saloon

Introducing asynchronous request support for Saloon! There is now a new sendAsnc method on both the request and the connector and when used, it will return an instance of Guzzle Promise which you can then use in your application.

$request = new GetUserRequest(userId: 1);
$promise = $request->sendAsync();

$promise->then(
    function (SaloonResponse $response) {
        // Handle successful response...
    },
    function (SaloonRequestException $exception) {
        $response = $exception->getSaloonResponse();

        // Handle unsuccessful response...
    },
);

What's Changed

• Removed InstalledVersions from Laravel check by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/53

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.11.0...v1.0.1

I have decided to tag version 1.0 of Saloon. The API is now stable, with small tidy-ups and optimisations that can be done, but there are plenty of tests and big changes will now wait until later versions.

Have fun with Saloon!

What's Changed

• Mocking exceptions by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/49

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.10.0...v0.10.1

Authenticators!

This release introduces a new feature into Saloon, authenticators. Easily authenticate with your API integrations using the built in methods or create your own custom authenticators.

Click here to read more

What's Changed

• Feature | Authenticators by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/48

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.9.2...v0.10.0

What's Changed

• Added new send and request methods to the connector
• Changed return type of cast method
• Moved make back out from trait to improve readability

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.9.1...v0.9.2

Changes

• Fixed an issue where the "default" method on the Keychain did not return an instance of the class.

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.9.0...v0.9.1

Features

• Added Keychain authentication

Breaking Changes

• Renamed "setLoadedConnector" to "setConnector" on SaloonRequest.

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.8.3...v0.9.0

What's Changed

• Fixed an issue trying to convert an unsuccesful response to a dto by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/44

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.8.2...v0.8.3

What's Changed

• Changed DTO property type to protected by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/42
• Changed "getStream" to "stream" on the SaloonResponse to be more consistent.

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.8.1...v0.8.2

This release introduces a first-party way to cast directly to a DTO of your choice.

Firstly, add the "CastsToDto" trait to your request. After that, you need to add the "castToDto" method on the request. This should return your DTO with the data populated inside of it.

public function castToDto(SaloonResponse $response): object
{
    return User::fromSaloon($response);
}

After your request has been sent, you can use the dto method on the response to retrieve your DTO.

$response = UserRequest::make()->send();
$dto = $response->dto(); // Data\User

What's Changed

• Added new 'CastsToDto' plugin by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/40

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.8.0...v0.8.1

The biggest release in terms of changes for Saloon, be careful there are quite a number of breaking changes as Saloon leads up to v1.0 so keep an eye out for them below.

Features

• Added “getStream” to Saloon Response
• Added “xml” method to Saloon Response which will cast a XML response to a SimpleXMLElement
• Added the current request being processed to the “boot” methods on the connector and request. (Breaking Change)
• Added new authentication methods
  • withBasicAuth (for username/password auth)
  • withDigestAuth (for username/password auth with a digest)
  • withToken (for Authentication: Bearer tokens)
• Added a default connection timeout of 10 seconds and default request timeout of 30 seconds (Breaking Change)
• Added a new “make” static method on a request and connector.
• Added the current request being processed to the “boot” method of your plugins.

Changes

• Removed unused “connectorHasQueryParamsTrait” method
• Removed the requirement to add the word “feature” on the end of plugins (Breaking Change)
• The “defineXMLBody” method on the HasXMLBody plugin is now abstract
• The namespace for all plugins has changed from "Sammyjo20\Saloon\Traits\Features" to “Sammyjo20\Saloon\Traits\Plugins" (Breaking Change)
• All built in plugins now have "SaloonRequest $request" added to their boot methods.

Breaking Changes

• Plugins no longer have the word “feature” at the end of them on their boot method. You should rename your boot methods of your plugins to address this. For example “bootHasJsonBodyFeature” is now “bootHasJsonBody”.
• Saloon now has a default connection timeout of 10 seconds and a request timeout of 30 seconds, if you need a larger timeout, you should overwrite this by using the HasTimeout plugin.
• The “boot” method on your connectors and requests now have the current processing request being passed in, you should specify this if you are using the “boot” method on either your connector or request.
• The namespace for all plugins has changed from "Sammyjo20\Saloon\Features\Plugins" to “Sammyjo20\Saloon\Traits\Plugins"
• All built in plugins now have "SaloonRequest $request" added to their boot methods. If you are extending any of these plugins, you should reflect this change too.

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.7.2...v0.8.0

What's Changed

• Fixed an issue where assertSent would not check against the full history by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/34

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.7.1...v0.7.2

Bug Fixes

• Update HasFormParams.php by @ronnievisser in https://github.com/Sammyjo20/Saloon/pull/33

New Contributors

• @ronnievisser made their first contribution in https://github.com/Sammyjo20/Saloon/pull/33

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.7.0...v0.7.1

New Features

You can now assert that Saloon has sent the correct response in your application! The following expectation methods have been added:

• AssertSent (accepts request classes, closures and URL patterns)
• AssertNotSent (inverse of assert sent)
• AssertSentJson (accepts a class and an array to check both are equal)
• AssertNothingSent
• AssertSentCount

Here's how you can use it:

// Laravel (using Facade)

Saloon::assertSent(GetForgeServerRequest::class);

// Normal PHP

$mockClient->assertSent(GetForgeServerRequest::class);

What's Changed

• Added new mock assertions by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/31

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.6.6...v0.7.0

New Features

Introducing a new way to use Saloon! You can now register your requests within your connector to use it just like an SDK. Take a look:

// Currently, the only way to make requests...

$request = new GetForgeServerRequest(serverId: 123456);
$response = $request->send();

// Introducing the new "SDK" API!

$connector = new ForgeConnector();
$request = $connector->getForgeServerRequest(serverId: 123456);
$response = $request->send();

// You can even use static methods...

$request = ForgeConnector::getForgeServerRequest(serverId: 123456);
$response = $request->send();

Click here to read more

What's Changed

• New connector request API by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/28
• Updated interfaces by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/29

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.6.5...v0.6.6

What's Changed

• Extended exceptions by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/25

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.6.4...v0.6.5

Fixes

• Fixed bug where if you tried to add the AlwaysThrowsOnErrors trait to a connector it would fail.

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.6.3...v0.6.4

Changes

• Removed cookies() method from SaloonResponse

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.6.2...v0.6.3

Added

• New getGuzzleException() to SaloonResponse
• Previous exception to SaloonRequestException

Changed

• Tidied up "Should Guess Status From Body" feature
• Removed effectiveUri() and handlerStats() from response
• Renamed getSaloonRequestOptions to getRequestOptions

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v0.6.1...v0.6.2