Appwilio\RussianPostSDK\Tracking\SingleAccessClient

Complexity

Total Complexity

13

Size/Duplication

Total Lines	149
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	12
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getTrackingUrl()	0	3	1
A	getClient()	0	3	1
A	callSoapMethod()	0	15	3
A	assembleCashOnDeliveryRequestArguments()	0	8	1
A	assembleAuthorizationHeader()	0	6	1
A	assembleTrackingRequestArguments()	0	10	1
A	getTrackingEvents()	0	16	2
A	getCashOnDeliveryEvents()	0	15	2

<?php

/**
 * This file is part of RussianPost SDK package.
 *
 * © Appwilio (http://appwilio.com), greabock (https://github.com/greabock), JhaoDa (https://github.com/jhaoda)
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Appwilio\RussianPostSDK\Tracking;

use Psr\Log\NullLogger;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\LoggerAwareInterface;
use Appwilio\RussianPostSDK\Tracking\Single\TrackingEventsResponse;
use Appwilio\RussianPostSDK\Tracking\Single\CashOnDeliveryEventsRequest;
use Appwilio\RussianPostSDK\Tracking\Single\CashOnDeliveryEventsResponse;
use Appwilio\RussianPostSDK\Tracking\Exceptions\SingleAccessException;

class SingleAccessClient implements LoggerAwareInterface
{
    use LoggerAwareTrait;

    public const LANG_ENG = 'ENG';
    public const LANG_RUS = 'RUS';

    public const HISTORY_OPERATIONS    = 0;
    public const HISTORY_NOTIFICATIONS = 1;

    protected const LINK_URL = 'https://www.pochta.ru/tracking';
    protected const WSDL_URL = 'https://tracking.pochta.ru/tracking-web-static/rtm34_wsdl.xml';

    protected const XML_NS_DATA     = 'http://russianpost.org/operationhistory/data';
    protected const XML_NS_COD_DATA = 'http://www.russianpost.org/RTM/DataExchangeESPP/Data';

    /** @var \SoapClient */
    protected $client;

    /** @var string */
    private $login;

    /** @var string */
    private $password;

    private $options = [
        'soap_version' => SOAP_1_2,
        'trace'        => 1,
        'classmap'     => [
            'Rtm02Parameter'                   => Single\Parameter::class,

            'getOperationHistoryResponse'      => Single\TrackingEventsResponse::class,
            'OperationHistoryRecord'           => Single\TrackingEvent::class,
            'Address'                          => Single\TrackingEventAddress::class,
            'Country'                          => Single\TrackingEventCountry::class,
            'OperationHistoryData'             => Single\TrackingEventsWrapper::class,
            'OperationParameters'              => Single\TrackingEventOperationParameters::class,
            'UserParameters'                   => Single\TrackingEventUserParameters::class,
            'ItemParameters'                   => Single\TrackingEventItemParameters::class,
            'AddressParameters'                => Single\TrackingEventAddressParameters::class,
            'FinanceParameters'                => Single\TrackingEventFinanceParameters::class,

            'PostalOrderEvent'                 => Single\CashOnDeliveryEvent::class,
            'PostalOrderEventsForMailResponse' => Single\CashOnDeliveryEventsResponse::class,
            'PostalOrderEventsForMailInput'    => Single\CashOnDeliveryEventsRequest::class,
            // Mai – не опечатка
            'PostalOrderEventsForMaiOutput'    => Single\CashOnDeliveryEventsWrapper::class,
        ],
    ];

    public function __construct(string $login, string $password)
    {
        $this->login = $login;
        $this->password = $password;

        $this->logger = new NullLogger();
    }

    public function getTrackingUrl(string $number): string
    {
        return self::LINK_URL."#{$number}";
    }

    public function getTrackingEvents(
        string $track,
        string $language = self::LANG_RUS,
        int $type = self::HISTORY_OPERATIONS
    ): TrackingEventsResponse {
        /** @var TrackingEventsResponse $response */
        $response = $this->callSoapMethod(
            'getOperationHistory',
            $this->assembleTrackingRequestArguments($track, $language, $type)
        );

        if (\count($response->getEvents()) === 0) {
            throw SingleAccessException::becauseEmptyTrackingResponse($track);
        }

        return $response;
    }

    public function getCashOnDeliveryEvents(
        string $track,
        string $language = self::LANG_RUS
    ): CashOnDeliveryEventsResponse {
        /** @var CashOnDeliveryEventsResponse $response */
        $response = $this->callSoapMethod(
            'PostalOrderEventsForMail',
            $this->assembleCashOnDeliveryRequestArguments($track, $language)
        );

        if (\count($response->getEvents()) === 0) {
            throw SingleAccessException::becauseEmptyCODResponse($track);
        }

        return $response;
    }

    protected function getClient(): \SoapClient
    {
        return $this->client ?? ($this->client = new \SoapClient(self::WSDL_URL, $this->options));
    }

    private function callSoapMethod(string $method, \SoapVar $arguments)
    {
        try {
            return $this->getClient()->__soapCall($method, [$arguments]);
        } catch (\SoapFault $e) {
            if (\property_exists($e, 'detail')) {
                $detail = \get_object_vars($e->detail);

                throw new SingleAccessException(\key($detail).': '.\current($detail), $e->getCode(), $e);
            }

            throw new SingleAccessException($e->getMessage(), $e->getCode(), $e);
        } finally {
            $this->logger->info("pochta.ru Single Tracking request: {$this->getClient()->__getLastRequest()}");
            $this->logger->info("pochta.ru Single Tracking response: {$this->getClient()->__getLastResponse()}");
        }
    }

    private function assembleTrackingRequestArguments(string $track, string $language, int $type): \SoapVar
    {
        return new \SoapVar([
            new \SoapVar([
                new \SoapVar($track, \XSD_STRING, '', '', 'Barcode', self::XML_NS_DATA),
                new \SoapVar($type, \XSD_STRING, '', '', 'MessageType', self::XML_NS_DATA),
                new \SoapVar($language, \XSD_STRING, '', '', 'Language', self::XML_NS_DATA),
            ], \SOAP_ENC_OBJECT, '', '', 'OperationHistoryRequest', self::XML_NS_DATA),
            $this->assembleAuthorizationHeader(),
        ], \SOAP_ENC_OBJECT);
    }

    private function assembleCashOnDeliveryRequestArguments(string $code, string $language): \SoapVar
    {
        $input = new CashOnDeliveryEventsRequest($code, $language);

        return new \SoapVar([
            new \SoapVar($input, \SOAP_ENC_OBJECT, '', '', 'PostalOrderEventsForMailInput', self::XML_NS_COD_DATA),
            $this->assembleAuthorizationHeader(),
        ], \SOAP_ENC_OBJECT);
    }

    private function assembleAuthorizationHeader(): \SoapVar
    {
        return new \SoapVar([
            new \SoapVar($this->login, \XSD_STRING, '', '', 'login', self::XML_NS_DATA),
            new \SoapVar($this->password, \XSD_STRING, '', '', 'password', self::XML_NS_DATA),
        ], \SOAP_ENC_OBJECT, '', '', 'AuthorizationHeader', self::XML_NS_DATA);
    }
}