Merge pull request #99 from PurplShip/carrier-tracking-integration-spree

[release] Carrier Tracking integration spree

Author: danh91

.templates/extensions/carrier/README.md

@@ -1 +1,30 @@
-# Carrier
+# purplship.carrier
+
+This package is a [Carrier Name] extension of the [purplship](https://pypi.org/project/purplship) multi carrier shipping SDK.
+
+## Requirements
+
+`Python 3.6+`
+
+## Installation
+
+```bash
+pip install purplship.carrier
+```
+
+## Usage
+
+```python
+import purplship
+from purplship.mappers.carrier.settings import Settings
+
+
+# Initialize a carrier gateway
+canadapost = purplship.gateway["[carrier_name]"].create(
+    Settings(
+        ...
+    )
+)
+```
+
+Check the [Purplship Mutli-carrier SDK docs](https://sdk.purplship.com) for Shipping API requests

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

@@ -7,7 +7,7 @@
 
 
 METADATA = Metadata(
-    label="[carrier label]",
+    label="[Carrier Name]",
 
     # Integrations
     Mapper=Mapper,

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

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

.templates/extensions/carrier/purplship/providers/carrier/utils.py

@@ -2,7 +2,7 @@
 
 
 class Settings(BaseSettings):
-    """[carrier] connection settings."""
+    """[Carrier Name] connection settings."""
 
     # username: str
     # password: str
@@ -11,8 +11,12 @@ class Settings(BaseSettings):
 
     @property
     def carrier_name(self):
-        return "carrier"
+        return "[carrier_name]"
 
     @property
     def server_url(self):
-        return "https://api.carrier.com/"
+        return (
+            "https://dev-api.carrier.com"
+            if self.test
+            else "https://api.carrier.com"
+        )

.templates/extensions/carrier/pyproject.toml

@@ -16,12 +16,12 @@ classifiers=[
 ]
 
 [tool.poetry.dependencies]
-python = "^3.6"
+python = "^3.7"
 "purplship" = ""
-"carrier.carrier" = "[version]"
+"carrier.[carrier]" = ""
 
 [tool.poetry.dev-dependencies]
 
 [build-system]
-requires = ["poetry-core>=1.0.0"]
+requires = ["poetry-core>=1.0.0", "setuptools!=50.0"]
 build-backend = "poetry.core.masonry.api"

.templates/extensions/carrier/setup.py

@@ -3,10 +3,10 @@
 from setuptools import setup, find_namespace_packages
 
 setup(
-      name='purplship.[carrier]',
-      version='[version]',
+      name='purplship.[carrier_name]',
+      version='0.0.0-dev',
       license='LGPLv3',
       packages=find_namespace_packages(),
-      install_requires=['purplship', 'carrier.carrier_name'],
+      install_requires=['purplship', 'carrier.[carrier_name]'],
       zip_safe=False,
 )

.templates/tests/carrier/address.py

@@ -24,7 +24,7 @@ def test_create_address_validation_request(self):
         )
 
     def test_validate_address(self):
-        with patch("purplship.mappers.carrier.proxy.http") as mock:
+        with patch("purplship.mappers.[carrier].proxy.http") as mock:
             mock.return_value = "<a></a>"
             purplship.Address.validate(self.AddressValidationRequest).from_(gateway)
 
@@ -34,7 +34,7 @@ def test_validate_address(self):
             )
 
     def test_parse_address_validation_response(self):
-        with patch("purplship.mappers.carrier.proxy.http") as mock:
+        with patch("purplship.mappers.[carrier].proxy.http") as mock:
             mock.return_value = AddressValidationResponseXML
             parsed_response = (
                 purplship.Address.validate(self.AddressValidationRequest)

.templates/tests/carrier/fixture.py

@@ -1,6 +1,6 @@
 import purplship
 
-gateway = purplship.gateway["carrier"].create(
+gateway = purplship.gateway["[carrier]"].create(
     dict(
         # username="user_id",
         # password="password",

.templates/tests/carrier/pickup.py

@@ -36,7 +36,7 @@ def test_create_cancel_pickup_request(self):
         self.assertEqual(request.serialize(), PickupCancelRequestXML)
 
     def test_request_pickup(self):
-        with patch("purplship.mappers.carrier.proxy.http") as mock:
+        with patch("purplship.mappers.[carrier].proxy.http") as mock:
             mock.return_value = "<a></a>"
             purplship.Pickup.schedule(self.PickupRequest).from_(gateway)
 
@@ -46,7 +46,7 @@ def test_request_pickup(self):
             )
 
     def test_modify_pickup(self):
-        with patch("purplship.mappers.carrier.proxy.http") as mocks:
+        with patch("purplship.mappers.[carrier].proxy.http") as mocks:
             mocks.side_effect = [
                 PickupResponseXML,
             ]
@@ -60,7 +60,7 @@ def test_modify_pickup(self):
             )
 
     def test_cancel_pickup(self):
-        with patch("purplship.mappers.carrier.proxy.http") as mock:
+        with patch("purplship.mappers.[carrier].proxy.http") as mock:
             mock.return_value = "<a></a>"
             purplship.Pickup.cancel(self.PickupCancelRequest).from_(gateway)
 
@@ -70,7 +70,7 @@ def test_cancel_pickup(self):
             )
 
     def test_parse_request_pickup_response(self):
-        with patch("purplship.mappers.carrier.proxy.http") as mock:
+        with patch("purplship.mappers.[carrier].proxy.http") as mock:
             mock.return_value = PickupResponseXML
             parsed_response = (
                 purplship.Pickup.schedule(self.PickupRequest).from_(gateway).parse()
@@ -79,7 +79,7 @@ def test_parse_request_pickup_response(self):
             self.assertEqual(DP.to_dict(parsed_response), DP.to_dict(ParsedPickupResponse))
 
     def test_parse_modify_pickup_response(self):
-        with patch("purplship.mappers.carrier.proxy.http") as mocks:
+        with patch("purplship.mappers.[carrier].proxy.http") as mocks:
             mocks.side_effect = [
                 PickupResponseXML,
             ]
@@ -90,7 +90,7 @@ def test_parse_modify_pickup_response(self):
             self.assertEqual(DP.to_dict(parsed_response), DP.to_dict(ParsedPickupResponse))
 
     def test_parse_void_shipment_response(self):
-        with patch("purplship.mappers.carrier.proxy.http") as mock:
+        with patch("purplship.mappers.[carrier].proxy.http") as mock:
             mock.return_value = PickupCancelResponseXML
             parsed_response = (
                 purplship.Pickup.cancel(self.PickupCancelRequest).from_(gateway).parse()

.templates/tests/carrier/rate.py

@@ -17,7 +17,7 @@ def test_create_rate_request(self):
         self.assertEqual(request.serialize(), RateRequestXML)
 
     def test_get_rates(self):
-        with patch("purplship.mappers.carrier.proxy.http") as mock:
+        with patch("purplship.mappers.[carrier].proxy.http") as mock:
             mock.return_value = "<a></a>"
             Rating.fetch(self.RateRequest).from_(gateway)
 
@@ -27,7 +27,7 @@ def test_get_rates(self):
             )
 
     def test_parse_rate_response(self):
-        with patch("purplship.mappers.carrier.proxy.http") as mock:
+        with patch("purplship.mappers.[carrier].proxy.http") as mock:
             mock.return_value = RateResponseXml
             parsed_response = Rating.fetch(self.RateRequest).from_(gateway).parse()