HummingBirdAnimeClient/src/API/MAL/MALTrait.php

235 lines
5.3 KiB
PHP
Raw Normal View History

2017-01-12 15:41: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
*
* @package AnimeListClient
* @author Timothy J. Warren <tim@timshomepage.net>
* @copyright 2015 - 2017 Timothy J. Warren
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 4.0
* @link https://github.com/timw4mail/HummingBirdAnimeClient
*/
namespace Aviat\AnimeClient\API\MAL;
2017-02-04 15:18:34 -05:00
use Amp\Artax\{Client, FormBody, Request};
2017-01-12 15:41:20 -05:00
use Aviat\AnimeClient\API\{
MAL as M,
APIRequestBuilder,
2017-01-12 15:41:20 -05:00
XML
};
use Aviat\AnimeClient\API\MALRequestBuilder;
2017-02-01 09:53:02 -05:00
use Aviat\Ion\Json;
2017-01-12 15:41:20 -05:00
use InvalidArgumentException;
trait MALTrait {
/**
* The request builder for the MAL API
* @var MALRequestBuilder
*/
protected $requestBuilder;
2017-01-12 15:41:20 -05:00
/**
* The base url for api requests
* @var string $base_url
*/
protected $baseUrl = M::BASE_URL;
/**
* HTTP headers to send with every request
*
* @var array
*/
protected $defaultHeaders = [
2017-02-04 15:18:34 -05:00
'Accept' => 'text/xml',
'Accept-Encoding' => 'gzip',
'Content-type' => 'application/x-www-form-urlencoded',
2017-01-12 15:41:20 -05:00
'User-Agent' => "Tim's Anime Client/4.0"
];
2017-02-04 15:18:34 -05:00
/**
* Set the request builder object
*
* @param MALRequestBuilder $requestBuilder
* @return self
*/
public function setRequestBuilder($requestBuilder): self
{
$this->requestBuilder = $requestBuilder;
return $this;
}
2017-02-04 15:18:34 -05:00
/**
* Unencode the dual-encoded ampersands in the body
*
* This is a dirty hack until I can fully track down where
* the dual-encoding happens
*
* @param FormBody $formBody The form builder object to fix
* @return string
*/
private function fixBody(FormBody $formBody): string
{
$rawBody = \Amp\wait($formBody->getBody());
return html_entity_decode($rawBody, \ENT_HTML5, 'UTF-8');
}
2017-01-12 15:41:20 -05:00
/**
* Create a request object
2017-01-12 15:41:20 -05:00
*
* @param string $type
* @param string $url
* @param array $options
* @return \Amp\Promise
2017-01-12 15:41:20 -05:00
*/
public function setUpRequest(string $type, string $url, array $options = [])
2017-01-12 15:41:20 -05:00
{
2017-02-04 15:18:34 -05:00
$this->defaultHeaders['User-Agent'] = $_SERVER['HTTP_USER_AGENT'] ?? $this->defaultHeaders;
2017-01-12 15:41:20 -05:00
$type = strtoupper($type);
2017-02-04 15:18:34 -05:00
$validTypes = ['GET', 'POST', 'DELETE'];
2017-01-12 15:41:20 -05:00
if ( ! in_array($type, $validTypes))
{
throw new InvalidArgumentException('Invalid http request type');
}
2017-02-04 15:18:34 -05:00
2017-01-12 15:41:20 -05:00
$config = $this->container->get('config');
$logger = $this->container->getLogger('mal-request');
2017-02-04 15:18:34 -05:00
2017-02-01 09:53:02 -05:00
$headers = array_merge($this->defaultHeaders, $options['headers'] ?? [], [
2017-02-04 15:18:34 -05:00
'Authorization' => 'Basic ' .
2017-02-01 09:53:02 -05:00
base64_encode($config->get(['mal','username']) . ':' .$config->get(['mal','password']))
]);
2017-02-04 15:18:34 -05:00
2017-02-01 09:53:02 -05:00
$query = $options['query'] ?? [];
2017-02-04 15:18:34 -05:00
2017-02-01 09:53:02 -05:00
$url = (strpos($url, '//') !== FALSE)
2017-02-04 15:18:34 -05:00
? $url
: $this->baseUrl . $url;
if ( ! empty($query))
{
$url .= '?' . http_build_query($query);
}
2017-02-01 09:53:02 -05:00
$request = (new Request)
->setMethod($type)
->setUri($url)
->setProtocol('1.1')
2017-02-04 15:18:34 -05:00
->setAllHeaders($headers);
2017-01-12 15:41:20 -05:00
2017-02-04 15:18:34 -05:00
if (array_key_exists('body', $options))
{
$request->setBody($options['body']);
}
return $request;
}
2017-02-04 15:18:34 -05:00
/**
* Make a request
*
* @param string $type
* @param string $url
* @param array $options
* @return \Amp\Artax\Response
*/
private function getResponse(string $type, string $url, array $options = [])
{
$logger = null;
if ($this->getContainer())
{
$logger = $this->container->getLogger('mal-request');
}
$request = $this->setUpRequest($type, $url, $options);
2017-02-04 15:18:34 -05:00
$response = \Amp\wait((new Client)->request($request));
$logger->debug('MAL api request', [
'url' => $url,
'status' => $response->getStatus(),
'reason' => $response->getReason(),
'headers' => $response->getAllHeaders(),
'requestHeaders' => $request->getAllHeaders(),
'requestBody' => $request->hasBody() ? $request->getBody() : 'No request body',
'requestBodyBeforeEncode' => $request->hasBody() ? urldecode($request->getBody()) : '',
'body' => $response->getBody()
]);
2017-01-12 15:41:20 -05:00
2017-02-04 15:18:34 -05:00
return $response;
2017-01-12 15:41:20 -05:00
}
/**
* Make a request
2017-01-12 15:41:20 -05:00
*
* @param string $type
* @param string $url
* @param array $options
* @return array
*/
private function request(string $type, string $url, array $options = []): array
{
$logger = null;
if ($this->getContainer())
{
$logger = $this->container->getLogger('mal-request');
2017-01-12 15:41:20 -05:00
}
$response = $this->getResponse($type, $url, $options);
2017-02-01 09:53:02 -05:00
if ((int) $response->getStatus() > 299 || (int) $response->getStatus() < 200)
2017-01-12 15:41:20 -05:00
{
if ($logger)
{
2017-02-04 15:18:34 -05:00
$logger->warning('Non 200 response for api call', $response->getBody());
2017-01-12 15:41:20 -05:00
}
}
return XML::toArray((string) $response->getBody());
}
/**
* Remove some boilerplate for get requests
*
* @param array $args
* @return array
*/
protected function getRequest(...$args): array
{
return $this->request('GET', ...$args);
}
/**
* Remove some boilerplate for post requests
*
* @param array $args
* @return array
*/
protected function postRequest(...$args): array
{
$logger = null;
if ($this->getContainer())
{
$logger = $this->container->getLogger('mal-request');
2017-01-12 15:41:20 -05:00
}
$response = $this->getResponse('POST', ...$args);
$validResponseCodes = [200, 201];
2017-02-01 09:53:02 -05:00
if ( ! in_array((int) $response->getStatus(), $validResponseCodes))
2017-01-12 15:41:20 -05:00
{
if ($logger)
{
2017-02-04 15:18:34 -05:00
$logger->warning('Non 201 response for POST api call', $response->getBody());
2017-01-12 15:41:20 -05:00
}
}
2017-02-01 09:53:02 -05:00
return XML::toArray($response->getBody());
2017-01-12 15:41:20 -05:00
}
}