README.md

Runalyze Provider for OAuth 2.0 Client

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