chillerlan\OAuth\Providers\MailChimp\MailChimp

Complexity

Total Complexity

4

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getTokenMetadata()	0	24	3
A	request()	0	12	1

<?php
/**
 * Class MailChimp
 *
 * @link http://developer.mailchimp.com/
 * @link http://developer.mailchimp.com/documentation/mailchimp/guides/how-to-use-oauth2/
 *
 * @filesource   MailChimp.php
 * @created      16.08.2018
 * @package      chillerlan\OAuth\Providers\MailChimp
 * @author       smiley <smiley@chillerlan.net>
 * @copyright    2018 smiley
 * @license      MIT
 */

namespace chillerlan\OAuth\Providers\MailChimp;

use chillerlan\OAuth\Core\{AccessToken, CSRFToken, OAuth2Provider};
use chillerlan\OAuth\OAuthException;
use Psr\Http\Message\ResponseInterface;

use function array_merge, sprintf;
use function chillerlan\HTTP\Psr7\get_json;

/**
 * @method \Psr\Http\Message\ResponseInterface createAuthorizedApp(array $body = ['client_id', 'client_secret'])
 * @method \Psr\Http\Message\ResponseInterface getAuthorizedApp(array $params = ['fields', 'exclude_fields'])
 * @method \Psr\Http\Message\ResponseInterface getAuthorizedAppList(array $params = ['fields', 'exclude_fields', 'count', 'offset'])
 * @method \Psr\Http\Message\ResponseInterface ping()
 * @method \Psr\Http\Message\ResponseInterface root(array $params = ['fields', 'exclude_fields'])
 */
class MailChimp extends OAuth2Provider implements CSRFToken{

	protected const API_BASE          = 'https://%s.api.mailchimp.com/3.0';
	protected const METADATA_ENDPOINT = 'https://login.mailchimp.com/oauth2/metadata';

	protected string $authURL          = 'https://login.mailchimp.com/oauth2/authorize';
	protected string $accessTokenURL   = 'https://login.mailchimp.com/oauth2/token';
	protected ?string $endpointMap     = MailChimpEndpoints::class;
	protected ?string $apiDocs         = 'https://developer.mailchimp.com/';
	protected ?string $applicationURL  = 'https://admin.mailchimp.com/account/oauth2/';
	protected string $authMethodHeader = 'OAuth';

	/**
	 * @param \chillerlan\OAuth\Core\AccessToken|null $token
	 *
	 * @return \chillerlan\OAuth\Core\AccessToken
	 * @throws \chillerlan\OAuth\OAuthException
	 */
	public function getTokenMetadata(AccessToken $token = null):AccessToken{

		$token ??= $this->storage->getAccessToken($this->serviceName);

		if(!$token instanceof AccessToken){

$token is always a sub-type of chillerlan\OAuth\Core\AccessToken.

			throw new OAuthException('invalid token'); // @codeCoverageIgnore
		}

		$request = $this->requestFactory
			->createRequest('GET', $this::METADATA_ENDPOINT)
			->withHeader('Authorization', 'OAuth '.$token->accessToken)
		;

		$response = $this->http->sendRequest($request);

		if($response->getStatusCode() !== 200){
			throw new OAuthException('metadata response error'); // @codeCoverageIgnore
		}

		$token->extraParams = array_merge($token->extraParams, get_json($response, true));

		$this->storage->storeAccessToken($this->serviceName, $token);

		return $token;
	}

	/**
	 * prepare the API URL from the token metadata
	 *
	 * @inheritdoc
	 */
	public function request(
		string $path,
		array $params = null,
		string $method = null,
		$body = null,
		array $headers = null
	):ResponseInterface{
		$token = $this->storage->getAccessToken($this->serviceName);

		$this->apiURL = sprintf($this::API_BASE, $token->extraParams['dc']);

		return parent::request($path, $params, $method, $body, $headers);
	}

}