runalyze / php-oauth2-runalyze
Runalyze OAuth 2.0 Client Provider for The PHP League OAuth2-Client
dev-main
2023-03-21 16:19 UTC
Requires
- php: ^8.0
- league/oauth2-client: ^2.6.1
Requires (Dev)
- phpunit/phpunit: 8.* || 9.* || 10.*
This package is not auto-updated.
Last update: 2024-11-13 22:08:04 UTC
README
This package provides Runalyze OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
Installation
To install the package, use composer:
composer require runalyze/oauth2-runalyze
Usage
Usage is the same as The League's OAuth client, using \Runalyze\OAuth2\Client\Provider\Runalyze
as the provider.
Authorization Code Flow
$provider = new Runalyze\OAuth2\Client\Provider\Runalyze([ 'clientId' => '{runalyze-client-id}', 'clientSecret' => '{runalyze-client-secret}', 'redirectUri' => 'https://example.com/callback_url', ]); // Send OAuth Request // If we don't have an authorization code then we can get one $authUrl = $provider->getAuthorizationUrl(); $_SESSION['OAuth2State'] = $provider->getState(); ... // OAuth2 Callback URL // Compare given state against previously stored one to block CSRF attack if (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['OAuth2State'])) { exit('Invalid state'); } else { // Try to get an access token $token = $provider->getAccessToken('authorization_code', ['code' => $_GET['code']]); // Now we can look up users profile try { // Get the user's details $user = $provider->getResourceOwner($token); printf('Hello %s!', $user->getName()); } catch (Exception $e) { // Failed to get user details exit('Oh no ... ...'); } // We can use token to make other API calls echo $token->getToken(); }
Testing
$ ./vendor/bin/phpunit