MALTrait::setUpRequest() - Code Metrics - Inspection of "Create Request Builder wrapper around Artax" - timw4mail/HummingBirdAnimeClient - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop (205409)

by Timothy

created 2017-02-08 01:44 UTC

MALTrait::setUpRequest() B

↳ Parent: MALTrait

Complexity

Conditions	5
Paths	9

Size

Total Lines	44
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	25
nc	9
nop	3
dl	0
loc	44
rs	8.439
c	0
b	0
f	0

<?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 <[email protected]>
 * @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;

use Amp\Artax\{Client, FormBody, Request};
use Aviat\AnimeClient\API\{
	MAL as M,
	APIRequestBuilder,
	XML
};
use Aviat\AnimeClient\API\MALRequestBuilder;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Aviat\Ion\Json;
use InvalidArgumentException;

trait MALTrait {
	
	/**
	 * The request builder for the MAL API
	 * @var MALRequestBuilder
	 */
	protected $requestBuilder;

	/**
	 * 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 = [
		'Accept' => 'text/xml',
		'Accept-Encoding' => 'gzip',
		'Content-type' => 'application/x-www-form-urlencoded',
		'User-Agent' => "Tim's Anime Client/4.0"
	];
	
	/**
	 * Set the request builder object
	 *
	 * @param MALRequestBuilder $requestBuilder
	 * @return self
	 */
	public function setRequestBuilder($requestBuilder): self
	{
		$this->requestBuilder = $requestBuilder;
		return $this;
	}
	
	/**
	 * 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');
	}
	
	/**
	 * Create a request object
	 *
	 * @param string $type
	 * @param string $url
	 * @param array $options
	 * @return \Amp\Promise

	 */
	public function setUpRequest(string $type, string $url, array $options = [])
	{
		$this->defaultHeaders['User-Agent'] = $_SERVER['HTTP_USER_AGENT'] ?? $this->defaultHeaders;

		$type = strtoupper($type);
		$validTypes = ['GET', 'POST', 'DELETE'];

		if ( ! in_array($type, $validTypes))
		{
			throw new InvalidArgumentException('Invalid http request type');
		}

		$config = $this->container->get('config');
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$logger = $this->container->getLogger('mal-request');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		$headers = array_merge($this->defaultHeaders, $options['headers'] ?? [],  [
			'Authorization' =>  'Basic ' .
				base64_encode($config->get(['mal','username']) . ':' .$config->get(['mal','password']))
		]);

		$query = $options['query'] ?? [];

		$url = (strpos($url, '//') !== FALSE)
			? $url
			: $this->baseUrl . $url;

		if ( ! empty($query))
		{
			$url .= '?' . http_build_query($query);
		}

		$request = (new Request)
			->setMethod($type)
			->setUri($url)
			->setProtocol('1.1')
			->setAllHeaders($headers);

		if (array_key_exists('body', $options))
		{
			$request->setBody($options['body']);
		}
		
		return $request;
	}

	/**
	 * 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())
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
		{
			$logger = $this->container->getLogger('mal-request');
		}
		
		$request = $this->setUpRequest($type, $url, $options);
		$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()
		]);

		return $response;
	}

	/**
	 * Make a request
	 *
	 * @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())
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
		{
			$logger = $this->container->getLogger('mal-request');
		}

		$response = $this->getResponse($type, $url, $options);

		if ((int) $response->getStatus() > 299 || (int) $response->getStatus() < 200)
		{
			if ($logger)
			{
				$logger->warning('Non 200 response for api call', $response->getBody());
			}
		}

		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);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
	}

	/**
	 * Remove some boilerplate for post requests
	 *
	 * @param array $args
	 * @return array
	 */
	protected function postRequest(...$args): array

	{
		$logger = null;
		if ($this->getContainer())
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
		{
			$logger = $this->container->getLogger('mal-request');
		}

		$response = $this->getResponse('POST', ...$args);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$validResponseCodes = [200, 201];

		if ( ! in_array((int) $response->getStatus(), $validResponseCodes))
		{
			if ($logger)
			{
				$logger->warning('Non 201 response for POST api call', $response->getBody());
			}
		}

		return XML::toArray($response->getBody());
	}
}

1		<?php declare(strict_types=1);
2		/**
3		* Anime List Client
4		*
5		* An API client for Kitsu and MyAnimeList to manage anime and manga watch lists
6		*
7		* PHP version 7
8		*
9		* @package AnimeListClient
10		* @author Timothy J. Warren <[email protected]>
11		* @copyright 2015 - 2017 Timothy J. Warren
12		* @license http://www.opensource.org/licenses/mit-license.html MIT License
13		* @version 4.0
14		* @link https://github.com/timw4mail/HummingBirdAnimeClient
15		*/
16
17		namespace Aviat\AnimeClient\API\MAL;
18
19		use Amp\Artax\{Client, FormBody, Request};
20		use Aviat\AnimeClient\API\{
21		MAL as M,
22		APIRequestBuilder,
23		XML
24		};
25		use Aviat\AnimeClient\API\MALRequestBuilder;
		0 ignored issues – show Bug introduced 2017-02-08 01:51 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Aviat\AnimeClient\API\MAL\MALRequestBuilder`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
26		use Aviat\Ion\Json;
27		use InvalidArgumentException;
28
29		trait MALTrait {
30
31		/**
32		* The request builder for the MAL API
33		* @var MALRequestBuilder
34		*/
35		protected $requestBuilder;
36
37		/**
38		* The base url for api requests
39		* @var string $base_url
40		*/
41		protected $baseUrl = M::BASE_URL;
42
43		/**
44		* HTTP headers to send with every request
45		*
46		* @var array
47		*/
48		protected $defaultHeaders = [
49		'Accept' => 'text/xml',
50		'Accept-Encoding' => 'gzip',
51		'Content-type' => 'application/x-www-form-urlencoded',
52		'User-Agent' => "Tim's Anime Client/4.0"
53		];
54
55		/**
56		* Set the request builder object
57		*
58		* @param MALRequestBuilder $requestBuilder
59		* @return self
60		*/
61		public function setRequestBuilder($requestBuilder): self
62		{
63		$this->requestBuilder = $requestBuilder;
64		return $this;
65		}
66
67		/**
68		* Unencode the dual-encoded ampersands in the body
69		*
70		* This is a dirty hack until I can fully track down where
71		* the dual-encoding happens
72		*
73		* @param FormBody $formBody The form builder object to fix
		0 ignored issues – show Documentation introduced 2017-02-07 02:10 UTC by Report Bug Copy Issue Report Should the type for parameter `$formBody` not be `\Amp\Artax\FormBody`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
74		* @return string
75		*/
76		private function fixBody(FormBody $formBody): string
77		{
78		$rawBody = \Amp\wait($formBody->getBody());
79		return html_entity_decode($rawBody, \ENT_HTML5, 'UTF-8');
80		}
81
82		/**
83		* Create a request object
84		*
85		* @param string $type
86		* @param string $url
87		* @param array $options
88		* @return \Amp\Promise
		0 ignored issues – show Documentation introduced 2017-02-08 01:51 UTC by Report Bug Copy Issue Report Should the return type not be `\Amp\Artax\Request`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
89		*/
90		public function setUpRequest(string $type, string $url, array $options = [])
91		{
92		$this->defaultHeaders['User-Agent'] = $_SERVER['HTTP_USER_AGENT'] ?? $this->defaultHeaders;
93
94		$type = strtoupper($type);
95		$validTypes = ['GET', 'POST', 'DELETE'];
96
97		if ( ! in_array($type, $validTypes))
98		{
99		throw new InvalidArgumentException('Invalid http request type');
100		}
101
102		$config = $this->container->get('config');
		0 ignored issues – show Bug introduced 2017-02-07 02:10 UTC by Report Bug Copy Issue Report The property `container` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
103		$logger = $this->container->getLogger('mal-request');
		0 ignored issues – show Unused Code introduced 2017-02-08 01:51 UTC by Report Bug Copy Issue Report `$logger` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
104
105		$headers = array_merge($this->defaultHeaders, $options['headers'] ?? [], [
106		'Authorization' => 'Basic ' .
107		base64_encode($config->get(['mal','username']) . ':' .$config->get(['mal','password']))
108		]);
109
110		$query = $options['query'] ?? [];
111
112		$url = (strpos($url, '//') !== FALSE)
113		? $url
114		: $this->baseUrl . $url;
115
116		if ( ! empty($query))
117		{
118		$url .= '?' . http_build_query($query);
119		}
120
121		$request = (new Request)
122		->setMethod($type)
123		->setUri($url)
124		->setProtocol('1.1')
125		->setAllHeaders($headers);
126
127		if (array_key_exists('body', $options))
128		{
129		$request->setBody($options['body']);
130		}
131
132		return $request;
133		}
134
135		/**
136		* Make a request
137		*
138		* @param string $type
139		* @param string $url
140		* @param array $options
141		* @return \Amp\Artax\Response
142		*/
143		private function getResponse(string $type, string $url, array $options = [])
144		{
145		$logger = null;
146		if ($this->getContainer())
		0 ignored issues – show Bug introduced 2017-02-08 01:51 UTC by Report Bug Copy Issue Report It seems like `getContainer()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
147		{
148		$logger = $this->container->getLogger('mal-request');
149		}
150
151		$request = $this->setUpRequest($type, $url, $options);
152		$response = \Amp\wait((new Client)->request($request));
153
154		$logger->debug('MAL api request', [
155		'url' => $url,
156		'status' => $response->getStatus(),
157		'reason' => $response->getReason(),
158		'headers' => $response->getAllHeaders(),
159		'requestHeaders' => $request->getAllHeaders(),
160		'requestBody' => $request->hasBody() ? $request->getBody() : 'No request body',
161		'requestBodyBeforeEncode' => $request->hasBody() ? urldecode($request->getBody()) : '',
162		'body' => $response->getBody()
163		]);
164
165		return $response;
166		}
167
168		/**
169		* Make a request
170		*
171		* @param string $type
172		* @param string $url
173		* @param array $options
174		* @return array
175		*/
176	View Code Duplication	private function request(string $type, string $url, array $options = []): array
		0 ignored issues – show Duplication introduced 2017-02-07 02:10 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
177		{
178		$logger = null;
179		if ($this->getContainer())
		0 ignored issues – show Bug introduced 2017-02-07 02:10 UTC by Report Bug Copy Issue Report It seems like `getContainer()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
180		{
181		$logger = $this->container->getLogger('mal-request');
182		}
183
184		$response = $this->getResponse($type, $url, $options);
185
186		if ((int) $response->getStatus() > 299 \|\| (int) $response->getStatus() < 200)
187		{
188		if ($logger)
189		{
190		$logger->warning('Non 200 response for api call', $response->getBody());
191		}
192		}
193
194		return XML::toArray((string) $response->getBody());
195		}
196
197		/**
198		* Remove some boilerplate for get requests
199		*
200		* @param array $args
201		* @return array
202		*/
203		protected function getRequest(...$args): array
204		{
205		return $this->request('GET', ...$args);
		0 ignored issues – show Documentation introduced 2017-02-07 02:10 UTC by Report Bug Copy Issue Report `$args` is of type `array<integer,array>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
206		}
207
208		/**
209		* Remove some boilerplate for post requests
210		*
211		* @param array $args
212		* @return array
213		*/
214	View Code Duplication	protected function postRequest(...$args): array
		0 ignored issues – show Duplication introduced 2017-02-07 02:10 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
215		{
216		$logger = null;
217		if ($this->getContainer())
		0 ignored issues – show Bug introduced 2017-02-07 02:10 UTC by Report Bug Copy Issue Report It seems like `getContainer()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
218		{
219		$logger = $this->container->getLogger('mal-request');
220		}
221
222		$response = $this->getResponse('POST', ...$args);
		0 ignored issues – show Documentation introduced 2017-02-07 02:10 UTC by Report Bug Copy Issue Report `$args` is of type `array<integer,array>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
223		$validResponseCodes = [200, 201];
224
225		if ( ! in_array((int) $response->getStatus(), $validResponseCodes))
226		{
227		if ($logger)
228		{
229		$logger->warning('Non 201 response for POST api call', $response->getBody());
230		}
231		}
232
233		return XML::toArray($response->getBody());
234		}
235		}

timw4mail / HummingBirdAnimeClient

Branch — develop (205409)

MALTrait::setUpRequest() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like