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

Rename carrier identifiers

Author: danh91

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,