netliferesearch/oauth2-twist

Twist OAuth 2.0 Client Provider for The PHP League OAuth2-Client

1.0.1 2017-10-27 11:17 UTC

Requires

• league/oauth2-client: ^2.0

Requires (Dev)

• mockery/mockery: ~0.9
• phpunit/phpunit: ~4.0
• squizlabs/php_codesniffer: ~2.0

MIT

• Steven Maguire
• Knut Melvær

• authorization
• client
• oauth
• oauth2
• authorisation
• twist

README

This package provides Twist OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Installation

To install, use composer:

composer require netliferesearch/oauth2-twist

Usage

Usage is the same as The League's OAuth client, using \Netliferesearch\OAuth2\Client\Provider\Twist as the provider.

Authorization Code Flow

$provider = new Netliferesearch\OAuth2\Client\Provider\Twist([
    'clientId'          => '{twist-client-id}',
    'clientSecret'      => '{twist-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url'
]);

For further usage of this package please refer to the core package documentation on "Authorization Code Grant".

Refreshing a Token

Once your application is authorized, you can refresh an expired token using a refresh token rather than going through the entire process of obtaining a brand new token. To do so, simply reuse this refresh token from your data store to request a refresh.

$existingAccessToken = getAccessTokenFromYourDataStore();

if ($existingAccessToken->hasExpired()) {
    $newAccessToken = $provider->getAccessToken('refresh_token', [
        'refresh_token' => $existingAccessToken->getRefreshToken()
    ]);

    // Purge old access token and store new access token to your data store.
}

For further usage of this package please refer to the core package documentation on "Refreshing a Token".

Testing

$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

• Knut Melvær
• Steven Maguire
• All Contributors

License

The MIT License (MIT). Please see License File for more information.