HummingBirdAnimeClient/src/AnimeClient/API/Kitsu/KitsuTrait.php

259 lines
5.5 KiB
PHP
Raw Normal View History

2016-12-21 12:46:20 -05:00
<?php declare(strict_types=1);
/**
2017-02-15 16:13:32 -05:00
* Hummingbird Anime List Client
2016-12-21 12:46:20 -05:00
*
2018-08-22 13:48:27 -04:00
* An API client for Kitsu to manage anime and manga watch lists
2016-12-21 12:46:20 -05:00
*
* PHP version 7.4
2016-12-21 12:46:20 -05:00
*
2017-02-15 16:13:32 -05:00
* @package HummingbirdAnimeClient
2017-01-06 23:34:56 -05:00
* @author Timothy J. Warren <tim@timshomepage.net>
2020-01-08 15:39:49 -05:00
* @copyright 2015 - 2020 Timothy J. Warren
2017-01-06 23:34:56 -05:00
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 5
* @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient
*/
namespace Aviat\AnimeClient\API\Kitsu;
2016-12-21 12:46:20 -05:00
use const Aviat\AnimeClient\SESSION_SEGMENT;
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\Response;
use Aviat\AnimeClient\API\{
FailedResponseException,
Kitsu as K
};
use Aviat\Ion\Json;
use Aviat\Ion\JsonException;
2016-12-21 12:46:20 -05:00
2019-12-09 14:34:23 -05:00
use Throwable;
2016-12-21 12:46:20 -05:00
trait KitsuTrait {
2017-02-07 13:27:41 -05:00
/**
2018-08-22 13:43:04 -04:00
* The request builder for the Kitsu API
2017-03-20 19:08:33 -04:00
* @var KitsuRequestBuilder
*/
2020-04-10 20:01:46 -04:00
protected KitsuRequestBuilder $requestBuilder;
2017-02-07 13:27:41 -05:00
/**
* Set the request builder object
*
* @param KitsuRequestBuilder $requestBuilder
* @return self
*/
public function setRequestBuilder($requestBuilder): self
{
$this->requestBuilder = $requestBuilder;
return $this;
}
2016-12-21 12:46:20 -05:00
/**
* Create a request object
*
* @param string $type
* @param string $url
* @param array $options
2019-12-09 14:34:23 -05:00
* @return Request
*/
public function setUpRequest(string $type, string $url, array $options = []): Request
{
$request = $this->requestBuilder->newRequest($type, $url);
$sessionSegment = $this->getContainer()
->get('session')
->getSegment(SESSION_SEGMENT);
2017-03-22 11:41:25 -04:00
$cache = $this->getContainer()->get('cache');
$cacheItem = $cache->getItem('kitsu-auth-token');
$token = null;
2017-02-17 11:37:22 -05:00
if ($sessionSegment->get('auth_token') !== NULL && $url !== K::AUTH_URL)
{
$token = $sessionSegment->get('auth_token');
if ( ! $cacheItem->isHit())
{
$cacheItem->set($token);
$cacheItem->save();
}
2017-03-22 11:41:25 -04:00
}
else if ($sessionSegment->get('auth_token') === NULL && $cacheItem->isHit())
{
$token = $cacheItem->get();
}
if (NULL !== $token)
2017-03-22 11:41:25 -04:00
{
$request = $request->setAuth('bearer', $token);
}
2017-03-22 11:41:25 -04:00
if (array_key_exists('form_params', $options))
{
$request = $request->setFormFields($options['form_params']);
}
if (array_key_exists('query', $options))
{
$request = $request->setQuery($options['query']);
}
if (array_key_exists('body', $options))
{
$request = $request->setJsonBody($options['body']);
}
if (array_key_exists('headers', $options))
{
$request = $request->setHeaders($options['headers']);
}
return $request->getFullRequest();
}
/**
* Make a request
*
* @param string $type
* @param string $url
* @param array $options
* @return Response
2019-12-09 14:34:23 -05:00
* @throws Throwable
*/
2018-11-09 10:38:35 -05:00
private function getResponse(string $type, string $url, array $options = []): Response
{
$logger = NULL;
if ($this->getContainer())
{
$logger = $this->container->getLogger('kitsu-request');
}
$request = $this->setUpRequest($type, $url, $options);
2018-11-29 11:00:50 -05:00
$response = getResponse($request);
if ($logger)
{
$logger->debug('Kitsu API Response', [
'response_status' => $response->getStatus(),
'request_headers' => $response->getOriginalRequest()->getHeaders(),
'response_headers' => $response->getHeaders()
]);
}
2017-02-04 15:18:34 -05:00
return $response;
}
/**
* Make a request
*
* @param string $type
* @param string $url
* @param array $options
2019-12-09 14:34:23 -05:00
* @throws JsonException
* @throws FailedResponseException
2019-12-09 14:34:23 -05:00
* @throws Throwable
* @return array
*/
private function request(string $type, string $url, array $options = []): array
{
2017-02-17 11:37:22 -05:00
$logger = NULL;
if ($this->getContainer())
{
$logger = $this->container->getLogger('kitsu-request');
}
$response = $this->getResponse($type, $url, $options);
2019-12-09 14:34:23 -05:00
if ((int) $response->getStatus() > 299 || (int) $response->getStatus() < 200)
{
if ($logger)
{
2017-04-05 13:01:51 -04:00
$logger->warning('Non 200 response for api call', (array)$response);
}
2017-04-05 13:01:51 -04:00
throw new FailedResponseException('Failed to get the proper response from the API');
}
try
{
2020-03-11 16:26:17 -04:00
return Json::decode(wait($response->getBody()->buffer()));
}
catch (JsonException $e)
{
print_r($e);
die();
}
}
/**
* Remove some boilerplate for get requests
*
2017-02-17 11:37:22 -05:00
* @param mixed ...$args
2019-12-09 14:34:23 -05:00
* @throws Throwable
* @return array
*/
protected function getRequest(...$args): array
{
return $this->request('GET', ...$args);
}
/**
* Remove some boilerplate for patch requests
*
2017-02-17 11:37:22 -05:00
* @param mixed ...$args
2019-12-09 14:34:23 -05:00
* @throws Throwable
* @return array
*/
protected function patchRequest(...$args): array
{
return $this->request('PATCH', ...$args);
}
/**
* Remove some boilerplate for post requests
*
2017-02-17 11:37:22 -05:00
* @param mixed ...$args
2019-12-09 14:34:23 -05:00
* @throws Throwable
* @return array
*/
protected function postRequest(...$args): array
{
2017-02-17 11:37:22 -05:00
$logger = NULL;
if ($this->getContainer())
{
$logger = $this->container->getLogger('kitsu-request');
}
$response = $this->getResponse('POST', ...$args);
$validResponseCodes = [200, 201];
if ( ! \in_array((int) $response->getStatus(), $validResponseCodes, TRUE))
{
if ($logger)
{
2017-02-04 15:18:34 -05:00
$logger->warning('Non 201 response for POST api call', $response->getBody());
}
}
2020-03-11 16:26:17 -04:00
return JSON::decode(wait($response->getBody()->buffer()), TRUE);
}
/**
* Remove some boilerplate for delete requests
*
2017-02-17 11:37:22 -05:00
* @param mixed ...$args
2019-12-09 14:34:23 -05:00
* @throws Throwable
* @return bool
*/
protected function deleteRequest(...$args): bool
{
$response = $this->getResponse('DELETE', ...$args);
return ((int) $response->getStatus() === 204);
}
2016-12-21 12:46:20 -05:00
}