1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 

<?php
/**
 * MercadoLibre Provider for OAuth 2.0 Client
 *
 * 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/oauth2-mercadolibre Repository
 * @link https://docta.github.io/oauth2-mercadolibre Documentation
 */
namespace Docta\MercadoLibre\OAuth2\Client;

use GuzzleHttp\Psr7\Uri;
use GuzzleHttp\Psr7\UriResolver;
use InvalidArgumentException;
use League\OAuth2\Client\Provider\AbstractProvider;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use League\OAuth2\Client\Token\AccessToken;
use League\OAuth2\Client\Tool\BearerAuthorizationTrait;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

/**
 * Represents a service provider.
 */
class Provider extends AbstractProvider
{
    use BearerAuthorizationTrait;

    /**
     * @var string
     */
    protected $apiUrl = 'https://api.mercadolibre.com';

    /**
     * @var array
     */
    protected $authSites = [
        'MLA' => 'https://auth.mercadolibre.com.ar',
        'MLB' => 'https://auth.mercadolivre.com.br',
        'MCO' => 'https://auth.mercadolibre.com.co',
        'MCR' => 'https://auth.mercadolibre.com.cr',
        'MEC' => 'https://auth.mercadolibre.com.ec',
        'MLC' => 'https://auth.mercadolibre.cl',
        'MLM' => 'https://auth.mercadolibre.com.mx',
        'MLU' => 'https://auth.mercadolibre.com.uy',
        'MLV' => 'https://auth.mercadolibre.com.ve',
        'MPA' => 'https://auth.mercadolibre.com.pa',
        'MPE' => 'https://auth.mercadolibre.com.pe',
        'MPT' => 'https://auth.mercadolibre.com.pt',
        'MRD' => 'https://auth.mercadolibre.com.do'
    ];

    /**
     * @var string
     */
    protected $authSite;

    /**
     * @var string
     */
    protected $authUrl;

    /**
     * Constructor.
     *
     * @param array $options
     * @param array $collaborators
     */
    public function __construct(array $options = [], array $collaborators = [])
    {
        // Check options
        $this->assertRequiredOptions($options);
        $this->assertAuthSite($options['authSite']);
        $this->authSite = $options['authSite'];
        $this->authUrl = $this->authSites[$this->authSite];

        // Build and filter options
        $required = $this->getRequiredOptions();
        $configured = array_intersect_key($options, array_flip($required));

        // Set options
        foreach ($configured as $key => $value) {
            $this->$key = $value;
        }

        // Apply the parent constructor
        $options = array_diff_key($options, $configured);
        parent::__construct($options, $collaborators);
    }

    /**
     * Returns all options that are required.
     *
     * @return array
     */
    protected function getRequiredOptions()
    {
        return [
            'authSite',
            'clientId',
            'clientSecret',
            'redirectUri'
        ];
    }

    /**
     * Verifies that all required options have been passed.
     *
     * @param array $options
     * @return void
     * @throws InvalidArgumentException
     */
    private function assertRequiredOptions(array $options)
    {
        $required = $this->getRequiredOptions();
        $missing = array_diff_key(array_flip($required), $options);

        if (!empty($missing)) {
            $missing = array_keys($missing);
            $missing = implode(', ', $missing);
            $template = 'Required options not defined: %s';
            $message = sprintf($template, $missing);
            throw new InvalidArgumentException($message);
        }
    }

    /**
     * Verifies that the `authSite` passed is valid.
     *
     * @param string $authSite
     * @return void
     * @throws InvalidArgumentException
     */
    private function assertAuthSite($authSite)
    {
        if (!array_key_exists($authSite, $this->authSites)) {
            $validValues = array_keys($this->authSites);
            $validValues = implode(', ', $validValues);
            $template = 'Valid values for authSite are only: %s';
            $message = sprintf($template, $validValues);
            throw new InvalidArgumentException($message);
        }
    }

    /**
     * Builds the authorization URL.
     *
     * @param array $options
     * @return string The authorization URL
     */
    public function getAuthorizationUrl(array $options = [])
    {
        $options = array_merge(['approval_prompt' => null], $options);
        return parent::getAuthorizationUrl($options);
    }

    /**
     * Build and returns the URL for API requests.
     *
     * @param string $path
     * @param array $query
     * @return string
     */
    public function getApiUrl($path = '/', array $query = [])
    {
        $base = new Uri($this->apiUrl);
        $path = new Uri($path);

        foreach ($query as $key => $value) {
            $path = Uri::withQueryValue($path, $key, $value);
        }

        return (string) UriResolver::resolve($base, $path);
    }

    /**
     * Returns the base URL for authorizing a client.
     *
     * @return string
     */
    public function getBaseAuthorizationUrl()
    {
        $base = new Uri($this->authUrl);
        $path = new Uri('/authorization');
        return (string) UriResolver::resolve($base, $path);
        ;
    }

    /**
     * Returns the base URL for requesting an access token.
     *
     * @param array|null $params
     * @return string
     */
    public function getBaseAccessTokenUrl(array $params = null)
    {
        return $this->getApiUrl('/oauth/token');
    }

    /**
     * Returns the URL for requesting the resource owner's details.
     *
     * @param AccessToken|null $token
     * @return string
     */
    public function getResourceOwnerDetailsUrl(AccessToken $token = null)
    {
        return $this->getApiUrl('/users/me');
    }

    /**
     * Returns the default scopes used by this provider.
     *
     * @return null
     */
    public function getDefaultScopes()
    {
        return null;
    }

    /**
     * Returns the key used in the access token
     * response to identify the resource owner.
     *
     * @return string Resource owner identifier key
     */
    protected function getAccessTokenResourceOwnerId()
    {
        return 'user_id';
    }

    /**
     * Returns an authenticated PSR-7 request instance.
     *
     * @todo Use only authorization by HTTP header and remove the query parameter.
     *
     * @param string $method
     * @param string $url
     * @param AccessToken|string $token
     * @param array $options Any of `headers`, `body`, and `protocolVersion`.
     * @return RequestInterface
     */
    public function getAuthenticatedRequest($method, $url, $token, array $options = [])
    {
        $url = Uri::withQueryValue(new Uri($url), 'access_token', (string) $token);
        return $this->createRequest($method, (string) $url, $token, $options);
    }


    /**
     * 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 (isset($data['error'])) {
            throw new IdentityProviderException((string) $data['error'], (int) $data['status'], $data);
        }
    }

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