Merge pull request #141 from purplship/purplship-sdk-2021.8

[release-candidate] purplship sdk 2021.8

Author: danh91

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+  "editor.formatOnPaste": true,
+  "python.terminal.activateEnvInCurrentTerminal": true,
+  "editor.formatOnSave": true,
+  "python.formatting.provider": "black",
+  "python.defaultInterpreterPath": "${workspaceFolder}/.venv/purplship",
+  "python.linting.mypyEnabled": true,
+  "python.linting.enabled": true,
+}

extensions/aramex/purplship/providers/aramex/error.py

@@ -11,7 +11,7 @@ def parse_error_response(response: Element, settings: Settings) -> List[Message]
 
 
 def _extract_error(node: Element, settings: Settings) -> Message:
-    notification = XP.build(Notification, node)
+    notification = XP.to_object(Notification, node)
 
     return Message(
         # context info

extensions/aramex/purplship/providers/aramex/tracking.py

@@ -26,7 +26,7 @@
 
 def parse_tracking_response(response, settings: Settings) -> Tuple[List[TrackingDetails], List[Message]]:
     non_existents = next(
-        (XP.build(ArrayOfstring, n) for n in response.xpath(".//*[local-name() = $name]", name="NonExistingWaybills")),
+        (XP.to_object(ArrayOfstring, n) for n in response.xpath(".//*[local-name() = $name]", name="NonExistingWaybills")),
         ArrayOfstring()
     )
     results = response.xpath(".//*[local-name() = $name]", name="TrackingResult")
@@ -49,7 +49,7 @@ def _extract_errors(non_existents: ArrayOfstring, settings: Settings) -> List[Me
 
 
 def _extract_detail(node: Element, settings: Settings) -> TrackingDetails:
-    detail = XP.build(TrackingResult, node)
+    detail = XP.to_object(TrackingResult, node)
 
     return TrackingDetails(
         carrier_name=settings.carrier_name,

extensions/aramex/pyproject.toml

@@ -1,8 +1,8 @@
 [tool.poetry]
 name = "purplship.aramex"
-version = "2021.7"
+version = "2021.8"
 homepage="https://sdk.purplship.com"
-repository="https://github.com/Purplship/purplship"
+repository="https://github.com/purplship/purplship"
 description = "Purplship - Aramex Shipping Extension"
 authors = ["Dan Kobina <danielkobina@gmail.com>"]
 license = "LGPLv3"

extensions/asendia_us/README.md

@@ -0,0 +1,30 @@
+# purplship.asendia_us
+
+This package is a Asendia US extension of the [purplship](https://pypi.org/project/purplship) multi carrier shipping SDK.
+
+## Requirements
+
+`Python 3.7+`
+
+## Installation
+
+```bash
+pip install purplship.asendia_us
+```
+
+## Usage
+
+```python
+import purplship
+from purplship.mappers.asendia_us.settings import Settings
+
+
+# Initialize a carrier gateway
+canadapost = purplship.gateway["asendia_us"].create(
+    Settings(
+        ...
+    )
+)
+```
+
+Check the [Purplship Mutli-carrier SDK docs](https://sdk.purplship.com) for Shipping API requests

extensions/asendia_us/purplship/mappers/asendia_us/__init__.py

@@ -0,0 +1,23 @@
+from purplship.core.metadata import Metadata
+
+from purplship.mappers.asendia_us.mapper import Mapper
+from purplship.mappers.asendia_us.proxy import Proxy
+from purplship.mappers.asendia_us.settings import Settings
+# import purplship.providers.asendia_us.units as units
+
+
+METADATA = Metadata(
+    id="asendia_us",
+    label="Asendia US",
+
+    # Integrations
+    Mapper=Mapper,
+    Proxy=Proxy,
+    Settings=Settings,
+
+    # Data Units
+    # options=units.OptionCode,
+    # package_presets=units.PackagePresets,
+    # packaging_types=units.PackagingType,
+    # services=units.Serives,
+)

extensions/asendia_us/purplship/mappers/asendia_us/mapper.py

@@ -0,0 +1,70 @@
+from typing import List, Tuple
+from purplship.core.utils.serializable import Serializable, Deserializable
+from purplship.api.mapper import Mapper as BaseMapper
+from purplship.core.models import (
+    AddressValidationRequest,
+    ShipmentCancelRequest,
+    ShipmentRequest,
+    TrackingRequest,
+    RateRequest,
+
+    ConfirmationDetails,
+    TrackingDetails,
+    ShipmentDetails,
+    RateDetails,
+    Message,
+)
+from purplship.providers.asendia_us import (
+    parse_shipment_cancel_response,
+    parse_shipment_response,
+    parse_tracking_response,
+    parse_rate_response,
+
+    shipment_cancel_request,
+    tracking_request,
+    shipment_request,
+    rate_request,
+)
+from purplship.mappers.asendia_us.settings import Settings
+
+
+class Mapper(BaseMapper):
+    settings: Settings
+
+    def create_rate_request(
+        self, payload: RateRequest
+    ) -> Serializable:
+        return rate_request(payload, self.settings)
+
+    def create_shipment_request(
+        self, payload: ShipmentRequest
+    ) -> Serializable:
+        return shipment_request(payload, self.settings)
+
+    def create_cancel_shipment_request(self, payload: ShipmentCancelRequest) -> Serializable:
+        return shipment_cancel_request(payload, self.settings)
+
+    def create_tracking_request(
+        self, payload: TrackingRequest
+    ) -> Serializable:
+        return tracking_request(payload, self.settings)
+
+    def parse_rate_response(
+        self, response: Deserializable[str]
+    ) -> Tuple[List[RateDetails], List[Message]]:
+        return parse_rate_response(response.deserialize(), self.settings)
+
+    def parse_shipment_response(
+        self, response: Deserializable[str]
+    ) -> Tuple[ShipmentDetails, List[Message]]:
+        return parse_shipment_response(response.deserialize(), self.settings)
+
+    def parse_cancel_shipment_response(
+        self, response: Deserializable[str]
+    ) -> Tuple[ConfirmationDetails, List[Message]]:
+        return parse_shipment_cancel_response(response.deserialize(), self.settings)
+
+    def parse_tracking_response(
+        self, response: Deserializable[str]
+    ) -> Tuple[List[TrackingDetails], List[Message]]:
+        return parse_tracking_response(response.deserialize(), self.settings)

extensions/asendia_us/purplship/mappers/asendia_us/proxy.py

@@ -0,0 +1,73 @@
+import base64
+import urllib.parse
+from typing import List, Tuple
+from purplship.core.utils import DP, Serializable, Deserializable, request as http, exec_async
+from purplship.api.proxy import Proxy as BaseProxy
+from purplship.mappers.asendia_us.settings import Settings
+
+
+class Proxy(BaseProxy):
+    settings: Settings
+
+    def _request(self, path: str, method: str = "GET", **kwargs):
+        return http(
+            url=f"{self.settings.server_url}{path}",
+            headers={
+                "Accept": "application/json",
+                "Authorization": f"Basic {self.settings.authorization}"
+            },
+            method=method,
+            **kwargs
+        )
+
+    # Proxy Methods
+
+    def get_tracking(self, request: Serializable) -> Deserializable[List[str]]:
+        def _get_tracking(ref: str):
+            return self._request(
+                f"/api/A1/v1.0/Tracking/Milestone?trackingNumberVendor={ref}")
+
+        responses: List[str] = exec_async(_get_tracking, request.serialize())
+
+        return Deserializable(
+            responses,
+            lambda res: [DP.to_dict(track) for track in res if any(track.strip())]
+        )
+
+    def get_rates(self, request: Serializable) -> Deserializable[str]:
+        query = urllib.parse.urlencode(request.serialize())
+        response = self._request(
+            f"/api/A1/v1.0/ShippingPlatform/ShippingRate?{query}")
+
+        return Deserializable(response, DP.to_dict)
+
+    def create_shipment(self, request: Serializable) -> Deserializable[str]:
+        response = self._request(
+            f"/api/A1/v1.0/ShippingPlatform/Package", "POST",
+            data=bytearray(request.serialize(), "utf-8")
+        )
+
+        return Deserializable(response, DP.to_dict)
+
+    def cancel_shipment(self, request: Serializable) -> Deserializable[Tuple[str, dict]]:
+        data = request.serialize()
+        query = urllib.parse.urlencode(data)
+        response = self._request(
+            f"/api/A1/v1.0/ShippingPlatform/Package?{query}", "DELETE")
+        
+        def deserialize(response: str) -> Tuple[str, dict]:
+            content = DP.to_dict(response)
+            labelUrl = next(
+                (label['content'] for label in (content.get("packageLabel") or {}).get("labels") or []),
+                None
+            )
+
+            if labelUrl is not None:
+                label = self._request(
+                    labelUrl, decoder=lambda b: base64.encodebytes(b).decode("utf-8"))
+
+                return label, content
+
+            return None, content
+
+        return Deserializable(response, deserialize)

extensions/asendia_us/purplship/mappers/asendia_us/settings.py

@@ -0,0 +1,21 @@
+"""Purplship Asendia US settings."""
+
+import attr
+from purplship.providers.asendia_us.utils import Settings as BaseSettings
+
+
+@attr.s(auto_attribs=True)
+class Settings(BaseSettings):
+    """Asendia US connection settings."""
+
+    # Carrier specific properties
+    username: str
+    password: str
+    x_asendia_one_api_key: str
+    account_number: str = None
+
+    # Base properties
+    id: str = None
+    test: bool = False
+    carrier_id: str = "asendia_us"
+    account_country_code: str = "US"

extensions/asendia_us/purplship/providers/asendia_us/__init__.py

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