Release 1.1.8

changelog.md

@@ -145,5 +145,12 @@
 - BO : Added PrestaShop module security validations
 - FO : Added PrestaShop module security validations
 
+## [1.1.8] - *
+- BO : Added a toggle setting for Saferpay email sending option
+- BO : Added a configuration field for the customization of the description parameter
+- BO : Increased module's API version
+- BO : Added a more descriptive payment method name in invoices
+- BO : Additional improvements and fixes
+
 - ## [1.2.0] - *
-- BO : Added order creation after authorization functionality
+- BO : Added order creation after authorization functionality

controllers/admin/AdminSaferPayOfficialSettingsController.php

@@ -30,6 +30,8 @@
 
 class AdminSaferPayOfficialSettingsController extends ModuleAdminController
 {
+    const FILE_NAME = 'AdminSaferPayOfficialSettingsController';
+
     public function __construct()
     {
         parent::__construct();
@@ -327,6 +329,13 @@ public function initOptions()
                             'cast' => 'intval',
                             'type' => 'bool',
                         ],
+                        SaferPayConfig::SAFERPAY_ALLOW_SAFERPAY_SEND_CUSTOMER_MAIL => [
+                            'title' => $this->l('Send an email from Saferpay on payment completion'),
+                            'desc' => $this->l('With this setting enabled an email from the Saferpay system will be sent to the customer'),
+                            'validation' => 'isBool',
+                            'cast' => 'intval',
+                            'type' => 'bool',
+                        ],
                         SaferPayConfig::SAFERPAY_SEND_NEW_ORDER_MAIL => [
                             'title' => $this->l('Send new order mail on authorization'),
                             'desc' => $this->l('Receive a notification when an order is authorized by Saferpay (Using the Mail alert module)'),
@@ -352,6 +361,7 @@ public function initOptions()
         }
 
         $this->fields_options[] = $this->getFieldOptionsOrderState();
+        $this->fields_options[] = $this->displayConfigurationSettings();
     }
 
     private function getFieldOptionsOrderState()
@@ -385,6 +395,32 @@ private function getFieldOptionsOrderState()
         ];
     }
 
+    /**
+     * @return array
+     */
+    private function displayConfigurationSettings()
+    {
+        return [
+            'title' => $this->module->l('Configuration', self::FILE_NAME),
+            'fields' => [
+                SaferPayConfig::SAFERPAY_PAYMENT_DESCRIPTION => [
+                    'title' => $this->module->l('Description', self::FILE_NAME),
+                    'type' => 'text',
+                    'desc' => 'This description is visible in payment page also in payment confirmation email',
+                    'class' => 'fixed-width-xxl'
+                ],
+            ],
+            'buttons' => [
+                'save_and_connect' => [
+                    'title' => $this->module->l('Save', self::FILE_NAME),
+                    'icon' => 'process-icon-save',
+                    'class' => 'btn btn-default pull-right',
+                    'type' => 'submit',
+                ],
+            ],
+        ];
+    }
+
     public function setMedia($isNewTheme = false)
     {
         parent::setMedia($isNewTheme);

controllers/front/successIFrame.php

@@ -84,7 +84,7 @@ public function postProcess()
                     'cartId' => $cartId,
                     'secureKey' => $secureKey,
                     'orderId' => $orderId,
-                    \Invertus\SaferPay\Config\SaferPayConfig::IS_BUSINESS_LICENCE => true,
+                    'moduleId' => $moduleId,
                 ],
                 true
             ));
@@ -115,7 +115,24 @@ public function postProcess()
             ));
         }
 
-        $orderStatusService->authorize($order);
+        try {
+            $orderStatusService->authorize($order);
+
+            Tools::redirect($this->getOrderConfirmationLink($cartId, $moduleId, $orderId, $secureKey));
+        } catch (Exception $exception) {
+            $this->warning[] = $this->module->l('We couldn\'t authorize your payment. Please try again.', self::FILENAME);
+            $this->redirectWithNotifications($this->context->link->getModuleLink(
+                $this->module->name,
+                ControllerName::FAIL_IFRAME,
+                [
+                    'cartId' => $cartId,
+                    'secureKey' => $secureKey,
+                    'orderId' => $orderId,
+                    'moduleId' => $moduleId,
+                ],
+                true
+            ));
+        }
 
         $paymentBehaviour = (int) Configuration::get(SaferPayConfig::PAYMENT_BEHAVIOR);
 

saferpayofficial.php

@@ -111,6 +111,47 @@ public function getService($service)
         return $containerProvider->getService($service);
     }
 
+    public function hookActionObjectOrderPaymentAddAfter($params)
+    {
+        if (!isset($params['object'])) {
+            return;
+        }
+
+        /** @var OrderPayment $orderPayment */
+        $orderPayment = $params['object'];
+
+        if (!Validate::isLoadedObject($orderPayment)) {
+            return;
+        }
+
+        /** @var \Invertus\SaferPay\Repository\SaferPayOrderRepository $saferPayOrderRepository */
+        $saferPayOrderRepository = $this->getService(\Invertus\SaferPay\Repository\SaferPayOrderRepository::class);
+
+        $orders = Order::getByReference($orderPayment->order_reference);
+
+        /** @var Order|bool $order */
+        $order = $orders->getFirst();
+
+        if (!Validate::isLoadedObject($order) || !$order) {
+            return;
+        }
+
+        $saferPayOrderId = (int) $saferPayOrderRepository->getIdByOrderId($order->id);
+
+        if (!$saferPayOrderId) {
+            return;
+        }
+
+        $brand = $saferPayOrderRepository->getPaymentBrandBySaferpayOrderId($saferPayOrderId);
+
+        if (!$brand) {
+            return;
+        }
+
+        $orderPayment->payment_method = 'Saferpay - ' . $brand;
+        $orderPayment->update();
+    }
+
     public function hookPaymentOptions($params)
     {
         /** @var Invertus\SaferPay\Service\SaferPayCartService $assertService */

src/Api/ApiRequest.php

@@ -42,7 +42,7 @@ class ApiRequest
      *
      * @param string $url
      * @param array $params
-     * @return array |null
+     * @return object|null
      * @throws Exception
      */
     public function post($url, $params = [])

src/Api/Request/AssertService.php

@@ -69,7 +69,7 @@ public function __construct(
      * @param AssertRequest $assertRequest
      * @param int $saferPayOrderId
      *
-     * @return array|null
+     * @return object|null
      * @throws \Exception
      */
     public function assert(AssertRequest $assertRequest, $saferPayOrderId)
@@ -78,8 +78,13 @@ public function assert(AssertRequest $assertRequest, $saferPayOrderId)
 
         $assertApi = self::ASSERT_API_PAYMENT;
 
+        //TODO: refactor this to use authorize request.
+        // naming is weird. With transaction, we do a request to an authorize endpoint but name it assert ?
+        // also we call authorize method in some of the success controllers, so if we leave the logic here,
+        // we get an error with TRANSACTION_IN_WRONG_STATE
         if ($saferPayOrder->is_transaction) {
-            $assertApi = self::ASSERT_API_TRANSACTION;
+            return null;
+//          $assertApi = self::ASSERT_API_TRANSACTION;
         }
 
         try {
@@ -93,7 +98,7 @@ public function assert(AssertRequest $assertRequest, $saferPayOrderId)
     }
 
     /**
-     * @param object $responseBody
+     * @param object|null $responseBody
      * @param int $saferPayOrderId
      *
      * @return AssertBody

src/Config/SaferPayConfig.php

@@ -50,7 +50,7 @@ class SaferPayConfig
     const CONFIGURATION_NAME = 'SAFERPAY_CONFIGURATION_NAME';
     const CSS_FILE = 'SAFERPAY_CSS_FILE';
     const TEST_SUFFIX = '_TEST';
-    const API_VERSION = 1.32;
+    const API_VERSION = 1.37;
     const PAYMENT_METHODS = [
         self::PAYMENT_ALIPAY,
         self::PAYMENT_AMEX,
@@ -72,7 +72,6 @@ class SaferPayConfig
         self::PAYMENT_POSTFINANCE,
         self::PAYMENT_SOFORT,
         self::PAYMENT_TWINT,
-        self::PAYMENT_UNIONPAY,
         self::PAYMENT_VISA,
         self::PAYMENT_VPAY,
         self::PAYMENT_APPLEPAY,
@@ -100,21 +99,22 @@ class SaferPayConfig
     const PAYMENT_POSTFINANCE = 'POSTFINANCE';
     const PAYMENT_SOFORT = 'SOFORT';
     const PAYMENT_TWINT = 'TWINT';
-    const PAYMENT_UNIONPAY = 'UNIONPAY';
     const PAYMENT_VISA = 'VISA';
     const PAYMENT_VPAY = 'VPAY';
     const PAYMENT_KLARNA = 'KLARNA';
     const PAYMENT_APPLEPAY = 'APPLEPAY';
     const PAYMENT_WLCRYPTOPAYMENTS = 'WLCRYPTOPAYMENTS';
     const PAYMENT_GOOGLEPAY = 'GOOGLEPAY';
-    const PAYMENT_MASTERPASS = 'MASTERPASS';
     const PAYMENT_BONUS = 'BONUS';
     const PAYMENT_LASTSCHRIFT = 'DIRECTDEBIT';
+    const PAYMENT_ACCOUNTTOACCOUNT = 'ACCOUNTTOACCOUNT';
+    const PAYMENT_PAYCONIQ = 'PAYCONIQ';
+    const PAYMENT_CARD = 'CARD';
+    const PAYMENT_POSTFINANCE_PAY = 'POSTFINANCEPAY';
 
     const WALLET_PAYMENT_METHODS = [
         self::PAYMENT_APPLEPAY,
         self::PAYMENT_GOOGLEPAY,
-        self::PAYMENT_MASTERPASS,
     ];
 
     const PAYMENT_METHODS_KEYS = [
@@ -127,18 +127,20 @@ class SaferPayConfig
         'KlarnaPayments' => self::PAYMENT_KLARNA,
         'MaestroInternational' => self::PAYMENT_MAESTRO,
         'Mastercard' => self::PAYMENT_MASTERCARD,
-        'Masterpass' =>self::PAYMENT_MASTERPASS,
         'myOne' => self::PAYMENT_MYONE,
         'paydirekt' => self::PAYMENT_PAYDIREKT,
         'PayPal' => self::PAYMENT_PAYPAL,
         'Twint' => self::PAYMENT_TWINT,
-        'UnionPay' => self::PAYMENT_UNIONPAY,
         'Visa' => self::PAYMENT_VISA,
         'WLCryptoPayments' => self::PAYMENT_WLCRYPTOPAYMENTS,
         'Postcard' => self::PAYMENT_POSTCARD,
         'BonusCard' => self::PAYMENT_BONUS,
         'Lastschrift' => self::PAYMENT_LASTSCHRIFT,
         'SOFORTUEBERWEISUNG' => self::PAYMENT_SOFORT,
+        'AccountToAccount' => self::PAYMENT_ACCOUNTTOACCOUNT,
+        'Payconiq' => self::PAYMENT_PAYCONIQ,
+        'Card' => self::PAYMENT_CARD,
+        'PostFinancePay' => self::PAYMENT_POSTFINANCE_PAY,
     ];
 
     const FIELD_SUPPORTED_PAYMENT_METHODS = [
@@ -204,12 +206,12 @@ class SaferPayConfig
         self::PAYMENT_MASTERCARD,
         self::PAYMENT_VISA,
         self::PAYMENT_VPAY,
-        self::PAYMENT_UNIONPAY,
         self::PAYMENT_APPLEPAY,
         self::PAYMENT_AMEX,
     ];
 
     const WEB_SERVICE_PASSWORD_PLACEHOLDER = '••••••';
+
     const SAFERPAY_PAYMENT_COMPLETED = 'SAFERPAY_PAYMENT_COMPLETED';
     const SAFERPAY_PAYMENT_AUTHORIZED = 'SAFERPAY_PAYMENT_AUTHORIZED';
     const SAFERPAY_PAYMENT_REJECTED = 'SAFERPAY_PAYMENT_REJECTED';
@@ -219,14 +221,19 @@ class SaferPayConfig
     const SAFERPAY_PAYMENT_PENDING_REFUND = 'SAFERPAY_PAYMENT_PENDING_REFUND';
     const SAFERPAY_PAYMENT_CANCELED = 'SAFERPAY_PAYMENT_CANCELED';
     const SAFERPAY_PAYMENT_AUTHORIZATION_FAILED = 'SAFERPAY_PAYMENT_AUTHORIZATION_FAILED';
+
     const SAFERPAY_SEND_ORDER_CONFIRMATION = 'SAFERPAY_SEND_ORDER_CONFIRMATION';
     const SAFERPAY_SEND_NEW_ORDER_MAIL = 'SAFERPAY_SEND_NEW_ORDER_MAIL';
+    const SAFERPAY_ALLOW_SAFERPAY_SEND_CUSTOMER_MAIL = 'SAFERPAY_ALLOW_SAFERPAY_SEND_CUSTOMER_MAIL';
     const SAFERPAY_ORDER_CREATION_AFTER_AUTHORIZATION = 'SAFERPAY_ORDER_CREATION_AFTER_AUTHORIZATION';
 
     const STATUS_PS_OS_OUTOFSTOCK_PAID = 'PS_OS_OUTOFSTOCK_PAID';
 
     const SAFERPAY_ORDER_STATE_CHOICE_AWAITING_PAYMENT = 'SAFERPAY_ORDER_STATE_CHOICE_AWAITING_PAYMENT';
 
+    const SAFERPAY_PAYMENT_DESCRIPTION = 'SAFERPAY_PAYMENT_DESCRIPTION';
+    const SAFERPAY_PAYMENT_DESCRIPTION_DEFAULT_VALUE = 'Prestashop Payment';
+
     const SAFERPAY_TEMPLATE_LOCATION = 'module:saferpayofficial/views/templates/';
     const SAFERPAY_HOSTED_TEMPLATE_LOCATION = 'module:saferpayofficial/views/templates/front/hosted-templates/';
 
@@ -241,10 +248,6 @@ class SaferPayConfig
     const TRANSACTION_STATUS_PENDING = 'PENDING';
     const TRANSACTION_STATUS_CANCELED = 'CANCELED';
 
-    const LOG_TYPE_SUCCESS = 'SUCCESS';
-    const LOG_TYPE_ERROR = 'ERROR';
-    const LOG_TYPE_CRITICAL_ERROR = 'CRITICAL ERROR';
-
     const FIELDS_ACCESS_TOKEN = 'SAFERPAY_FIELDS_ACCESS_TOKEN';
     const FIELDS_LIBRARY = 'SAFERPAY_FIELDS_JAVASCRIPT_LIBRARY';
     const FIELDS_LIBRARY_DEFAULT_VALUE = 'https://www.saferpay.com/Fields/lib/1/saferpay-fields.js';
@@ -331,12 +334,14 @@ public static function getBaseUrl()
     public static function getDefaultConfiguration()
     {
         return [
-            RequestHeader::SPEC_VERSION => '1.32',
-            RequestHeader::SPEC_REFUND_VERSION => '1.32',
+            RequestHeader::SPEC_VERSION => '1.37',
+            RequestHeader::SPEC_REFUND_VERSION => '1.37',
             RequestHeader::RETRY_INDICATOR => 0,
             SaferPayConfig::PAYMENT_BEHAVIOR => 1,
             SaferPayConfig::PAYMENT_BEHAVIOR_WITHOUT_3D => 1,
             SaferPayConfig::SAFERPAY_SEND_ORDER_CONFIRMATION => 1,
+            SaferPayConfig::SAFERPAY_ALLOW_SAFERPAY_SEND_CUSTOMER_MAIL => 1,
+            SaferPayConfig::SAFERPAY_PAYMENT_DESCRIPTION => self::SAFERPAY_PAYMENT_DESCRIPTION_DEFAULT_VALUE,
             SaferPayConfig::FIELDS_LIBRARY => self::FIELDS_LIBRARY_DEFAULT_VALUE,
             SaferPayConfig::FIELDS_LIBRARY . SaferPayConfig::TEST_SUFFIX => self::FIELDS_LIBRARY_TEST_DEFAULT_VALUE,
             self::SAFERPAY_ORDER_CREATION_AFTER_AUTHORIZATION => 0,
@@ -354,6 +359,8 @@ public static function getUninstallConfiguration()
             RequestHeader::SPEC_VERSION,
             RequestHeader::RETRY_INDICATOR,
             RequestHeader::SPEC_REFUND_VERSION,
+            self::SAFERPAY_ALLOW_SAFERPAY_SEND_CUSTOMER_MAIL,
+            self::SAFERPAY_PAYMENT_DESCRIPTION,
             self::TEST_MODE,
             self::USERNAME,
             self::PASSWORD,

src/DTO/Request/Assert/AssertRequest.php

@@ -29,6 +29,8 @@
     exit;
 }
 
+// TODO: A lot of these request are the same, we can at least put them under an interface
+
 class AssertRequest
 {
 

src/DTO/Request/Initialize/InitializeRequest.php

@@ -226,11 +226,14 @@ public function getAsArray()
 
         if ($this->notification !== null) {
             $return['Notification'] = [
-                'PayerEmail' => $this->notification->getPayerEmail(),
                 'MerchantEmails' => [$this->notification->getMerchantEmail()],
                 'SuccessNotifyUrl' => $this->notification->getNotifyUrl(),
                 'FailNotifyUrl' => $this->notification->getNotifyUrl(),
             ];
+
+            if (\Configuration::get(SaferPayConfig::SAFERPAY_ALLOW_SAFERPAY_SEND_CUSTOMER_MAIL)) {
+                $return['Notification'] = ['PayerEmail' => $this->notification->getPayerEmail()];
+            }
         }
 
         if ($this->configSet) {

src/DTO/Request/Payment.php

@@ -50,9 +50,9 @@ class Payment
     private $payerNote = null;
 
     /**
-     * @var null
+     * @var string
      */
-    private $description = 'PrestaShop payment';
+    private $description;
 
     /**
      * @return string
@@ -119,15 +119,15 @@ public function setPayerNote($payerNote)
     }
 
     /**
-     * @return null
+     * @return string
      */
     public function getDescription()
     {
         return $this->description;
     }
 
     /**
-     * @param null $description
+     * @param string $description
      */
     public function setDescription($description)
     {