Merge pull request #64 from PurplShip/rename-carrier-identifiers

Rename carrier identifiers

README.md

@@ -8,16 +8,25 @@
 
 ## Introduction
 
-PurplShip is a system for connecting multiple supply chain carriers API.
+PurplShip is a system for connecting multiple logistics carriers API.
 
-In addition to providing a unified and simplified interface across logistics carriers APIs, PurplShip offers a framework to facilitate the full access of advanced and specific carriers capabilities while simplifying the addition of new carrier APIs.
+In addition to providing a unified and simplified interface across logistics carriers APIs, 
+PurplShip offers a framework to facilitate the full access of advanced and specific carriers capabilities 
+while simplifying the addition of new carrier APIs.
 
 With PurplShip you can:
 
 - Integrate multiple carriers web services: DHL, FedEx, UPS, USPS, Canada Post and more with ease
 - Use a modern and intuitive, unified API across carriers
 
 
+## Integration
+
+PurplShip has two layers
+
+- **PurplShip SDK** for an integration as a Python library. *[documentation](#Documentation) bellow*
+- **PurplShip Server** for a self-hosted private cloud REST API. *documentation and usage can be found at [docs.purplship.com](https://docs.purplship.com)*
+
 ## License
 
 Please see [LICENSE.md](https://github.com/PurplShip/purplship/blob/master/LICENSE) for licensing details.
@@ -78,11 +87,11 @@ This instruction will get you started with `purplship.package` and the support f
 -f https://git.io/purplship
 
 # core packages
-purplship==2020.6.0
-purplship.package==2020.6.0
+purplship==2020.6.1
+purplship.package==2020.6.1
 
 # carriers
-purplship.canadapost==2020.6.0
+purplship.canadapost==2020.6.1
 ```
 
 <details>
@@ -91,10 +100,10 @@ purplship.canadapost==2020.6.0
 You can add additional carriers you desire to work with
 
 ```text
-purplship.dhl==2020.6.0
-purplship.fedex==2020.6.0
-purplship.purolator==2020.6.0
-purplship.ups==2020.6.0
+purplship.dhl==2020.6.1
+purplship.fedex==2020.6.1
+purplship.purolator==2020.6.1
+purplship.ups==2020.6.1
 ```
 
 </details>

extensions/canadapost/purplship/carriers/canadapost/error.py

@@ -21,8 +21,8 @@ def extract(errors: List[Message], message_node: Element) -> List[Message]:
             Message(
                 code=message.code,
                 message=message.description,
-                carrier=settings.carrier,
                 carrier_name=settings.carrier_name,
+                carrier_id=settings.carrier_id,
             )
         ]
 

extensions/canadapost/purplship/carriers/canadapost/rating.py

@@ -46,8 +46,8 @@ def _extract_quote(price_quote_node: Element, settings: Settings) -> RateDetails
         for d in price_quote.price_details.adjustments.adjustment
     ]
     return RateDetails(
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         currency=currency,
         estimated_delivery=format_date(
             price_quote.service_standard.expected_delivery_date
@@ -86,7 +86,7 @@ def mailing_scenario_request(
     """
     if payload.shipper.country_code and payload.shipper.country_code != Country.CA.name:
         raise OriginNotServicedError(
-            payload.shipper.country_code, settings.carrier_name
+            payload.shipper.country_code, settings.carrier_id
         )
 
     parcel_preset = (

extensions/canadapost/purplship/carriers/canadapost/shipment/contract_shipment.py

@@ -61,8 +61,8 @@ def _extract_shipment(response: Element, settings: Settings) -> ShipmentDetails:
     info.build(info_node)
 
     return ShipmentDetails(
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         tracking_number=info.tracking_pin,
         label=label.text if len(errors) == 0 else None,
     )

extensions/canadapost/purplship/carriers/canadapost/shipment/non_contract_shipment.py

@@ -56,8 +56,8 @@ def _extract_shipment(response: Element, settings: Settings) -> ShipmentDetails:
     info.build(info_node)
 
     return ShipmentDetails(
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         tracking_number=info.tracking_pin,
         label=label.text if len(errors) == 0 else None,
     )

extensions/canadapost/purplship/carriers/canadapost/track.py

@@ -25,8 +25,8 @@ def _extract_tracking(pin_summary_node: Element, settings: Settings) -> Tracking
     pin_summary_ = pin_summary()
     pin_summary_.build(pin_summary_node)
     return TrackingDetails(
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         tracking_number=pin_summary_.pin,
         events=[
             TrackingEvent(

extensions/canadapost/purplship/carriers/canadapost/utils.py

@@ -14,7 +14,7 @@ class Settings(BaseSettings):
     id: str = None
 
     @property
-    def carrier(self):
+    def carrier_name(self):
         return "canadapost"
 
     @property

extensions/canadapost/purplship/package/mappers/canadapost/settings.py

@@ -14,4 +14,4 @@ class Settings(BaseSettings):
     contract_id: str = None
     id: str = None
     test: bool = False
-    carrier_name: str = "CanadaPost"
+    carrier_id: str = "canadapost"

extensions/canadapost/setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_namespace_packages
 
 setup(name='purplship.canadapost',
-      version='2020.6.0',
+      version='2020.6.1',
       description='Multi-carrier shipping API integration with python',
       url='https://github.com/PurplShip/purplship',
       author='PurplShip',

extensions/dhl/purplship/carriers/dhl/book_pickup.py

@@ -51,8 +51,8 @@ def _extract_pickup(response: Element, settings: Settings) -> PickupDetails:
         else None
     )
     return PickupDetails(
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         confirmation_number=str(pickup.ConfirmationNumber[0]),
         pickup_date=format_date(pickup.NextPickupDate),
         pickup_charge=pickup_charge,

extensions/dhl/purplship/carriers/dhl/dct_quote.py

@@ -76,8 +76,8 @@ def _extract_quote(qtdshp_node: Element, settings: Settings) -> RateDetails:
         qtdshp.LocalProductName,
     )
     return RateDetails(
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         currency=qtdshp.CurrencyCode,
         estimated_delivery=format_date(delivery_date),
         service=service_name,

extensions/dhl/purplship/carriers/dhl/error.py

@@ -21,8 +21,8 @@ def extract(errors: List[Message], condition_node: Element) -> List[Message]:
             Message(
                 code=condition.ConditionCode,
                 message=condition.ConditionData,
-                carrier=settings.carrier,
                 carrier_name=settings.carrier_name,
+                carrier_id=settings.carrier_id,
             )
         ]
 

extensions/dhl/purplship/carriers/dhl/modify_pickup.py

@@ -51,8 +51,8 @@ def _extract_pickup(response: Element, settings: Settings) -> PickupDetails:
         else None
     )
     return PickupDetails(
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         confirmation_number=str(pickup.ConfirmationNumber[0]),
         pickup_date=format_date(pickup.NextPickupDate)
         if pickup.NextPickupDate is not None

extensions/dhl/purplship/carriers/dhl/ship_val.py

@@ -65,8 +65,8 @@ def _extract_shipment(shipment_node, settings: Settings) -> Optional[ShipmentDet
     label = encodebytes(cast(LabelImage, label_image).OutputImage).decode("utf-8")
 
     return ShipmentDetails(
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         tracking_number=shipment.AirwayBillNumber,
         label=label,
     )

extensions/dhl/purplship/carriers/dhl/tracking_known.py

@@ -40,8 +40,8 @@ def _extract_tracking(
         return None
 
     return TrackingDetails(
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         tracking_number=info.AWBNumber,
         events=list(
             map(

extensions/dhl/purplship/carriers/dhl/utils.py

@@ -12,8 +12,8 @@ class Settings(BaseSettings):
     id: str = None
 
     @property
-    def carrier(self):
-        return "dhl"
+    def carrier_name(self):
+        return "dhl_express"
 
     @property
     def server_url(self):

extensions/dhl/purplship/freight/mappers/dhl/settings.py

@@ -13,4 +13,4 @@ class Settings(BaseSettings):
     account_number: str = None
     id: str = None
     test: bool = False
-    carrier_name: str = "DHL Freight"
+    carrier_id: str = "dhl_freight"

extensions/dhl/purplship/package/mappers/dhl/settings.py

@@ -13,4 +13,4 @@ class Settings(BaseSettings):
     account_number: str = None
     id: str = None
     test: bool = False
-    carrier_name: str = "DHL"
+    carrier_id: str = "dhl_express"

extensions/dhl/setup.py

@@ -2,7 +2,7 @@
 
 
 setup(name='purplship.dhl',
-      version='2020.6.0',
+      version='2020.6.1',
       description='Multi-carrier shipping API integration with python',
       url='https://github.com/PurplShip/purplship',
       author='PurplShip',

extensions/fedex/purplship/carriers/fedex/error.py

@@ -24,8 +24,8 @@ def extract(messages: List[Message], notification_node: Element) -> List[Message
                 Message(
                     code=notification.Code,
                     message=notification.Message,
-                    carrier=settings.carrier,
                     carrier_name=settings.carrier_name,
+                    carrier_id=settings.carrier_id,
                 )
             )
         return messages

extensions/fedex/purplship/carriers/fedex/package/rate.py

@@ -67,8 +67,8 @@ def _extract_rate(detail_node: Element, settings: Settings) -> Optional[RateDeta
     ]
 
     return RateDetails(
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         service=service,
         currency=currency,
         base_charge=decimal(shipment_rate.TotalBaseCharge.Amount),

extensions/fedex/purplship/carriers/fedex/package/ship_service.py

@@ -88,8 +88,8 @@ def _extract_shipment(
     )
 
     return ShipmentDetails(
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         tracking_number=tracking_number,
         label=label,
     )

extensions/fedex/purplship/carriers/fedex/track_service.py

@@ -42,8 +42,8 @@ def _extract_tracking(
     if track_detail.Notification.Severity == "ERROR":
         return None
     return TrackingDetails(
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         tracking_number=track_detail.TrackingNumber,
         events=list(
             map(

extensions/fedex/purplship/carriers/fedex/utils.py

@@ -16,7 +16,7 @@ class Settings(BaseSettings):
     id: str = None
 
     @property
-    def carrier(self):
+    def carrier_name(self):
         return "fedex"
 
     @property

extensions/fedex/purplship/freight/mappers/fedex/settings.py

@@ -14,4 +14,4 @@ class Settings(BaseSettings):
     account_number: str = None
     id: str = None
     test: bool = False
-    carrier_name: str = "FedEx Freight"
+    carrier_id: str = "fedex_freight"

extensions/fedex/purplship/package/mappers/fedex/settings.py

@@ -14,4 +14,4 @@ class Settings(BaseSettings):
     account_number: str
     id: str = None
     test: bool = False
-    carrier_name: str = "FedEx"
+    carrier_id: str = "fedex"

extensions/fedex/setup.py

@@ -2,7 +2,7 @@
 
 
 setup(name='purplship.fedex',
-      version='2020.6.0',
+      version='2020.6.1',
       description='Multi-carrier shipping API integration with python',
       url='https://github.com/PurplShip/purplship',
       author='PurplShip',

extensions/freight/purplship/freight/interface.py

@@ -38,8 +38,8 @@ def deserialize():
             [
                 Message(
                     code="500",
-                    carrier=gateway.settings.carrier,
                     carrier_name=gateway.settings.carrier_name,
+                    carrier_id=gateway.settings.carrier_id,
                     message=f"{error}",
                 )
             ],

extensions/freight/setup.py

@@ -2,7 +2,7 @@
 
 
 setup(name='purplship.freight',
-      version='2020.6.0',
+      version='2020.6.1',
       description='Multi-carrier shipping API integration with python',
       url='https://github.com/PurplShip/purplship',
       author='PurplShip',

extensions/package/purplship/package/interface.py

@@ -28,8 +28,8 @@ def abort(error: Exception, gateway: Gateway):
         [
             Message(
                 code="500",
-                carrier=gateway.settings.carrier,
                 carrier_name=gateway.settings.carrier_name,
+                carrier_id=gateway.settings.carrier_id,
                 message=f"{error}",
             )
         ],

extensions/package/setup.py

@@ -2,7 +2,7 @@
 
 
 setup(name='purplship.package',
-      version='2020.6.0',
+      version='2020.6.1',
       description='Multi-carrier shipping API integration with python',
       url='https://github.com/PurplShip/purplship',
       author='PurplShip',

extensions/purolator/purplship/carriers/purolator/error.py

@@ -21,8 +21,8 @@ def _extract_error(error_node: Element, settings: Settings) -> Message:
     return Message(
         code=error.Code,
         message=error.Description,
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         details=dict(AdditionalInformation=error.AdditionalInformation)
         if error.AdditionalInformation is not None
         else None,
@@ -35,6 +35,6 @@ def _extract_fault(fault_node: Element, settings: Settings) -> Message:
     return Message(
         code=error.faultcode,
         message=error.faultstring,
-        carrier=settings.carrier,
-        carrier_name=settings.carrier_name
+        carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id
     )

extensions/purolator/purplship/carriers/purolator/package/estimate_service.py

@@ -82,8 +82,8 @@ def _extract_rate(estimate_node: Element, settings: Settings) -> RateDetails:
         (p.name for p in Product if p.value in estimate.ServiceID), estimate.ServiceID
     )
     return RateDetails(
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         service=service,
         currency=currency,
         base_charge=decimal(estimate.BasePrice),

extensions/purolator/purplship/carriers/purolator/package/shipping_service/__init__.py

@@ -50,8 +50,8 @@ def _extract_shipment(response: Element, settings: Settings) -> ShipmentDetails:
     )
 
     return ShipmentDetails(
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         tracking_number=cast(PIN, shipment.ShipmentPIN).Value,
         label=label,
     )

extensions/purolator/purplship/carriers/purolator/package/tracking_service.py

@@ -38,8 +38,8 @@ def _extract_tracking(node: Element, settings: Settings) -> TrackingDetails:
     track = TrackingInformation()
     track.build(node)
     return TrackingDetails(
-        carrier=settings.carrier,
         carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
         tracking_number=str(track.PIN.Value),
         events=[
             TrackingEvent(