Merge pull request #188 from purplship/purplship-2022.2

[release-candidate] Purplship 2022.2

Author: danh91

.env

@@ -10,3 +10,4 @@ DETACHED_WORKER=True
 LOG_DIR=.pship
 WORKER_DB_DIR=.pship
 SECRET_KEY="n*s-ex6@ex_r1i%bk=3jd)p+lsick5bi*90!mbk7rc3iy_op1r"
+OIDC_RSA_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nMIIJKQIBAAKCAgEA92+93Tyg6UvetkT0Li+RtjjeQX7mHMzvOL+HllDTfXAeh9GB\nlrgGrFR5ZTjtrmWiG3ditK3JoJGrVY4B0lFRi7d3nl8gPDR03bALEIfrB0TtiYGB\nTQ92sGBKmlRKAmAhTVXeWK+l5wdj7w8Lcoso3rpLFYSllcoJwDQ5qeP/wzJd0iYr\nyZpasx1huQZcOd/yP7Cvb9LAH8Nwqgk4WCbxHcmUVjUm1A5rNJYKCKM5uC6JvMGb\nm2mR/81SoPgU4qaW/v+L5chJoxnl7vWazKSjWcn2HkZIGshPFqpQpobIZhngC5/A\nXlXntf5CpYcauWPT3qvNJZxxJUPzziwyYFknxE72iURCSBNnGLYqDEjIHplFeTdU\nB40dsE7ThEeVNp7oM6vJY79ieTw7PFExHp8nufZQCV3KRO+r9iUXMHw2G4bUE2mS\nluPl+MHMrA/XZXmK+Ufz6g676GYYv7yfykSFrF4YHyCMKgA//irnYxhpBl4L3Lwu\nvBXmgUWzPIgwLrTS6Qik863PLDNCK5XgL/no2iNgNsTpDkeTdZ4atTOS91EdzvYf\n5WUr8P/l9C8H/1DIXbFsKLtsDv4B/Z/6NqE1qbvmp2S5nv+t66cHlYFLkvUlHpXp\n/GUo8LroaHduJjfsCE+9fJEgjyT5dOZT4NxOYnKKzjbM/V68uIk74DwmhO8CAwEA\nAQKCAgEAxljdsxZhywIVori9oLRjMtZ9W7VU0yt4bF4kW1upXTleT/Oi1OXp+4Sv\n13N+HDm+bBQUnM9e/Ico+Ckgzq5/FufYTKzmkzxdnkP7aqH5xlb7rymQM+y8cQCP\nbQ06UpMqvuqhlSggboUfF8hQnd5twbVGcRZnAh72GAwFWWm6YYfja41Lto00PbbE\n2mP91Crv7xw8VgB0IEIz8yn277svt3gan8x1trFkQMAxhOELaNhtc1Ej4r4K2iqG\nHSEg5Nsz2W+Sfn1CgitFhXt+PqOPim96CqS+MjH2LC4U/pi21hnR3p+NvlFQsDQE\nytn1kz0x3qKLjaXNkVjafKAzNcbiN0itB3kceHOkkw5Ve5AlzlpxSS13e1nOBLo7\n+EnghTJ2TUghbBfVJxOPs1gCeqpD7HXHW+7nSMvDlv2Br69u+6vWiZkBIyENRmez\nLD7/g+LmJcKzBoZy6+sAyzGchMSqK/lmX03NdWntCpg6HCwFd68+Lfcu45tCJ9on\nBP/i5sN09Hxuth/sVLBchK3ePwJpCVpEmq/QHUZaqwWaHMiz8lX93ijtu9Xy9u0y\nq7KapRLNKlqhvjzXnYjFXc8g/s3Qw48sYaNaBNMqmmJfNy6AfM5MplSqU4BhimUm\nuLBDdAnNvghI8dFnsJ+odqPDXwlGkZf6k/jTiwI06BC2QiC1z6ECggEBAP1lZZO4\ns2jx2+sAiA5wFVElCS9GoWIoQsjoL6SX/AMoClu9qN2MEtxgkXDqBMkkvrRVJG9b\nd6xH3YkL6eoW34551lc702iWus4AVa3WI+8gjxWCBHzsCvtR8XPpiZuqLQEVuU1j\nBr/jZ2NfSxEDiALcyC07tmSTDVmZxhqMpAWFkP+8E1RjNwQ5Dci271SMjOKgGBVy\nqgblEEr8zW2V3kdiqGlQt9HxEbgja9vPSIWWjzkz4nwoR7TGbcNqvkUz8ZrM0GB7\nzwawh/FK0OzK0jHfo3tzJ7Ei0jlzJAvvR1YJft3YAQQ/ij0gd8AJxi7dZTv6IjnT\nvueZ5iKNClsRi1ECggEBAPn6qsgPNCvamxrfAn4UsxLFDqRdBNvPgkVYMcgBReso\nXFmKLUhyInsrCFIvAXy1DgKguMz9H1aFMcDik2+dCxmq86w5DDlaMHRUNv2R4q/V\nt/rNRKhpFoEEofouVap8OneFd3qJo/BmPCB0WgSDcHICafW16qRrMXkr+CQ+Oake\nptGSU0jHRNGgC7xL11zik6uaw5zqwc0V6O1JSsrfZuNwQLMBAUgYVViVT+eik01K\ni7JZQo4yiAJP9k7RN1m0NBtj4Bxb/BsfZ6H8AtfRwl80DVp7UCudjUJpUJF3ARWU\nAV9sVz2FSTBBFUx7yOqHzguW/gWt1gZbaPeVStM6fD8CggEAKKD1ZHYc7hq5dDil\nmAsIn/YcPuRIRADIlIYF/ZIQ6kClSIhkZwFqlMM3Dq+3DLlDio6MRP6ZdZogPzUV\n0F7SgXmvkFUbVI22bglHs5O+Nz01M/Gg3pbKO/mriTZMxhTHGoFtMKdMEcBYd2p0\nEspKKItV3UrRt9aMMW2igedC9U+xLA/v2Xv++kJbn28VeK0AeeXJdsbn1CsuLZfT\nKFr7RN7gueIjVxocCTZEuP3HVwQI+tcC3X1n4ehe+RJIZ7goaPWmA5JWY3Aym9Gv\nJghvI2gEQmr4VkKLCoMXqII5IeZr3Q4hO5kkhSCLktL+X81HyhIVIsh8t43JhIiw\nvGFXwQKCAQB8hL1vPAuL0K+0OePe8+ajcd8yRld2Oq40ZpMdgmzWj1s5Ctg1nwzH\n946EiX+fI/zfmDmVenySt3QqFXLFhR+TYJFSd3Q8WU2LlKtzsaiOV9H2LyuFDBu2\nlp0spsnrS0hAYw45zrgHtpU6wVpZpzNqxwMK7tv7nJ2fMyS+wPQt5uPHvrCXrxL7\nrFJMMCcN0JsoPsYzsshopQJKuFh2J8PzhOXlhJmj1OMmZfHQey4OsRRW+ZlqhYc0\nR6p0ZkjA+T9/aUeoOLWiuQkBKiwsXwMIM0B3krdDko5bx2PnobS7j+cDJk9qiKsF\nS1YVrA9Pq+gZ49OS9p2Gux/VO9tyzk43AoIBAQCxl3RcyaE0JWVByVhaA4Ej+zr4\nlD4UcJsjxPkW5a2k8d3xa63IDBU2yehZNGwQmmc1Y/DoQNMiO+Zagj4gawUWZRcf\nO6YSEHNhPzKMLIxFxpAXYTEcdpwgQ+eWrLP5EvAT2qyqC9Y1CnY6lyT8tLuZkrxv\nGc41na1aSr0FF2EIEzcDgxYWDSvfx2G/k23t7qIcLxYcyFhyvIyCN0JrtvcBB7zy\nALTL9QubmLGZaN+igOfDImdvDVO/BV4GV74OiGFJu1pAStiNmkmlK2J+wI9n3iHT\n3/1coqkpWG7gBcA/Exhh4oDjoaKEE00nPJ1m5Q0a65eb4kG4n2bx116hdZb4\n-----END RSA PRIVATE KEY-----"

README.md

@@ -6,20 +6,19 @@
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/cc2ac4fcb6004bca84e42a90d8acfe41)](https://www.codacy.com/gh/purplship/purplship/dashboard?utm_source=github.com&utm_medium=referral&utm_content=purplship/purplship&utm_campaign=Badge_Grade)
 
-
 purplship makes shipping services simple and accessible.
 Help us out… If you love open source and great software, give us a star! 🌟
 
 **Features**
 
-- **Headless Shipping**: Access a network of traditional and modern shipping carrier services
+- **Headless Shipping**: Access a network of traditional and modern shipping carrier API-first
 - **Multi-carrier SDK**: Integrate purplship once and connect to multiple shipping carrier APIs
 - **Extensible**: Use the purplship SDK Framework to integrate with custom carrier APIs.
 - **Shipping**: Connect carrier accounts, get live rates and purchase shipping labels.
 - **Tracking**: Create package tracker, get real time tracking status and provide a branded tracking page.
 - **Address Validation**: Validate shipping addresses using integrated 3rd party APIs.
 - **Cloud**: Optimized for deployments using Docker.
-- **Dashboard**: Use the [purplship dashboard](https://github.com/purplship/purplship-dashboard) to orchestrate your logistics automation.
+- **Dashboard**: Use the [purplship dashboard](https://github.com/purplship/purplship-dashboard) to orchestrate your logistics operations.
 
 <picture><img alt="Purplship Dashboard" src="./screenshots/dashboard.png" /></picture>
 
@@ -37,10 +36,10 @@ There are several ways to use Purplship:
 
 - [x] Alpha: We are testing purplship with a closed set of customers
 - [x] Public Alpha: Anyone can sign up over at [cloud.purplship.com](cloud.purplship.com). But go easy on us, there are a few kinks
-- [ ] Public Beta: Stable enough for most non-enterprise use-cases
+- [x] Public Beta: Stable enough for most non-enterprise use-cases
 - [ ] Public: Production-ready
 
-We are currently in Public Alpha. Watch "releases" of this repo to get notified of major updates.
+We are currently in Public Beta. Watch "releases" of this repo to get notified of major updates.
 
 ## Self-hosted installation
 
@@ -71,7 +70,7 @@ docker run -d \
   -e ADMIN_EMAIL=admin@example.com \
   -e ADMIN_PASSWORD=demo \
   --link=db:db -p 5002:5002 \
-  danh91.docker.scarf.sh/purplship/server:2022.1.4
+  danh91.docker.scarf.sh/purplship/server:2022.2
 ```
 
 </details>
@@ -96,7 +95,7 @@ services:
       - db_network
 
   pship:
-    image: danh91.docker.scarf.sh/purplship/server:2022.1.4
+    image: danh91.docker.scarf.sh/purplship/server:2022.2
     restart: unless-stopped
     environment:
       - DEBUG_MODE=True
@@ -130,7 +129,7 @@ docker-compose up
 
 </details>
 
-Purplship should now be running at http://localhost:5002
+Purplship should now be running at <http://localhost:5002>
 
 **Default Login**
 
@@ -144,7 +143,6 @@ Purplship should now be running at http://localhost:5002
 - [PHP](https://github.com/purplship/purplship-php-client)
 - [Python](https://github.com/purplship/purplship-python-client)
 
-
 ## Purplship SDK
 
 ### Installation

insiders/sdk/addons/purplship/addons/label.py

@@ -58,7 +58,7 @@ def generate_label(
 
     <line x1="450" y1="20" x2="450" y2="270" stroke="black" stroke-width="3" />
 
-    <text x="470" y="60" fill="black" style="font-size: 50; font-weight: bold">CARR: {{ carrier.get('verbose_name', "").upper() }}</text>
+    <text x="470" y="60" fill="black" style="font-size: 50; font-weight: bold">CARR: {{ carrier.get('display_name', "").upper() }}</text>
     <text x="470" y="140" fill="black" style="font-size: 45; font-weight: bold">PRO#: {{ metadata.get('RFF_CN', '') }}</text>
     <text x="470" y="220" fill="black" style="font-size: 45; font-weight: bold">BOL#: {{ metadata.get('BGM', '') }}</text>
 
@@ -114,10 +114,10 @@ def generate_label(
 
     <text x="100" y="1300" fill="black" style="font-size: 35; font-weight: bold">(00) SERIAL SHIPPING CONTAINER</text>
 
-    <text data-type="barcode-text" x="90" y="1360" fill="black" style="font-size: 45">({{ carrier['metadata'].get('APP_ID', '00') }}){{ carrier['metadata'].get('SERIAL') }}{{ tracking_number[:6] }}5</text>
-    <g data-type="barcode" data-value="({{ carrier['metadata'].get('APP_ID', '00') }}){{ carrier['metadata'].get('SERIAL') }}{{ tracking_number[:6] }}5"
+    <text data-type="barcode-text" x="90" y="1360" fill="black" style="font-size: 45">({{ carrier['metadata'].get('APP_ID', '00') }}){{ carrier['metadata'].get('EXTENSION_DIGIT', '0') }}{{ carrier['metadata'].get('GS1_PREFIX', '0000000000') }}{{ tracking_number[-6:] }}{{ carrier['metadata'].get('CHECK_DIGIT', 5) }}</text>
+    <g data-type="barcode" data-value="({{ carrier['metadata'].get('APP_ID', '00') }}){{ carrier['metadata'].get('EXTENSION_DIGIT', '0') }}{{ carrier['metadata'].get('GS1_PREFIX', '0000000000') }}{{ tracking_number[-6:] }}{{ carrier['metadata'].get('CHECK_DIGIT', 5) }}"
         data-module-width="5" data-width-ratio="3" x="60" y="1410" width="900" height="250" style="font-size: 65;">
-        <text x="80" y="1380" fill="black" style="font-size: 60; font-weight: bold">({{ carrier['metadata'].get('APP_ID', '00') }}){{ carrier['metadata'].get('SERIAL') }}{{ tracking_number[:6] }}5</text>
+        <text x="80" y="1380" fill="black" style="font-size: 60; font-weight: bold">({{ carrier['metadata'].get('APP_ID', '00') }}){{ carrier['metadata'].get('EXTENSION_DIGIT', '0') }}{{ carrier['metadata'].get('GS1_PREFIX', '0000000000') }}{{ tracking_number[-6:] }}{{ carrier['metadata'].get('CHECK_DIGIT', 5) }}</text>
         <rect x="60" y="1400" width="750" height="200" fill="transparent" stroke="black"></rect>
     </g>
 
@@ -147,7 +147,7 @@ def generate_label(
 
 ^FX Top Right section.
 ^CF0,50
-^FO540,30^FDCARR: {{ carrier.get('verbose_name', '').upper() }}^FS
+^FO540,30^FDCARR: {{ carrier.get('display_name', '').upper() }}^FS
 ^CF0,45
 ^FO540,120^FDPRO#: {{ metadata.get('RFF_CN', '') }}^FS
 ^FO540,200^FDBOL#: {{ metadata.get('BGM', '') }}^FS
@@ -205,9 +205,9 @@ def generate_label(
 ^FO100,1280^FD(00) SERIAL SHIPPING CONTAINER^FS
 
 ^CFA,45
-^FO80,1360^FD({{ carrier['metadata'].get('APP_ID', '00') }}){{ carrier['metadata'].get('SERIAL') }}{{ tracking_number[:6] }}5^FS
+^FO80,1360^FD({{ carrier['metadata'].get('APP_ID', '00') }}){{ carrier['metadata'].get('EXTENSION_DIGIT', '0') }}{{ carrier['metadata'].get('GS1_PREFIX', '0000000000') }}{{ tracking_number[-6:] }}{{ carrier['metadata'].get('CHECK_DIGIT', 5) }}^FS
 ^BY5,3,200
-^FO60,1410^BCN,250,N,Y,Y,D^FD({{ carrier['metadata'].get('APP_ID', '00') }}){{ carrier['metadata'].get('SERIAL') }}{{ tracking_number[:6] }}5^FS
+^FO60,1410^BCN,250,N,Y,Y,D^FD({{ carrier['metadata'].get('APP_ID', '00') }}){{ carrier['metadata'].get('EXTENSION_DIGIT', '0') }}{{ carrier['metadata'].get('GS1_PREFIX', '0000000000') }}{{ tracking_number[-6:] }}{{ carrier['metadata'].get('CHECK_DIGIT', 5) }}^FS
 
 ^CF0,30
 ^FO760,1720^FDxxxxxxxxxxxxxxxxxxxxxxxxx^FS

insiders/sdk/addons/purplship/universal/providers/shipping/shipment.py

@@ -1,6 +1,7 @@
 from typing import Tuple, List
 from purplship.core.utils import Serializable
 from purplship.core.models import (
+    Documents,
     ShipmentRequest,
     ShipmentDetails,
     Message,
@@ -31,11 +32,11 @@ def _extract_details(
     return ShipmentDetails(
         carrier_name=settings.custom_carrier_name,
         carrier_id=settings.carrier_id,
-        label=service_label.label,
         label_type=service_label.label_type,
         tracking_number=service_label.tracking_number,
         shipment_identifier=service_label.tracking_number,
         meta=dict(service_name=service_label.service_name),
+        docs=Documents(label=service_label.label),
     )
 
 

insiders/sdk/addons/purplship/universal/providers/shipping/utils.py

@@ -11,7 +11,7 @@
 class ShippingMixinSettings(BaseSettings):
     """Universal shipping mixin settings."""
 
-    verbose_name: str = "Custom Carrier"
+    display_name: str = "Custom Carrier"
     custom_carrier_name: str = "custom_carrier"
 
     # Additional properties

insiders/sdk/addons/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "purplship.addons"
-version = "2022.1"
+version = "2022.2"
 homepage="https://next.purplship.com/docs/guides/sdk"
 repository="https://github.com/purplship/purplship"
 description = "Multi-carrier shipping API integration with python"

insiders/sdk/addons/tests/addons/universal_shipment.py

@@ -79,7 +79,12 @@ def test_multi_piece_shipment_request(self):
             "international": False,
         },
     ],
-    "metadata": {"APP_ID": "00", "SERIAL": "00099999000"},
+    "metadata": {
+        "APP_ID": "00",
+        "EXTENSION_DIGIT": "0",
+        "GS1_PREFIX": "0099999000",
+        "CHECK_DIGIT": "5",
+    },
 }
 
 shipment_request_data = {
@@ -140,10 +145,10 @@ def test_multi_piece_shipment_request(self):
     {
         "carrier_id": "custom-carrier",
         "carrier_name": "custom_carrier",
-        "label": ANY,
         "label_type": "ZPL",
         "shipment_identifier": ANY,
         "tracking_number": ANY,
+        "docs": {"label": ANY},
         "meta": {
             "service_name": "Premium",
         },
@@ -155,8 +160,8 @@ def test_multi_piece_shipment_request(self):
     {
         "carrier_id": "custom-carrier",
         "carrier_name": "custom_carrier",
-        "label": ANY,
         "label_type": "PDF",
+        "docs": {"label": ANY},
         "meta": {
             "service_name": "Premium",
             "tracking_identifiers": ANY,

insiders/sdk/generic/purplship/mappers/generic/settings.py

@@ -14,12 +14,13 @@
 class Settings(BaseSettings, RatingMixinSettings, ShippingMixinSettings):
     """Generic connection settings."""
 
-    verbose_name: str
+    display_name: str
     custom_carrier_name: str
 
     id: str = None
     test: bool = False
     carrier_id: str = "custom-carrier"
+    account_number: str = None
     account_country_code: str = None
     metadata: dict = {}
 

insiders/sdk/generic/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "purplship.generic"
-version = "2022.1"
+version = "2022.2"
 homepage="https://next.purplship.com/docs/guides/sdk"
 repository="https://github.com/purplship/purplship"
 description = "Purplship - Generic Shipping Extension"

insiders/sdk/generic/tests/generic/fixture.py

@@ -4,7 +4,7 @@
     {
         "carrier_id": "custom-carrier",
         "custom_carrier_name": "custom_carrier",
-        "verbose_name": "Custom Carrier",
+        "display_name": "Custom Carrier",
         "services": [
             dict(
                 service_name="Standard Service",
@@ -13,6 +13,11 @@
                 currency="USD",
             )
         ],
-        "metadata": {"APP_ID": "00", "SERIAL": "00099999000"},
+        "metadata": {
+            "APP_ID": "00",
+            "EXTENSION_DIGIT": "0",
+            "GS1_PREFIX": "0099999000",
+            "CHECK_DIGIT": "5",
+        },
     }
 )