[IMP] delivery_postlogistics: refactor API of web service class to avoid loss when several unchained modules implements new behaviors in it

Author: StephaneMangin

delivery_postlogistics/checklog-odoo.cfg

@@ -0,0 +1,3 @@
+[checklog-odoo]
+ignore=
+    WARNING.*DeprecationWarning

delivery_postlogistics/models/stock_picking.py

@@ -1,14 +1,19 @@
 # Copyright 2013 Camptocamp SA
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 import base64
+import logging
+from io import BytesIO
 from operator import attrgetter
 
 import lxml.html
+from PIL import Image
 
 from odoo import api, fields, models, tools
 from odoo.exceptions import UserError
 
-from ..postlogistics.web_service import PostlogisticsWebService
+from ..postlogistics.web_service import PostlogisticsWebService, sanitize_string
+
+_logger = logging.getLogger(__name__)
 
 
 class StockPicking(models.Model):
@@ -27,6 +32,16 @@ class StockPicking(models.Model):
         "Mobile", help="For notify delivery by telephone (ZAW3213)"
     )
 
+    def _get_packages_from_picking(self):
+        # As CI doesn't allow warnings, we need to log as info here
+        # (deprecated decorator is unhelpfull).
+        _logger.info(
+            "This method will be removed in version 18.0. \
+Please use _get_quant_packages_from_picking instead."
+        )
+        # TODO: remove this method in version > 18.0
+        return self._get_quant_packages_from_picking()
+
     def _get_quant_packages_from_picking(self):
         """Get all the quant packages from the picking"""
         self.ensure_one()
@@ -235,3 +250,209 @@ def action_generate_carrier_label(self):
         if not self.carrier_id:
             raise UserError(self.env._("Please, set a carrier."))
         self.env["delivery.carrier"].postlogistics_send_shipping(self)
+
+    #
+    # Postlogistics specific methods allowing proper override
+    #
+
+    def get_package_number_hook(self, package):
+        """Hook method to customize the package number retrieval"""
+        return None
+
+    def get_recipient_partner_hook(self):
+        """Hook method to customize the partner retrieval"""
+        self.ensure_one()
+        if self.picking_type_id.code != "outgoing":
+            return (
+                self.location_dest_id.company_id.partner_id
+                or self.env.user.company_id.partner_id
+            )
+        return self.partner_id
+
+    def postlogistics_label_prepare_attributes(
+        self, pack=None, pack_num=None, pack_total=None, pack_weight=None
+    ):
+        """This method aims to prepare a dictionary of attributes to be sent
+        to the PostLogistics API"""
+        self.ensure_one()
+        package_type = (
+            pack
+            and pack.package_type_id
+            or self.carrier_id.postlogistics_default_package_type_id
+        )
+        package_codes = package_type._get_shipper_package_code_list()
+
+        if pack_weight:
+            total_weight = pack_weight
+        else:
+            total_weight = pack.shipping_weight if pack else self.shipping_weight
+        total_weight *= 1000
+
+        if not package_codes:
+            raise UserError(
+                self.env._(
+                    "No PostLogistics packaging services found "
+                    "in package type {package_type_name}, for picking {picking_name}."
+                ).format(package_type_name=package_type.name, picking_name=self.name)
+            )
+
+        # Activate phone notification ZAW3213
+        # if phone call notification is set on partner
+        if self.partner_id.postlogistics_notification == "phone":
+            package_codes.append("ZAW3213")
+
+        attributes = {
+            "weight": int(total_weight),
+        }
+
+        # Remove the services if the delivery fixed date is not set
+        if "ZAW3217" in package_codes:
+            if self.delivery_fixed_date:
+                attributes["deliveryDate"] = self.delivery_fixed_date
+            else:
+                package_codes.remove("ZAW3217")
+
+        # parcelNo / parcelTotal cannot be used if service ZAW3218 is not activated
+        if "ZAW3218" in package_codes:
+            if pack_total > 1:
+                attributes.update(
+                    {"parcelTotal": pack_total - 1, "parcelNo": pack_num - 1}
+                )
+            else:
+                package_codes.remove("ZAW3218")
+
+        if "ZAW3219" in package_codes and self.delivery_place:
+            attributes["deliveryPlace"] = self.delivery_place
+        if self.carrier_id.postlogistics_proclima_logo:
+            attributes["proClima"] = True
+        else:
+            attributes["proClima"] = False
+
+        attributes["przl"] = package_codes
+
+        return attributes
+
+    def postlogistics_label_prepare_customer(self):
+        """Create a ns0:Customer as a dict from picking
+
+        This is the PostLogistics Customer, thus the sender
+
+        :param picking: picking browse record
+        :return a dict containing data for ns0:Customer
+
+        """
+        self.ensure_one()
+        company = self.company_id
+        partner = company.partner_id
+        if self.picking_type_id.code != "outgoing":
+            partner = self.partner_id
+
+        partner_name = partner.name or partner.parent_id.name
+        if not partner_name:
+            raise UserError(self.env._("Customer name is required."))
+        customer = {
+            "name1": sanitize_string(partner_name)[:25],
+            "street": sanitize_string(partner.street)[:25],
+            "zip": sanitize_string(partner.zip)[:10],
+            "city": sanitize_string(partner.city)[:25],
+            "country": partner.country_id.code,
+            "domicilePostOffice": self.carrier_id.postlogistics_office or None,
+        }
+        logo = self.carrier_id.postlogistics_logo
+        if logo:
+            logo_image = Image.open(BytesIO(base64.b64decode(logo)))
+            logo_format = logo_image.format
+            customer["logo"] = logo.decode()
+            customer["logoFormat"] = logo_format
+        return customer
+
+    def postlogistics_label_prepare_recipient(self, sanitize_mapping=None):
+        """Create a ns0:Recipient as a dict from a partner
+
+        :param partner: partner browse record
+        :return a dict containing data for ns0:Recipient
+
+        """
+        partner = self.get_recipient_partner_hook()
+
+        partner_mobile = sanitize_string(
+            self.delivery_mobile or partner.mobile, sanitize_mapping
+        )
+        partner_phone = sanitize_string(
+            self.delivery_phone or partner.phone, sanitize_mapping
+        )
+
+        if partner.postlogistics_notification == "email" and not partner.email:
+            raise UserError(self.env._("Email is required for notification."))
+        elif partner.postlogistics_notification == "sms" and not partner_mobile:
+            raise UserError(
+                self.env._("Mobile number is required for sms notification.")
+            )
+        elif partner.postlogistics_notification == "phone" and not partner_phone:
+            raise UserError(
+                self.env._("Phone number is required for phone call notification.")
+            )
+
+        if not partner.street:
+            raise UserError(self.env._("Partner street is required."))
+
+        if not partner.name and not partner.parent_id.name:
+            raise UserError(self.env._("Partner name is required."))
+
+        if not partner.zip:
+            raise UserError(self.env._("Partner zip is required."))
+
+        if not partner.city:
+            raise UserError(self.env._("Partner city is required."))
+
+        partner_name = partner.name or partner.parent_id.name
+        sanitized_partner_name = sanitize_string(partner_name, sanitize_mapping)
+        partner_street = sanitize_string(partner.street, sanitize_mapping)
+        partner_zip = sanitize_string(partner.zip, sanitize_mapping)
+        partner_city = sanitize_string(partner.city, sanitize_mapping)
+        recipient = {
+            "name1": sanitized_partner_name[:35],
+            "street": partner_street[:35],
+            "zip": partner_zip[:10],
+            "city": partner_city[:35],
+        }
+
+        if partner.country_id.code:
+            country_code = sanitize_string(
+                partner.country_id.code.upper(), sanitize_mapping
+            )
+            recipient["country"] = country_code
+
+        if partner.street2:
+            # addressSuffix is shown before street on label
+            recipient["addressSuffix"] = recipient["street"]
+            recipient["street"] = sanitize_string(
+                partner.street2[:35], sanitize_mapping
+            )
+
+        company_partner_name = partner.commercial_company_name
+        if company_partner_name and company_partner_name != partner_name:
+            parent_name = sanitize_string(partner.parent_id.name, sanitize_mapping)
+            recipient["name2"] = parent_name[:35]
+            recipient["personallyAddressed"] = False
+
+        # Phone and / or mobile should only be displayed if instruction to
+        # Notify delivery by telephone is set
+        if partner.postlogistics_notification == "email":
+            recipient["email"] = sanitize_string(partner.email, sanitize_mapping)
+        elif partner.postlogistics_notification == "phone":
+            recipient["phone"] = sanitize_string(partner_phone, sanitize_mapping)
+            if partner_mobile:
+                recipient["mobile"] = partner_mobile
+        elif partner.postlogistics_notification == "sms":
+            recipient["mobile"] = partner_mobile
+
+        return recipient
+
+    def postlogistics_label_cash_on_delivery(self, package=None):
+        amount = (package or self).postlogistics_cod_amount()
+        amount = f"{amount:.2f}"
+        return [{"Type": "NN_BETRAG", "Value": amount}]
+
+    def postlogistics_label_get_item_additional_data(self, package=None):
+        return []