Microsoft::getAuthorizationHeaders() - Code Metrics - Inspection of "Added Bearer token types." - stevenmaguire/oauth2-microsoft - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#10)

unknown

created 2018-02-08 12:43 UTC

Microsoft::getAuthorizationHeaders() A

↳ Parent: Microsoft

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3.0175

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	7
cts	8
cp	0.875
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	7
nc	3
nop	1
crap	3.0175

<?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
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            );
        }
    }

    /**
     * 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 [];
        }
    }
}


1		<?php namespace Stevenmaguire\OAuth2\Client\Provider;
2
3		use GuzzleHttp\Psr7\Uri;
4		use League\OAuth2\Client\Provider\AbstractProvider;
5		use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
6		use League\OAuth2\Client\Token\AccessToken;
7		use Psr\Http\Message\ResponseInterface;
8
9		class Microsoft extends AbstractProvider
10		{
11		/**
12		* No access token type
13		*
14		* @var string
15		*/
16		const ACCESS_TOKEN_TYPE_NONE = '';
17
18		/**
19		* Access token type 'Bearer'
20		*
21		* @var string
22		*/
23		const ACCESS_TOKEN_TYPE_BEARER = 'Bearer';
24
25		/**
26		* Default scopes
27		*
28		* @var array
29		*/
30		public $defaultScopes = ['wl.basic', 'wl.emails'];
31
32		/**
33		* Base url for authorization.
34		*
35		* @var string
36		*/
37		protected $urlAuthorize = 'https://login.live.com/oauth20_authorize.srf';
38
39		/**
40		* Base url for access token.
41		*
42		* @var string
43		*/
44		protected $urlAccessToken = 'https://login.live.com/oauth20_token.srf';
45
46		/**
47		* Base url for resource owner.
48		*
49		* @var string
50		*/
51		protected $urlResourceOwnerDetails = 'https://apis.live.net/v5.0/me';
52
53		/**
54		* The access token type to use. Defaults to none.
55		*
56		* @var string
57		*/
58		protected $accessTokenType = self::ACCESS_TOKEN_TYPE_NONE;
59
60		/**
61		* Get authorization url to begin OAuth flow
62		*
63		* @return string
64		*/
65	12	public function getBaseAuthorizationUrl()
66		{
67	12	return $this->urlAuthorize;
68		}
69
70		/**
71		* Get access token url to retrieve token
72		*
73		* @return string
74		*/
75	15	public function getBaseAccessTokenUrl(array $params)
76		{
77	15	return $this->urlAccessToken;
78		}
79
80		/**
81		* Sets the access token type used for authorization.
82		*
83		* @param string The access token type to use.
84		*/
85	3	public function setAccessTokenType($accessTokenType)
86		{
87	3	$this->accessTokenType = $accessTokenType;
88	3	}
89
90		/**
91		* Get default scopes
92		*
93		* @return array
94		*/
95	9	protected function getDefaultScopes()
96		{
97	9	return $this->defaultScopes;
98		}
99
100		/**
101		* Check a provider response for errors.
102		*
103		* @throws IdentityProviderException
104		* @param ResponseInterface $response
105		* @return void
106		*/
107	9	protected function checkResponse(ResponseInterface $response, $data)
108		{
109	9	if (isset($data['error'])) {
110	3	throw new IdentityProviderException(
111	3	(isset($data['error']['message']) ? $data['error']['message'] : $response->getReasonPhrase()),
112	3	$response->getStatusCode(),
113	2	$response
		0 ignored issues – show Documentation introduced 2017-01-26 01:58 UTC by Report Bug Copy Issue Report `$response` is of type `object<Psr\Http\Message\ResponseInterface>`, but the function expects a `array\|string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
114	1	);
115		}
116	6	}
117
118		/**
119		* Generate a user object from a successful user details request.
120		*
121		* @param array $response
122		* @param AccessToken $token
123		* @return MicrosoftResourceOwner
124		*/
125	3	protected function createResourceOwner(array $response, AccessToken $token)
126		{
127	3	return new MicrosoftResourceOwner($response);
128		}
129
130		/**
131		* Get provider url to fetch user details
132		*
133		* @param AccessToken $token
134		*
135		* @return string
136		*/
137	6	public function getResourceOwnerDetailsUrl(AccessToken $token)
138		{
139	6	$uri = new Uri($this->urlResourceOwnerDetails);
140
141	6	return (string) Uri::withQueryValue($uri, 'access_token', (string) $token);
142		}
143
144		/**
145		* Returns the authorization headers used by this provider.
146		*
147		* @param mixed\|null $token Either a string or an access token instance
148		* @return array
149		*/
150	6	protected function getAuthorizationHeaders($token = null)
151		{
152	6	switch ($this->accessTokenType) {
153	6	case self::ACCESS_TOKEN_TYPE_BEARER:
154	3	return ['Authorization' => 'Bearer ' . $token];
155	6	case self::ACCESS_TOKEN_TYPE_NONE:
156	2	default:
157	6	return [];
158		}
159		}
160		}
161

stevenmaguire / oauth2-microsoft

Pull Request — master (#10)

Microsoft::getAuthorizationHeaders() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like