Docta\MercadoLibre\Client

Complexity

Total Complexity

23

Size/Duplication

Total Lines	238
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	get()	0	3	1
A	execute()	0	6	1
A	__construct()	0	16	2
A	getToken()	0	8	4
A	buildOptions()	0	5	2
A	options()	0	3	1
A	put()	0	3	1
A	setToken()	0	6	2
A	buildRequest()	0	8	2
A	getOwner()	0	7	2
A	delete()	0	3	1
A	getAuthorizationUrl()	0	3	1
A	buildResource()	0	3	1
A	getState()	0	3	1
A	post()	0	3	1

<?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 <lucasconobanegas@gmail.com>
 * @license https://opensource.org/licenses/MIT MIT License
 * @author Lucas Banegas <lucasconobanegas@gmail.com>
 * @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

$token is always a sub-type of League\OAuth2\Client\Token\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);
    }
}