WebservicePurchaseResponse::getTransactionReference() - Code Metrics - AvaiBookSports/omnipay-redsys - Measure and Improve Code Quality continuously with Scrutinizer

getTransactionReference() A
last analyzed 2025-03-26 13:33 UTC

↳ Parent: WebservicePurchaseResponse

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
cc	1
eloc	1
c	2
b	1
f	0
nc	1
nop	0
dl	0
loc	3
ccs	1
cts	1
cp	1
crap	1
rs	10

<?php

namespace Omnipay\Redsys\Message;

use AvaiBookSports\Component\RedsysMessages\Exception\CatalogNotFoundException;
use AvaiBookSports\Component\RedsysMessages\Factory;
use AvaiBookSports\Component\RedsysMessages\Loader\CatalogLoader;
use Omnipay\Common\Exception\InvalidResponseException;
use Omnipay\Common\Message\RequestInterface;

/**
 * Redsys Purchase Response.
 */
class WebservicePurchaseResponse extends AbstractResponse
{
    /** @var string */
    protected $returnSignature;

    /** @var bool */
    protected $usingUpcaseResponse = false;

    /** @var CatalogInterface */
filter:
    dependency_paths: ["lib/*"]
    protected $redsysMessages;

    /**
     * Constructor.
     *
     * @param RequestInterface $request the initiating request
     * @param mixed            $data
     *
     * @throws InvalidResponseException If resopnse format is incorrect, data is missing, or signature does not match
     */
    public function __construct(RequestInterface $request, $data)
    {
        parent::__construct($request, $data);

        try {
            $this->redsysMessages = (new Factory(new CatalogLoader()))->createCatalogByLanguage(array_key_exists('language', $this->request->getParameters()) ? $this->request->getParameters()['language'] : 'en');

        } catch (CatalogNotFoundException $e) {
            $this->redsysMessages = (new Factory(new CatalogLoader()))->createCatalogByLanguage('en');
        }

        $security = new Security();

        if (!isset($data['CODIGO'])) {
            throw new InvalidResponseException('Invalid response from payment gateway (no data)');
        }

        if (!isset($data['OPERACION'])) {
            if ('0' == $data['CODIGO']) {
                throw new InvalidResponseException('Invalid response from payment gateway (no data)');
            } else {
                if (null === $this->getMessage()) {
                    throw new InvalidResponseException('Invalid response from payment gateway: "'.$this->getCode().'"');
                } else {
                    throw new InvalidResponseException('Invalid response from payment gateway: "'.$this->getCode().': '.$this->getMessage().'"');
                }
            }
        }

        if (isset($data['OPERACION']['DS_ORDER'])) {
            $this->usingUpcaseResponse = true;
        }

        $order = $this->GetKey('Ds_Order');
        if (null === $order) {
            throw new InvalidResponseException();
        }

        $signature_keys = [
            'Ds_Amount',
            'Ds_Order',
            'Ds_MerchantCode',
            'Ds_Currency',
            'Ds_Response',
            'Ds_TransactionType',
            'Ds_SecurePayment',
        ];
        $signature_data = '';
        foreach ($signature_keys as $key) {
            $value = $this->getKey($key);
            if (null === $value) {
                throw new InvalidResponseException('Invalid response from payment gateway (missing data)');
            }
            $signature_data .= $value;
        }

        $this->returnSignature = $security->createSignature(
            $signature_data,
            $order,
            $this->request->getHmacKey()
                            getHmacKey()
        );

        if ($this->returnSignature != $this->GetKey('Ds_Signature')) {
            throw new InvalidResponseException('Invalid response from payment gateway (signature mismatch)');
        }
    }

    public function isSuccessful()
    {
        $response_code = $this->getKey('Ds_Response');

        // check for field existence as well as value
        return isset($this->data['CODIGO'])
            && '0' == $this->data['CODIGO']
            && null !== $response_code
            && is_numeric($response_code)
            && 0 <= $response_code
            && 100 > $response_code;
    }

    /**
     * Helper method to get a specific response parameter if available.
     *
     * @param string $key The key to look up
     *
     * @return mixed|null
     */
    protected function getKey($key)
    {
        if ($this->usingUpcaseResponse) {
            $key = strtoupper($key);
        }

        return isset($this->data['OPERACION'][$key]) ? $this->data['OPERACION'][$key] : null;
    }

    /**
     * Get the authorisation code if available.
     *
     * @return string|null
     */
    public function getTransactionReference()
    {
        return $this->getAuthorisationCode();
    }

    /**
     * Get the merchant message if available.
     *
     * @return string|null A response message from the payment gateway
     */
    public function getMessage()
    {
        $message = $this->redsysMessages->getDsResponseMessage($this->getCode());

        if (null === $message) {
            $message = $this->redsysMessages->getErrorMessage($this->getCode());
        }

        return $message;
    }

    /**
     * Get the merchant response code if available.
     *
     * @return string|null
     */
    public function getCode()
    {
        $code = $this->getKey('Ds_Response');

        if (null === $code) {
            $code = $this->data['CODIGO'];
        }

        return $code;
    }

    /**
     * Get the merchant data if available.
     *
     * @return string|null
     */
    public function getMerchantData()
    {
        return $this->getKey('Ds_MerchantData');
    }

    /**
     * Get the card country if available.
     *
     * @return string|null ISO 3166-1 (3-digit numeric) format, if supplied
     */
    public function getCardCountry()
    {
        return $this->getKey('Ds_Card_Country');
    }
}


AvaiBookSports / omnipay-redsys

getTransactionReference() A last analyzed 2025-03-26 13:33 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

getTransactionReference() A
last analyzed 2025-03-26 13:33 UTC