From 05adb5c40f5b02c0f91aabe1453f048520bfd55b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20BEAU?= Date: Tue, 25 Aug 2020 18:16:26 +0200 Subject: [PATCH 1/2] [IMP] add carrier code into api response and remove duplicated code #417 --- .../services/abstract_sale.py | 24 ++++++++----------- .../services/delivery_carrier.py | 5 ++++ shopinvader_delivery_carrier/tests/common.py | 2 ++ .../tests/test_carrier.py | 22 +++++++++++++++++ .../tests/test_delivery_carrier.py | 4 ++++ 5 files changed, 43 insertions(+), 14 deletions(-) diff --git a/shopinvader_delivery_carrier/services/abstract_sale.py b/shopinvader_delivery_carrier/services/abstract_sale.py index a94c85fd69..f388e9beea 100644 --- a/shopinvader_delivery_carrier/services/abstract_sale.py +++ b/shopinvader_delivery_carrier/services/abstract_sale.py @@ -9,14 +9,14 @@ class AbstractSaleService(AbstractComponent): def _convert_shipping(self, cart): res = super(AbstractSaleService, self)._convert_shipping(cart) - selected_carrier = {} if cart.carrier_id: - carrier = cart.carrier_id - selected_carrier = { - "id": carrier.id, - "name": carrier.name, - "description": carrier.name, - } + # we do not need an estimation of the price + # so we do not pass the cart to the _prepare_carrier method + # and we remove the field + selected_carrier = self._prepare_carrier(cart.carrier_id) + selected_carrier.pop("price") + else: + selected_carrier = {} res.update( { "amount": { @@ -51,13 +51,9 @@ def _convert_amount(self, sale): ) return result - def _prepare_carrier(self, carrier, cart): - return { - "id": carrier.id, - "name": carrier.name, - "description": carrier.name, - "price": carrier.rate_shipment(cart).get("price", 0.0), - } + def _prepare_carrier(self, carrier, cart=None): + service = self.component(usage="delivery_carrier") + return service._prepare_carrier(carrier, cart=cart) def _get_available_carrier(self, cart): return [ diff --git a/shopinvader_delivery_carrier/services/delivery_carrier.py b/shopinvader_delivery_carrier/services/delivery_carrier.py index 8217a112d1..6d30773975 100644 --- a/shopinvader_delivery_carrier/services/delivery_carrier.py +++ b/shopinvader_delivery_carrier/services/delivery_carrier.py @@ -72,6 +72,11 @@ def _validator_return_search(self): "required": False, "nullable": True, }, + "code": { + "type": "string", + "required": False, + "nullable": True, + }, "description": { "type": "string", "required": False, diff --git a/shopinvader_delivery_carrier/tests/common.py b/shopinvader_delivery_carrier/tests/common.py index ea7525844c..4b05f7fb5b 100644 --- a/shopinvader_delivery_carrier/tests/common.py +++ b/shopinvader_delivery_carrier/tests/common.py @@ -11,6 +11,8 @@ def setUpClass(cls): super(CommonCarrierCase, cls).setUpClass() cls.free_carrier = cls.env.ref("delivery.free_delivery_carrier") cls.poste_carrier = cls.env.ref("delivery.delivery_carrier") + cls.free_carrier.default_code = "FREE" + cls.poste_carrier.default_code = "POSTE" cls.product_1 = cls.env.ref("product.product_product_4b") cls.precision = 2 diff --git a/shopinvader_delivery_carrier/tests/test_carrier.py b/shopinvader_delivery_carrier/tests/test_carrier.py index a43680ac87..8a86a17a60 100644 --- a/shopinvader_delivery_carrier/tests/test_carrier.py +++ b/shopinvader_delivery_carrier/tests/test_carrier.py @@ -21,6 +21,16 @@ def test_deprecated_apply_delivery_method(self): def test_setting_free_carrier(self): cart = self._set_carrier(self.free_carrier) self.assertEqual(cart["shipping"]["amount"]["total"], 0) + self.assertEqual( + cart["shipping"]["selected_carrier"], + { + "description": self.free_carrier.description or None, + "id": self.free_carrier.id, + "name": self.free_carrier.name, + "code": self.free_carrier.code, + "type": None, + }, + ) def test_setting_poste_carrier(self): cart = self._set_carrier(self.poste_carrier) @@ -59,6 +69,18 @@ def test_setting_poste_carrier(self): cart_amount["tax_without_shipping"], tax_without_shipping ) + # Check Selected carrier + self.assertEqual( + cart["shipping"]["selected_carrier"], + { + "description": self.poste_carrier.description or None, + "id": self.poste_carrier.id, + "name": self.poste_carrier.name, + "code": self.poste_carrier.code, + "type": None, + }, + ) + def test_reset_carrier_on_add_item(self): self._apply_carrier_and_assert_set() cart = self.add_item(self.product_1.id, 2) diff --git a/shopinvader_delivery_carrier/tests/test_delivery_carrier.py b/shopinvader_delivery_carrier/tests/test_delivery_carrier.py index 562ffc250c..7a317e739a 100644 --- a/shopinvader_delivery_carrier/tests/test_delivery_carrier.py +++ b/shopinvader_delivery_carrier/tests/test_delivery_carrier.py @@ -19,6 +19,7 @@ def test_search_all(self): "description": self.free_carrier.name or None, "id": self.free_carrier.id, "name": self.free_carrier.name, + "code": self.free_carrier.code, "type": None, }, { @@ -26,6 +27,7 @@ def test_search_all(self): "description": self.poste_carrier.name or None, "id": self.poste_carrier.id, "name": self.poste_carrier.name, + "code": self.poste_carrier.code, "type": None, }, ], @@ -42,6 +44,7 @@ def test_search_current_cart(self): "description": self.free_carrier.name or None, "id": self.free_carrier.id, "name": self.free_carrier.name, + "code": self.free_carrier.code, "type": None, }, { @@ -49,6 +52,7 @@ def test_search_current_cart(self): "description": self.poste_carrier.name or None, "id": self.poste_carrier.id, "name": self.poste_carrier.name, + "code": self.poste_carrier.code, "type": None, }, ], From ad34014f2a00a47a2e1b576f74234c1cd1251a0d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20BEAU?= Date: Mon, 31 Aug 2020 08:00:30 +0200 Subject: [PATCH 2/2] [FIX] fix exporting code and description and add dependency on delivery_carrier_info --- shopinvader_delivery_carrier/__manifest__.py | 1 + shopinvader_delivery_carrier/services/delivery_carrier.py | 2 +- shopinvader_delivery_carrier/tests/common.py | 6 ++++-- shopinvader_delivery_carrier/tests/test_carrier.py | 4 ++-- .../tests/test_delivery_carrier.py | 8 ++++---- 5 files changed, 12 insertions(+), 9 deletions(-) diff --git a/shopinvader_delivery_carrier/__manifest__.py b/shopinvader_delivery_carrier/__manifest__.py index 3523c7ec3f..6c042f2ac3 100644 --- a/shopinvader_delivery_carrier/__manifest__.py +++ b/shopinvader_delivery_carrier/__manifest__.py @@ -18,6 +18,7 @@ "queue_job", "shopinvader", "sale_shipping_info_helper", + "delivery_carrier_info", ], "data": ["views/backend_view.xml", "data/cart_step.xml"], "demo": [ diff --git a/shopinvader_delivery_carrier/services/delivery_carrier.py b/shopinvader_delivery_carrier/services/delivery_carrier.py index 6d30773975..7f2bd565ee 100644 --- a/shopinvader_delivery_carrier/services/delivery_carrier.py +++ b/shopinvader_delivery_carrier/services/delivery_carrier.py @@ -147,4 +147,4 @@ def allowed_carrier_types(self): @property def _json_parser_carrier(self): - return ["id", "name", "name:description"] + return ["id", "name", "code", "description"] diff --git a/shopinvader_delivery_carrier/tests/common.py b/shopinvader_delivery_carrier/tests/common.py index 4b05f7fb5b..9d104bbb52 100644 --- a/shopinvader_delivery_carrier/tests/common.py +++ b/shopinvader_delivery_carrier/tests/common.py @@ -11,8 +11,10 @@ def setUpClass(cls): super(CommonCarrierCase, cls).setUpClass() cls.free_carrier = cls.env.ref("delivery.free_delivery_carrier") cls.poste_carrier = cls.env.ref("delivery.delivery_carrier") - cls.free_carrier.default_code = "FREE" - cls.poste_carrier.default_code = "POSTE" + cls.free_carrier.code = "FREE" + cls.free_carrier.description = "delivery in 5 days" + cls.poste_carrier.code = "POSTE" + cls.poste_carrier.description = "delivery in 2 days" cls.product_1 = cls.env.ref("product.product_product_4b") cls.precision = 2 diff --git a/shopinvader_delivery_carrier/tests/test_carrier.py b/shopinvader_delivery_carrier/tests/test_carrier.py index 8a86a17a60..f80706d626 100644 --- a/shopinvader_delivery_carrier/tests/test_carrier.py +++ b/shopinvader_delivery_carrier/tests/test_carrier.py @@ -24,7 +24,7 @@ def test_setting_free_carrier(self): self.assertEqual( cart["shipping"]["selected_carrier"], { - "description": self.free_carrier.description or None, + "description": self.free_carrier.description, "id": self.free_carrier.id, "name": self.free_carrier.name, "code": self.free_carrier.code, @@ -73,7 +73,7 @@ def test_setting_poste_carrier(self): self.assertEqual( cart["shipping"]["selected_carrier"], { - "description": self.poste_carrier.description or None, + "description": self.poste_carrier.description, "id": self.poste_carrier.id, "name": self.poste_carrier.name, "code": self.poste_carrier.code, diff --git a/shopinvader_delivery_carrier/tests/test_delivery_carrier.py b/shopinvader_delivery_carrier/tests/test_delivery_carrier.py index 7a317e739a..0cbf97c516 100644 --- a/shopinvader_delivery_carrier/tests/test_delivery_carrier.py +++ b/shopinvader_delivery_carrier/tests/test_delivery_carrier.py @@ -16,7 +16,7 @@ def test_search_all(self): "rows": [ { "price": 0.0, - "description": self.free_carrier.name or None, + "description": self.free_carrier.description, "id": self.free_carrier.id, "name": self.free_carrier.name, "code": self.free_carrier.code, @@ -24,7 +24,7 @@ def test_search_all(self): }, { "price": 0.0, - "description": self.poste_carrier.name or None, + "description": self.poste_carrier.description, "id": self.poste_carrier.id, "name": self.poste_carrier.name, "code": self.poste_carrier.code, @@ -41,7 +41,7 @@ def test_search_current_cart(self): "rows": [ { "price": 0.0, - "description": self.free_carrier.name or None, + "description": self.free_carrier.description, "id": self.free_carrier.id, "name": self.free_carrier.name, "code": self.free_carrier.code, @@ -49,7 +49,7 @@ def test_search_current_cart(self): }, { "price": 20.0, - "description": self.poste_carrier.name or None, + "description": self.poste_carrier.description, "id": self.poste_carrier.id, "name": self.poste_carrier.name, "code": self.poste_carrier.code,