MailChimp.php

<?php
/**
 * Class MailChimp
 *
 * @created      16.08.2018
 * @author       smiley <smiley@chillerlan.net>
 * @copyright    2018 smiley
 * @license      MIT
 */
declare(strict_types=1);

namespace chillerlan\OAuth\Providers;

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

/**
 * MailChimp OAuth2
 *
 * @link https://mailchimp.com/developer/
 * @link https://mailchimp.com/developer/marketing/guides/access-user-data-oauth-2/
 */
class MailChimp extends OAuth2Provider implements CSRFToken, UserInfo{

	public const IDENTIFIER = 'MAILCHIMP';

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

	protected string      $authorizationURL = 'https://login.mailchimp.com/oauth2/authorize';
	protected string      $accessTokenURL   = 'https://login.mailchimp.com/oauth2/token';
	protected string|null $apiDocs          = 'https://mailchimp.com/developer/';
	protected string|null $applicationURL   = 'https://admin.mailchimp.com/account/oauth2/';
	// set to empty so that we don't run into "uninitialized" errors in mock tests, as the datacenter is in the token
	protected string      $apiURL           = '';

	public function getAccessToken(string $code, string|null $state = null):AccessToken{
		$this->checkState($state);

		$body     = $this->getAccessTokenRequestBodyParams($code);
		$response = $this->sendAccessTokenRequest($this->accessTokenURL, $body);
		$token    = $this->parseTokenResponse($response);

		// MailChimp needs another call to the auth metadata endpoint
		// to receive the datacenter prefix/API URL, which will then
		// be stored in AccessToken::$extraParams

		return $this->getTokenMetadata($token);
	}

	/**
	 * @throws \chillerlan\OAuth\OAuthException
	 */
	public function getTokenMetadata(AccessToken|null $token = null):AccessToken{
		$token ??= $this->storage->getAccessToken($this->name);

		$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->name);

		return $token;
	}

	public function request(
		string                            $path,
		array|null                        $params = null,
		string|null                       $method = null,
		StreamInterface|array|string|null $body = null,
		array|null                        $headers = null,
		string|null                       $protocolVersion = null,
	):ResponseInterface{
		$token = $this->storage->getAccessToken($this->name);
		// get the API URL from the token metadata
		$this->apiURL = sprintf($this::API_BASE, $token->extraParams['dc']);

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

	protected function sendMeRequest(string $endpoint, array|null $params = null):ResponseInterface{
		return $this->request(path: $endpoint, params: $params);
	}

	/**
	 * @link https://mailchimp.com/developer/marketing/api/root/list-api-root-resources/
	 *
	 * @inheritDoc
	 * @codeCoverageIgnore
	 */
	public function me():AuthenticatedUser{
		$json = $this->getMeResponseData('/3.0/'); // trailing slash!

		$userdata = [
			'data'        => $json,
			'avatar'      => $json['avatar_url'],
			'displayName' => $json['username'],
			'handle'      => $json['account_name'],
			'email'       => $json['email'],
			'id'          => $json['account_id'],
		];

		return new AuthenticatedUser($userdata);
	}

}