Omnipay\Redsys\Message\PurchaseRequest

Complexity

Total Complexity

42

Size/Duplication

Total Lines	359
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

34 Methods

Rating	Name	Duplication	Size	Complexity
A	getCardholder()	0	4	1
A	setCardholder()	0	4	1
A	getConsumerLanguage()	0	4	1
A	setConsumerLanguage()	0	13	6
A	getHmacKey()	0	4	1
A	setHmacKey()	0	4	1
A	getMerchantData()	0	4	1
A	setMerchantData()	0	4	1
A	getMerchantId()	0	4	1
A	setMerchantId()	0	4	1
A	getMerchantName()	0	4	1
A	setMerchantName()	0	4	1
A	getTerminalId()	0	4	1
A	setTerminalId()	0	4	1
A	getShippingCountry()	0	4	1
A	setShippingCountry()	0	4	1
A	getShippingCity()	0	4	1
A	setShippingCity()	0	4	1
A	getShippingState()	0	4	1
A	setShippingState()	0	4	1
A	getShippingAddress3()	0	4	1
A	setShippingAddress3()	0	4	1
A	getShippingAddress2()	0	4	1
A	setShippingAddress2()	0	4	1
A	getShippingAddress1()	0	4	1
A	setShippingAddress1()	0	4	1
A	getShippingPostcode()	0	4	1
A	setShippingPostcode()	0	4	1
A	getEmail()	0	4	1
A	setEmail()	0	4	1
A	setTransactionId()	0	15	3
A	getData()	0	39	1
A	sendData()	0	18	1
A	getEndpoint()	0	4	2

<?php

namespace Omnipay\Redsys\Message;

use Omnipay\Common\Message\AbstractRequest;

/**
 * Redsys Purchase Request
 */
class PurchaseRequest extends AbstractRequest
{
    /** @var string */
    protected $liveEndpoint = 'https://sis.redsys.es/sis/realizarPago';
    /** @var string */
    protected $testEndpoint = 'https://sis-t.redsys.es:25443/sis/realizarPago';
    /** @var array */
    protected static $consumerLanguages = array(
        'es' => '001', // Spanish
        'en' => '002', // English
        'ca' => '003', // Catalan - same as Valencian (010)
        'fr' => '004', // French
        'de' => '005', // German
        'nl' => '006', // Dutch
        'it' => '007', // Italian
        'sv' => '008', // Swedish
        'pt' => '009', // Portuguese
        'pl' => '011', // Polish
        'gl' => '012', // Galician
        'eu' => '013', // Basque
    );

    public function getCardholder()
    {
        return $this->getParameter('cardholder');
    }

    public function setCardholder($value)
    {
        return $this->setParameter('cardholder', $value);
    }

    public function getConsumerLanguage()
    {
        return $this->getParameter('consumerLanguage');
    }

    /**
     * Set the language presented to the consumer
     *
     * @param string|int Either the ISO 639-1 code to be converted, or the gateway's own numeric language code
     */
    public function setConsumerLanguage($value)
    {
        if (is_int($value)) {
            if ($value < 0 || $value > 13) {
                $value = 1;
            }
            $value = str_pad($value, 3, '0', STR_PAD_LEFT);
        } elseif (!is_numeric($value)) {
            $value = isset(self::$consumerLanguages[$value]) ? self::$consumerLanguages[$value] : '001';
        }

        return $this->setParameter('consumerLanguage', $value);
    }

    public function getHmacKey()
    {
        return $this->getParameter('hmacKey');
    }

    public function setHmacKey($value)
    {
        return $this->setParameter('hmacKey', $value);
    }

    public function getMerchantData()
    {
        return $this->getParameter('merchantData');
    }

    public function setMerchantData($value)
    {
        return $this->setParameter('merchantData', $value);
    }

    public function getMerchantId()
    {
        return $this->getParameter('merchantId');
    }

    public function setMerchantId($value)
    {
        return $this->setParameter('merchantId', $value);
    }

    public function getMerchantName()
    {
        return $this->getParameter('merchantName');
    }

    public function setMerchantName($value)
    {
        return $this->setParameter('merchantName', $value);
    }

    public function getTerminalId()
    {
        return $this->getParameter('terminalId');
    }

    public function setTerminalId($value)
    {
        return $this->setParameter('terminalId', $value);
    }

    /**
     * Get the shippingCountry field
     *
     * @return int The shipping country as an ISO3166 numeric code, e.g. 840 for USA.
     */
    public function getShippingCountry()
    {
        return $this->getParameter('shippingCountry');
    }

    /**
     * Set the shippingCountry field
     *
     * @param int $value The shipping country as an ISO3166 numeric code, e.g. 840 for USA.
     * @return self
     */
    public function setShippingCountry($value)
    {
        return $this->setParameter('shippingCountry', $value);
    }

    /**
     * Get the shippingCity field
     *
     * @return string
     */
    public function getShippingCity()
    {
        return $this->getParameter('shippingCity');
    }

    /**
     * Set the shippingCity field
     *
     * @param string $value
     * @return self
     */
    public function setShippingCity($value)
    {
        return $this->setParameter('shippingCity', $value);
    }

    /**
     * Get the shippingState field
     *
     * @return string
     */
    public function getShippingState()
    {
        return $this->getParameter('shippingState');
    }

    /**
     * Set the shippingState field
     *
     * @param string $value
     * @return self
     */
    public function setShippingState($value)
    {
        return $this->setParameter('shippingState', $value);
    }

    /**
     * Get the shippingAddress3 field
     *
     * @return string
     */
    public function getShippingAddress3()
    {
        return $this->getParameter('shippingAddress3');
    }

    /**
     * Set the shippingAddress3 field
     *
     * @param string $value
     * @return self
     */
    public function setShippingAddress3($value)
    {
        return $this->setParameter('shippingAddress3', $value);
    }

    /**
     * Get the shippingAddress2 field
     *
     * @return string
     */
    public function getShippingAddress2()
    {
        return $this->getParameter('shippingAddress2');
    }

    /**
     * Set the shippingAddress2 field
     *
     * @param string $value
     * @return self
     */
    public function setShippingAddress2($value)
    {
        return $this->setParameter('shippingAddress2', $value);
    }

    /**
     * Get the shippingAddress1 field
     *
     * @return string
     */
    public function getShippingAddress1()
    {
        return $this->getParameter('shippingAddress1');
    }

    /**
     * Set the shippingAddress1 field
     *
     * @param string $value
     * @return self
     */
    public function setShippingAddress1($value)
    {
        return $this->setParameter('shippingAddress1', $value);
    }

    /**
     * Get the shippingPostcode field
     *
     * @return string
     */
    public function getShippingPostcode()
    {
        return $this->getParameter('shippingPostcode');
    }

    /**
     * Set the shippingPostcode field
     *
     * @param string $value
     * @return self
     */
    public function setShippingPostcode($value)
    {
        return $this->setParameter('shippingPostcode', $value);
    }

    /**
     * Get the email field
     *
     * @return string
     */
    public function getEmail()
    {
        return $this->getParameter('email');
    }

    /**
     * Set the email field
     *
     * @param string $value
     * @return self
     */
    public function setEmail($value)
    {
        return $this->setParameter('email', $value);
    }

    /**
     * Override the abstract method to add requirement that it must start with 4 numeric characters
     *
     * @param string|int $value The transaction ID (merchant order) to set for the transaction
     */
    public function setTransactionId($value)
    {
        $start = substr($value, 0, 4);
        $numerics = 0;
        foreach (str_split($start) as $char) {
            if (is_numeric($char)) {
                $numerics++;
            } else {
                break;
            }
        }
        $value = str_pad(substr($start, 0, $numerics), 4, 0, STR_PAD_LEFT).substr($value, $numerics);

        parent::setTransactionId($value);
    }

    public function getData()
    {
        $this->validate('merchantId', 'terminalId', 'amount', 'currency');

        return array(
            // mandatory fields
            'Ds_Merchant_MerchantCode'       => $this->getMerchantId(),
            'Ds_Merchant_Terminal'           => $this->getTerminalId(),
            'Ds_Merchant_TransactionType'    => '0',                          // Authorisation
            'Ds_Merchant_Amount'             => $this->getAmountInteger(),
            'Ds_Merchant_Currency'           => $this->getCurrencyNumeric(),  // uses ISO-4217 codes
            'Ds_Merchant_Order'              => $this->getTransactionId(),
            'Ds_Merchant_MerchantUrl'        => $this->getNotifyUrl(),
            // optional fields
            'Ds_Merchant_ProductDescription' => $this->getDescription(),
            'Ds_Merchant_Cardholder'         => $this->getCardholder(),
            'Ds_Merchant_UrlOK'              => $this->getReturnUrl(),
            'Ds_Merchant_UrlKO'              => $this->getReturnUrl(),
            'Ds_Merchant_MerchantName'       => $this->getMerchantName(),
            'Ds_Merchant_ConsumerLanguage'   => $this->getConsumerLanguage(),
            'Ds_Merchant_MerchantData'       => $this->getMerchantData(),
            // 3DS EMV fields
            'Ds_Merchant_Emv3Ds' => [
                  'shipAddrCountry'  => $this->getShippingCountry(),
                  'shipAddrCity'     => $this->getShippingCity(),
                  'shipAddrState'    => $this->getShippingState(),
                  'shipAddrLine3'    => $this->getShippingAddress3(),
                  'shipAddrLine2'    => $this->getShippingAddress2(),
                  'shipAddrLine1'    => $this->getShippingAddress1(),
                  'shipAddrPostCode' => $this->getShippingPostcode(),
                  'cardholderName'   => $this->getCardholder(),
                  'email'            => $this->getEmail(),
                  // 'mobilePhone'      => [
                  //     'cc'         => '123',
                  //     'subscriber' => '123456789'
                  // ],
            ],
        );
    }

    public function sendData($data)
    {
        $security = new Security;

        $encoded_data = $security->encodeMerchantParameters($data);

        $response_data = array(
            'Ds_SignatureVersion'   => Security::VERSION,
            'Ds_MerchantParameters' => $encoded_data,
            'Ds_Signature'          => $security->createSignature(
                $encoded_data,
                $data['Ds_Merchant_Order'],
                $this->getHmacKey()
            ),
        );

        return $this->response = new PurchaseResponse($this, $response_data);
    }

    public function getEndpoint()
    {
        return $this->getTestMode() ? $this->testEndpoint : $this->liveEndpoint;
    }
}