Zoho::getAuthorizationHeaders() - Code Metrics - Inspection of "Readme file changed" - shahariaazam/zoho-oauth2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 112fa1...258d4d )

by Shaharia

created 2019-10-10 22:12 UTC

Zoho::getAuthorizationHeaders() A

↳ Parent: Zoho

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php


namespace ShahariaAzam\ZohoOAuth2\Client\Provider;

use League\OAuth2\Client\Provider\AbstractProvider;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use League\OAuth2\Client\Token\AccessToken;
use Psr\Http\Message\ResponseInterface;
use ShahariaAzam\ZohoOAuth2\Client\Exceptions\IdentifyProviderException;

class Zoho extends AbstractProvider
{
    /**
     * @var string
     */
    protected $endpoint = "https://accounts.zoho.com";
    protected $accessType = "online";

    /**
     * Zoho constructor.
     * @param array $options
     * @param array $collaborators
     */
    public function __construct(array $options = [], array $collaborators = [])
    {
        parent::__construct($options, $collaborators);

        foreach (['clientId', 'clientSecret', 'redirectUri'] as $key) {
            if (!isset($options[$key])) {
                throw new \InvalidArgumentException($key . " is missing");
            }
        }
    }

    /**
     * Returns the base URL for authorizing a client.
     *
     * Eg. https://oauth.service.com/authorize
     *
     * @return string
     */
    public function getBaseAuthorizationUrl()
    {
        return $this->endpoint . "/oauth/v2/auth";
    }

    /**
     * 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 $this->endpoint . "/oauth/v2/token";
    }

    /**
     * Returns the URL for requesting the resource owner's details.
     *
     * @param AccessToken $token
     * @return string
     */
    public function getResourceOwnerDetailsUrl(AccessToken $token)
    {
        return $this->endpoint . "/oauth/user/info";
    }

    /**
     * @param mixed|null $token
     * @return array|void
     */
    protected function getAuthorizationHeaders($token = null)
    {
        return ['Authorization' => "Bearer " . $token];
    }

    /**
     * @param array $options
     * @return array
     */
    protected function getAuthorizationParameters(array $options)
    {
        if (empty($options['state'])) {
            $options['state'] = $this->getRandomState();
        }

        if (empty($options['scope'])) {
            $options['scope'] = $this->getDefaultScopes();
        }

        $options += [
            'response_type' => 'code',
            'approval_prompt' => 'auto'
        ];

        if (is_array($options['scope'])) {
            $separator = $this->getScopeSeparator();
            $options['scope'] = implode($separator, $options['scope']);
        }

        // Store the state as it may need to be accessed later on.
        $this->state = $options['state'];

        // Business code layer might set a different redirect_uri parameter
        // depending on the context, leave it as-is
        if (!isset($options['redirect_uri'])) {
            $options['redirect_uri'] = $this->redirectUri;
        }

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

        if (isset($options['access_type']) && in_array($options['access_type'], ['offline', 'online'])) {
            $options['access_type'] = $this->accessType;
        }

        return $options;
    }

    /**
     * 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 array
     */
    protected function getDefaultScopes()
    {
        return ['aaaserver.profile.READ', 'ZohoProfile.userinfo.read', 'ZohoProfile.userphoto.read'];
    }

    /**
     * Checking response to see if provider returned any error
     *
     * @param ResponseInterface $response
     * @param array|string $data Parsed response data
     * @return void
     * @throws IdentityProviderException
     */
    protected function checkResponse(ResponseInterface $response, $data)
    {
        $responseData = $this->parseResponse($response);
        if (array_key_exists("error", $responseData)) {
            throw new IdentifyProviderException($responseData['error'], $response->getStatusCode(), $response);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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


1		<?php
2
3
4		namespace ShahariaAzam\ZohoOAuth2\Client\Provider;
5
6		use League\OAuth2\Client\Provider\AbstractProvider;
7		use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
8		use League\OAuth2\Client\Token\AccessToken;
9		use Psr\Http\Message\ResponseInterface;
10		use ShahariaAzam\ZohoOAuth2\Client\Exceptions\IdentifyProviderException;
11
12		class Zoho extends AbstractProvider
13		{
14		/**
15		* @var string
16		*/
17		protected $endpoint = "https://accounts.zoho.com";
18		protected $accessType = "online";
19
20		/**
21		* Zoho constructor.
22		* @param array $options
23		* @param array $collaborators
24		*/
25	20	public function __construct(array $options = [], array $collaborators = [])
26		{
27	20	parent::__construct($options, $collaborators);
28
29	20	foreach (['clientId', 'clientSecret', 'redirectUri'] as $key) {
30	20	if (!isset($options[$key])) {
31	20	throw new \InvalidArgumentException($key . " is missing");
32		}
33		}
34	20	}
35
36		/**
37		* Returns the base URL for authorizing a client.
38		*
39		* Eg. https://oauth.service.com/authorize
40		*
41		* @return string
42		*/
43	4	public function getBaseAuthorizationUrl()
44		{
45	4	return $this->endpoint . "/oauth/v2/auth";
46		}
47
48		/**
49		* Returns the base URL for requesting an access token.
50		*
51		* Eg. https://oauth.service.com/token
52		*
53		* @param array $params
54		* @return string
55		*/
56	8	public function getBaseAccessTokenUrl(array $params)
57		{
58	8	return $this->endpoint . "/oauth/v2/token";
59		}
60
61		/**
62		* Returns the URL for requesting the resource owner's details.
63		*
64		* @param AccessToken $token
65		* @return string
66		*/
67	2	public function getResourceOwnerDetailsUrl(AccessToken $token)
68		{
69	2	return $this->endpoint . "/oauth/user/info";
70		}
71
72		/**
73		* @param mixed\|null $token
74		* @return array\|void
75		*/
76		protected function getAuthorizationHeaders($token = null)
77		{
78		return ['Authorization' => "Bearer " . $token];
79		}
80
81		/**
82		* @param array $options
83		* @return array
84		*/
85	2	protected function getAuthorizationParameters(array $options)
86		{
87	2	if (empty($options['state'])) {
88	2	$options['state'] = $this->getRandomState();
89		}
90
91	2	if (empty($options['scope'])) {
92	2	$options['scope'] = $this->getDefaultScopes();
93		}
94
95		$options += [
96	2	'response_type' => 'code',
97		'approval_prompt' => 'auto'
98		];
99
100	2	if (is_array($options['scope'])) {
101	2	$separator = $this->getScopeSeparator();
102	2	$options['scope'] = implode($separator, $options['scope']);
103		}
104
105		// Store the state as it may need to be accessed later on.
106	2	$this->state = $options['state'];
107
108		// Business code layer might set a different redirect_uri parameter
109		// depending on the context, leave it as-is
110	2	if (!isset($options['redirect_uri'])) {
111	2	$options['redirect_uri'] = $this->redirectUri;
112		}
113
114	2	$options['client_id'] = $this->clientId;
115
116	2	if (isset($options['access_type']) && in_array($options['access_type'], ['offline', 'online'])) {
117		$options['access_type'] = $this->accessType;
118		}
119
120	2	return $options;
121		}
122
123		/**
124		* Returns the default scopes used by this provider.
125		*
126		* This should only be the scopes that are required to request the details
127		* of the resource owner, rather than all the available scopes.
128		*
129		* @return array
130		*/
131	4	protected function getDefaultScopes()
132		{
133	4	return ['aaaserver.profile.READ', 'ZohoProfile.userinfo.read', 'ZohoProfile.userphoto.read'];
134		}
135
136		/**
137		* Checking response to see if provider returned any error
138		*
139		* @param ResponseInterface $response
140		* @param array\|string $data Parsed response data
141		* @return void
142		* @throws IdentityProviderException
143		*/
144	4	protected function checkResponse(ResponseInterface $response, $data)
145		{
146	4	$responseData = $this->parseResponse($response);
147	4	if (array_key_exists("error", $responseData)) {
148	2	throw new IdentifyProviderException($responseData['error'], $response->getStatusCode(), $response);
		0 ignored issues – show Documentation introduced 2019-10-10 21:55 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...
149		}
150	2	}
151
152		/**
153		* Generates a resource owner object from a successful resource owner
154		* details request.
155		*
156		* @param array $response
157		* @param AccessToken $token
158		* @return ZohoUser
159		*/
160		protected function createResourceOwner(array $response, AccessToken $token)
161		{
162		return new ZohoUser($response);
163		}
164		}
165

shahariaazam / zoho-oauth2

Push — master ( 112fa1...258d4d )

Zoho::getAuthorizationHeaders() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like