Merge pull request #90 from PurplShip/purplship-2021.0-doc-friendly

Purplship 2021.0 doc friendly

Author: danh91

.gitignore

@@ -101,5 +101,3 @@ ENV/
 .mypy_cache/
 
 .idea/
-
-VERSION

.templates/carrier/purplship/mappers/carrier/__init__.py

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

.templates/carrier/purplship/mappers/carrier/mapper.py

@@ -0,0 +1,125 @@
+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,
+    # PickupUpdateRequest,
+    # PickupCancelRequest,
+    # ShipmentRequest,
+    # TrackingRequest,
+    # PickupRequest,
+    RateRequest,
+
+    # AddressValidationDetails,
+    # ConfirmationDetails,
+    # TrackingDetails,
+    # ShipmentDetails,
+    # PickupDetails,
+    RateDetails,
+    Message,
+)
+from purplship.providers.carrier import (
+    # parse_address_validation_response,
+    # parse_shipment_cancel_response,
+    # parse_pickup_update_response,
+    # parse_pickup_cancel_response,
+    # parse_shipment_response,
+    # parse_tracking_response,
+    # parse_pickup_response,
+    parse_rate_response,
+
+    # address_validation_request,
+    # shipment_cancel_request,
+    # pickup_update_request,
+    # pickup_cancel_request,
+    # tracking_request,
+    # shipment_request,
+    # pickup_request,
+    rate_request,
+)
+from purplship.mappers.carrier.settings import Settings
+
+
+class Mapper(BaseMapper):
+    settings: Settings
+
+    """Request Mappers"""
+
+    # def create_address_validation_request(self, payload: AddressValidationRequest) -> Serializable:
+    #     return address_validation_request(payload, self.settings)
+    #
+    # def create_pickup_request(
+    #     self, payload: PickupRequest
+    # ) -> Serializable:
+    #     return pickup_request(payload, self.settings)
+    #
+    # def create_pickup_update_request(
+    #     self, payload: PickupUpdateRequest
+    # ) -> Serializable:
+    #     return pickup_update_request(payload, self.settings)
+    #
+    # def create_cancel_pickup_request(
+    #     self, payload: PickupCancelRequest
+    # ) -> Serializable:
+    #     return pickup_cancel_request(payload, self.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)
+
+    """Response Parsers"""
+
+    # def parse_address_validation_response(
+    #     self, response: Deserializable
+    # ) -> Tuple[AddressValidationDetails, List[Message]]:
+    #     return parse_address_validation_response(response.deserialize(), self.settings)
+    #
+    # def parse_cancel_pickup_response(
+    #     self, response: Deserializable[str]
+    # ) -> Tuple[ConfirmationDetails, List[Message]]:
+    #     return parse_pickup_cancel_response(response.deserialize(), self.settings)
+    #
+    # def parse_pickup_response(
+    #     self, response: Deserializable[str]
+    # ) -> Tuple[PickupDetails, List[Message]]:
+    #     return parse_pickup_response(response.deserialize(), self.settings)
+    #
+    # def parse_pickup_update_response(
+    #     self, response: Deserializable[str]
+    # ) -> Tuple[PickupDetails, List[Message]]:
+    #     return parse_pickup_update_response(response.deserialize(), 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
+    # ) -> 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)

.templates/carrier/purplship/mappers/carrier/proxy.py

@@ -0,0 +1,66 @@
+from typing import Any
+from purplship.core.utils import XP, request as http, Serializable, Deserializable
+from purplship.api.proxy import Proxy as BaseProxy
+from purplship.mappers.carrier.settings import Settings
+
+
+class Proxy(BaseProxy):
+    settings: Settings
+
+    """ Proxy Methods """
+
+    # def validate_address(self, request: Serializable) -> Deserializable[str]:
+    #     response = self._send_request(request)
+    #
+    #     return Deserializable(response, XP.to_xml)
+
+    def get_rates(self, request: Serializable) -> Deserializable[str]:
+        response = self._send_request(request)
+
+        return Deserializable(response, XP.to_xml)
+
+    # def get_tracking(
+    #     self, request: Serializable
+    # ) -> Deserializable[str]:
+    #     response = self._send_request(request)
+    #
+    #     return Deserializable(response, XP.to_xml)
+    #
+    # def create_shipment(
+    #     self, request: Serializable
+    # ) -> Deserializable[str]:
+    #     response = self._send_request(request)
+    #
+    #     return Deserializable(response, XP.to_xml)
+    #
+    # def schedule_pickup(
+    #     self, request: Serializable
+    # ) -> Deserializable[str]:
+    #     response = self._send_request(request)
+    #
+    #     return Deserializable(response, XP.to_xml)
+    #
+    # def modify_pickup(
+    #     self, request: Serializable
+    # ) -> Deserializable[str]:
+    #     response = self._send_request(request)
+    #
+    #     return Deserializable(response, XP.to_xml)
+    #
+    # def cancel_pickup(
+    #     self, request: Serializable
+    # ) -> Deserializable[str]:
+    #     response = self._send_request(request)
+    #
+    #     return Deserializable(response, XP.to_xml)
+
+    """ Private Methods """
+
+    def _send_request(self, request: Serializable[Any]) -> str:
+        return http(
+            url=self.settings.server_url,
+            data=bytearray(request.serialize(), "utf-8"),
+            headers={"Content-Type": "application/xml"},
+            method="POST",
+        )
+

.templates/carrier/purplship/mappers/carrier/settings.py

@@ -0,0 +1,19 @@
+"""Purplship [carrier] settings."""
+
+import attr
+from purplship.providers.carrier.utils import Settings as BaseSettings
+
+
+@attr.s(auto_attribs=True)
+class Settings(BaseSettings):
+    """[carrier] connection settings."""
+
+    # Carrier specific properties
+    # username: str
+    # password: str
+    # account_number: str = None
+
+    # Base properties
+    id: str = None
+    test: bool = False
+    carrier_id: str = "dhl_express"

.templates/carrier/purplship/providers/carrier/__init__.py

@@ -0,0 +1,24 @@
+from purplship.providers.carrier.utils import Settings
+from purplship.providers.carrier.rate import parse_rate_response, rate_request
+# from purplship.providers.carrier.address import (
+#     parse_address_validation_response,
+#     address_validation_request
+# )
+# from purplship.providers.carrier.shipment import (
+#     parse_shipment_cancel_response,
+#     parse_shipment_response,
+#     shipment_cancel_request,
+#     shipment_request,
+# )
+# from purplship.providers.carrier.pickup import (
+#     parse_pickup_cancel_response,
+#     parse_pickup_update_response,
+#     parse_pickup_response,
+#     pickup_update_request,
+#     pickup_cancel_request,
+#     pickup_request,
+# )
+# from purplship.providers.carrier.tracking import (
+#     parse_tracking_response,
+#     tracking_request,
+# )

.templates/carrier/purplship/providers/carrier/address.py

@@ -0,0 +1,30 @@
+from typing import Tuple, List
+from purplship.core.utils import Serializable
+from purplship.core.models import AddressValidationRequest, Message, AddressValidationDetails
+from purplship.providers.carrier.utils import Settings
+from purplship.providers.carrier.error import parse_error_response
+
+
+def parse_address_validation_response(response, settings: Settings) -> Tuple[AddressValidationDetails, List[Message]]:
+    successful = True  # retrieve success status from `response`
+    validation_details = AddressValidationDetails(
+        carrier_id=settings.carrier_id,
+        carrier_name=settings.carrier_name,
+        success=successful
+    ) if successful else None
+
+    return validation_details, parse_error_response(response, settings)
+
+
+def address_validation_request(payload: AddressValidationRequest, settings: Settings) -> Serializable['CarrierAddressValidationRequest']:
+
+    # request = CarrierAddressValidationRequest(
+    #     ...
+    # )
+    #
+    # return Serializable(request, _request_serializer)
+    pass
+
+
+def _request_serializer(request: 'CarrierAddressValidationRequest') -> str:
+    pass

.templates/carrier/purplship/providers/carrier/error.py

@@ -0,0 +1,21 @@
+from typing import List
+from purplship.providers.carrier import Settings
+from purplship.core.models import Message
+
+
+def parse_error_response(response, settings: Settings) -> List[Message]:
+    carrier_errors = []  # retrieve carrier errors from `response`
+    return [_extract_error(node, settings) for node in carrier_errors]
+
+
+def _extract_error(carrier_error, settings: Settings) -> Message:
+    return Message(
+        # context info
+        carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
+
+        # carrier error info
+        code=carrier_error.code,
+        message=carrier_error.description,
+        details=carrier_error.details
+    )

.templates/carrier/purplship/providers/carrier/pickup/__init__.py

@@ -0,0 +1,3 @@
+from purplship.providers.carrier.pickup.create import parse_pickup_response, pickup_request
+from purplship.providers.carrier.pickup.update import parse_pickup_update_response, pickup_update_request
+from purplship.providers.carrier.pickup.cancel import parse_pickup_cancel_response, pickup_cancel_request

.templates/carrier/purplship/providers/carrier/pickup/cancel.py

@@ -0,0 +1,39 @@
+from typing import Tuple, List
+from purplship.core.utils import Serializable
+from purplship.core.models import (
+    PickupCancelRequest,
+    Message,
+    ConfirmationDetails,
+)
+from purplship.providers.carrier.utils import Settings, reformat_time
+from purplship.providers.carrier.error import parse_error_response
+
+
+def parse_pickup_cancel_response(response, settings) -> Tuple[ConfirmationDetails, List[Message]]:
+    successful = True  # retrieve success status from `response`
+    cancellation = (
+        ConfirmationDetails(
+            carrier_name=settings.carrier_name,
+            carrier_id=settings.carrier_id,
+            success=successful,
+            operation="Cancel Pickup",
+        )
+        if successful
+        else None
+    )
+
+    return cancellation, parse_error_response(response, settings)
+
+
+def pickup_cancel_request(payload: PickupCancelRequest, settings: Settings) -> Serializable['CarrierPickupCancelRequest']:
+
+    # request = CarrierPickupCancelRequest(
+    #     ...
+    # )
+    #
+    # return Serializable(request, _request_serializer)
+    pass
+
+
+def _request_serializer(request: 'CarrierPickupCancelRequest') -> str:
+    pass