CurlAdapter::request() - Code Metrics - Inspection of "Add the possibility to use Apikey" - thematicmedia/habrahabr_api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 49bad6...13c876 )

by dotzero

created 2016-06-02 12:40 UTC

CurlAdapter::request() D

↳ Parent: CurlAdapter

Complexity

Conditions	9
Paths	36

Size

Total Lines	37
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	90

Importance

Changes	9
Bugs	1	Features	2

Metric	Value
c	9
b	1
f	2
dl	0
loc	37
ccs	0
cts	28
cp	0
rs	4.909
cc	9
eloc	23
nc	36
nop	3
crap	90

<?php

namespace Habrahabr\Api\HttpAdapter;

use Habrahabr\Api\Exception\ExtensionNotLoadedException;
use Habrahabr\Api\Exception\NetworkException;

/**
 * Class CurlAdapter
 *
 * Habrahabr Api HTTP адаптер использующий cURL как транспорт
 *
 * @package Habrahabr\Api\HttpAdapter
 * @version 0.1.0
 * @author thematicmedia <[email protected]>
 * @link https://tmtm.ru/
 * @link https://habrahabr.ru/
 * @link https://github.com/thematicmedia/habrahabr_api
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
class CurlAdapter extends BaseAdapter implements HttpAdapterInterface
{
    /**
     * @const string Тип HTTP запроса GET
     */
    const METHOD_GET = 'GET';

    /**
     * @const string Тип HTTP запроса POST
     */
    const METHOD_POST = 'POST';

    /**
     * @const string Тип HTTP запроса PUT
     */
    const METHOD_PUT = 'PUT';

    /**
     * @const string Тип HTTP запроса DELETE
     */
    const METHOD_DELETE = 'DELETE';

    /**
     * @var null|resource Экземпляр cURL
     */
    protected $curl = null;

    /**
     * @var bool Строгая проверка SSL сертификата
     */
    protected $strictSSL = true;

    /**
     * CurlAdapter constructor
     *
     * @throws ExtensionNotLoadedException
     */
    public function __construct()
    {
        if (!function_exists('curl_init')) {
            throw new ExtensionNotLoadedException('The cURL PHP extension was not loaded');
        }

        $this->curl = curl_init();
    }

    /**
     * CurlAdapter destructor
     */
    public function __destruct()
    {
        if ($this->curl) {
            curl_close($this->curl);
        }
    }

    /**
     * Выполнить HTTP GET запрос и вернуть тело ответа
     *
     * @param string $url URL суффикс запрашиваемого ресурса
     * @return array
     * @throws NetworkException
     */
    public function get($url)
    {
        return $this->request($this->createUrl($url), self::METHOD_GET);
    }

    /**
     * Выполнить HTTP POST запрос и вернуть тело ответа
     *
     * @param string $url URL суффикс запрашиваемого ресурса
     * @param array $params Параметры, передаваемые в теле запроса
     * @return array
     * @throws NetworkException
     */
    public function post($url, array $params = [])
    {
        return $this->request($this->createUrl($url), self::METHOD_POST, $params);
    }

    /**
     * Выполнить HTTP PUT запрос и вернуть тело ответа
     *
     * @param string $url URL суффикс запрашиваемого ресурса
     * @param array $params Параметры, передаваемые в теле запроса
     * @return array
     * @throws NetworkException
     */
    public function put($url, array $params = [])
    {
        return $this->request($this->createUrl($url), self::METHOD_PUT, $params);
    }

    /**
     * Выполнить HTTP DELETE запрос и вернуть тело ответа
     *
     * @param string $url URL суффикс запрашиваемого ресурса
     * @param array $params Параметры, передаваемые в теле запроса
     * @return array
     * @throws NetworkException
     */
    public function delete($url, array $params = [])
    {
        return $this->request($this->createUrl($url), self::METHOD_DELETE, $params);
    }

    /**
     * Устанавливает или убирает строгую проверку SSL сертификата
     *
     * @param bool $flag Флаг строгой проверки SSL сертификата
     * @return $this
     */
    public function setStrictSSL($flag = true)
    {
        $this->strictSSL = $flag;

        return $this;
    }

    /**
     * Выполнить HTTP запрос и вернуть тело ответа
     *
     * @param string $url URL суффикс запрашиваемого ресурса
     * @param string $method метод HTTP запроса
     * @param array $params Параметры, передаваемые в теле запроса
     * @return array
     * @throws NetworkException
     */
    protected function request($url, $method, array $params = [])
    {
        curl_setopt($this->curl, CURLOPT_URL, $url);
        curl_setopt($this->curl, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, $method);
        curl_setopt($this->curl, CURLOPT_CONNECTTIMEOUT, $this->connectionTimeout);

        if ($this->client && $this->token) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            curl_setopt($this->curl, CURLOPT_HTTPHEADER, [
                'client: ' . $this->client,
                'token: ' . $this->token
            ]);
        } elseif ($this->apikey) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            curl_setopt($this->curl, CURLOPT_HTTPHEADER, [
                'apikey: ' . $this->apikey,
            ]);
        }

        if ($this->strictSSL === false) {
            curl_setopt($this->curl, CURLOPT_SSL_VERIFYHOST, 0);
            curl_setopt($this->curl, CURLOPT_SSL_VERIFYPEER, 0);
        }

        if ($method == self::METHOD_PUT || $method == self::METHOD_POST) {
            curl_setopt($this->curl, CURLOPT_POSTFIELDS, http_build_query($params));
        }

        if (!$result = curl_exec($this->curl)) {
            $error = curl_error($this->curl);
            $errno = curl_errno($this->curl);
            throw new NetworkException($error, $errno);
        }

        $result = json_decode($result, true);

        return $result ? $result : [];
    }
}


1		<?php
2
3		namespace Habrahabr\Api\HttpAdapter;
4
5		use Habrahabr\Api\Exception\ExtensionNotLoadedException;
6		use Habrahabr\Api\Exception\NetworkException;
7
8		/**
9		* Class CurlAdapter
10		*
11		* Habrahabr Api HTTP адаптер использующий cURL как транспорт
12		*
13		* @package Habrahabr\Api\HttpAdapter
14		* @version 0.1.0
15		* @author thematicmedia <[email protected]>
16		* @link https://tmtm.ru/
17		* @link https://habrahabr.ru/
18		* @link https://github.com/thematicmedia/habrahabr_api
19		*
20		* For the full copyright and license information, please view the LICENSE
21		* file that was distributed with this source code.
22		*/
23		class CurlAdapter extends BaseAdapter implements HttpAdapterInterface
24		{
25		/**
26		* @const string Тип HTTP запроса GET
27		*/
28		const METHOD_GET = 'GET';
29
30		/**
31		* @const string Тип HTTP запроса POST
32		*/
33		const METHOD_POST = 'POST';
34
35		/**
36		* @const string Тип HTTP запроса PUT
37		*/
38		const METHOD_PUT = 'PUT';
39
40		/**
41		* @const string Тип HTTP запроса DELETE
42		*/
43		const METHOD_DELETE = 'DELETE';
44
45		/**
46		* @var null\|resource Экземпляр cURL
47		*/
48		protected $curl = null;
49
50		/**
51		* @var bool Строгая проверка SSL сертификата
52		*/
53		protected $strictSSL = true;
54
55		/**
56		* CurlAdapter constructor
57		*
58		* @throws ExtensionNotLoadedException
59		*/
60	6	public function __construct()
61		{
62	6	if (!function_exists('curl_init')) {
63		throw new ExtensionNotLoadedException('The cURL PHP extension was not loaded');
64		}
65
66	6	$this->curl = curl_init();
67	6	}
68
69		/**
70		* CurlAdapter destructor
71		*/
72	1	public function __destruct()
73		{
74	1	if ($this->curl) {
75	1	curl_close($this->curl);
76	1	}
77	1	}
78
79		/**
80		* Выполнить HTTP GET запрос и вернуть тело ответа
81		*
82		* @param string $url URL суффикс запрашиваемого ресурса
83		* @return array
84		* @throws NetworkException
85		*/
86	1	public function get($url)
87		{
88	1	return $this->request($this->createUrl($url), self::METHOD_GET);
89		}
90
91		/**
92		* Выполнить HTTP POST запрос и вернуть тело ответа
93		*
94		* @param string $url URL суффикс запрашиваемого ресурса
95		* @param array $params Параметры, передаваемые в теле запроса
96		* @return array
97		* @throws NetworkException
98		*/
99	1	public function post($url, array $params = [])
100		{
101	1	return $this->request($this->createUrl($url), self::METHOD_POST, $params);
102		}
103
104		/**
105		* Выполнить HTTP PUT запрос и вернуть тело ответа
106		*
107		* @param string $url URL суффикс запрашиваемого ресурса
108		* @param array $params Параметры, передаваемые в теле запроса
109		* @return array
110		* @throws NetworkException
111		*/
112	1	public function put($url, array $params = [])
113		{
114	1	return $this->request($this->createUrl($url), self::METHOD_PUT, $params);
115		}
116
117		/**
118		* Выполнить HTTP DELETE запрос и вернуть тело ответа
119		*
120		* @param string $url URL суффикс запрашиваемого ресурса
121		* @param array $params Параметры, передаваемые в теле запроса
122		* @return array
123		* @throws NetworkException
124		*/
125	1	public function delete($url, array $params = [])
126		{
127	1	return $this->request($this->createUrl($url), self::METHOD_DELETE, $params);
128		}
129
130		/**
131		* Устанавливает или убирает строгую проверку SSL сертификата
132		*
133		* @param bool $flag Флаг строгой проверки SSL сертификата
134		* @return $this
135		*/
136	1	public function setStrictSSL($flag = true)
137		{
138	1	$this->strictSSL = $flag;
139
140	1	return $this;
141		}
142
143		/**
144		* Выполнить HTTP запрос и вернуть тело ответа
145		*
146		* @param string $url URL суффикс запрашиваемого ресурса
147		* @param string $method метод HTTP запроса
148		* @param array $params Параметры, передаваемые в теле запроса
149		* @return array
150		* @throws NetworkException
151		*/
152		protected function request($url, $method, array $params = [])
153		{
154		curl_setopt($this->curl, CURLOPT_URL, $url);
155		curl_setopt($this->curl, CURLOPT_RETURNTRANSFER, 1);
156		curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, $method);
157		curl_setopt($this->curl, CURLOPT_CONNECTTIMEOUT, $this->connectionTimeout);
158
159		if ($this->client && $this->token) {
		0 ignored issues – show Bug Best Practice introduced 2016-06-02 12:50 UTC by Report Bug Copy Issue Report The expression `$this->client` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history... Bug Best Practice introduced 2016-06-02 12:50 UTC by Report Bug Copy Issue Report The expression `$this->token` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
160		curl_setopt($this->curl, CURLOPT_HTTPHEADER, [
161		'client: ' . $this->client,
162		'token: ' . $this->token
163		]);
164		} elseif ($this->apikey) {
		0 ignored issues – show Bug Best Practice introduced 2016-06-02 12:50 UTC by Report Bug Copy Issue Report The expression `$this->apikey` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
165		curl_setopt($this->curl, CURLOPT_HTTPHEADER, [
166		'apikey: ' . $this->apikey,
167		]);
168		}
169
170		if ($this->strictSSL === false) {
171		curl_setopt($this->curl, CURLOPT_SSL_VERIFYHOST, 0);
172		curl_setopt($this->curl, CURLOPT_SSL_VERIFYPEER, 0);
173		}
174
175		if ($method == self::METHOD_PUT \|\| $method == self::METHOD_POST) {
176		curl_setopt($this->curl, CURLOPT_POSTFIELDS, http_build_query($params));
177		}
178
179		if (!$result = curl_exec($this->curl)) {
180		$error = curl_error($this->curl);
181		$errno = curl_errno($this->curl);
182		throw new NetworkException($error, $errno);
183		}
184
185		$result = json_decode($result, true);
186
187		return $result ? $result : [];
188		}
189		}
190

thematicmedia / habrahabr_api

Push — master ( 49bad6...13c876 )

CurlAdapter::request() D

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like