saloon

What's Changed

• Feature | V2 Better Merging Pipeline by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/144

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v2.0.0-beta4...v2.0.0-beta5

What's Changed

• Feature | V2 Defaults Class by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/142

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v2.0.0-beta3...v2.0.0-beta4

What's Changed

• Feature | V2 Allow other simulated responses to take priority by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/141

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v2.0.0-beta2...v2.0.0-beta3

What's Changed

• Feature | V2 Beta improvements by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/139
• Feature | V2 Beta Improvements by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/140

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v2.0.0-beta1...v2.0-beta2

What's Changed

It's finally time for the first Saloon v2 beta! After months of work and pretty much rewriting the core code, Saloon v2 is finally in beta for you to try out. Please provide feedback on the main issue.

Issue: https://github.com/Sammyjo20/Saloon/issues/64
Docs: https://docs.saloon.dev/v/2/

• Feature | Better v2 mocking by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/72
• Feature | Fake responses by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/93
• Feature | Data repository pattern by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/94
• Feature | Laravel middleware by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/96
• Feature | Laravel integration by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/103
• Feature | More tidy ups by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/104
• Feature | Drop Sammyjo20 from namespace by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/105
• Feature | Drop Saloon in Class Names by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/106
• Feature | Reduce Dependencies by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/107
• Feature | V2 Fixing Tests by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/108
• Feature | More tests by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/110
• Feature | More tests by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/111
• Feature | Fixed handler stack by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/112
• Fix | Guzzle handler stack by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/113
• Fix | AlwaysThrowOnErrors Priority by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/114
• Feature | Rename queryParameters to query by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/115
• Feature | v2 better workflow permissions by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/116
• Feature |v2 better workflow permissions by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/117
• V2 Tweaks by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/118
• Feature | V2 Data-Object Responses by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/119
• Feature | V2 - Connector First Design by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/122
• Feature | V2 - Custom Exception Handlers by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/123
• Feature | V2 - Replace method with enum by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/127
• Feature | V2 Safe Body by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/130
• Fix | v2 Better Response Error Methods by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/132
• Feature | V2 Better Body Tests + More Features by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/133
• Feature | V2 - Simplified responses and created one single response by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/135
• Feature | V2 MultipartValue Object by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/134
• Feature | V2 Added headers to body traits by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/136
• Feature | V2 - Added back throwing mock exceptions by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/137
• Fix | V2 - Changed the Response class return type to its interface counterpart by @juse-less in https://github.com/Sammyjo20/Saloon/pull/138

New Contributors

• @juse-less made their first contribution in https://github.com/Sammyjo20/Saloon/pull/138

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v1.6.0...v2.0.0-beta1

What's Changed

• Fix | Support PHP 8.2 by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/126

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v1.5.3...v1.6.0

What's Changed

• Feature | Added new dom() method for parsing HTML and XML by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/102

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v1.5.2...v1.5.3

What's Changed

• enhance: UrlHelper join method handle endpoint URL string by @ashleyhood in https://github.com/Sammyjo20/Saloon/pull/101

New Contributors

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

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v1.5.1...v1.5.2

What's Changed

• Fix | Leading Slash When Base URL is empty and endpoint in request is a URL by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/92

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v1.5...v1.5.1

What's Changed

• Feature | Mocking Fixtures by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/90

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v1.4.4...v1.5

What's Changed

• Added funding by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/82
• Caught up with main by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/83
• Fix response DTO type-hint by @Gummibeer in https://github.com/Sammyjo20/Saloon/pull/85

New Contributors

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

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v1.4.3...v1.4.4

What's Changed

• Feature | Improved GitHub Workflow by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/75
• Feature | Added new resolveConnector method by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/76

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v1.4.2...v1.4.3

What's Changed

• Fix docblock in SaloonResponse by @szepeviktor in https://github.com/Sammyjo20/Saloon/pull/69
• Plugins on a base class will be used when extending the base class by @leo108 in https://github.com/Sammyjo20/Saloon/pull/70

New Contributors

• @szepeviktor made their first contribution in https://github.com/Sammyjo20/Saloon/pull/69
• @leo108 made their first contribution in https://github.com/Sammyjo20/Saloon/pull/70

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v1.4.1...v1.4.2

• Added missing test for using invokable classes for mocking.

What's Changed

• Invokable mock response by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/67

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v1.4.0...v1.4.1

What's Changed

• Feature | Added closure mocking by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/66

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v1.3.3...v1.4.0

• Updated composer.json

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v1.3.2...v1.3.3

What's Changed

• Fix | Cleanup Composer.json by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/65

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v1.3.1...v1.3.2

What's Changed

• Feature | Spring cleaning & added authentication alias by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/63

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v1.3.0...v1.3.1

Read the documentation here: https://docs.saloon.dev/advanced/oauth2-authentication

Version 1.3 introduces OAuth2 helpers/boilerplate code for the Authorization Code Flow! 🥳 It will allow you to write all the OAuth2 client configuration in a connector that you can use to:

• Generate an authorization URL
• Create access tokens
• Create a refresh token

Connector

<?php

use Sammyjo20\Saloon\Helpers\OAuth2\OAuthConfig;
use Sammyjo20\Saloon\Http\SaloonConnector;
use Sammyjo20\Saloon\Traits\OAuth2\AuthorizationCodeGrant;

class SpotifyAuthConnector extends SaloonConnector
{
    use AuthorizationCodeGrant;

    public function defineBaseUrl(): string
    {
        return 'https://accounts.spotify.com';
    }

    protected function defaultOauthConfig(): OAuthConfig
    {
        return OAuthConfig::make()
            ->setClientId('my-client-id')
            ->setClientSecret('my-client-secret')
	    ->setDefaultScopes(['user-read-currently-playing'])
            ->setRedirectUri('https://my-app.saloon.dev/auth/callback')
	    ->setAuthorizeEndpoint('authorize')
            ->setTokenEndpoint('token')
            ->setUserEndpoint('user')
    }
}

Your application:

$authConnector = new SpotifyAuthConnector;

// 1. Redirect the user to the authorization URL...

$authorizationUrl = $authConnector->getAuthorizationUrl($scopes, $state);

// 2. Handle the callback from the API provider and create an access token...

$authenticator = $authConnector->getAccessTokens($code, $state);

// 3. Authenticate your requests!

$request = new GetTracksRequest;
$request->withAuth($authenticator);
$request->send(); // 🚀

// 4. Refresh your access tokens...

$newAuthenticator = $authConnector->refreshAccessTokens($authenticator);

Previously you could define custom methods on the connector to call requests in Saloon, like so:

protected array $requests = [
    'getMyUser' => UserRequest::class,
    ErrorRequest::class,
];

This was pretty limited as you couldn't define "groups" of requests.

This PR introduces an extension to this API and now you can define an array of requests, keyed for a collection or a custom "RequestCollection" which is a class that extends the base "RequestCollection" class and can have completely custom methods inside. You will also have access to the connector.

Define groups of requests

$connector->user()->get()

protected array $requests = [
    'user' => [
        'get' => UserRequest::class,
    ],
];

Define custom request collections

$connector->user()->get()

protected array $requests = [
    'user' => UserCollection::class,
];

class UserCollection extends RequestCollection
{
    public function get(): SaloonRequest
    {
        return $this->connector->request(new UserRequest);
    }
}

What's Changed

• Feature | Nested SDK Requests by @Sammyjo20 in https://github.com/Sammyjo20/Saloon/pull/59

Full Changelog: https://github.com/Sammyjo20/Saloon/compare/v1.1.0...v1.2.0