stevenmaguire/oauth2-wecounsel

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

0.1.0 2018-07-09 23:27 UTC

README

Latest Version Software License Build Status Coverage Status Quality Score Total Downloads

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

Installation

To install, use composer:

composer require stevenmaguire/oauth2-wecounsel

Usage

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

Authorization Code Flow

$provider = new Stevenmaguire\OAuth2\Client\Provider\Wecounsel([
    'clientId'          => '{wecounsel-client-id}',
    'clientSecret'      => '{wecounsel-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url',
    'host'              => 'https://staging.wecounsel.com' // Defaults to https://api.wecounsel.com
]);

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
} elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {

    unset($_SESSION['oauth2state']);
    exit('Invalid state');

} else {

    // 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->getId());

    } 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();
}

Refreshing a Token

The WeCounsel API supports refresh tokens. Review the "Refreshing a Token documentation" on the base oauth2-client project for tips on implementing refresh tokens in your project.

Testing

$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

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