HummingBirdAnimeClient/src/API/Kitsu/KitsuModel.php

310 lines
6.6 KiB
PHP
Raw Normal View History

2016-12-21 12:46:20 -05:00
<?php declare(strict_types=1);
/**
* Anime List Client
*
* An API client for Kitsu and MyAnimeList to manage anime and manga watch lists
*
* PHP version 7
*
2017-01-06 23:34:56 -05:00
* @package AnimeListClient
* @author Timothy J. Warren <tim@timshomepage.net>
2017-01-11 10:30:53 -05:00
* @copyright 2015 - 2017 Timothy J. Warren
2017-01-06 23:34:56 -05:00
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 4.0
* @link https://github.com/timw4mail/HummingBirdAnimeClient
*/
namespace Aviat\AnimeClient\API\Kitsu;
2016-12-21 12:46:20 -05:00
2017-01-12 15:41:20 -05:00
use Aviat\AnimeClient\API\JsonAPI;
use Aviat\AnimeClient\API\Kitsu as K;
2017-01-03 21:06:49 -05:00
use Aviat\AnimeClient\API\Kitsu\Transformer\{
2017-01-04 13:16:58 -05:00
AnimeTransformer, AnimeListTransformer, MangaTransformer, MangaListTransformer
2017-01-03 21:06:49 -05:00
};
use Aviat\Ion\Di\ContainerAware;
use Aviat\Ion\Json;
use GuzzleHttp\Exception\ClientException;
2016-12-21 12:46:20 -05:00
/**
* Kitsu API Model
*/
class KitsuModel {
use ContainerAware;
2016-12-21 12:46:20 -05:00
use KitsuTrait;
/**
* Class to map anime list items
* to a common format used by
* templates
*
* @var AnimeListTransformer
*/
protected $animeListTransformer;
/**
* @var AnimeTransformer
*/
protected $animeTransformer;
/**
* @var ListItem
*/
protected $listItem;
/**
* @var MangaTransformer
*/
protected $mangaTransformer;
2017-01-04 13:16:58 -05:00
/**
* @var MangaListTransformer
*/
2017-01-03 21:06:49 -05:00
protected $mangaListTransformer;
/**
* KitsuModel constructor.
*/
public function __construct(ListItem $listItem)
2016-12-21 12:46:20 -05:00
{
// Set up Guzzle trait
$this->init();
$this->animeTransformer = new AnimeTransformer();
2016-12-21 12:46:20 -05:00
$this->animeListTransformer = new AnimeListTransformer();
$this->listItem = $listItem;
2017-01-04 13:16:58 -05:00
$this->mangaTransformer = new MangaTransformer();
2017-01-03 21:06:49 -05:00
$this->mangaListTransformer = new MangaListTransformer();
2016-12-21 12:46:20 -05:00
}
/**
* Get the userid for a username from Kitsu
*
* @param string $username
* @return string
*/
public function getUserIdByUsername(string $username)
{
$data = $this->getRequest('users', [
'query' => [
'filter' => [
'name' => $username
]
]
]);
return $data['data'][0]['id'];
}
2016-12-21 12:46:20 -05:00
/**
* Get the access token from the Kitsu API
*
* @param string $username
* @param string $password
* @return bool|string
*/
public function authenticate(string $username, string $password)
{
$response = $this->getResponse('POST', K::AUTH_URL, [
'headers' => [],
'form_params' => [
2016-12-21 12:46:20 -05:00
'grant_type' => 'password',
'username' => $username,
'password' => $password
]
2016-12-21 12:46:20 -05:00
]);
$data = Json::decode((string)$response->getBody());
if (array_key_exists('access_token', $data))
{
return $data['access_token'];
2016-12-21 12:46:20 -05:00
}
return false;
}
/**
* Get information about a particular anime
*
* @param string $animeId
* @return array
*/
public function getAnime(string $animeId): array
{
$baseData = $this->getRawMediaData('anime', $animeId);
return $this->animeTransformer->transform($baseData);
}
/**
* Get information about a particular manga
*
* @param string $mangaId
* @return array
*/
2017-01-04 13:16:58 -05:00
public function getManga(string $mangaId): array
{
2017-01-04 13:16:58 -05:00
$baseData = $this->getRawMediaData('manga', $mangaId);
return $this->mangaTransformer->transform($baseData);
}
public function getAnimeList($status): array
{
$options = [
2016-12-21 12:46:20 -05:00
'query' => [
'filter' => [
'user_id' => $this->getUserIdByUsername($this->getUsername()),
'media_type' => 'Anime',
'status' => $status,
],
2017-01-12 15:41:20 -05:00
'include' => 'media,media.genres,media.mappings',
'page' => [
'offset' => 0,
2017-01-12 15:41:20 -05:00
'limit' => 500
2016-12-21 12:46:20 -05:00
],
'sort' => '-updated_at'
2016-12-21 12:46:20 -05:00
]
];
2016-12-21 12:46:20 -05:00
$data = $this->getRequest('library-entries', $options);
2017-01-12 15:41:20 -05:00
$included = JsonAPI::organizeIncludes($data['included']);
$included = JsonAPI::inlineIncludedRelationships($included, 'anime');
2016-12-21 12:46:20 -05:00
foreach($data['data'] as $i => &$item)
2016-12-21 12:46:20 -05:00
{
2017-01-12 15:41:20 -05:00
$item['included'] =& $included;
2016-12-21 12:46:20 -05:00
}
$transformed = $this->animeListTransformer->transformCollection($data['data']);
return $transformed;
}
2017-01-03 21:06:49 -05:00
public function getMangaList($status): array
2017-01-04 13:16:58 -05:00
{
$options = [
'query' => [
'filter' => [
'user_id' => $this->getUserIdByUsername($this->getUsername()),
2017-01-04 13:16:58 -05:00
'media_type' => 'Manga',
'status' => $status,
],
'include' => 'media',
'page' => [
'offset' => 0,
'limit' => 200
],
'sort' => '-updated_at'
]
];
$data = $this->getRequest('library-entries', $options);
foreach($data['data'] as $i => &$item)
{
$item['manga'] = $data['included'][$i];
}
$transformed = $this->mangaListTransformer->transformCollection($data['data']);
return $transformed;
}
2017-01-03 21:06:49 -05:00
public function search(string $type, string $query): array
{
$options = [
'query' => [
'filter' => [
'text' => $query
2017-01-10 21:13:44 -05:00
],
'page' => [
'offset' => 0,
'limit' => 20
],
]
];
$raw = $this->getRequest($type, $options);
foreach ($raw['data'] as &$item)
{
$item['attributes']['titles'] = K::filterTitles($item['attributes']);
array_shift($item['attributes']['titles']);
}
return $raw;
}
2017-01-10 21:13:44 -05:00
public function createListItem(array $data): bool
{
$data['user_id'] = $this->getUserIdByUsername($this->getUsername());
return $this->listItem->create($data);
}
public function getListItem(string $listId): array
{
$baseData = $this->listItem->get($listId);
switch ($baseData['included'][0]['type'])
{
case 'anime':
$baseData['data']['anime'] = $baseData['included'][0];
return $this->animeListTransformer->transform($baseData['data']);
case 'manga':
$baseData['data']['manga'] = $baseData['included'][0];
return $this->mangaListTransformer->transform($baseData['data']);
default:
return $baseData['data']['attributes'];
}
}
public function updateListItem(array $data)
{
try
{
$response = $this->listItem->update($data['id'], $data['data']);
return [
'statusCode' => $response->getStatusCode(),
'body' => $response->getBody(),
];
}
catch(ClientException $e)
{
return [
'statusCode' => $e->getResponse()->getStatusCode(),
'body' => Json::decode((string)$e->getResponse()->getBody())
];
}
}
public function deleteListItem(string $id): bool
{
return $this->listItem->delete($id);
}
private function getUsername(): string
{
return $this->getContainer()
->get('config')
->get(['kitsu_username']);
}
private function getRawMediaData(string $type, string $slug): array
{
$options = [
'query' => [
'filter' => [
'slug' => $slug
],
'include' => ($type === 'anime')
? 'genres,mappings,streamingLinks'
: 'genres,mappings',
]
];
$data = $this->getRequest($type, $options);
$baseData = $data['data'][0]['attributes'];
$baseData['included'] = $data['included'];
return $baseData;
}
2016-12-21 12:46:20 -05:00
}