vasildakov / shipping

src/Adapter/SpeedyAdapter.php

<?php

declare(strict_types=1);

namespace VasilDakov\Shipping\Adapter;

use Psr\Http\Client\ClientExceptionInterface;
use Selective\Transformer\ArrayTransformer;
use VasilDakov\Shipping\Model\Country;
use VasilDakov\Shipping\Request\GetCountriesRequest;
use VasilDakov\Speedy\Configuration;
use VasilDakov\Speedy\Service\Location\Country\FindCountryRequest;
use VasilDakov\Speedy\Service\Location\Office\FindOfficeRequest;
use VasilDakov\Speedy\Service\Location\Site\FindSiteRequest;
use VasilDakov\Speedy\Speedy;
use GuzzleHttp\Client;
use Laminas\Diactoros\RequestFactory;
use VasilDakov\Shipping\Response;
use VasilDakov\Shipping\Request;
use VasilDakov\Speedy\SpeedyInterface;

/**
 * SpeedyAdapter
 *
 * @author    Vasil Dakov <vasildakov@gmail.com>
 * @copyright 2009-2024 Neutrino.bg
 * @version   1.0
 */
final class SpeedyAdapter implements AdapterInterface
{
    private const NAME = 'Speedy';

    private ?SpeedyInterface $client;

    public function __construct(?SpeedyInterface $client = null)
    {
        if (null === $client) {
            $client = new Speedy(
                new Configuration(
                    username: $_ENV['SPEEDY_USERNAME'],
                    password: $_ENV['SPEEDY_PASSWORD'],
                    language: $_ENV['SPEEDY_LANGUAGE']
                ),
                new Client(),
                new RequestFactory()
            );
        }
        $this->client = $client;
    }

    /**
     * @return string
     */
    public function getName(): string
    {
        return self::NAME;
    }

    /**
     * @param GetCountriesRequest $request
     * @return Response\GetCountriesResponse
     * @throws ClientExceptionInterface
     */
    public function getCountries(Request\GetCountriesRequest $request): Response\GetCountriesResponse
    {
        $json = $this->client->findCountry(

The method findCountry() does not exist on null.

            new FindCountryRequest(name: 'Bulgaria')
        );
        $data = json_decode($json, true);

        $transformer = new ArrayTransformer();
        $transformer
            ->map('id', 'id')
            ->map('name', 'name')
            ->map('nameEn', 'nameEn')
            ->map('isoAlpha2', 'isoAlpha2')
            ->map('isoAlpha3', 'isoAlpha3')
        ;

        $result['countries'] = $transformer->toArray($data);

$result was never initialized. Although not strictly required by PHP, it is generally a good practice to add $result = array(); before regardless.

        $strategy = new \Laminas\Hydrator\Strategy\CollectionStrategy(
            new \Laminas\Hydrator\ObjectPropertyHydrator(),
            Country::class
        );
        $array = $strategy->hydrate($result['countries']);

        return new Response\GetCountriesResponse($array);
    }

    /**
     * @param Request\GetCitiesRequest $request
     * @return Response\GetCitiesResponse
     * @throws ClientExceptionInterface
     */
    public function getCities(Request\GetCitiesRequest $request): Response\GetCitiesResponse
    {
        $object = new FindSiteRequest(
            countryId: $request->countryId,

It seems like $request->countryId can also be of type null and string; however, parameter $countryId of VasilDakov\Speedy\Service\Location\Site\FindSiteRequest::__construct() does only seem to accept integer, maybe add an additional type check?

            name: $request->name
        );

        $json = $this->client->findSite($object);
        $data = $this->jsonDecode($json);

        $transformer = new ArrayTransformer();
        $transformer
            ->map('id', 'id')
            ->map('countryId', 'countryId')
            ->map('name', 'name')
            ->map('nameEn', 'nameEn')
            ->map('postCode', 'postCode')
        ;

        $result['cities'] = $transformer->toArrays($data['sites']);

$result was never initialized. Although not strictly required by PHP, it is generally a good practice to add $result = array(); before regardless.

        return new Response\GetCitiesResponse($result);
    }

    public function getOffices(Request\GetOfficesRequest $request): Response\GetOfficesResponse
    {
        $object = new FindOfficeRequest(
            siteId: $request->cityId

It seems like $request->cityId can also be of type null; however, parameter $siteId of VasilDakov\Speedy\Service\Location\Office\FindOfficeRequest::__construct() does only seem to accept integer, maybe add an additional type check?

        );

        $json = $this->client->findOffice($object);
        $data = $this->jsonDecode($json);

        $transformer = new ArrayTransformer();
        $transformer
            ->map('id', 'id')
            ->map('name', 'name')
            ->map('nameEn', 'nameEn')
        ;

        $result['offices'] = $transformer->toArrays($data['offices']);

$result was never initialized. Although not strictly required by PHP, it is generally a good practice to add $result = array(); before regardless.

        return new Response\GetOfficesResponse($result);
    }

    public function track(array $data)
    {
        // TODO: Implement track() method.
    }

    private function jsonDecode(string $json): array
    {
        return json_decode($json, true);
    }
}