Merge pull request #88 from PurplShip/purplship-2020.12-patch

[patch] Purplship 2020.12 patch

Author: danh91

README.md

@@ -11,7 +11,7 @@
     <a href="https://github.com/Purplship/Purplship/actions"><img src="https://github.com/Purplship/Purplship/workflows/PuprlShip/badge.svg" alt="CI" style="max-width:100%;"></a>
     <a href="https://www.gnu.org/licenses/lgpl-3.0" rel="nofollow"><img src="https://img.shields.io/badge/License-LGPL%20v3-blue.svg" alt="License: AGPL v3" data-canonical-src="https://img.shields.io/badge/License-AGPL%20v3-blue.svg" style="max-width:100%;"></a>
     <a href="https://github.com/python/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black" style="max-width:100%;"></a>
-    <a href="https://codecov.io/gh/Purplship/Purplship"><img src="https://codecov.io/gh/Purplship/Purplship/branch/master/graph/badge.svg" alt="codecov" style="max-width:100%;"></a>
+    <a href="https://codecov.io/gh/Purplship/Purplship"><img src="https://codecov.io/gh/Purplship/Purplship/branch/main/graph/badge.svg" alt="codecov" style="max-width:100%;"></a>
     <a href="https://app.codacy.com/manual/DanH91/Purplship?utm_source=github.com&utm_medium=referral&utm_content=Purplship/Purplship&utm_campaign=Badge_Grade_Dashboard"><img src="https://api.codacy.com/project/badge/Grade/a57baa23a1ca4403a37a8b7134609709" alt="Codacy Badge" style="max-width:100%;"></a>
     <a href="https://gitter.im/Purplship/Purplship?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img src="https://badges.gitter.im/Purplship/purplship.svg" alt="Join the chat at https://gitter.im/Purplship/Purplship" style="max-width:100%;"></a>
   </p>
@@ -36,7 +36,7 @@ With Purplship you can:
 Purplship has two layers
 
 - **Purplship SDK** for an integration as a Python library. *[documentation](#Documentation) bellow*
-- **Purplship Server** for an On-prem or private cloud REST API. *documentation and usage can be found at [docs.purplship.com](https://docs.purplship.com)*
+- **Purplship Server** for an On-prem or cloud REST API. *documentation and usage can be found at [docs.purplship.com](https://docs.purplship.com)*
 
 ## License
 
@@ -446,7 +446,7 @@ rates = request.from_(carrier).parse()
 
 | Name | Type | Description
 | --- | --- | --- |
-| `carrier_name` | `str` | default: carrier name (eg: CanadaPost, Purolator...)
+| `carrier_name` | `str` | default: carrier name (eg: canadapost, purolator...)
 | `id` | `str` | 
 | `test` | `boolean` |
 
@@ -566,7 +566,7 @@ rates = request.from_(carrier).parse()
     | --- | --- | --- |
     | `carrier_name` | `str` | 
     | `carrier_id` | `str` | 
-    | `message` | `str` | 
+    | `message` | Union[str, Any] | 
     | `code` | `str` | 
     | `details` | `dict` | 
 
@@ -710,6 +710,7 @@ rates = request.from_(carrier).parse()
     | `doc_images` | List[[Doc](#Doc)] | 
     | `options` | `dict` | 
     | `reference` | `str` | 
+    | `label_type` | `str` | 
 
 
 - <a name="TrackingDetails"></a> TrackingDetails
@@ -738,7 +739,7 @@ rates = request.from_(carrier).parse()
     | --- | --- | --- |
     | `tracking_numbers` | List[str] | 
     | `language_code` | `str` | 
-    | `level_of_details` | `str` |
+    | `level_of_details` | `str` | 
 
 </details>
 

cli.py

@@ -1,7 +1,7 @@
 import click
 import inspect
 from jinja2 import Template
-from purplship.core.utils import to_dict
+from purplship.core.utils import DP
 
 MODELS_TEMPLATE = Template('''
 {% for name, cls in classes.items() %}
@@ -135,7 +135,7 @@ def generate_shipment_options():
 @cli.command()
 def generate_package_presets():
     preset_mappers = {
-        key: {c.name: to_dict(c.value) for c in list(getattr(mapper['package'], mapper['packagePresets']))}
+        key: {c.name: DP.to_dict(c.value) for c in list(getattr(mapper['package'], mapper['packagePresets']))}
         for key, mapper in PACKAGE_MAPPERS.items()
         if mapper.get('packagePresets') is not None
     }

extensions/boxknight/setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_namespace_packages
 
 setup(name='purplship.boxknight',
-      version='2020.12-alpha',
+      version='2020.12.1-alpha',
       description='Multi-carrier shipping API integration with python',
       url='https://github.com/PurplShip/purplship',
       author='Purplship Team',

extensions/canadapost/purplship/mappers/canadapost/proxy.py

@@ -80,9 +80,9 @@ def _non_contract_shipment(job: Job):
         def _get_label(job: Job):
             label_string = http(
                 decoder=lambda b: base64.encodebytes(b).decode("utf-8"),
-                url=job.data,
+                url=job.data["href"],
                 headers={
-                    "Accept": "application/pdf",
+                    "Accept": job.data["media"],
                     "Authorization": f"Basic {self.settings.authorization}",
                 },
                 method="GET",

extensions/canadapost/purplship/providers/canadapost/rate.py

@@ -13,15 +13,14 @@
     service_standardType,
 )
 from functools import reduce
-from datetime import datetime
 from typing import List, Tuple, cast
 from purplship.core.utils import Serializable, Element, NF, XP
 from purplship.providers.canadapost.utils import Settings
 from purplship.core.units import Country, Currency, Packages, Services, Options
 from purplship.core.errors import OriginNotServicedError
 from purplship.core.models import RateDetails, ChargeDetails, Message, RateRequest
 from purplship.providers.canadapost.error import parse_error_response
-from purplship.providers.canadapost.units import OptionCode, ServiceType, PackagePresets
+from purplship.providers.canadapost.units import OptionCode, ServiceType, PackagePresets, MeasurementOptions
 
 
 def parse_rate_response(
@@ -97,7 +96,7 @@ def rate_request(
         contract_id=None,
         promo_code=None,
         quote_type=None,
-        expected_mailing_date=datetime.today().strftime("%Y-%m-%d"),
+        expected_mailing_date=requested_options.shipment_date,
         options=(
             optionsType(
                 option=[
@@ -108,11 +107,11 @@ def rate_request(
             if any(requested_options) else None
         ),
         parcel_characteristics=parcel_characteristicsType(
-            weight=package.weight.KG,
+            weight=package.weight.map(MeasurementOptions).KG,
             dimensions=dimensionsType(
-                length=package.length.CM,
-                width=package.width.CM,
-                height=package.height.CM,
+                length=package.length.map(MeasurementOptions).CM,
+                width=package.width.map(MeasurementOptions).CM,
+                height=package.height.map(MeasurementOptions).CM,
             ),
             unpackaged=None,
             mailing_tube=None,

extensions/canadapost/purplship/providers/canadapost/shipment/contract.py

@@ -22,7 +22,7 @@
     groupIdOrTransmitShipment,
 )
 from purplship.core.units import Currency, WeightUnit, Options, Packages
-from purplship.core.utils import Serializable, Element, XP, SF
+from purplship.core.utils import Serializable, Element, XP, SF, NF
 from purplship.core.models import (
     Message,
     ShipmentDetails,
@@ -33,9 +33,10 @@
     OptionCode,
     ServiceType,
     PackagePresets,
-    PrinterType,
     PaymentType,
-    INTERNATIONAL_NON_DELIVERY_OPTION
+    LabelType,
+    INTERNATIONAL_NON_DELIVERY_OPTION,
+    MeasurementOptions,
 )
 from purplship.providers.canadapost.utils import Settings
 
@@ -101,6 +102,8 @@ def compute_amount(code: str, _: Any):
     if is_intl and not any(key in special_services for key in INTERNATIONAL_NON_DELIVERY_OPTION):
         special_services['canadapost_return_to_sender'] = OptionCode.canadapost_return_to_sender.value
 
+    label_encoding, label_format = LabelType[payload.label_type or 'PDF_4x6'].value
+
     request = ShipmentType(
         customer_request_id=None,
         groupIdOrTransmitShipment=groupIdOrTransmitShipment(),
@@ -145,11 +148,11 @@ def compute_amount(code: str, _: Any):
                 ),
             ),
             parcel_characteristics=ParcelCharacteristicsType(
-                weight=package.weight.KG,
+                weight=package.weight.map(MeasurementOptions).KG,
                 dimensions=dimensionsType(
-                    length=package.length.CM,
-                    width=package.width.CM,
-                    height=package.height.CM,
+                    length=package.length.map(MeasurementOptions).CM,
+                    width=package.width.map(MeasurementOptions).CM,
+                    height=package.height.map(MeasurementOptions).CM,
                 ),
                 unpackaged=None,
                 mailing_tube=None,
@@ -178,8 +181,8 @@ def compute_amount(code: str, _: Any):
                 if options.notification_email else None
             ),
             print_preferences=PrintPreferencesType(
-                output_format=PrinterType[options.label_printing or "regular"].value,
-                encoding=None,
+                output_format=label_format,
+                encoding=label_encoding,
             ),
             preferences=PreferencesType(
                 service_code=None,

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

@@ -37,8 +37,8 @@ def _create_shipment(payload: ShipmentRequest, settings: Settings) -> Job:
 
 def _get_shipment_label(shipement_response: str) -> Job:
     links = XP.to_xml(shipement_response).xpath(".//*[local-name() = $name]", name="link")
-    label_url = next(
-        (link.get("href") for link in links if link.get("rel") == "label"),
-        None,
+    href, media = next(
+        ((link.get("href"), link.get("media-type")) for link in links if link.get("rel") == "label"),
+        (None, None),
     )
-    return Job(id="shipment_label", data=label_url, fallback="")
+    return Job(id="shipment_label", data=dict(href=href, media=media), fallback="")

extensions/canadapost/purplship/providers/canadapost/shipment/non_contract.py

@@ -19,7 +19,7 @@
     PreferencesType,
 )
 from purplship.core.units import Currency, WeightUnit, Options, Packages
-from purplship.core.utils import Serializable, Element, SF, XP
+from purplship.core.utils import Serializable, Element, SF, XP, NF
 from purplship.core.models import (
     Message,
     ShipmentDetails,
@@ -138,11 +138,11 @@ def compute_amount(code: str, _: Any):
                 if len(special_services) > 0 else None
             ),
             parcel_characteristics=ParcelCharacteristicsType(
-                weight=package.weight.KG,
+                weight=NF.decimal(package.weight.KG, .1),
                 dimensions=dimensionsType(
-                    length=package.length.CM,
-                    width=package.width.CM,
-                    height=package.height.CM,
+                    length=NF.decimal(package.length.CM, .1),
+                    width=NF.decimal(package.width.CM, .1),
+                    height=NF.decimal(package.height.CM, .1),
                 ),
                 unpackaged=None,
                 mailing_tube=None,
@@ -157,7 +157,7 @@ def compute_amount(code: str, _: Any):
                 if options.notification_email is not None else None
             ),
             preferences=PreferencesType(
-                show_packing_instructions=True,
+                show_packing_instructions=False,
                 show_postage_rate=True,
                 show_insured_value=("insurance" in payload.options),
             ),

extensions/canadapost/purplship/providers/canadapost/units.py

@@ -46,14 +46,18 @@ class PackagePresets(Flag):
     )
 
 
-class PrinterType(Enum):
-    regular = "8.5x11"
-    thermal = "4x6"
+class MeasurementOptions(Enum):
+    quant = 0.1
 
 
-class LablelEncoding(Enum):
-    pdf = "PDF"
-    zpl = "ZPL"
+class LabelType(Enum):
+    PDF_4x6 = ("PDF", "4x6")
+    PDF_8_5x11 = ("PDF", "8.5x11")
+    ZPL_4x6 = ("ZPL", "4x6")
+
+    """ Unified Label type mapping """
+    PDF = PDF_4x6
+    ZPL = ZPL_4x6
 
 
 class PaymentType(Flag):

extensions/canadapost/setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="purplship.canadapost",
-    version="2020.12",
+    version="2020.12.1",
     description="Multi-carrier shipping API integration with python",
     url="https://github.com/PurplShip/purplship",
     author="Purplship Team",