284 lines
5.8 KiB
PHP
284 lines
5.8 KiB
PHP
<?php
|
|
/**
|
|
* Hummingbird Anime Client
|
|
*
|
|
* An API client for Hummingbird to manage anime and manga watch lists
|
|
*
|
|
* @package HummingbirdAnimeClient
|
|
* @author Timothy J. Warren
|
|
* @copyright Copyright (c) 2015 - 2016
|
|
* @link https://github.com/timw4mail/HummingBirdAnimeClient
|
|
* @license MIT
|
|
*/
|
|
|
|
namespace Aviat\AnimeClient\Model;
|
|
|
|
use GuzzleHttp\Cookie\SetCookie;
|
|
|
|
use Aviat\Ion\Json;
|
|
use Aviat\AnimeClient\Hummingbird\Transformer;
|
|
use Aviat\AnimeClient\Hummingbird\Enum\MangaReadingStatus;
|
|
|
|
/**
|
|
* Model for handling requests dealing with the manga list
|
|
*/
|
|
class Manga extends API {
|
|
|
|
const READING = 'Reading';
|
|
const PLAN_TO_READ = 'Plan to Read';
|
|
const DROPPED = 'Dropped';
|
|
const ON_HOLD = 'On Hold';
|
|
const COMPLETED = 'Completed';
|
|
|
|
/**
|
|
* Map API constants to display constants
|
|
* @var array
|
|
*/
|
|
protected $const_map = [
|
|
MangaReadingStatus::READING => self::READING,
|
|
MangaReadingStatus::PLAN_TO_READ => self::PLAN_TO_READ,
|
|
MangaReadingStatus::ON_HOLD => self::ON_HOLD,
|
|
MangaReadingStatus::DROPPED => self::DROPPED,
|
|
MangaReadingStatus::COMPLETED => self::COMPLETED
|
|
];
|
|
|
|
/**
|
|
* The base url for api requests
|
|
* @var string
|
|
*/
|
|
protected $base_url = "https://hummingbird.me/";
|
|
|
|
/**
|
|
* Make an authenticated manga API call
|
|
*
|
|
* @param string $type - the HTTP verb
|
|
* @param string $url
|
|
* @param string|null $json
|
|
* @return array
|
|
*/
|
|
protected function _manga_api_call($type, $url, $json = NULL)
|
|
{
|
|
$token = $this->container->get('auth')
|
|
->get_auth_token();
|
|
|
|
// Set the token cookie, with the authentication token
|
|
// from the auth class.
|
|
$cookieJar = $this->cookieJar;
|
|
$cookie_data = new SetCookie([
|
|
'Name' => 'token',
|
|
'Value' => $token,
|
|
'Domain' => 'hummingbird.me'
|
|
]);
|
|
$cookieJar->setCookie($cookie_data);
|
|
|
|
$config = [
|
|
'cookies' => $cookieJar
|
|
];
|
|
|
|
if ( ! is_null($json))
|
|
{
|
|
$config['json'] = $json;
|
|
}
|
|
|
|
$result = $this->client->request(strtoupper($type), $url, $config);
|
|
|
|
return [
|
|
'statusCode' => $result->getStatusCode(),
|
|
'body' => $result->getBody()
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Add a manga to the list
|
|
*
|
|
* @param array $data
|
|
* @return array
|
|
*/
|
|
public function add($data)
|
|
{
|
|
$object = [
|
|
'manga_library_entry' => [
|
|
'status' => $data['status'],
|
|
'manga_id' => $data['id']
|
|
]
|
|
];
|
|
|
|
return $this->_manga_api_call('post', 'manga_library_entries', $object);
|
|
}
|
|
|
|
/**
|
|
* Update the selected manga
|
|
*
|
|
* @param array $data
|
|
* @return array
|
|
*/
|
|
public function update($data)
|
|
{
|
|
$id = $data['id'];
|
|
|
|
return $this->_manga_api_call(
|
|
'put',
|
|
"manga_library_entries/{$id}",
|
|
['manga_library_entry' => $data]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Delete a manga entry
|
|
*
|
|
* @param array $data
|
|
* @return array
|
|
*/
|
|
public function delete($data)
|
|
{
|
|
$id = $data['id'];
|
|
|
|
return $this->_manga_api_call('delete', "manga_library_entries/{$id}");
|
|
}
|
|
|
|
/**
|
|
* Search for manga by name
|
|
*
|
|
* @param string $name
|
|
* @return array
|
|
* @throws RuntimeException
|
|
*/
|
|
public function search($name)
|
|
{
|
|
$logger = $this->container->getLogger('default');
|
|
|
|
$config = [
|
|
'query' => [
|
|
'scope' => 'manga',
|
|
'depth' => 'full',
|
|
'query' => $name
|
|
]
|
|
];
|
|
|
|
$response = $this->get('search.json', $config);
|
|
|
|
if ($response->getStatusCode() != 200)
|
|
{
|
|
$logger->warning("Non 200 response for search api call");
|
|
$logger->warning($response->getBody());
|
|
|
|
throw new RuntimeException($response->getEffectiveUrl());
|
|
}
|
|
|
|
return Json::decode($response->getBody(), TRUE);
|
|
}
|
|
|
|
/**
|
|
* Get a category out of the full list
|
|
*
|
|
* @param string $status
|
|
* @return array
|
|
*/
|
|
public function get_list($status)
|
|
{
|
|
$data = $this->cache->get($this, '_get_list_from_api');
|
|
return ($status !== 'All') ? $data[$status] : $data;
|
|
}
|
|
|
|
/**
|
|
* Retrieve the list from the hummingbird api
|
|
*
|
|
* @param string $status
|
|
* @return array
|
|
*/
|
|
public function _get_list_from_api($status = "All")
|
|
{
|
|
$config = [
|
|
'query' => [
|
|
'user_id' => $this->config->get('hummingbird_username')
|
|
],
|
|
'allow_redirects' => FALSE
|
|
];
|
|
|
|
$response = $this->get('manga_library_entries', $config);
|
|
$data = $this->transform($response);
|
|
$final = $this->map_by_status($data);
|
|
return ($status !== 'All') ? $final[$status] : $final;
|
|
}
|
|
|
|
/**
|
|
* Transform the response to be more consistent
|
|
*
|
|
* @param \GuzzleHttp\Message\Response $response
|
|
* @codeCoverageIgnore
|
|
* @return array
|
|
*/
|
|
private function transform($response)
|
|
{
|
|
// Bail out early if there isn't any manga data
|
|
$api_data = Json::decode($response->getBody(), TRUE);
|
|
if ( ! array_key_exists('manga', $api_data))
|
|
{
|
|
return [];
|
|
}
|
|
|
|
$zippered_data = $this->zipper_lists($api_data);
|
|
$transformer = new Transformer\MangaListTransformer();
|
|
$transformed_data = $transformer->transform_collection($zippered_data);
|
|
|
|
return $transformed_data;
|
|
}
|
|
|
|
/**
|
|
* Get the details of a manga
|
|
*
|
|
* @param string $manga_id
|
|
* @return array
|
|
*/
|
|
public function get_manga($manga_id)
|
|
{
|
|
$raw = $this->_manga_api_call('get', "manga/{$manga_id}.json");
|
|
return Json::decode($raw['body'], TRUE);
|
|
}
|
|
|
|
/**
|
|
* Map transformed anime data to be organized by reading status
|
|
*
|
|
* @param array $data
|
|
* @return array
|
|
*/
|
|
private function map_by_status($data)
|
|
{
|
|
$output = [
|
|
self::READING => [],
|
|
self::PLAN_TO_READ => [],
|
|
self::ON_HOLD => [],
|
|
self::DROPPED => [],
|
|
self::COMPLETED => [],
|
|
];
|
|
|
|
foreach ($data as &$entry)
|
|
{
|
|
$entry['manga']['image'] = $this->get_cached_image(
|
|
$entry['manga']['image'],
|
|
$entry['manga']['slug'],
|
|
'manga'
|
|
);
|
|
$key = $this->const_map[$entry['reading_status']];
|
|
$output[$key][] = $entry;
|
|
}
|
|
|
|
foreach($output as &$val)
|
|
{
|
|
$this->sort_by_name($val, 'manga');
|
|
}
|
|
|
|
return $output;
|
|
}
|
|
|
|
/**
|
|
* Combine the two manga lists into one
|
|
* @param array $raw_data
|
|
* @return array
|
|
*/
|
|
private function zipper_lists($raw_data)
|
|
{
|
|
return (new Transformer\MangaListsZipper($raw_data))->transform();
|
|
}
|
|
}
|
|
// End of MangaModel.php
|