LauLamanApps / ecurring-api

src/Http/Adapter/Guzzle/Client.php

<?php

declare(strict_types=1);

namespace LauLamanApps\eCurring\Http\Adapter\Guzzle;

use GuzzleHttp\ClientInterface as GuzzleClientInterface;
use GuzzleHttp\Exception\RequestException;
use LauLamanApps\eCurring\Exception\eCurringException;
use LauLamanApps\eCurring\Http\Adapter\Guzzle\Exception\Handler;
use LauLamanApps\eCurring\Http\Adapter\Guzzle\Exception\NotFoundException;
use LauLamanApps\eCurring\Http\ClientInterface;
use LauLamanApps\eCurring\Http\Endpoint\Exception\EndpointCouldNotBeMappedException;
use LauLamanApps\eCurring\Http\Endpoint\MapperInterface;
use LauLamanApps\eCurring\Http\Exception\ApiCallException;
use LauLamanApps\eCurring\Resource\Curser\Pagination;
use Psr\Http\Message\ResponseInterface;

final class Client implements ClientInterface
{
    /**
     * @var GuzzleClientInterface
     */
    private $guzzleClient;

    /**
     * @var MapperInterface
     */
    private $endpointMapper;

    public function __construct(
        GuzzleClientInterface $guzzleClient,
        MapperInterface $urlMapper
    ) {
        $this->guzzleClient = $guzzleClient;
        $this->endpointMapper = $urlMapper;
    }

    /**
     * @throws EndpointCouldNotBeMappedException
     * @throws eCurringException
     * @throws NotFoundException
     */
    public function getEndpoint(string $endpoint, ?array $urlBits = [], ?Pagination $page = null): ResponseInterface
    {
        $options = $page ? ['query' => $page->getQueryOptions()] : [];

        return $this->get(
            $this->endpointMapper->map($endpoint, $urlBits),
            $options
        );
    }

    /**
     * @throws eCurringException
     * @throws NotFoundException
     * @return ResponseInterface
     */
    public function getUrl(string $url): ResponseInterface
    {
        return $this->get($url);
    }

    public function getJson(ResponseInterface $response): string
    {
        return (string) $response->getBody();
    }

    /**
     * @throws NotFoundException
     * @throws eCurringException
     */
    private function get(string $url, ?array $options = []): ResponseInterface
    {
        try {
            $response = $this->guzzleClient->get($url, $options);

            $this->wasSuccessfulRequest($response);

            return $response;
        } catch (RequestException $exception) {
            Handler::handleRequestException($exception);

In this branch, the function will implicitly return null which is incompatible with the type-hinted return Psr\Http\Message\ResponseInterface. Consider adding a return statement or allowing null as return value.

        }
    }

    /**
     * @throws eCurringException
     */
    public function postEndpoint(string $endpoint, array $data, array $urlBits = null): ResponseInterface
    {
        return $this->post(
            $this->endpointMapper->map($endpoint, $urlBits),

It seems like $urlBits can also be of type null; however, parameter $bits of LauLamanApps\eCurring\Http\Endpoint\MapperInterface::map() does only seem to accept array, maybe add an additional type check?

            ['json' => $data]
        );
    }

    /**
     * @throws ApiCallException
     * @throws eCurringException
     * @throws NotFoundException
     */
    private function post(string $url, ?array $options = []): ResponseInterface
    {
        try {
            $response = $this->guzzleClient->post($url, $options);
            $this->wasSuccessfulRequest($response);

            return $response;
        } catch (RequestException $exception) {
            Handler::handleRequestException($exception);

In this branch, the function will implicitly return null which is incompatible with the type-hinted return Psr\Http\Message\ResponseInterface. Consider adding a return statement or allowing null as return value.

        }
    }

    /**
     * @throws eCurringException
     */
    public function patchEndpoint(string $endpoint, array $data, array $urlBits = null): ResponseInterface
    {
        return $this->patch(
            $this->endpointMapper->map($endpoint, $urlBits),

It seems like $urlBits can also be of type null; however, parameter $bits of LauLamanApps\eCurring\Http\Endpoint\MapperInterface::map() does only seem to accept array, maybe add an additional type check?

            ['json' => $data]
        );
    }

    /**
     * @throws ApiCallException
     * @throws eCurringException
     * @throws NotFoundException
     */
    private function patch(string $url, ?array $options = []): ResponseInterface
    {
        try {
            $response = $this->guzzleClient->patch($url, $options);
            $this->wasSuccessfulRequest($response);

            return $response;
        } catch (RequestException $exception) {
            Handler::handleRequestException($exception);

In this branch, the function will implicitly return null which is incompatible with the type-hinted return Psr\Http\Message\ResponseInterface. Consider adding a return statement or allowing null as return value.

        }
    }

    /**
     * @throws eCurringException
     */
    public function deleteEndpoint(string $endpoint, array $data, array $urlBits = null): void
    {
        $this->delete(
            $this->endpointMapper->map($endpoint, $urlBits),

It seems like $urlBits can also be of type null; however, parameter $bits of LauLamanApps\eCurring\Http\Endpoint\MapperInterface::map() does only seem to accept array, maybe add an additional type check?

            ['json' => $data]
        );
    }

    /**
     * @throws ApiCallException
     * @throws eCurringException
     * @throws NotFoundException
     */
    private function delete(string $url, ?array $options = []): ResponseInterface
    {
        try {
            $response = $this->guzzleClient->delete($url, $options);
            $this->wasSuccessfulRequest($response);

            return $response;
        } catch (RequestException $exception) {
            Handler::handleRequestException($exception);

In this branch, the function will implicitly return null which is incompatible with the type-hinted return Psr\Http\Message\ResponseInterface. Consider adding a return statement or allowing null as return value.

        }
    }

    /**
     * @throws ApiCallException
     */
    private function wasSuccessfulRequest(ResponseInterface $response): void
    {
        switch ($response->getStatusCode()) {
            case 200:
                return;

                break;

break is not strictly necessary here and could be removed.

            case 201:
                return;

                break;
            default:
                throw new ApiCallException(
                    sprintf(
                        '%s %s: %s',
                        $response->getStatusCode(),
                        $response->getReasonPhrase(),
                        $response->getBody()->getContents()
                    )
                );
        }
    }
}