Release 1.0.7

wallee-payment · Jun 17, 2024 · 4eefab8 · 4eefab8
1 parent c8aa449
commit 4eefab8
Show file tree

Hide file tree

Showing 575 changed files with 2,987 additions and 2,945 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # PrestaShop 8 wallee Integration
 This repository contains the PrestaShop wallee payment module that enables the shop to process payments with [wallee](https://www.wallee.com).
 
-## To install module manually by dragging up zip file, please download [.zip archive](https://plugin-documentation.wallee.com/wallee-payment/prestashop-8/1.0.6/wallee.zip) of module with correct structure required by Prestashop installation
+## To install module manually by dragging up zip file, please download [.zip archive](https://plugin-documentation.wallee.com/wallee-payment/prestashop-8/1.0.7/wallee.zip) of module with correct structure required by Prestashop installation
 
 ##### To use this extension, a [wallee](https://app-wallee.com/user/signup) account is required.
 
@@ -12,15 +12,15 @@ This repository contains the PrestaShop wallee payment module that enables the s
 
 ## Documentation
 
-* [English](https://plugin-documentation.wallee.com/wallee-payment/prestashop-8/1.0.6/docs/en/documentation.html)
+* [English](https://plugin-documentation.wallee.com/wallee-payment/prestashop-8/1.0.7/docs/en/documentation.html)
 
 ## Support
 
 Support queries can be issued on the [wallee support site](https://app-wallee.com/space/select?target=/support).
 
 ## License
 
-Please see the [license file](https://github.com/wallee-payment/prestashop-8/blob/1.0.6/LICENSE) for more information.
+Please see the [license file](https://github.com/wallee-payment/prestashop-8/blob/1.0.7/LICENSE) for more information.
 
 ## Other PrestaShop Versions
 

diff --git a/controllers/front/return.php b/controllers/front/return.php
@@ -97,8 +97,9 @@ private function processFailure(Order $order)
         if (! empty($userFailureMessage)) {
             $this->context->cookie->wle_error = $userFailureMessage;
         }
+
+        $this->setCurrentState($order);
 
-        $order->setCurrentState(Configuration::get(WalleeBasemodule::CK_STATUS_FAILED));
         //the new state should be saved here to override the stock issues of incrementing or decrementing items when going through the webhooks
         //by calling the setCurrentState function more than once without saving.
         $order->save();
@@ -116,6 +117,25 @@ public function setMedia()
     {
         // We do not need styling here
     }
+
+    /**
+     * @param Order $order
+     * @return void
+     * @throws PrestaShopDatabaseException
+     * @throws PrestaShopException
+     */
+    protected function setCurrentState(Order $order): void
+    {
+        $newState = Configuration::get(WalleeBasemodule::CK_STATUS_FAILED);
+        $history = new OrderHistory();
+        $history->id_order = $order->id;
+        $history->id_order_state = $newState;
+        $history->id_employee = (int)Context::getContext()->employee->id;
+        $history->date_add = date('Y-m-d H:i:s');
+        $history->add();
+
+        $order->current_state = $newState;
+    }
 
     protected function displayMaintenancePage()
     {

diff --git a/docs/en/documentation.html b/docs/en/documentation.html
@@ -23,7 +23,7 @@ <h2>Documentation</h2>				</div>
 		</a>
 	</li>
 	<li>
-		<a href="https://github.com/wallee-payment/prestashop-8/releases/tag/1.0.6/">
+		<a href="https://github.com/wallee-payment/prestashop-8/releases/tag/1.0.7/">
 			Source
 		</a>
 	</li>
@@ -50,7 +50,7 @@ <h1>
 					<div class="olist arabic">
 <ol class="arabic">
 <li>
-<p><a href="https://github.com/wallee-payment/prestashop-8/releases/tag/1.0.6/">Download</a> the module.</p>
+<p><a href="https://github.com/wallee-payment/prestashop-8/releases/tag/1.0.7/">Download</a> the module.</p>
 </li>
 <li>
 <p>Login to the backend of your PrestsShop store.</p>

diff --git a/views/templates/admin/admin_help_buttons.tpl b/views/templates/admin/admin_help_buttons.tpl
@@ -10,5 +10,5 @@
 <div class="alert alert-info">
 <img src="../modules/wallee/logo.png" style="float:left; margin-right:15px;" height="50">
 <p><strong>{l s='This module requires an %s account.' sprintf='wallee' mod='wallee'}</strong></p>
-<p><a class="btn btn-default" href="https://app-wallee.com/user/signup" target="_blank">{l s='Sign Up' mod='wallee'}</a> <a class="btn btn-default" href="https://plugin-documentation.wallee.com/wallee-payment/prestashop-8/1.0.6/docs/en/documentation.html" target="_blank">{l s='Documentation' mod='wallee'}</a></p>
+<p><a class="btn btn-default" href="https://app-wallee.com/user/signup" target="_blank">{l s='Sign Up' mod='wallee'}</a> <a class="btn btn-default" href="https://plugin-documentation.wallee.com/wallee-payment/prestashop-8/1.0.7/docs/en/documentation.html" target="_blank">{l s='Documentation' mod='wallee'}</a></p>
 </div>
diff --git a/wallee-sdk/.travis.yml b/wallee-sdk/.travis.yml
@@ -3,5 +3,6 @@ sudo: false
 php:
     - 8.0
     - 8.1
+    - 8.2
 before_install: "composer install"
 script: "phpunit --bootstrap autoload.php test/"
diff --git a/wallee-sdk/LICENSE b/wallee-sdk/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2023 wallee AG
+   Copyright 2024 wallee AG
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/wallee-sdk/README.md b/wallee-sdk/README.md
@@ -127,6 +127,44 @@ putenv('WLE_HTTP_CLIENT=curl');
 ?>
 ```
 
+### Integrating Webhook Payload Signing Mechanism into webhook callback handler
+
+The HTTP request which is sent for a state change of an entity now includes an additional field `state`, which provides information about the update of the monitored entity's state. This enhancement is a result of the implementation of our webhook encryption mechanism.
+
+Payload field `state` provides direct information about the state update of the entity, making additional API calls to retrieve the entity state redundant.
+
+#### ⚠️ Warning: Generic Pseudocode
+
+> **The provided pseudocode is intentionally generic and serves to illustrate the process of enhancing your API to leverage webhook payload signing. It is not a complete implementation.**
+>
+> Please ensure that you adapt and extend this code to meet the specific needs of your application, including appropriate security measures and error handling.
+For a detailed webhook payload signing mechanism understanding we highly recommend referring to our comprehensive
+[Webhook Payload Signing Documentation](https://app-wallee.com/doc/webhooks#_webhook_payload_signing_mechanism).
+
+```php
+public function handleWebhook() {
+    $requestPayload = file_get_contents('php://input');
+    $signature = $_SERVER['HTTP_X_SIGNATURE'] ?? '';
+
+    if (empty($signature)) {
+        // Make additional API call to retrieve the entity state
+        // ...
+    } else {
+        if ($client->getWebhookEncryptionService()->isContentValid($signature, $requestPayload)) {
+            // Parse requestPayload to extract 'state' value
+            // $state = ...
+            // Process entity's state change
+            // $this->processEntityStateChange($state);
+            // ...
+        }
+    }
+
+    // Process the received webhook data
+    // ...
+
+}
+```
+
 ## License
 
 Please see the [license file](https://github.com/wallee-payment/php-sdk/blob/master/LICENSE) for more information.
diff --git a/wallee-sdk/composer.json b/wallee-sdk/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "wallee/sdk",
-    "version": "3.2.0",
+    "version": "4.2.0",
 	"description": "wallee SDK for PHP",
 	"keywords": [
 		"wallee",
@@ -14,7 +14,8 @@
 	"authors": [
 		{
 			"name": "wallee AG",
-			"homepage": "https://wallee.com"
+			"email": "[email protected]",
+			"homepage": "https://www.wallee.com"
 		}
 	],
 	"require": {

diff --git a/wallee-sdk/lib/ApiClient.php b/wallee-sdk/lib/ApiClient.php
@@ -30,7 +30,7 @@
  *
  * @category Class
  * @package  Wallee\Sdk
- * @author   customweb GmbH
+ * @author   wallee AG
  * @license  http://www.apache.org/licenses/LICENSE-2.0 Apache License v2
  */
 final class ApiClient {
@@ -48,7 +48,7 @@ final class ApiClient {
 	 * @var array
 	 */
 	private $defaultHeaders = [
-        'x-meta-sdk-version' => "3.2.0",
+        'x-meta-sdk-version' => "4.2.0",
         'x-meta-sdk-language' => 'php',
         'x-meta-sdk-provider' => "wallee",
     ];
@@ -58,7 +58,7 @@ final class ApiClient {
 	 *
 	 * @var string
 	 */
-	private $userAgent = 'PHP-Client/3.2.0/php';
+	private $userAgent = 'PHP-Client/4.2.0/php';
 
 	/**
 	 * The path to the certificate authority file.
@@ -1833,6 +1833,18 @@ public function getWebAppService() {
         return $this->webAppService;
     }
 
+    protected $webhookEncryptionService;
+
+    /**
+     * @return \Wallee\Sdk\Service\WebhookEncryptionService
+     */
+    public function getWebhookEncryptionService() {
+        if(is_null($this->webhookEncryptionService)){
+            $this->webhookEncryptionService = new \Wallee\Sdk\Service\WebhookEncryptionService($this);
+        }
+        return $this->webhookEncryptionService;
+    }
+
     protected $webhookListenerService;
 
     /**

diff --git a/wallee-sdk/lib/ApiException.php b/wallee-sdk/lib/ApiException.php
@@ -27,7 +27,7 @@
  *
  * @category Class
  * @package  Wallee\Sdk
- * @author   customweb GmbH
+ * @author   wallee AG
  * @license  http://www.apache.org/licenses/LICENSE-2.0 Apache License v2
  */
 class ApiException extends Exception

diff --git a/wallee-sdk/lib/ApiResponse.php b/wallee-sdk/lib/ApiResponse.php
@@ -25,7 +25,7 @@
  *
  * @category Class
  * @package  Wallee\Sdk
- * @author   customweb GmbH
+ * @author   wallee AG
  * @license  http://www.apache.org/licenses/LICENSE-2.0 Apache License v2
  */
 class ApiResponse {

diff --git a/wallee-sdk/lib/Configuration.php b/wallee-sdk/lib/Configuration.php
@@ -26,7 +26,7 @@
  *
  * @category    Class
  * @package     Wallee\Sdk
- * @author      customweb GmbH
+ * @author      wallee AG
  * @license     http://www.apache.org/licenses/LICENSE-2.0 Apache License v2
  */
 class Configuration
@@ -80,7 +80,7 @@ class Configuration
      *
      * @var string
      */
-    protected $userAgent = 'Wallee\Sdk/3.2.0/php';
+    protected $userAgent = 'Wallee\Sdk/4.2.0/php';
 
     /**
      * Debug switch (default set to false)
@@ -388,8 +388,8 @@ public static function toDebugReport()
         $report  = 'PHP SDK (Wallee\Sdk) Debug Report:' . PHP_EOL;
         $report .= '    OS: ' . php_uname() . PHP_EOL;
         $report .= '    PHP Version: ' . PHP_VERSION . PHP_EOL;
-        $report .= '    OpenAPI Spec Version: 3.2.0' . PHP_EOL;
-        $report .= '    SDK Package Version: 3.2.0' . PHP_EOL;
+        $report .= '    OpenAPI Spec Version: 4.2.0' . PHP_EOL;
+        $report .= '    SDK Package Version: 4.2.0' . PHP_EOL;
         $report .= '    Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
 
         return $report;

diff --git a/wallee-sdk/lib/EncryptionUtil.php b/wallee-sdk/lib/EncryptionUtil.php
@@ -0,0 +1,77 @@
+<?php
+/**
+ * wallee SDK
+ *
+ * This library allows to interact with the wallee payment service.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+
+namespace Wallee\Sdk;
+
+use \Exception;
+
+/**
+ * EncryptionUtil Class Doc Comment
+ *
+ * @category    Class
+ * @package     Wallee\Sdk
+ * @author      wallee AG
+ * @license     http://www.apache.org/licenses/LICENSE-2.0 Apache License v2
+ */
+class EncryptionUtil
+{
+    /**
+	 * Verify content with signature
+     *
+	 * @param string $contentToVerify Content to verify (required)
+	 * @param string $contentSignature Content signature (required)
+	 * @param string $encodedPublicKey Base64 encoded public key (required)
+	 * @param string $signatureAlgorithm Signature algorithm (required)
+	 * @throws RuntimeException
+	 * @return bool
+	 */
+    public static function isContentValid($contentToVerify, $contentSignature, $encodedPublicKey, $signatureAlgorithm) {
+        switch ($signatureAlgorithm) {
+            case "SHA256withECDSA":
+                $publicKey = self::getPublicKey($encodedPublicKey);
+                $openSSLAlgorithm = OPENSSL_ALGO_SHA256;
+                break;
+            default:
+                throw new Exception("Unknown webhook signature encryption algorithm: " . $signatureAlgorithm);
+        }
+
+        $verification = openssl_verify($contentToVerify, base64_decode($contentSignature), $publicKey, $openSSLAlgorithm);
+
+        if (PHP_VERSION_ID < 80000) {
+            openssl_free_key($publicKey);
+        }
+
+        return $verification == 1;
+    }
+
+    private static function getPublicKey($encodedPublicKey) {
+        $pem = "-----BEGIN PUBLIC KEY-----\n" . chunk_split($encodedPublicKey, 64, "\n") . "-----END PUBLIC KEY-----";
+
+        // Create the public key resource
+        $publicKey = openssl_pkey_get_public($pem);
+
+        if (!$publicKey) {
+            throw new Exception("Failed to create public key from base64 string");
+        }
+
+        return $publicKey;
+    }
+
+}
diff --git a/wallee-sdk/lib/HeaderSelector.php b/wallee-sdk/lib/HeaderSelector.php
@@ -26,8 +26,8 @@
  *
  * @category Class
  * @package  Wallee\Sdk
- * @author      customweb GmbH
- * @license     http://www.apache.org/licenses/LICENSE-2.0 Apache License v2
+ * @author   wallee AG
+ * @license  http://www.apache.org/licenses/LICENSE-2.0 Apache License v2
  */
 class HeaderSelector
 {

diff --git a/wallee-sdk/lib/Http/ConnectionException.php b/wallee-sdk/lib/Http/ConnectionException.php
@@ -27,7 +27,7 @@
  *
  * @category Class
  * @package  Wallee\Sdk\Http
- * @author   customweb GmbH
+ * @author   wallee AG
  * @license  http://www.apache.org/licenses/LICENSE-2.0 Apache License v2
  */
 final class ConnectionException extends Exception {