Merge pull request #40 from andrextor/feature/redirect-request-metadata

feat: adds support for `metadata` and `provider` properties.

Author: dnetix

src/Message/CollectRequest.php

@@ -11,11 +11,18 @@ class CollectRequest extends RedirectRequest
     protected string $returnUrl = '';
     protected string $ipAddress = '';
     protected string $userAgent = '';
+    protected ?string $provider = null;
 
     public function __construct(array $data = [])
     {
         parent::__construct($data);
         $this->loadEntity($data['instrument'], 'instrument', Instrument::class);
+        $this->provider = $data['provider'] ?? null;
+    }
+
+    public function provider(): ?string
+    {
+        return $this->provider;
     }
 
     public function instrument(): Instrument
@@ -27,6 +34,7 @@ public function toArray(): array
     {
         return array_merge(parent::toArray(), [
             'instrument' => $this->instrument() ? $this->instrument()->toArray() : null,
+            'provider' => $this->provider(),
         ]);
     }
 }

src/Message/RedirectRequest.php

@@ -27,6 +27,8 @@ class RedirectRequest extends Entity
     protected bool $skipResult = false;
     protected bool $noBuyerFill = false;
 
+    protected array $metadata = [];
+
     public function __construct($data = [])
     {
         // Setting the default values
@@ -48,6 +50,8 @@ public function __construct($data = [])
         if (isset($data['fields'])) {
             $this->setFields($data['fields']);
         }
+
+        $this->metadata = $data['metadata'] ?? [];
     }
 
     public function locale(): string
@@ -177,6 +181,11 @@ public function noBuyerFill(): bool
         return filter_var($this->noBuyerFill, FILTER_VALIDATE_BOOLEAN);
     }
 
+    public function metadata(): array
+    {
+        return $this->metadata;
+    }
+
     public function toArray(): array
     {
         return $this->arrayFilter([
@@ -195,6 +204,7 @@ public function toArray(): array
             'captureAddress' => $this->captureAddress(),
             'skipResult' => $this->skipResult(),
             'noBuyerFill' => $this->noBuyerFill(),
+            'metadata' => $this->metadata(),
         ]);
     }
 }

tests/Messages/CollectRequestTest.php

@@ -43,6 +43,10 @@ public function testItParsesCorrectlyACollectWithCredit()
             'captureAddress' => false,
             'skipResult' => false,
             'noBuyerFill' => false,
+            'provider' => 'PROVIDER',
+            'metadata' => [
+                "initiatorIndicator" =>  "AGENT"
+            ]
         ];
         $request = new CollectRequest($data);
 
@@ -53,5 +57,8 @@ public function testItParsesCorrectlyACollectWithCredit()
 
         $this->assertEquals($data['instrument'], $request->instrument()->toArray());
         $this->assertEquals($data, $request->toArray());
+        $this->assertEquals($data['metadata'], $request->metadata());
+        $this->assertEquals($data['provider'], $request->provider());
+
     }
 }

tests/Messages/RedirectRequestTest.php

@@ -103,6 +103,9 @@ public function testItParsesCorrectlyAPaymentRequest()
             'noBuyerFill' => true,
             'captureAddress' => true,
             'paymentMethod' => 'CR_VS,_ATH_',
+            'metadata' => [
+                "initiatorIndicator" =>  "AGENT"
+            ],
         ];
         $request = new RedirectRequest($data);
 
@@ -112,6 +115,7 @@ public function testItParsesCorrectlyAPaymentRequest()
         $this->assertTrue($request->payment()->allowPartial());
         $this->assertEquals($data['returnUrl'], $request->returnUrl());
         $this->assertEquals($data['cancelUrl'], $request->cancelUrl());
+        $this->assertEquals($data['metadata'], $request->metadata());
 
         $this->assertEquals($data, $request->toArray());
     }