Merge pull request #9 from dachcom-digital/transaction_details

add GetTransactionDetailsAction

Author: solverat

Action/Api/GetTransactionDetailsAction.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace DachcomDigital\Payum\PostFinance\Flex\Action\Api;
+
+use DachcomDigital\Payum\PostFinance\Flex\Api;
+use DachcomDigital\Payum\PostFinance\Flex\Request\Api\GetTransactionDetails;
+use Payum\Core\Action\ActionInterface;
+use Payum\Core\ApiAwareInterface;
+use Payum\Core\ApiAwareTrait;
+use Payum\Core\Bridge\Spl\ArrayObject;
+use Payum\Core\Exception\LogicException;
+use Payum\Core\Exception\RequestNotSupportedException;
+use Payum\Core\GatewayAwareInterface;
+use Payum\Core\GatewayAwareTrait;
+
+class GetTransactionDetailsAction implements ActionInterface, GatewayAwareInterface, ApiAwareInterface
+{
+    use GatewayAwareTrait;
+    use ApiAwareTrait {
+        setApi as _setApi;
+    }
+
+    public function __construct()
+    {
+        $this->apiClass = Api::class;
+    }
+
+    public function setApi($api)
+    {
+        $this->_setApi($api);
+    }
+
+    /**
+     * @param $request GetTransactionDetails
+     */
+    public function execute($request)
+    {
+        RequestNotSupportedException::assertSupports($this, $request);
+        $model = ArrayObject::ensureArrayObject($request->getModel());
+
+        if ($model['transaction_id'] === null) {
+            throw new LogicException('transaction_id must be set.');
+        }
+
+        $transaction = $this->api->getEntity($model['transaction_id']);
+
+        $model->replace($this->api->createTransactionInfo($transaction));
+    }
+
+    public function supports($request): bool
+    {
+        return
+            $request instanceof GetTransactionDetails &&
+            $request->getModel() instanceof \ArrayAccess;
+    }
+}

Action/NotifyNullAction.php

@@ -3,17 +3,18 @@
 namespace DachcomDigital\Payum\PostFinance\Flex\Action;
 
 use DachcomDigital\Payum\PostFinance\Flex\Api;
+use DachcomDigital\Payum\PostFinance\Flex\Request\Api\GetTransactionDetails;
 use Payum\Core\Action\ActionInterface;
 use Payum\Core\ApiAwareInterface;
 use Payum\Core\ApiAwareTrait;
+use Payum\Core\Bridge\Spl\ArrayObject;
 use Payum\Core\Exception\RequestNotSupportedException;
 use Payum\Core\GatewayAwareInterface;
 use Payum\Core\GatewayAwareTrait;
 use Payum\Core\Reply\HttpResponse;
 use Payum\Core\Request\GetHttpRequest;
 use Payum\Core\Request\GetToken;
 use Payum\Core\Request\Notify;
-use PostFinanceCheckout\Sdk\Model\Transaction;
 
 class NotifyNullAction implements ActionInterface, ApiAwareInterface, GatewayAwareInterface
 {
@@ -53,13 +54,12 @@ public function execute($request)
                 return;
             }
 
-            $transaction = $this->api->getEntity($body['entityId']);
+            $model = new ArrayObject([]);
+            $model['transaction_id'] = $body['entityId'];
 
-            if (!$transaction instanceof Transaction) {
-                return;
-            }
+            $this->gateway->execute(new GetTransactionDetails($model));
 
-            $tokenHash = $transaction->getMetaData()['paymentToken'] ?? null;
+            $tokenHash = $model['meta_paymentToken'] ?? null;
 
         } catch (\Throwable $e) {
             throw new HttpResponse($e->getMessage(), 500, ['Content-Type' => 'text/plain', 'X-Notify-Message' => $e->getMessage()]);

Action/StatusAction.php

@@ -3,6 +3,7 @@
 namespace DachcomDigital\Payum\PostFinance\Flex\Action;
 
 use DachcomDigital\Payum\PostFinance\Flex\Api;
+use DachcomDigital\Payum\PostFinance\Flex\Request\Api\GetTransactionDetails;
 use Payum\Core\Action\ActionInterface;
 use Payum\Core\ApiAwareInterface;
 use Payum\Core\ApiAwareTrait;
@@ -11,7 +12,6 @@
 use Payum\Core\GatewayAwareInterface;
 use Payum\Core\GatewayAwareTrait;
 use Payum\Core\Request\GetStatusInterface;
-use PostFinanceCheckout\Sdk\Model\Transaction;
 use PostFinanceCheckout\Sdk\Model\TransactionState;
 
 class StatusAction implements ActionInterface, ApiAwareInterface, GatewayAwareInterface
@@ -46,14 +46,9 @@ public function execute($request)
             return;
         }
 
-        $transaction = $this->api->getEntity($model['transaction_id']);
-        if (!$transaction instanceof Transaction) {
-            $request->markUnknown();
-
-            return;
-        }
+        $this->gateway->execute(new GetTransactionDetails($model));
 
-        $state = $transaction->getState();
+        $state = $model['State'] ?? null;
 
         // @see https://checkout.postfinance.ch/doc/api/web-service#_transactionstate
 

Action/SyncAction.php

@@ -3,6 +3,7 @@
 namespace DachcomDigital\Payum\PostFinance\Flex\Action;
 
 use DachcomDigital\Payum\PostFinance\Flex\Api;
+use DachcomDigital\Payum\PostFinance\Flex\Request\Api\GetTransactionDetails;
 use Payum\Core\Action\ActionInterface;
 use Payum\Core\ApiAwareInterface;
 use Payum\Core\ApiAwareTrait;
@@ -11,7 +12,6 @@
 use Payum\Core\GatewayAwareInterface;
 use Payum\Core\GatewayAwareTrait;
 use Payum\Core\Request\Sync;
-use PostFinanceCheckout\Sdk\Model\Transaction;
 
 class SyncAction implements ActionInterface, ApiAwareInterface, GatewayAwareInterface
 {
@@ -43,12 +43,7 @@ public function execute($request)
             return;
         }
 
-        $transaction = $this->api->getEntity($model['transaction_id']);
-        if (!$transaction instanceof Transaction) {
-            return;
-        }
-
-        $model->replace($this->api->createTransactionInfo($transaction));
+       $this->gateway->execute(new GetTransactionDetails($model));
     }
 
     public function supports($request): bool

Api.php

@@ -105,6 +105,10 @@ public function createTransactionInfo(Transaction $transaction): array
             'getters'
         ];
 
+        $metaData = $transaction->getMetaData();
+
+        $data['meta_paymentToken'] = $metaData['paymentToken'] ?? null;
+
         foreach ($ref->getMethods() as $method) {
 
             $methodName = $method->getName();

PostFinanceFlexGatewayFactory.php

@@ -2,6 +2,7 @@
 
 namespace DachcomDigital\Payum\PostFinance\Flex;
 
+use DachcomDigital\Payum\PostFinance\Flex\Action\Api\GetTransactionDetailsAction;
 use DachcomDigital\Payum\PostFinance\Flex\Action\Api\RenderIframeAction;
 use DachcomDigital\Payum\PostFinance\Flex\Action\Api\RenderLightboxAction;
 use DachcomDigital\Payum\PostFinance\Flex\Action\Api\TransactionExtenderAction;
@@ -33,6 +34,7 @@ protected function populateConfig(ArrayObject $config): void
             'payum.action.convert_payment' => new ConvertPaymentAction(),
             'payum.action.sync'            => new SyncAction(),
 
+            'payum.action.api.get_transaction_details' => new GetTransactionDetailsAction(),
             'payum.action.api.transaction_extender'   => new TransactionExtenderAction(),
             'payum.action.api.initialize_transaction' => new CreateTransactionAction(),
             'payum.action.api.capture_offsite'        => new CaptureOffsiteAction(),

README.md

@@ -23,6 +23,9 @@ You need to define a global webhook: `https://your-domain.com/payment/notify/uns
 
 ## Changelog
 
+### 1.3.0
+- introduce `GetTransactionDetailsAction`
+
 ### 1.2.0
 - dependency `postfinancecheckout/sdk:^4.1` added
 - added `totalTaxes` to transaction extender to allow tax rates submission to line item

Request/Api/GetTransactionDetails.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace DachcomDigital\Payum\PostFinance\Flex\Request\Api;
+
+use Payum\Core\Request\Generic;
+
+class GetTransactionDetails extends Generic
+{
+}