kerox/oauth2-spotify

Spotify Oauth 2.0 Client Provider for The PHP League OAuth2-Client

1.0.2 2018-11-23 10:33 UTC

README

Build Coverage Code Quality PHP Version Downloads Latest Stable Version License

Spotify Provider for OAuth 2.0 Client

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

Installation

You can install this package using Composer:

composer require kerox/oauth2-spotify

You will then need to:

  • run composer install to get these dependencies added to your vendor directory
  • add the autoloader to your application with this line: require('vendor/autoload.php');

Usage

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

Authorization Code Flow

$provider = new Kerox\OAuth2\Client\Provider\Spotify([
    'clientId'     => '{spotify-client-id}',
    'clientSecret' => '{spotify-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([
        'scope' => [
            Kerox\OAuth2\Client\Provider\Spotify::SCOPE_USER_READ_BIRTHDATE,
            Kerox\OAuth2\Client\Provider\Spotify::SCOPE_USER_READ_EMAIL,
        ]
    ]);
    
    $_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']);
    echo 'Invalid state.';
    exit;

}

// 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
    /** @var \Kerox\OAuth2\Client\Provider\SpotifyResourceOwner $user */
    $user = $provider->getResourceOwner($token);

    // Use these details to create a new profile
    printf('Hello %s!', $user->getDisplayName());
    
    echo '<pre>';
    var_dump($user);
    echo '</pre>';

} catch (Exception $e) {

    // Failed to get user details
    exit('Damned...');
}

echo '<pre>';
// Use this to interact with an API on the users behalf
var_dump($token->getToken());
# string(217) "CAADAppfn3msBAI7tZBLWg...

// The time (in epoch time) when an access token will expire
var_dump($token->getExpires());
# int(1436825866)
echo '</pre>';

Authorization Scopes

The following scopes are available as described in the official documentation:

  • SCOPE_APP_REMOTE_CONTROL
  • SCOPE_PLAYLIST_MODIFY_PRIVATE
  • SCOPE_PLAYLIST_MODIFY_PUBLIC
  • SCOPE_PLAYLIST_READ_COLLABORATIVE
  • SCOPE_PLAYLIST_READ_PRIVATE
  • SCOPE_STREAMING
  • SCOPE_USER_READ_PRIVATE
  • SCOPE_USER_READ_BIRTHDATE
  • SCOPE_USER_READ_EMAIL
  • SCOPE_USER_TOP_READ
  • SCOPE_USER_READ_RECENTLY_PLAYED
  • SCOPE_USER_LIBRARY_MODIFY
  • SCOPE_USER_LIBRARY_READ
  • SCOPE_USER_READ_CURRENTLY_PLAYING
  • SCOPE_USER_READ_PLAYBACK_STATE
  • SCOPE_USER_MODIFY_PLAYBACK_STATE
  • SCOPE_USER_FOLLOW_MODIFY
  • SCOPE_USER_FOLLOW_READ

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.