Response::getRemainingRequests() - Code Metrics - Inspection of "Response: Add method to get the error message" - hansott/pinterest-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 35c804...a662fb )

by Hans

created 2016-03-13 15:41 UTC

Response::getRemainingRequests() A

↳ Parent: Response

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	6
ccs	3
cts	3
cp	1
rs	9.4285
cc	2
eloc	3
nc	2
nop	0
crap	2

<?php

/*
 * This file is part of the Pinterest PHP library.
 *
 * (c) Hans Ott <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.md.
 *
 * Source: https://github.com/hansott/pinterest-php
 */

namespace Pinterest\Http;

use Pinterest\Http\Exceptions\MalformedJson;

/**
 * The response class.
 *
 * @author Hans Ott <[email protected]>
 * @author Toon Daelman <[email protected]>
 */
final class Response
{
    /**
     * The parsed response body.
     *
     * @var mixed
     */
    public $body;

    /**
     * The response status code.
     *
     * @var int
     */
    private $statusCode;

    /**
     * The raw response body.
     *
     * @var string
     */
    private $rawBody;

    /**
     * The HTTP headers.
     *
     * @var array
     */
    private $headers;

    /**
     * The processed result.
     *
     * @var mixed
     */
    private $result;

    /**
     * The request object.
     *
     * @var Request
     */
    private $request;

    /**
     * The constructor.
     *
     * @param Request $request    The request object.
     * @param int     $statusCode The status code.
     * @param string  $rawBody    The raw response body.
     * @param array   $headers    A key => value representation of response headers.
     */
    public function __construct(Request $request, $statusCode, $rawBody, array $headers)
    {
        $this->request = $request;
        $this->statusCode = (int) $statusCode;
        $this->rawBody = (string) $rawBody;
        $this->body = $this->parseJson($this->rawBody);
        $this->headers = $headers;
    }

    /**
     * Checks if the response is okay.
     *
     * @return bool Whether the response is okay.
     */
    public function ok()
    {
        return
            !isset($this->body->error)
            && $this->statusCode >= 200
            && $this->statusCode < 300;
    }

    /**
     * Get the HTTP status code.
     *
     * @return int
     */
    public function getStatusCode()
    {
        return $this->statusCode;
    }

    /**
     * Get the error message.
     *
     * @return null|string
     */
    public function getError()
    {
        return !empty($this->body->message) ? (string) $this->body->message : null;
    }

    /**
     * Checks if the response is rate-limited.
     *
     * @return bool Whether the response is rate-limited.
     */
    public function rateLimited()
    {
        return $this->statusCode === 429;
    }

    /**
     * Parse the response json.
     *
     * @param string $rawBody The raw response body.
     * @param bool $toArray Return as array?
     *
     * @throws MalformedJson
     *
     * @return mixed The parsed json.
     */
    private function parseJson($rawBody, $toArray = false)
    {
        $json = json_decode($rawBody, $toArray);
        if (json_last_error() === JSON_ERROR_NONE) {
            return $json;
        } else {
            throw new MalformedJson();
        }
    }

    /**
     * Get the processed result.
     *
     * @return mixed The processed result.
     */
    public function result()
    {
        return $this->result;
    }

    /**
     * Set the processed result.
     *
     * @param mixed $result The result.
     *
     * @return $this
     */
    public function setResult($result)
    {
        $this->result = $result;

        return $this;
    }

    /**
     * Get the request object.
     *
     * @return Request
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * Get the HTTP Headers.
     *
     * @return array
     */
    public function getHeaders()
    {
        return $this->headers;
    }

    /**
     * Get a specific HTTP header.
     *
     * @param string $header
     *
     * @return string|null The header value.
     */
    public function getHeader($header)
    {
        return isset($this->headers[$header])
            ? $this->headers[$header]
            : null;
    }

    /**
     * Get the rate-limit.
     *
     * @return int|null The rate-limit.
     */
    public function getRateLimit()
    {
        $limit = $this->getHeader('X-Ratelimit-Limit');

        return is_numeric($limit) ? (int) $limit : null;
    }

    /**
     * Get the remaining requests before reaching the rate-limit.
     *
     * @return int|null The remaining requests.
     */
    public function getRemainingRequests()
    {
        $remaining = $this->getHeader('X-Ratelimit-Remaining');

        return is_numeric($remaining) ? (int) $remaining : null;
    }
}


1		<?php
2
3		/*
4		* This file is part of the Pinterest PHP library.
5		*
6		* (c) Hans Ott <[email protected]>
7		*
8		* This source file is subject to the MIT license that is bundled
9		* with this source code in the file LICENSE.md.
10		*
11		* Source: https://github.com/hansott/pinterest-php
12		*/
13
14		namespace Pinterest\Http;
15
16		use Pinterest\Http\Exceptions\MalformedJson;
17
18		/**
19		* The response class.
20		*
21		* @author Hans Ott <[email protected]>
22		* @author Toon Daelman <[email protected]>
23		*/
24		final class Response
25		{
26		/**
27		* The parsed response body.
28		*
29		* @var mixed
30		*/
31		public $body;
32
33		/**
34		* The response status code.
35		*
36		* @var int
37		*/
38		private $statusCode;
39
40		/**
41		* The raw response body.
42		*
43		* @var string
44		*/
45		private $rawBody;
46
47		/**
48		* The HTTP headers.
49		*
50		* @var array
51		*/
52		private $headers;
53
54		/**
55		* The processed result.
56		*
57		* @var mixed
58		*/
59		private $result;
60
61		/**
62		* The request object.
63		*
64		* @var Request
65		*/
66		private $request;
67
68		/**
69		* The constructor.
70		*
71		* @param Request $request The request object.
72		* @param int $statusCode The status code.
73		* @param string $rawBody The raw response body.
74		* @param array $headers A key => value representation of response headers.
75		*/
76	32	public function __construct(Request $request, $statusCode, $rawBody, array $headers)
77		{
78	32	$this->request = $request;
79	32	$this->statusCode = (int) $statusCode;
80	32	$this->rawBody = (string) $rawBody;
81	32	$this->body = $this->parseJson($this->rawBody);
82	32	$this->headers = $headers;
83	32	}
84
85		/**
86		* Checks if the response is okay.
87		*
88		* @return bool Whether the response is okay.
89		*/
90	32	public function ok()
91		{
92		return
93	32	!isset($this->body->error)
94	32	&& $this->statusCode >= 200
95	32	&& $this->statusCode < 300;
96		}
97
98		/**
99		* Get the HTTP status code.
100		*
101		* @return int
102		*/
103		public function getStatusCode()
104		{
105		return $this->statusCode;
106		}
107
108		/**
109		* Get the error message.
110		*
111		* @return null\|string
112		*/
113		public function getError()
114		{
115		return !empty($this->body->message) ? (string) $this->body->message : null;
116		}
117
118		/**
119		* Checks if the response is rate-limited.
120		*
121		* @return bool Whether the response is rate-limited.
122		*/
123	32	public function rateLimited()
124		{
125	32	return $this->statusCode === 429;
126		}
127
128		/**
129		* Parse the response json.
130		*
131		* @param string $rawBody The raw response body.
132		* @param bool $toArray Return as array?
133		*
134		* @throws MalformedJson
135		*
136		* @return mixed The parsed json.
137		*/
138	32	private function parseJson($rawBody, $toArray = false)
139		{
140	32	$json = json_decode($rawBody, $toArray);
141	32	if (json_last_error() === JSON_ERROR_NONE) {
142	32	return $json;
143		} else {
144		throw new MalformedJson();
145		}
146		}
147
148		/**
149		* Get the processed result.
150		*
151		* @return mixed The processed result.
152		*/
153	30	public function result()
154		{
155	30	return $this->result;
156		}
157
158		/**
159		* Set the processed result.
160		*
161		* @param mixed $result The result.
162		*
163		* @return $this
164		*/
165	30	public function setResult($result)
166		{
167	30	$this->result = $result;
168
169	30	return $this;
170		}
171
172		/**
173		* Get the request object.
174		*
175		* @return Request
176		*/
177		public function getRequest()
178		{
179		return $this->request;
180		}
181
182		/**
183		* Get the HTTP Headers.
184		*
185		* @return array
186		*/
187	6	public function getHeaders()
188		{
189	6	return $this->headers;
190		}
191
192		/**
193		* Get a specific HTTP header.
194		*
195		* @param string $header
196		*
197		* @return string\|null The header value.
198		*/
199	6	public function getHeader($header)
200		{
201	6	return isset($this->headers[$header])
202	6	? $this->headers[$header]
203	6	: null;
204		}
205
206		/**
207		* Get the rate-limit.
208		*
209		* @return int\|null The rate-limit.
210		*/
211	6	public function getRateLimit()
212		{
213	6	$limit = $this->getHeader('X-Ratelimit-Limit');
214
215	6	return is_numeric($limit) ? (int) $limit : null;
216		}
217
218		/**
219		* Get the remaining requests before reaching the rate-limit.
220		*
221		* @return int\|null The remaining requests.
222		*/
223	6	public function getRemainingRequests()
224		{
225	6	$remaining = $this->getHeader('X-Ratelimit-Remaining');
226
227	6	return is_numeric($remaining) ? (int) $remaining : null;
228		}
229		}
230

hansott / pinterest-php

Push — master ( 35c804...a662fb )

Response::getRemainingRequests() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like