Initial commit of Redsys gateway and unit tests

Author: leith

.gitignore

@@ -0,0 +1,4 @@
+/vendor
+composer.lock
+composer.phar
+phpunit.xml

.travis.yml

@@ -0,0 +1,13 @@
+language: php
+
+php:
+  - 5.3
+  - 5.4
+  - 5.5
+  - 5.6
+  - hhvm
+
+before_script:
+  - composer install -n --dev --prefer-source
+
+script: vendor/bin/phpcs --standard=PSR2 src && vendor/bin/phpunit --coverage-text

CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing Guidelines
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit just the modifications, do not mess with the composer.json or CHANGELOG.md files.
+* Ensure your code is nicely formatted in the [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
+  style and that all tests pass.
+* Send the pull request.
+* Check that the Travis CI build passed. If not, rinse and repeat.

LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Leith Caldwell
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,51 @@
+# Omnipay: Redsys
+
+**Redsys driver for the Omnipay PHP payment processing library**
+
+[![Build Status](https://travis-ci.org/PatronBase/omnipay-redsys.png?branch=master)](https://travis-ci.org/PatronBase/omnipay-redsys)
+[![Latest Stable Version](https://poser.pugx.org/PatronBase/omnipay-redsys/version.png)](https://packagist.org/packages/patronbase/omnipay-redsys)
+[![Total Downloads](https://poser.pugx.org/patronbase/omnipay-redsys/d/total.png)](https://packagist.org/packages/patronbase/omnipay-redsys)
+
+
+[Omnipay](https://github.com/thephpleague/omnipay) is a framework agnostic, multi-gateway payment
+processing library for PHP 5.3+. This package implements Redsys support for Omnipay.
+
+## Installation
+
+Omnipay is installed via [Composer](http://getcomposer.org/). To install, simply add it
+to your `composer.json` file:
+
+```json
+{
+    "require": {
+        "PatronBase/omnipay-redsys": "~2.0"
+    }
+}
+```
+
+And run composer to update your dependencies:
+
+    $ curl -s http://getcomposer.org/installer | php
+    $ php composer.phar update
+
+## Basic Usage
+
+The following gateways are provided by this package:
+
+* Redsys
+
+For general usage instructions, please see the main [Omnipay](https://github.com/thephpleague/omnipay)
+repository.
+
+## Support
+
+If you are having general issues with Omnipay, we suggest posting on
+[Stack Overflow](http://stackoverflow.com/). Be sure to add the
+[omnipay tag](http://stackoverflow.com/questions/tagged/omnipay) so it can be easily found.
+
+If you want to keep up to date with release anouncements, discuss ideas for the project,
+or ask more detailed questions, there is also a [mailing list](https://groups.google.com/forum/#!forum/omnipay) which
+you can subscribe to.
+
+If you believe you have found a bug, please report it using the [GitHub issue tracker](https://github.com/PatronBase/omnipay-redsys/issues),
+or better yet, fork the library and submit a pull request.

composer.json

@@ -0,0 +1,42 @@
+{
+    "name": "patronbase/omnipay-redsys",
+    "type": "library",
+    "description": "Redsys driver for the Omnipay payment processing library",
+    "keywords": [
+        "gateway",
+        "merchant",
+        "omnipay",
+        "pay",
+        "payment",
+        "redsys",
+        "servired"
+    ],
+    "homepage": "https://github.com/PatronBase/omnipay-redsys",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Leith Caldwell",
+            "email": "[email protected]"
+        }
+    ],
+    "autoload": {
+        "psr-4": { "Omnipay\\Redsys\\" : "src/" }
+    },
+    "autoload-dev": {
+        "psr-4": { "Omnipay\\Redsys\\" : "tests/" }
+    },
+    "require": {
+        "omnipay/common": "~2.0"
+    },
+    "require-dev": {
+        "omnipay/tests": "~2.0"
+    },
+    "suggest": {
+        "ext-mcrypt": "Required for hashing functions to check message signatures"
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "2.0.x-dev"
+        }
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         syntaxCheck="false">
+    <testsuites>
+        <testsuite name="Omnipay Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <listeners>
+        <listener class="Mockery\Adapter\Phpunit\TestListener" file="vendor/mockery/mockery/library/Mockery/Adapter/Phpunit/TestListener.php" />
+    </listeners>
+    <filter>
+        <whitelist>
+            <directory>./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Gateway.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace Omnipay\Redsys;
+
+use Omnipay\Common\AbstractGateway;
+use Omnipay\Redsys\Message\CompletePurchaseRequest;
+use Omnipay\Redsys\Message\PurchaseRequest;
+
+/**
+ * Redsys Gateway
+ *
+ * @link http://www.redsys.es/
+ */
+class Gateway extends AbstractGateway
+{
+    public function getName()
+    {
+        return 'Redsys';
+    }
+
+    public function getDefaultParameters()
+    {
+        return array(
+            'merchantId' => '',
+            'merchantName' => '',
+            'terminalId' => '',
+            'hmacKey' => '',
+            'testMode' => false,
+        );
+    }
+
+    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);
+    }
+
+    public function getHmacKey()
+    {
+        return $this->getParameter('hmacKey');
+    }
+
+    public function setHmacKey($value)
+    {
+        return $this->setParameter('hmacKey', $value);
+    }
+
+    public function purchase(array $parameters = array())
+    {
+        return $this->createRequest('\Omnipay\Redsys\Message\PurchaseRequest', $parameters);
+    }
+
+    public function completePurchase(array $parameters = array())
+    {
+        return $this->createRequest('\Omnipay\Redsys\Message\CompletePurchaseRequest', $parameters);
+    }
+}

src/Message/AbstractResponse.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace Omnipay\Redsys\Message;
+
+use Omnipay\Common\Message\AbstractResponse as BaseAbstractResponse;
+use Omnipay\Common\Exception\RuntimeException;
+
+/**
+ * Abstract Response
+ *
+ * This abstract class extends the base Omnipay AbstractResponse in order
+ * to provide some common encoding and decoding functions.
+ */
+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));
+    }
+
+    /**
+     * 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)));
+
+        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;
+    }
+
+    /**
+     * 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), '+/', '-_');
+    }
+}

src/Message/CompletePurchaseRequest.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Omnipay\Redsys\Message;
+
+/**
+ * Redsys Complete Purchase Request
+ */
+class CompletePurchaseRequest extends PurchaseRequest
+{
+    public function getData()
+    {
+        return $this->httpRequest->request->all();
+    }
+
+    public function sendData($data)
+    {
+        return $this->response = new CompletePurchaseResponse($this, $data);
+    }
+}