feature: Cancel support (#3)

Author: dkarlovi

src/Action/AuthorizeAction.php

@@ -51,14 +51,13 @@ public function execute($request)
         $this->gateway->execute($httpRequest);
 
         $authRequest = ArrayObject::ensureArrayObject($httpRequest->request);
-        $authRequest->validateNotEmpty(['paymentid', 'securitytoken', 'authorizationcode', 'responsecode', 'result']);
+        // $authRequest->validateNotEmpty(['paymentid', 'securitytoken', 'authorizationcode', 'responsecode', 'result']);
+        $authRequest->validateNotEmpty(['paymentid', 'result']);
 
         $details->replace($this->api->authorizeTransaction((array) $details, (array) $authRequest));
 
-        if ($details['authorization']) {
-            // TODO: we can communicate back with Setefi, what can we say here? Maybe a different response URL?
-            throw new HttpResponse('OK');
-        }
+        // TODO: we can communicate back with Setefi, what can we say here? Maybe a different response URL?
+        throw new HttpResponse('OK');
     }
 
     /**

src/Action/CancelAction.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Webburza\Payum\Setefi\Action;
+
+use Payum\Core\Action\ActionInterface;
+use Payum\Core\Bridge\Spl\ArrayObject;
+use Payum\Core\Exception\RequestNotSupportedException;
+use Payum\Core\GatewayAwareTrait;
+use Payum\Core\Request\Cancel;
+
+/**
+ * Class CancelAction.
+ */
+class CancelAction implements ActionInterface
+{
+    use GatewayAwareTrait;
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param Cancel $request
+     */
+    public function execute($request)
+    {
+        RequestNotSupportedException::assertSupports($this, $request);
+        $model = ArrayObject::ensureArrayObject($request->getModel());
+
+        $model['cancellation'] = true;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports($request)
+    {
+        return
+            $request instanceof Cancel &&
+            $request->getModel() instanceof \ArrayAccess;
+    }
+}

src/Action/CaptureAction.php

@@ -63,7 +63,7 @@ public function execute($request)
             // we're need to create the transaction on Setefi
             // and redirect the user there
             $this->gateway->execute(new CreateTransaction($details));
-        } elseif (null === $details['authorization']) {
+        } elseif (null === $details['authorization'] && null === $details['cancellation']) {
             // second pass
             // we're authorizing the transaction by a server-to-server request
             // this request is served to Setefi backend, NOT the returning user

src/Action/StatusAction.php

@@ -30,6 +30,12 @@ public function execute($request)
             return;
         }
 
+        if (true === isset($model['cancellation'])) {
+            $request->markCanceled();
+
+            return;
+        }
+
         if (true === isset($model['authorization'])) {
             $authorization = PaymentAuthorization::fromArray($model['authorization']);
             if ($authorization->isValid()) {

src/Api.php

@@ -31,6 +31,7 @@ class Api
     const PROPERTY_SECURITY_TOKEN = 'securitytoken';
 
     const STATUS_SUCCESS = '000';
+    const STATUS_CANCELED = '-1';
 
     private static $currencies = [
         self::CURRENCY_GBP => '826',
@@ -97,6 +98,12 @@ public function authorizeTransaction(array $model, array $authorizationRequest)
         $payment = Payment::fromArray($model['payment']);
         $authorization = PaymentAuthorization::fromSetefiResponse($authorizationRequest);
 
+        if (true === $authorization->isCanceled()) {
+            $model['cancellation'] = $authorization->toArray();
+
+            return $model;
+        }
+
         if (false === $payment->isMatchingAuthorization($authorization)) {
             throw new InvalidArgumentException('Invalid payment authorization');
         }

src/Response/PaymentAuthorization.php

@@ -22,18 +22,18 @@ class PaymentAuthorization
 
     /**
      * @param string $payment
+     * @param string $result
+     * @param string $code
      * @param string $token
      * @param string $authorization
-     * @param string $code
-     * @param string $result
      */
-    public function __construct($payment, $token, $authorization, $code, $result)
+    public function __construct($payment, $result, $code, $token = null, $authorization = null)
     {
         $this->payment = $payment;
+        $this->result = $result;
+        $this->code = $code;
         $this->token = $token;
         $this->authorization = $authorization;
-        $this->code = $code;
-        $this->result = $result;
     }
 
     /**
@@ -43,13 +43,13 @@ public function __construct($payment, $token, $authorization, $code, $result)
      */
     public static function fromSetefiResponse(array $response)
     {
-        return new self(
-            $response[Api::PROPERTY_PAYMENT_ID],
-            $response[Api::PROPERTY_SECURITY_TOKEN],
-            $response[Api::PROPERTY_AUTHORIZATION],
-            $response[Api::PROPERTY_RESPONSE_CODE],
-            $response[Api::PROPERTY_RESULT]
-        );
+        $payment = $response[Api::PROPERTY_PAYMENT_ID];
+        $result = $response[Api::PROPERTY_RESULT];
+        $code = isset($response[Api::PROPERTY_RESPONSE_CODE]) ? $response[Api::PROPERTY_RESPONSE_CODE] : Api::STATUS_CANCELED;
+        $token = isset($response[Api::PROPERTY_SECURITY_TOKEN]) ? $response[Api::PROPERTY_SECURITY_TOKEN] : null;
+        $authorization = isset($response[Api::PROPERTY_AUTHORIZATION]) ? $response[Api::PROPERTY_AUTHORIZATION] : null;
+
+        return new self($payment, $result, $code, $token, $authorization);
     }
 
     /**
@@ -61,10 +61,10 @@ public static function fromArray(array $array)
     {
         return new self(
             $array['payment'],
-            $array['token'],
-            $array['authorization'],
+            $array['result'],
             $array['code'],
-            $array['result']
+            $array['token'],
+            $array['authorization']
         );
     }
 
@@ -75,10 +75,10 @@ public function toArray()
     {
         return [
             'payment' => $this->payment,
+            'result' => $this->result,
+            'code' => $this->code,
             'token' => $this->token,
             'authorization' => $this->authorization,
-            'code' => $this->code,
-            'result' => $this->result,
         ];
     }
 
@@ -100,4 +100,12 @@ public function isValid()
     {
         return $this->code === Api::STATUS_SUCCESS;
     }
+
+    /**
+     * @return bool
+     */
+    public function isCanceled()
+    {
+        return $this->code === Api::STATUS_CANCELED;
+    }
 }

src/SetefiGatewayFactory.php

@@ -6,6 +6,7 @@
 use Payum\Core\GatewayFactory;
 use Webburza\Payum\Setefi\Action\AuthorizeAction;
 use Webburza\Payum\Setefi\Action\CaptureAction;
+use Webburza\Payum\Setefi\Action\CancelAction;
 use Webburza\Payum\Setefi\Action\ConvertPaymentAction;
 use Webburza\Payum\Setefi\Action\CreateTransactionAction;
 use Webburza\Payum\Setefi\Action\RefundAction;
@@ -31,6 +32,7 @@ protected function populateConfig(ArrayObject $config)
                 'payum.action.capture' => new CaptureAction(),
                 'payum.action.authorize' => new AuthorizeAction(),
                 'payum.action.refund' => new RefundAction(),
+                'payum.action.cancel' => new CancelAction(),
                 'payum.action.status' => new StatusAction(),
                 'payum.action.convert_payment' => new ConvertPaymentAction(),