SprykerEco\Zed\ArvatoRss\Business\Api\Adapter\ApiCall\AbstractCall

Complexity

Total Complexity

12

Size/Duplication

Total Lines	164
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	execute()	0	16	1
	executeCall()	0	1	?
	throwValidationException()	0	1	?
A	sendRequest()	0	12	1
A	createSoapClient()	0	12	1
A	validateResponse()	0	7	2
A	extractExceptionMessage()	0	10	3
A	retrieveOrderNumber()	0	8	2
A	getRequestOptions()	0	6	1

<?php

/**
 * MIT License
 * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
 */

namespace SprykerEco\Zed\ArvatoRss\Business\Api\Adapter\ApiCall;

use Generated\Shared\Transfer\ArvatoRssIdentificationRequestTransfer;
use SoapClient;
use SoapFault;
use Spryker\Shared\Config\Config;
use SprykerEco\Shared\ArvatoRss\ArvatoRssConstants;
use SprykerEco\Zed\ArvatoRss\Business\Api\Adapter\ApiCall\Logger\ApiCallLoggerInterface;
use SprykerEco\Zed\ArvatoRss\Business\Api\ArvatoRssRequestApiConfig;
use SprykerEco\Zed\ArvatoRss\Business\Api\Converter\RequestHeaderConverterInterface;

abstract class AbstractCall implements ApiCallInterface
{
    /**
     * @const string
     */
    const WSDL_PATH = __DIR__ . "/../../Etc/risk-solution-services.v2.1.wsdl";

    /**
     * @const string
     */
    const CALL_TYPE = 'UNKNOWN';

    /**
     * @var \SprykerEco\Zed\ArvatoRss\Business\Api\Converter\RequestHeaderConverterInterface
     */
    protected $requestHeaderConverter;

    /**
     * @var \SprykerEco\Zed\ArvatoRss\Business\Api\Adapter\ApiCall\Logger\ApiCallLoggerInterface
     */
    protected $apiCallLogger;

    /**
     * @param \SprykerEco\Zed\ArvatoRss\Business\Api\Converter\RequestHeaderConverterInterface $requestHeaderConverter
     * @param \SprykerEco\Zed\ArvatoRss\Business\Api\Adapter\ApiCall\Logger\ApiCallLoggerInterface $apiCallLogger
     */
    public function __construct(
        RequestHeaderConverterInterface $requestHeaderConverter,
        ApiCallLoggerInterface $apiCallLogger
    ) {
        $this->requestHeaderConverter = $requestHeaderConverter;
        $this->apiCallLogger = $apiCallLogger;
    }

    /**
     * @param \Generated\Shared\Transfer\ArvatoRssIdentificationRequestTransfer $identification
     * @param array $params
     *
     * @return \stdClass
     */
    public function execute(
        ArvatoRssIdentificationRequestTransfer $identification,
        array $params
    ) {
        $result = $this->sendRequest($identification, $params);

The expression $this->sendRequest($identification, $params); of type stdClass|SoapFault adds the type SoapFault to the return on line 73 which is incompatible with the return type declared by the interface SprykerEco\Zed\ArvatoRss\Business\Api\Adapter\ApiCall\ApiCallInterface::execute of type stdClass.

        $this->apiCallLogger->log(
            $this->retrieveOrderNumber($params),
            static::CALL_TYPE,
            $result->Decision->ResultCode,
            $params,
            $result

It seems like $result defined by $this->sendRequest($identification, $params) on line 63 can also be of type object<SoapFault>; however, SprykerEco\Zed\ArvatoRss\Business\Api\Adapter\ApiCall\Logger\ApiCallLoggerInterface::log() does only seem to accept object<stdClass>, maybe add an additional type check?

        );

        return $result;
    }

    /**
     * @param \SoapClient $soapClient
     * @param array $params
     *
     * @return \stdClass|\SoapFault
     */
    abstract protected function executeCall(SoapClient $soapClient, array $params);

    /**
     * @param string $message
     *
     * @throws \Exception
     *
     * @return void
     */
    abstract protected function throwValidationException($message);

    /**
     * @param \Generated\Shared\Transfer\ArvatoRssIdentificationRequestTransfer $identification
     * @param array $params
     *
     * @return \SoapFault|\stdClass
     */
    protected function sendRequest(
        ArvatoRssIdentificationRequestTransfer $identification,
        array $params
    ) {
        $soapClient = $this->createSoapClient(
            $identification
        );
        $result = $this->executeCall($soapClient, $params);
        $this->validateResponse($result);

        return $result;
    }

    /**
     * @param \Generated\Shared\Transfer\ArvatoRssIdentificationRequestTransfer $identification
     *
     * @return \SoapClient
     */
    protected function createSoapClient(ArvatoRssIdentificationRequestTransfer $identification)
    {
        $header = $this->requestHeaderConverter->convert($identification);
        $options = $this->getRequestOptions();
        $soapClient = new SoapClient(static::WSDL_PATH, $options);
        $soapClient->__setSoapHeaders($header);
        $soapClient->__setLocation(
            Config::get(ArvatoRssConstants::ARVATORSS_URL)
        );

        return $soapClient;
    }

    /**
     * @param \SoapFault|\stdClass $result
     *
     * @return void
     */
    protected function validateResponse($result)
    {
        if (is_soap_fault($result)) {
            $message = $this->extractExceptionMessage($result);

It seems like $result defined by parameter $result on line 135 can also be of type object<stdClass>; however, SprykerEco\Zed\ArvatoRss\Business\Api\Adapter\ApiCall\AbstractCall::extractExceptionMessage() does only seem to accept object<SoapFault>, maybe add an additional type check?

            $this->throwValidationException($message);
        }
    }

    /**
     * @param \SoapFault $result
     *
     * @return string
     */
    protected function extractExceptionMessage(SoapFault $result)
    {
        if (isset($result->detail) && !empty(array_keys(get_object_vars($result->detail))[0])) {
            $exceptionName = array_keys(get_object_vars($result->detail))[0];

The property detail does not seem to exist in SoapFault.

            $exceptionObj = $result->detail->{$exceptionName};
            return $exceptionObj->Description;
        }

        return $result->getMessage();
    }

    /**
     * @param array $params
     *
     * @return string
     */
    protected function retrieveOrderNumber(array $params)
    {
        return isset(
            $params[ArvatoRssRequestApiConfig::ARVATORSS_API_ORDER][ArvatoRssRequestApiConfig::ARVATORSS_API_ORDER_NUMBER]
        )?
            $params[ArvatoRssRequestApiConfig::ARVATORSS_API_ORDER][ArvatoRssRequestApiConfig::ARVATORSS_API_ORDER_NUMBER]:
            '';
    }

    /**
     * @return array
     */
    protected function getRequestOptions()
    {
        return [
            'exceptions' => false,
        ];
    }
}