Merge pull request #86 from alma/develop

Release 2.0.3
alma · Feb 14, 2024 · 2c73716 · 2c73716
2 parents 336845d + 962cbbc
commit 2c73716
Show file tree

Hide file tree

Showing 8 changed files with 475 additions and 82 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+v2.0.3
+-------
+* Added order_id in subscription model
+* Added sendCustomerCart endpoint Insurance
+* Added cancelSubscription endpoint Insurance
+
 v2.0.2
 -------
 * Added getSubscription endpoint Insurance

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.2",
+  "version": "2.0.3",
   "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.2';
+    const VERSION = '2.0.3';
 
     const LIVE_MODE = 'live';
     const TEST_MODE = 'test';

diff --git a/src/Endpoints/Base.php b/src/Endpoints/Base.php
@@ -41,7 +41,6 @@ class Base
     public function __construct($client_context)
     {
         $this->setClientContext($client_context);
-        $this->logger = $client_context->logger;
     }
 
     /**
@@ -60,5 +59,6 @@ public function request($path)
     public function setClientContext($clientContext)
     {
         $this->clientContext = $clientContext;
+        $this->logger = $clientContext->logger;
     }
 }
diff --git a/src/Endpoints/Insurance.php b/src/Endpoints/Insurance.php
@@ -102,6 +102,7 @@ public function checkParameters($cmsReference, $insuranceContractExternalId, $pr
 
     /**
      * @param $subscriptionArray
+     * @param string $orderId
      * @param null $paymentId
      * @param string | null $customerSessionId
      * @param string | null $cartId
@@ -110,7 +111,13 @@ public function checkParameters($cmsReference, $insuranceContractExternalId, $pr
      * @throws RequestError
      * @throws RequestException
      */
-    public function subscription($subscriptionArray, $paymentId = null, $customerSessionId = null, $cartId = null)
+    public function subscription(
+        $subscriptionArray,
+        $orderId,
+        $paymentId = null,
+        $customerSessionId = null,
+        $cartId = null
+    )
     {
 
         if (!is_array($subscriptionArray)) {
@@ -122,7 +129,7 @@ public function subscription($subscriptionArray, $paymentId = null, $customerSes
             );
         }
 
-        $subscriptionData = $this->buildSubscriptionData($subscriptionArray, $paymentId);
+        $subscriptionData = $this->buildSubscriptionData($subscriptionArray, $orderId, $paymentId);
         $request = $this->request(self::INSURANCE_PATH . 'subscriptions')
             ->setRequestBody($subscriptionData);
 
@@ -137,15 +144,15 @@ public function subscription($subscriptionArray, $paymentId = null, $customerSes
     }
 
     /**
-     * @throws RequestError
+     * @return array json_decode in response constructor
      * @throws RequestException
      * @throws ParametersException
-     * @return array json_decode in response constructor
+     * @throws RequestError
      */
     public function getSubscription($subscriptionIds)
     {
         $this->insuranceValidator->checkSubscriptionIds($subscriptionIds);
-        $response = $this->request(
+          $response = $this->request(
             self::INSURANCE_PATH . 'subscriptions'
         )->setQueryParams(
             $subscriptionIds
@@ -158,15 +165,41 @@ public function getSubscription($subscriptionIds)
         return $response->json;
     }
 
+    /**
+     * @param $cmsReferenceArray
+     * @param $cartId
+     * @return void
+     * @throws RequestError
+     */
+    public function sendCustomerCart($cmsReferenceArray, $cartId)
+    {
+        try {
+            $this->insuranceValidator->checkCmsReference($cmsReferenceArray);
+            $request = $this->request(self::INSURANCE_PATH . 'customer-cart')
+                ->setRequestBody(
+                    [
+                        'cms_references' => $cmsReferenceArray
+                    ]
+                );
+
+            $this->addCustomerSessionToRequest($request, null, $cartId);
+            $request->post();
+        } catch (ParametersException $e) {
+            $this->logger->error('Impossible to send customer cart data', [$e->getMessage()]);
+        }
+    }
+
     /**
      * @param array $subscriptionArray
+     * @param string $orderId
      * @param string|null $paymentId
      * @return array
      * @throws ParametersException
      */
-    protected function buildSubscriptionData($subscriptionArray, $paymentId = null)
+    protected function buildSubscriptionData($subscriptionArray, $orderId, $paymentId = null)
     {
         $subscriptionData = ['subscriptions' => []];
+        $subscriptionData['order_id'] = $orderId;
 
         /**
          * @var Subscription $subscription
@@ -209,7 +242,6 @@ protected function buildSubscriptionData($subscriptionArray, $paymentId = null)
         ) {
             $subscriptionData['payment_id'] = $paymentId;
         }
-
         return $subscriptionData;
     }
 
@@ -273,4 +305,37 @@ public function addCustomerSessionToRequest($request, $customerSessionId = null,
             $request->addCartIdToHeader($cartId);
         }
     }
+
+    /**
+     * @param string $subscriptionId
+     * @return void
+     * @throws ParametersException
+     * @throws RequestError
+     * @throws RequestException
+     */
+    public function cancelSubscription($subscriptionId)
+    {
+        $subscriptionId = trim($subscriptionId);
+        $this->checkSubscriptionIdFormat($subscriptionId);
+
+        $request = $this->request(self::INSURANCE_PATH . 'subscriptions/' . $subscriptionId . '/void');
+        $response = $request->post();
+
+        if ($response->isError()) {
+            throw new RequestException($response->errorMessage, $request, $response);
+        }
+    }
+
+    /**
+     * @param string $subscriptionId
+     * @return void
+     * @throws ParametersException
+     */
+    public function checkSubscriptionIdFormat($subscriptionId)
+    {
+        if (!is_string($subscriptionId) || empty($subscriptionId)) {
+            throw new ParametersException('Invalid subscriptions Array');
+        }
+
+    }
 }
diff --git a/src/Lib/InsuranceValidator.php b/src/Lib/InsuranceValidator.php
@@ -78,4 +78,26 @@ public function checkSubscriptionIds($subscriptionIds)
             ));
         }
     }
+
+    /**
+     * Throw Exception if payload isn't valid
+     * @throws ParametersException
+     */
+    public function checkCmsReference($cmsReferenceArray)
+    {
+        if (!is_array($cmsReferenceArray) || empty($cmsReferenceArray)) {
+            throw new ParametersException(sprintf(
+                'Invalid parameters must be an array with strings : %s',
+                gettype($cmsReferenceArray)
+            ));
+        }
+        foreach ($cmsReferenceArray as $cmsReference) {
+            if (!is_string($cmsReference)) {
+                throw new ParametersException(sprintf(
+                    'Cms references must be a string : %s',
+                    json_encode($cmsReference)
+                ));
+            }
+        }
+    }
 }