Docta\MercadoLibre\Client

Complexity

Total Complexity

16

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getAuthUrl()	0	3	1
A	options()	0	3	1
A	put()	0	3	1
A	setToken()	0	3	1
A	getOwner()	0	3	2
A	delete()	0	3	1
A	get()	0	3	1
A	post()	0	3	1
A	getState()	0	3	1
B	getToken()	0	17	6

<?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 Copyright (c) 2018 Lucas Banegas <lucasconobanegas@gmail.com>
 * @license https://opensource.org/licenses/MIT MIT License
 * @link https://github.com/docta/mercadolibre
 */
namespace Docta\MercadoLibre;

use Docta\OAuth2\Client\Provider\MercadoLibreResourceOwner;
use League\OAuth2\Client\Token\AccessToken;

/**
 * Client class
 *
 * An easy-to-use client to access the MercadoLibre API services.
 *
 * To use this client, must first register the application in
 * {@link http://applications.mercadolibre.com/ MercadoLibre},
 * since the API must grant the clientId and clientSecret values.
 * The options required for the constructor are:
 *
 * - authSite
 * - clientId
 * - clientSecret
 * - redirectUri
 *
 * Optionally, can initialize the client with a previously
 * generated token, passing it with the `token` key.
 *
 * @example
 * <pre>
 * $client = new \Docta\MercadoLibre\Client([
 *     'authSite'     => '{mercadolibre-auth-site}',
 *     'clientId'     => '{mercadolibre-client-id}',
 *     'clientSecret' => '{mercadolibre-client-secret}',
 *     'redirectUri'  => 'https://example.com/oauth/'
 * ]);
 *
 * if (!isset($_GET['code'])) {
 *     $authUrl = $provider->getAuthUrl();
 *     $_SESSION['state'] = $provider->getState();
 *     header('Location: ' . $authUrl);
 *     exit;
 * } elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['state'])) {
 *     unset($_SESSION['state']);
 *     exit('Invalid state');
 * } else {
 *     try {
 *         $token = $client->getToken($_GET['code']);
 *         $owner = $client->getOwner();
 *         $items = $client->post('/items');
 *     } catch (Exception $e) {
 *         exit($e->getMessage());
 *     }
 * }
 * </pre>
 */
class Client extends ClientBase
{
    /**
     * Builds and return the authorization URL
     *
     * The url returned by this method depends on the `authSite` option passed
     * to the constructor. For example, if the option set is `MLA`, it will
     * return `https://auth.mercadolibre.com.ar/authorization`.
     *
     * In addition, the url will contain the following query parameters:
     *
     * - `response_type`
     * - `client_id`
     * - `redirect_uri`
     * - `state`
     *
     * @return string The authorization URL
     */
    public function getAuthUrl()
    {
        return $this->provider->getAuthorizationUrl();
    }

    /**
     * Returns the current value of the state parameter
     *
     * When the authorization url is generated, this includes the parameter
     * `state`. This method get its value to store in a session and then be
     * able to compare when the server redirects back to the application.
     * The objective of this parameter is to mitigate CSRF attacks.
     *
     * @link https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF) Cross-Site Request Forgery (CSRF)
     *
     * @return string The current value of the state parameter
     */
    public function getState()
    {
        return $this->provider->getState();
    }

    /**
     * Get a token
     *
     * If a string is passed, this method assumes that
     * it is a code that must be exchanged for a token.
     *
     * If a valid token is passed, it returns the same token;
     * but if the token has expired and has a refresh token,
     * then it requests and returns a new token.
     *
     * In all cases that a token returns, it is established as
     * the default token. In any other case it returns null.
     *
     * @param AccessToken|string|null $token Code or token
     * @return AccessToken The {@link https://goo.gl/QEoCNV access token}
     */
    public function getToken($token = null)
    {
        if (is_string($token)) {
            return $this->authorize($token);
        }

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

        if ($this->token) {
            return $this->token->getRefreshToken() && $this->token->hasExpired()
                ? $this->refresh($this->token)
                : $this->token;
        }

        return null;
    }

    /**
     * Set a token
     *
     * Set the token passed as the default token. A default token can
     * also be set using the `token` key in the constructor options.
     *
     * @param AccessToken|null $token The token to set
     * @return AccessToken The {@link https://goo.gl/QEoCNV access token}
     */
    public function setToken(AccessToken $token)
    {
        return ($this->token = $token);
    }

    /**
     * Make a GET request to API services
     *
     * @param string $path Path relative to the API url
     * @param array $query Optional: query parameters
     * @return array The response of API services
     */
    public function get($path, array $query = [])
    {
        return $this->getResponse('GET', $path, $query);
    }

    /**
     * Make a POST request to API services
     *
     * @param string $path Path relative to the API url
     * @param array $data Optional: data to be sent to the API services
     * @param array $query Optional: query parameters
     * @return array The response of API services
     */
    public function post($path, array $data = [], array $query = [])
    {
        return $this->getResponse('POST', $path, $query, $data);
    }

    /**
     * Make a PUT request to API services
     *
     * @param string $path Path relative to the API url
     * @param array $data Optional: data to be sent to the API services
     * @param array $query Optional: query parameters
     * @return array The response of API services
     */
    public function put($path, array $data = [], array $query = [])
    {
        return $this->getResponse('PUT', $path, $query, $data);
    }

    /**
     * Make a DELETE request to API services
     *
     * @param string $path Path relative to the API url
     * @param array $query Optional: query parameters
     * @return array The response of API services
     */
    public function delete($path, array $query = [])
    {
        return $this->getResponse('DELETE', $path, $query);
    }

    /**
     * Make a OPTIONS request to API services
     *
     * @param string $path Path relative to the API url
     * @param array $query Optional: query parameters
     * @return array The response of API services
     */
    public function options($path, array $query = [])
    {
        return $this->getResponse('OPTIONS', $path, $query);
    }

    /**
     * Gets data about the owner of the resources.
     *
     * @return MercadoLibreResourceOwner The {@link https://goo.gl/bBmFoP owner data}
     */
    public function getOwner()
    {
        return $this->token ? $this->provider->getResourceOwner($this->token) : null;
    }
}