Refactor Lunar transactions to use payment checks DTO (#1767)

lunarphp · May 23, 2024 · fe6108a · fe6108a
1 parent 631dedc
commit fe6108a
Show file tree

Hide file tree

Showing 10 changed files with 441 additions and 21 deletions.
diff --git a/docs/core/reference/payments.md b/docs/core/reference/payments.md
@@ -330,6 +330,20 @@ $order->charges; // Get all transactions that are charges.
 $order->refunds; // Get all transactions that are refunds.
 ```
 
+### Payment Checks
+
+Some providers return information based on checks that can occur before payment is validated and completed. 
+This is usually related to 3DSecure but in some cases can relate to credit checks or anything the payment provider has deemed relevant to the transaction.
+
+You can get access to these checks via the `paymentChecks()` method on the `Transaction`.
+
+```php
+foreach($transaction->paymentChecks() as $check) {
+    $check->successful;
+    $check->label;
+    $check->message;
+}
+```
 ## Payments
 
 We will be looking to add support for the most popular payment providers, so keep an eye out here as we will list them all out.

diff --git a/packages/admin/resources/views/infolists/components/transaction.blade.php b/packages/admin/resources/views/infolists/components/transaction.blade.php
@@ -19,7 +19,7 @@
         '!border-red-500 bg-red-50' => !$transaction->success,
         'bg-gray-50' => $transaction->success,
     ])
->    
+>
     <div class="p-2 space-y-2">
         <div class="px-4 py-2 rounded text-xs bg-white dark:bg-gray-800 shadow text-gray-600 dark:text-gray-400 ring-1 ring-gray-100 dark:ring-gray-700">
             <span>{{ $transaction->driver }}</span> //
@@ -53,7 +53,7 @@
                 @endif
             </div>
 
-            <strong 
+            <strong
                 @class([
                     "text-sm",
                     'text-red-500' => !$transaction->success,
@@ -75,26 +75,19 @@
                         class="w-4"
                     />
                 </div>
-
                 <span>{{ $transaction->created_at->format('jS F Y h:ia') }}</span>
             </div>
 
-            @if($threeD = $transaction->meta['threedSecure'] ?? null)
-                <div class="flex space-x-2">
-                    @foreach([
-                        'address' => 'Address',
-                        'postalCode' => 'Postal Code',
-                        'securityCode' => 'Security Code',
-                    ] as $metaKey => $metaLabel)
-                        <x-filament::badge
-                            :icon="$threeD[$metaKey] ?? false ? 'heroicon-m-check' : 'heroicon-m-x-mark'"
-                            :color="$threeD[$metaKey] ?? false ? \Filament\Support\Colors\Color::Sky : 'gray'"
-                        >
-                            {{ $metaLabel }}
-                        </x-filament::badge>
-                    @endforeach
-                </div>
-            @endif
+            <div class="flex space-x-2">
+            @foreach($transaction->paymentChecks() as $check)
+                    <x-filament::badge
+                        :icon="$check->successful ? 'heroicon-m-check' : 'heroicon-m-x-mark'"
+                        :color="$check->successful ?  \Filament\Support\Colors\Color::Sky : 'gray'"
+                    >
+                        {{ $check->label }}: {{ $check->message }}
+                    </x-filament::badge>
+            @endforeach
+            </div>
         </div>
 
         @if($transaction->notes)
@@ -111,7 +104,7 @@ class="w-4"
         @endif
     </div>
 
-    <div 
+    <div
         @class([
             "bottom-0 left-0 block w-full text-center rounded-b-lg border-t text-xs py-1",
             "!bg-red-50 !dark:bg-red-400/10 !border-red-300 !text-red-600 !dark:text-red-400" => !$transaction->success,

diff --git a/packages/core/src/Base/DataTransferObjects/PaymentCheck.php b/packages/core/src/Base/DataTransferObjects/PaymentCheck.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Lunar\Base\DataTransferObjects;
+
+class PaymentCheck
+{
+    public function __construct(
+        public bool $successful,
+        public string $label,
+        public string $message
+    ) {
+    }
+}
diff --git a/packages/core/src/Base/DataTransferObjects/PaymentChecks.php b/packages/core/src/Base/DataTransferObjects/PaymentChecks.php
@@ -0,0 +1,69 @@
+<?php
+
+namespace Lunar\Base\DataTransferObjects;
+
+class PaymentChecks implements \ArrayAccess, \Iterator
+{
+    private int $position = 0;
+
+    protected array $checks = [];
+
+    public function addCheck(PaymentCheck $check): void
+    {
+        $this->checks[] = $check;
+    }
+
+    public function getChecks(): array
+    {
+        return $this->checks;
+    }
+
+    public function current(): PaymentCheck
+    {
+        return $this->checks[$this->position];
+    }
+
+    public function next(): void
+    {
+        $this->position++;
+    }
+
+    public function key(): mixed
+    {
+        return $this->position;
+    }
+
+    public function valid(): bool
+    {
+        return isset($this->checks[$this->position]);
+    }
+
+    public function rewind(): void
+    {
+        $this->position = 0;
+    }
+
+    public function offsetExists(mixed $offset): bool
+    {
+        return isset($this->checks[$offset]);
+    }
+
+    public function offsetGet(mixed $offset): mixed
+    {
+        return $this->checks[$offset];
+    }
+
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
+        if (is_null($offset)) {
+            $this->checks[] = $value;
+        } else {
+            $this->checks[$offset] = $value;
+        }
+    }
+
+    public function offsetUnset(mixed $offset): void
+    {
+        unset($this->checks[$offset]);
+    }
+}
diff --git a/packages/core/src/Models/Transaction.php b/packages/core/src/Models/Transaction.php
@@ -87,6 +87,11 @@ public function driver()
         return Payments::driver($this->driver);
     }
 
+    public function paymentChecks()
+    {
+        return $this->driver()->getPaymentChecks($this);
+    }
+
     public function refund(int $amount, $notes = null)
     {
         return $this->driver()->refund($this, $amount, $notes);

diff --git a/packages/core/src/PaymentTypes/AbstractPayment.php b/packages/core/src/PaymentTypes/AbstractPayment.php
@@ -2,9 +2,11 @@
 
 namespace Lunar\PaymentTypes;
 
+use Lunar\Base\DataTransferObjects\PaymentChecks;
 use Lunar\Base\PaymentTypeInterface;
 use Lunar\Models\Cart;
 use Lunar\Models\Order;
+use Lunar\Models\Transaction;
 
 abstract class AbstractPayment implements PaymentTypeInterface
 {
@@ -71,4 +73,9 @@ public function setConfig(array $config): self
 
         return $this;
     }
+
+    public function getPaymentChecks(Transaction $transaction): PaymentChecks
+    {
+        return new PaymentChecks;
+    }
 }
diff --git a/packages/opayo/src/OpayoPaymentType.php b/packages/opayo/src/OpayoPaymentType.php
@@ -4,6 +4,8 @@
 
 use Illuminate\Support\Str;
 use Lunar\Base\DataTransferObjects\PaymentCapture;
+use Lunar\Base\DataTransferObjects\PaymentCheck;
+use Lunar\Base\DataTransferObjects\PaymentChecks;
 use Lunar\Base\DataTransferObjects\PaymentRefund;
 use Lunar\Events\PaymentAttemptEvent;
 use Lunar\Models\Order;
@@ -421,6 +423,82 @@ public function setPolicy(mixed $policy): void
         $this->policy = $policy;
     }
 
+    public function getPaymentChecks(Transaction $transaction): PaymentChecks
+    {
+        $meta = $transaction->meta['threedSecure'] ?? null;
+
+        $checks = new PaymentChecks;
+
+        if (! $meta) {
+            return $checks;
+        }
+
+        if (isset($meta['address'])) {
+            $message = $meta['address'];
+            $successful = $meta['address'] == 'Matched';
+
+            if (is_bool($message) && ! $message) {
+                $message = 'NotMatched';
+                $successful = false;
+            }
+            if (is_bool($message) && $message) {
+                $message = 'Matched';
+                $successful = true;
+            }
+            $checks->addCheck(
+                new PaymentCheck(
+                    successful: $successful,
+                    label: 'Address',
+                    message: $message,
+                )
+            );
+        }
+
+        if (isset($meta['postalCode'])) {
+            $message = $meta['postalCode'];
+            $successful = $meta['postalCode'] == 'Matched';
+
+            if (is_bool($message) && ! $message) {
+                $message = 'NotMatched';
+                $successful = false;
+            }
+            if (is_bool($message) && $message) {
+                $message = 'Matched';
+                $successful = true;
+            }
+            $checks->addCheck(
+                new PaymentCheck(
+                    successful: $successful,
+                    label: 'Postal Code',
+                    message: $message,
+                )
+            );
+        }
+
+        if (isset($meta['securityCode'])) {
+            $message = $meta['securityCode'];
+            $successful = $meta['securityCode'] == 'Matched';
+
+            if (is_bool($message) && ! $message) {
+                $message = 'NotMatched';
+                $successful = false;
+            }
+            if (is_bool($message) && $message) {
+                $message = 'Matched';
+                $successful = true;
+            }
+            $checks->addCheck(
+                new PaymentCheck(
+                    successful: $successful,
+                    label: 'Security Code',
+                    message: $message,
+                )
+            );
+        }
+
+        return $checks;
+    }
+
     private function saveCard(Order $order, object $details, string $authCode = null)
     {
         if (! $order->user_id) {

diff --git a/packages/stripe/src/StripePaymentType.php b/packages/stripe/src/StripePaymentType.php
@@ -4,6 +4,8 @@
 
 use Lunar\Base\DataTransferObjects\PaymentAuthorize;
 use Lunar\Base\DataTransferObjects\PaymentCapture;
+use Lunar\Base\DataTransferObjects\PaymentCheck;
+use Lunar\Base\DataTransferObjects\PaymentChecks;
 use Lunar\Base\DataTransferObjects\PaymentRefund;
 use Lunar\Events\PaymentAttemptEvent;
 use Lunar\Exceptions\DisallowMultipleCartOrdersException;
@@ -193,4 +195,43 @@ public function refund(Transaction $transaction, int $amount = 0, $notes = null)
             success: true
         );
     }
+
+    public function getPaymentChecks(Transaction $transaction): PaymentChecks
+    {
+        $meta = $transaction->meta;
+
+        $checks = new PaymentChecks;
+
+        if (isset($meta['address_line1_check'])) {
+            $checks->addCheck(
+                new PaymentCheck(
+                    successful: $meta['address_line1_check'] == 'pass',
+                    label: 'Address Line 1',
+                    message: $meta['address_line1_check'],
+                )
+            );
+        }
+
+        if (isset($meta['address_postal_code_check'])) {
+            $checks->addCheck(
+                new PaymentCheck(
+                    successful: $meta['address_postal_code_check'] == 'pass',
+                    label: 'Postal Code',
+                    message: $meta['address_postal_code_check'],
+                )
+            );
+        }
+
+        if (isset($meta['cvc_check'])) {
+            $checks->addCheck(
+                new PaymentCheck(
+                    successful: $meta['cvc_check'] == 'pass',
+                    label: 'CVC Check',
+                    message: $meta['cvc_check'],
+                )
+            );
+        }
+
+        return $checks;
+    }
 }