Payconiq > WERO/Bancontact migration + PHP 8 (#19)

* Payconiq > WERO/Bancontact migration + PHP 8

* cleanup

* updated phpcs

* fix

* PSR12

* improvements

* fix github action codecov?

* fix codecov?

* added codecov.yml

* use DateTimeInterface to support DateTime & DateTimeImmutable

* readme update

* cacheKey fix

* fix phpunit

* typo

* update example

* useNewPreProductionEnv for qr code generator

* fix JWS verifier?

* allow short variables

* phpcs fix

---------

Co-authored-by: Simon <simon@optios.net>

Author: simonwestyn

.github/workflows/tests.yaml

@@ -9,12 +9,12 @@ jobs:
     strategy:
       matrix:
         operating-system: ['ubuntu-latest']
-        php-versions: ['7.2', '7.3', '7.4']
+        php-versions: ['8.2', '8.3', '8.4']
         phpunit-versions: ['latest']
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup PHP, with composer and extensions
         uses: shivammathur/setup-php@v2
@@ -40,8 +40,11 @@ jobs:
         run: php vendor/bin/phpcs src/ tests/ --colors -p
 
       - name: Send test coverage to codecov.io
-        uses: codecov/codecov-action@v2.1.0
+        if: matrix.php-versions == '8.4'
+        uses: codecov/codecov-action@v5
         with:
+          token: ${{ secrets.CODECOV_TOKEN }}
           files: clover.xml
-          fail_ci_if_error: true # optional (default = false)
-          verbose: true # optional (default = false)
+          flags: php-${{ matrix.php-versions }}
+          fail_ci_if_error: true
+          verbose: true

.gitignore

@@ -1,5 +1,6 @@
 /vendor/
 /bin/.phpunit.result.cache
+.phpunit.cache/
 .phpunit.result.cache
 .idea/
 composer.lock

.php-version

@@ -1,7 +1,7 @@
 [![CI](https://github.com/optiosteam/payconiq-client-php/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/optiosteam/payconiq-client-php/actions/workflows/tests.yaml)
 [![codecov](https://codecov.io/gh/optiosteam/payconiq-client-php/branch/main/graph/badge.svg?token=S62YDUXV7A)](https://codecov.io/gh/optiosteam/payconiq-client-php)
 
-# PHP Payconiq API Client (unofficial)
+# PHP Payconiq/Wero/Bancontact API Client (unofficial)
 
 Supported API version: v3
 
@@ -26,12 +26,23 @@ Not supported yet:
 
 ## Installation
 
-**Requirement**: PHP version >=7.2
+**Requirement**: PHP version >=8.2
 
 ```
 composer require optiosteam/payconiq-client-php
 ```
 
+## Migrating from 1.x to 2.x: Migration Payconiq > WERO/Bancontact
+On `2025-09-21 03:00:00 CET` the endpoints will be updated automatically to use the new endpoints according to https://docs.payconiq.be/guides/general/preprod072025v4
+
+The code has been updated for PHP 8 (constructor property promotion, enums, immutable with `readonly`, ...)
+
+All resources (`Payment`, `Creditor`, `Debtor`, `SearchResult`) are now immutable.
+
+**So if you are migrating your code from 1.x to 2.x, make sure to use the enums for PaymentStatus, QR code size, color & format, instead of the old constants**
+
+Setters on resources no longer exist.
+
 ## Description
 This library provides 3 main classes:
 - `PayconiqApiClient`
@@ -157,16 +168,19 @@ var_dump($payconiqCallbackSignatureVerifier->loadAndVerifyJWS($signature, $paylo
 
 ### QR link generation
 ```php
+use Optios\Payconiq\Enum\QrImageColor;
+use Optios\Payconiq\Enum\QrImageFormat;
+use Optios\Payconiq\Enum\QrImageSize;
 use Optios\Payconiq\PayconiqQrCodeGenerator;
 
 //Example 1: customized QR code (defaults are PNG, SMALL, MAGENTO)
 //e.g. coming from Optios\Payconiq\Resource\Payment\Payment->getQrLink()
 $qrLink = 'https://portal.payconiq.com/qrcode?c=https%3A%2F%2Fpayconiq.com%2Fpay%2F2%2F73a222xxxxxxxxx00964';
 $customizedQRLink  = PayconiqQrCodeGenerator::customizePaymentQrLink(
     $qrLink,
-    PayconiqQrCodeGenerator::FORMAT_PNG,
-    PayconiqQrCodeGenerator::SIZE_EXTRA_LARGE,
-    PayconiqQrCodeGenerator::COLOR_BLACK
+    QrImageFormat::PNG,
+    QrImageSize::EXTRA_LARGE,
+    QrImageColor::BLACK,
 );
 var_dump($customizedQRLink);
 

README.md

@@ -0,0 +1,22 @@
+codecov:
+  require_ci_to_pass: yes
+
+coverage:
+  status:
+    project:
+      default:
+        target: 90%
+        threshold: 2%
+        informational: false
+    patch:
+      default:
+        target: 90%
+        threshold: 2%
+        informational: false
+
+ignore:
+  - "vendor/**"
+  - "examples/**"
+  - "build/**"
+  - "coverage/**"
+  - "tests/**/Fixtures/**"

codecov.yml

@@ -19,16 +19,21 @@
         }
     ],
     "require": {
-        "php": ">=7.2|>=8.0",
+        "php": ">=8.2",
         "composer/ca-bundle": "^1.1",
         "ext-json": "*",
-        "guzzlehttp/guzzle": "^6.0|^7.0",
-        "league/url": "^3.3",
-        "nesbot/carbon": "^2.41",
-        "symfony/cache": "^3.4|^4.0|^5.0|^6.0",
-        "web-token/jwt-checker": "^2.2",
-        "web-token/jwt-signature": "^2.2",
-        "web-token/jwt-signature-algorithm-ecdsa": "^2.2"
+        "guzzlehttp/guzzle": "^7.5",
+        "nesbot/carbon": "^3.0",
+        "symfony/cache": "^5.4|^6.0|^7.0",
+        "web-token/jwt-library": "^4.0",
+        "league/uri": "^7.5",
+        "league/uri-components": "^7.5",
+        "phpseclib/phpseclib": "^3.0"
+    },
+    "conflict": {
+        "web-token/jwt-checker": "*",
+        "web-token/jwt-signature": "*",
+        "web-token/jwt-signature-algorithm-ecdsa": "*"
     },
     "autoload": {
         "psr-4": {
@@ -43,7 +48,7 @@
     "require-dev": {
         "squizlabs/php_codesniffer": "^3.5",
         "phpmd/phpmd": "^2.9",
-        "phpunit/phpunit": "^8.5",
-        "spatie/phpunit-snapshot-assertions": "3.0|4.2.15"
+        "phpunit/phpunit": "^11.2",
+        "spatie/phpunit-snapshot-assertions": "^5.0"
     }
 }

composer.json

@@ -7,6 +7,9 @@
 
 require_once __DIR__ . "../vendor/autoload.php";
 
+use Optios\Payconiq\Enum\QrImageColor;
+use Optios\Payconiq\Enum\QrImageFormat;
+use Optios\Payconiq\Enum\QrImageSize;
 use Optios\Payconiq\PayconiqQrCodeGenerator;
 
 //Example 1: customized QR code (defaults are PNG, SMALL, MAGENTO)
@@ -15,9 +18,9 @@
 $qrLink = 'https://portal.payconiq.com/qrcode?c=https%3A%2F%2Fpayconiq.com%2Fpay%2F2%2F73a222xxxxxxxxx00964';
 $customizedQRLink  = PayconiqQrCodeGenerator::customizePaymentQrLink(
     $qrLink,
-    PayconiqQrCodeGenerator::FORMAT_PNG,
-    PayconiqQrCodeGenerator::SIZE_EXTRA_LARGE,
-    PayconiqQrCodeGenerator::COLOR_BLACK
+    QrImageFormat::PNG,
+    QrImageSize::EXTRA_LARGE,
+    QrImageColor::BLACK,
 );
 var_dump($customizedQRLink);
 

examples/QRCodeGeneratorExample.php

@@ -1,7 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<ruleset name="pcsg-generated-ruleset">
-    <description>Created with the PHP Coding Standard Generator. http://edorian.github.com/php-coding-standard-generator/
-    </description>
+<ruleset name="Project Standard">
+    <description>PSR-12 + focused Generic/Squiz rules</description>
+
+    <file>src</file>
+    <file>tests</file>
+
+    <rule ref="PSR12"/>
     <rule ref="Generic.Classes.DuplicateClassName"/>
     <rule ref="Generic.CodeAnalysis.ForLoopShouldBeWhileLoop"/>
     <rule ref="Generic.CodeAnalysis.ForLoopWithTestFunctionCall"/>
@@ -19,11 +23,6 @@
         </properties>
     </rule>
     <rule ref="Generic.Formatting.DisallowMultipleStatements"/>
-    <rule ref="Generic.Formatting.MultipleStatementAlignment">
-        <properties>
-            <property name="ignoreMultiLine" value="true"/>
-        </properties>
-    </rule>
     <rule ref="Generic.Formatting.SpaceAfterCast"/>
     <rule ref="Generic.Metrics.CyclomaticComplexity"/>
     <rule ref="Generic.Metrics.NestingLevel">
@@ -40,22 +39,6 @@
     <rule ref="Generic.Strings.UnnecessaryStringConcat"/>
     <rule ref="Generic.WhiteSpace.DisallowTabIndent"/>
     <rule ref="Generic.WhiteSpace.ScopeIndent"/>
-    <rule ref="MySource.PHP.EvalObjectFactory"/>
-    <rule ref="PEAR.Commenting.InlineComment"/>
-    <rule ref="PEAR.ControlStructures.ControlSignature"/>
-    <rule ref="PEAR.NamingConventions.ValidClassName"/>
-    <rule ref="PEAR.WhiteSpace.ObjectOperatorIndent"/>
-    <rule ref="PEAR.WhiteSpace.ScopeClosingBrace"/>
-    <rule ref="PSR1.Classes.ClassDeclaration"/>
-    <rule ref="PSR1.Files.SideEffects"/>
-    <rule ref="PSR2.Classes.ClassDeclaration"/>
-    <rule ref="PSR2.Classes.PropertyDeclaration"/>
-    <rule ref="PSR2.ControlStructures.ElseIfDeclaration"/>
-    <rule ref="PSR2.ControlStructures.SwitchDeclaration"/>
-    <rule ref="PSR2.Files.EndFileNewline"/>
-    <rule ref="PSR2.Methods.MethodDeclaration"/>
-    <rule ref="PSR2.Namespaces.NamespaceDeclaration"/>
-    <rule ref="PSR2.Namespaces.UseDeclaration"/>
     <rule ref="Squiz.PHP.DisallowMultipleAssignments"/>
     <rule ref="Squiz.PHP.DisallowSizeFunctionsInLoops"/>
     <rule ref="Squiz.PHP.Eval"/>

phpcs.xml

@@ -19,7 +19,7 @@
     </rule>
     <rule ref="rulesets/naming.xml/ShortVariable">
         <properties>
-            <property name="minimum" value="2"/>
+            <property name="minimum" value="1"/>
             <property name="exceptions" value="id,e" />
         </properties>
     </rule>

phpmd.xml

@@ -1,20 +1,19 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- https://phpunit.readthedocs.io/en/latest/configuration.html -->
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/8.5/phpunit.xsd" backupGlobals="false" colors="true">
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">src</directory>
-        </whitelist>
-    </filter>
-    <php>
-        <ini name="error_reporting" value="-1"/>
-        <server name="APP_ENV" value="test" force="true"/>
-        <server name="SHELL_VERBOSITY" value="-1"/>
-    </php>
-    <testsuites>
-        <testsuite name="unit-tests">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-</phpunit>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.5/phpunit.xsd" backupGlobals="false" colors="true" cacheDirectory=".phpunit.cache">
+  <php>
+    <ini name="error_reporting" value="-1"/>
+    <server name="APP_ENV" value="test" force="true"/>
+    <server name="SHELL_VERBOSITY" value="-1"/>
+  </php>
+  <testsuites>
+    <testsuite name="unit-tests">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </source>
+</phpunit>