ApiRequester::response() - Code Metrics - vindi/vindi-php - Measure and Improve Code Quality continuously with Scrutinizer

ApiRequester::response() A
last analyzed 2019-03-28 21:47 UTC

↳ Parent: ApiRequester

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	19
ccs	9
cts	9
cp	1
rs	9.6333
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	2

<?php

namespace Vindi;

use Psr\Http\Message\ResponseInterface;
use GuzzleHttp\Exception\ClientException;
use Vindi\Exceptions\ValidationException;
use Vindi\Http\Client;
use Vindi\Exceptions\RequestException;
use Vindi\Exceptions\RateLimitException;

/**
 * Class ApiRequester
 *
 * @package Vindi
 */
class ApiRequester
{
    /**
     * @var \Vindi\Http\Client
     */
    public $client;

    /**
     * @var ResponseInterface
     */
    public $lastResponse;

    /**
     * @var array
     */
    public $lastOptions;

    /**
     * ApiRequester constructor.
     */
    public function __construct()
    {
        $this->client = new Client;
    }

    /**
     * @param string $method   HTTP Method.
     * @param string $endpoint Relative to API base path.
     * @param array  $options  Options for the request.
     *
     * @return mixed
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \Vindi\Exceptions\RateLimitException
     * @throws \Vindi\Exceptions\RequestException
     */
    public function request($method, $endpoint, array $options = [])
    {
        $this->lastOptions = $options;
        try {
            $response = $this->client->request($method, $endpoint, $options);
        } catch (ClientException $e) {
            $response = $e->getResponse();
        }

        return $this->response($response);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }

    /**
     * @param ResponseInterface $response
     *
     * @return object
     * @throws RateLimitException
     * @throws \Vindi\Exceptions\RequestException
     */
    public function response(ResponseInterface $response)
    {
        $this->lastResponse = $response;

        $content = $response->getBody()->getContents();

        $decoded = json_decode($content); // parse as object
        $data = $decoded;

        if (!empty($decoded)) {
            reset($decoded);
            $data = current($decoded); // get first attribute from array, e.g.: subscription, subscriptions, errors.
        }

        $this->checkRateLimit($response)
            ->checkForErrors($response, $data);

        return $data;
    }

    /**
     * @param ResponseInterface $response
     *
     * @return $this
     * @throws RateLimitException
     */
    private function checkRateLimit(ResponseInterface $response)
    {
        if (429 === $response->getStatusCode()) {
            throw new RateLimitException($response);
        }

        return $this;
    }

    /**
     * @param ResponseInterface $response
     * @param mixed             $data
     *
     * @return $this
     * @throws \Vindi\Exceptions\RequestException
     */
    private function checkForErrors(ResponseInterface $response, $data)
    {
        $status = $response->getStatusCode();

        $data = (array)$data;

        $statusClass = (int)($status / 100);

        if (($statusClass === 4) || ($statusClass === 5)) {
            switch ($status) {
                case 422:
                    throw new ValidationException($status, $data, $this->lastOptions);
                default:
                    throw new RequestException($status, $data, $this->lastOptions);
            }
        }

        return $this;
    }
}


1		<?php
2
3		namespace Vindi;
4
5		use Psr\Http\Message\ResponseInterface;
6		use GuzzleHttp\Exception\ClientException;
7		use Vindi\Exceptions\ValidationException;
8		use Vindi\Http\Client;
9		use Vindi\Exceptions\RequestException;
10		use Vindi\Exceptions\RateLimitException;
11
12		/**
13		* Class ApiRequester
14		*
15		* @package Vindi
16		*/
17		class ApiRequester
18		{
19		/**
20		* @var \Vindi\Http\Client
21		*/
22		public $client;
23
24		/**
25		* @var ResponseInterface
26		*/
27		public $lastResponse;
28
29		/**
30		* @var array
31		*/
32		public $lastOptions;
33
34		/**
35		* ApiRequester constructor.
36		*/
37	458	public function __construct()
38		{
39	458	$this->client = new Client;
40	458	}
41
42		/**
43		* @param string $method HTTP Method.
44		* @param string $endpoint Relative to API base path.
45		* @param array $options Options for the request.
46		*
47		* @return mixed
48		* @throws \GuzzleHttp\Exception\GuzzleException
49		* @throws \Vindi\Exceptions\RateLimitException
50		* @throws \Vindi\Exceptions\RequestException
51		*/
52	10	public function request($method, $endpoint, array $options = [])
53		{
54	10	$this->lastOptions = $options;
55		try {
56	10	$response = $this->client->request($method, $endpoint, $options);
57	10	} catch (ClientException $e) {
58	2	$response = $e->getResponse();
59		}
60
61	10	return $this->response($response);
		0 ignored issues – show Bug introduced 2016-08-18 21:26 UTC by Report Bug Copy Issue Report It seems like `$response` defined by `$e->getResponse()` on line `58` can be `null`; however, `Vindi\ApiRequester::response()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
62		}
63
64		/**
65		* @param ResponseInterface $response
66		*
67		* @return object
68		* @throws RateLimitException
69		* @throws \Vindi\Exceptions\RequestException
70		*/
71	10	public function response(ResponseInterface $response)
72		{
73	10	$this->lastResponse = $response;
74
75	10	$content = $response->getBody()->getContents();
76
77	10	$decoded = json_decode($content); // parse as object
78	10	$data = $decoded;
79	10
80		if (!empty($decoded)) {
81	10	reset($decoded);
82	8	$data = current($decoded); // get first attribute from array, e.g.: subscription, subscriptions, errors.
83		}
84	2
85		$this->checkRateLimit($response)
86		->checkForErrors($response, $data);
87
88		return $data;
89		}
90
91		/**
92		* @param ResponseInterface $response
93	10	*
94		* @return $this
95	10	* @throws RateLimitException
96	2	*/
97		private function checkRateLimit(ResponseInterface $response)
98		{
99	8	if (429 === $response->getStatusCode()) {
100		throw new RateLimitException($response);
101		}
102
103		return $this;
104		}
105
106		/**
107		* @param ResponseInterface $response
108		* @param mixed $data
109	8	*
110		* @return $this
111	8	* @throws \Vindi\Exceptions\RequestException
112		*/
113	8	private function checkForErrors(ResponseInterface $response, $data)
114		{
115	8	$status = $response->getStatusCode();
116
117	8	$data = (array)$data;
118
119	6	$statusClass = (int)($status / 100);
120	2
121	4	if (($statusClass === 4) \|\| ($statusClass === 5)) {
122	4	switch ($status) {
123	4	case 422:
124		throw new ValidationException($status, $data, $this->lastOptions);
125		default:
126	2	throw new RequestException($status, $data, $this->lastOptions);
127		}
128		}
129
130		return $this;
131		}
132		}
133

vindi / vindi-php

GitHub Access Token became invalid

ApiRequester::response() A last analyzed 2019-03-28 21:47 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ApiRequester::response() A
last analyzed 2019-03-28 21:47 UTC