shadowhand / oauth2-untappd
Untappd OAuth 2.0 Client Provider for The PHP League OAuth2-Client
0.3.0
2016-03-08 14:12 UTC
Requires
- league/oauth2-client: ^1.0.0
Requires (Dev)
- mockery/mockery: ^0.9.4
README
This package provides Untappd OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
This package is compliant with PSR-1, PSR-2 and PSR-4. If you notice compliance oversights, please send a patch via pull request.
Requirements
The following versions of PHP are supported.
- PHP 5.5
- PHP 5.6
- PHP 7.0
- HHVM
Installation
To install, use composer:
composer require shadowhand/oauth2-untappd
Usage
Authorization Code Flow
$provider = new Shadowhand\OAuth2\Client\Provider\Untappd([ 'clientId' => '{untappd-app-id}', 'clientSecret' => '{untappd-app-secret}', 'redirectUri' => 'https://example.com/callback-url', 'hostedDomain' => 'example.com', ]); if (!empty($_GET['error'])) { // Got an error, probably user denied access exit('Got error: ' . $_GET['error']); } elseif (empty($_GET['code'])) { // If we don't have an authorization code then get one $authUrl = $provider->getAuthorizationUrl(); header('Location: ' . $authUrl); exit; } 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 owner details $ownerDetails = $provider->getResourceOwner($token); // Use these details to create a new profile printf('Hello %s!', $ownerDetails->getFirstName()); } catch (Exception $e) { // Failed to get user details exit('Something went wrong: ' . $e->getMessage()); } // Use this to interact with an API on the users behalf echo $token->accessToken; }
NOTE: Untappd does not support state
passing for verification.
Refreshing a Token
Untappd tokens do not expire and do not need to be refreshed.
Testing
$ ./vendor/bin/phpunit
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.