Request::getLastHttpCode() - Code Metrics - Inspection of "New debug methods getLastHttpCode and getLastHttpR..." - dotzero/amocrm-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 870a85...648470 )

by dotzero

created 2017-05-28 06:52 UTC

Request::getLastHttpCode() A

↳ Parent: Request

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php

namespace AmoCRM\Request;

use DateTime;
use AmoCRM\Exception;
use AmoCRM\NetworkException;

/**
 * Class Request
 *
 * Класс отправляющий запросы к API amoCRM используя cURL
 *
 * @package AmoCRM\Request
 * @author dotzero <[email protected]>
 * @link http://www.dotzero.ru/
 * @link https://github.com/dotzero/amocrm-php
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
class Request
{
    /**
     * @var bool Использовать устаревшую схему авторизации
     */
    protected $v1 = false;

    /**
     * @var bool Флаг вывода отладочной информации
     */
    private $debug = false;

    /**
     * @var ParamsBag|null Экземпляр ParamsBag для хранения аргументов
     */
    private $parameters = null;

    /**
     * @var int|null Последний полученный HTTP код
     */
    private $lastHttpCode = null;

    /**
     * @var string|null Последний полученный HTTP ответ
     */
    private $lastHttpResponse = null;

    /**
     * Request constructor
     *
     * @param ParamsBag $parameters Экземпляр ParamsBag для хранения аргументов
     * @throws NetworkException
     */
    public function __construct(ParamsBag $parameters)
    {
        if (!function_exists('curl_init')) {
            throw new NetworkException('The cURL PHP extension was not loaded');
        }

        $this->parameters = $parameters;
    }

    /**
     * Установка флага вывода отладочной информации
     *
     * @param bool $flag Значение флага
     * @return $this
     */
    public function debug($flag = false)
    {
        $this->debug = (bool)$flag;

        return $this;
    }

    /**
     * Возвращает последний полученный HTTP код
     *
     * @return int|null
     */
    public function getLastHttpCode()
    {
        return $this->lastHttpCode;
    }

    /**
     * Возвращает последний полученный HTTP ответ
     *
     * @return null|string
     */
    public function getLastHttpResponse()
    {
        return $this->lastHttpResponse;
    }

    /**
     * Возвращает экземпляр ParamsBag для хранения аргументов
     *
     * @return ParamsBag|null
     */
    protected function getParameters()
    {
        return $this->parameters;
    }

    /**
     * Выполнить HTTP GET запрос и вернуть тело ответа
     *
     * @param string $url Запрашиваемый URL
     * @param array $parameters Список GET параметров
     * @param null|string $modified Значение заголовка IF-MODIFIED-SINCE
     * @return mixed
     * @throws Exception
     * @throws NetworkException
     */
    protected function getRequest($url, $parameters = [], $modified = null)
    {
        if (!empty($parameters)) {
            $this->parameters->addGet($parameters);
        }

        return $this->request($url, $modified);
    }

    /**
     * Выполнить HTTP POST запрос и вернуть тело ответа
     *
     * @param string $url Запрашиваемый URL
     * @param array $parameters Список POST параметров
     * @return mixed
     * @throws Exception
     * @throws NetworkException
     */
    protected function postRequest($url, $parameters = [])
    {
        if (!empty($parameters)) {
            $this->parameters->addPost($parameters);
        }

        return $this->request($url);
    }

    /**
     * Подготавливает список заголовков HTTP
     *
     * @param mixed $modified Значение заголовка IF-MODIFIED-SINCE
     * @return array
     */
    protected function prepareHeaders($modified = null)
    {
        $headers = ['Content-Type: application/json'];

        if ($modified !== null) {
            if (is_int($modified)) {
                $headers[] = 'IF-MODIFIED-SINCE: ' . $modified;
            } else {
                $headers[] = 'IF-MODIFIED-SINCE: ' . (new DateTime($modified))->format(DateTime::RFC1123);
            }
        }

        return $headers;
    }

    /**
     * Подготавливает URL для HTTP запроса
     *
     * @param string $url Запрашиваемый URL
     * @return string
     */
    protected function prepareEndpoint($url)
    {
        if ($this->v1 === false) {
            $query = http_build_query(array_merge($this->parameters->getGet(), [
                'USER_LOGIN' => $this->parameters->getAuth('login'),
                'USER_HASH' => $this->parameters->getAuth('apikey'),
            ]), null, '&');
        } else {
            $query = http_build_query(array_merge($this->parameters->getGet(), [
                'login' => $this->parameters->getAuth('login'),
                'api_key' => $this->parameters->getAuth('apikey'),
            ]), null, '&');
        }

        return sprintf('https://%s%s?%s', $this->parameters->getAuth('domain'), $url, $query);
    }

    /**
     * Выполнить HTTP запрос и вернуть тело ответа
     *
     * @param string $url Запрашиваемый URL
     * @param null|string $modified Значение заголовка IF-MODIFIED-SINCE
     * @return mixed
     * @throws Exception
     * @throws NetworkException
     */
    protected function request($url, $modified = null)
    {
        $headers = $this->prepareHeaders($modified);
        $endpoint = $this->prepareEndpoint($url);

        $this->printDebug('url', $endpoint);
        $this->printDebug('headers', $headers);

        $ch = curl_init();

        curl_setopt($ch, CURLOPT_URL, $endpoint);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

        if ($this->parameters->hasPost()) {
            $fields = json_encode([
                'request' => $this->parameters->getPost(),
            ]);
            curl_setopt($ch, CURLOPT_POST, true);
            curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);
            $this->printDebug('post params', $fields);
        }

        $result = curl_exec($ch);
        $info = curl_getinfo($ch);
        $error = curl_error($ch);
        $errno = curl_errno($ch);

        curl_close($ch);

        $this->lastHttpCode = $info['http_code'];
        $this->lastHttpResponse = $result;

        $this->printDebug('curl_exec', $result);
        $this->printDebug('curl_getinfo', $info);
        $this->printDebug('curl_error', $error);
        $this->printDebug('curl_errno', $errno);

        if ($result === false && !empty($error)) {
            throw new NetworkException($error, $errno);
        }

        return $this->parseResponse($result, $info);
    }

    /**
     * Парсит HTTP ответ, проверяет на наличие ошибок и возвращает тело ответа
     *
     * @param string $response HTTP ответ
     * @param array $info Результат функции curl_getinfo
     * @return mixed
     * @throws Exception
     */
    protected function parseResponse($response, $info)
    {
        $result = json_decode($response, true);

        if (!isset($result['response'])) {
            return false;
        } elseif (floor($info['http_code'] / 100) >= 3) {
            $code = 0;
            if (isset($result['response']['error_code']) && $result['response']['error_code'] > 0) {
                $code = $result['response']['error_code'];
            }
            if ($this->v1 === false) {
                throw new Exception($result['response']['error'], $code);
            } else {
                throw new Exception(json_encode($result['response']));
            }
        }

        return $result['response'];
    }

    /**
     * Вывода отладочной информации
     *
     * @param string $key Заголовок отладочной информации
     * @param mixed $value Значение отладочной информации
     * @param bool $return Возврат строки вместо вывода
     * @return mixed
     */
    protected function printDebug($key = '', $value = null, $return = false)
    {
        if ($this->debug !== true) {
            return false;
        }

        if (!is_string($value)) {
            $value = print_r($value, true);
        }

        $line = sprintf('[DEBUG] %s: %s', $key, $value);

        if ($return === false) {
            return print_r($line . PHP_EOL);
        }

        return $line;
    }
}


1		<?php
2
3		namespace AmoCRM\Request;
4
5		use DateTime;
6		use AmoCRM\Exception;
7		use AmoCRM\NetworkException;
8
9		/**
10		* Class Request
11		*
12		* Класс отправляющий запросы к API amoCRM используя cURL
13		*
14		* @package AmoCRM\Request
15		* @author dotzero <[email protected]>
16		* @link http://www.dotzero.ru/
17		* @link https://github.com/dotzero/amocrm-php
18		*
19		* For the full copyright and license information, please view the LICENSE
20		* file that was distributed with this source code.
21		*/
22		class Request
23		{
24		/**
25		* @var bool Использовать устаревшую схему авторизации
26		*/
27		protected $v1 = false;
28
29		/**
30		* @var bool Флаг вывода отладочной информации
31		*/
32		private $debug = false;
33
34		/**
35		* @var ParamsBag\|null Экземпляр ParamsBag для хранения аргументов
36		*/
37		private $parameters = null;
38
39		/**
40		* @var int\|null Последний полученный HTTP код
41		*/
42		private $lastHttpCode = null;
43
44		/**
45		* @var string\|null Последний полученный HTTP ответ
46		*/
47		private $lastHttpResponse = null;
48
49		/**
50		* Request constructor
51		*
52		* @param ParamsBag $parameters Экземпляр ParamsBag для хранения аргументов
53		* @throws NetworkException
54		*/
55	218	public function __construct(ParamsBag $parameters)
56		{
57	218	if (!function_exists('curl_init')) {
58		throw new NetworkException('The cURL PHP extension was not loaded');
59		}
60
61	218	$this->parameters = $parameters;
62	218	}
63
64		/**
65		* Установка флага вывода отладочной информации
66		*
67		* @param bool $flag Значение флага
68		* @return $this
69		*/
70	2	public function debug($flag = false)
71		{
72	2	$this->debug = (bool)$flag;
73
74	2	return $this;
75		}
76
77		/**
78		* Возвращает последний полученный HTTP код
79		*
80		* @return int\|null
81		*/
82	1	public function getLastHttpCode()
83		{
84	1	return $this->lastHttpCode;
85		}
86
87		/**
88		* Возвращает последний полученный HTTP ответ
89		*
90		* @return null\|string
91		*/
92	1	public function getLastHttpResponse()
93		{
94	1	return $this->lastHttpResponse;
95		}
96
97		/**
98		* Возвращает экземпляр ParamsBag для хранения аргументов
99		*
100		* @return ParamsBag\|null
101		*/
102	3	protected function getParameters()
103		{
104	3	return $this->parameters;
105		}
106
107		/**
108		* Выполнить HTTP GET запрос и вернуть тело ответа
109		*
110		* @param string $url Запрашиваемый URL
111		* @param array $parameters Список GET параметров
112		* @param null\|string $modified Значение заголовка IF-MODIFIED-SINCE
113		* @return mixed
114		* @throws Exception
115		* @throws NetworkException
116		*/
117	1	protected function getRequest($url, $parameters = [], $modified = null)
118		{
119	1	if (!empty($parameters)) {
120	1	$this->parameters->addGet($parameters);
121	1	}
122
123	1	return $this->request($url, $modified);
124		}
125
126		/**
127		* Выполнить HTTP POST запрос и вернуть тело ответа
128		*
129		* @param string $url Запрашиваемый URL
130		* @param array $parameters Список POST параметров
131		* @return mixed
132		* @throws Exception
133		* @throws NetworkException
134		*/
135	1	protected function postRequest($url, $parameters = [])
136		{
137	1	if (!empty($parameters)) {
138	1	$this->parameters->addPost($parameters);
139	1	}
140
141	1	return $this->request($url);
142		}
143
144		/**
145		* Подготавливает список заголовков HTTP
146		*
147		* @param mixed $modified Значение заголовка IF-MODIFIED-SINCE
148		* @return array
149		*/
150	2	protected function prepareHeaders($modified = null)
151		{
152	2	$headers = ['Content-Type: application/json'];
153
154	2	if ($modified !== null) {
155	2	if (is_int($modified)) {
156	1	$headers[] = 'IF-MODIFIED-SINCE: ' . $modified;
157	1	} else {
158	2	$headers[] = 'IF-MODIFIED-SINCE: ' . (new DateTime($modified))->format(DateTime::RFC1123);
159		}
160	1	}
161
162	1	return $headers;
163		}
164
165		/**
166		* Подготавливает URL для HTTP запроса
167		*
168		* @param string $url Запрашиваемый URL
169		* @return string
170		*/
171	2	protected function prepareEndpoint($url)
172		{
173	2	if ($this->v1 === false) {
174	1	$query = http_build_query(array_merge($this->parameters->getGet(), [
175	1	'USER_LOGIN' => $this->parameters->getAuth('login'),
176	1	'USER_HASH' => $this->parameters->getAuth('apikey'),
177	1	]), null, '&');
178	1	} else {
179	1	$query = http_build_query(array_merge($this->parameters->getGet(), [
180	1	'login' => $this->parameters->getAuth('login'),
181	1	'api_key' => $this->parameters->getAuth('apikey'),
182	1	]), null, '&');
183		}
184
185	2	return sprintf('https://%s%s?%s', $this->parameters->getAuth('domain'), $url, $query);
186		}
187
188		/**
189		* Выполнить HTTP запрос и вернуть тело ответа
190		*
191		* @param string $url Запрашиваемый URL
192		* @param null\|string $modified Значение заголовка IF-MODIFIED-SINCE
193		* @return mixed
194		* @throws Exception
195		* @throws NetworkException
196		*/
197		protected function request($url, $modified = null)
198		{
199		$headers = $this->prepareHeaders($modified);
200		$endpoint = $this->prepareEndpoint($url);
201
202		$this->printDebug('url', $endpoint);
203		$this->printDebug('headers', $headers);
204
205		$ch = curl_init();
206
207		curl_setopt($ch, CURLOPT_URL, $endpoint);
208		curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
209		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
210		curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
211		curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
212
213		if ($this->parameters->hasPost()) {
214		$fields = json_encode([
215		'request' => $this->parameters->getPost(),
216		]);
217		curl_setopt($ch, CURLOPT_POST, true);
218		curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);
219		$this->printDebug('post params', $fields);
220		}
221
222		$result = curl_exec($ch);
223		$info = curl_getinfo($ch);
224		$error = curl_error($ch);
225		$errno = curl_errno($ch);
226
227		curl_close($ch);
228
229		$this->lastHttpCode = $info['http_code'];
230		$this->lastHttpResponse = $result;
231
232		$this->printDebug('curl_exec', $result);
233		$this->printDebug('curl_getinfo', $info);
234		$this->printDebug('curl_error', $error);
235		$this->printDebug('curl_errno', $errno);
236
237		if ($result === false && !empty($error)) {
238		throw new NetworkException($error, $errno);
239		}
240
241		return $this->parseResponse($result, $info);
242		}
243
244		/**
245		* Парсит HTTP ответ, проверяет на наличие ошибок и возвращает тело ответа
246		*
247		* @param string $response HTTP ответ
248		* @param array $info Результат функции curl_getinfo
249		* @return mixed
250		* @throws Exception
251		*/
252	5	protected function parseResponse($response, $info)
253		{
254	5	$result = json_decode($response, true);
255
256	5	if (!isset($result['response'])) {
257	1	return false;
258	4	} elseif (floor($info['http_code'] / 100) >= 3) {
259	3	$code = 0;
260	3	if (isset($result['response']['error_code']) && $result['response']['error_code'] > 0) {
261	1	$code = $result['response']['error_code'];
262	1	}
263	3	if ($this->v1 === false) {
264	2	throw new Exception($result['response']['error'], $code);
265		} else {
266	1	throw new Exception(json_encode($result['response']));
267		}
268		}
269
270	1	return $result['response'];
271		}
272
273		/**
274		* Вывода отладочной информации
275		*
276		* @param string $key Заголовок отладочной информации
277		* @param mixed $value Значение отладочной информации
278		* @param bool $return Возврат строки вместо вывода
279		* @return mixed
280		*/
281	2	protected function printDebug($key = '', $value = null, $return = false)
282		{
283	2	if ($this->debug !== true) {
284	1	return false;
285		}
286
287	1	if (!is_string($value)) {
288	1	$value = print_r($value, true);
289	1	}
290
291	1	$line = sprintf('[DEBUG] %s: %s', $key, $value);
292
293	1	if ($return === false) {
294		return print_r($line . PHP_EOL);
295		}
296
297	1	return $line;
298		}
299		}
300

dotzero / amocrm-php

Push — master ( 870a85...648470 )

Request::getLastHttpCode() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like