MusicBrainz.php

<?php
/**
 * Class MusicBrainz
 *
 * @created      31.07.2018
 * @author       Smiley <smiley@chillerlan.net>
 * @copyright    2017 Smiley
 * @license      MIT
 *
 * @noinspection PhpUnused
 */
declare(strict_types=1);

namespace chillerlan\OAuth\Providers;

use chillerlan\OAuth\Core\{
	AccessToken, AuthenticatedUser, CSRFToken, OAuth2Provider, TokenInvalidate, TokenInvalidateTrait, TokenRefresh, UserInfo,
};
use Psr\Http\Message\{ResponseInterface, StreamInterface};
use function in_array, strtoupper;

/**
 * MusicBrainz OAuth2
 *
 * @link https://musicbrainz.org/doc/Development
 * @link https://musicbrainz.org/doc/Development/OAuth2
 */
class MusicBrainz extends OAuth2Provider implements CSRFToken, TokenInvalidate, TokenRefresh, UserInfo{
	use TokenInvalidateTrait;

	public const IDENTIFIER = 'MUSICBRAINZ';

	public const SCOPE_PROFILE        = 'profile';
	public const SCOPE_EMAIL          = 'email';
	public const SCOPE_TAG            = 'tag';
	public const SCOPE_RATING         = 'rating';
	public const SCOPE_COLLECTION     = 'collection';
	public const SCOPE_SUBMIT_ISRC    = 'submit_isrc';
	public const SCOPE_SUBMIT_BARCODE = 'submit_barcode';

	public const DEFAULT_SCOPES = [
		self::SCOPE_PROFILE,
		self::SCOPE_EMAIL,
		self::SCOPE_TAG,
		self::SCOPE_RATING,
		self::SCOPE_COLLECTION,
	];

	protected string      $authorizationURL = 'https://musicbrainz.org/oauth2/authorize';
	protected string      $accessTokenURL   = 'https://musicbrainz.org/oauth2/token';
	protected string      $revokeURL        = 'https://musicbrainz.org/oauth2/revoke ';
	protected string      $apiURL           = 'https://musicbrainz.org/ws/2';
	protected string|null $userRevokeURL    = 'https://musicbrainz.org/account/applications';
	protected string|null $apiDocs          = 'https://musicbrainz.org/doc/Development';
	protected string|null $applicationURL   = 'https://musicbrainz.org/account/applications';

	protected function getRefreshAccessTokenRequestBodyParams(string $refreshToken):array{
		return [
			'client_id'     => $this->options->key,
			'client_secret' => $this->options->secret,
			'grant_type'    => 'refresh_token',
			'refresh_token' => $refreshToken,
		];
	}

	/**
	 * @return array<string, scalar|bool|null>
	 */
	protected function getInvalidateAccessTokenBodyParams(AccessToken $token, string $type):array{
		return [
			'client_id'       => $this->options->key,
			'client_secret'   => $this->options->secret,
			'token'           => $token->accessToken,
			'token_type_hint' => $type,
		];
	}

	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{
		$params = ($params ?? []);
		$method = strtoupper(($method ?? 'GET'));

		if(!isset($params['fmt'])){
			$params['fmt'] = 'json';
		}

		if(in_array($method, ['POST', 'PUT', 'DELETE'], true) && !isset($params['client'])){
			$params['client'] = $this::USER_AGENT; // @codeCoverageIgnore
		}

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

	/** @codeCoverageIgnore */
	public function me():AuthenticatedUser{
		$json = $this->getMeResponseData('https://musicbrainz.org/oauth2/userinfo', ['fmt' => 'json']);

		$userdata = [
			'data'   => $json,
			'handle' => $json['sub'],
			'email'  => $json['email'],
			'id'     => $json['metabrainz_user_id'],
			'url'    => $json['profile'],
		];

		return new AuthenticatedUser($userdata);
	}

}