Add support for secureXML echo test messages

Author: Andrew Keynes

src/Message/SecureXMLAbstractRequest.php

@@ -10,6 +10,8 @@ abstract class SecureXMLAbstractRequest extends AbstractRequest
     public $testEndpoint = 'https://test.securepay.com.au/xmlapi/payment';
     public $liveEndpoint = 'https://api.securepay.com.au/xmlapi/payment';
 
+    protected $requestType = 'Payment';
+
     /**
      * Set the messageID on the request.
      *
@@ -67,7 +69,19 @@ protected function getBaseXML()
         $merchantInfo->addChild('merchantID', $this->getMerchantId());
         $merchantInfo->addChild('password', $this->getTransactionPassword());
 
-        $xml->addChild('RequestType', 'Payment'); // Not related to the transaction type
+        $xml->addChild('RequestType', $this->requestType); // Not related to the transaction type
+
+        return $xml;
+    }
+
+    /**
+     * XML template of a SecurePayMessage Payment.
+     *
+     * @return \SimpleXMLElement SecurePayMessage with transaction details.
+     */
+    protected function getBasePaymentXML()
+    {
+        $xml = $this->getBaseXML();
 
         $payment = $xml->addChild('Payment');
         $txnList = $payment->addChild('TxnList');
@@ -85,13 +99,14 @@ protected function getBaseXML()
     }
 
     /**
-     * @return \SimpleXMLElement SecurePayMessage with card details.
+     * @return \SimpleXMLElement SecurePayMessage with transaction and card
+     * details.
      */
-    protected function getBaseXMLWithCard()
+    protected function getBasePaymentXMLWithCard()
     {
         $this->getCard()->validate();
 
-        $xml = $this->getBaseXML();
+        $xml = $this->getBasePaymentXML();
 
         $card = $xml->Payment->TxnList->Txn->addChild('CreditCardInfo');
         $card->addChild('cardNumber', $this->getCard()->getNumber());

src/Message/SecureXMLAuthorizeRequest.php

@@ -17,6 +17,6 @@ class SecureXMLAuthorizeRequest extends SecureXMLAbstractRequest
 
     public function getData()
     {
-        return $this->getBaseXMLWithCard();
+        return $this->getBasePaymentXMLWithCard();
     }
 }

src/Message/SecureXMLCaptureRequest.php

@@ -18,7 +18,7 @@ class SecureXMLCaptureRequest extends SecureXMLAbstractRequest
 
     public function getData()
     {
-        $xml = $this->getBaseXML();
+        $xml = $this->getBasePaymentXML();
 
         $xml->Payment->TxnList->Txn->addChild('preauthID', $this->getPreauthId());
 

src/Message/SecureXMLEchoTestRequest.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Omnipay\SecurePay\Message;
+
+/**
+ * SecurePay SecureXML Echo Request.
+ *
+ * Echo requests are used to verify that the SecurePay payment server is
+ * available.
+ *
+ * The status code returned in the response will be '000' if the service is up.
+ */
+class SecureXMLEchoTestRequest extends SecureXMLAbstractRequest
+{
+    protected $requestType = 'Echo';
+    protected $requiredFields = [];
+
+    public function getData()
+    {
+        return $this->getBaseXML();
+    }
+}

src/Message/SecureXMLPurchaseRequest.php

@@ -12,6 +12,6 @@ class SecureXMLPurchaseRequest extends SecureXMLAbstractRequest
 
     public function getData()
     {
-        return $this->getBaseXMLWithCard();
+        return $this->getBasePaymentXMLWithCard();
     }
 }

src/Message/SecureXMLRefundRequest.php

@@ -17,7 +17,7 @@ class SecureXMLRefundRequest extends SecureXMLAbstractRequest
 
     public function getData()
     {
-        $xml = $this->getBaseXML();
+        $xml = $this->getBasePaymentXML();
         $xml->Payment->TxnList->Txn->addChild('txnID', $this->getTransactionReference());
 
         return $xml;

src/SecureXMLGateway.php

@@ -102,4 +102,9 @@ public function refund(array $parameters = array())
     {
         return $this->createRequest('\Omnipay\SecurePay\Message\SecureXMLRefundRequest', $parameters);
     }
+
+    public function echoTest(array $parameters = array())
+    {
+        return $this->createRequest('\Omnipay\SecurePay\Message\SecureXMLEchoTestRequest', $parameters);
+    }
 }

tests/Message/SecureXMLEchoTestRequestTest.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Omnipay\SecurePay\Message;
+
+use Omnipay\Tests\TestCase;
+
+class SecureXMLEchoTestRequestTest extends TestCase
+{
+    public function setUp()
+    {
+        $this->request = new SecureXMLEchoTestRequest($this->getHttpClient(), $this->getHttpRequest());
+
+        $this->request->initialize(
+            array(
+                'merchantId' => 'ABC0030',
+                'transactionPassword' => 'abc123',
+            )
+        );
+    }
+
+    public function testSuccess()
+    {
+        $this->setMockHttpResponse('SecureXMLEchoTestRequestSuccess.txt');
+        $response = $this->request->send();
+        $data = $response->getData();
+
+        $this->assertInstanceOf('Omnipay\\SecurePay\\Message\\SecureXMLResponse', $response);
+
+        $this->assertTrue($response->isSuccessful());
+        $this->assertFalse($response->isRedirect());
+        $this->assertSame('000', $response->getCode());
+        $this->assertSame('Normal', $response->getMessage());
+    }
+}

tests/Mock/SecureXMLEchoTestRequestSuccess.txt

@@ -0,0 +1,22 @@
+HTTP/1.1 100 Continue
+Server: Microsoft-IIS/5.0
+Date: Mon, 19 Apr 2004 06:19:48 GMT
+HTTP/1.1 200 OK
+Server: Microsoft-IIS/5.0
+Date: Mon, 19 Apr 2004 06:20:01 GMT
+Content-Type: text/xml;charset=ISO-8859-1
+Content-Length: 929
+
+<?xml version="1.0" encoding="UTF-8"?>
+<SecurePayMessage>
+<MessageInfo>
+<messageID>8af793f9af34bea0cf40f5fb79f383</messageID>
+<messageTimestamp>20042403095956732000+660</messageTimestamp>
+<apiVersion>xml-4.2</apiVersion>
+</MessageInfo>
+<RequestType>Echo</RequestType>
+<Status>
+<statusCode>000</statusCode>
+<statusDescription>Normal</statusDescription>
+</Status>
+</SecurePayMessage>