Merge pull request #34 from PurplShip/CollectDeliveryEstimates

Collect delivery estimates

Author: danh91

purplship/domain/Types/datatypes.py

@@ -1,5 +1,6 @@
 """PurplShip Unified datatypes module."""
 from typing import List, NamedTuple, Dict
+import attr
 
 
 class party(NamedTuple):
@@ -182,155 +183,98 @@ class pickup_cancellation_request(NamedTuple):
 """ Generic response data types """
 
 
+@attr.s(auto_attribs=True)
 class Error:
     """PurplShip Error type."""
 
-    def __init__(self, message: str = None, code: str = None, carrier: str = None):
-        """Error type constructor."""
-        self.message = message
-        self.code = code
-        self.carrier = carrier
+    message: str = None
+    code: str = None
+    carrier: str = None
 
 
+@attr.s(auto_attribs=True)
 class ChargeDetails:
     """PurplShip charge type."""
 
-    def __init__(self, name: str = None, amount: float = None, currency: str = None):
-        """Charge details type constructor."""
-        self.name = name
-        self.amount = amount
-        self.currency = currency
+    name: str = None
+    amount: float = None
+    currency: str = None
 
 
+@attr.s(auto_attribs=True)
 class ReferenceDetails:
     """PurplShip reference details type."""
 
-    def __init__(self, value: str, type: str = None):
-        """Purplship Reference details type constructor."""
-        self.value = value
-        self.type = type
+    value: str
+    type: str = None
 
 
+@attr.s(auto_attribs=True)
 class TimeDetails:
     """PurplShip time details type."""
 
-    def __init__(self, value: str, name: str = None):
-        """Time details type constructor."""
-        self.value = value
-        self.name = name
+    value: str
+    name: str = None
 
 
+@attr.s(auto_attribs=True)
 class TrackingEvent:
     """PurplShip tracking event type."""
 
-    def __init__(
-        self,
-        date: str,
-        description: str,
-        location: str,
-        code: str,
-        time: str = None,
-        signatory: str = None,
-    ):
-        """Tracking event type constructor."""
-        self.date = date
-        self.time = time
-        self.description = description
-        self.location = location
-        self.code = code
-        self.signatory = signatory
+    date: str
+    description: str
+    location: str
+    code: str
+    time: str = None
+    signatory: str = None
 
 
+@attr.s(auto_attribs=True)
 class QuoteDetails:
     """PurplShip quote details type."""
 
-    def __init__(
-        self,
-        carrier: str,
-        service_name: str,
-        service_type: str,
-        base_charge: float,
-        duties_and_taxes: float,
-        total_charge: float,
-        currency: str,
-        pickup_time: str = None,
-        delivery_date: str = None,
-        pickup_date: str = None,
-        discount: float = None,
-        extra_charges: List[ChargeDetails] = [],
-    ):
-        """Quotes details type constructor."""
-        self.carrier = carrier
-        self.service_name = service_name
-        self.service_type = service_type
-        self.base_charge = base_charge
-        self.duties_and_taxes = duties_and_taxes
-        self.total_charge = total_charge
-        self.currency = currency
-        self.discount = discount
-        self.extra_charges = extra_charges
-
-        self.pickup_time = pickup_time
-        self.delivery_date = delivery_date
-        self.pickup_date = pickup_date
+    carrier: str
+    service_name: str
+    service_type: str
+    base_charge: float
+    duties_and_taxes: float
+    total_charge: float
+    currency: str
+    delivery_date: str = None
+    discount: float = None
+    extra_charges: List[ChargeDetails] = []
 
 
+@attr.s(auto_attribs=True)
 class TrackingDetails:
     """PurplShip tracking details type."""
 
-    def __init__(
-        self,
-        carrier: str,
-        tracking_number: str,
-        shipment_date: str = None,
-        events: List[TrackingEvent] = [],
-    ):
-        """Tracking details type constructor."""
-        self.carrier = carrier
-        self.events = events
-        self.shipment_date = shipment_date
-        self.tracking_number = tracking_number
+    carrier: str
+    tracking_number: str
+    shipment_date: str = None
+    events: List[TrackingEvent] = []
 
 
+@attr.s(auto_attribs=True)
 class ShipmentDetails:
     """PurplShip shipment details type."""
 
-    def __init__(
-        self,
-        carrier: str,
-        tracking_numbers: List[str],
-        total_charge: ChargeDetails,
-        charges: List[ChargeDetails],
-        shipment_date: str = None,
-        services: List[str] = None,
-        documents: List[str] = [],
-        reference: ReferenceDetails = None,
-    ):
-        """Shipment details type constructor."""
-        self.carrier = carrier
-        self.tracking_numbers = tracking_numbers
-        self.shipment_date = shipment_date
-        self.documents = documents
-        self.services = services
-        self.reference = reference
-        self.total_charge = total_charge
-        self.charges = charges
+    carrier: str
+    tracking_numbers: List[str]
+    total_charge: ChargeDetails
+    charges: List[ChargeDetails]
+    shipment_date: str = None
+    services: List[str] = None
+    documents: List[str] = []
+    reference: ReferenceDetails = None
 
 
+@attr.s(auto_attribs=True)
 class PickupDetails:
     """PurplShip pickup details type."""
 
-    def __init__(
-        self,
-        carrier: str,
-        confirmation_number: str,
-        pickup_date: str = None,
-        pickup_charge: ChargeDetails = None,
-        ref_times: List[TimeDetails] = None,
-    ):
-        """Pickup details type constructor."""
-        self.carrier = carrier
-        self.confirmation_number = confirmation_number
-        self.pickup_date = pickup_date
-        self.pickup_charge = pickup_charge
-        self.ref_times = ref_times
+    carrier: str
+    confirmation_number: str
+    pickup_date: str = None
+    pickup_charge: ChargeDetails = None
+    ref_times: List[TimeDetails] = None

purplship/mappers/caps/caps_mapper/partials/rate.py

@@ -83,7 +83,10 @@ def create_mailing_scenario(self, payload: T.shipment_request) -> mailing_scenar
             contract_id=payload.shipment.extra.get("contract-id"),
             promo_code=payload.shipment.extra.get("promo-code"),
             quote_type=payload.shipment.extra.get("quote-type"),
-            expected_mailing_date=payload.shipment.extra.get("expected-mailing-date"),
+            expected_mailing_date=(
+                payload.shipment.extra.get("expected-mailing-date") or 
+                datetime.today().strftime('%Y-%m-%d')
+            ),
             options=optionsType(
                 option=[
                     optionType(

purplship/mappers/dhl/dhl_mapper/partials/rate.py

@@ -48,8 +48,6 @@ def _extract_quote(
                 carrier=self.client.carrier_name,
                 currency=qtdshp.CurrencyCode,
                 delivery_date=str(qtdshp.DeliveryDate[0].DlvyDateTime),
-                pickup_date=str(qtdshp.PickupDate),
-                pickup_time=str(qtdshp.PickupCutoffTime),
                 service_name=qtdshp.LocalProductName,
                 service_type=qtdshp.NetworkTypeCode,
                 base_charge=float(qtdshp.WeightCharge or 0),

purplship/mappers/ups/ups_mapper/partials/rate.py

@@ -1,4 +1,3 @@
-import time
 from lxml import etree
 from pyups import freight_rate as Rate, package_rate as PRate, common as Common
 from .interface import reduce, Tuple, List, T, UPSMapperBase
@@ -94,6 +93,12 @@ def _extract_package_rate(
 
         extra_charges = itemized_charges + [rate.ServiceOptionsCharges]
 
+        arrival = PRate.PickupType()
+        [
+            arrival.build(arrival) for arrival in
+            detailNode.xpath(".//*[local-name() = $name]", name="Arrival")
+        ]
+
         return rates + [
             T.QuoteDetails(
                 carrier=self.client.carrier_name,
@@ -120,6 +125,7 @@ def _extract_package_rate(
                     [charge for charge in extra_charges if charge != None],
                     [],
                 ),
+                delivery_date=str(arrival.Date)
             )
         ]
 

setup.py

@@ -14,6 +14,7 @@
       license='LGPL',
       packages=find_packages(".", exclude=["tests"]),
       install_requires=[
+            'attrs==18.2.0',
             'py-fedex==1.1',
             'py-dhl==1.2',
             'py-soap==1.1',

tests/caps/__init__.py

@@ -1,4 +1,4 @@
 from tests.caps.tracking import *
 from tests.caps.quote import *
 from tests.caps.shipment import *
-from tests.caps.pickup import *
+from tests.caps.pickup import *

tests/caps/fixture.py

@@ -1,8 +1,10 @@
 from purplship.mappers.caps import CanadaPostClient, CanadaPostProxy
 
-proxy = CanadaPostProxy(CanadaPostClient(
-  server_url="https://ct.soa-gw.canadapost.ca",
-  username="username",
-  password="password",
-  customer_number="1234567"
-))
+proxy = CanadaPostProxy(
+    CanadaPostClient(
+        server_url="https://ct.soa-gw.canadapost.ca",
+        username="username",
+        password="password",
+        customer_number="1234567",
+    )
+)

tests/caps/pickup.py

@@ -12,21 +12,21 @@ def setUp(self):
         self.PickupRequest = PickupRequestDetailsType()
         self.PickupRequest.build(to_xml(PickupRequestXml))
 
-    @patch("purplship.mappers.caps.caps_proxy.http", return_value='<a></a>')
+    @patch("purplship.mappers.caps.caps_proxy.http", return_value="<a></a>")
     def test_request_pickup(self, http_mock):
         proxy.request_pickup(self.PickupRequest)
 
-        xmlStr = http_mock.call_args[1]['data'].decode("utf-8")
+        xmlStr = http_mock.call_args[1]["data"].decode("utf-8")
         self.assertEqual(strip(xmlStr), strip(PickupRequestXml))
 
-    @patch.object(proxy, 'request_pickup')
+    @patch.object(proxy, "request_pickup")
     def test_modify_pickup(self, proxy_mock):
         proxy.modify_pickup(self.PickupRequest)
 
         proxy_mock.assert_called()
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     unittest.main()
 
 PickupRequestXml = """<pickup-request-details xmlns="http://www.canadapost.ca/ws/pickuprequest">