Merge pull request #91 from alma/develop

Release 2.0.4
alma · Feb 16, 2024 · ce024b0 · ce024b0
2 parents 2c73716 + 47a9de1
commit ce024b0
Show file tree

Hide file tree

Showing 6 changed files with 81 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+v2.0.4
+-------
+* Fix json_decode in getSubscriptionDetails
+* Add subscription pending_cancellation status 
+
 v2.0.3
 -------
 * Added order_id in subscription model

diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
   "name": "alma/alma-php-client",
   "description": "PHP API client for the Alma payments API",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "type": "library",
   "require": {
     "php": "^5.6 || ~7.0 || ~7.1 || ~7.2 || ~7.3 || ~7.4 || ~8.0 || ~8.1 || ~8.2",

diff --git a/src/Client.php b/src/Client.php
@@ -30,7 +30,7 @@
 
 class Client
 {
-    const VERSION = '2.0.3';
+    const VERSION = '2.0.4';
 
     const LIVE_MODE = 'live';
     const TEST_MODE = 'test';

diff --git a/src/Endpoints/Insurance.php b/src/Endpoints/Insurance.php
@@ -8,6 +8,7 @@
 use Alma\API\Exceptions\MissingKeyException;
 use Alma\API\Exceptions\ParametersException;
 use Alma\API\Exceptions\RequestException;
+use Alma\API\Exceptions\ResponseException;
 use Alma\API\Lib\ArrayUtils;
 use Alma\API\Lib\InsuranceValidator;
 use Alma\API\RequestError;
@@ -144,15 +145,17 @@ public function subscription(
     }
 
     /**
+     * @param $subscriptionIds
      * @return array json_decode in response constructor
-     * @throws RequestException
      * @throws ParametersException
      * @throws RequestError
+     * @throws RequestException
+     * @throws ResponseException
      */
     public function getSubscription($subscriptionIds)
     {
         $this->insuranceValidator->checkSubscriptionIds($subscriptionIds);
-          $response = $this->request(
+        $response = $this->request(
             self::INSURANCE_PATH . 'subscriptions'
         )->setQueryParams(
             $subscriptionIds
@@ -161,6 +164,10 @@ public function getSubscription($subscriptionIds)
         if ($response->isError()) {
             throw new RequestException($response->errorMessage, null, $response);
         }
+        $subscriptions = $response->json['subscriptions'];
+        if (!count($subscriptions)) {
+            throw new ResponseException('No data was found', 404);
+        }
 
         return $response->json;
     }
@@ -242,6 +249,7 @@ protected function buildSubscriptionData($subscriptionArray, $orderId, $paymentI
         ) {
             $subscriptionData['payment_id'] = $paymentId;
         }
+
         return $subscriptionData;
     }
 

diff --git a/src/Entities/Insurance/Subscription.php b/src/Entities/Insurance/Subscription.php
@@ -30,10 +30,11 @@ class Subscription
      */
     private $callbackUrl;
 
-    CONST STATE_STARTED = 'started';
-    CONST STATE_FAILED = 'failed';
-    CONST STATE_CANCELLED = 'canceled';
-    CONST STATE_PENDING = 'pending';
+    const STATE_STARTED = 'started';
+    const STATE_FAILED = 'failed';
+    const STATE_CANCELLED = 'canceled';
+    const STATE_PENDING = 'pending';
+    const STATE_PENDING_CANCELLATION = 'pending_cancellation';
 
     /**
      * @param string $contractId

diff --git a/tests/Unit/Legacy/Endpoints/InsuranceTest.php b/tests/Unit/Legacy/Endpoints/InsuranceTest.php
@@ -11,6 +11,7 @@
 use Alma\API\Exceptions\MissingKeyException;
 use Alma\API\Exceptions\ParametersException;
 use Alma\API\Exceptions\RequestException;
+use Alma\API\Exceptions\ResponseException;
 use Alma\API\Lib\ArrayUtils;
 use Alma\API\Lib\InsuranceValidator;
 use Alma\API\Request;
@@ -439,6 +440,23 @@ public function getSubscriptionsRightParamDataProvider()
         ];
     }
 
+    /**
+     * @return array[]
+     */
+    public function subscriptionIdInvalidDataProvider()
+    {
+        return [
+            'Test with subscription id invalid' => [
+                [
+                    'id' => 'toto'
+                ],
+                '{
+                    "subscriptions": []
+                }'
+            ]
+        ];
+    }
+
     /**
      * @return void
      */
@@ -728,26 +746,33 @@ public function testSubscriptionMethodExist()
      * @throws ParametersException
      * @throws RequestError
      * @throws RequestException
+     * @throws ResponseException
      */
-    public function testGetSubscriptionRequestIsCalled($subscriptionIds)
+    public function testGetSubscriptionRequestIsCalled($subscriptionIds, $json)
     {
+        $this->responseMock->json = json_decode($json, true);
         $this->responseMock->shouldReceive('isError')->once()->andReturn(false);
-        $this->requestObject->shouldReceive('setQueryParams')->once()->andReturn($this->requestObject);
         $this->requestObject->shouldReceive('get')->once()->andReturn($this->responseMock);
-        $this->insuranceValidatorMock->shouldReceive('checkSubscriptionIds')->once();
+        $this->requestObject->shouldReceive('setQueryParams')
+            ->once()
+            ->with($subscriptionIds)
+            ->andReturn($this->requestObject);
         $this->insuranceMock->shouldReceive('request')
             ->with(self::INSURANCE_SUBSCRIPTIONS_PATH)
             ->once()
             ->andReturn($this->requestObject);
 
+        $this->insuranceValidatorMock->shouldReceive('checkSubscriptionIds')->once();
         $this->insuranceMock->getSubscription($subscriptionIds);
     }
 
     /**
      * @dataProvider getSubscriptionsRightParamDataProvider
+     * @param $subscriptionIds
      * @throws ParametersException
      * @throws RequestError
      * @throws RequestException
+     * @throws ResponseException
      */
     public function testGetSubscriptionThrowExceptionIfResponseHasAnError($subscriptionIds)
     {
@@ -773,6 +798,7 @@ public function testGetSubscriptionThrowExceptionIfResponseHasAnError($subscript
      * @throws ParametersException
      * @throws RequestError
      * @throws RequestException
+     * @throws ResponseException
      */
     public function testGetSubscriptionThrowExceptionIfWeDontSendAnArray($subscriptionIds)
     {
@@ -795,7 +821,7 @@ public function testGetSubscriptionThrowExceptionIfWeDontSendAnArray($subscripti
      */
     public function testGetSubscriptionsReturnApiResponse($subscriptionIds, $json)
     {
-        $this->responseMock->json = $json;
+        $this->responseMock->json = json_decode($json, true);
         $this->responseMock->shouldReceive('isError')->once()->andReturn(false);
         $this->requestObject->shouldReceive('get')->once()->andReturn($this->responseMock);
         $this->requestObject->shouldReceive('setQueryParams')->once()->andReturn($this->requestObject);
@@ -805,7 +831,7 @@ public function testGetSubscriptionsReturnApiResponse($subscriptionIds, $json)
             ->andReturn($this->requestObject);
         $this->insuranceValidatorMock->shouldReceive('checkSubscriptionIds')->once();
 
-        $this->assertEquals($json, $this->insuranceMock->getSubscription($subscriptionIds));
+        $this->assertEquals($this->responseMock->json, $this->insuranceMock->getSubscription($subscriptionIds));
     }
 
     /**
@@ -917,4 +943,32 @@ public function cancelSubscriptionErrorPayloadDataProvider()
             ],
         ];
     }
+
+    /**
+     * @dataProvider subscriptionIdInvalidDataProvider
+     * @param $subscriptionIdInvalid
+     * @param $jsonReturnRequest
+     * @return void
+     * @throws ParametersException
+     * @throws RequestError
+     * @throws RequestException
+     */
+    public function testGetSubscriptionIfReturnZeroDataThrowException($subscriptionIdInvalid, $jsonReturnRequest)
+    {
+        $this->responseMock->json = json_decode($jsonReturnRequest, true);
+        $this->responseMock->shouldReceive('isError')->once()->andReturn(false);
+        $this->requestObject->shouldReceive('setQueryParams')->once()->andReturn($this->requestObject);
+        $this->requestObject->shouldReceive('get')->once()->andReturn($this->responseMock);
+        $this->insuranceMock->shouldReceive('request')
+            ->with(self::INSURANCE_SUBSCRIPTIONS_PATH)
+            ->once()
+            ->andReturn($this->requestObject);
+
+        $this->insuranceValidatorMock->shouldReceive('checkSubscriptionIds')
+            ->once()
+            ->with($subscriptionIdInvalid);
+
+        $this->expectException(ResponseException::class);
+        $this->insuranceMock->getSubscription($subscriptionIdInvalid);
+    }
 }