NextEngineProvider::getAccessToken() - Code Metrics - Inspection of "Simplified a bit" - w-takumi/oauth2-next-engine - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 694d99...95c47e )

by Hirofumi

created 2017-06-09 15:22 UTC

NextEngineProvider::getAccessToken() A

↳ Parent: NextEngineProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	6
cts	6
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	7
nc	1
nop	2
crap	1

<?php

namespace Shippinno\NextEngine\OAuth2\Client\Provider;

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

class NextEngineProvider extends AbstractProvider
{
    /**
     * @var string Key used in a token response to identify the resource owner.
     */
    const ACCESS_TOKEN_RESOURCE_OWNER_ID = 'uid';

    /**
     * Returns the base URL for authorizing a client.
     *
     * @return string
     */
    public function getBaseAuthorizationUrl()
    {
        return 'https://base.next-engine.org/users/sign_in/';
    }

    /**
     * Returns the base URL for requesting an access token.
     *
     * Eg. https://oauth.service.com/token
     *
     * @param array $params
     * @return string
     */
    public function getBaseAccessTokenUrl(array $params)
    {
        return 'https://api.next-engine.org/api_neauth/';
    }

    /**
     * Returns the URL for requesting the resource owner's details.
     *
     * @param AccessToken $token
     * @return string
     */
    public function getResourceOwnerDetailsUrl(AccessToken $token)
    {
        return null;
    }

    /**
     * Returns the default scopes used by this provider.
     *
     * This should only be the scopes that are required to request the details
     * of the resource owner, rather than all the available scopes.
     *
     * @return string[]
     */
    protected function getDefaultScopes()
    {
        return [];
    }

    /**
     * Checks a provider response for errors.
     *
     * @throws IdentityProviderException
     * @param  ResponseInterface $response
     * @param  array|string $data Parsed response data
     * @return void
     */
    protected function checkResponse(ResponseInterface $response, $data)
    {
        if ('error' === $data['result']) {
            throw new IdentityProviderException(
                $data['message'] ?: $response->getReasonPhrase(),
                $response->getStatusCode(),
                $response->getBody()
            );
        }
    }

    /**
     * Returns authorization parameters based on provided options.
     *
     * @param  array $options
     * @return array Authorization parameters
     */
    protected function getAuthorizationParameters(array $options)
    {
        if (!isset($options['redirect_uri'])) {
            $options['redirect_uri'] = $this->redirectUri;
        }

        $options['client_id'] = $this->clientId;
        $options['client_secret'] = $this->clientSecret;

        return $options;
    }

    /**
     * Requests an access token using a specified grant and option set.
     *
     * @param  mixed $grant
     * @param  array $options
     * @return AccessToken
     */
    public function getAccessToken($grant, array $options = [])
    {
        $grant = $this->verifyGrant($grant);

        $request  = $this->getAccessTokenRequest($options);
        $response = $this->getParsedResponse($request);
        $prepared = $this->prepareAccessTokenResponse($response);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $token    = $this->createAccessToken($prepared, $grant);

        return $token;
    }

    /**
     * Generates a resource owner object from a successful resource owner
     * details request.
     *
     * @param  array $response
     * @param  AccessToken $token
     * @return ResourceOwnerInterface
     */
    protected function createResourceOwner(array $response, AccessToken $token)
    {
        return new NextEngineResourceOwner($token->getValues());
    }

    /**
     * Requests and returns the resource owner of given access token.
     *
     * @param  AccessToken $token
     * @return ResourceOwnerInterface
     */
    public function getResourceOwner(AccessToken $token)
    {
        return $this->createResourceOwner([], $token);
    }
}


1		<?php
2
3		namespace Shippinno\NextEngine\OAuth2\Client\Provider;
4
5		use League\OAuth2\Client\Provider\AbstractProvider;
6		use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
7		use League\OAuth2\Client\Provider\ResourceOwnerInterface;
8		use League\OAuth2\Client\Token\AccessToken;
9		use Psr\Http\Message\ResponseInterface;
10
11		class NextEngineProvider extends AbstractProvider
12		{
13		/**
14		* @var string Key used in a token response to identify the resource owner.
15		*/
16		const ACCESS_TOKEN_RESOURCE_OWNER_ID = 'uid';
17
18		/**
19	1	* Returns the base URL for authorizing a client.
20		*
21	1	* @return string
22		*/
23		public function getBaseAuthorizationUrl()
24		{
25		return 'https://base.next-engine.org/users/sign_in/';
26		}
27
28		/**
29		* Returns the base URL for requesting an access token.
30	1	*
31		* Eg. https://oauth.service.com/token
32	1	*
33	1	* @param array $params
34	1	* @return string
35		*/
36	1	public function getBaseAccessTokenUrl(array $params)
37	1	{
38		return 'https://api.next-engine.org/api_neauth/';
39	1	}
40
41		/**
42		* Returns the URL for requesting the resource owner's details.
43		*
44		* @param AccessToken $token
45		* @return string
46		*/
47		public function getResourceOwnerDetailsUrl(AccessToken $token)
48	1	{
49		return null;
50	1	}
51
52		/**
53		* Returns the default scopes used by this provider.
54		*
55		* This should only be the scopes that are required to request the details
56		* of the resource owner, rather than all the available scopes.
57		*
58		* @return string[]
59	1	*/
60		protected function getDefaultScopes()
61	1	{
62	1	return [];
63	1	}
64
65	1	/**
66		* Checks a provider response for errors.
67		*
68		* @throws IdentityProviderException
69		* @param ResponseInterface $response
70		* @param array\|string $data Parsed response data
71		* @return void
72		*/
73		protected function checkResponse(ResponseInterface $response, $data)
74		{
75		if ('error' === $data['result']) {
76	2	throw new IdentityProviderException(
77		$data['message'] ?: $response->getReasonPhrase(),
78	2	$response->getStatusCode(),
79		$response->getBody()
80		);
81		}
82		}
83
84		/**
85		* Returns authorization parameters based on provided options.
86		*
87	1	* @param array $options
88		* @return array Authorization parameters
89	1	*/
90		protected function getAuthorizationParameters(array $options)
91		{
92		if (!isset($options['redirect_uri'])) {
93		$options['redirect_uri'] = $this->redirectUri;
94		}
95
96		$options['client_id'] = $this->clientId;
97		$options['client_secret'] = $this->clientSecret;
98
99		return $options;
100		}
101
102		/**
103		* Requests an access token using a specified grant and option set.
104		*
105		* @param mixed $grant
106		* @param array $options
107		* @return AccessToken
108		*/
109		public function getAccessToken($grant, array $options = [])
110		{
111		$grant = $this->verifyGrant($grant);
112
113	2	$request = $this->getAccessTokenRequest($options);
114		$response = $this->getParsedResponse($request);
115	2	$prepared = $this->prepareAccessTokenResponse($response);
		0 ignored issues – show Bug introduced 2017-06-09 15:25 UTC by Report Bug Copy Issue Report It seems like `$response` defined by `$this->getParsedResponse($request)` on line `114` can also be of type `null` or `string`; however, `League\OAuth2\Client\Pro...reAccessTokenResponse()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
116	1	$token = $this->createAccessToken($prepared, $grant);
117	1
118	1	return $token;
119	1	}
120	1
121		/**
122	1	* Generates a resource owner object from a successful resource owner
123		* details request.
124		*
125		* @param array $response
126		* @param AccessToken $token
127		* @return ResourceOwnerInterface
128		*/
129		protected function createResourceOwner(array $response, AccessToken $token)
130		{
131		return new NextEngineResourceOwner($token->getValues());
132		}
133
134		/**
135		* Requests and returns the resource owner of given access token.
136		*
137		* @param AccessToken $token
138		* @return ResourceOwnerInterface
139		*/
140		public function getResourceOwner(AccessToken $token)
141		{
142		return $this->createResourceOwner([], $token);
143		}
144		}
145

w-takumi / oauth2-next-engine

Push — master ( 694d99...95c47e )

NextEngineProvider::getAccessToken() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like