ODOO-236: Upgrade MultiSafepay Cloud POS module for Odoo 19 compatibility

Author: zulquer

pos_multisafepay_cloud/README.rst

@@ -17,7 +17,7 @@ PoS MultiSafepay Cloud
     :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
     :alt: License: AGPL-3
 .. |badge3| image:: https://img.shields.io/badge/github-%2Fmultisafepay-lightgray.png?logo=github
-    :target: https://github.com//multisafepay/tree/18.0/pos_multisafepay_cloud
+    :target: https://github.com//multisafepay/tree/19.0/pos_multisafepay_cloud
     :alt: /multisafepay
 
 |badge1| |badge2| |badge3|
@@ -100,7 +100,7 @@ Bug Tracker
 Bugs are tracked on `GitHub Issues <https://github.com//multisafepay/issues>`_.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us to smash it by providing a detailed and welcomed
-`feedback <https://github.com//multisafepay/issues/new?body=module:%20pos_multisafepay_cloud%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com//multisafepay/issues/new?body=module:%20pos_multisafepay_cloud%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
 
 Do not contact contributors directly about support or help with technical issues.
 
@@ -120,6 +120,6 @@ Contributors
 Maintainers
 -----------
 
-This module is part of the `/multisafepay <https://github.com//multisafepay/tree/18.0/pos_multisafepay_cloud>`_ project on GitHub.
+This module is part of the `/multisafepay <https://github.com//multisafepay/tree/19.0/pos_multisafepay_cloud>`_ project on GitHub.
 
 You are welcome to contribute.

pos_multisafepay_cloud/__manifest__.py

@@ -2,7 +2,7 @@
     "name": "PoS MultiSafepay Cloud",
     "summary": "PoC for MultiSafepay Cloud POS payments in Odoo POS",
     "author": "MultiSafepay",
-    "website": "https://github.com/multisafepay",
+    "website": "https://github.com//multisafepay",
     "license": "AGPL-3",
     "category": "Point of Sale",
     "version": "19.0.1.0.0",

pos_multisafepay_cloud/controllers/main.py

@@ -3,7 +3,6 @@
 # See the LICENSE.md file for more information.
 # See the DISCLAIMER.md file for disclaimer details
 
-import json
 import logging
 
 from odoo import http
@@ -84,4 +83,3 @@ def notification(self, **kwargs):
             notification.get("transaction_id"),
         )
         return request.make_response("OK", status=200)
-

pos_multisafepay_cloud/helpers/error_payload.py

@@ -50,7 +50,9 @@ def format_exception(error):
         return f"{error_type}: {error_message}" if error_message else error_type
 
     @classmethod
-    def build(cls, payment_method_or_detail, default_detail=None, error=None, operation=None):
+    def build(
+        cls, payment_method_or_detail, default_detail=None, error=None, operation=None
+    ):
         """Build a POS-friendly error payload for Cloud POS API failures.
 
         Can be called with a simple text message:
@@ -69,12 +71,15 @@ def build(cls, payment_method_or_detail, default_detail=None, error=None, operat
         if default_detail is None and isinstance(payment_method_or_detail, str):
             final_detail = payment_method_or_detail
         else:
-            final_detail = cls.humanize(
-                payment_method_or_detail,
-                cls.format_exception(error),
-                default_detail,
-                operation=operation,
-            ) or default_detail
+            final_detail = (
+                cls.humanize(
+                    payment_method_or_detail,
+                    cls.format_exception(error),
+                    default_detail,
+                    operation=operation,
+                )
+                or default_detail
+            )
 
         return {
             "status": "error",

pos_multisafepay_cloud/helpers/frontend_response_builder.py

@@ -3,10 +3,10 @@
 # See the LICENSE.md file for more information.
 # See the DISCLAIMER.md file for disclaimer details
 
-from odoo.addons.pos_multisafepay_cloud.helpers.status import _Status
 from odoo.addons.pos_multisafepay_cloud.helpers.error_payload import (
     _ErrorPayload,
 )
+from odoo.addons.pos_multisafepay_cloud.helpers.status import _Status
 
 
 class _FrontendResponseBuilder:

pos_multisafepay_cloud/helpers/notification_payload.py

@@ -8,6 +8,7 @@
 from decimal import Decimal
 
 from odoo import _
+
 from odoo.addons.pos_multisafepay_cloud.helpers.utils import (
     _Utils,
 )

pos_multisafepay_cloud/helpers/notification_validator.py

@@ -41,7 +41,9 @@ def validate(cls, payment_name, payment_method, raw_body=None, auth_header=None)
             )
             return False
 
-        return cls._validate_with_api_keys(payment_name, raw_body, auth_header, api_keys)
+        return cls._validate_with_api_keys(
+            payment_name, raw_body, auth_header, api_keys
+        )
 
     @staticmethod
     def _get_api_keys(payment_method):

pos_multisafepay_cloud/helpers/odoo_payload_builder.py

@@ -3,10 +3,10 @@
 # See the LICENSE.md file for more information.
 # See the DISCLAIMER.md file for disclaimer details
 
-from odoo.addons.pos_multisafepay_cloud.helpers.status import _Status
 from odoo.addons.pos_multisafepay_cloud.helpers.order_context_builder import (
     _OrderContextBuilder,
 )
+from odoo.addons.pos_multisafepay_cloud.helpers.status import _Status
 
 
 class _OdooPayloadBuilder:
@@ -42,8 +42,10 @@ def create_values(response, data, terminal_id, status):
             "session_id": data.get("session_id"),
             "terminal_id": terminal_id,
             "events_token": response.get("events_token") or response.get("event_token"),
-            "remote_transaction_id": response.get("transaction_id") or response.get("order_id"),
-            "events_stream_url": response.get("events_stream_url") or response.get("event_stream_url"),
+            "remote_transaction_id": response.get("transaction_id")
+            or response.get("order_id"),
+            "events_stream_url": response.get("events_stream_url")
+            or response.get("event_stream_url"),
             "last_event_id": response.get("last_event_id"),
             "msp_latest_response": payload,
             "status": status,
@@ -62,12 +64,18 @@ def write_for_cancel(payment, cancellation):
         :rtype: dict
         """
         status = _Status.normalize(cancellation.get("status") or "canceled")
-        payload = (payment.msp_latest_response or {}) | cancellation | {
-            "status": status,
-            "state": _Status.state(status),
-            "order_id": payment.name,
-            "transaction_id": cancellation.get("transaction_id") or payment.remote_transaction_id or payment.name,
-        }
+        payload = (
+            (payment.msp_latest_response or {})
+            | cancellation
+            | {
+                "status": status,
+                "state": _Status.state(status),
+                "order_id": payment.name,
+                "transaction_id": cancellation.get("transaction_id")
+                or payment.remote_transaction_id
+                or payment.name,
+            }
+        )
         return {
             "msp_latest_response": payload,
             "status": status,
@@ -136,14 +144,20 @@ def write_for_notification(cls, payment, payload, method, now_string):
             "notification_method": method,
             "notification_received_at": now_string,
         }
-        for key in ("last_status_refresh_error", "last_status_refresh_error_at", "last_status_refresh_error_source"):
+        for key in (
+            "last_status_refresh_error",
+            "last_status_refresh_error_at",
+            "last_status_refresh_error_source",
+        ):
             latest_response.pop(key, None)
 
         write_vals = {
             "status": status,
             "remote_transaction_id": transaction_id,
             "stream_state": "done" if state != "pending" else payment.stream_state,
-            "stream_lock_until": False if state != "pending" else payment.stream_lock_until,
+            "stream_lock_until": False
+            if state != "pending"
+            else payment.stream_lock_until,
         }
 
         cls._append_events(payload, write_vals, latest_response)
@@ -185,7 +199,9 @@ def _append_events(payload, write_vals, latest_response):
 
         stream_url = payload.get("events_stream_url") or payload.get("event_stream_url")
         if stream_url:
-            write_vals["events_stream_url"] = latest_response["events_stream_url"] = stream_url
+            write_vals["events_stream_url"] = latest_response["events_stream_url"] = (
+                stream_url
+            )
 
     @staticmethod
     def write_for_refresh_error(payment, remote_status, source, now_string):
@@ -238,10 +254,14 @@ def write_for_cancel_error(payment, cancellation):
         :return: A tuple of write values dictionary and error payload dictionary.
         :rtype: tuple[dict, dict]
         """
-        payload = (payment.msp_latest_response or {}) | cancellation | {
-            "order_id": payment.name,
-            "transaction_id": payment.remote_transaction_id or payment.name,
-        }
+        payload = (
+            (payment.msp_latest_response or {})
+            | cancellation
+            | {
+                "order_id": payment.name,
+                "transaction_id": payment.remote_transaction_id or payment.name,
+            }
+        )
         write_vals = {
             "msp_latest_response": payload,
             "status": "error",

pos_multisafepay_cloud/helpers/order_context_builder.py

@@ -34,7 +34,9 @@ def from_payload(cls, data):
             "odoo_order_amount": data.get("amount") if isinstance(data, dict) else None,
             "odoo_shopping_cart_item_count": len(items),
             "odoo_shopping_cart_amount": float(cart_amount),
-            "odoo_shopping_cart_amount_cents": _Utils.amount_to_minor_units(cart_amount),
+            "odoo_shopping_cart_amount_cents": _Utils.amount_to_minor_units(
+                cart_amount
+            ),
             "odoo_tip_amount": float(tip_amount),
             "odoo_tip_amount_cents": _Utils.amount_to_minor_units(tip_amount),
             "odoo_tip_line_count": tip_line_count,

pos_multisafepay_cloud/helpers/order_payload_builder.py

@@ -20,6 +20,7 @@
 from multisafepay.api.shared.customer import Customer
 
 from odoo import _
+
 from odoo.addons.pos_multisafepay_cloud.helpers.utils import (
     _Utils,
 )
@@ -163,9 +164,7 @@ def _apply_cart_item_taxes(cart_item, item_data):
         """
         tax_rate_percentage = item_data.get("tax_rate_percentage")
         if tax_rate_percentage is not None:
-            cart_item.add_tax_rate(
-                _Utils.tax_rate_from_percentage(tax_rate_percentage)
-            )
+            cart_item.add_tax_rate(_Utils.tax_rate_from_percentage(tax_rate_percentage))
         elif item_data.get("tax_table_selector") is not None:
             cart_item.add_tax_table_selector(str(item_data.get("tax_table_selector")))
         else:
@@ -196,9 +195,7 @@ def customer(cls, customer_data):
             "zip_code": truncate_text(customer_data.get("zip_code"), 64),
             "city": truncate_text(customer_data.get("city"), 255),
             "state": truncate_text(customer_data.get("state"), 255),
-            "country": _Utils.format_country_code(
-                customer_data.get("country")
-            ),
+            "country": _Utils.format_country_code(customer_data.get("country")),
             "phone": truncate_text(customer_data.get("phone"), 64),
             "email": _Utils.format_email(customer_data.get("email")),
         }