AbstractConnection::checkResponse() - Code Metrics - Inspection of "changed `Command::search`: added passing send opti..." - hiqdev/yii2-hiart - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 729f46...ea06ac )

by Andrii

created 2017-01-26 17:41 UTC

AbstractConnection::checkResponse() A

↳ Parent: AbstractConnection

Complexity

Conditions	3
Paths	4

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3.4746

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	5
cts	8
cp	0.625
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	7
nc	4
nop	1
crap	3.4746

<?php
/**
 * Tools to use API as ActiveRecord for Yii2
 *
 * @link      https://github.com/hiqdev/yii2-hiart
 * @package   yii2-hiart
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\hiart;

use Closure;
use hiqdev\hiart\stream\Request;
use Yii;
use yii\base\Component;
use yii\base\InvalidParamException;
use yii\helpers\Json;

/**
 * Abstract connection class.
 */
abstract class AbstractConnection extends Component implements ConnectionInterface
{
    const EVENT_AFTER_OPEN = 'afterOpen';

    /**
     * @var string to be specified in concrete implementation
     */
    public $queryBuilderClass;

    public $requestClass = Request::class;

    public $commandClass = Command::class;

    public $queryClass = Query::class;

    public $activeQueryClass = ActiveQuery::class;

    public static $dbname = 'hiart';

    public $name = 'hiart';

    public $userAgent = 'HiArt/0.x';

    public $baseUri;

    /**
     * @var array transport config will be used in Request for handler or proxy request
     */
    public $config = [];

    /**
     * @var object request handler common for all requests of this connection
     */
    protected $_handler;

    /**
     * @var AbstractQueryBuilder the query builder for this connection
     */
    protected $_builder;

    /**
     * @var array authorization config
     */
    protected $_auth = [];

    /**
     * @var bool is auth disabled
     */
    protected $_disabledAuth = false;

    /**
     * @var Closure callback to test if API response has error
     * The function signature: `function ($response)`
     * Must return `null`, if the response does not contain an error
     */
    protected $_errorChecker;

    /**
     * @param null $dbname
     * @return ConnectionInterface|AbstractConnection
     */
    public static function getDb($dbname = null)
    {
        return $dbname ? Yii::$app->get($dbname) : Yii::$container->get(ConnectionInterface::class);
    }

    public function setAuth($auth)
    {
        $this->_auth = $auth;
    }

    /**
     * Returns auth settings.
     * @return array
     */
    public function getAuth()
    {
        if ($this->_disabledAuth) {
            return [];
        }
        if ($this->_auth instanceof Closure) {
            $this->_auth = call_user_func($this->_auth, $this);

        }

        return $this->_auth;
    }

    public function disableAuth()
    {
        $this->_disabledAuth = true;
    }

    public function enableAuth()
    {
        $this->_disabledAuth = false;
    }

    /**
     * Closes the connection when this component is being serialized.
     * @return array
     */
    public function __sleep()
    {
        return array_keys(get_object_vars($this));
    }

    /**
     * Returns the name of the DB driver for the current [[dsn]].
     * @return string name of the DB driver
     */
    public function getDriverName()
    {
        return 'hiart';
    }

    /**
     * Creates a command for execution.
     * @param array $config the configuration for the Command class
     * @return Command the DB command
     */
    public function createCommand(array $config = [])
    {
        $config['db'] = $this;

        return new $this->commandClass($config);
    }

    /**
     * @return AbstractQueryBuilder the query builder for this connection
     */
    public function getQueryBuilder()
    {
        if ($this->_builder === null) {
            $this->_builder = new $this->queryBuilderClass($this);
        }

        return $this->_builder;
    }

    /**
     * Handler is created and set by request.
     * @see setHandler
     * @return object
     */
    public function getHandler()
    {
        return $this->_handler;
    }

    /**
     * Requests use this function to keep request handler.
     * @param object $handler
     */
    public function setHandler($handler)
    {
        $this->_handler = $handler;
    }

    /**
     * @return boolean
     */
    public function isDisabledAuth()
    {
        return $this->_disabledAuth;
    }

    /**
     * @param boolean $disabledAuth
     */
    public function setDisabledAuth($disabledAuth)
    {
        $this->_disabledAuth = $disabledAuth;
    }

    /**
     * Try to decode error information if it is valid json, return it if not.
     * @param $body
     * @return mixed
     */
    protected function decodeErrorBody($body)
    {
        try {
            $decoded = Json::decode($body);
            if (isset($decoded['error'])) {
                $decoded['error'] = preg_replace('/\b\w+?Exception\[/',
                    "<span style=\"color: red;\">\\0</span>\n               ", $decoded['error']);
            }

            return $decoded;
        } catch (InvalidParamException $e) {
            return $body;
        }
    }

    /**
     * Setter for errorChecker.
     * @param Closure $checker
     */
    public function setErrorChecker($checker)
    {
        $this->_errorChecker = $checker;
    }

    /**
     * Checks response method and raises exception if error found.
     * @param ResponseInterface $response response data from API
     * @throws ResponseErrorException when response is invalid
     */
    public function checkResponse(ResponseInterface $response)
    {
        if (isset($this->_errorChecker)) {
            $error = call_user_func($this->_errorChecker, $response);
        } else {
            $error = $this->getResponseError($response);
        }

        if ($error) {
            throw new ResponseErrorException($error, $response);
        }
    }

    /**
     * Method checks whether the response is an error.
     *
     * @param ResponseInterface $response
     * @return false|string the error text or boolean `false`, when the response is not an error
     */
    abstract public function getResponseError(ResponseInterface $response);

    /**
     * Return API base uri.
     * Adds trailing slash if uri is domain only.
     * @return string
     */
    public function getBaseUri()
    {
        static $checked;
        if (empty($checked)) {
            if (count(explode('/', $this->baseUri, 4)) === 3) {
                $this->baseUri .= '/';
            }
            $checked = true;
        }

        return $this->baseUri;
    }

    public function getUserAgent()
    {
        return $this->userAgent;
    }
}


1		<?php
2		/**
3		* Tools to use API as ActiveRecord for Yii2
4		*
5		* @link https://github.com/hiqdev/yii2-hiart
6		* @package yii2-hiart
7		* @license BSD-3-Clause
8		* @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
9		*/
10
11		namespace hiqdev\hiart;
12
13		use Closure;
14		use hiqdev\hiart\stream\Request;
15		use Yii;
16		use yii\base\Component;
17		use yii\base\InvalidParamException;
18		use yii\helpers\Json;
19
20		/**
21		* Abstract connection class.
22		*/
23		abstract class AbstractConnection extends Component implements ConnectionInterface
24		{
25		const EVENT_AFTER_OPEN = 'afterOpen';
26
27		/**
28		* @var string to be specified in concrete implementation
29		*/
30		public $queryBuilderClass;
31
32		public $requestClass = Request::class;
33
34		public $commandClass = Command::class;
35
36		public $queryClass = Query::class;
37
38		public $activeQueryClass = ActiveQuery::class;
39
40		public static $dbname = 'hiart';
41
42		public $name = 'hiart';
43
44		public $userAgent = 'HiArt/0.x';
45
46		public $baseUri;
47
48		/**
49		* @var array transport config will be used in Request for handler or proxy request
50		*/
51		public $config = [];
52
53		/**
54		* @var object request handler common for all requests of this connection
55		*/
56		protected $_handler;
57
58		/**
59		* @var AbstractQueryBuilder the query builder for this connection
60		*/
61		protected $_builder;
62
63		/**
64		* @var array authorization config
65		*/
66		protected $_auth = [];
67
68		/**
69		* @var bool is auth disabled
70		*/
71		protected $_disabledAuth = false;
72
73		/**
74		* @var Closure callback to test if API response has error
75		* The function signature: `function ($response)`
76		* Must return `null`, if the response does not contain an error
77		*/
78		protected $_errorChecker;
79
80		/**
81		* @param null $dbname
82		* @return ConnectionInterface\|AbstractConnection
83		*/
84		public static function getDb($dbname = null)
85		{
86		return $dbname ? Yii::$app->get($dbname) : Yii::$container->get(ConnectionInterface::class);
87		}
88
89	1	public function setAuth($auth)
90		{
91	1	$this->_auth = $auth;
92	1	}
93
94		/**
95		* Returns auth settings.
96		* @return array
97		*/
98	2	public function getAuth()
99		{
100	2	if ($this->_disabledAuth) {
101		return [];
102		}
103	2	if ($this->_auth instanceof Closure) {
104		$this->_auth = call_user_func($this->_auth, $this);
		0 ignored issues – show Documentation Bug introduced 2017-01-24 17:39 UTC by Report Bug Copy Issue Report It seems like `call_user_func($this->_auth, $this)` of type `*` is incompatible with the declared type `array` of property `$_auth`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
105		}
106
107	2	return $this->_auth;
108		}
109
110		public function disableAuth()
111		{
112		$this->_disabledAuth = true;
113		}
114
115		public function enableAuth()
116		{
117		$this->_disabledAuth = false;
118		}
119
120		/**
121		* Closes the connection when this component is being serialized.
122		* @return array
123		*/
124		public function __sleep()
125		{
126		return array_keys(get_object_vars($this));
127		}
128
129		/**
130		* Returns the name of the DB driver for the current [[dsn]].
131		* @return string name of the DB driver
132		*/
133		public function getDriverName()
134		{
135		return 'hiart';
136		}
137
138		/**
139		* Creates a command for execution.
140		* @param array $config the configuration for the Command class
141		* @return Command the DB command
142		*/
143	2	public function createCommand(array $config = [])
144		{
145	2	$config['db'] = $this;
146
147	2	return new $this->commandClass($config);
148		}
149
150		/**
151		* @return AbstractQueryBuilder the query builder for this connection
152		*/
153	3	public function getQueryBuilder()
154		{
155	3	if ($this->_builder === null) {
156	2	$this->_builder = new $this->queryBuilderClass($this);
157	2	}
158
159	3	return $this->_builder;
160		}
161
162		/**
163		* Handler is created and set by request.
164		* @see setHandler
165		* @return object
166		*/
167		public function getHandler()
168		{
169		return $this->_handler;
170		}
171
172		/**
173		* Requests use this function to keep request handler.
174		* @param object $handler
175		*/
176		public function setHandler($handler)
177		{
178		$this->_handler = $handler;
179		}
180
181		/**
182		* @return boolean
183		*/
184		public function isDisabledAuth()
185		{
186		return $this->_disabledAuth;
187		}
188
189		/**
190		* @param boolean $disabledAuth
191		*/
192		public function setDisabledAuth($disabledAuth)
193		{
194		$this->_disabledAuth = $disabledAuth;
195		}
196
197		/**
198		* Try to decode error information if it is valid json, return it if not.
199		* @param $body
200		* @return mixed
201		*/
202		protected function decodeErrorBody($body)
203		{
204		try {
205		$decoded = Json::decode($body);
206		if (isset($decoded['error'])) {
207		$decoded['error'] = preg_replace('/\b\w+?Exception\[/',
208		"<span style=\"color: red;\">\\0</span>\n ", $decoded['error']);
209		}
210
211		return $decoded;
212		} catch (InvalidParamException $e) {
213		return $body;
214		}
215		}
216
217		/**
218		* Setter for errorChecker.
219		* @param Closure $checker
220		*/
221		public function setErrorChecker($checker)
222		{
223		$this->_errorChecker = $checker;
224		}
225
226		/**
227		* Checks response method and raises exception if error found.
228		* @param ResponseInterface $response response data from API
229		* @throws ResponseErrorException when response is invalid
230		*/
231	2	public function checkResponse(ResponseInterface $response)
232		{
233	2	if (isset($this->_errorChecker)) {
234		$error = call_user_func($this->_errorChecker, $response);
235		} else {
236	2	$error = $this->getResponseError($response);
237		}
238
239	2	if ($error) {
240	2	throw new ResponseErrorException($error, $response);
241		}
242		}
243
244		/**
245		* Method checks whether the response is an error.
246		*
247		* @param ResponseInterface $response
248		* @return false\|string the error text or boolean `false`, when the response is not an error
249		*/
250		abstract public function getResponseError(ResponseInterface $response);
251
252		/**
253		* Return API base uri.
254		* Adds trailing slash if uri is domain only.
255		* @return string
256		*/
257	3	public function getBaseUri()
258		{
259	3	static $checked;
260	3	if (empty($checked)) {
261	1	if (count(explode('/', $this->baseUri, 4)) === 3) {
262	1	$this->baseUri .= '/';
263	1	}
264	1	$checked = true;
265	1	}
266
267	3	return $this->baseUri;
268		}
269
270	2	public function getUserAgent()
271		{
272	2	return $this->userAgent;
273		}
274		}
275

hiqdev / yii2-hiart

Push — master ( 729f46...ea06ac )

AbstractConnection::checkResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like