Skip to content

Latest commit

 

History

History
104 lines (70 loc) · 3.23 KB

README.md

File metadata and controls

104 lines (70 loc) · 3.23 KB
Raw

Freshbooks Provider for OAuth 2.0 Client

Software License Coverage Status Build Status Total Downloads

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

Installation

To install, use composer:

composer require zerospam/oauth2-freshbooks

Usage

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

Authorization Code Flow

$provider = new ZEROSPAM\OAuth2\Client\Provider\FreshBooks([
    'clientId'          => '{freshbooks-client-id}',
    'clientSecret'      => '{freshbooks-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();
}

Refreshing a Token

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

$grant = new \League\OAuth2\Client\Grant\RefreshToken();
$token = $provider->getAccessToken($grant, ['refresh_token' => $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.