Refactor response handling in payment re-query

Author: damms005

src/Services/PaymentHandlers/Paystack.php

@@ -96,7 +96,7 @@ public function reQuery(Payment $existingPayment): ?ReQuery
         try {
             $verificationResponse = $this->verifyPaystackTransaction($existingPayment->processor_transaction_reference);
         } catch (\Throwable $th) {
-            return new ReQuery($existingPayment, $th->getMessage());
+            return new ReQuery($existingPayment, ['error' => $th->getMessage()]);
         }
 
         // status should be true if there was a successful call
@@ -124,7 +124,7 @@ public function reQuery(Payment $existingPayment): ?ReQuery
 
         return new ReQuery(
             payment: $payment,
-            responseDescription: 'Response from gateway server: ' . json_encode((array)$verificationResponse),
+            responseDetails: (array)$verificationResponse,
         );
     }
 

src/Services/PaymentHandlers/Remita.php

@@ -158,7 +158,7 @@ public function reQuery(Payment $existingPayment): ?ReQuery
 
         return new ReQuery(
             payment: $payment,
-            responseDescription: 'Response from gateway server: ' . json_encode((array)$rrrQueryResponse),
+            responseDetails: (array)$rrrQueryResponse,
         );
     }
 

src/ValueObjects/ReQuery.php

@@ -8,6 +8,10 @@ class ReQuery
 {
     public function __construct(
         public Payment $payment,
-        public string $responseDescription,
+
+        /**
+         * An array of arbitrary shape based on the specific payment handler.
+         */
+        public array $responseDetails,
     ) {}
 }

tests/PaymentRequeryTest.php

@@ -33,7 +33,7 @@
         $mock->expects('reQuery')->andReturn(
             new ReQuery(
                 payment: new Payment(),
-                responseDescription: 'Successful',
+                responseDetails: ['status' => 'Successful'],
             ),
         );
 
@@ -52,7 +52,7 @@
         $mock->expects('reQuery')->andReturn(
             new ReQuery(
                 payment: new Payment(['is_success' => true]),
-                responseDescription: 'Successful',
+                responseDetails: ['status' => 'Successful'],
             ),
         );
 
@@ -76,7 +76,7 @@
         $mock->expects('reQuery')->andReturn(
             new ReQuery(
                 payment: new Payment(['is_success' => false]),
-                responseDescription: 'Went South!',
+                responseDetails: ['status' => 'Went South!'],
             ),
         );