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

195 lines
4.1 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
2019-12-09 14:34:23 -05:00
use Aviat\Ion\Di\Exception\ContainerException;
use Aviat\Ion\Di\Exception\NotFoundException;
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 Aviat\AnimeClient\API\AbstractListItem;
use Aviat\AnimeClient\Types\FormItemData;
use Aviat\Ion\Di\ContainerAware;
use Aviat\Ion\Json;
2016-12-21 12:46:20 -05:00
2019-12-09 14:34:23 -05:00
use Throwable;
/**
* CRUD operations for Kitsu list items
*/
final class ListItem extends AbstractListItem {
use ContainerAware;
2016-12-21 12:46:20 -05:00
use KitsuTrait;
2019-12-09 14:34:23 -05:00
/**
* @param array $data
* @return Request
* @throws Throwable
*/
public function create(array $data): Request
2018-11-09 10:38:35 -05:00
{
$body = [
'data' => [
'type' => 'libraryEntries',
'attributes' => [
'status' => $data['status'],
'progress' => $data['progress'] ?? 0
],
'relationships' => [
'user' => [
'data' => [
'id' => $data['user_id'],
'type' => 'users'
]
],
'media' => [
'data' => [
'id' => $data['id'],
'type' => $data['type']
]
]
]
]
];
2018-11-09 10:38:35 -05:00
2018-09-26 22:31:04 -04:00
if (array_key_exists('notes', $data))
{
$body['data']['attributes']['notes'] = $data['notes'];
}
$authHeader = $this->getAuthHeader();
$request = $this->requestBuilder->newRequest('POST', 'library-entries');
2020-05-08 19:18:10 -04:00
if ($authHeader !== NULL)
{
$request = $request->setHeader('Authorization', $authHeader);
}
return $request->setJsonBody($body)
->getFullRequest();
2016-12-21 12:46:20 -05:00
}
2019-12-09 14:34:23 -05:00
/**
* @param string $id
* @return Request
* @throws Throwable
*/
public function delete(string $id): Request
2016-12-21 12:46:20 -05:00
{
$authHeader = $this->getAuthHeader();
$request = $this->requestBuilder->newRequest('DELETE', "library-entries/{$id}");
2020-05-08 19:18:10 -04:00
if ($authHeader !== NULL)
{
$request = $request->setHeader('Authorization', $authHeader);
}
return $request->getFullRequest();
2016-12-21 12:46:20 -05:00
}
2019-12-09 14:34:23 -05:00
/**
* @param string $id
* @return array
* @throws Throwable
*/
2016-12-21 12:46:20 -05:00
public function get(string $id): array
{
$authHeader = $this->getAuthHeader();
$request = $this->requestBuilder->newRequest('GET', "library-entries/{$id}")
->setQuery([
'include' => 'media,media.categories,media.mappings'
]);
2020-05-08 19:18:10 -04:00
if ($authHeader !== NULL)
{
$request = $request->setHeader('Authorization', $authHeader);
}
$request = $request->getFullRequest();
2018-11-29 11:00:50 -05:00
$response = getResponse($request);
2020-03-11 16:26:17 -04:00
return Json::decode(wait($response->getBody()->buffer()));
2016-12-21 12:46:20 -05:00
}
/**
* Increase the progress on the medium by 1
*
* @param string $id
* @param FormItemData $data
* @return Request
*/
public function increment(string $id, FormItemData $data): Request
{
return $this->requestBuilder->mutateRequest('IncrementLibraryItem', [
'id' => $id,
'progress' => $data->progress
]);
}
2019-12-09 14:34:23 -05:00
/**
* @param string $id
* @param FormItemData $data
* @return Request
* @throws Throwable
*/
public function update(string $id, FormItemData $data): Request
2016-12-21 12:46:20 -05:00
{
$authHeader = $this->getAuthHeader();
$requestData = [
'data' => [
'id' => $id,
'type' => 'libraryEntries',
'attributes' => $data
]
];
2020-04-24 14:14:52 -04:00
if (((int) $data->progress) === 0)
{
$data->progress = 0;
}
$request = $this->requestBuilder->newRequest('PATCH', "library-entries/{$id}")
->setJsonBody($requestData);
2020-05-08 19:18:10 -04:00
if ($authHeader !== NULL)
{
$request = $request->setHeader('Authorization', $authHeader);
}
return $request->getFullRequest();
2016-12-21 12:46:20 -05:00
}
2019-12-06 15:46:56 -05:00
/**
2019-12-09 14:34:23 -05:00
* @return bool|string
* @throws ContainerException
* @throws NotFoundException
2019-12-06 15:46:56 -05:00
*/
2020-05-08 19:18:10 -04:00
private function getAuthHeader(): ?string
{
2020-05-08 19:18:10 -04:00
$auth = $this->getContainer()->get('auth');
$token = $auth->getAuthToken();
2020-05-08 19:18:10 -04:00
if ( ! empty($token)) {
return "bearer {$token}";
}
2020-05-08 19:18:10 -04:00
return NULL;
}
2016-12-21 12:46:20 -05:00
}