Merge pull request #138 from purplship/patch-purolator-label-type-mapper

[patch] Use unified label_type mapper for the purolator shipping label_type

Author: danh91

extensions/purolator/purplship/providers/purolator/shipment/create.py

@@ -101,7 +101,7 @@ def _shipment_request(payload: ShipmentRequest, settings: Settings) -> Serializa
     is_international = (payload.shipper.country_code != payload.recipient.country_code)
     shipper_phone_number = Phone(payload.shipper.phone_number, payload.shipper.country_code)
     recipient_phone_number = Phone(payload.recipient.phone_number, payload.recipient.country_code)
-    printing = PrintType[options.label_printing or "PDF"].value
+    printing = PrintType.map(payload.label_type or "PDF").value
     option_ids = [
         (key, value) for key, value in options if key in Service and key not in NON_OFFICIAL_SERVICES
     ]
@@ -111,7 +111,7 @@ def _shipment_request(payload: ShipmentRequest, settings: Settings) -> Serializa
             Version="2.1",
             Language=settings.language,
             GroupID="",
-            RequestReference="",
+            RequestReference=payload.reference,
             UserToken=settings.user_token,
         ),
         body_content=CreateShipmentRequest(
@@ -128,9 +128,7 @@ def _shipment_request(payload: ShipmentRequest, settings: Settings) -> Serializa
                         StreetDirection=None,
                         Suite=None,
                         Floor=None,
-                        StreetAddress2=SF.concat_str(
-                            payload.shipper.address_line2, join=True
-                        ),
+                        StreetAddress2=SF.concat_str(payload.shipper.address_line2, join=True),
                         StreetAddress3=None,
                         City=payload.shipper.city or "",
                         Province=payload.shipper.state_code or "",
@@ -144,8 +142,7 @@ def _shipment_request(payload: ShipmentRequest, settings: Settings) -> Serializa
                         ),
                         FaxNumber=None,
                     ),
-                    TaxNumber=payload.shipper.federal_tax_id
-                              or payload.shipper.state_tax_id,
+                    TaxNumber=(payload.shipper.federal_tax_id or payload.shipper.state_tax_id),
                 ),
                 ReceiverInformation=ReceiverInformation(
                     Address=Address(
@@ -154,16 +151,12 @@ def _shipment_request(payload: ShipmentRequest, settings: Settings) -> Serializa
                         Department=None,
                         StreetNumber="",
                         StreetSuffix=None,
-                        StreetName=SF.concat_str(
-                            payload.recipient.address_line1, join=True
-                        ),
+                        StreetName=SF.concat_str(payload.recipient.address_line1, join=True),
                         StreetType=None,
                         StreetDirection=None,
                         Suite=None,
                         Floor=None,
-                        StreetAddress2=SF.concat_str(
-                            payload.recipient.address_line2, join=True
-                        ),
+                        StreetAddress2=SF.concat_str(payload.recipient.address_line2, join=True),
                         StreetAddress3=None,
                         City=payload.recipient.city or "",
                         Province=payload.recipient.state_code or "",
@@ -177,9 +170,7 @@ def _shipment_request(payload: ShipmentRequest, settings: Settings) -> Serializa
                         ),
                         FaxNumber=None,
                     ),
-                    TaxNumber=(
-                            payload.recipient.federal_tax_id or payload.recipient.state_tax_id
-                    ),
+                    TaxNumber=(payload.recipient.federal_tax_id or payload.recipient.state_tax_id),
                 ),
                 FromOnLabelIndicator=None,
                 FromOnLabelInformation=None,
@@ -304,7 +295,7 @@ def _shipment_request(payload: ShipmentRequest, settings: Settings) -> Serializa
                 ),
                 NotificationInformation=(
                     NotificationInformation(
-                        ConfirmationEmailAddress=options.notification_email or payload.recipient.email
+                        ConfirmationEmailAddress=(options.notification_email or payload.recipient.email)
                     )
                     if options.notification_email is None else None
                 ),
@@ -327,21 +318,16 @@ def _create_shipment(payload: ShipmentRequest, settings: Settings) -> Job:
     )
 
 
-def _get_shipment_label(
-        create_response: str, payload: ShipmentRequest, settings: Settings
-) -> Job:
-    errors = parse_error_response(XP.to_xml(create_response), settings)
-    valid = len(errors) == 0
+def _get_shipment_label(create_response: str, payload: ShipmentRequest, settings: Settings) -> Job:
+    response = XP.to_xml(create_response)
+    valid = len(parse_error_response(response, settings)) == 0
     shipment_pin = (
-        getattr(XP.find("ShipmentPIN", XP.to_xml(create_response), PIN, first=True), 'Value', None)
+        getattr(XP.find("ShipmentPIN", response, PIN, first=True), 'Value', None)
         if valid else None
     )
-    return Job(
-        id="document",
-        data=(
-            get_shipping_documents_request(shipment_pin, payload, settings)
-            if valid
-            else None
-        ),
-        fallback="",
+    data = (
+        get_shipping_documents_request(shipment_pin, payload, settings)
+        if valid else None
     )
+
+    return Job(id="document", data=data, fallback="")

extensions/purolator/purplship/providers/purolator/shipment/documents.py

@@ -17,11 +17,11 @@ def get_shipping_documents_request(
     pin: str, payload: ShipmentRequest, settings: Settings
 ) -> Serializable[Envelope]:
     is_international = payload.shipper.country_code != payload.recipient.country_code
-    print_type = PrintType[payload.label_type or 'PDF'].name
+    label_type = PrintType.map(payload.label_type or 'PDF').name
     document_type = SF.concat_str(
         ("International" if is_international else "Domestic"),
         "BillOfLading",
-        ("Thermal" if print_type == "ZPL" else ""),
+        ("Thermal" if label_type == "ZPL" else ""),
         separator="", join=True
     )
 
@@ -30,17 +30,19 @@ def get_shipping_documents_request(
             Version="1.3",
             Language=settings.language,
             GroupID="",
-            RequestReference="",
+            RequestReference=payload.reference,
             UserToken=settings.user_token,
         ),
         body_content=GetDocumentsRequest(
-            OutputType=print_type,
+            OutputType=label_type,
             Synchronous=True,
             DocumentCriterium=ArrayOfDocumentCriteria(
                 DocumentCriteria=[
                     DocumentCriteria(
                         PIN=PIN(Value=pin),
-                        DocumentTypes=DocumentTypes(DocumentType=[document_type])
+                        DocumentTypes=DocumentTypes(
+                            DocumentType=[document_type]
+                        )
                     )
                 ]
             ),

extensions/purolator/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "purplship.purolator"
-version = "2021.6.2"
+version = "2021.6.3"
 homepage="https://sdk.purplship.com"
 repository="https://github.com/Purplship/purplship"
 description = "Purplship - Purolator Shipping Extension"

tests/purolator/shipment.py

@@ -120,7 +120,8 @@ def test_parse_cancel_shipment_response(self):
     ],
     "reference": "Reference For Shipment",
     "service": "purolator_express",
-    "options": {"printing": "PDF", "shipment_date": "2021-02-04"},
+    "label_type": "PDF",
+    "options": {"shipment_date": "2021-02-04"},
 }
 
 PARSED_SHIPMENT_RESPONSE = [
@@ -151,7 +152,7 @@ def test_parse_cancel_shipment_response(self):
             <v2:Version>2.1</v2:Version>
             <v2:Language>en</v2:Language>
             <v2:GroupID></v2:GroupID>
-            <v2:RequestReference></v2:RequestReference>
+            <v2:RequestReference>Reference For Shipment</v2:RequestReference>
             <v2:UserToken>token</v2:UserToken>
         </v2:RequestContext>
     </soap:Header>
@@ -227,7 +228,7 @@ def test_parse_cancel_shipment_response(self):
             <v1:Version>1.3</v1:Version>
             <v1:Language>en</v1:Language>
             <v1:GroupID></v1:GroupID>
-            <v1:RequestReference></v1:RequestReference>
+            <v1:RequestReference>Reference For Shipment</v1:RequestReference>
             <v1:UserToken>token</v1:UserToken>
         </v1:RequestContext>
     </soap:Header>