Stevenmaguire\OAuth2\Client\Provider\Microsoft

Complexity

Total Complexity

12

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	4

Test Coverage

Coverage

96.67%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getBaseAuthorizationUrl()	0	4	1
A	getBaseAccessTokenUrl()	0	4	1
A	setAccessTokenType()	0	4	1
A	getDefaultScopes()	0	4	1
A	checkResponse()	0	10	3
A	createResourceOwner()	0	4	1
A	getResourceOwnerDetailsUrl()	0	6	1
A	getAuthorizationHeaders()	0	10	3

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

use GuzzleHttp\Psr7\Uri;
use League\OAuth2\Client\Provider\AbstractProvider;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use League\OAuth2\Client\Token\AccessToken;
use Psr\Http\Message\ResponseInterface;

class Microsoft extends AbstractProvider
{
    /**
     * No access token type
     *
     * @var string
     */
    const ACCESS_TOKEN_TYPE_NONE = '';

    /**
     * Access token type 'Bearer'
     *
     * @var string
     */
    const ACCESS_TOKEN_TYPE_BEARER = 'Bearer';

    /**
     * Default scopes
     *
     * @var array
     */
    public $defaultScopes = ['wl.basic', 'wl.emails'];

    /**
     * Base url for authorization.
     *
     * @var string
     */
    protected $urlAuthorize = 'https://login.live.com/oauth20_authorize.srf';

    /**
     * Base url for access token.
     *
     * @var string
     */
    protected $urlAccessToken = 'https://login.live.com/oauth20_token.srf';

    /**
     * Base url for resource owner.
     *
     * @var string
     */
    protected $urlResourceOwnerDetails = 'https://apis.live.net/v5.0/me';

    /**
     * The access token type to use. Defaults to none.
     *
     * @var string
     */
    protected $accessTokenType = self::ACCESS_TOKEN_TYPE_NONE;

    /**
     * Get authorization url to begin OAuth flow
     *
     * @return string
     */
    public function getBaseAuthorizationUrl()
    {
        return $this->urlAuthorize;
    }

    /**
     * Get access token url to retrieve token
     *
     * @return string
     */
    public function getBaseAccessTokenUrl(array $params)
    {
        return $this->urlAccessToken;
    }

    /**
     * Sets the access token type used for authorization.
     *
     * @param string The access token type to use.
     */
    public function setAccessTokenType($accessTokenType)
    {
        $this->accessTokenType = $accessTokenType;
    }

    /**
     * Get default scopes
     *
     * @return array
     */
    protected function getDefaultScopes()
    {
        return $this->defaultScopes;
    }

    /**
     * Check a provider response for errors.
     *
     * @throws IdentityProviderException
     * @param  ResponseInterface $response
     * @return void
     */
    protected function checkResponse(ResponseInterface $response, $data)
    {
        if (isset($data['error'])) {
            throw new IdentityProviderException(
                (isset($data['error']['message']) ? $data['error']['message'] : $response->getReasonPhrase()),
                $response->getStatusCode(),
                $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 array $response
     * @param AccessToken $token
     * @return MicrosoftResourceOwner
     */
    protected function createResourceOwner(array $response, AccessToken $token)
    {
        return new MicrosoftResourceOwner($response);
    }

    /**
     * Get provider url to fetch user details
     *
     * @param  AccessToken $token
     *
     * @return string
     */
    public function getResourceOwnerDetailsUrl(AccessToken $token)
    {
        $uri = new Uri($this->urlResourceOwnerDetails);

        return (string) Uri::withQueryValue($uri, 'access_token', (string) $token);
    }

    /**
     * Returns the authorization headers used by this provider.
     *
     * @param  mixed|null $token Either a string or an access token instance
     * @return array
     */
    protected function getAuthorizationHeaders($token = null)
    {
        switch ($this->accessTokenType) {
            case self::ACCESS_TOKEN_TYPE_BEARER:
                return ['Authorization' => 'Bearer ' .  $token];
            case self::ACCESS_TOKEN_TYPE_NONE:
            default:
                return [];
        }
    }
}