chillerlan / php-oauth-providers

src/MailChimp.php

<?php
/**
 * Class MailChimp
 *
 * @created      16.08.2018
 * @author       smiley <smiley@chillerlan.net>
 * @copyright    2018 smiley
 * @license      MIT
 */

namespace chillerlan\OAuth\Providers;

use chillerlan\HTTP\Utils\MessageUtil;
use chillerlan\OAuth\Core\{AccessToken, CSRFToken, OAuth2Provider, ProviderException};
use chillerlan\OAuth\OAuthException;
use Psr\Http\Message\{ResponseInterface, StreamInterface};
use function array_merge;
use function sprintf;

/**
 * @see http://developer.mailchimp.com/
 * @see http://developer.mailchimp.com/documentation/mailchimp/guides/how-to-use-oauth2/
 */
class MailChimp extends OAuth2Provider implements CSRFToken{

	protected const API_BASE            = 'https://%s.api.mailchimp.com';
	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 $apiDocs          = 'https://developer.mailchimp.com/';
	protected ?string $applicationURL   = 'https://admin.mailchimp.com/account/oauth2/';
	protected string  $authMethodHeader = 'OAuth';

	/**
	 * @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, MessageUtil::decodeJSON($response, true));

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

		return $token;
	}

	/**
	 * prepare the API URL from the token metadata
	 *
	 * @inheritdoc
	 */
	public function request(
		string $path,
		array $params = null,
		string $method = null,
		StreamInterface|array|string $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);
	}

	/**
	 * @see https://mailchimp.com/developer/marketing/api/root/list-api-root-resources/
	 * @inheritDoc
	 */
	public function me():ResponseInterface{
		$response = $this->request('/3.0/'); // trailing slash!
		$status   = $response->getStatusCode();

		if($status === 200){
			return $response;
		}

		$json = MessageUtil::decodeJSON($response);

		if(isset($json->detail)){
			throw new ProviderException($json->detail);
		}

		throw new ProviderException(sprintf('user info error error HTTP/%s', $status));
	}

}