OAuth\OAuth2\Service\Twitch

Complexity

Total Complexity

9

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	2
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	23	2
A	getAuthorizationEndpoint()	0	4	1
A	getAccessTokenEndpoint()	0	4	1
A	parseAccessTokenResponse()	0	19	4
A	getExtraApiHeaders()	0	7	1

<?php

namespace OAuth\OAuth2\Service;

use OAuth\OAuth2\Token\StdOAuth2Token;
use OAuth\Common\Http\Exception\TokenResponseException;
use OAuth\Common\Http\Uri\Uri;
use OAuth\Common\Consumer\CredentialsInterface;
use OAuth\Common\Http\Client\ClientInterface;
use OAuth\Common\Storage\TokenStorageInterface;
use OAuth\Common\Http\Uri\UriInterface;

class Twitch extends AbstractService
{
    /**
     * Scopes defined at:
     * https://github.com/justintv/Twitch-API/blob/master/authentication.md#scopes
     */

    /**
     * Read access to non-public user information, such as email address.
     */
    const SCOPE_USER_READ = 'user_read';

    /**
     * Ability to ignore or unignore on behalf of a user.
     */
    const SCOPE_BLOCKS_EDIT = 'user_blocks_edit';

    /**
     * Read access to a user's list of ignored users.
     */
    const SCOPE_BLOCKS_READ = 'user_blocks_read';

    /**
     * Access to manage a user's followed channels.
     */
    const SCOPE_CHANNEL_READ = 'channel_read';

    /**
     * Write access to channel metadata (game, status, etc).
     */
    const SCOPE_CHANNEL_EDITOR = 'channel_editor';

    /**
     * Access to trigger commercials on channel.
     */
    const SCOPE_CHANNEL_COMMERCIAL = 'channel_commercial';

    /**
     * Ability to reset a channel's stream key.
     */
    const SCOPE_CHANNEL_STREAM = 'channnel_stream';

    /**
     * Read access to all subscribers to your channel.
     */
    const SCOPE_CHANNEL_SUBSCRIPTIONS = 'channel_subscriptions';

    /**
     * Read access to subscriptions of a user.
     */
    const SCOPE_USER_SUBSCRIPTIONS = 'user_subscriptions';

    /**
     * Read access to check if a user is subscribed to your channel.
     */
    const SCOPE_CHANNEL_CHECK_SUBSCRIPTION = 'channel_check_subscription';

    /**
     * Ability to log into chat and send messages.
     */
    const SCOPE_CHAT_LOGIN = 'chat_login';

    public function __construct(
        CredentialsInterface $credentials,
        ClientInterface $httpClient,
        TokenStorageInterface $storage,
        $scopes = array(),
        UriInterface $baseApiUri = null,
        $stateParameterInAutUrl = true,
        $apiVersion = "v3"
    ) {
        parent::__construct(
            $credentials,
            $httpClient,
            $storage,
            $scopes,
            $baseApiUri,
            $stateParameterInAutUrl,
            $apiVersion
        );

        if (null === $baseApiUri) {
            $this->baseApiUri = new Uri('https://api.twitch.tv/kraken/');
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getAuthorizationEndpoint()
    {
        return new Uri('https://api.twitch.tv/kraken/oauth2/authorize');
    }

    /**
     * {@inheritdoc}
     */
    public function getAccessTokenEndpoint()
    {
        return new Uri('https://api.twitch.tv/kraken/oauth2/token');
    }

    /**
     * {@inheritdoc}
     */
    protected function parseAccessTokenResponse($responseBody)
    {
        $data = json_decode($responseBody, true);

        if (null === $data || !is_array($data)) {
            throw new TokenResponseException('Unable to parse response.');
        } elseif (isset($data['error'])) {
            throw new TokenResponseException('Error in retrieving token: "' . $data['error'] . '"');
        }

        $token = new StdOAuth2Token();
        $token->setAccessToken($data['access_token']);
        $token->setEndOfLife(StdOAuth2Token::EOL_NEVER_EXPIRES);
        unset($data['access_token']);

        $token->setExtraParams($data);

        return $token;
    }

    /**
     * {@inheritdoc}
     */
    protected function getExtraApiHeaders()
    {
        return array(
            'Accept' => 'application/vnd.twitchtv.'.$this->apiVersion.'+json',
            'Client-ID' => $this->credentials->getConsumerId()
        );
    }
}