Merge pull request #135 from alma/release/v2.2.0

Release v2.2.0

.github/workflows/ci.yml

@@ -60,7 +60,11 @@ jobs:
           grep -r -l "$string" tests/ | xargs sed -i "s/$string//g"
 
       - name: PHPUnit
-        run: composer exec phpunit -- --configuration phpunit.ci.xml --coverage-xml ./.coverage
+        run: |
+          case ${{ matrix.php }} in
+            8.1|8.2|8.3 ) composer exec phpunit -- --configuration phpunit.ci.8.xml --coverage-xml ./.coverage;;
+            *) composer exec phpunit -- --configuration phpunit.ci.xml --coverage-xml ./.coverage;;
+          esac
         env:
           XDEBUG_MODE: coverage
 

.gitignore

@@ -9,4 +9,5 @@ phpunit.xml
 .phpunit.cache/
 composer.lock
 .DS_Store
-.env
+.env
+.coverage/

CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## v2.2.0 - 2024-09-05
+
+### Changes
+
+### 🚀 New Features
+
+- Add function for HMAC verification (#132)
+
+#### Contributors
+
+@Benjamin-Freoua-Alma, @CamilleFljt, @Francois-Gomis and @carine-bonnafous
+
 ## v2.1.0 - 2024-07-29
 
 ### Changes
@@ -149,6 +161,7 @@
         // Handle errors
     }
 
+
   ```
 * Add fields and docs to the Payment entity
 * Add a Refund entity and extract refunds data within the Payment entity constructor
@@ -268,10 +281,15 @@ Getting more serious with a 1.0.0 release! 🎉
 ## v0.0.1
 
 * Initial "pre-release" of the API Client
+
 * Includes two main endpoints: Payments and Merchants
+
 * Provides what's necessary for a typical payment flow:
+
   * `Payments.createPayment` and `Payments.eligibility`
   * `Merchants.me`
 
 * Base `Alma\API\Client` class can be configured with API key and live/test mode
+
 * TLS is automatically forced to TLS 1.2 to meet Alma's security requirements, but configurable
+

Dockerfile

@@ -3,6 +3,7 @@ ARG COMPOSER_VERSION
 
 FROM composer:${COMPOSER_VERSION} as composer
 FROM php:${PHP_VERSION}-fpm
+ARG PHP_VERSION
 
 ENV DEBIAN_FRONTEND noninteractive
 
@@ -16,6 +17,11 @@ RUN apt update && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* /usr/share/doc/*
 
+RUN case ${PHP_VERSION} in \
+        8.0|8.1|8.2|8.3 ) pecl install xdebug-3.3.2 && docker-php-ext-enable xdebug;; \
+        *) pecl install xdebug-2.9.8 && docker-php-ext-enable xdebug;; \
+    esac
+
 RUN usermod -u 1000 www-data
 RUN groupmod -g 1000 www-data
 

Dockerfile.legacy

@@ -20,6 +20,10 @@ RUN apt update && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* /usr/share/doc/*
 
+# Install xdebug for code coverage
+RUN pecl install xdebug-2.5.5 \
+&& docker-php-ext-enable xdebug
+
 RUN usermod -u 1000 www-data
 RUN groupmod -g 1000 www-data
 

Taskfile.php.yml

@@ -27,9 +27,9 @@ tasks:
     cmds:
       - >-
         {{ if eq .PHP_VERSION "5.6" "7.0" }}
-        docker compose run {{ .COMPOSE_SERVICE }} ./tests/legacy_tests.sh
+        docker compose run --rm {{ .COMPOSE_SERVICE }} ./tests/legacy_tests.sh
         {{ else }}
-        docker compose run {{ .COMPOSE_SERVICE }} composer exec phpunit --verbose -- --configuration phpunit.dist.xml --testsuite "Alma PHP Client Unit Test Suite"
+        docker compose run --rm {{ .COMPOSE_SERVICE }} composer exec phpunit --verbose -- --configuration {{ .PHPUNIT_FILE }} --testsuite "Alma PHP Client Unit Test Suite" --coverage-xml ./.coverage
         {{ end }}
 
   tests:integration:
@@ -39,15 +39,15 @@ tasks:
     cmds:
        - >-
           {{ if eq .PHP_VERSION "5.6" "7.0" }}
-          docker compose run {{ .COMPOSE_SERVICE }} ./tests/legacy_integration_tests.sh
+          docker compose run --rm {{ .COMPOSE_SERVICE }} ./tests/legacy_integration_tests.sh
           {{ else }}
-          docker compose run {{ .COMPOSE_SERVICE }} composer exec phpunit --verbose -- --configuration phpunit.dist.xml --testsuite "Alma PHP Client Integration Test Suite"
+          docker compose run --rm {{ .COMPOSE_SERVICE }} composer exec phpunit --verbose -- --configuration {{ .PHPUNIT_FILE }} --testsuite "Alma PHP Client Integration Test Suite"
           {{ end }}
 
   shell:
     desc: Connect to PHP container
     deps:
       - docker:build
     cmds:
-      - sed 's/{MYVERSION}/{{ .PHPUNIT_VERSION }}/g' phpunit.dist.xml > phpunit.xml
-      - docker compose run {{ .COMPOSE_SERVICE }} bash
+      - sed 's/{MYVERSION}/{{ .PHPUNIT_VERSION }}/g' {{ .PHPUNIT_FILE }} > phpunit.xml
+      - docker compose run --rm {{ .COMPOSE_SERVICE }} bash

Taskfile.yml

@@ -44,14 +44,17 @@ includes:
     taskfile: Taskfile.php.yml
     vars:
       PHP_VERSION: "8.1"
+      PHPUNIT_FILE: phpunit.dist.8.xml
   "8.2":
     taskfile: Taskfile.php.yml
     vars:
       PHP_VERSION: "8.2"
+      PHPUNIT_FILE: phpunit.dist.8.xml
   "8.3":
     taskfile: Taskfile.php.yml
     vars:
       PHP_VERSION: "8.3"
+      PHPUNIT_FILE: phpunit.dist.8.xml
 
 tasks:
   default:

compose.yml

@@ -12,6 +12,8 @@ services:
     volumes:
       - ./:/app
       - /app/vendor
+    environment:
+      XDEBUG_MODE: coverage
 
   php-legacy:
     user: ${UID:-1000}:${GID:-1000}

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "alma/alma-php-client",
   "description": "PHP API client for the Alma payments API",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "type": "library",
   "require": {
     "php": "^5.6 || ~7.0 || ~7.1 || ~7.2 || ~7.3 || ~7.4 || ~8.0 || ~8.1 || ~8.2 || ~8.3",

phpunit.ci.8.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  bootstrap="vendor/autoload.php"
+  backupGlobals="false"
+  colors="true"
+  processIsolation="false"
+  stopOnFailure="true"
+  beStrictAboutTestsThatDoNotTestAnything="false"
+  xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
+  cacheDirectory=".phpunit.cache"
+  backupStaticProperties="false">
+
+  <testsuites>
+    <testsuite name="Alma PHP Client Unit Test Suite">
+      <directory>tests/Unit</directory>
+    </testsuite>
+  </testsuites>
+
+  <coverage includeUncoveredFiles="true"
+    pathCoverage="false"
+    ignoreDeprecatedCodeUnits="true"
+    disableCodeCoverageIgnore="true">
+  </coverage>
+
+  <source>
+    <include>
+      <directory suffix=".php">./src/*</directory>
+    </include>
+  </source>
+
+</phpunit>

phpunit.dist.8.xml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+        bootstrap="vendor/autoload.php" 
+        backupGlobals="false" 
+        colors="true" 
+        testdox="true" 
+        displayDetailsOnTestsThatTriggerDeprecations="true" 
+        processIsolation="false" 
+        stopOnFailure="false" 
+        beStrictAboutTestsThatDoNotTestAnything="false" 
+        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd" 
+        cacheDirectory=".phpunit.cache" 
+        backupStaticProperties="false">
+
+  <testsuites>
+    <testsuite name="Alma PHP Client Unit Test Suite">
+      <directory>tests/Unit</directory>
+    </testsuite>
+    <testsuite name="Alma PHP Client Integration Test Suite">
+      <directory>tests/Integration</directory>
+    </testsuite>
+  </testsuites>
+
+  <coverage includeUncoveredFiles="true"
+    pathCoverage="false"
+    ignoreDeprecatedCodeUnits="true"
+    disableCodeCoverageIgnore="true">
+  </coverage>
+
+  <source>
+    <include>
+      <directory suffix=".php">./src/*</directory>
+    </include>
+  </source>
+
+  <php>
+    <env name="ALMA_API_KEY" value="sk_test_*******"/>
+    <env name="ALMA_API_ROOT" value="alma-api-url"/>
+  </php>
+</phpunit>

phpunit.dist.xml

@@ -1,5 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" colors="true" testdox="true" displayDetailsOnTestsThatTriggerDeprecations="true" processIsolation="false" stopOnFailure="false" beStrictAboutTestsThatDoNotTestAnything="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+<phpunit bootstrap="vendor/autoload.php"
+        backupGlobals="false"
+        colors="true"
+        processIsolation="false"
+        stopOnFailure="false"
+        beStrictAboutTestsThatDoNotTestAnything="false">
   <testsuites>
     <testsuite name="Alma PHP Client Unit Test Suite">
       <directory>tests/Unit</directory>
@@ -8,6 +13,11 @@
       <directory>tests/Integration</directory>
     </testsuite>
   </testsuites>
+  <filter>
+    <whitelist processUncoveredFilesFromWhitelist="true">
+        <directory suffix=".php">./src/*</directory>
+    </whitelist>
+</filter>
   <php>
     <env name="ALMA_API_KEY" value="sk_test_*******"/>
     <env name="ALMA_API_ROOT" value="alma-api-url"/>

src/Client.php

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

src/Lib/PaymentValidator.php

@@ -34,6 +34,9 @@
  */
 class PaymentValidator
 {
+
+    const HEADER_SIGNATURE_KEY = 'X-Alma-Signature';
+
     /**
      * Ensure that the purchase amount is an integer
      *
@@ -53,4 +56,17 @@ public static function checkPurchaseAmount($data)
             ));
         }
     }
-}
+
+    /**
+     * @param string $data
+     * @param string $apiKey
+     * @param string $signature
+     * @return bool
+     */
+    public function isHmacValidated($data, $apiKey,  $signature)
+    {
+        return is_string($data) &&
+            is_string($apiKey) &&
+            hash_hmac('sha256', $data, $apiKey) === $signature;
+    }
+}