HummingBirdAnimeClient/src/AnimeClient/API/APIRequestBuilder.php

411 lines
7.9 KiB
PHP
Raw Normal View History

<?php declare(strict_types=1);
/**
2017-02-15 16:13:32 -05:00
* Hummingbird Anime List Client
*
2018-08-22 13:48:27 -04:00
* An API client for Kitsu to manage anime and manga watch lists
*
* PHP version 7.4
*
2017-02-15 16:13:32 -05:00
* @package HummingbirdAnimeClient
* @author Timothy J. Warren <tim@timshomepage.net>
2020-01-08 15:39:49 -05:00
* @copyright 2015 - 2020 Timothy J. Warren
* @license http://www.opensource.org/licenses/mit-license.html MIT License
2020-08-04 09:30:21 -04:00
* @version 5.1
* @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient
*/
namespace Aviat\AnimeClient\API;
use const Aviat\AnimeClient\USER_AGENT;
use function Amp\Promise\wait;
2018-11-29 11:00:50 -05:00
use function Aviat\AnimeClient\getResponse;
2020-03-11 16:26:17 -04:00
use Amp\Http\Client\Request;
use Amp\Http\Client\Body\FormBody;
use Aviat\Ion\Json;
use InvalidArgumentException;
use Psr\Log\LoggerAwareTrait;
/**
2020-03-11 16:26:17 -04:00
* Wrapper around Http\Client to make it easier to build API requests
*/
2019-12-09 14:34:23 -05:00
abstract class APIRequestBuilder {
use LoggerAwareTrait;
/**
* Where to look for GraphQL request files
* @var string
*/
protected string $filePath = __DIR__;
/**
* Url prefix for making url requests
* @var string
*/
2020-04-10 20:01:46 -04:00
protected string $baseUrl = '';
/**
* Url path of the request
* @var string
*/
2020-04-10 20:01:46 -04:00
protected string $path = '';
/**
* Query string for the request
* @var string
*/
2020-04-10 20:01:46 -04:00
protected string $query = '';
/**
* Default request headers
* @var array
*/
2020-04-10 20:01:46 -04:00
protected array $defaultHeaders = [];
/**
* Valid HTTP request methods
* @var array
*/
2020-04-10 20:01:46 -04:00
protected array $validMethods = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'];
/**
* The current request
2019-12-06 15:46:56 -05:00
* @var Request
*/
2020-04-10 20:01:46 -04:00
protected Request $request;
2018-10-01 10:50:22 -04:00
/**
* Do a basic minimal GET request
*
* @param string $uri
* @return Request
*/
public static function simpleRequest(string $uri): Request
{
2020-04-10 20:01:46 -04:00
$request = (new Request($uri));
$request->setHeader('User-Agent', USER_AGENT);
$request->setTcpConnectTimeout(300000);
$request->setTransferTimeout(300000);
2020-04-10 20:01:46 -04:00
return $request;
2018-10-01 10:50:22 -04:00
}
/**
* Set an authorization header
*
* @param string $type The type of authorization, eg, basic, bearer, etc.
* @param string $value The authorization value
* @return self
*/
public function setAuth(string $type, string $value): self
{
$authString = ucfirst($type) . ' ' . $value;
$this->setHeader('Authorization', $authString);
return $this;
}
/**
* Set a basic authentication header
*
* @param string $username
* @param string $password
* @return self
*/
public function setBasicAuth(string $username, string $password): self
{
$this->setAuth('basic', base64_encode($username . ':' . $password));
return $this;
}
/**
* Set the request body
*
* @param FormBody|string $body
* @throws \TypeError
* @return self
*/
public function setBody($body): self
{
2020-03-11 16:26:17 -04:00
$this->request->setBody($body);
return $this;
}
/**
* Set body as form fields
*
* @param array $fields Mapping of field names to values
* @throws \TypeError
* @return self
*/
public function setFormFields(array $fields): self
{
$body = new FormBody();
$body->addFields($fields);
return $this->setBody($body);
}
2018-01-10 16:34:25 -05:00
/**
* Unset a request header
*
* @param string $name
* @return self
*/
public function unsetHeader(string $name): self
{
2020-03-11 16:26:17 -04:00
$this->request->removeHeader($name);
return $this;
}
/**
* Set a request header
*
* @param string $name
* @param string $value
* @return self
*/
public function setHeader(string $name, string $value = NULL): self
{
if (NULL === $value)
{
$this->unsetHeader($name);
}
else
{
2020-03-11 16:26:17 -04:00
$this->request->setHeader($name, $value);
}
return $this;
}
/**
* Set multiple request headers
*
* name => value
*
* @param array $headers
* @return self
*/
public function setHeaders(array $headers): self
{
foreach ($headers as $name => $value)
{
$this->setHeader($name, $value);
}
return $this;
}
/**
* Set the request body
*
* @param mixed $body
* @throws \TypeError
* @return self
*/
public function setJsonBody($body): self
{
$requestBody = ( ! is_scalar($body))
? Json::encode($body)
: $body;
return $this->setBody($requestBody);
}
/**
* Append a query string in array format
*
* @param array $params
* @return self
*/
public function setQuery(array $params): self
{
$this->query = http_build_query($params);
return $this;
}
/**
* Return the promise for the current request
*
2019-12-06 15:46:56 -05:00
* @return Request
* @throws \Throwable
*/
public function getFullRequest(): Request
{
$this->buildUri();
2019-12-06 15:46:56 -05:00
if ($this->logger !== NULL)
{
$this->logger->debug('API Request', [
'request_url' => $this->request->getUri(),
'request_headers' => $this->request->getHeaders(),
'request_body' => wait(
$this->request->getBody()
->createBodyStream()
->read()
)
]);
}
return $this->request;
}
2018-01-10 16:34:25 -05:00
/**
* Get the data from the response of the passed request
*
* @param Request $request
* @return mixed
* @throws \Error
* @throws \Throwable
* @throws \TypeError
*/
public function getResponseData(Request $request)
{
2018-11-29 11:00:50 -05:00
$response = getResponse($request);
2020-03-11 16:26:17 -04:00
return wait($response->getBody()->buffer());
2018-01-10 16:34:25 -05:00
}
/**
* Create a new http request
*
* @param string $type
* @param string $uri
2017-02-17 10:55:17 -05:00
* @throws InvalidArgumentException
* @return self
*/
public function newRequest(string $type, string $uri): self
{
if ( ! in_array($type, $this->validMethods, TRUE))
{
throw new InvalidArgumentException('Invalid HTTP method');
}
$realUrl = (strpos($uri, '//') !== FALSE)
? $uri
: $this->baseUrl . $uri;
$this->resetState($realUrl, $type);
$this->path = $uri;
// Actually create the full url!
$this->buildUri();
if ( ! empty($this->defaultHeaders))
{
$this->setHeaders($this->defaultHeaders);
}
return $this;
}
/**
* Create a GraphQL query and return the Request object
*
* @param string $name
* @param array $variables
* @return Request
*/
public function queryRequest(string $name, array $variables = []): Request
{
$file = "{$this->filePath}/Queries/{$name}.graphql";
if ( ! file_exists($file))
{
throw new LogicException('GraphQL query file does not exist.');
}
$query = file_get_contents($file);
$body = [
'query' => $query
];
if ( ! empty($variables))
{
$body['variables'] = [];
foreach($variables as $key => $val)
{
$body['variables'][$key] = $val;
}
}
return $this->setUpRequest('POST', $this->baseUrl, [
'body' => $body,
]);
}
/**
* Create a GraphQL mutation request, and return the Request object
*
* @param string $name
* @param array $variables
* @return Request
* @throws Throwable
*/
public function mutateRequest (string $name, array $variables = []): Request
{
$file = "{$this->filePath}/Mutations/{$name}.graphql";
if ( ! file_exists($file))
{
throw new LogicException('GraphQL mutation file does not exist.');
}
$query = file_get_contents($file);
$body = [
'query' => $query
];
if (!empty($variables)) {
$body['variables'] = [];
foreach ($variables as $key => $val)
{
$body['variables'][$key] = $val;
}
}
return $this->setUpRequest('POST', $this->baseUrl, [
'body' => $body,
]);
}
/**
* Create the full request url
*
* @return Request
*/
private function buildUri(): Request
{
$url = (strpos($this->path, '//') !== FALSE)
? $this->path
: $this->baseUrl . $this->path;
if ( ! empty($this->query))
{
$url .= '?' . $this->query;
}
2020-03-11 16:26:17 -04:00
$this->request->setUri($url);
return $this->request;
}
/**
* Reset the class state for a new request
*
* @param string $url
* @param string $type
* @return void
*/
2018-11-09 10:38:35 -05:00
private function resetState($url, $type = 'GET'): void
{
$requestUrl = $url ?: $this->baseUrl;
$this->path = '';
$this->query = '';
2020-03-11 16:26:17 -04:00
$this->request = new Request($requestUrl, $type);
$this->request->setInactivityTimeout(300000);
$this->request->setTlsHandshakeTimeout(300000);
2020-03-11 16:26:17 -04:00
$this->request->setTcpConnectTimeout(300000);
$this->request->setTransferTimeout(300000);
}
}