stevenmaguire/oauth2-elance

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

2.0.0 2017-01-26 02:24 UTC

This package is auto-updated.

Last update: 2024-10-14 10:50:53 UTC


README

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

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

Installation

To install, use composer:

composer require stevenmaguire/oauth2-elance

Usage

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

Authorization Code Flow

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

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

Important note about the Elance API

This package attempts to use the /profiles/my API endpoint to populate the ElanceResourceOwner object. This attempt will be successful if the resource owner has a "Contractor Profile" on Elance. If the resource owner does not have a "Contractor Profile" the request for this information will result in a 404 response and the code example above will fail.

The request to getAccessToken will succeed regardless of "Contractor Profile" status.

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.

$grant = new \League\OAuth2\Client\Grant\RefreshToken();
$token = $provider->getAccessToken($grant, ['refresh_token' => $refreshToken]);

Testing

$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

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