Merge pull request #218 from alma/develop

Release 3.0.3
alma · Sep 28, 2023 · d9f633f · d9f633f
2 parents 8a816df + 00ecac6
commit d9f633f
Show file tree

Hide file tree

Showing 39 changed files with 423 additions and 448 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,85 @@
+# 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
+
+  - repo: local
+    hooks:
+      - id: coding-standard-fixer
+        name: PHP and Prestashop 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/pre-commit/mirrors-prettier
+  #  rev: v3.0.0-alpha.4
+   # hooks:
+   #   - id: prettier
+   #     files: "(^.*\\.js$)|(^pos/frontend/.*$)"
+
+#  - repo: https://github.com/pre-commit/mirrors-eslint
+  #  rev: v8.29.0
+  #  hooks:
+ #     - id: eslint
+    #    files: "(^dashboard/frontend/src/.*\\.[jt]sx?$)" # *.js, *.jsx, *.ts and *.tsx
+    #    types: [file]
+     #   args:
+      #    - --fix
+
+#  - repo: https://github.com/thibaudcolas/pre-commit-stylelint
+#    rev: v14.16.0
+#    hooks:
+#      - id: stylelint
+#        files: "(^src/assets/css/.*\\.css$)|(^src/assets/widget/css/.*\\.css$)|(^.*\\.css$)"
+#        args:
+#          - --config
+#          - stylelint.config.cjs
+#        additional_dependencies:
+#          - [email protected]
+#          - [email protected]
+#          - [email protected]
+#          - [email protected]
+
+  - 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|HEAD)$$"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## v3.0.3
+
+- fix: Change event system for In-Page on Prestashop 1.7+
+- fix: Issue modal In-Page on Prestashop before 16.0.12
+- fix: Clear the partial refund amount after a partial refund
+- fix: Issue error when merchant not allow to create payments
+
 ## v3.0.2
 
 - fix: issue modal In-Page with jQuery noConflict

diff --git a/alma/CHANGELOG.md b/alma/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## v3.0.3
+
+- fix: Change event system for In-Page on Prestashop 1.7+
+- fix: Issue modal In-Page on Prestashop before 16.0.12
+- fix: Clear the partial refund amount after a partial refund
+- fix: Issue error when merchant not allow to create payments
+
 ## v3.0.2
 
 - fix: issue modal In-Page with jQuery noConflict

diff --git a/alma/alma.php b/alma/alma.php
@@ -30,7 +30,7 @@
 
 class Alma extends PaymentModule
 {
-    const VERSION = '3.0.2';
+    const VERSION = '3.0.3';
 
     public $_path;
     public $local_path;
@@ -65,7 +65,7 @@ public function __construct()
     {
         $this->name = 'alma';
         $this->tab = 'payments_gateways';
-        $this->version = '3.0.2';
+        $this->version = '3.0.3';
         $this->author = 'Alma';
         $this->need_instance = false;
         $this->bootstrap = true;

diff --git a/alma/controllers/hook/DisplayBackOfficeHeaderHookController.php b/alma/controllers/hook/DisplayBackOfficeHeaderHookController.php
@@ -53,6 +53,9 @@ public function canRun()
      * @param array $params
      *
      * @return void
+     *
+     * @throws \PrestaShopDatabaseException
+     * @throws \PrestaShopException
      */
     public function run($params)
     {

diff --git a/alma/controllers/hook/GetContentHookController.php b/alma/controllers/hook/GetContentHookController.php
@@ -394,7 +394,11 @@ private function credentialsError($liveKey, $testKey)
 
         foreach ($modes as $mode) {
             $key = (ALMA_MODE_LIVE == $mode ? $liveKey : $testKey);
-            if (!$key || ConstantsHelper::OBSCURE_VALUE === $key) {
+            if (
+                !$key
+                || ConstantsHelper::OBSCURE_VALUE === $key
+                || SettingsHelper::getActiveMode() !== $mode
+            ) {
                 continue;
             }
 

diff --git a/alma/exceptions/ActivationException.php b/alma/exceptions/ActivationException.php
@@ -36,9 +36,16 @@ class ActivationException extends AlmaException
      */
     public function __construct($module)
     {
-        $message = sprintf(
-            $module - l('Your Alma account needs to be activated before you can use Alma on your shop.<br>Go to your <a href="%1$s" target="_blank">Alma dashboard</a> to activate your account.<br><a href="#">Refresh</a> the page when ready.', 'ActivationException'),
-            LinkHelper::getAlmaDashboardUrl(SettingsHelper::getActiveMode(), 'settings')
+        $message = $module->l('Your Alma account needs to be activated before you can use Alma on your shop.', 'ActivationException')
+        . sprintf(
+            $module->l('Go to your %1$sAlma dashboard%2$s to activate your account.', 'ActivationException'),
+            '<a href="' . LinkHelper::getAlmaDashboardUrl(SettingsHelper::getActiveMode(), 'settings') . '" target="_blank">',
+            '</a>'
+        )
+        . sprintf(
+            $module->l('%1$sRefresh%2$s the page when ready.', 'ActivationException'),
+            '<a href="#">',
+            '</a>'
         );
 
         parent::__construct($message);

diff --git a/alma/exceptions/WrongCredentialsException.php b/alma/exceptions/WrongCredentialsException.php
@@ -36,9 +36,10 @@ class WrongCredentialsException extends AlmaException
      */
     public function __construct($module)
     {
-        $message = sprintf(
-            $module->l('Could not connect to Alma using your API keys.<br>Please double check your keys on your %s Alma dashboard %s.', 'WrongCredentialsException'),
-            sprintf('<a href="%1$s" target="_blank">', LinkHelper::getAlmaDashboardUrl(SettingsHelper::getActiveMode(), 'api')),
+        $message = $module->l('Could not connect to Alma using your API keys.', 'WrongCredentialsException')
+        . sprintf(
+            $module->l('Please double check your keys on your %1$sAlma dashboard%2$s.', 'WrongCredentialsException'),
+            '<a href="' . LinkHelper::getAlmaDashboardUrl(SettingsHelper::getActiveMode(), 'api') . '" target="_blank">',
             '</a>'
         );
 

diff --git a/alma/lib/Helpers/DateHelper.php b/alma/lib/Helpers/DateHelper.php
@@ -133,4 +133,16 @@ protected static function getFrenchDateFormat($timestamp)
 
         return $date->format('d/m/Y');
     }
+
+    /**
+     * @param string|int $timestamp
+     *
+     * @return bool
+     */
+    public static function isValidTimeStamp($timestamp)
+    {
+        return ((string) (int) $timestamp === $timestamp)
+            && ($timestamp <= PHP_INT_MAX)
+            && ($timestamp >= ~PHP_INT_MAX);
+    }
 }
diff --git a/alma/lib/Helpers/HookHelper.php b/alma/lib/Helpers/HookHelper.php
@@ -50,7 +50,6 @@ public function __construct()
         'moduleRoutes' => 'all',
         'actionAdminControllerInitBefore' => 'all',
         'header' => 'all',
-        'Header' => 'all',
         'displayHeader' => 'all',
         'displayBackOfficeHeader' => 'all',
         'displayShoppingCartFooter' => 'all',

diff --git a/alma/lib/Helpers/OrderHelper.php b/alma/lib/Helpers/OrderHelper.php
@@ -63,6 +63,9 @@ public function __construct()
      * @param string $endDate
      *
      * @return \Order[]
+     *
+     * @throws \PrestaShopDatabaseException
+     * @throws \PrestaShopException
      */
     public function getOrdersByDate($startDate, $endDate)
     {
@@ -87,6 +90,8 @@ public function getOrdersByDate($startDate, $endDate)
      * @param string $endDate
      *
      * @return array
+     *
+     * @throws \PrestaShopDatabaseException
      */
     public function getOrdersIdByDate($startDate, $endDate)
     {

diff --git a/alma/lib/Helpers/ShareOfCheckoutHelper.php b/alma/lib/Helpers/ShareOfCheckoutHelper.php
@@ -70,13 +70,17 @@ public function __construct($orderHelper)
 
     /**
      * @return bool
+     *
+     * @throws \PrestaShopDatabaseException
+     * @throws \PrestaShopException
      */
     public function shareDays()
     {
         $shareOfCheckoutEnabledDate = $this->getEnabledDate();
         if (
             ShareOfCheckoutAdminFormBuilder::ALMA_SHARE_OF_CHECKOUT_CONSENT_NO === SettingsHelper::getShareOfCheckoutStatus()
             || empty($shareOfCheckoutEnabledDate)
+            || !DateHelper::isValidTimeStamp($shareOfCheckoutEnabledDate)
         ) {
             Logger::instance()->info('Share Of Checkout is disabled or invalide date');
 
@@ -102,6 +106,9 @@ public function shareDays()
      * Put Payload to Share of Checkout.
      *
      * @return void
+     *
+     * @throws \PrestaShopDatabaseException
+     * @throws \PrestaShopException
      */
     public function putDay()
     {
@@ -152,6 +159,9 @@ public function getStartShareOfCheckout()
      * Total Orders to send.
      *
      * @return array
+     *
+     * @throws \PrestaShopDatabaseException
+     * @throws \PrestaShopException
      */
     public function getTotalOrders()
     {
@@ -437,7 +447,7 @@ private function getEndDateTime()
      *
      * @param string $id
      *
-     * @return string
+     * @return array|bool|object|string|null
      */
     private function getIsoCodeById($id)
     {
@@ -453,6 +463,9 @@ private function getIsoCodeById($id)
      * Payload Share of Checkout.
      *
      * @return array
+     *
+     * @throws \PrestaShopDatabaseException
+     * @throws \PrestaShopException
      */
     public function getPayload()
     {
@@ -467,15 +480,15 @@ public function getPayload()
     /**
      * @return string|false
      */
-    protected function getEnabledDate()
+    public function getEnabledDate()
     {
         return \Configuration::get(ShareOfCheckoutAdminFormBuilder::ALMA_SHARE_OF_CHECKOUT_DATE);
     }
 
     /**
      * @return array
      */
-    protected function getDatesInInterval($lastShareOfCheckout, $shareOfCheckoutEnabledDate)
+    public function getDatesInInterval($lastShareOfCheckout, $shareOfCheckoutEnabledDate)
     {
         return DateHelper::getDatesInInterval($lastShareOfCheckout, $shareOfCheckoutEnabledDate);
     }

diff --git a/alma/lib/Traits/AjaxTrait.php b/alma/lib/Traits/AjaxTrait.php
@@ -102,6 +102,6 @@ protected function renderAndExit($value = null, $controller = null, $method = nu
      */
     protected function ajaxRenderBefore16012($value)
     {
-        exit(\Tools::jsonEncode($value));
+        exit($value);
     }
 }
diff --git a/alma/phpunit.ci.xml b/alma/phpunit.ci.xml
@@ -11,13 +11,8 @@
          stopOnFailure               = "true">
 
     <testsuites>
-        <testsuite name="Alma Installment Prestashop Unit Test Suite">
-            <directory>tests/unit</directory>
-        </testsuite>
-    </testsuites>
-    <testsuites>
-        <testsuite name="Alma Installment Prestashop Integration Test Suite">
-            <directory>tests/integration</directory>
+        <testsuite name="Alma Installment Prestashop Test Suite">
+            <directory>tests</directory>
         </testsuite>
     </testsuites>
 

diff --git a/alma/phpunit.dist.xml b/alma/phpunit.dist.xml
@@ -11,13 +11,8 @@
          stopOnFailure               = "false">
 
     <testsuites>
-        <testsuite name="Alma Installment Prestashop Unit Test Suite">
-            <directory>tests/unit</directory>
-        </testsuite>
-    </testsuites>
-    <testsuites>
-        <testsuite name="Alma Installment Prestashop Integration Test Suite">
-            <directory>tests/integration</directory>
+        <testsuite name="Alma Installment Prestashop Test Suite">
+            <directory>tests</directory>
         </testsuite>
     </testsuites>
     <php>

diff --git a/alma/tests/README.md b/alma/tests/README.md
@@ -18,15 +18,5 @@ cd modules/alma/
 
 to launch test :
 ```
-./vendor/bin/phpunit
-```
-
-to launch integration test :
-```
-./vendor/bin/phpunit --testsuite 'Alma Installment Prestashop Integration Test Suite'
-```
-
-to launch unit test :
-```
-./vendor/bin/phpunit --testsuite 'Alma Installment Prestashop Unit Test Suite'
+./vendor/bin/phpunit -c phpunit.ci.xml
 ```