Sarhan\OAuth2\Client\Provider\Docusign

Complexity

Total Complexity

12

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getScopeSeparator()	0	3	1
A	getBasicAuth()	0	3	1
A	getDefaultHeaders()	0	3	1
A	getDefaultScopes()	0	3	1
A	getBaseAuthorizationUrl()	0	3	1
A	createResourceOwner()	0	3	1
A	checkResponse()	0	7	2
A	getBaseAccessTokenUrl()	0	3	1
A	getResourceOwnerDetailsUrl()	0	3	1
A	getUrl()	0	6	2

<?php

namespace Sarhan\OAuth2\Client\Provider;

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

class Docusign extends AbstractProvider
{
    use BearerAuthorizationTrait {
        getAuthorizationHeaders as getTokenBearerAuthorizationHeaders;
    }

    const URL_ROOT = 'https://account.docusign.com/oauth';
    const URL_ROOT_SANDBOX = 'https://account-d.docusign.com/oauth';

    const ENDPOINT_AUTHORIZTION = 'auth';
    const ENDPOINT_ACCESS_TOKEN = 'token';
    const ENDPOINT_RESOURCE_OWNER_DETAILS = 'userinfo';

    const SCOPE_SIGNATURE = 'signature';
    const SCOPE_EXTENDED = 'extended';
    const SCOPE_IMPERSONATION = 'impersonation';
    const SCOPES_DEFAULT = [
        self::SCOPE_SIGNATURE,
        self::SCOPE_EXTENDED
    ];
    const SCOPES_SEPARATOR = ' ';

    protected $sandbox = false;

    /**
     * @inheritDoc
     */
    public function getBaseAuthorizationUrl()
    {
        return $this->getUrl(self::ENDPOINT_AUTHORIZTION);
    }

    /**
     * @inheritDoc
     */
    public function getBaseAccessTokenUrl(array $params)
    {
        return $this->getUrl(self::ENDPOINT_ACCESS_TOKEN);
    }

    /**
     * @inheritDoc
     */
    public function getResourceOwnerDetailsUrl(AccessToken $token)
    {
        return $this->getUrl(self::ENDPOINT_RESOURCE_OWNER_DETAILS);
    }

    /**
     * Returns a full url for the given path, with the appropriate docusign
     * backennd.
     *
     * It can be used in combination of getRequest and getResponse methods
     * to make further calls to docusign endpoint using the given token.
     *
     * @param string $path
     *
     * @return string
     *
     * @see Docusign::getRequest
     * @see Docusign::getResponse
     */
    public function getUrl($path)
    {
        return sprintf(
            '%s/%s',
            $this->sandbox ? self::URL_ROOT_SANDBOX : self::URL_ROOT,
            $path
        );
    }

    protected function getDefaultScopes()
    {
        return self::SCOPES_DEFAULT;
    }

    protected function checkResponse(ResponseInterface $response, $data)
    {
        if ($response->getStatusCode() >= 400) {
            throw new IdentityProviderException(
                $response->getReasonPhrase(),
                $response->getStatusCode(),
                \json_decode((string) $response->getBody(), true)
            );
        }
    }

    protected function createResourceOwner(array $response, AccessToken $token)
    {
        return new DocusignUser($response, $token);
    }

    protected function getScopeSeparator()
    {
        return self::SCOPES_SEPARATOR;
    }

    protected function getDefaultHeaders()
    {
        return ['Authorization' => 'Basic ' . $this->getBasicAuth()];
    }

    private function getBasicAuth()
    {
        return base64_encode(sprintf('%s:%s', $this->clientId, $this->clientSecret));
    }
}