karrio-server-proxy 2025.5rc1__py3-none-any.whl

karrio/server/proxy/tests/test_shipping.py

@@ -0,0 +1,337 @@
+import json
+from unittest.mock import patch, ANY
+from django.urls import reverse
+from rest_framework import status
+from karrio.core.models import ShipmentDetails, ConfirmationDetails, Message
+from karrio.server.core.tests import APITestCase
+
+
+class TestShipping(APITestCase):
+    def test_shipping_request(self):
+        url = reverse("karrio.server.proxy:shipping-request")
+        data = SHIPPING_DATA
+
+        with patch("karrio.server.core.gateway.utils.identity") as mock:
+            mock.return_value = RETURNED_VALUE
+            response = self.client.post(url, data)
+            response_data = json.loads(response.content)
+
+            self.assertEqual(response.status_code, status.HTTP_200_OK)
+            self.assertDictEqual(response_data, SHIPPING_RESPONSE)
+
+    def test_shipping_cancel(self):
+        url = reverse(
+            "karrio.server.proxy:shipping-cancel",
+            kwargs=dict(carrier_name="canadapost"),
+        )
+        data = SHIPPING_CANCEL_DATA
+
+        with patch("karrio.server.core.gateway.utils.identity") as mock:
+            mock.return_value = RETURNED_SUCCESS_CANCEL_VALUE
+            response = self.client.post(f"{url}", data)
+            response_data = json.loads(response.content)
+
+            self.assertEqual(response.status_code, status.HTTP_202_ACCEPTED)
+            self.assertDictEqual(response_data, SHIPPING_CANCEL_SUCCESS_RESPONSE)
+
+    def test_shipping_failed_cancel(self):
+        url = reverse(
+            "karrio.server.proxy:shipping-cancel",
+            kwargs=dict(carrier_name="canadapost"),
+        )
+        data = SHIPPING_CANCEL_DATA
+
+        with patch("karrio.server.core.gateway.utils.identity") as mock:
+            mock.return_value = RETURNED_FAILED_CANCEL_VALUE
+            response = self.client.post(f"{url}", data)
+            response_data = json.loads(response.content)
+
+            self.assertEqual(response.status_code, status.HTTP_424_FAILED_DEPENDENCY)
+            self.assertDictEqual(response_data, SHIPPING_CANCEL_FAILED_RESPONSE)
+
+
+SHIPPING_DATA = {
+    "selected_rate_id": "prx_a9b96e5a82f644b0921bfed3190b4d6c",
+    "options": {},
+    "recipient": {
+        "address_line1": "125 Church St",
+        "person_name": "John Doe",
+        "company_name": "A corp.",
+        "phone_number": "514 000 0000",
+        "city": "Moncton",
+        "country_code": "CA",
+        "postal_code": "E1C4Z8",
+        "residential": False,
+        "state_code": "NB",
+        "validate_location": False,
+        "validation": None,
+    },
+    "shipper": {
+        "address_line1": "5840 Oak St",
+        "person_name": "Jane Doe",
+        "company_name": "B corp.",
+        "phone_number": "514 000 0000",
+        "city": "Vancouver",
+        "country_code": "CA",
+        "postal_code": "v6m2V9",
+        "residential": False,
+        "state_code": "BC",
+        "validate_location": False,
+        "validation": None,
+    },
+    "parcels": [
+        {
+            "weight": 1,
+            "weight_unit": "KG",
+            "package_preset": "canadapost_corrugated_small_box",
+        }
+    ],
+    "rates": [
+        {
+            "base_charge": 101.83,
+            "carrier_id": "canadapost",
+            "carrier_name": "canadapost",
+            "currency": "CAD",
+            "estimated_delivery": ANY,
+            "discount": -9.04,
+            "duties_and_taxes": 13.92,
+            "estimated_delivery": "2020-06-22",
+            "extra_charges": [
+                {"amount": 2.7, "currency": "CAD", "name": "Fuel surcharge"},
+                {"amount": -11.74, "currency": "CAD", "name": "SMB Savings"},
+            ],
+            "id": "prx_a9b96e5a82f644b0921bfed3190b4d6c",
+            "service": "canadapost_priority",
+            "total_charge": 106.71,
+            "test_mode": True,
+        },
+        {
+            "base_charge": 27.36,
+            "carrier_id": "canadapost",
+            "carrier_name": "canadapost",
+            "currency": "CAD",
+            "estimated_delivery": None,
+            "discount": -3.06,
+            "duties_and_taxes": 3.65,
+            "estimated_delivery": "2020-07-02",
+            "extra_charges": [
+                {"amount": 0.71, "currency": "CAD", "name": "Fuel surcharge"},
+                {"amount": -3.77, "currency": "CAD", "name": "SMB Savings"},
+            ],
+            "id": "prx_9290e4a2c8e34c8d8c73ab990b029f3d",
+            "service": "canadapost_regular_parcel",
+            "total_charge": 27.95,
+            "test_mode": True,
+        },
+    ],
+    "payment": {"currency": "CAD", "paid_by": "sender"},
+}
+
+SHIPPING_CANCEL_DATA = {"shipment_identifier": "123456789012"}
+
+RETURNED_VALUE = [
+    ShipmentDetails(
+        carrier_name="canadapost",
+        carrier_id="canadapost",
+        tracking_number="123456789012",
+        shipment_identifier="123456789012",
+        docs=dict(label="==apodifjoefr"),
+    ),
+    [],
+]
+
+RETURNED_SUCCESS_CANCEL_VALUE = [
+    ConfirmationDetails(
+        carrier_name="canadapost",
+        carrier_id="canadapost",
+        success=True,
+        operation="Cancel Shipment",
+    ),
+    [],
+]
+
+RETURNED_FAILED_CANCEL_VALUE = [
+    None,
+    [
+        Message(
+            carrier_name="canadapost",
+            carrier_id="canadapost",
+            message="Not Found",
+            code="404",
+        )
+    ],
+]
+
+SHIPPING_RESPONSE = {
+    "id": ANY,
+    "object_type": "shipment",
+    "tracking_url": "/v1/proxy/tracking/canadapost/123456789012",
+    "shipper": {
+        "id": None,
+        "postal_code": "V6M2V9",
+        "city": "Vancouver",
+        "federal_tax_id": None,
+        "state_tax_id": None,
+        "person_name": "Jane Doe",
+        "company_name": "B corp.",
+        "country_code": "CA",
+        "email": None,
+        "phone_number": "+1 514-000-0000",
+        "state_code": "BC",
+        "street_number": None,
+        "residential": False,
+        "address_line1": "5840 Oak St",
+        "address_line2": "",
+        "validate_location": False,
+        "object_type": "address",
+        "validation": None,
+    },
+    "recipient": {
+        "id": None,
+        "postal_code": "E1C4Z8",
+        "city": "Moncton",
+        "federal_tax_id": None,
+        "state_tax_id": None,
+        "person_name": "John Doe",
+        "company_name": "A corp.",
+        "country_code": "CA",
+        "email": None,
+        "phone_number": "+1 514-000-0000",
+        "state_code": "NB",
+        "street_number": None,
+        "residential": False,
+        "address_line1": "125 Church St",
+        "address_line2": "",
+        "validate_location": False,
+        "object_type": "address",
+        "validation": None,
+    },
+    "parcels": [
+        {
+            "id": None,
+            "weight": 1.0,
+            "width": 42.0,
+            "height": 32.0,
+            "length": 32.0,
+            "packaging_type": None,
+            "package_preset": "canadapost_corrugated_small_box",
+            "description": None,
+            "content": None,
+            "is_document": False,
+            "weight_unit": "KG",
+            "dimension_unit": "CM",
+            "items": [],
+            "freight_class": None,
+            "reference_number": "123456789012",
+            "object_type": "parcel",
+            "options": {},
+        }
+    ],
+    "services": [],
+    "options": {"shipment_date": ANY, "shipping_date": ANY},
+    "payment": {"paid_by": "sender", "currency": "CAD", "account_number": None},
+    "billing_address": None,
+    "customs": None,
+    "rates": [
+        {
+            "id": ANY,
+            "object_type": "rate",
+            "carrier_name": "canadapost",
+            "carrier_id": "canadapost",
+            "currency": "CAD",
+            "estimated_delivery": ANY,
+            "service": "canadapost_priority",
+            "total_charge": 106.71,
+            "transit_days": None,
+            "extra_charges": [
+                {"name": "Fuel surcharge", "amount": 2.7, "currency": "CAD"},
+                {"name": "SMB Savings", "amount": -11.74, "currency": "CAD"},
+            ],
+            "meta": None,
+            "test_mode": True,
+        },
+        {
+            "id": ANY,
+            "object_type": "rate",
+            "carrier_name": "canadapost",
+            "carrier_id": "canadapost",
+            "currency": "CAD",
+            "estimated_delivery": ANY,
+            "service": "canadapost_regular_parcel",
+            "total_charge": 27.95,
+            "transit_days": None,
+            "extra_charges": [
+                {"name": "Fuel surcharge", "amount": 0.71, "currency": "CAD"},
+                {"name": "SMB Savings", "amount": -3.77, "currency": "CAD"},
+            ],
+            "meta": None,
+            "test_mode": True,
+        },
+    ],
+    "reference": "",
+    "return_address": None,
+    "label_type": "PDF",
+    "carrier_ids": [],
+    "tracker_id": None,
+    "created_at": ANY,
+    "metadata": {},
+    "messages": [],
+    "status": "purchased",
+    "carrier_name": "canadapost",
+    "carrier_id": "canadapost",
+    "tracking_number": "123456789012",
+    "shipment_identifier": "123456789012",
+    "selected_rate": {
+        "id": ANY,
+        "object_type": "rate",
+        "carrier_name": "canadapost",
+        "carrier_id": "canadapost",
+        "currency": "CAD",
+        "estimated_delivery": ANY,
+        "service": "canadapost_priority",
+        "total_charge": 106.71,
+        "transit_days": None,
+        "extra_charges": [
+            {"name": "Fuel surcharge", "amount": 2.7, "currency": "CAD"},
+            {"name": "SMB Savings", "amount": -11.74, "currency": "CAD"},
+        ],
+        "meta": {
+            "ext": "canadapost",
+            "carrier": "canadapost",
+            "rate_provider": "canadapost",
+            "service_name": "CANADAPOST PRIORITY",
+        },
+        "test_mode": True,
+    },
+    "docs": {"label": "==apodifjoefr", "invoice": None},
+    "meta": {
+        "ext": "canadapost",
+        "carrier": "canadapost",
+        "rate_provider": "canadapost",
+        "service_name": "CANADAPOST PRIORITY",
+    },
+    "service": "canadapost_priority",
+    "selected_rate_id": ANY,
+    "test_mode": True,
+}
+
+SHIPPING_CANCEL_SUCCESS_RESPONSE = {
+    "messages": [],
+    "confirmation": {
+        "carrier_name": "canadapost",
+        "carrier_id": "canadapost",
+        "operation": "Cancel Shipment",
+        "success": True,
+    },
+}
+
+SHIPPING_CANCEL_FAILED_RESPONSE = {
+    "messages": [
+        {
+            "carrier_id": "canadapost",
+            "carrier_name": "canadapost",
+            "code": "404",
+            "message": "Not Found",
+        }
+    ]
+}

karrio/server/proxy/tests/test_tracking.py

@@ -0,0 +1,92 @@
+import json
+from unittest.mock import patch, ANY
+from django.urls import reverse
+from rest_framework import status
+from karrio.core.models import TrackingDetails, TrackingEvent
+from karrio.server.core.tests import APITestCase
+
+
+class TestTracking(APITestCase):
+    def test_tracking_shipment(self):
+        url = reverse("karrio.server.proxy:get-tracking")
+        data = dict(tracking_number="1Z12345E6205277936", carrier_name="ups")
+
+        with patch("karrio.server.core.gateway.utils.identity") as mock:
+            mock.return_value = RETURNED_VALUE
+            response = self.client.post(f"{url}", data)
+            response_data = json.loads(response.content)
+
+            self.assertEqual(response.status_code, status.HTTP_200_OK)
+            self.assertDictEqual(response_data, TRACKING_RESPONSE)
+
+
+RETURNED_VALUE = [
+    [
+        TrackingDetails(
+            carrier_id="ups_package",
+            carrier_name="ups",
+            tracking_number="1Z12345E6205277936",
+            events=[
+                TrackingEvent(
+                    code="KB",
+                    date="2010-08-30",
+                    description="UPS INTERNAL ACTIVITY CODE",
+                    location="BONN",
+                    time="10:39",
+                )
+            ],
+        )
+    ],
+    [],
+]
+
+TRACKING_RESPONSE = {
+    "messages": [],
+    "tracking": {
+        "id": ANY,
+        "carrier_name": "ups",
+        "carrier_id": "ups_package",
+        "tracking_number": "1Z12345E6205277936",
+        "images": None,
+        "info": {
+            "carrier_tracking_link": "https://www.ups.com/track?loc=en_US&requester=QUIC&tracknum=1Z12345E6205277936/trackdetails",
+            "customer_name": None,
+            "expected_delivery": None,
+            "note": None,
+            "order_date": None,
+            "order_id": None,
+            "package_weight": None,
+            "package_weight_unit": None,
+            "shipment_package_count": None,
+            "shipment_pickup_date": None,
+            "shipment_delivery_date": None,
+            "shipment_service": None,
+            "shipment_origin_country": None,
+            "shipment_origin_postal_code": None,
+            "shipment_destination_country": None,
+            "shipment_destination_postal_code": None,
+            "shipping_date": None,
+            "signed_by": None,
+            "source": "api",
+        },
+        "events": [
+            {
+                "date": "2010-08-30",
+                "description": "UPS INTERNAL ACTIVITY CODE",
+                "location": "BONN",
+                "code": "KB",
+                "time": "10:39",
+                "latitude": None,
+                "longitude": None,
+            }
+        ],
+        "delivered": None,
+        "test_mode": True,
+        "status": "in_transit",
+        "estimated_delivery": ANY,
+        "meta": {"ext": "ups", "carrier": "ups"},
+        "object_type": "tracker",
+        "metadata": {},
+        "messages": [],
+    },
+}

karrio/server/proxy/urls.py

@@ -0,0 +1,10 @@
+"""
+karrio server proxy module urls
+"""
+from django.urls import include, path
+from karrio.server.proxy.views import router
+
+app_name = 'karrio.server.proxy'
+urlpatterns = [
+    path('v1/', include(router.urls)),
+]

karrio/server/proxy/views/__init__.py

@@ -0,0 +1,6 @@
+import karrio.server.proxy.views.tracking
+import karrio.server.proxy.views.rating
+import karrio.server.proxy.views.shipping
+import karrio.server.proxy.views.pickup
+import karrio.server.proxy.views.manifest
+from karrio.server.proxy.router import router

karrio/server/proxy/views/manifest.py

@@ -0,0 +1,55 @@
+import logging
+import django.urls as urls
+import rest_framework.status as status
+import rest_framework.request as request
+import rest_framework.response as response
+
+import karrio.server.openapi as openapi
+import karrio.server.core.views.api as api
+import karrio.server.proxy.router as router
+import karrio.server.core.gateway as gateway
+import karrio.server.core.serializers as serializers
+
+logger = logging.getLogger(__name__)
+ENDPOINT_ID = "@@@$"  # This endpoint id is used to make operation ids unique make sure not to duplicate
+
+DESCRIPTION = """
+Some carriers require shipment manifests to be created for pickups and dropoff.
+Creating a manifest for a shipment also kicks off billing as a commitment or confirmation of the shipment.
+"""
+
+
+class ManifestingAPI(api.APIView):
+    throttle_scope = "carrier_request"
+
+    @openapi.extend_schema(
+        tags=["Proxy"],
+        operation_id=f"{ENDPOINT_ID}generate_manifest",
+        extensions={"x-operationId": "generateManifest"},
+        summary="Create a manifest",
+        description=DESCRIPTION,
+        responses={
+            200: serializers.ManifestResponse(),
+            400: serializers.ErrorResponse(),
+            424: serializers.ErrorMessages(),
+            500: serializers.ErrorResponse(),
+        },
+        request=serializers.ManifestRequest(),
+    )
+    def post(self, request: request.Request):
+        payload = serializers.ManifestRequest.map(data=request.data).data
+
+        manifest = gateway.Manifests.create(payload, context=request)
+
+        return response.Response(
+            serializers.ManifestResponse(manifest).data, status=status.HTTP_200_OK
+        )
+
+
+router.router.urls.append(
+    urls.path(
+        "proxy/manifest",
+        ManifestingAPI.as_view(),
+        name="shipment-manifest",
+    )
+)

karrio/server/proxy/views/pickup.py

@@ -0,0 +1,151 @@
+import logging
+from django.urls import path
+from rest_framework import status
+from rest_framework.response import Response
+from rest_framework.request import Request
+
+import karrio.server.openapi as openapi
+import karrio.server.core.utils as utils
+import karrio.server.core.dataunits as dataunits
+import karrio.server.providers.models as providers
+from karrio.server.proxy.router import router
+from karrio.server.core.gateway import Pickups
+from karrio.server.core.views.api import APIView
+from karrio.server.core.serializers import (
+    PickupCancelRequest,
+    PickupUpdateRequest,
+    OperationResponse,
+    PickupResponse,
+    PickupRequest,
+    ErrorResponse,
+    ErrorMessages,
+)
+
+logger = logging.getLogger(__name__)
+ENDPOINT_ID = "@"  # This endpoint id is used to make operation ids unique make sure not to duplicate
+
+
+class PickupSchedule(APIView):
+    throttle_scope = "carrier_request"
+
+    @openapi.extend_schema(
+        tags=["Proxy"],
+        operation_id=f"{ENDPOINT_ID}schedule_pickup",
+        extensions={"x-operationId": "pickupSchedule"},
+        summary="Schedule a pickup",
+        request=PickupRequest(),
+        responses={
+            201: PickupResponse(),
+            400: ErrorResponse(),
+            424: ErrorMessages(),
+            500: ErrorResponse(),
+        },
+        parameters=[
+            openapi.OpenApiParameter(
+                "carrier_name",
+                location=openapi.OpenApiParameter.PATH,
+                type=openapi.OpenApiTypes.STR,
+                enum=dataunits.CARRIER_NAMES,
+            ),
+        ],
+    )
+    def post(self, request: Request, carrier_name: str):
+        """
+        Schedule one or many parcels pickup
+        """
+        payload = PickupRequest.map(data=request.data).data
+
+        response = Pickups.schedule(payload, context=request, carrier_name=carrier_name)
+
+        return Response(PickupResponse(response).data, status=status.HTTP_201_CREATED)
+
+
+class PickupUpdate(APIView):
+    throttle_scope = "carrier_request"
+
+    @openapi.extend_schema(
+        tags=["Proxy"],
+        operation_id=f"{ENDPOINT_ID}update_pickup",
+        extensions={"x-operationId": "pickupUpdate"},
+        summary="Update a pickup",
+        request=PickupUpdateRequest(),
+        responses={
+            200: PickupResponse(),
+            400: ErrorResponse(),
+            424: ErrorMessages(),
+            500: ErrorResponse(),
+        },
+        parameters=[
+            openapi.OpenApiParameter(
+                "carrier_name",
+                location=openapi.OpenApiParameter.PATH,
+                type=openapi.OpenApiTypes.STR,
+                enum=dataunits.CARRIER_NAMES,
+            ),
+        ],
+    )
+    def post(self, request: Request, carrier_name: str):
+        """
+        Modify a scheduled pickup
+        """
+        payload = PickupUpdateRequest.map(data=request.data).data
+
+        response = Pickups.update(payload, context=request, carrier_name=carrier_name)
+
+        return Response(PickupResponse(response).data, status=status.HTTP_200_OK)
+
+
+class PickupCancel(APIView):
+    throttle_scope = "carrier_request"
+
+    @openapi.extend_schema(
+        tags=["Proxy"],
+        operation_id=f"{ENDPOINT_ID}cancel_pickup",
+        extensions={"x-operationId": "pickupCancel"},
+        summary="Cancel a pickup",
+        request=PickupCancelRequest(),
+        responses={
+            200: OperationResponse(),
+            400: ErrorResponse(),
+            424: ErrorMessages(),
+            500: ErrorResponse(),
+        },
+        parameters=[
+            openapi.OpenApiParameter(
+                "carrier_name",
+                location=openapi.OpenApiParameter.PATH,
+                type=openapi.OpenApiTypes.STR,
+                enum=dataunits.CARRIER_NAMES,
+            ),
+        ],
+    )
+    def post(self, request: Request, carrier_name: str):
+        """
+        Cancel a pickup previously scheduled
+        """
+        payload = PickupCancelRequest.map(data=request.data).data
+
+        response = Pickups.cancel(payload, context=request, carrier_name=carrier_name)
+
+        return Response(OperationResponse(response).data, status=status.HTTP_200_OK)
+
+
+router.urls.append(
+    path(
+        "proxy/pickups/<carrier_name>", PickupSchedule.as_view(), name="pickup-schedule"
+    )
+)
+router.urls.append(
+    path(
+        "proxy/pickups/<carrier_name>/update",
+        PickupUpdate.as_view(),
+        name="pickup-details",
+    )
+)
+router.urls.append(
+    path(
+        "proxy/pickups/<carrier_name>/cancel",
+        PickupCancel.as_view(),
+        name="pickup-cancel",
+    )
+)