HummingBirdAnimeClient/src/Aviat/AnimeClient/Model/Manga.php

308 lines
6.3 KiB
PHP
Raw Normal View History

<?php
/**
2015-11-16 11:40:01 -05:00
* 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
2015-11-16 11:40:01 -05:00
* @link https://github.com/timw4mail/HummingBirdAnimeClient
* @license MIT
*/
2015-09-14 19:54:34 -04:00
namespace Aviat\AnimeClient\Model;
use GuzzleHttp\Cookie\Cookiejar;
use GuzzleHttp\Cookie\SetCookie;
2016-01-07 13:45:43 -05:00
use Aviat\Ion\Json;
2015-09-15 13:19:29 -04:00
use Aviat\AnimeClient\Model\API;
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
];
/**
2015-06-26 16:39:10 -04:00
* The base url for api requests
* @var string
*/
2015-06-17 08:50:01 -04:00
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
*/
2016-02-02 21:38:38 -05:00
protected function _manga_api_call($type, $url, $json = NULL)
2016-02-02 11:34:03 -05:00
{
$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);
2016-02-02 11:34:03 -05:00
return [
'statusCode' => $result->getStatusCode(),
'body' => $result->getBody()
];
}
/**
* Add a manga to the list
*
* @param array $data
*/
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);
2016-02-02 11:34:03 -05:00
}
/**
* Update the selected manga
*
* @param array $data
* @return array
*/
public function update($data)
{
$id = $data['id'];
return $this->_manga_api_call(
2016-02-02 11:34:03 -05:00
'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}");
2016-02-02 11:34:03 -05:00
}
/**
* Search for manga by name
*
* @param string $name
* @return array
*/
public function search($name)
{
$logger = $this->container->getLogger('default');
$config = [
'query' => [
'scope' => 'manga',
'depth' => 'full',
'query' => $name
]
];
2016-02-02 11:34:03 -05:00
$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 the full set of anime lists
*
* @return array
*/
public function get_all_lists()
{
$data = $this->_get_list_from_api();
2015-11-05 11:26:03 -05:00
foreach ($data as &$val)
{
$this->sort_by_name($val, 'manga');
}
return $data;
}
/**
* Get a category out of the full list
*
* @param string $status
* @return array
*/
public function get_list($status)
{
$data = $this->_get_list_from_api($status);
$this->sort_by_name($data, 'manga');
return $data;
}
2015-10-14 09:20:52 -04:00
/**
* Retrieve the list from the hummingbird api
2015-10-15 09:25:30 -04:00
*
2015-10-14 09:20:52 -04:00
* @param string $status
* @return array
*/
protected function _get_list_from_api($status = "All")
{
$config = [
'query' => [
2015-10-06 11:38:20 -04:00
'user_id' => $this->config->get('hummingbird_username')
],
'allow_redirects' => FALSE
];
2015-10-15 09:25:30 -04:00
$response = $this->get('manga_library_entries', $config);
2015-10-12 14:11:00 -04:00
$data = $this->_check_cache($response);
$output = $this->map_by_status($data);
return (array_key_exists($status, $output))
? $output[$status]
: $output;
}
/**
* Check the status of the cache and return the appropriate response
*
* @param \GuzzleHttp\Message\Response $response
2015-11-17 16:45:41 -05:00
* @codeCoverageIgnore
* @return array
*/
private function _check_cache($response)
{
// Bail out early if there isn't any manga data
2016-01-07 13:45:43 -05:00
$api_data = Json::decode($response->getBody(), TRUE);
2015-11-05 11:26:03 -05:00
if ( ! array_key_exists('manga', $api_data))
{
return [];
}
2015-10-06 11:38:20 -04:00
$cache_file = _dir($this->config->get('data_cache_path'), 'manga.json');
$transformed_cache_file = _dir(
$this->config->get('data_cache_path'),
'manga-transformed.json'
);
$cached_data = file_exists($cache_file)
2016-01-07 13:45:43 -05:00
? Json::decodeFile($cache_file)
: [];
if ($cached_data === $api_data && file_exists($transformed_cache_file))
{
2016-01-07 13:45:43 -05:00
return Json::decodeFile($transformed_cache_file);
}
else
{
2016-01-07 13:45:43 -05:00
Json::encodeFile($cache_file, $api_data);
$zippered_data = $this->zipper_lists($api_data);
$transformer = new Transformer\MangaListTransformer();
$transformed_data = $transformer->transform_collection($zippered_data);
2016-01-07 13:45:43 -05:00
Json::encodeFile($transformed_cache_file, $transformed_data);
return $transformed_data;
}
}
/**
* 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;
}
return $output;
}
/**
* Combine the two manga lists into one
* @param array $raw_data
* @return array
*/
private function zipper_lists($raw_data)
{
2015-11-04 16:36:54 -05:00
return (new Transformer\MangaListsZipper($raw_data))->transform();
}
}
// End of MangaModel.php