osavchenko/oauth2-cloudconvert

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

0.1.0 2021-09-17 17:34 UTC

Requires

• php: ^7.4 || ^8.0
• ext-json: *
• league/oauth2-client: ^2.0

Requires (Dev)

• mockery/mockery: ^1.4
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.6

MIT

• Oleksandr Savchenko

• authorization
• client
• oauth
• oauth2
• authorisation
• cloudconvert

README

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

Installation

To install, use composer:

composer require osavchenko/oauth2-cloudconvert

Usage

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

Authorization Code Flow

$provider = new Osavchenko\OAuth2\Client\Provider\CloudConvert([
    'clientId'     => '{cloud-convert-client-id}',
    'clientSecret' => '{cloud-convert-client-secret}',
    'redirectUri'  => 'https://example.com/callback-url',
    'sandbox'      => false, // optional
]);

if (!isset($_GET['code'])) {
    // If we don't have an authorization code then get one
    $authUrl = $provider->getAuthorizationUrl();
    $_SESSION['oauth2state'] = $provider->getState();
    header('Location: '.$authUrl);
    exit;
}

// Check given state against previously stored one to mitigate CSRF attack
if (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {
    unset($_SESSION['oauth2state']);
    exit('Invalid state');
}

// Try to get an access token (using the authorization code grant)
$token = $provider->getAccessToken('authorization_code', [
    'code' => $_GET['code']
]);

// Optional: Now you have a token you can look up a users profile data
try {
    // We got an access token, let's now get the user's details
    $user = $provider->getResourceOwner($token);

    // Use these details to create a new profile
    printf('Hello %s!', $user->getNickname());
} catch (Exception $e) {
    // Failed to get user details
    exit('Oh dear...');
}

// Use this to interact with an API on the users behalf
echo $token->getToken();
}

Managing Scopes

When creating your CloudConvert authorization URL, you can specify the state and scopes your application may authorize.

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['user.read','task.read'], // array or string
];

$authorizationUrl = $provider->getAuthorizationUrl($options);

If neither are defined, the provider will utilize internal defaults.

At the time of authoring this documentation, the following scopes are available.

• user.read
• user.write
• task.read
• task.write
• webhook.read
• webhook.write

Testing

$ ./vendor/bin/phpunit

License

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