Merge pull request #22 from utopia-php/feat-disputes

Feat: list disputes

Author: lohanidamodar

src/Pay/Adapter.php

@@ -250,6 +250,17 @@ abstract public function updateFuturePayment(string $id, ?string $customerId = n
      */
     abstract public function getMandate(string $id): array;
 
+    /**
+     * List disputes
+     *
+     * @param  int|null  $limit
+     * @param  string|null  $paymentIntentId
+     * @param  string|null  $chargeId
+     * @param  int|null  $createdAfter
+     * @return array
+     */
+    abstract public function listDisputes(?int $limit = null, ?string $paymentIntentId = null, ?string $chargeId = null, ?int $createdAfter = null): array;
+
     /**
      * Call
      * Make a request
@@ -265,8 +276,9 @@ protected function call(string $method, string $url, array $params = [], array $
     {
         $responseHeaders = [];
         $ch = \curl_init();
+        $query = null;
 
-        switch ($headers['content-type']) {
+        switch ($headers['content-type'] ?? null) {
             case 'application/json':
                 $query = json_encode($params);
                 break;
@@ -304,7 +316,7 @@ protected function call(string $method, string $url, array $params = [], array $
 
             return $len;
         });
-        if ($method != self::METHOD_GET && $method != self::METHOD_DELETE) {
+        if (! empty($query)) {
             curl_setopt($ch, CURLOPT_POSTFIELDS, $query);
         }
 

src/Pay/Adapter/Stripe.php

@@ -332,6 +332,41 @@ public function getMandate(string $id): array
         return $this->execute(self::METHOD_GET, $path);
     }
 
+    /**
+     * List disputes
+     *
+     * @param  int|null  $limit
+     * @param  string|null  $paymentIntentId
+     * @param  string|null  $chargeId
+     * @param  int|null  $createdAfter
+     * @return array
+     */
+    public function listDisputes(?int $limit = null, ?string $paymentIntentId = null, ?string $chargeId = null, ?int $createdAfter = null): array
+    {
+        $path = '/disputes';
+        $requestBody = [];
+
+        if ($limit !== null) {
+            $requestBody['limit'] = $limit;
+        }
+
+        if ($paymentIntentId !== null) {
+            $requestBody['payment_intent'] = $paymentIntentId;
+        }
+        if ($chargeId !== null) {
+            $requestBody['charge'] = $chargeId;
+        }
+        if ($createdAfter !== null) {
+            $requestBody['created'] = [
+                'gte' => $createdAfter,
+            ];
+        }
+
+        $result = $this->execute(self::METHOD_GET, $path, $requestBody);
+
+        return $result['data'];
+    }
+
     /**
      * Execute
      *
@@ -343,7 +378,12 @@ public function getMandate(string $id): array
      */
     private function execute(string $method, string $path, array $requestBody = [], array $headers = []): array
     {
-        $headers = array_merge(['content-type' => 'application/x-www-form-urlencoded', 'Authorization' => 'Bearer '.$this->secretKey], $headers);
+        $defaultHeaders = ['Authorization' => 'Bearer '.$this->secretKey];
+
+        if ($method !== self::METHOD_GET) {
+            $defaultHeaders['content-type'] = 'application/x-www-form-urlencoded';
+        }
+        $headers = array_merge($defaultHeaders, $headers);
 
         return $this->call($method, $this->baseUrl.$path, $requestBody, $headers);
     }

src/Pay/Pay.php

@@ -312,4 +312,18 @@ public function getMandate(string $id): array
     {
         return $this->adapter->getMandate($id);
     }
+
+    /**
+     * List disputes
+     *
+     * @param  int|null  $limit
+     * @param  string|null  $paymentIntentId
+     * @param  string|null  $chargeId
+     * @param  int|null  $createdAfter
+     * @return array
+     */
+    public function listDisputes(?int $limit = null, ?string $paymentIntentId = null, ?string $chargeId = null, ?int $createdAfter = null): array
+    {
+        return $this->adapter->listDisputes($limit, $paymentIntentId, $chargeId, $createdAfter);
+    }
 }

tests/Pay/Adapter/StripeTest.php

@@ -355,6 +355,55 @@ public function testDeleteCustomer(array $data): void
         $this->assertTrue($res['deleted']);
     }
 
+    /**
+     * Test list disputes
+     *
+     * @param  array  $data
+     * @return void
+     */
+    public function testListDisputes(): void
+    {
+        $customer = $this->stripe->createCustomer('Test customer', 'testcustomer@email.com', ['city' => 'Kathmandu', 'country' => 'NP', 'line1' => 'Gaurighat', 'line2' => 'Pambu Marga', 'postal_code' => '44600', 'state' => 'Bagmati']);
+        $this->assertNotEmpty($customer['id']);
+        $customerId = $customer['id'];
+
+        $pm = $this->stripe->createPaymentMethod($customerId, 'card', [
+            'number' => 4000000000000259,
+            'exp_month' => 8,
+            'exp_year' => 2030,
+            'cvc' => 123,
+        ]);
+        $this->assertNotEmpty($pm['id']);
+        $this->assertNotEmpty($pm['card']);
+
+        $card = $pm['card'];
+        $this->assertEquals('visa', $card['brand']);
+        $this->assertEquals('US', $card['country']);
+        $this->assertEquals(2030, $card['exp_year']);
+        $this->assertEquals(8, $card['exp_month']);
+        $this->assertEquals('0259', $card['last4']);
+
+        $paymentMethodId = $pm['id'];
+
+        $purchase = $this->stripe->purchase(5000, $customerId, $paymentMethodId);
+
+        $this->assertNotEmpty($purchase['id']);
+        $this->assertEquals(5000, $purchase['amount_received']);
+        $this->assertEquals('payment_intent', $purchase['object']);
+        $this->assertEquals('succeeded', $purchase['status']);
+
+        // list disputes
+        $paymentIntentId = $purchase['id'];
+
+        $disputes = $this->stripe->listDisputes(1);
+        $this->assertIsArray($disputes);
+        $this->assertEquals(1, count($disputes));
+
+        $disputes = $this->stripe->listDisputes(paymentIntentId: $paymentIntentId);
+        $this->assertEquals(1, count($disputes));
+        $this->assertEquals($paymentIntentId, $disputes[0]['payment_intent']);
+    }
+
     public function testErrorHandling(): void
     {
         try {