Client::getAuthorizationUrl() - Code Metrics - Inspection of "chore: initial commit" - docta/mercadolibre - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d6c6a3...6b4c6c )

by Lucas

created 2018-06-01 03:42 UTC

Client::getAuthorizationUrl() A

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php
/**
 * MercadoLibre PHP SDK
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE file
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright 2018 Lucas Banegas <[email protected]>
 * @license https://opensource.org/licenses/MIT MIT License
 * @author Lucas Banegas <[email protected]>
 * @link https://github.com/docta/mercadolibre Repository
 * @link https://docta.github.io/mercadolibre Documentation
 */
namespace Docta\MercadoLibre;

use Docta\MercadoLibre\OAuth2\Client\Provider;
use Docta\MercadoLibre\OAuth2\Client\ResourceGeneric;
use Docta\MercadoLibre\OAuth2\Client\ResourceOwner;
use InvalidArgumentException;
use League\OAuth2\Client\Provider\AbstractProvider;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use League\OAuth2\Client\Token\AccessToken;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

/**
 * Represents a simplified version of MercadoLibre Provider.
 */
class Client extends Provider
{
    /**
     * @var AccessToken
     */
    protected $token;

    /**
     * @var ResourceOwner
     */
    protected $owner;

    /**
     * Constructor.
     *
     * @param string $authSite The site where the application was registered (ex: `MLA`)
     * @param string $clientId The App ID granted by MercadoLibre
     * @param string $clientSecret The secret key granted by MercadoLibre
     * @param string $redirectUri The URI that will process the MercadoLibre callback
     * @param AccessToken|string $token Code or token previously granted (optional)
     * @throws IdentityProviderException
     * @throws InvalidArgumentException
     */
    public function __construct(
        $authSite,
        $clientId,
        $clientSecret,
        $redirectUri,
        $token = null
    ) {
        parent::__construct(compact(
            'authSite',
            'clientId',
            'clientSecret',
            'redirectUri'
        ));

        if ($token) {
            $this->setToken($token);
        }
    }

    /**
     * Builds and returns the authorization URL.
     *
     * @param array $options
     * @return string Authorization URL
     */
    public function getAuthorizationUrl(array $options = [])
    {
        return parent::getAuthorizationUrl($options);
    }

    /**
     * Returns the current value of the state parameter.
     *
     * @return string
     */
    public function getState()
    {
        return parent::getState();
    }

    /**
     * Set a token using a code or a previously created token.
     *
     * @param AccessToken|string $token Code or token previously granted
     * @return AccessToken|null
     * @throws IdentityProviderException
     */
    public function setToken($token)
    {
        $this->token = $token instanceof AccessToken
            ? $token : $this->getAccessToken('authorization_code', ['code' => $token]);

        return $this->getToken();
    }

    /**
     * Get the current token.
     *
     * @return AccessToken|null
     * @throws IdentityProviderException
     */
    public function getToken()
    {
        if ($this->token && $this->token->hasExpired() && $this->token->getRefreshToken()) {
            $options = ['refresh_token' => $this->token->getRefreshToken()];
            $this->token = $this->getAccessToken('refresh_token', $options);
        }

        return $this->token;
    }

    /**
     * Get the owner resource for the current token.
     *
     * @return ResourceOwner|null
     * @throws IdentityProviderException
     */
    public function getOwner()
    {
        if ($this->getToken()) {
            $this->owner = $this->getResourceOwner($this->getToken());
        }

        return $this->owner;
    }

    /**
     * Execute a GET request
     *
     * @param string $path Path relative to the API URL
     * @param array $query Query parameters to include in the URL (optional)
     * @return ResourceGeneric The resource obtained by the request
     * @throws IdentityProviderException
     */
    public function get($path, array $query = [])
    {
        return $this->execute('GET', $path, $query);
    }

    /**
     * Execute a POST request
     *
     * @param string $path Path relative to the API URL
     * @param array $data Data to be sent through the HTTP headers (optional)
     * @param array $query Query parameters to include in the URL (optional)
     * @return ResourceGeneric The resource obtained by the request
     * @throws IdentityProviderException
     */
    public function post($path, array $data = [], array $query = [])
    {
        return $this->execute('POST', $path, $query, $data);
    }

    /**
     * Execute a PUT request
     *
     * @param string $path Path relative to the API URL
     * @param array $data Data to be sent through the HTTP headers (optional)
     * @param array $query Query parameters to include in the URL (optional)
     * @return ResourceGeneric The resource obtained by the request
     * @throws IdentityProviderException
     */
    public function put($path, array $data = [], array $query = [])
    {
        return $this->execute('PUT', $path, $query, $data);
    }

    /**
     * Execute a DELETE request
     *
     * @param string $path Path relative to the API URL
     * @param array $query Query parameters to include in the URL (optional)
     * @return ResourceGeneric The resource obtained by the request
     * @throws IdentityProviderException
     */
    public function delete($path, array $query = [])
    {
        return $this->execute('DELETE', $path, $query);
    }

    /**
     * Execute a OPTIONS request
     *
     * @param string $path Path relative to the API URL
     * @param array $query Query parameters to include in the URL (optional)
     * @return ResourceGeneric The resource obtained by the request
     * @throws IdentityProviderException
     */
    public function options($path, array $query = [])
    {
        return $this->execute('OPTIONS', $path, $query);
    }

    /**
     * Execute a custom request
     *
     * @param string $method Request method
     * @param string $path Path relative to the API URL
     * @param array $query Query parameters to include in the URL (optional)
     * @param array $data Data to be sent through the HTTP headers (optional)
     * @return ResourceGeneric The resource obtained by the request
     * @throws IdentityProviderException
     */
    public function execute($method, $path, array $query = [], array $data = [])
    {
        $url = $this->getApiUrl($path, $query);
        $request = $this->buildRequest($method, $url, $data);
        $response = $this->getParsedResponse($request);
        return $this->buildResource($response);
    }

    /**
     * Build and return an appropriate request.
     *
     * @internal
     * @param string $method
     * @param string $url
     * @param array $data
     * @return RequestInterface
     */
    public function buildRequest($method, $url, array $data = [])
    {
        $token = $this->getToken();
        $options = $this->buildOptions($data);

        return $token instanceof AccessToken

            ? $this->getAuthenticatedRequest($method, $url, $token, $options)
            : $this->getRequest($method, $url, $options);
    }

    /**
     * Convert data to HTTP headers.
     *
     * @internal
     * @param array $data
     * @return array
     */
    private function buildOptions(array $data)
    {
        return empty($data) ? $data : [
            'headers' => ['content-type' => 'application/json'],
            'body' => json_encode($data)
        ];
    }

    /**
     * Build and return a resource.
     *
     * @internal
     * @param array $response
     * @return ResourceGeneric
     */
    private function buildResource(array $response)
    {
        return new ResourceGeneric($response);
    }
}


1		<?php
2		/**
3		* MercadoLibre PHP SDK
4		*
5		* Licensed under The MIT License
6		* For full copyright and license information, please see the LICENSE file
7		* Redistributions of files must retain the above copyright notice.
8		*
9		* @copyright 2018 Lucas Banegas <[email protected]>
10		* @license https://opensource.org/licenses/MIT MIT License
11		* @author Lucas Banegas <[email protected]>
12		* @link https://github.com/docta/mercadolibre Repository
13		* @link https://docta.github.io/mercadolibre Documentation
14		*/
15		namespace Docta\MercadoLibre;
16
17		use Docta\MercadoLibre\OAuth2\Client\Provider;
18		use Docta\MercadoLibre\OAuth2\Client\ResourceGeneric;
19		use Docta\MercadoLibre\OAuth2\Client\ResourceOwner;
20		use InvalidArgumentException;
21		use League\OAuth2\Client\Provider\AbstractProvider;
22		use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
23		use League\OAuth2\Client\Token\AccessToken;
24		use Psr\Http\Message\RequestInterface;
25		use Psr\Http\Message\ResponseInterface;
26
27		/**
28		* Represents a simplified version of MercadoLibre Provider.
29		*/
30		class Client extends Provider
31		{
32		/**
33		* @var AccessToken
34		*/
35		protected $token;
36
37		/**
38		* @var ResourceOwner
39		*/
40		protected $owner;
41
42		/**
43		* Constructor.
44		*
45		* @param string $authSite The site where the application was registered (ex: `MLA`)
46		* @param string $clientId The App ID granted by MercadoLibre
47		* @param string $clientSecret The secret key granted by MercadoLibre
48		* @param string $redirectUri The URI that will process the MercadoLibre callback
49		* @param AccessToken\|string $token Code or token previously granted (optional)
50		* @throws IdentityProviderException
51		* @throws InvalidArgumentException
52		*/
53	12	public function __construct(
54		$authSite,
55		$clientId,
56		$clientSecret,
57		$redirectUri,
58		$token = null
59		) {
60	12	parent::__construct(compact(
61	12	'authSite',
62	12	'clientId',
63	12	'clientSecret',
64	12	'redirectUri'
65		));
66
67	12	if ($token) {
68	1	$this->setToken($token);
69		}
70	12	}
71
72		/**
73		* Builds and returns the authorization URL.
74		*
75		* @param array $options
76		* @return string Authorization URL
77		*/
78	1	public function getAuthorizationUrl(array $options = [])
79		{
80	1	return parent::getAuthorizationUrl($options);
81		}
82
83		/**
84		* Returns the current value of the state parameter.
85		*
86		* @return string
87		*/
88	1	public function getState()
89		{
90	1	return parent::getState();
91		}
92
93		/**
94		* Set a token using a code or a previously created token.
95		*
96		* @param AccessToken\|string $token Code or token previously granted
97		* @return AccessToken\|null
98		* @throws IdentityProviderException
99		*/
100	7	public function setToken($token)
101		{
102	7	$this->token = $token instanceof AccessToken
103	7	? $token : $this->getAccessToken('authorization_code', ['code' => $token]);
104
105	7	return $this->getToken();
106		}
107
108		/**
109		* Get the current token.
110		*
111		* @return AccessToken\|null
112		* @throws IdentityProviderException
113		*/
114	11	public function getToken()
115		{
116	11	if ($this->token && $this->token->hasExpired() && $this->token->getRefreshToken()) {
117	1	$options = ['refresh_token' => $this->token->getRefreshToken()];
118	1	$this->token = $this->getAccessToken('refresh_token', $options);
119		}
120
121	11	return $this->token;
122		}
123
124		/**
125		* Get the owner resource for the current token.
126		*
127		* @return ResourceOwner\|null
128		* @throws IdentityProviderException
129		*/
130	2	public function getOwner()
131		{
132	2	if ($this->getToken()) {
133	1	$this->owner = $this->getResourceOwner($this->getToken());
134		}
135
136	2	return $this->owner;
137		}
138
139		/**
140		* Execute a GET request
141		*
142		* @param string $path Path relative to the API URL
143		* @param array $query Query parameters to include in the URL (optional)
144		* @return ResourceGeneric The resource obtained by the request
145		* @throws IdentityProviderException
146		*/
147	1	public function get($path, array $query = [])
148		{
149	1	return $this->execute('GET', $path, $query);
150		}
151
152		/**
153		* Execute a POST request
154		*
155		* @param string $path Path relative to the API URL
156		* @param array $data Data to be sent through the HTTP headers (optional)
157		* @param array $query Query parameters to include in the URL (optional)
158		* @return ResourceGeneric The resource obtained by the request
159		* @throws IdentityProviderException
160		*/
161	1	public function post($path, array $data = [], array $query = [])
162		{
163	1	return $this->execute('POST', $path, $query, $data);
164		}
165
166		/**
167		* Execute a PUT request
168		*
169		* @param string $path Path relative to the API URL
170		* @param array $data Data to be sent through the HTTP headers (optional)
171		* @param array $query Query parameters to include in the URL (optional)
172		* @return ResourceGeneric The resource obtained by the request
173		* @throws IdentityProviderException
174		*/
175	1	public function put($path, array $data = [], array $query = [])
176		{
177	1	return $this->execute('PUT', $path, $query, $data);
178		}
179
180		/**
181		* Execute a DELETE request
182		*
183		* @param string $path Path relative to the API URL
184		* @param array $query Query parameters to include in the URL (optional)
185		* @return ResourceGeneric The resource obtained by the request
186		* @throws IdentityProviderException
187		*/
188	1	public function delete($path, array $query = [])
189		{
190	1	return $this->execute('DELETE', $path, $query);
191		}
192
193		/**
194		* Execute a OPTIONS request
195		*
196		* @param string $path Path relative to the API URL
197		* @param array $query Query parameters to include in the URL (optional)
198		* @return ResourceGeneric The resource obtained by the request
199		* @throws IdentityProviderException
200		*/
201	1	public function options($path, array $query = [])
202		{
203	1	return $this->execute('OPTIONS', $path, $query);
204		}
205
206		/**
207		* Execute a custom request
208		*
209		* @param string $method Request method
210		* @param string $path Path relative to the API URL
211		* @param array $query Query parameters to include in the URL (optional)
212		* @param array $data Data to be sent through the HTTP headers (optional)
213		* @return ResourceGeneric The resource obtained by the request
214		* @throws IdentityProviderException
215		*/
216	1	public function execute($method, $path, array $query = [], array $data = [])
217		{
218	1	$url = $this->getApiUrl($path, $query);
219	1	$request = $this->buildRequest($method, $url, $data);
220	1	$response = $this->getParsedResponse($request);
221	1	return $this->buildResource($response);
222		}
223
224		/**
225		* Build and return an appropriate request.
226		*
227		* @internal
228		* @param string $method
229		* @param string $url
230		* @param array $data
231		* @return RequestInterface
232		*/
233	3	public function buildRequest($method, $url, array $data = [])
234		{
235	3	$token = $this->getToken();
236	3	$options = $this->buildOptions($data);
237
238	3	return $token instanceof AccessToken
		0 ignored issues – show introduced 2018-06-01 03:44 UTC by Report Bug Copy Issue Report `$token` is always a sub-type of `League\OAuth2\Client\Token\AccessToken`. Loading history...
239	1	? $this->getAuthenticatedRequest($method, $url, $token, $options)
240	3	: $this->getRequest($method, $url, $options);
241		}
242
243		/**
244		* Convert data to HTTP headers.
245		*
246		* @internal
247		* @param array $data
248		* @return array
249		*/
250	3	private function buildOptions(array $data)
251		{
252	3	return empty($data) ? $data : [
253	2	'headers' => ['content-type' => 'application/json'],
254	3	'body' => json_encode($data)
255		];
256		}
257
258		/**
259		* Build and return a resource.
260		*
261		* @internal
262		* @param array $response
263		* @return ResourceGeneric
264		*/
265	1	private function buildResource(array $response)
266		{
267	1	return new ResourceGeneric($response);
268		}
269		}
270

docta / mercadolibre

Push — master ( d6c6a3...6b4c6c )

Client::getAuthorizationUrl() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like