Speedy::createRequest() - Code Metrics - Inspection of "updated cancel shipment request" - vasildakov/speedy - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — main ( 2611c0...fe37b5 )

by Vasil
created 2023-07-05 11:15 UTC
Speedy::createRequest() A

↳ Parent: Speedy
Complexity

Conditions	1
Paths	1
Size

Total Lines	9
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	5
CRAP Score	1
Importance

Changes
Metric	Value
cc	1
eloc	4
c	0
b	0
f	0
nc	1
nop	3
dl	0
loc	9
ccs	5
cts	5
cp	1
crap	1
rs	10
<?php

declare(strict_types=1);

namespace VasilDakov\Speedy;

use Fig\Http\Message\RequestMethodInterface;
use Psr\Http\Client\ClientExceptionInterface;
use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestFactoryInterface;
use Psr\Http\Message\RequestInterface;
use Throwable;
use VasilDakov\Speedy\Service\Calculation\CalculationRequest;
use VasilDakov\Speedy\Service\Calculation\CalculationResponse;
use VasilDakov\Speedy\Service\Calculation\CalculationResponseFactory;
use VasilDakov\Speedy\Service\Client\GetContractClientsRequest;
use VasilDakov\Speedy\Service\Client\GetContractClientsResponse;
use VasilDakov\Speedy\Service\Client\GetContractClientsResponseFactory;
use VasilDakov\Speedy\Service\Location;
use VasilDakov\Speedy\Service\Location\Complex\FindComplexRequest;
use VasilDakov\Speedy\Service\Location\Complex\FindComplexResponse;
use VasilDakov\Speedy\Service\Location\Office\FindOfficeRequest;
use VasilDakov\Speedy\Service\Location\Office\FindOfficeResponse;
use VasilDakov\Speedy\Service\Location\Site\FindSiteResponse;
use VasilDakov\Speedy\Service\Printing\PrintRequest;
use VasilDakov\Speedy\Service\Printing\PrintResponse;
use VasilDakov\Speedy\Service\Service\DestinationServicesRequest;
use VasilDakov\Speedy\Service\Service\DestinationServicesResponse;
use VasilDakov\Speedy\Service\Service\DestinationServicesResponseFactory;
use VasilDakov\Speedy\Service\Shipment\CancelShipmentRequest;
use VasilDakov\Speedy\Service\Shipment\CancelShipmentResponse;
use VasilDakov\Speedy\Service\Shipment\CancelShipmentResponseFactory;
use VasilDakov\Speedy\Service\Shipment\CreateShipmentRequest;
use VasilDakov\Speedy\Service\Shipment\CreateShipmentResponse;
use VasilDakov\Speedy\Service\Shipment\CreateShipmentResponseFactory;
use VasilDakov\Speedy\Service\Track\TrackRequest;
use VasilDakov\Speedy\Service\Track\TrackResponse;
use VasilDakov\Speedy\Service\Track\TrackResponseFactory;

use function array_merge;
use function json_encode;

/**
 * Class Speedy
 *
 * @author    Vasil Dakov <[email protected]>
 * @copyright 2009-2022 Neutrino.bg
 * @version   1.0
 */
final class Speedy
{
    public const API_URL = 'https://api.speedy.bg/v1';
    public const USER_NAME = 'userName';
    public const PASSWORD  = 'password';
    public const LANGUAGE  = 'language';
    public const CLIENT_SYSTEM_ID = 'clientSystemId';
    public const SENDER = 'sender';
    public const CLIENT_ID = 'clientId';
    public const PRIVATE_PERSON = 'privatePerson';
    public const DROP_OFF_OFFICE_ID = 'dropoffOfficeId';
    public const PICKUP_OFFICE_ID = 'pickupOfficeId';
    public const ADDRESS_LOCATION = 'addressLocation';
    public const COUNTRY_ID = 'countryId';
    public const STATE_ID = 'stateId';
    public const SITE_ID = 'siteId';
    public const SITE_TYPE = 'siteType';
    public const SITE_NAME = 'siteName';
    public const POST_CODE = 'postCode';
    public const RECIPIENT = 'recipient';
    public const SERVICE = 'service';
    public const PICKUP_DATE = 'pickupDate';
    public const AUTO_ADJUST_PICKUP_DATE = 'autoAdjustPickupDate';
    public const SERVICE_IDS = 'serviceIds';
    public const DEFERRED_DAYS = 'deferredDays';
    public const SATURDAY_DELIVERY = 'saturdayDelivery';
    public const ADDITIONAL_SERVICES = 'additionalServices';
    public const FIXED_TIME_DELIVERY = 'fixedTimeDelivery';
    public const SPECIAL_DELIVERY_ID = 'specialDeliveryId';
    public const DELIVERY_TO_FLOOR = 'deliveryToFloor';
    public const COD = 'cod';
    public const AMOUNT = 'amount';
    public const CURRENCY_CODE = 'currencyCode';
    public const PROCESSING_TYPE = 'processingType';
    public const PAYOUT_TO_THIRD_PARTY = 'payoutToThirdParty';
    public const INCLUDE_SHIPPING_PRICE = 'includeShippingPrice';
    public const OBP_DETAILS = 'obpDetails';
    public const OPTION = 'option';
    public const RETURN_SHIPMENT_SERVICE_ID = 'returnShipmentServiceId';
    public const RETURN_SHIPMENT_PAYER = 'returnShipmentPayer';
    public const DECLARED_VALUE = 'declaredValue';
    public const FRAGILE = 'fragile';
    public const IGNORE_IF_NOT_APPLICABLE = 'ignoreIfNotApplicable';
    public const RETURNS = 'returns';
    public const ROD = 'rod';
    public const ENABLED = 'enabled';
    public const COMMENT = 'comment';
    public const RETURN_TO_CLIENT_ID = 'returnToClientId';
    public const RETURN_TO_OFFICE_ID = 'returnToOfficeId';
    public const THIRD_PARTY_PAYER = 'thirdPartyPayer';
    public const RETURN_RECEIPT = 'returnReceipt';
    public const SWAP = 'swap';
    public const SERVICE_ID = 'serviceId';
    public const PARCELS_COUNT = 'parcelsCount';
    public const ROP = 'rop';
    public const PALLETS = 'pallets';
    public const RETURN_VOUCHER = 'returnVoucher';
    public const PAYER = 'payer';
    public const CONTENT = 'content';
    public const TOTAL_WEIGHT = 'totalWeight';
    public const DOCUMENTS = 'documents';
    public const PALLETIZED = 'palletized';
    public const PARCELS = 'parcels';
    public const ID = 'id';
    public const SEQ_NO = 'seqNo';
    public const PACKAGE_UNIQUE_NUMBER = 'packageUniqueNumber';
    public const WEIGHT = 'weight';
    public const EXTERNAL_CARRIER_PARCEL_NUMBER = 'externalCarrierParcelNumber';
    public const SIZE = 'size';
    public const WIDTH = 'width';
    public const DEPTH = 'depth';
    public const HEIGHT = 'height';
    public const PAYMENT = 'payment';
    public const COURIER_SERVICE_PAYER = 'courierServicePayer';
    public const DECLARED_VALUE_PAYER = 'declaredValuePayer';
    public const PACKAGE_PAYER = 'packagePayer';
    public const THIRD_PARTY_CLIENT_ID = 'thirdPartyClientId';
    public const DISCOUNT_CARD_ID = 'discountCardId';
    public const CONTRACT_ID = 'contractId';
    public const CARD_ID = 'cardId';
    public const NAME = 'name';
    public const TYPE = 'type';
    public const MUNICIPALITY = 'municipality';
    public const REGION = 'region';
    public const LIMIT = 'limit';
    public const ISO_ALPHA_3 = 'isoAlpha3';
    public const ISO_ALPHA_2 = 'isoAlpha2';
    public const ADDRESS = 'address';
    public const STREET_ID = 'streetId';
    public const STREET_TYPE = 'streetType';
    public const STREET_NAME = 'streetName';
    public const STREET_NO = 'streetNo';
    public const COMPLEX_ID = 'complexId';
    public const COMPLEX_TYPE = 'complexType';
    public const COMPLEX_NAME = 'complexName';
    public const BLOCK_NO = 'blockNo';
    public const ENTRANCE_NO = 'entranceNo';
    public const FLOOR_NO = 'floorNo';
    public const APARTMENT_NO = 'apartmentNo';
    public const POI_ID = 'poiId';
    public const ADDRESS_NOTE = 'addressNote';
    public const ADDRESS_LINE_1 = 'addressLine1';
    public const ADDRESS_LINE_2 = 'addressLine2';
    public const X = 'x';
    public const Y = 'y';
    public const SHIPMENT_NOTE = 'shipmentNote';
    public const REF_1 = 'ref1';
    public const REF_2 = 'ref2';
    public const PHONE_1 = 'phone1';
    public const PHONE_2 = 'phone2';
    public const PHONE_3 = 'phone3';
    public const NUMBER = 'number';
    public const EXTENSION = 'extension';
    public const CLIENT_NAME = 'clientName';
    public const CONTACT_NAME = 'contactName';
    public const EMAIL = 'email';
    public const OBJECT_NAME = 'objectName';
    public const CONTENTS = 'contents';
    public const PACKAGE = 'package';
    public const PENDING_PARCELS = 'pendingParcels';
    public const STARTING_DATE = 'startingDate';
    public const SENDER_HAS_PAYMENT = 'senderHasPayment';
    public const SHIPMENT_ID = 'shipmentId';
    public const FORMAT = 'format';
    public const PAPER_SIZE = 'paperSize';
    public const PRINTER_NAME = 'printerName';
    public const DPI = 'dpi';
    public const PARCEL = 'parcel';
    public const ADDITIONAL_BARCODE = 'additionalBarcode';
    public const VALUE = 'value';
    public const LABEL = 'label';
    public const SHIPMENT_IDS = 'shipmentIds';
    public const LAST_OPERATION_ONLY = 'lastOperationOnly';
    public const CONSOLIDATION_REF = 'consolidationRef';
    public const REQUIRE_UNSUCCESSFUL_DELIVERY_STICKER_IMAGE = 'requireUnsuccessfulDeliveryStickerImage';
    public const EXCISE_GOODS = 'exciseGoods';
    public const SENDER_BANK_ACCOUNT = 'senderBankAccount';
    public const IBAN = 'iban';
    public const ACCOUNT_HOLDER = 'accountHolder';

    /**
     * @var Configuration
     */
    private Configuration $configuration;

    /**
     * PSR-18: HTTP Client
     * @var ClientInterface
     */
    private ClientInterface $client;

    /**
     * PSR-17: HTTP Factories
     * @var RequestFactoryInterface
     */
    private RequestFactoryInterface $factory;

    /**
     * @param Configuration $configuration
     * @param ClientInterface $client
     * @param RequestFactoryInterface $factory
     */
    public function __construct(
        Configuration $configuration,
        ClientInterface $client,
        RequestFactoryInterface $factory
    ) {
        $this->configuration = $configuration;
        $this->client  = $client;
        $this->factory = $factory;
    }

    /**
     * @param string $method
     * @param string $uri
     * @param array $data
     * @return RequestInterface
     */
    private function createRequest(string $method, string $uri, array $data): RequestInterface
    {
        $request = $this->factory->createRequest($method, $uri);

        $request = $request->withAddedHeader('Content-Type', 'application/json');

        $request->getBody()->write(json_encode($data));

        return $request;

    }

    /**
     * @param array $data
     * @return array
     */
    private function createPayload(array $data): array
    {
        $config = $this->configuration->toArray();

        return array_merge($config, $data);
    }

    /**
     * @param RequestInterface $request
     * @return string
     * @throws ClientExceptionInterface
     */
    private function getContents(RequestInterface $request): string
    {
        $response = $this->client->sendRequest($request);

        return $response->getBody()->getContents();
    }


    /**
     * @param GetContractClientsRequest $object
     * @return GetContractClientsResponse
     * @throws ClientExceptionInterface
     * @throws Throwable
     */
    public function getContractClient(
        GetContractClientsRequest $object
    ): GetContractClientsResponse {
        $payload = $this->createPayload($object->toArray());

        $request = $this->createRequest(
            RequestMethodInterface::METHOD_POST,
            self::API_URL . '/client/contract',
            $payload
        );

        $json = $this->getContents($request);

        return (new GetContractClientsResponseFactory())($json);
    }

    /**
     * @param Location\Country\FindCountryRequest $object
     * @return Location\Country\FindCountryResponse
     * @throws ClientExceptionInterface
     */
    public function findCountry(
        Location\Country\FindCountryRequest $object
    ): Location\Country\FindCountryResponse {
        $payload = $this->createPayload($object->toArray());

        $request = $this->createRequest(
            RequestMethodInterface::METHOD_POST,
            self::API_URL . '/location/country',
            $payload
        );

        $json = $this->getContents($request);

        return (new Location\Country\FindCountryResponseFactory())($json);
    }

    /**
     * @param Location\State\FindStateRequest $request
     * @return Location\State\FindStateResponse
     * @throws ClientExceptionInterface
     */
    public function findState(
        Location\State\FindStateRequest $request
    ): Location\State\FindStateResponse {
        $payload = $this->createPayload($request->toArray());

        $request = $this->createRequest(
            RequestMethodInterface::METHOD_POST,
            self::API_URL . '/location/state',
            $payload
        );

        $json = $this->getContents($request);

        return (new Location\State\FindStateResponseFactory())($json);
    }


    /**
     * @param Location\Site\FindSiteRequest $object
     * @return FindSiteResponse
     * @throws ClientExceptionInterface
     */
    public function findSite(Location\Site\FindSiteRequest $object): Location\Site\FindSiteResponse
    {
        $payload = $this->createPayload($object->toArray());

        $request = $this->createRequest(
            RequestMethodInterface::METHOD_POST,
            self::API_URL . '/location/site',
            $payload
        );

        $json = $this->getContents($request);

        return (new Location\Site\FindSiteResponseFactory())($json);
    }


    /**
     * @param FindOfficeRequest $object
     * @return FindOfficeResponse
     * @throws ClientExceptionInterface
     */
    public function findOffice(Location\Office\FindOfficeRequest $object): FindOfficeResponse
    {
        $payload = $this->createPayload($object->toArray());

        $request = $this->createRequest(
            RequestMethodInterface::METHOD_POST,
            self::API_URL . '/location/office',
            $payload
        );

        $json = $this->getContents($request);

        return (new Location\Office\FindOfficeResponseFactory())($json);
    }


    /**
     * @param FindComplexRequest $object
     * @return FindComplexResponse
     * @throws ClientExceptionInterface
     */
    public function findComplex(Location\Complex\FindComplexRequest $object): Location\Complex\FindComplexResponse
    {
        $payload = $this->createPayload($object->toArray());

        $request = $this->createRequest(
            RequestMethodInterface::METHOD_POST,
            self::API_URL . '/location/complex',
            $payload
        );

        $json = $this->getContents($request);

        return (new Location\Complex\FindComplexResponseFactory())($json);
    }

    /**
     * @param Location\Street\FindStreetRequest $object
     * @return Location\Street\FindStreetResponse
     * @throws ClientExceptionInterface
     */
    public function findStreet(Location\Street\FindStreetRequest $object): Location\Street\FindStreetResponse
    {
        $payload = $this->createPayload($object->toArray());

        $request = $this->createRequest(
            RequestMethodInterface::METHOD_POST,
            self::API_URL . '/location/street',
            $payload
        );

        $json = $this->getContents($request);

        return (new Location\Street\FindStreetResponseFactory())($json);
    }

    /**
     * @param CalculationRequest $object
     * @return CalculationResponse
     * @throws ClientExceptionInterface
     */
    public function calculation(CalculationRequest $object): CalculationResponse
    {
        $payload = $this->createPayload($object->toArray());

        $request = $this->createRequest(
            RequestMethodInterface::METHOD_POST,
            self::API_URL . '/calculate',
            $payload
        );

        $json = $this->getContents($request);

        return (new CalculationResponseFactory())($json);
    }

    /**
     * @param TrackRequest $request
     * @return TrackResponse
     */
    public function track(TrackRequest $object): TrackResponse
    {
        $payload = $this->createPayload($object->toArray());

        $request = $this->createRequest(
            RequestMethodInterface::METHOD_POST,
            self::API_URL . '/track',
            $payload
        );

        $json = $this->getContents($request);

        return (new TrackResponseFactory())($json);
    }

    /**
     * @param PrintRequest $request
     * @return PrintResponse
     */
    public function print(PrintRequest $request): PrintResponse
    public function print(/** @scrutinizer ignore-unused */ PrintRequest $request): PrintResponse
    {
        return new PrintResponse();
    }

    /**
     * @param CreateShipmentRequest $object
     * @return CreateShipmentResponse
     * @throws ClientExceptionInterface
     */
    public function createShipment(CreateShipmentRequest $object): CreateShipmentResponse
    {
        $payload = $this->createPayload($object->toArray());


        $request = $this->createRequest(
            RequestMethodInterface::METHOD_POST,
            self::API_URL . '/shipment',
            $payload
        );

        $json = $this->getContents($request);

        return (new CreateShipmentResponseFactory())($json);
    }

    /**
     * @param CancelShipmentRequest $object
     * @return CancelShipmentResponse
     * @throws ClientExceptionInterface
     */
    public function cancelShipment(CancelShipmentRequest $object): CancelShipmentResponse
    {
        $payload = $this->createPayload($object->toArray());

        $request = $this->createRequest(
            RequestMethodInterface::METHOD_POST,
            self::API_URL . '/shipment/cancel',
            $payload
        );

        $json = $this->getContents($request);

        /** @var CancelShipmentResponse */
        return (new CancelShipmentResponseFactory())($json);
    }

    /**
     * @throws ClientExceptionInterface
     */
    public function destination(DestinationServicesRequest $object): DestinationServicesResponse
    {
        $payload = $this->createPayload($object->toArray());

        $request = $this->createRequest(
            RequestMethodInterface::METHOD_POST,
            self::API_URL . '/services/destination',
            $payload
        );

        $json = $this->getContents($request);

        return (new DestinationServicesResponseFactory())($json);
    }
}

vasildakov / speedy

Push — main ( 2611c0...fe37b5 )

Speedy::createRequest() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
