Gemz\HttpClient\Response

Complexity

Total Complexity

32

Size/Duplication

Total Lines	281
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

25 Methods

Rating	Name	Duplication	Size	Complexity
A	createFromResponse()	0	4	1
A	__construct()	0	5	1
A	status()	0	4	1
A	isSuccess()	0	4	2
A	isOk()	0	4	1
A	isRedirect()	0	4	2
A	isClientError()	0	4	2
A	isServerError()	0	4	1
A	response()	0	4	1
A	body()	0	4	1
A	asString()	0	4	1
A	asObject()	0	4	1
A	asCollection()	0	4	1
A	asArray()	0	4	1
A	toStream()	0	8	2
A	isJson()	0	4	1
A	header()	0	10	2
A	normalizeHeaders()	0	6	1
A	headers()	0	4	1
A	requestUrl()	0	4	2
A	executionTime()	0	4	2
A	customData()	0	4	1
A	info()	0	4	1
A	contentType()	0	4	1
A	userAgent()	0	4	1

<?php

namespace Gemz\HttpClient;

use Illuminate\Support\Collection;
use Illuminate\Support\Str;
use Symfony\Contracts\HttpClient\ResponseInterface;

class Response
{
    /** @var ResponseInterface */
    protected $response;

    /** @var bool */
    protected $throwErrors;

    /**
     * @param ResponseInterface $response
     * @param bool $throwErrors
     *
     * @return Response
     */
    public static function createFromResponse(ResponseInterface $response, $throwErrors = false)
    {
        return new self($response, $throwErrors);
    }

    /**
     * @param ResponseInterface $response
     * @param bool $throwErrors
     */
    public function __construct(ResponseInterface $response, $throwErrors = false)
    {
        $this->response = $response;
        $this->throwErrors = $throwErrors;
    }

    /**
     * @return int
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function status(): int
    {
        return $this->response->getStatusCode();
    }

    /**
     * @return bool
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function isSuccess(): bool
    {
        return $this->status() >= 200 && $this->status() < 300;
    }

    /**
     * @return bool
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function isOk(): bool
    {
        return $this->isSuccess();
    }

    /**
     * @return bool
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function isRedirect(): bool
    {
        return $this->status() >= 300 && $this->status() < 400;
    }

    /**
     * @return bool
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function isClientError(): bool
    {
        return $this->status() >= 400 && $this->status() < 500;
    }

    /**
     * @return bool
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function isServerError(): bool
    {
        return $this->status() >= 500;
    }

    /**
     * @return ResponseInterface
     */
    public function response()
    {
        return $this->response;
    }

    /**
     * @return string
     * @throws \Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function body(): string
    {
        return $this->response->getContent($this->throwErrors);
    }

    /**
     * @return string
     * @throws \Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function asString(): string
    {
        return $this->body();
    }

    /**
     * @return mixed
     * @throws \Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function asObject()
    {
        return json_decode($this->body());
    }

    /**
     * @return \Illuminate\Support\Collection<mixed>

The doc-type \Illuminate\Support\Collection<mixed> could not be parsed: Expected "|" or "end of type", but got "<" at position 30. (view supported doc-types)

     *
     * @throws \Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function asCollection(): Collection
    {
        return collect($this->asArray());
    }

    /**
     * @return mixed
     *
     * @throws \Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function asArray()
    {
        return json_decode($this->body(), true);
    }

    /**
     * @return resource
     */
    public function toStream()
    {
        if (method_exists($this->response, 'toStream')) {
            return $this->response->toStream($this->throwErrors);
        }

        throw new \BadMethodCallException('method toStream does not exists');
    }

    /**
     * @return bool
     *
     * @throws \Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function isJson(): bool
    {
        return $this->contentType() == 'application/json';
    }

    /**
     * @param string $header
     *
     * @return mixed|string
     * @throws \Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function header(string $header)
    {
        $header = Str::lower($header);

        if (array_key_exists($header, $this->headers())) {
            return $this->headers()[$header];
        }

        return '';
    }

    /**
     * @param array<mixed> $headers
     *
     * @return array<String>
     */
    protected function normalizeHeaders(array $headers)
    {
        return collect($headers)->transform(function ($item, $key) {

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

            return $item[0];
        })->all();
    }

    /**
     * @return array<String>
     *
     * @throws \Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function headers(): array
    {
        return $this->normalizeHeaders($this->response->getHeaders());
    }

    /**
     * @return string
     */
    public function requestUrl(): string
    {
        return $this->info()['url'] ?: '';
    }

    /**
     * @return float
     */
    public function executionTime(): float
    {
        return $this->info()['total_time'] ?: 0.0;
    }

    /**
     * @return array|mixed|null
     */
    public function customData()
    {
        return $this->info()['user_data'];
    }

    /**
     * @return array|mixed|null
     */
    public function info()
    {
        return $this->response->getInfo();
    }

    /**
     * @return mixed|string
     *
     * @throws \Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function contentType()
    {
        return $this->header('content-type');
    }

    /**
     * @return mixed|string
     *
     * @throws \Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public function userAgent()
    {
        return $this->header('user-agent');
    }
}