Merge PR #10 into 16.0

Signed-off-by lmignon

Author: shopinvader-git-bot

Diff for: shopinvader_api_delivery_carrier/README.rst

@@ -40,9 +40,10 @@ Usage
 This module will give you several endpoints for interacting with delivery carrier.
 You can play with it with swagger.
 
-* Add a `/set_carrier` route on the `cart_router`: to set a delivery carrier on your cart;
-* Create a new `delivery_carrier` router: the route `delivery_carriers` allow to search on delivery carriers. You can filter on a specific cart, or on a specific country and/or zipcode.
-* Create a new `deliveries` router: the route `deliveries` allow to search on all deliveries linked to the current partner.
+This module provides the following routers:
+* ``delivery_carrier_router`` to get the carriers available for a partner;
+* ``delivery_carrier_cart_router`` to get the carriers available for a cart, including delivery prices for the cart, and set a carrier on a cart;
+* ``delivery_router``: to search on all deliveries linked to the authenticated partner.
 
 Bug Tracker
 ===========

Diff for: shopinvader_api_delivery_carrier/readme/USAGE.rst

@@ -1,6 +1,7 @@
 This module will give you several endpoints for interacting with delivery carrier.
 You can play with it with swagger.
 
-* Add a `/set_carrier` route on the `cart_router`: to set a delivery carrier on your cart;
-* Create a new `delivery_carrier` router: the route `delivery_carriers` allow to search on delivery carriers. You can filter on a specific cart, or on a specific country and/or zipcode.
-* Create a new `deliveries` router: the route `deliveries` allow to search on all deliveries linked to the current partner.
+This module provides the following routers:
+* ``delivery_carrier_router`` to get the carriers available for a partner;
+* ``delivery_carrier_cart_router`` to get the carriers available for a cart, including delivery prices for the cart, and set a carrier on a cart;
+* ``delivery_router``: to search on all deliveries linked to the authenticated partner.

Diff for: shopinvader_api_delivery_carrier/routers/__init__.py

@@ -1,3 +1,3 @@
-from . import cart
+from .cart import delivery_carrier_cart_router
 from .delivery import delivery_router
 from .delivery_carrier import delivery_carrier_router

Diff for: shopinvader_api_delivery_carrier/routers/cart.py

@@ -4,7 +4,7 @@
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 from typing import Annotated
 
-from fastapi import Depends
+from fastapi import APIRouter, Depends
 
 from odoo import _, api, models
 from odoo.exceptions import UserError
@@ -15,16 +15,20 @@
     authenticated_partner_env,
 )
 from odoo.addons.sale.models.sale_order import SaleOrder
-from odoo.addons.shopinvader_api_cart.routers import cart_router
 from odoo.addons.shopinvader_api_cart.schemas import CartTransaction
 from odoo.addons.shopinvader_schema_sale.schemas import Sale
 
 from ..schemas import DeliveryCarrierInput
 
+delivery_carrier_cart_router = APIRouter(tags=["carts"])
 
-@cart_router.post("/set_carrier")
-@cart_router.post("/{uuid}/set_carrier")
-@cart_router.post("/current/set_carrier")
+
+@delivery_carrier_cart_router.post("/set_carrier", deprecated=True)
+@delivery_carrier_cart_router.post("/{uuid}/set_carrier", deprecated=True)
+@delivery_carrier_cart_router.post("/current/set_carrier", deprecated=True)
+@delivery_carrier_cart_router.post("/carrier")
+@delivery_carrier_cart_router.post("/{uuid}/carrier")
+@delivery_carrier_cart_router.post("/current/carrier")
 def set_carrier(
     env: Annotated[api.Environment, Depends(authenticated_partner_env)],
     partner: Annotated["ResPartner", Depends(authenticated_partner)],

Diff for: shopinvader_api_delivery_carrier/routers/delivery.py

@@ -28,6 +28,7 @@ def search(
     partner: Annotated["ResPartner", Depends(authenticated_partner)],
     paging_: Annotated[Paging, Depends(paging)],
 ) -> PagedCollection[Picking]:
+    """Return all outgoing Deliveries for the authenticated partner."""
     count, pickings = (
         env["shopinvader_api_delivery_carrier.delivery_router.helper"]
         .new({"partner": partner})

Diff for: shopinvader_api_delivery_carrier/routers/delivery_carrier.py

@@ -19,6 +19,7 @@
     DeliveryCarrierSearch,
     DeliveryCarrierWithPrice,
 )
+from .cart import delivery_carrier_cart_router
 
 delivery_carrier_router = APIRouter(tags=["delivery_carriers"])
 
@@ -46,8 +47,10 @@ def search(
     ]
 
 
-@delivery_carrier_router.get("/{uuid}/delivery_carriers")
-@delivery_carrier_router.get("/current/delivery_carriers")
+@delivery_carrier_router.get("/{uuid}/delivery_carriers", deprecated=True)
+@delivery_carrier_router.get("/current/delivery_carriers", deprecated=True)
+@delivery_carrier_cart_router.get("/{uuid}/delivery_carriers")
+@delivery_carrier_cart_router.get("/current/delivery_carriers")
 def search_current(
     data: Annotated[DeliveryCarrierSearch, Depends()],
     env: Annotated[api.Environment, Depends(authenticated_partner_env)],

Diff for: shopinvader_api_delivery_carrier/static/description/index.html

@@ -1,4 +1,3 @@
-<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
@@ -394,11 +393,10 @@ <h1 class="title">Shopinvader Carrier</h1>
 <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
 <p>This module will give you several endpoints for interacting with delivery carrier.
 You can play with it with swagger.</p>
-<ul class="simple">
-<li>Add a <cite>/set_carrier</cite> route on the <cite>cart_router</cite>: to set a delivery carrier on your cart;</li>
-<li>Create a new <cite>delivery_carrier</cite> router: the route <cite>delivery_carriers</cite> allow to search on delivery carriers. You can filter on a specific cart, or on a specific country and/or zipcode.</li>
-<li>Create a new <cite>deliveries</cite> router: the route <cite>deliveries</cite> allow to search on all deliveries linked to the current partner.</li>
-</ul>
+<p>This module provides the following routers:
+* <tt class="docutils literal">delivery_carrier_router</tt> to get the carriers available for a partner;
+* <tt class="docutils literal">delivery_carrier_cart_router</tt> to get the carriers available for a cart, including delivery prices for the cart, and set a carrier on a cart;
+* <tt class="docutils literal">delivery_router</tt>: to search on all deliveries linked to the authenticated partner.</p>
 </div>
 <div class="section" id="bug-tracker">
 <h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>

Diff for: shopinvader_api_delivery_carrier/tests/test_set_carrier.py

@@ -8,8 +8,7 @@
 
 from odoo.tests.common import tagged
 
-from odoo.addons.shopinvader_api_cart.routers import cart_router
-
+from ..routers import delivery_carrier_cart_router
 from .common import TestShopinvaderDeliveryCarrierCommon
 
 
@@ -31,7 +30,9 @@ def setUpClass(cls) -> None:
         ]
 
     def test_setting_free_carrier(self):
-        with self._create_test_client(router=cart_router) as test_client:
+        with self._create_test_client(
+            router=delivery_carrier_cart_router
+        ) as test_client:
             data = {
                 "carrier_id": self.free_carrier.id,
             }
@@ -56,7 +57,9 @@ def test_setting_free_carrier(self):
         )
 
     def test_setting_poste_carrier(self):
-        with self._create_test_client(router=cart_router) as test_client:
+        with self._create_test_client(
+            router=delivery_carrier_cart_router
+        ) as test_client:
             data = {
                 "carrier_id": self.poste_carrier.id,
             }

Diff for: shopinvader_api_delivery_carrier/tests/test_sync_cart.py

@@ -11,6 +11,7 @@
 
 from odoo.addons.shopinvader_api_cart.routers import cart_router
 
+from ..routers import delivery_carrier_cart_router
 from .common import TestShopinvaderDeliveryCarrierCommon
 
 
@@ -33,7 +34,9 @@ def setUpClass(cls) -> None:
         cls.trans_uuid_1 = str(uuid.uuid4())
 
     def _set_carrier(self, carrier):
-        with self._create_test_client(router=cart_router) as test_client:
+        with self._create_test_client(
+            router=delivery_carrier_cart_router
+        ) as test_client:
             data = {
                 "carrier_id": carrier.id,
             }