eBayEnterprise\RetailOrderManagement\Payload\Payment\CreditCardAuthReply

Complexity

Total Complexity

36

Size/Duplication

Total Lines	257
Duplicated Lines	12.84 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	21
Bugs	1	Features	1

26 Methods

Rating	Name	Duplication	Size	Complexity
A	getIsAVSCorrectionRequired()	0	4	2
A	getIsAuthApproved()	0	4	1
A	getAuthorizationResponseCode()	0	4	1
A	getIsAVSSuccessful()	0	4	1
A	getAVSResponseCode()	0	4	1
A	getIsCVV2CorrectionRequired()	0	4	2
A	getIsCVV2Successful()	0	4	1
A	getCVV2ResponseCode()	0	4	1
A	getIsAuthSuccessful()	0	5	4
A	getBankAuthorizationCode()	0	4	1
A	serializeAdditionalResponseCodes()	0	9	4
A	getPhoneResponseCode()	0	4	1
A	getNameResponseCode()	0	4	1
A	getEmailResponseCode()	0	4	1
A	getCurrencyCode()	0	4	1
A	getAmountAuthorized()	0	4	1
A	getSchemaFile()	0	4	1
A	getRootNodeName()	0	4	1
A	getXmlNamespace()	0	4	1
B	__construct()	33	33	1
A	getIsAuthTimeout()	0	6	2
A	getIsAuthAcceptable()	0	6	1
A	getResponseCode()	0	5	2
A	serializeContents()	0	7	1
A	serializeResponseCodes()	0	14	1
A	serializeAmount()	0	8	1

<?php
/**
 * Copyright (c) 2013-2014 eBay Enterprise, Inc.
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * @copyright   Copyright (c) 2013-2014 eBay Enterprise, Inc. (http://www.ebayenterprise.com/)
 * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 */

namespace eBayEnterprise\RetailOrderManagement\Payload\Payment;

use eBayEnterprise\RetailOrderManagement\Payload\IPayload;
use eBayEnterprise\RetailOrderManagement\Payload\IPayloadMap;
use eBayEnterprise\RetailOrderManagement\Payload\ISchemaValidator;
use eBayEnterprise\RetailOrderManagement\Payload\IValidatorIterator;
use eBayEnterprise\RetailOrderManagement\Payload\TTopLevelPayload;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

/**
 * Class CreditCardAuthReply
 * @package eBayEnterprise\RetailOrderManagement\Payload\Payment
 */
class CreditCardAuthReply implements ICreditCardAuthReply
{
    use TTopLevelPayload, TPaymentContext;

    /** @var string */
    protected $authorizationResponseCode;
    /** @var string */
    protected $bankAuthorizationCode;
    /** @var string */
    protected $cvv2ResponseCode;
    /** @var string */
    protected $avsResponseCode;
    /** @var string */
    protected $phoneResponseCode;
    /** @var string */
    protected $nameResponseCode;
    /** @var string */
    protected $emailResponseCode;
    /** @var float */
    protected $amountAuthorized;
    /** @var string */
    protected $currencyCode;
    /** @var array Mapping of reply authorization response code to OMS response code */
    protected $responseCodeMap = [
        self::AUTHORIZATION_APPROVED => self::APPROVED_RESPONSE_CODE,
        self::AUTHORIZATION_TIMEOUT_PAYMENT_PROVIDER => self::TIMEOUT_RESPONSE_CODE,
        self::AUTHORIZATION_TIMEOUT_CARD_PROCESSOR => self::TIMEOUT_RESPONSE_CODE,
    ];
    /** @var string[] AVS response codes that should be rejected */
    protected $invalidAvsCodes = ['N', 'AW'];
    /** @var string[] CVV response codes that should be rejected */
    protected $invalidCvvCodes = ['N'];

    /**
     * @param IValidatorIterator
     * @param ISchemaValidator
     * @param IPayloadMap
     * @param LoggerInterface
     * @param IPayload
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function __construct(

This method seems to be duplicated in your project.

        IValidatorIterator $validators,
        ISchemaValidator $schemaValidator,
        IPayloadMap $payloadMap,

The parameter $payloadMap is not used and could be removed.

        LoggerInterface $logger,
        IPayload $parentPayload = null
    ) {
        $this->logger = $logger;

It seems like $logger of type object<Psr\Log\LoggerInterface> is incompatible with the declared type object<eBayEnterprise\RetailOrderManagement\Payload\LoggerInterface> of property $logger.

        $this->validators = $validators;
        $this->schemaValidator = $schemaValidator;
        $this->parentPayload = $parentPayload;

        $this->extractionPaths = [
            'orderId' => 'string(x:PaymentContext/x:OrderId)',
            'cardNumber' =>
                'string(x:PaymentContext/x:EncryptedPaymentAccountUniqueId|x:PaymentContext/x:PaymentAccountUniqueId)',
            'authorizationResponseCode' => 'string(x:AuthorizationResponseCode)',
            'bankAuthorizationCode' => 'string(x:BankAuthorizationCode)',
            'cvv2ResponseCode' => 'string(x:CVV2ResponseCode)',
            'avsResponseCode' => 'string(x:AVSResponseCode)',
            'amountAuthorized' => 'number(x:AmountAuthorized)',
            'currencyCode' => 'string(x:AmountAuthorized/@currencyCode)',
            'isEncrypted' => 'boolean(x:PaymentContext/x:EncryptedPaymentAccountUniqueId)',
        ];
        $this->booleanExtractionPaths = [
            'panIsToken' => 'string(x:PaymentContext/x:PaymentAccountUniqueId/@isToken)'
        ];
        $this->optionalExtractionPaths = [
            'phoneResponseCode' => 'x:PhoneResponseCode',
            'nameResponseCode' => 'x:NameResponseCode',
            'emailResponseCode' => 'x:EmailResponseCode',
        ];
    }

    public function getIsAVSCorrectionRequired()
    {
        return $this->getIsAuthApproved() && !$this->getIsAVSSuccessful();
    }

    public function getIsAuthApproved()
    {
        return $this->getAuthorizationResponseCode() === self::AUTHORIZATION_APPROVED;
    }

    public function getAuthorizationResponseCode()
    {
        return $this->authorizationResponseCode;
    }

    public function getIsAVSSuccessful()
    {
        return !in_array($this->getAVSResponseCode(), $this->invalidAvsCodes);
    }

    public function getAVSResponseCode()
    {
        return $this->avsResponseCode;
    }

    public function getIsCVV2CorrectionRequired()
    {
        return $this->getIsAuthApproved() && !$this->getIsCVV2Successful();
    }

    public function getIsCVV2Successful($value = '')
    {
        return !in_array($this->getCVV2ResponseCode(), $this->invalidCvvCodes);
    }

    public function getCVV2ResponseCode()
    {
        return $this->cvv2ResponseCode;
    }

    public function getIsAuthSuccessful()
    {
        return ($this->getIsAuthApproved() && $this->getIsAVSSuccessful() && $this->getIsCVV2Successful())
        || ($this->getIsAuthTimeout());
    }

    public function getIsAuthTimeout()
    {
        $responseCode = $this->getAuthorizationResponseCode();
        return $responseCode === self::AUTHORIZATION_TIMEOUT_PAYMENT_PROVIDER
        || $responseCode === self::AUTHORIZATION_TIMEOUT_CARD_PROCESSOR;
    }

    public function getIsAuthAcceptable()
    {
        // If there is a response code acceptable by the OMS self::getResponseCode
        // doesn't return null, then the reply is acceptable
        return !is_null($this->getResponseCode());
    }

    public function getResponseCode()
    {
        $responseCode = $this->getAuthorizationResponseCode();
        return isset($this->responseCodeMap[$responseCode]) ? $this->responseCodeMap[$responseCode] : null;
    }

    /**
     * Serialize the various parts of the payload into XML strings and
     * simply concatenate them together.
     * @return string
     */
    protected function serializeContents()
    {
        return $this->serializePaymentContext()
        . $this->serializeResponseCodes()
        . $this->serializeAdditionalResponseCodes()
        . $this->serializeAmount();
    }

    /**
     * Create an XML string representing the various response codes, e.g.
     * AuthorizationResponseCode, BankAuthorizationCode, CVV2ResponseCode, etc.
     * @return string
     */
    protected function serializeResponseCodes()
    {
        $template = '<AuthorizationResponseCode>%s</AuthorizationResponseCode>'
            . '<BankAuthorizationCode>%s</BankAuthorizationCode>'
            . '<CVV2ResponseCode>%s</CVV2ResponseCode>'
            . '<AVSResponseCode>%s</AVSResponseCode>';
        return sprintf(
            $template,
            $this->xmlEncode($this->getAuthorizationResponseCode()),
            $this->xmlEncode($this->getBankAuthorizationCode()),
            $this->xmlEncode($this->getCVV2ResponseCode()),
            $this->xmlEncode($this->getAVSResponseCode())
        );
    }

    public function getBankAuthorizationCode()
    {
        return $this->bankAuthorizationCode;
    }

    /**
     * Create an XML string representing any of the optional response codes,
     * e.g. EmailResponseCode, PhoneResponseCode, etc.
     * @return string
     */
    protected function serializeAdditionalResponseCodes()
    {
        $phoneResponseCode = $this->xmlEncode($this->getPhoneResponseCode());
        $nameResponseCode = $this->xmlEncode($this->getNameResponseCode());
        $emailResponseCode = $this->xmlEncode($this->getEmailResponseCode());
        return ($phoneResponseCode ? "<PhoneResponseCode>{$phoneResponseCode}</PhoneResponseCode>" : '')
        . ($nameResponseCode ? "<NameResponseCode>{$nameResponseCode}</NameResponseCode>" : '')
        . ($emailResponseCode ? "<EmailResponseCode>{$emailResponseCode}</EmailResponseCode>" : '');
    }

    public function getPhoneResponseCode()
    {
        return $this->phoneResponseCode;
    }

    public function getNameResponseCode()
    {
        return $this->nameResponseCode;
    }

    public function getEmailResponseCode()
    {
        return $this->emailResponseCode;
    }

    /**
     * Create an XML string representing the amount authorized.
     * @return string
     */
    protected function serializeAmount()
    {
        return sprintf(
            '<AmountAuthorized currencyCode="%s">%01.2F</AmountAuthorized>',
            $this->xmlEncode($this->getCurrencyCode()),
            $this->getAmountAuthorized()
        );
    }

    public function getCurrencyCode()
    {
        return $this->currencyCode;
    }

    public function getAmountAuthorized()
    {
        return $this->amountAuthorized;
    }

    protected function getSchemaFile()
    {
        return $this->getSchemaDir() . self::XSD;
    }

    /**
     * Return the name of the xml root node.
     *
     * @return string
     */
    protected function getRootNodeName()
    {
        return static::ROOT_NODE;
    }

    /**
     * The XML namespace for the payload.
     *
     * @return string
     */
    protected function getXmlNamespace()
    {
        return static::XML_NS;
    }
}