Stevenmaguire\OAuth2\Client\Provider\Zendesk

Complexity

Total Complexity

16

Size/Duplication

Total Lines	166
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	6

Test Coverage

Coverage

87.5%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	getBaseAuthorizationUrl()	0	4	1
A	getBaseAccessTokenUrl()	0	4	1
A	getResourceOwnerDetailsUrl()	0	4	1
A	getDefaultScopes()	0	4	1
A	setDefaultScopes()	0	8	2
A	getScopeSeparator()	0	4	1
A	checkResponse()	0	11	3
A	createResourceOwner()	0	4	1
A	getSubdomain()	0	4	1
A	setSubdomain()	0	8	2

<?php namespace Stevenmaguire\OAuth2\Client\Provider;

use League\OAuth2\Client\Provider\AbstractProvider;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use League\OAuth2\Client\Token\AccessToken;
use League\OAuth2\Client\Tool\BearerAuthorizationTrait;
use Psr\Http\Message\ResponseInterface;

class Zendesk extends AbstractProvider
{
    use BearerAuthorizationTrait;

    protected $subdomain;

    protected $scopes = [];

    /**
     * @var string Key used in a token response to identify the resource owner.
     */
    const ACCESS_TOKEN_RESOURCE_OWNER_ID = 'id';

    /**
     * Constructs an OAuth 2.0 service provider.
     *
     * @param array $options An array of options to set on this provider.
     *     Options include `clientId`, `clientSecret`, `redirectUri`, and `state`.
     *     Individual providers may introduce more options, as needed.
     * @param array $collaborators An array of collaborators that may be used to
     *     override this provider's default behavior. Collaborators include
     *     `grantFactory`, `requestFactory`, `httpClient`, and `randomFactory`.
     *     Individual providers may introduce more collaborators, as needed.
     */
    public function __construct(array $options = [], array $collaborators = [])
    {
        parent::__construct($options, $collaborators);

        if (empty($this->subdomain)) {
            throw new Exception\ProviderConfigurationException(
                'No subdomain has been configured for this Zendesk provider; it has to have a subdomain.'
            );
        }
    }

    /**
     * Get authorization url to begin OAuth flow
     *
     * @return string
     */
    public function getBaseAuthorizationUrl()
    {
        return 'https://'.$this->subdomain.'.zendesk.com/oauth/authorizations/new';
    }

    /**
     * Get access token url to retrieve token
     *
     * @return string
     */
    public function getBaseAccessTokenUrl(array $params)
    {
        return 'https://'.$this->subdomain.'.zendesk.com/oauth/tokens';
    }

    /**
     * Get provider url to fetch user details
     *
     * @param  AccessToken $token
     *
     * @return string
     */
    public function getResourceOwnerDetailsUrl(AccessToken $token)
    {
        return 'https://'.$this->subdomain.'.zendesk.com/api/v2/users/me.json';
    }

    /**
     * Get the default scopes used by this provider.
     *
     * This should not be a complete list of all scopes, but the minimum
     * required for the provider user interface!
     *
     * @return array
     */
    protected function getDefaultScopes()
    {
        return $this->scopes;
    }

    /**
     * Set the default scopes used by this provider.
     *
     * This should not be a complete list of all scopes, but the minimum
     * required for the provider user interface!
     *
     * @return Zendesk
     */
    public function setDefaultScopes(Array $scopes)
    {
        if (!empty($scopes)) {
            $this->scopes = $scopes;
        }

        return $this;
    }

    /**
     * Returns the string that should be used to separate scopes when building
     * the URL for requesting an access token.
     *
     * @return string Scope separator, defaults to ','
     */
    protected function getScopeSeparator()
    {
        return ' ';
    }

    /**
     * Check a provider response for errors.
     *
     * @throws IdentityProviderException
     * @param  ResponseInterface $response
     * @param  string $data Parsed response data
     * @return void
     */
    protected function checkResponse(ResponseInterface $response, $data)
    {
        $statusCode = $response->getStatusCode();
        if ($statusCode >= 400) {
            throw new IdentityProviderException(
                isset($data['description']) ? $data['description'] : $response->getReasonPhrase(),
                $statusCode,
                $response

$response is of type object<Psr\Http\Message\ResponseInterface>, but the function expects a array|string.

            );
        }
    }

    /**
     * Generate a user object from a successful user details request.
     *
     * @param object $response
     * @param AccessToken $token
     * @return ZendeskResourceOwner
     */
    protected function createResourceOwner(array $response, AccessToken $token)
    {
        return new ZendeskResourceOwner($response);
    }

    /**
     * Retrieves currently configured subdomain.
     *
     * @return string
     */
    public function getSubdomain()
    {
        return $this->subdomain;
    }

    /**
     * Updates currently configured subdomain.
     *
     * @param string $subdomain
     *
     * @return Zendesk
     */
    public function setSubdomain($subdomain)
    {
        if (!empty($subdomain)) {
            $this->subdomain = $subdomain;
        }

        return $this;
    }
}