Quantum\Libraries\HttpClient\HttpClient

Complexity

Total Complexity

46

Size/Duplication

Total Lines	387
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	url()	0	5	1
A	getRequestHeaders()	0	9	2
A	startSingleRequest()	0	10	2
A	interceptCall()	0	14	6
A	createAsyncMultiRequest()	0	8	2
A	formatHeaders()	0	9	2
A	getResponseBody()	0	5	1
A	getResponseCookies()	0	11	2
A	ensureSingleRequest()	0	4	2
A	setData()	0	4	1
A	info()	0	5	2
A	createRequest()	0	5	2
A	isMultiRequest()	0	3	1
A	getErrors()	0	3	2
A	createMultiRequest()	0	9	2
A	getMethod()	0	3	1
A	getResponse()	0	3	2
A	getResponseHeaders()	0	11	2
A	handleResponse()	0	13	2
A	setMethod()	0	8	2
A	start()	0	13	3
A	getData()	0	3	1
A	__call()	0	15	3

<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <arman.ag@softberg.org>
 * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
 * @link http://quantum.softberg.org/
 * @since 3.0.0
 */

namespace Quantum\Libraries\HttpClient;

use Quantum\Libraries\HttpClient\Exceptions\HttpClientException;
use Quantum\App\Exceptions\BaseException;
use Curl\CaseInsensitiveArray;
use Curl\MultiCurl;
use ErrorException;
use Curl\Curl;

/**
 * HttpClient Class
 * @package Quantum\Libraries\HttpClient
 * @uses php-curl-class/php-curl-class
 * @method object addGet(string $url, array $data = [])
 * @method object addPost(string $url, string $data = '', bool $follow_303_with_post = false)
 * @method setHeader($key, $value)
 * @method setHeaders($headers)
 * @method setOpt($option, $value)
 */
class HttpClient
{
    /**
     * Available methods
     */
    public const METHODS = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'];

    /**
     * Response headers section
     */
    public const RESPONSE_HEADERS = 'headers';

    /**
     * Response cookies section
     */
    public const RESPONSE_COOKIES = 'cookies';

    /**
     * Response body section
     */
    public const RESPONSE_BODY = 'body';

    /**
     * @var MultiCurl|Curl
     */
    private $client = null;

    /**
     * @var string
     */
    private $method = 'GET';

    /**
     * @var mixed|null
     */
    private $data = null;

    /**
     * @var array
     */
    private array $requestHeaders = [];

    /**
     * @var array
     */
    private $response = [];

    /**
     * @var array
     */
    private $errors = [];

    /**
     * Creates request
     * @param string $url
     * @param Curl|null $client
     * @return HttpClient
     */
    public function createRequest(string $url, ?Curl $client = null): HttpClient
    {
        $this->client = $client ?: new Curl();
        $this->client->setUrl($url);
        return $this;
    }

    /**
     * Creates multi request
     * @param MultiCurl|null $client
     * @return HttpClient
     */
    public function createMultiRequest(?MultiCurl $client = null): HttpClient
    {
        $this->client = $client ?: new MultiCurl();

        $this->client->complete(function (Curl $instance) {
            $this->handleResponse($instance);
        });

        return $this;
    }

    /**
     * Creates async multi request
     * @param callable $success
     * @param callable $error
     * @param MultiCurl|null $client
     * @return HttpClient
     */
    public function createAsyncMultiRequest(callable $success, callable $error, ?MultiCurl $client = null): HttpClient
    {
        $this->client = $client ?: new MultiCurl();

        $this->client->success($success);
        $this->client->error($error);

        return $this;
    }

    /**
     * Sets http method
     * @param string $method
     * @return $this
     * @throws BaseException
     */
    public function setMethod(string $method): HttpClient
    {
        if (!in_array($method, self::METHODS)) {
            throw HttpClientException::requestMethodNotAvailable($method);
        }

        $this->method = $method;
        return $this;
    }

    /**
     * Gets the current http method
     * @return string
     */
    public function getMethod(): string
    {
        return $this->method;
    }

    /**
     * Sets data
     * @param mixed $data
     * @return HttpClient
     */
    public function setData($data): HttpClient
    {
        $this->data = $data;
        return $this;
    }

    /**
     * Gets the data
     * @return mixed|null
     */
    public function getData()
    {
        return $this->data;
    }

    /**
     * Checks if the request is multi cURL
     * @return bool
     */
    public function isMultiRequest(): bool
    {
        return $this->client instanceof MultiCurl;
    }

    /**
     * Starts the request
     * @throws ErrorException
     * @throws HttpClientException
     */
    public function start(): HttpClient
    {
        if (!$this->client) {
            throw HttpClientException::requestNotCreated();
        }

        if ($this->isMultiRequest()) {
            $this->client->start();
        } else {
            $this->startSingleRequest();
        }

        return $this;
    }

    /**
     * Gets single or all request headers
     * @param string|null $header
     * @return mixed|null
     * @throws BaseException
     */
    public function getRequestHeaders(?string $header = null)
    {
        $this->ensureSingleRequest();

        if ($header !== null) {
            return $this->requestHeaders[$header] ?? null;
        }

        return $this->requestHeaders;
    }

    /**
     * Gets the response headers
     * @param string|null $header
     * @return mixed|null
     * @throws BaseException
     */
    public function getResponseHeaders(?string $header = null)
    {
        $this->ensureSingleRequest();

        $responseHeaders = $this->getResponse()[self::RESPONSE_HEADERS];

        if ($header) {
            return $responseHeaders[$header] ?? null;
        }

        return $responseHeaders;
    }

    /**
     * Gets the response cookies
     * @param string|null $cookie
     * @return mixed|null
     * @throws BaseException
     */
    public function getResponseCookies(?string $cookie = null)
    {
        $this->ensureSingleRequest();

        $responseCookies = $this->getResponse()[self::RESPONSE_COOKIES];

        if ($cookie) {
            return $responseCookies[$cookie] ?? null;
        }

        return $responseCookies;
    }

    /**
     * Gets the response body
     * @return mixed|null
     * @throws BaseException
     */
    public function getResponseBody()
    {
        $this->ensureSingleRequest();

        return $this->response[$this->client->getId()][self::RESPONSE_BODY] ?? null;

The method getId() does not exist on Curl\MultiCurl.

    }

    /**
     * Gets the entire response
     * @return array
     */
    public function getResponse(): array
    {
        return $this->isMultiRequest() ? $this->response : ($this->response[$this->client->getId()] ?? []);
    }

    /**
     * Returns the errors
     * @return array
     */
    public function getErrors(): array
    {
        return $this->isMultiRequest() ? $this->errors : ($this->errors[$this->client->getId()] ?? []);
    }

    /**
     * Gets the curl info
     * @param int|null $option
     * @return mixed
     * @throws BaseException
     */
    public function info(?int $option = null)
    {
        $this->ensureSingleRequest();

        return $option ? $this->client->getInfo($option) : $this->client->getInfo();

The method getInfo() does not exist on Curl\MultiCurl.

    }

    /**
     * Gets the current url being executed
     * @return string|null
     * @throws BaseException
     */
    public function url(): ?string
    {
        $this->ensureSingleRequest();

        return $this->client->getUrl();

The method getUrl() does not exist on Curl\MultiCurl.

    }

    /**
     * @param string $method
     * @param array $arguments
     * @return $this
     * @throws BaseException
     * @throws HttpClientException
     */
    public function __call(string $method, array $arguments): HttpClient
    {
        if (is_null($this->client)) {
            throw HttpClientException::requestNotCreated();
        }

        if (!method_exists($this->client, $method)) {
            throw HttpClientException::methodNotSupported($method, get_class($this->client));
        }

        $this->interceptCall($method, $arguments);

        $this->client->$method(...$arguments);

        return $this;
    }

    /**
     * @return void
     * @throws ErrorException
     */
    private function startSingleRequest(): void
    {
        $this->client->setOpt(CURLOPT_CUSTOMREQUEST, $this->method);

        if ($this->data) {
            $this->client->setOpt(CURLOPT_POSTFIELDS, $this->client->buildPostData($this->data));

The method buildPostData() does not exist on Curl\MultiCurl.

        }

        $this->client->exec();

The method exec() does not exist on Curl\MultiCurl.

        $this->handleResponse($this->client);

It seems like $this->client can also be of type Curl\MultiCurl; however, parameter $instance of Quantum\Libraries\HttpClient\HttpClient::handleResponse() does only seem to accept Curl\Curl, maybe add an additional type check?

    }

    /**
     * Handles the response
     * @param Curl $instance
     */
    private function handleResponse(Curl $instance)
    {
        if ($instance->isError()) {
            $this->errors[$instance->getId()] = [
                'code' => $instance->getErrorCode(),
                'message' => $instance->getErrorMessage(),
            ];
        }

        $this->response[$instance->getId()] = [
            self::RESPONSE_HEADERS => $this->formatHeaders($instance->getResponseHeaders()),
            self::RESPONSE_COOKIES => $instance->getResponseCookies(),
            self::RESPONSE_BODY => $instance->getResponse(),
        ];
    }

    /**
     * @param CaseInsensitiveArray $headers
     * @return array
     */
    private function formatHeaders(CaseInsensitiveArray $headers): array
    {
        $formatted = [];

        foreach ($headers as $key => $value) {
            $formatted[strtolower($key)] = $value;

It seems like $key can also be of type null; however, parameter $string of strtolower() does only seem to accept string, maybe add an additional type check?

        }

        return $formatted;
    }

    /**
     * @return void
     * @throws BaseException
     */
    private function ensureSingleRequest(): void
    {
        if ($this->isMultiRequest()) {
            throw HttpClientException::methodNotSupported(__METHOD__, MultiCurl::class);
        }
    }

    /**
     * @param string $method
     * @param array $arguments
     * @return void
     */
    private function interceptCall(string $method, array $arguments): void
    {
        switch ($method) {
            case 'setHeaders':
                if (isset($arguments[0]) && is_array($arguments[0])) {
                    $this->requestHeaders = array_change_key_case($arguments[0], CASE_LOWER);
                }
                break;

            case 'setHeader':
                if (isset($arguments[0], $arguments[1])) {
                    $this->requestHeaders[strtolower($arguments[0])] = $arguments[1];
                }
                break;
        }
    }
}