feat: void request

Author: recca0120

src/Gateway.php

@@ -10,14 +10,14 @@
 use Omnipay\ECPay\Message\FetchTransactionRequest;
 use Omnipay\ECPay\Message\PurchaseRequest;
 use Omnipay\ECPay\Message\RefundRequest;
+use Omnipay\ECPay\Message\VoidRequest;
 use Omnipay\ECPay\Traits\HasDefaults;
 
 /**
  * Skeleton Gateway.
  * @method RequestInterface authorize(array $options = [])
  * @method RequestInterface completeAuthorize(array $options = [])
  * @method RequestInterface capture(array $options = [])
- * @method RequestInterface void(array $options = [])
  * @method RequestInterface createCard(array $options = [])
  * @method RequestInterface updateCard(array $options = [])
  * @method RequestInterface deleteCard(array $options = [])
@@ -86,4 +86,9 @@ public function refund(array $options = [])
     {
         return $this->createRequest(RefundRequest::class, $options);
     }
+
+    public function void(array $options = [])
+    {
+        return $this->createRequest(VoidRequest::class, $options);
+    }
 }

src/Message/RefundRequest.php

@@ -28,7 +28,7 @@ public function getTradeNo()
 
     public function getData()
     {
-        $this->validate('transactionId', 'transactionReference');
+        $this->validate('transactionId', 'transactionReference', 'amount');
 
         return [
             'MerchantTradeNo' => $this->getTransactionId(),
@@ -40,7 +40,7 @@ public function getData()
 
     public function sendData($data)
     {
-        return $this->response = new RefundResponse($this, $this->doAction($data));
+        return $this->response = new VoidOrRefundResponse($this, $this->doAction($data));
     }
 
     /**

src/Message/RefundResponse.php renamed to src/Message/VoidOrRefundResponse.php

@@ -2,7 +2,7 @@
 
 namespace Omnipay\ECPay\Message;
 
-class RefundResponse extends AbstractResponse
+class VoidOrRefundResponse extends AbstractResponse
 {
     /**
      * Is the response successful?

src/Message/VoidRequest.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Omnipay\ECPay\Message;
+
+use ECPay_ActionType;
+
+class VoidRequest extends RefundRequest
+{
+    public function setAction($value)
+    {
+        return $this->setParameter('action', $value);
+    }
+
+    public function getAction()
+    {
+        return $this->getParameter('action') ?: ECPay_ActionType::N;
+    }
+
+    public function getData()
+    {
+        $this->validate('transactionId', 'transactionReference', 'amount');
+
+        return [
+            'MerchantTradeNo' => $this->getTransactionId(),
+            'TradeNo' => $this->getTransactionReference(),
+            'Action' => $this->getAction(),
+            'TotalAmount' => $this->getAmount(),
+        ];
+    }
+}

tests/GatewayTest.php

@@ -114,7 +114,20 @@ public function testRefund()
         ]))->send();
 
         self::assertTrue($response->isSuccessful());
+        self::assertEquals('1909021549160081', $response->getTransactionReference());
+        self::assertEquals('2821567410556', $response->getTransactionId());
+    }
+
+    public function testVoid()
+    {
+        $response = $this->gateway->void(array_merge($this->options, [
+            'transactionReference' => '1909021549160081',
+            'transactionId' => '2821567410556',
+            'amount' => 1000,
+        ]))->send();
+
         self::assertTrue($response->isSuccessful());
-        self::assertTrue($response->isSuccessful());
+        self::assertEquals('1909021549160081', $response->getTransactionReference());
+        self::assertEquals('2821567410556', $response->getTransactionId());
     }
 }

tests/Message/RefundRequestTest.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Omnipay\ECPay\Tests\Message;
+
+use Omnipay\ECPay\Tests\Stubs\StubRefundRequest;
+use Omnipay\Tests\TestCase;
+
+class RefundRequestTest extends TestCase
+{
+    public function testGetData()
+    {
+        $options = [
+            'MerchantID' => '2000132',
+            'MerchantTradeNo' => '2821567410556',
+            'TradeNo' => '1909021549160081',
+            'TotalAmount' => 1000,
+        ];
+        $request = new StubRefundRequest($this->getHttpClient(), $this->getHttpRequest());
+        $request->initialize($options);
+
+        self::assertEquals([
+            'MerchantTradeNo' => '2821567410556',
+            'TradeNo' => '1909021549160081',
+            'Action' => 'R',
+            'TotalAmount' => '1000.00',
+        ], $request->getData());
+    }
+}

tests/Message/VoidRequestTest.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Omnipay\ECPay\Tests\Message;
+
+use Omnipay\ECPay\Tests\Stubs\StubVoidRequest;
+use Omnipay\Tests\TestCase;
+
+class VoidRequestTest extends TestCase
+{
+    public function testGetData()
+    {
+        $options = [
+            'MerchantID' => '2000132',
+            'MerchantTradeNo' => '2821567410556',
+            'TradeNo' => '1909021549160081',
+            'TotalAmount' => 1000,
+        ];
+        $request = new StubVoidRequest($this->getHttpClient(), $this->getHttpRequest());
+        $request->initialize($options);
+
+        self::assertEquals([
+            'MerchantTradeNo' => '2821567410556',
+            'TradeNo' => '1909021549160081',
+            'Action' => 'N',
+            'TotalAmount' => '1000.00',
+        ], $request->getData());
+    }
+}

tests/Stubs/StubGateway.php

@@ -24,4 +24,13 @@ public function refund(array $options = [])
     {
         return $this->createRequest(StubRefundRequest::class, $options);
     }
+
+    /**
+     * @param array $options
+     * @return RequestInterface
+     */
+    public function void(array $options = [])
+    {
+        return $this->createRequest(StubVoidRequest::class, $options);
+    }
 }

tests/Stubs/StubVoidRequest.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Omnipay\ECPay\Tests\Stubs;
+
+use Omnipay\ECPay\Message\VoidRequest;
+
+class StubVoidRequest extends VoidRequest
+{
+    /**
+     * @param array $data
+     * @return array
+     */
+    protected function doAction($data)
+    {
+        return [
+            'MerchantID' => $this->getMerchantID(),
+            'MerchantTradeNo' => $data['MerchantTradeNo'],
+            'TradeNo' => $data['TradeNo'],
+            'RtnCode' => '1',
+            'RtnMsg' => '',
+        ];
+    }
+}