hiqdev\hiart\Connection

Complexity

Total Complexity

58

Size/Duplication

Total Lines	435
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	8

Test Coverage

Coverage

0%

Importance

Changes	10
Bugs	2	Features	2

21 Methods

Rating	Name	Duplication	Size	Complexity
A	setAuth()	0	4	1
A	getAuth()	0	8	2
A	init()	0	6	2
A	getHandler()	0	8	2
A	__sleep()	0	4	1
A	getDriverName()	0	4	1
A	createCommand()	0	7	1
A	getQueryBuilder()	0	4	1
A	get()	0	4	1
A	head()	0	4	1
A	post()	0	4	1
A	put()	0	4	1
A	delete()	0	4	1
A	perform()	0	4	1
A	makeRequest()	0	7	1
B	createUrl()	0	17	5
B	guzzleRequest()	0	16	5
A	getGuzzle()	0	8	2
F	curlRequest()	0	126	23
A	decodeErrorBody()	0	14	3
A	checkResponse()	0	13	2

<?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, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\hiart;

use Closure;
use Yii;
use yii\base\Component;
use yii\base\InvalidConfigException;
use yii\base\InvalidParamException;
use yii\helpers\Json;

/**
 * Connection class.
 *
 * Example configuration:
 * ```php
 * 'components' => [
 *     'hiart' => [
 *         'class' => 'hiqdev\hiart\Connection',
 *         'config' => [
 *             'base_uri' => 'https://api.site.com/',
 *         ],
 *     ],
 * ],
 * ```
 */
class Connection extends Component
{
    const EVENT_AFTER_OPEN = 'afterOpen';

    /**
     * @var array Config
     */
    public $config = [];

    public $connectionTimeout = null;

    public $dataTimeout = null;

    public static $curl = null;

    protected static $guzzle = null;

    /**
     * Authorization config.
     *
     * @var array
     */
    protected $_auth;

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

    public function getAuth()
    {
        if ($this->_auth instanceof Closure) {
            $this->_auth = call_user_func($this->_auth, $this);

It seems like call_user_func($this->_auth, $this) of type * is incompatible with the declared type array of property $_auth.

        }

        return $this->_auth;
    }

    public function init()
    {
        if (!isset($this->config['api_url'])) {
            throw new InvalidConfigException('HiArt needs api_url configuration');
        }
    }

    public function getHandler()
    {
        if (!self::$curl) {
            self::$curl = static::$curl = curl_init();
        }

        return self::$curl;
    }

    /**
     * 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 'hiresource';
    }

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

        return $command;
    }

    /**
     * Creates new query builder instance.
     *
     * @return QueryBuilder
     */
    public function getQueryBuilder()
    {
        return new QueryBuilder($this);
    }

    /**
     * Performs GET HTTP request.
     * @param string $url     URL
     * @param array  $options URL options
     * @param string $body    request body
     * @param bool   $raw     if response body contains JSON and should be decoded
     * @throws HiArtException
     * @throws \yii\base\InvalidConfigException
     * @return mixed response
     */
    public function get($url, $options = [], $body = null, $raw = false)
    {
        return $this->makeRequest('GET', $url, $options, $body, $raw);
    }

    /**
     * Performs HEAD HTTP request.
     * @param string $url     URL
     * @param array  $options URL options
     * @param string $body    request body
     * @throws HiArtException
     * @throws \yii\base\InvalidConfigException
     * @return mixed response
     */
    public function head($url, $options = [], $body = null)
    {
        return $this->makeRequest('HEAD', $url, $options, $body, $raw);

The variable $raw does not exist. Did you forget to declare it?

    }

    /**
     * Performs POST HTTP request.
     * @param string $url     URL
     * @param array  $options URL options
     * @param string $body    request body
     * @param bool   $raw     if response body contains JSON and should be decoded
     * @throws HiArtException
     * @throws \yii\base\InvalidConfigException
     * @return mixed response
     */
    public function post($url, $options = [], $body = null, $raw = false)
    {
        return $this->makeRequest('POST', $url, $options, $body, $raw);
    }

    /**
     * Performs PUT HTTP request.
     * @param string $url     URL
     * @param array  $options URL options
     * @param string $body    request body
     * @param bool   $raw     if response body contains JSON and should be decoded
     * @throws HiArtException
     * @throws \yii\base\InvalidConfigException
     * @return mixed response
     */
    public function put($url, $options = [], $body = null, $raw = false)
    {
        return $this->makeRequest('PUT', $url, $options, $body, $raw);
    }

    /**
     * Performs DELETE HTTP request.
     * @param string $url     URL
     * @param array  $options URL options
     * @param string $body    request body
     * @param bool   $raw     if response body contains JSON and should be decoded
     * @throws HiArtException
     * @throws \yii\base\InvalidConfigException
     * @return mixed response
     */
    public function delete($url, $options = [], $body = null, $raw = false)
    {
        return $this->makeRequest('DELETE', $url, $options, $body, $raw);
    }

    /**
     * XXX To be removed in favour of post().
     * @param $url
     * @param array $options
     * @return mixed
     */
    public function perform($url, $options = [])
    {
        return $this->makeRequest('DELETE', $url, $options);
    }

    /**
     * Make request and check for error.
     * @param string $url     URL
     * @param array  $options URL options
     * @param string $body    request body
     * @param bool   $raw     if response body contains JSON and should be decoded
     * @throws HiArtException
     * @throws \yii\base\InvalidConfigException
     * @return mixed response
     */
    public function makeRequest($method, $url, $options = [], $body = null, $raw = false)

The parameter $body is not used and could be removed.

    {
        #$result = $this->curlRequest($method, $this->createUrl($url), http_build_query($options), $raw);

68% of this comment could be valid code. Did you maybe forget this after debugging?

        $result = $this->guzzleRequest($method, $this->createUrl($url), $options, $raw);

        return $this->checkResponse($result, $url, $options);
    }

    /**
     * Creates URL.
     * @param mixed $path path
     * @param array $options URL options
     * @return array
     */
    private function createUrl($path, array $options = [])
    {
        $options = array_merge($this->getAuth(), $options);
        if (!is_string($path)) {
            $url = urldecode(reset($path));
            if (!empty($options)) {
                $url .= '?' . http_build_query($options);
            }
        } else {
            $url = $path;
            if (!empty($options)) {
                $url .= (strpos($url, '?') === false ? '?' : '&') . http_build_query($options);
            }
        }

        return [$this->config['api_url'], $url];
    }

    protected function guzzleRequest($method, $url, $body = null, $raw = false)
    {
        $method  = strtoupper($method);
        $profile = $method . ' ' . $url[1] . '#' . (is_array($body) ? http_build_query($body) : $body);
        $options = [(is_array($body) ? 'form_params' : 'body') => $body];
        Yii::beginProfile($profile, __METHOD__);
        $response = $this->getGuzzle()->request($method, $url[1], $options);
        Yii::endProfile($profile, __METHOD__);

        $res = $response->getBody()->getContents();
        if (!$raw && in_array('application/json', $response->getHeader('Content-Type'))) {
            $res = Json::decode($res);
        }

        return $res;
    }

    public function getGuzzle()
    {
        if (static::$guzzle === null) {
            static::$guzzle = new \GuzzleHttp\Client($this->config);
        }

        return static::$guzzle;
    }

    /**
     * Performs HTTP request.
     * @param string $method method name
     * @param string $url URL
     * @param string $requestBody request body
     * @param bool $raw if response body contains JSON and should be decoded
     * @throws ErrorResponseException
     * @throws HiArtException
     * @return mixed if request failed
     */
    protected function curlRequest($method, $url, $requestBody = null, $raw = false)
    {
        $method = strtoupper($method);
        // response body and headers
        $headers = [];
        $body    = '';
        $options = [
            CURLOPT_URL       => $url,
            CURLOPT_USERAGENT => 'Yii Framework ' . Yii::getVersion() . ' (HiArt)',
            //CURLOPT_ENCODING        => 'UTF-8',

50% of this comment could be valid code. Did you maybe forget this after debugging?

            # CURLOPT_USERAGENT       => 'curl/0.00 (php 5.x; U; en)',

43% of this comment could be valid code. Did you maybe forget this after debugging?

            CURLOPT_RETURNTRANSFER => false,
            CURLOPT_HEADER         => false,
            CURLOPT_SSL_VERIFYPEER => false,
            CURLOPT_SSL_VERIFYHOST => 2,
            // http://www.php.net/manual/en/function.curl-setopt.php#82418
            CURLOPT_HTTPHEADER    => ['Expect:'],
            CURLOPT_WRITEFUNCTION => function ($curl, $data) use (&$body) {
                $body .= $data;

                return mb_strlen($data, '8bit');
            },
            CURLOPT_HEADERFUNCTION => function ($curl, $data) use (&$headers) {
                foreach (explode("\r\n", $data) as $row) {
                    if (($pos = strpos($row, ':')) !== false) {
                        $headers[strtolower(substr($row, 0, $pos))] = trim(substr($row, $pos + 1));
                    }
                }

                return mb_strlen($data, '8bit');
            },
            CURLOPT_CUSTOMREQUEST => $method,
        ];
        if ($this->connectionTimeout !== null) {
            $options[CURLOPT_CONNECTTIMEOUT] = $this->connectionTimeout;
        }
        if ($this->dataTimeout !== null) {
            $options[CURLOPT_TIMEOUT] = $this->dataTimeout;
        }
        if ($requestBody !== null) {
            $options[CURLOPT_POSTFIELDS] = $requestBody;
        }
        if ($method === 'HEAD') {
            $options[CURLOPT_NOBODY] = true;
            unset($options[CURLOPT_WRITEFUNCTION]);
        }
        if (is_array($url)) {
            list($host, $q) = $url;
            if (strncmp($host, 'inet[', 5) === 0) {
                $host = substr($host, 5, -1);
                if (($pos = strpos($host, '/')) !== false) {
                    $host = substr($host, $pos + 1);
                }
            }
            $profile = $method . ' ' . $q . '#' . $requestBody;
            if (preg_match('@^https?://@', $host)) {
                $url = $host . '/' . $q;
            } else {
                throw new HiArtException('Request failed: please specify the protocol (http, https) in reference to the API HiResource Core');
            }
        } else {
            $profile = false;
        }
        $options[CURLOPT_URL] = $url;
        Yii::trace("Sending request to node: $method $url\n$requestBody", __METHOD__);
        if ($profile !== false) {
            Yii::beginProfile($profile, __METHOD__);
        }
        $curl = $this->getHandler();
        curl_setopt_array($curl, $options);
        if (curl_exec($curl) === false) {
            throw new HiArtException('Request failed: ' . curl_errno($curl) . ' - ' . curl_error($curl), [
                'requestUrl'      => $url,
                'requestBody'     => $requestBody,
                'responseBody'    => $this->decodeErrorBody($body),
                'requestMethod'   => $method,
                'responseHeaders' => $headers,
            ]);
        }

        $responseCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
        Yii::trace(curl_getinfo($curl));
        if ($profile !== false) {
            Yii::endProfile($profile, __METHOD__);
        }
        if ($responseCode >= 200 && $responseCode < 300) {
            if ($method === 'HEAD') {
                return true;
            } else {
                if (isset($headers['content-length']) && ($len = mb_strlen($body, '8bit')) < $headers['content-length']) {
                    throw new HiArtException("Incomplete data received: $len < {$headers['content-length']}", [
                        'requestMethod'   => $method,
                        'requestUrl'      => $url,
                        'requestBody'     => $requestBody,
                        'responseCode'    => $responseCode,
                        'responseHeaders' => $headers,
                        'responseBody'    => $this->decodeErrorBody($body),
                    ]);
                }
                if (isset($headers['content-type']) && !strncmp($headers['content-type'], 'application/json', 16)) {
                    return $raw ? $body : Json::decode($body);
                } else {
                    return $body;
                }
                throw new HiArtException('Unsupported data received from Hiresource: ' . $headers['content-type'], [

throw new \hiqdev\hiart\HiArtException('Unsupported data received from Hiresource: ' . $headers['content-type'], array('requestUrl' => $url, 'requestBody' => $requestBody, 'responseBody' => $this->decodeErrorBody($body), 'requestMethod' => $method, 'responseCode' => $responseCode, 'responseHeaders' => $headers)); does not seem to be reachable.

                    'requestUrl'      => $url,
                    'requestBody'     => $requestBody,
                    'responseBody'    => $this->decodeErrorBody($body),
                    'requestMethod'   => $method,
                    'responseCode'    => $responseCode,
                    'responseHeaders' => $headers,
                ]);
            }
        } elseif ($responseCode === 404) {
            return false;
        } else {
            throw new HiArtException("Request request failed with code $responseCode.", [
                'requestUrl'      => $url,
                'requestBody'     => $requestBody,
                'responseBody'    => $this->decodeErrorBody($body),
                'requestMethod'   => $method,
                'responseCode'    => $responseCode,
                'responseHeaders' => $headers,
            ]);
        }
    }

    /**
     * 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;
        }
    }

    /**
     * Callback to test if API response has error.
     */
    public $errorChecker;

    /**
     * Checks response with errorChecker callback and raises exception if error.
     * @param array  $response response data from API
     * @param string $url      request URL
     * @param array  $options  request data
     * @throws ErrorResponseException
     * @return array
     */
    protected function checkResponse($response, $url, $options)
    {
        $error = call_user_func($this->errorChecker, $response);
        if ($error) {
            throw new ErrorResponseException($error, [
                'requestUrl' => $url,
                'request'    => $options,
                'response'   => $response,
            ]);
        }

        return $response;
    }
}