PatronBase / omnipay-redsys

src/Message/AbstractResponse.php

Indentation +64 added lines, -64 removed lines

@@ -13,74 +13,74 @@
  */
 abstract class AbstractResponse extends BaseAbstractResponse
 {
-    /**
-     * Encode merchant parameters
-     *
-     * @param array $data  The parameters to encode
-     *
-     * @return string Encoded data
-     */
-    protected function encodeMerchantParameters($data)
-    {
-        return base64_encode(json_encode($data));
-    }
+	/**
+	 * Encode merchant parameters
+	 *
+	 * @param array $data  The parameters to encode
+	 *
+	 * @return string Encoded data
+	 */
+	protected function encodeMerchantParameters($data)
+	{
+		return base64_encode(json_encode($data));
+	}
 
-    /**
-     * Decode merchant parameters
-     *
-     * @param string $data  The encoded string of parameters
-     *
-     * @return array Decoded data
-     */
-    protected function decodeMerchantParameters($data)
-    {
-        return (array)json_decode(base64_decode(strtr($data, '-_', '+/')));
-    }
+	/**
+	 * Decode merchant parameters
+	 *
+	 * @param string $data  The encoded string of parameters
+	 *
+	 * @return array Decoded data
+	 */
+	protected function decodeMerchantParameters($data)
+	{
+		return (array)json_decode(base64_decode(strtr($data, '-_', '+/')));
+	}
 
-    /**
-     * Encrypt message with given key and default IV
-     *
-     * @todo function_exists() vs extension_loaded()?
-     *
-     * @param string $message  The message to encrypt
-     * @param string $key      The key used to encrypt the message
-     *
-     * @return string Encrypted message
-     *
-     * @throws RuntimeException
-     */
-    protected function encryptMessage($message, $key)
-    {
-        $iv = implode(array_map('chr', array(0, 0, 0, 0, 0, 0, 0, 0)));
+	/**
+	 * Encrypt message with given key and default IV
+	 *
+	 * @todo function_exists() vs extension_loaded()?
+	 *
+	 * @param string $message  The message to encrypt
+	 * @param string $key      The key used to encrypt the message
+	 *
+	 * @return string Encrypted message
+	 *
+	 * @throws RuntimeException
+	 */
+	protected function encryptMessage($message, $key)
+	{
+		$iv = implode(array_map('chr', array(0, 0, 0, 0, 0, 0, 0, 0)));
 
-        if (function_exists('mcrypt_encrypt')) {
-            $ciphertext = mcrypt_encrypt(MCRYPT_3DES, $key, $message, MCRYPT_MODE_CBC, $iv);
-        } else {
-            throw new RuntimeException('No valid encryption extension installed');
-        }
+		if (function_exists('mcrypt_encrypt')) {
+			$ciphertext = mcrypt_encrypt(MCRYPT_3DES, $key, $message, MCRYPT_MODE_CBC, $iv);
+		} else {
+			throw new RuntimeException('No valid encryption extension installed');
+		}
 
-        return $ciphertext;
-    }
+		return $ciphertext;
+	}
 
-    /**
-     * Create signature hash used to verify messages
-     *
-     * @todo Add if-check on algorithm to match against signature version as new param?
-     *
-     * @param string $message  The message to encrypt
-     * @param string $salt     Unique salt used to generate the ciphertext
-     * @param string $key      The key used to encrypt the message
-     *
-     * @return string Generated signature
-     */
-    protected function createSignature($message, $salt, $key)
-    {
-        $ciphertext = $this->encryptMessage($salt, $key);
-        return base64_encode(hash_hmac('sha256', $message, $ciphertext, true));
-    }
+	/**
+	 * Create signature hash used to verify messages
+	 *
+	 * @todo Add if-check on algorithm to match against signature version as new param?
+	 *
+	 * @param string $message  The message to encrypt
+	 * @param string $salt     Unique salt used to generate the ciphertext
+	 * @param string $key      The key used to encrypt the message
+	 *
+	 * @return string Generated signature
+	 */
+	protected function createSignature($message, $salt, $key)
+	{
+		$ciphertext = $this->encryptMessage($salt, $key);
+		return base64_encode(hash_hmac('sha256', $message, $ciphertext, true));
+	}
 
-    protected function createReturnSignature($message, $salt, $key)
-    {
-        return strtr($this->createSignature($message, $salt, $key), '+/', '-_');
-    }
+	protected function createReturnSignature($message, $salt, $key)
+	{
+		return strtr($this->createSignature($message, $salt, $key), '+/', '-_');
+	}
 }

src/Message/CompletePurchaseResponse.php

Indentation +110 added lines, -110 removed lines

@@ -10,125 +10,125 @@
  */
 class CompletePurchaseResponse extends AbstractResponse
 {
-    /** @var array */
-    protected $merchantParameters;
-    /** @var string */
-    protected $returnSignature;
-    /** @var boolean */
-    protected $usingUpcaseParameters = false;
-    /** @var boolean */
-    protected $usingUpcaseResponse = false;
+	/** @var array */
+	protected $merchantParameters;
+	/** @var string */
+	protected $returnSignature;
+	/** @var boolean */
+	protected $usingUpcaseParameters = false;
+	/** @var boolean */
+	protected $usingUpcaseResponse = false;
 
-    /**
-     * Constructor
-     *
-     * @param RequestInterface $request the initiating request.
-     * @param mixed $data
-     *
-     * @throws InvalidResponseException If merchant data or order number is missing, or signature does not match
-     */
-    public function __construct(RequestInterface $request, $data)
-    {
-        parent::__construct($request, $data);
+	/**
+	 * Constructor
+	 *
+	 * @param RequestInterface $request the initiating request.
+	 * @param mixed $data
+	 *
+	 * @throws InvalidResponseException If merchant data or order number is missing, or signature does not match
+	 */
+	public function __construct(RequestInterface $request, $data)
+	{
+		parent::__construct($request, $data);
 
-        if (!empty($data['Ds_MerchantParameters'])) {
-            $this->merchantParameters = $this->decodeMerchantParameters($data['Ds_MerchantParameters']);
-        } elseif (!empty($data['DS_MERCHANTPARAMETERS'])) {
-            $this->merchantParameters = $this->decodeMerchantParameters($data['DS_MERCHANTPARAMETERS']);
-            $this->usingUpcaseResponse = true;
-        } else {
-            throw new InvalidResponseException('Invalid response from payment gateway (no data)');
-        }
+		if (!empty($data['Ds_MerchantParameters'])) {
+			$this->merchantParameters = $this->decodeMerchantParameters($data['Ds_MerchantParameters']);
+		} elseif (!empty($data['DS_MERCHANTPARAMETERS'])) {
+			$this->merchantParameters = $this->decodeMerchantParameters($data['DS_MERCHANTPARAMETERS']);
+			$this->usingUpcaseResponse = true;
+		} else {
+			throw new InvalidResponseException('Invalid response from payment gateway (no data)');
+		}
 
-        if (!empty($this->merchantParameters['Ds_Order'])) {
-            $order = $this->merchantParameters['Ds_Order'];
-        } elseif (!empty($this->merchantParameters['DS_ORDER'])) {
-            $order = $this->merchantParameters['DS_ORDER'];
-            $this->usingUpcaseParameters = true;
-        } else {
-            throw new InvalidResponseException();
-        }
+		if (!empty($this->merchantParameters['Ds_Order'])) {
+			$order = $this->merchantParameters['Ds_Order'];
+		} elseif (!empty($this->merchantParameters['DS_ORDER'])) {
+			$order = $this->merchantParameters['DS_ORDER'];
+			$this->usingUpcaseParameters = true;
+		} else {
+			throw new InvalidResponseException();
+		}
 
-        $this->returnSignature = $this->createReturnSignature(
-            $data[$this->usingUpcaseResponse ? 'DS_MERCHANTPARAMETERS' : 'Ds_MerchantParameters'],
-            $order,
-            base64_decode($this->request->getHmacKey())
-        );
+		$this->returnSignature = $this->createReturnSignature(
+			$data[$this->usingUpcaseResponse ? 'DS_MERCHANTPARAMETERS' : 'Ds_MerchantParameters'],
+			$order,
+			base64_decode($this->request->getHmacKey())
+		);
 
-        if ($this->returnSignature != $data[$this->usingUpcaseResponse ? 'DS_SIGNATURE' : 'Ds_Signature']) {
-            throw new InvalidResponseException('Invalid response from payment gateway (signature mismatch)');
-        }
-    }
+		if ($this->returnSignature != $data[$this->usingUpcaseResponse ? 'DS_SIGNATURE' : 'Ds_Signature']) {
+			throw new InvalidResponseException('Invalid response from payment gateway (signature mismatch)');
+		}
+	}
 
-    /**
-     * Is the response successful?
-     *
-     * @return boolean
-     */
-    public function isSuccessful()
-    {
-        $key = $this->usingUpcaseParameters ? 'DS_RESPONSE' : 'Ds_Response';
-        return isset($this->merchantParameters[$key])
-            && is_numeric($this->merchantParameters[$key])
-            && 0 <= $this->merchantParameters[$key]
-            && 100 > $this->merchantParameters[$key];
-    }
+	/**
+	 * Is the response successful?
+	 *
+	 * @return boolean
+	 */
+	public function isSuccessful()
+	{
+		$key = $this->usingUpcaseParameters ? 'DS_RESPONSE' : 'Ds_Response';
+		return isset($this->merchantParameters[$key])
+			&& is_numeric($this->merchantParameters[$key])
+			&& 0 <= $this->merchantParameters[$key]
+			&& 100 > $this->merchantParameters[$key];
+	}
 
-    /**
-     * Get the response data, included the decoded merchant parameters if available.
-     *
-     * @return mixed
-     */
-    public function getData()
-    {
-        $data = parent::getData();
-        return is_array($data) && is_array($this->merchantParameters)
-            ? array_merge($data, $this->merchantParameters)
-            : $data;
-    }
+	/**
+	 * Get the response data, included the decoded merchant parameters if available.
+	 *
+	 * @return mixed
+	 */
+	public function getData()
+	{
+		$data = parent::getData();
+		return is_array($data) && is_array($this->merchantParameters)
+			? array_merge($data, $this->merchantParameters)
+			: $data;
+	}
 
-    /**
-     * Helper method to get a specific merchant parameter if available.
-     *
-     * @param string $key The key to look up
-     *
-     * @return null|mixed
-     */
-    protected function getKey($key)
-    {
-        if ($this->usingUpcaseParameters) {
-            $key = strtoupper($key);
-        }
-        return isset($this->merchantParameters[$key]) ? $this->merchantParameters[$key] : null;
-    }
+	/**
+	 * Helper method to get a specific merchant parameter if available.
+	 *
+	 * @param string $key The key to look up
+	 *
+	 * @return null|mixed
+	 */
+	protected function getKey($key)
+	{
+		if ($this->usingUpcaseParameters) {
+			$key = strtoupper($key);
+		}
+		return isset($this->merchantParameters[$key]) ? $this->merchantParameters[$key] : null;
+	}
 
-    /**
-     * Get the authorisation code if available.
-     *
-     * @return null|string
-     */
-    public function getTransactionReference()
-    {
-        return $this->getKey('Ds_AuthorisationCode');
-    }
+	/**
+	 * Get the authorisation code if available.
+	 *
+	 * @return null|string
+	 */
+	public function getTransactionReference()
+	{
+		return $this->getKey('Ds_AuthorisationCode');
+	}
 
-    /**
-     * Get the merchant response message if available.
-     *
-     * @return null|string
-     */
-    public function getMessage()
-    {
-        return $this->getKey('Ds_Response');
-    }
+	/**
+	 * Get the merchant response message if available.
+	 *
+	 * @return null|string
+	 */
+	public function getMessage()
+	{
+		return $this->getKey('Ds_Response');
+	}
 
-    /**
-     * Get the card type if available.
-     *
-     * @return null|string
-     */
-    public function getCardType()
-    {
-        return $this->getKey('Ds_Card_Type');
-    }
+	/**
+	 * Get the card type if available.
+	 *
+	 * @return null|string
+	 */
+	public function getCardType()
+	{
+		return $this->getKey('Ds_Card_Type');
+	}
 }

src/Message/PurchaseRequest.php

Indentation +158 added lines, -158 removed lines

@@ -9,162 +9,162 @@
  */
 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);
-    }
-
-    /**
-     * 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(),
-        );
-    }
-
-    public function sendData($data)
-    {
-        return $this->response = new PurchaseResponse($this, $data);
-    }
-
-    public function getEndpoint()
-    {
-        return $this->getTestMode() ? $this->testEndpoint : $this->liveEndpoint;
-    }
+	/** @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);
+	}
+
+	/**
+	 * 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(),
+		);
+	}
+
+	public function sendData($data)
+	{
+		return $this->response = new PurchaseResponse($this, $data);
+	}
+
+	public function getEndpoint()
+	{
+		return $this->getTestMode() ? $this->testEndpoint : $this->liveEndpoint;
+	}
 }