Add support for Order imports

Author: tleguijt

CHANGES.md

@@ -28,6 +28,7 @@
   The old pattern is deprecated but will remain backwards compatible for now
 - Allow passing custom HTTP adapter to BaseClient (@lime-green)
 - Add support for custom address fields and update actions
+- Testing: Add support for `Order` imports
 - Testing: fixed issues with `get_by_key` lookups in certain testing backends
 - Testing: Added missing actions for Cart Discounts, Discount Codes and Extensions
 - Testing: Add `datetime` and `list` updater utils

src/commercetools/testing/abstract.py

@@ -90,7 +90,7 @@ def _generate_key(self, obj):
     def _create_from_draft(self, draft, id=None):
         raise NotImplementedError()
 
-    def query(self, where):
+    def query(self, where=None):
         objects = list(self.objects.values())
         if not where:
             return objects

src/commercetools/testing/orders.py

@@ -9,13 +9,18 @@
 from commercetools.platform.models._schemas.order import (
     DeliverySchema,
     OrderFromCartDraftSchema,
+    OrderImportDraftSchema,
     OrderPagedQueryResponseSchema,
     OrderSchema,
     OrderUpdateSchema,
 )
 from commercetools.platform.models._schemas.payment import PaymentReferenceSchema
+from commercetools.platform.models.common import CentPrecisionMoney
 from commercetools.testing.abstract import BaseModel, ServiceBackend
 from commercetools.testing.utils import (
+    create_commercetools_response,
+    create_from_draft,
+    money_to_typed,
     set_custom_field,
     set_line_item_custom_field,
     update_attribute,
@@ -28,30 +33,65 @@ class OrdersModel(BaseModel):
     _resource_schema = OrderSchema
 
     def _create_from_draft(
-        self, draft: models.OrderFromCartDraft, id: typing.Optional[str] = None
+        self,
+        draft: typing.Union[models.OrderFromCartDraft, models.OrderImportDraft],
+        id: typing.Optional[str] = None,
     ) -> models.Order:
         """
         Note this implementation needs further refinement. For example:
          - Copying fields from an existing cart
          - Setting custom type fields?
         """
+        id = str(id if id is not None else uuid.uuid4())
 
-        object_id = str(uuid.UUID(id) if id is not None else uuid.uuid4())
+        if isinstance(draft, models.OrderFromCartDraft):
+            return self._create_from_cart_draft(draft, id)
+        elif isinstance(draft, models.OrderImportDraft):
+            return self._create_from_import_draft(draft, id)
+
+    def _create_from_cart_draft(self, draft: models.OrderFromCartDraft, id: str):
+        """
+        Note this implementation needs further refinement. For example:
+         - Copying fields from an existing cart
+         - Setting custom type fields?
+        """
         cart_identifier = models.CartResourceIdentifier(id=draft.id)
 
         cart_data = self._storage.get_by_resource_identifier(cart_identifier)
         cart = None
+        total_price = None
         if cart_data:
             cart: models.Cart = CartSchema().load(cart_data)
+            total_price = copy.deepcopy(cart.total_price)
+
+        order = models.Order(
+            id=id,
+            version=1,
+            created_at=datetime.datetime.now(datetime.timezone.utc),
+            last_modified_at=datetime.datetime.now(datetime.timezone.utc),
+            line_items=[],
+            custom_line_items=[],
+            total_price=total_price,
+            sync_info=[],
+            last_message_sequence_number=0,
+            refused_gifts=[],
+            order_number=draft.order_number,
+            payment_state=draft.payment_state,
+            order_state=OrderState.OPEN,
+            origin=CartOrigin.CUSTOMER,
+        )
+        return order
 
+    def _create_from_import_draft(self, draft: models.OrderImportDraft, id: str):
         order = models.Order(
-            id=str(object_id),
+            id=id,
             version=1,
             created_at=datetime.datetime.now(datetime.timezone.utc),
             last_modified_at=datetime.datetime.now(datetime.timezone.utc),
             line_items=[],
             custom_line_items=[],
-            total_price=copy.deepcopy(cart.total_price),
+            total_price=money_to_typed(draft.total_price),
+            taxed_price=create_from_draft(draft.taxed_price),
             sync_info=[],
             last_message_sequence_number=0,
             refused_gifts=[],
@@ -138,6 +178,7 @@ def urls(self):
         return [
             ("^$", "GET", self.query),
             ("^$", "POST", self.create),
+            ("^import$", "POST", self.import_),
             ("^key=(?P<key>[^/]+)$", "GET", self.get_by_key),
             ("^key=(?P<key>[^/]+)$", "POST", self.update_by_key),
             ("^key=(?P<key>[^/]+)$", "DELETE", self.delete_by_key),
@@ -146,6 +187,14 @@ def urls(self):
             ("^(?P<id>[^/]+)$", "DELETE", self.delete_by_id),
         ]
 
+    def import_(self, request):
+        obj = OrderImportDraftSchema().loads(request.body)
+        data = self.model.add(obj)
+        expanded_data = self._expand(request, data)
+        return create_commercetools_response(
+            request, json=expanded_data, status_code=201
+        )
+
     _actions = {
         "changeOrderState": update_enum_attribute("orderState", "order_state"),
         "changePaymentState": update_enum_attribute("paymentState", "payment_state"),

src/commercetools/testing/payments.py

@@ -33,9 +33,9 @@ def _create_from_draft(
             last_modified_at=datetime.datetime.now(datetime.timezone.utc),
             customer=draft.customer,
             amount_authorized=draft.amount_authorized,
-            amount_paid=utils._money_to_typed(draft.amount_paid),
-            amount_planned=utils._money_to_typed(draft.amount_planned),
-            amount_refunded=utils._money_to_typed(draft.amount_refunded),
+            amount_paid=utils.money_to_typed(draft.amount_paid),
+            amount_planned=utils.money_to_typed(draft.amount_planned),
+            amount_refunded=utils.money_to_typed(draft.amount_refunded),
             anonymous_id=draft.anonymous_id,
             payment_method_info=draft.payment_method_info,
             payment_status=draft.payment_status,
@@ -55,7 +55,7 @@ def _create_transaction_draft(
             id=str(uuid.uuid4()),
             timestamp=draft.timestamp,
             type=draft.type,
-            amount=utils._money_to_typed(draft.amount),
+            amount=utils.money_to_typed(draft.amount),
             interaction_id=draft.interaction_id,
             state=draft.state,
         )
@@ -68,7 +68,7 @@ def updater(self, obj, action):
             id=str(uuid.uuid4()),
             timestamp=draft.timestamp,
             type=draft.type,
-            amount=utils._money_to_typed(draft.amount),
+            amount=utils.money_to_typed(draft.amount),
             interaction_id=draft.interaction_id,
             state=draft.state,
         )

src/commercetools/testing/products.py

@@ -293,7 +293,7 @@ def convert_draft_price(
         id=price_id or str(uuid.uuid4()),
         country=price_draft.country,
         channel=price_draft.channel,
-        value=utils._money_to_typed(price_draft.value),
+        value=utils.money_to_typed(price_draft.value),
         valid_from=price_draft.valid_from,
         valid_until=price_draft.valid_until,
         discounted=price_draft.discounted,

src/commercetools/testing/shipping_methods.py

@@ -36,8 +36,8 @@ def _create_from_draft(
             shipping_rates: typing.List[models.ShippingRate] = []
             for shipping_rate_draft in rate_draft.shipping_rates or []:
                 shipping_rate = models.ShippingRate(
-                    price=utils._money_to_typed(shipping_rate_draft.price),
-                    free_above=utils._money_to_typed(shipping_rate_draft.free_above),
+                    price=utils.money_to_typed(shipping_rate_draft.price),
+                    free_above=utils.money_to_typed(shipping_rate_draft.free_above),
                     tiers=copy.deepcopy(shipping_rate_draft.tiers),
                 )
                 shipping_rates.append(shipping_rate)

src/commercetools/testing/utils.py

@@ -17,7 +17,11 @@
 )
 from commercetools.platform.models._abstract import _BaseType
 from commercetools.platform.models._schemas.product import ProductSchema
-from commercetools.platform.models.cart import Cart, CartSetLineItemCustomFieldAction
+from commercetools.platform.models.cart import (
+    Cart,
+    CartSetLineItemCustomFieldAction,
+    TaxPortion,
+)
 from commercetools.platform.models.order import Order, OrderSetLineItemCustomFieldAction
 
 
@@ -49,7 +53,7 @@ def get_product_variants(product_catalog_data: dict) -> typing.List[dict]:
     return variants
 
 
-def create_from_draft(draft):
+def create_from_draft(draft: typing.Optional[_BaseType]):
     """Utility method to create normal objects out of draft objects.
 
     This is used for non-resource objects. For the resources themselves (which contain)
@@ -65,13 +69,26 @@ def create_from_draft(draft):
     if isinstance(draft, models.PriceTierDraft):
         return models.PriceTier(
             minimum_quantity=draft.minimum_quantity,
-            value=_money_to_typed(
+            value=money_to_typed(
                 models.Money(
                     cent_amount=draft.value.cent_amount,
                     currency_code=draft.value.currency_code,
                 )
             ),
         )
+    if isinstance(draft, models.TaxedPriceDraft):
+        return models.TaxedPrice(
+            total_net=money_to_typed(draft.total_net),
+            total_gross=money_to_typed(draft.total_gross),
+            tax_portions=[
+                models.TaxPortion(
+                    name=portion.name,
+                    rate=portion.rate,
+                    amount=money_to_typed(portion.amount),
+                )
+                for portion in draft.tax_portions
+            ],
+        )
 
     raise ValueError(f"Unsupported type {draft.__class__}")
 
@@ -87,17 +104,18 @@ def custom_fields_from_draft(
     )
 
 
-def _money_to_typed(
+def money_to_typed(
     money: typing.Optional[models.Money],
 ) -> typing.Optional[models.TypedMoney]:
-    if money is not None:
-        return models.TypedMoney(
-            cent_amount=money.cent_amount,
-            currency_code=money.currency_code,
-            type=models.MoneyType.CENT_PRECISION,
-            fraction_digits=2,
-        )
-    return None
+    if money is None:
+        return None
+
+    return models.TypedMoney(
+        cent_amount=money.cent_amount,
+        currency_code=money.currency_code,
+        type=models.MoneyType.CENT_PRECISION,
+        fraction_digits=2,
+    )
 
 
 def update_attribute(dst: str, src: str):