Merge pull request #56 from PurplShip/document-release-2020.4

Document release 2020.4

Author: danh91

LICENSE

@@ -1,8 +1,174 @@
 Copyright (c) Contributed Systems LLC
 
-PurplShip is an Open Source project licensed under the terms of the LGPLv3 license.
-Please see <http://www.gnu.org/licenses/lgpl-3.0.html> for license text.
+PurplShip is an Open Source project licensed under the terms of the LGPLv3 license as included below.
 
-PurplShip Pro has a commercial-friendly license allowing private forks
-and modifications of PurplShip.
+PurplShip Pro has a commercial-friendly license allowing private forks and modifications of PurplShip.
 Please talk to us at https://purplship.com for more details.
+
+_____________________________________________________________________________
+
+                GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.md

@@ -1,4 +1,4 @@
-# PurplShip (Multi-carrier API SDK)
+# PurplShip (Multi-carrier API Library)
 
 ![PuprlShip Core Package](https://github.com/PurplShip/purplship/workflows/PuprlShip%20Core%20Package/badge.svg)
 [![codecov](https://codecov.io/gh/PurplShip/purplship/branch/master/graph/badge.svg)](https://codecov.io/gh/PurplShip/purplship)

purplship/carriers/australiapost/shipping/shipping_price.py

@@ -77,7 +77,7 @@ def shipping_price_request(payload: RateRequest) -> Serializable[ShippingPriceRe
     request = ShippingPriceRequest(
         shipments=[
             Shipment(
-                shipment_reference=payload.parcel.reference,
+                shipment_reference=payload.reference,
                 sender_references=None,
                 goods_descriptions=None,
                 despatch_date=None,
@@ -119,7 +119,7 @@ def shipping_price_request(payload: RateRequest) -> Serializable[ShippingPriceRe
                 authorisation_number=None,
                 items=[
                     Item(
-                        item_reference=payload.parcel.reference,
+                        item_reference=payload.reference,
                         product_id=payload.parcel.id,
                         item_description=payload.parcel.description,
                         length=payload.parcel.length,

purplship/carriers/canadapost/shipment/__init__.py

@@ -1,6 +1,7 @@
+from functools import partial
 from typing import Tuple, List
-from purplship.core.utils.xml import Element
-from purplship.core.utils.serializable import Serializable
+from purplship.core.utils import Element, to_xml, Serializable
+from purplship.core.utils.pipeline import Pipeline, Job
 from purplship.core.models import ShipmentRequest, ShipmentDetails, Message
 from purplship.carriers.canadapost.utils import Settings
 from purplship.carriers.canadapost.shipment.contract_shipment import (
@@ -21,9 +22,27 @@ def parse_shipment_response(
     return parse_contract_shipment_response(response, settings)
 
 
-def shipment_request(
-    payload: ShipmentRequest, settings: Settings
-) -> Serializable[Element]:
-    if settings.contract_id is None or settings.contract_id == "":
-        return non_contract_shipment_request(payload, settings)
-    return contract_shipment_request(payload, settings)
+def shipment_request(payload: ShipmentRequest, settings: Settings) -> Serializable[Pipeline]:
+    requests: Pipeline = Pipeline(
+        create_shipment=lambda *_: partial(_create_shipment, payload=payload, settings=settings)(),
+        retrieve_label=partial(_get_shipment_label),
+    )
+    return Serializable(requests)
+
+
+def _create_shipment(payload: ShipmentRequest, settings: Settings) -> Job:
+    no_contract = settings.contract_id is None or settings.contract_id == ""
+    create_shipment = (non_contract_shipment_request if no_contract else contract_shipment_request)
+    return Job(
+        id="non_contract_shipment" if no_contract else "contract_shipment",
+        data=create_shipment(payload, settings)
+    )
+
+
+def _get_shipment_label(shipement_response: str) -> Job:
+    links = 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,
+    )
+    return Job(id="shipment_label", data=label_url, fallback="")

purplship/carriers/canadapost/shipment/contract_shipment.py

@@ -216,7 +216,7 @@ def compute_amount(code: str, _: Any):
             else None,
             references=ReferencesType(
                 cost_centre=None,
-                customer_ref_1=payload.parcel.reference,
+                customer_ref_1=payload.reference,
                 customer_ref_2=None,
             ),
             settlement_info=SettlementInfoType(

purplship/carriers/canadapost/shipment/non_contract_shipment.py

@@ -4,7 +4,6 @@
     OptionCode,
     ServiceType,
     PackagePresets,
-    PaymentType,
 )
 from purplship.carriers.canadapost.utils import Settings
 from purplship.core.models import (
@@ -20,7 +19,7 @@
     NonContractShipmentInfoType,
     DeliverySpecType,
     SenderType,
-    AddressDetailsType,
+    DomesticAddressDetailsType,
     DestinationType,
     DestinationAddressDetailsType,
     ParcelCharacteristicsType,
@@ -33,7 +32,6 @@
     OptionType,
     CustomsType,
     PreferencesType,
-    SettlementInfoType,
 )
 
 
@@ -65,9 +63,7 @@ def _extract_shipment(response: Element, settings: Settings) -> ShipmentDetails:
     )
 
 
-def non_contract_shipment_request(
-    payload: ShipmentRequest, settings: Settings
-) -> Serializable[NonContractShipmentType]:
+def non_contract_shipment_request(payload: ShipmentRequest, settings: Settings) -> Serializable[NonContractShipmentType]:
     parcel_preset = (
         PackagePresets[payload.parcel.package_preset].value
         if payload.parcel.package_preset
@@ -93,11 +89,6 @@ def compute_amount(code: str, _: Any):
         for name, value in payload.options.items()
         if name in OptionCode.__members__
     }
-    payment_type = (
-        PaymentType[payload.payment.paid_by].value
-        if payload.payment is not None
-        else None
-    )
 
     request = NonContractShipmentType(
         requested_shipping_point=None,
@@ -107,12 +98,11 @@ def compute_amount(code: str, _: Any):
                 name=payload.shipper.person_name,
                 company=payload.shipper.company_name,
                 contact_phone=payload.shipper.phone_number,
-                address_details=AddressDetailsType(
+                address_details=DomesticAddressDetailsType(
                     address_line_1=concat_str(payload.shipper.address_line1, join=True),
                     address_line_2=concat_str(payload.shipper.address_line2, join=True),
                     city=payload.shipper.city,
                     prov_state=payload.shipper.state_code,
-                    country_code=payload.shipper.country_code,
                     postal_zip_code=payload.shipper.postal_code,
                 ),
             ),
@@ -166,14 +156,13 @@ def compute_amount(code: str, _: Any):
             if options.notification
             else None,
             preferences=PreferencesType(
-                service_code=None,
                 show_packing_instructions=True,
                 show_postage_rate=True,
-                show_insured_value=True,
+                show_insured_value=("insurance" in payload.options)
             ),
             references=ReferencesType(
                 cost_centre=None,
-                customer_ref_1=payload.parcel.reference,
+                customer_ref_1=payload.reference,
                 customer_ref_2=None,
             ),
             customs=CustomsType(
@@ -204,17 +193,7 @@ def compute_amount(code: str, _: Any):
             )
             if payload.customs is not None
             else None,
-            settlement_info=SettlementInfoType(
-                paid_by_customer=(
-                    payload.payment.account_number
-                    if payload.payment is not None
-                    else settings.customer_number
-                ),
-                contract_id=settings.contract_id,
-                cif_shipment=None,
-                intended_method_of_payment=payment_type,
-                promo_code=None,
-            ),
+            settlement_info=None,
         ),
     )
     return Serializable(request, _request_serializer)
@@ -223,6 +202,6 @@ def compute_amount(code: str, _: Any):
 def _request_serializer(request: NonContractShipmentType) -> str:
     return export(
         request,
-        name_="shipment",
-        namespacedef_="xmlns=”http://www.canadapost.ca/ws/shipment-v8”",
+        name_="non-contract-shipment",
+        namespacedef_='xmlns="http://www.canadapost.ca/ws/ncshipment-v4"',
     )

purplship/carriers/canadapost/units.py

@@ -30,16 +30,16 @@ class PackagePresets(Flag):
         width=46.0, height=46.0, length=40.6
     )
     canadapost_xexpresspost_certified_envelope = PackagePreset(
-        width=26.0, height=15.9, weight=0.5, thickness=1.5
+        width=26.0, height=15.9, weight=0.5, length=1.5
     )
     canadapost_xexpresspost_national_large_envelope = PackagePreset(
-        width=40.0, height=29.2, weight=1.36, thickness=1.5
+        width=40.0, height=29.2, weight=1.36, length=1.5
     )
     canadapost_xexpresspost_regional_small_envelope = PackagePreset(
-        width=26.0, height=15.9, weight=0.5, thickness=1.5
+        width=26.0, height=15.9, weight=0.5, length=1.5
     )
     canadapost_xexpresspost_regional_large_envelope = PackagePreset(
-        width=40.0, height=29.2, weight=1.36, thickness=1.5
+        width=40.0, height=29.2, weight=1.36, length=1.5
     )