Elance Provider for OAuth 2.0 Client
, (*1)
This package provides Elance OAuth 2.0 support for the PHP League's OAuth 2.0 Client., (*2)
Installation
To install, use composer:, (*3)
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., (*4)
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., (*5)
The request to getAccessToken will succeed regardless of "Contractor Profile" status., (*6)
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., (*7)
$grant = new \League\OAuth2\Client\Grant\RefreshToken();
$token = $provider->getAccessToken($grant, ['refresh_token' => $refreshToken]);
Testing
bash
$ ./vendor/bin/phpunit, (*8)
Contributing
Please see CONTRIBUTING for details., (*9)
Credits
License
The MIT License (MIT). Please see License File for more information., (*10)
Wallogit.com
