Add MIGS gateway

Author: benjamindavid

README.md

@@ -88,6 +88,8 @@ The following gateways are already implemented:
 * Dummy
 * GoCardless
 * Manual
+* Migs 2-Party
+* Migs 3-Party
 * Netaxept (BBS)
 * PayFast
 * Payflow Pro

src/Omnipay/Migs/Message/AbstractRequest.php

@@ -0,0 +1,85 @@
+<?php
+
+/*
+ * This file is part of the Omnipay package.
+ *
+ * (c) Adrian Macneil <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Omnipay\Migs\Message;
+
+/**
+ * GoCardless Abstract Request
+ */
+abstract class AbstractRequest extends \Omnipay\Common\Message\AbstractRequest
+{
+    protected $endpoint = 'https://migs.mastercard.com.au/';
+
+    public function getMerchantId()
+    {
+        return $this->getParameter('merchantId');
+    }
+
+    public function setMerchantId($value)
+    {
+        return $this->setParameter('merchantId', $value);
+    }
+
+    public function getMerchantAccessCode()
+    {
+        return $this->getParameter('merchantAccessCode');
+    }
+
+    public function setMerchantAccessCode($value)
+    {
+        return $this->setParameter('merchantAccessCode', $value);
+    }
+
+    public function getSecureHash()
+    {
+        return $this->getParameter('secureHash');
+    }
+
+    public function setSecureHash($value)
+    {
+        return $this->setParameter('secureHash', $value);
+    }
+
+    protected function getBaseData()
+    {
+        $data = array();
+        $data['vpc_Merchant']   = $this->getMerchantId();
+        $data['vpc_AccessCode'] = $this->getMerchantAccessCode();
+        $data['vpc_Version']    = '1';
+        $data['vpc_Locale']     = 'en';
+        $data['vpc_Command']    = $this->action;
+        $data['vpc_Amount']      = $this->getAmount();
+        $data['vpc_MerchTxnRef'] = $this->getTransactionId();
+        $data['vpc_OrderInfo']   = $this->getDescription();
+        $data['vpc_ReturnURL']   = $this->getReturnUrl();
+
+        return $data;
+    }
+
+    public function getEndpoint()
+    {
+        return $this->endpoint;
+    }
+
+    public function calculateHash($data)
+    {
+        ksort($data);
+
+        $hash = $this->getSecureHash();
+        foreach ($data as $k => $v) {
+            if (substr($k, 0, 4) === 'vpc_' && $k !== 'vpc_SecureHash') {
+                $hash .= $v;
+            }
+        }
+
+        return strtoupper(md5($hash));
+    }
+}

src/Omnipay/Migs/Message/Response.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the Omnipay package.
+ *
+ * (c) Adrian Macneil <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Omnipay\Migs\Message;
+
+use Omnipay\Common\Message\AbstractResponse;
+use Omnipay\Common\Message\RequestInterface;
+
+/**
+ * Migs Purchase Response
+ */
+class Response extends AbstractResponse
+{
+    public function __construct(RequestInterface $request, $data)
+    {
+        if (!is_array($data)) {
+            parse_str($data, $data);
+        }
+
+        parent::__construct($request, $data);
+    }
+
+    public function isSuccessful()
+    {
+        return isset($this->data['vpc_TxnResponseCode']) && "0" === $this->data['vpc_TxnResponseCode'];
+    }
+
+    public function getTransactionReference()
+    {
+        return isset($this->data['vpc_ReceiptNo']) ? $this->data['vpc_ReceiptNo'] : null;
+    }
+
+    public function getMessage()
+    {
+        return isset($this->data['vpc_Message']) ? $this->data['vpc_Message'] : null;
+    }
+}

src/Omnipay/Migs/Message/ThreePartyCompletePurchaseRequest.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the Omnipay package.
+ *
+ * (c) Adrian Macneil <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Omnipay\Migs\Message;
+
+use Omnipay\Common\Exception\InvalidRequestException;
+
+/**
+ * Migs Complete Purchase Request
+ */
+class ThreePartyCompletePurchaseRequest extends AbstractRequest
+{
+    public function getData()
+    {
+        $data = $this->httpRequest->query->all();
+
+        $hash = isset($data['vpc_SecureHash']) ? $data['vpc_SecureHash'] : null;
+        if ($this->calculateHash($data) !== $hash) {
+            throw new InvalidRequestException('Incorrect hash');
+        }
+
+        return $data;
+    }
+
+    public function send()
+    {
+        return $this->response = new Response($this, $this->getData());
+    }
+
+    public function getEndpoint()
+    {
+        return $this->endpoint.'vpcpay';
+    }
+}

src/Omnipay/Migs/Message/ThreePartyPurchaseRequest.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the Omnipay package.
+ *
+ * (c) Adrian Macneil <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Omnipay\Migs\Message;
+
+/**
+ * Migs Purchase Request
+ */
+class ThreePartyPurchaseRequest extends AbstractRequest
+{
+    protected $action = 'pay';
+
+    public function getData()
+    {
+        $this->validate('amount', 'returnUrl', 'transactionId');
+
+        $data = $this->getBaseData();
+        $data['vpc_SecureHash']  = $this->calculateHash($data);
+
+        return $data;
+    }
+
+    public function send()
+    {
+        $redirectUrl = $this->getEndpoint().'?'.http_build_query($this->getData());
+
+        return $this->response = new ThreePartyPurchaseResponse($this, $this->getData(), $redirectUrl);
+    }
+
+    public function getEndpoint()
+    {
+        return $this->endpoint.'vpcpay';
+    }
+}

src/Omnipay/Migs/Message/ThreePartyPurchaseResponse.php

@@ -0,0 +1,55 @@
+<?php
+
+/*
+ * This file is part of the Omnipay package.
+ *
+ * (c) Adrian Macneil <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Omnipay\Migs\Message;
+
+use Omnipay\Common\Message\AbstractResponse;
+use Omnipay\Common\Message\RequestInterface;
+use Omnipay\Common\Message\RedirectResponseInterface;
+
+/**
+ * Migs Purchase Response
+ */
+class ThreePartyPurchaseResponse extends AbstractResponse implements RedirectResponseInterface
+{
+    protected $redirectUrl;
+
+    public function __construct(RequestInterface $request, $data, $redirectUrl)
+    {
+        parent::__construct($request, $data);
+        $this->redirectUrl = $redirectUrl;
+    }
+
+    public function isSuccessful()
+    {
+        return false;
+    }
+
+    public function isRedirect()
+    {
+        return true;
+    }
+
+    public function getRedirectUrl()
+    {
+        return $this->redirectUrl;
+    }
+
+    public function getRedirectMethod()
+    {
+        return 'GET';
+    }
+
+    public function getRedirectData()
+    {
+        return $this->getData();
+    }
+}

src/Omnipay/Migs/Message/TwoPartyPurchaseRequest.php

@@ -0,0 +1,47 @@
+<?php
+
+/*
+ * This file is part of the Omnipay package.
+ *
+ * (c) Adrian Macneil <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Omnipay\Migs\Message;
+
+/**
+ * Migs Purchase Request
+ */
+class TwoPartyPurchaseRequest extends AbstractRequest
+{
+    protected $action = 'pay';
+
+    public function getData()
+    {
+        $this->validate('amount', 'transactionId', 'card');
+
+        $this->getCard()->validate();
+
+        $data = $this->getBaseData();
+        $data['vpc_CardNum'] = $this->getCard()->getNumber();
+        $data['vpc_CardExp'] = $this->getCard()->getExpiryDate('ym');
+        $data['vpc_CardSecurityCode'] = $this->getCard()->getCvv();
+        $data['vpc_SecureHash']  = $this->calculateHash($data);
+
+        return $data;
+    }
+
+    public function send()
+    {
+        $httpResponse = $this->httpClient->post($this->getEndpoint(), null, $this->getData())->send();
+
+        return $this->response = new Response($this, $httpResponse->getBody());
+    }
+
+    public function getEndpoint()
+    {
+        return $this->endpoint.'vpcdps';
+    }
+}

src/Omnipay/Migs/ThreePartyGateway.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Omnipay package.
+ *
+ * (c) Adrian Macneil <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Omnipay\Migs;
+
+/**
+ * MIGS Gateway
+ *
+ * @link http://www.anz.com/australia/business/merchant/pdf/VPC-Dev-Kit-Integration-Notes.pdf
+ */
+class ThreePartyGateway extends TwoPartyGateway
+{
+    public function getName()
+    {
+        return 'MIGS 3-Party';
+    }
+
+    public function purchase(array $parameters = array())
+    {
+        return $this->createRequest('\Omnipay\Migs\Message\ThreePartyPurchaseRequest', $parameters);
+    }
+
+    public function completePurchase(array $parameters = array())
+    {
+        return $this->createRequest('\Omnipay\Migs\Message\ThreePartyCompletePurchaseRequest', $parameters);
+    }
+}