Flickr.php

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

namespace chillerlan\OAuth\Providers;

use chillerlan\HTTP\Utils\QueryUtil;
use chillerlan\OAuth\Core\{AuthenticatedUser, InvalidAccessTokenException, OAuth1Provider, UserInfo};
use Psr\Http\Message\{ResponseInterface, StreamInterface};
use function array_merge, sprintf;

/**
 * Flickr OAuth1
 *
 * @link https://www.flickr.com/services/api/auth.oauth.html
 * @link https://www.flickr.com/services/api/
 */
class Flickr extends OAuth1Provider implements UserInfo{

	public const IDENTIFIER = 'FLICKR';

	public const PERM_READ   = 'read';
	public const PERM_WRITE  = 'write';
	public const PERM_DELETE = 'delete';

	protected string      $requestTokenURL  = 'https://www.flickr.com/services/oauth/request_token';
	protected string      $authorizationURL = 'https://www.flickr.com/services/oauth/authorize';
	protected string      $accessTokenURL   = 'https://www.flickr.com/services/oauth/access_token';
	protected string      $apiURL           = 'https://api.flickr.com/services/rest';
	protected string|null $userRevokeURL    = 'https://www.flickr.com/services/auth/list.gne';
	protected string|null $apiDocs          = 'https://www.flickr.com/services/api/';
	protected string|null $applicationURL   = 'https://www.flickr.com/services/apps/create/';

	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 = array_merge(($params ?? []), [
			'method'         => $path,
			'format'         => 'json',
			'nojsoncallback' => true,
		]);

		$request = $this->getRequestAuthorization(
			$this->requestFactory->createRequest(($method ?? 'POST'), QueryUtil::merge($this->apiURL, $params)),
		);

		return $this->http->sendRequest($request);
	}

	/**
	 * hi flickr, can i have a 401 on invalid token???
	 *
	 * @inheritDoc
	 * @codeCoverageIgnore
	 */
	public function me():AuthenticatedUser{

		$json = $this->getMeResponseData($this->apiURL, [
			'method'         => 'flickr.test.login',
			'format'         => 'json',
			'nojsoncallback' => true,
		]);

		if(isset($json['stat'], $json['message']) && $json['stat'] === 'fail'){

			if($json['message'] === 'Invalid auth token'){
				throw new InvalidAccessTokenException($json['message']);
			}

			throw new ProviderException($json['message']);
		}

		$userdata = [
			'data'   => $json['user'],
			'handle' => $json['user']['username']['_content'],
			'id'     => $json['user']['id'],
			'url'    => sprintf('https://www.flickr.com/people/%s/', $json['user']['path_alias']),
		];

		return new AuthenticatedUser($userdata);
	}

}