Release 2.0.2

.github/workflows/aqua.yml

@@ -3,6 +3,7 @@ on:
   pull_request:
     branches:
       - main
+      - develop
 
 jobs:
   aqua:

.github/workflows/code-coverage.yaml

@@ -0,0 +1,41 @@
+name: PHPUnit Coverage Report
+
+on:
+  push:
+    branches: [develop, master]
+  pull_request:
+    branches: [develop, master]
+  workflow_dispatch: ~
+
+jobs:
+  ci:
+    runs-on: ubuntu-22.04
+    defaults:
+      run:
+        working-directory: ./
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 5.6
+          tools: composer:v1
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress --no-suggest
+
+      - name: Ensure source code is linted
+        run: ./vendor/bin/phpcs src
+
+      - name: PHPUnit
+        run: ./vendor/bin/phpunit -c phpunit.ci.xml --coverage-xml ./.coverage
+        env:
+          XDEBUG_MODE: coverage
+
+      - name: PHPUnit threshold
+        run: php ./phpunit-threshold.php

.pre-commit-config.yaml

@@ -0,0 +1,59 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-added-large-files
+        args: ["--maxkb=1024"]
+      - id: detect-private-key
+      - id: check-merge-conflict
+      - id: no-commit-to-branch
+        args: [--branch, develop, --branch, main]
+
+
+  #  - repo: local
+#    hooks:
+#      - id: coding-standard-fixer
+#        name: PHP coding standards Fixer test
+#        language: script
+#        entry:  ./scripts/coding-standard-fixer.sh
+#        stages: [commit]
+#
+#  - repo: local
+#    hooks:
+#      - id: coding-standard
+#        name: Check the PHP and Prestashop coding standards
+#        language: script
+#        entry:  ./scripts/coding-standard.sh
+#        stages: [commit]
+#
+#  - repo: local
+#    hooks:
+#      - id: php-compatibility
+#        name: Check the PHP compatibility
+#        language: script
+#        entry:  ./scripts/php-compatibility.sh
+#        stages: [commit]
+#
+#  - repo: https://github.com/returntocorp/semgrep
+#    rev: v1.27.0
+#    hooks:
+#      - id: semgrep
+#        args:
+#          - --error
+#          - --config
+#          - semgrep/rules/
+#          - --metrics
+#          - "off"
+#          - --quiet
+#          - --disable-version-check
+#          - --skip-unknown-extensions
+#        pass_filenames: false # Passing files explicitely override semgremignore
+
+  - repo: https://github.com/alma/pre-commit-hooks
+    rev: 1.1.2
+    hooks:
+      - id: check-branch-name
+        args:
+          - "-r^((chore|ci|dependabot|devx|docs|feature|fix|hotfix|hotfix-backport|infra|other|perf|refactor|security|test)\/.+|(snyk)-.+|main|develop|HEAD)$$"

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+v2.0.2
+-------
+* Added getSubscription endpoint Insurance
+* Fix Subscription amount model
+
 v2.0.1
 -------
 * Fix : Don't remove amount in refund if value equal zero

composer.json

@@ -7,7 +7,8 @@
     "php": "^5.6 || ~7.0 || ~7.1 || ~7.2 || ~7.3 || ~7.4 || ~8.0 || ~8.1 || ~8.2",
     "psr/log": "^1 || ^2 || ^3",
     "ext-curl": "*",
-    "ext-json": "*"
+    "ext-json": "*",
+    "ext-simplexml": "*"
   },
   "require-dev": {
     "dealerdirect/phpcodesniffer-composer-installer": "^0.7.0",

phpunit-threshold.php

@@ -0,0 +1,53 @@
+<?php
+
+$file = "./.coverage/index.xml";
+$coverage = simplexml_load_file($file);
+$coverageIsOk = true;
+$errorMessage = "";
+$totals = [
+    [
+        'name' => "Lines",
+        'threshold' => 51,
+        'ratio' => (double)$coverage->project->directory->totals->lines["percent"]
+    ],
+    [
+        'name' => "Methods",
+        'threshold' => 47,
+        'ratio' => (double)$coverage->project->directory->totals->methods["percent"]
+    ],
+    [
+        'name' => "Functions",
+        'threshold' => 0,
+        'ratio' => (double)$coverage->project->directory->totals->functions["percent"]
+    ],
+    [
+        'name' => "Classes",
+        'threshold' => 22,
+        'ratio' => (double)$coverage->project->directory->totals->classes["percent"]
+    ],
+    [
+        'name' => "Traits",
+        'threshold' => 0,
+        'ratio' => (double)$coverage->project->directory->totals->traits["percent"]
+    ]
+];
+
+foreach ($totals as $total) {
+    if ($total['ratio'] < $total['threshold']) {
+        echo "{$total['name']} coverage failed! \r\n";
+        echo "{$total['name']} coverage: {$total['ratio']}% \r\n";
+        echo "Threshold: {$total['threshold']}% \r\n";
+        $coverageIsOk = false;
+        $errorMessage .= "{$total['name']} coverage failed! \r\n";
+    } else {
+        echo "{$total['name']} coverage success: {$total['ratio']}% \r\n";
+    }
+}
+
+if (!$coverageIsOk) {
+    echo "Coverage failed! \r\n";
+    echo $errorMessage;
+    exit(1);
+} else {
+    echo "Coverage success! \r\n";
+}

phpunit.ci.xml

@@ -15,5 +15,12 @@
             <directory>tests/Unit/Legacy</directory>
         </testsuite>
     </testsuites>
-
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src/*</directory>
+            <exclude>
+                <directory suffix=".php">./src/vendor/*</directory>
+            </exclude>
+        </whitelist>
+    </filter>
 </phpunit>

src/Client.php

@@ -30,7 +30,7 @@
 
 class Client
 {
-    const VERSION = '2.0.1';
+    const VERSION = '2.0.2';
 
     const LIVE_MODE = 'live';
     const TEST_MODE = 'test';

src/Endpoints/Insurance.php

@@ -19,7 +19,7 @@ class Insurance extends Base
     /**
      * @var InsuranceValidator
      */
-    protected $insuranceValidator;
+    public $insuranceValidator;
 
     public function __construct($client_context)
     {
@@ -130,7 +130,28 @@ public function subscription($subscriptionArray, $paymentId = null, $customerSes
         $response = $request->post();
 
         if ($response->isError()) {
+            throw new RequestException($response->errorMessage, null, $response);
+        }
 
+        return $response->json;
+    }
+
+    /**
+     * @throws RequestError
+     * @throws RequestException
+     * @throws ParametersException
+     * @return array json_decode in response constructor
+     */
+    public function getSubscription($subscriptionIds)
+    {
+        $this->insuranceValidator->checkSubscriptionIds($subscriptionIds);
+        $response = $this->request(
+            self::INSURANCE_PATH . 'subscriptions'
+        )->setQueryParams(
+            $subscriptionIds
+        )->get();
+
+        if ($response->isError()) {
             throw new RequestException($response->errorMessage, null, $response);
         }
 
@@ -161,6 +182,7 @@ protected function buildSubscriptionData($subscriptionArray, $paymentId = null)
 
             $subscriptionData['subscriptions'][] = [
                 'insurance_contract_id' => $subscription->getContractId(),
+                'amount' => $subscription->getAmount(),
                 'cms_reference' => $subscription->getCmsReference(),
                 'product_price' => $subscription->getProductPrice(),
                 'cms_callback_url' => $subscription->getCallbackUrl(),

src/Entities/Insurance/Subscription.php

@@ -8,6 +8,10 @@ class Subscription
      * @var string
      */
     private $contractId;
+    /**
+     * @var int
+     */
+    private $amount;
     /**
      * @var string
      */
@@ -33,20 +37,23 @@ class Subscription
 
     /**
      * @param string $contractId
+     * @param int  $amount
      * @param string $cmsReference
      * @param int $productPrice
      * @param Subscriber $subscriber
      * @param string $callbackUrl
      */
     public function __construct(
         $contractId,
+        $amount,
         $cmsReference,
         $productPrice,
         $subscriber,
         $callbackUrl
     )
     {
         $this->contractId = $contractId;
+        $this->amount = $amount;
         $this->cmsReference = $cmsReference;
         $this->productPrice = $productPrice;
         $this->subscriber = $subscriber;
@@ -56,11 +63,12 @@ public function __construct(
     public function getAll()
     {
         return [
-            $this->contractId,
-            $this->cmsReference,
-            $this->productPrice,
-            $this->subscriber,
-            $this->callbackUrl,
+            $this->getContractId(),
+            $this->getAmount(),
+            $this->getCmsReference(),
+            $this->getProductPrice(),
+            $this->getSubscriber(),
+            $this->getCallbackUrl(),
         ];
     }
 
@@ -103,4 +111,12 @@ public function getSubscriber()
     {
         return $this->subscriber;
     }
+
+    /**
+     * @return int
+     */
+    public function getAmount()
+    {
+        return $this->amount;
+    }
 }

src/Lib/InsuranceValidator.php

@@ -65,4 +65,17 @@ public function checkParamFormat($param, $name)
             ));
         }
     }
+
+    /**
+     * @throws ParametersException
+     */
+    public function checkSubscriptionIds($subscriptionIds)
+    {
+        if (!is_array($subscriptionIds)) {
+            throw new ParametersException(sprintf(
+                'The subscription ids need to be an array, "%s" given',
+                gettype($subscriptionIds)
+            ));
+        }
+    }
 }