karrio-eshipper 2025.5rc1__py3-none-any.whl

karrio/mappers/eshipper/__init__.py

@@ -0,0 +1,3 @@
+from karrio.mappers.eshipper.mapper import Mapper
+from karrio.mappers.eshipper.proxy import Proxy
+from karrio.mappers.eshipper.settings import Settings

karrio/mappers/eshipper/mapper.py

@@ -0,0 +1,50 @@
+"""Karrio eShipper client mapper."""
+
+import typing
+import karrio.lib as lib
+import karrio.api.mapper as mapper
+import karrio.core.models as models
+import karrio.providers.eshipper as provider
+import karrio.mappers.eshipper.settings as provider_settings
+
+
+class Mapper(mapper.Mapper):
+    settings: provider_settings.Settings
+
+    def create_rate_request(self, payload: models.RateRequest) -> lib.Serializable:
+        return provider.rate_request(payload, self.settings)
+
+    def create_tracking_request(
+        self, payload: models.TrackingRequest
+    ) -> lib.Serializable:
+        return provider.tracking_request(payload, self.settings)
+
+    def create_shipment_request(
+        self, payload: models.ShipmentRequest
+    ) -> lib.Serializable:
+        return provider.shipment_request(payload, self.settings)
+
+    def create_cancel_shipment_request(
+        self, payload: models.ShipmentCancelRequest
+    ) -> lib.Serializable[str]:
+        return provider.shipment_cancel_request(payload, self.settings)
+
+    def parse_cancel_shipment_response(
+        self, response: lib.Deserializable[str]
+    ) -> typing.Tuple[models.ConfirmationDetails, typing.List[models.Message]]:
+        return provider.parse_shipment_cancel_response(response, self.settings)
+
+    def parse_rate_response(
+        self, response: lib.Deserializable[str]
+    ) -> typing.Tuple[typing.List[models.RateDetails], typing.List[models.Message]]:
+        return provider.parse_rate_response(response, self.settings)
+
+    def parse_shipment_response(
+        self, response: lib.Deserializable[str]
+    ) -> typing.Tuple[models.ShipmentDetails, typing.List[models.Message]]:
+        return provider.parse_shipment_response(response, self.settings)
+
+    def parse_tracking_response(
+        self, response: lib.Deserializable[str]
+    ) -> typing.Tuple[typing.List[models.TrackingDetails], typing.List[models.Message]]:
+        return provider.parse_tracking_response(response, self.settings)

karrio/mappers/eshipper/proxy.py

@@ -0,0 +1,65 @@
+"""Karrio eShipper client proxy."""
+
+import karrio.lib as lib
+import karrio.api.proxy as proxy
+import karrio.mappers.eshipper.settings as provider_settings
+
+
+class Proxy(proxy.Proxy):
+    settings: provider_settings.Settings
+
+    def get_rates(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        response = lib.request(
+            url=f"{self.settings.server_url}/api/v2/quote",
+            data=lib.to_json(request.serialize()),
+            trace=self.trace_as("json"),
+            method="POST",
+            headers={
+                "content-Type": "application/json",
+                "Authorization": f"Bearer {self.settings.access_token}",
+            },
+        )
+
+        return lib.Deserializable(response, lib.to_dict)
+
+    def create_shipment(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        response = lib.request(
+            url=f"{self.settings.server_url}/api/v2/ship",
+            data=lib.to_json(request.serialize()),
+            trace=self.trace_as("json"),
+            method="PUT",
+            headers={
+                "content-Type": "application/json",
+                "Authorization": f"Bearer {self.settings.access_token}",
+            },
+        )
+
+        return lib.Deserializable(response, lib.to_dict)
+
+    def cancel_shipment(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        response = lib.request(
+            url=f"{self.settings.server_url}/api/v2/ship/cancel",
+            data=lib.to_json(request.serialize()),
+            trace=self.trace_as("json"),
+            method="DELETE",
+            headers={
+                "content-Type": "application/json",
+                "Authorization": f"Bearer {self.settings.access_token}",
+            },
+        )
+
+        return lib.Deserializable(response, lib.to_dict)
+
+    def get_tracking(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        query = lib.to_query_string(request.serialize())
+        response = lib.request(
+            url=f"{self.settings.server_url}/api/v2/track/events?{query}",
+            trace=self.trace_as("json"),
+            method="GET",
+            headers={
+                "content-Type": "application/json",
+                "Authorization": f"Bearer {self.settings.access_token}",
+            },
+        )
+
+        return lib.Deserializable(response, lib.to_dict)

karrio/mappers/eshipper/settings.py

@@ -0,0 +1,21 @@
+"""Karrio eShipper client settings."""
+
+import attr
+import karrio.providers.eshipper.utils as provider_utils
+
+
+@attr.s(auto_attribs=True)
+class Settings(provider_utils.Settings):
+    """eShipper connection settings."""
+
+    # required carrier specific properties
+    principal: str
+    credential: str
+
+    # generic properties
+    id: str = None
+    test_mode: bool = False
+    carrier_id: str = "eshipper"
+    account_country_code: str = None
+    metadata: dict = {}
+    config: dict = {}

karrio/plugins/eshipper/__init__.py

@@ -0,0 +1,18 @@
+import karrio.core.metadata as metadata
+import karrio.mappers.eshipper as mappers
+import karrio.providers.eshipper.units as units
+
+
+METADATA = metadata.PluginMetadata(
+    status="production-ready",
+    id="eshipper",
+    label="eShipper",
+    # Integrations
+    Mapper=mappers.Mapper,
+    Proxy=mappers.Proxy,
+    Settings=mappers.Settings,
+    # Data Units
+    is_hub=True,
+    services=units.ShippingService,
+    options=units.ShippingOption,
+)

karrio/providers/eshipper/__init__.py

@@ -0,0 +1,13 @@
+
+from karrio.providers.eshipper.utils import Settings
+from karrio.providers.eshipper.rate import parse_rate_response, rate_request
+from karrio.providers.eshipper.shipment import (
+    parse_shipment_cancel_response,
+    parse_shipment_response,
+    shipment_cancel_request,
+    shipment_request,
+)
+from karrio.providers.eshipper.tracking import (
+    parse_tracking_response,
+    tracking_request,
+)

karrio/providers/eshipper/error.py

@@ -0,0 +1,53 @@
+import typing
+import karrio.lib as lib
+import karrio.core.models as models
+import karrio.providers.eshipper.utils as provider_utils
+
+
+def parse_error_response(
+    response: dict,
+    settings: provider_utils.Settings,
+    **kwargs,
+) -> typing.List[models.Message]:
+    responses = response if isinstance(response, list) else [response]
+    errors = [
+        *[_ for _ in responses if _.get("code")],
+        *sum(
+            [
+                [dict(code="warning", message=__) for __ in _.get("warnings")]
+                for _ in responses
+                if _.get("warnings")
+            ],
+            [],
+        ),
+        *sum(
+            [
+                [
+                    dict(
+                        code="error",
+                        message=order["message"]
+                    )
+                    for order in _.get("order", [])
+                    if "message" in order and order["message"].startswith("Error")
+                ]
+                for _ in responses
+            ],
+            [],
+        )
+    ]
+
+    return [
+        models.Message(
+            carrier_id=settings.carrier_id,
+            carrier_name=settings.carrier_name,
+            code=error.get("code"),
+            message=error.get("message"),
+            details={
+                **kwargs,
+                "type": error.get("type"),
+                "fieldErrors": error.get("fieldErrors"),
+                "thirdPartyMessage": error.get("thirdPartyMessage"),
+            },
+        )
+        for error in errors
+    ]