Feat/add ninja van carrier integration by backendArchitect · Pull Request #596 · karrioapi/karrio

backendArchitect · 2024-05-29T06:07:05Z

Changes

Feat:

Add NinjaVan Integration

danh91

The general idea is that while the bootstrap command creates the plugin file structure.

You need to navigate through the files to setup the data and implementation specific to the NinjaVan API operations and logic

danh91 · 2024-05-29T15:54:01Z

modules/connectors/ninja_van/generate

+quicktype --src="${SCHEMAS}/error_response.json" --out="${LIB_MODULES}/error_response.py"
+quicktype --src="${SCHEMAS}/paperless_request.json" --out="${LIB_MODULES}/paperless_request.py"
+quicktype --src="${SCHEMAS}/paperless_response.json" --out="${LIB_MODULES}/paperless_response.py"
+quicktype --src="${SCHEMAS}/rating_request.json" --out="${LIB_MODULES}/rating_request.py"
+quicktype --src="${SCHEMAS}/rating_response.json" --out="${LIB_MODULES}/rating_response.py"
+quicktype --src="${SCHEMAS}/shipping_request.json" --out="${LIB_MODULES}/shipping_request.py"
+quicktype --src="${SCHEMAS}/shipping_response.json" --out="${LIB_MODULES}/shipping_response.py"
+quicktype --src="${SCHEMAS}/tracking_request.json" --out="${LIB_MODULES}/tracking_request.py"
+quicktype --src="${SCHEMAS}/tracking_response.json" --out="${LIB_MODULES}/tracking_response.py"
+quicktype --src="${SCHEMAS}/cancel_request.json" --out="${LIB_MODULES}/cancel_request.py"
+quicktype --src="${SCHEMAS}/cancel_response.json" --out="${LIB_MODULES}/cancel_response.py"


The JSON files referenced here need to be from the NinjaVan API.
https://api-docs.ninjavan.co/en

danh91 · 2024-05-29T15:59:05Z

modules/connectors/ninja_van/karrio/mappers/ninja_van/proxy.py

+
+    def get_rates(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        response = lib.request(
+            url=f"{self.settings.server_url}/service",


Suggested change

url=f"{self.settings.server_url}/service",

url=f"{self.settings.server_url}/1.0/public/price",

This and all the subsequent API requests needs to be based on the corresponding operation from the NinjaVan API.

By example, this one is the Tariff API

danh91 · 2024-05-29T16:01:30Z

modules/connectors/ninja_van/karrio/mappers/ninja_van/proxy.py

+
+    def create_shipment(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        response = lib.request(
+            url=f"{self.settings.server_url}/service",


Similarly, this one needs to be updated to reflect the Order API

Suggested change

url=f"{self.settings.server_url}/service",

url=f"{self.settings.server_url}/4.2/orders",

danh91 · 2024-05-29T16:01:43Z

modules/connectors/ninja_van/karrio/mappers/ninja_van/proxy.py

+
+    def cancel_shipment(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        response = lib.request(
+            url=f"{self.settings.server_url}/service",


danh91 · 2024-05-29T16:01:58Z

modules/connectors/ninja_van/karrio/mappers/ninja_van/proxy.py

+
+    def get_tracking(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        response = lib.request(
+            url=f"{self.settings.server_url}/service",


And this one for tracking

danh91 · 2024-05-29T16:32:58Z

modules/connectors/ninja_van/tests/ninja_van/fixture.py

+gateway = karrio.gateway["ninja_van"].create(
+    dict(
+        # add required carrier API setting key/value here
+    )
+)


Suggested change

gateway = karrio.gateway["ninja_van"].create(

dict(

# add required carrier API setting key/value here

)

)

gateway = karrio.gateway["ninja_van"].create(

dict(

client_id="client_id",

client_secret="client_secret",

)

)

danh91 · 2024-05-29T16:34:35Z

modules/connectors/ninja_van/tests/ninja_van/test_rate.py

+ParsedRateResponse = []
+
+
+RateRequest = {}
+
+RateResponse = """{}
+"""


For the tests, you want to run them and ensure that essentially when a request is created, you get the right output data that needs to be sent to NinjaVan

Sendle is a good example here https://github.com/karrioapi/karrio/blob/main/modules/connectors/sendle/tests/sendle/test_rate.py

danh91 · 2024-05-29T16:34:57Z

modules/connectors/ninja_van/tests/ninja_van/test_shipment.py

+ShipmentCancelPayload = {
+    "shipment_identifier": "794947717776",
+}
+
+ParsedShipmentResponse = []
+
+ParsedCancelShipmentResponse = []
+
+
+ShipmentRequest = {}
+
+ShipmentCancelRequest = {}
+
+ShipmentResponse = """{}
+"""
+
+ShipmentCancelResponse = """{}
+"""


Same comment about the tests above

danh91 · 2024-05-29T16:35:15Z

modules/connectors/ninja_van/tests/ninja_van/test_tracking.py

+ParsedTrackingResponse = []
+
+ParsedErrorResponse = []
+
+
+TrackingRequest = {}
+
+TrackingResponse = """{}
+"""
+
+ErrorResponse = """{}
+"""


danh91 · 2024-05-29T16:36:07Z

modules/core/karrio/server/providers/extensions/ninja_van.py

+   api_key = models.CharField(max_length=100, blank=True, null=True)
+   secret_key = models.CharField(max_length=100, blank=True, null=True)
+   track_api_key = models.CharField(max_length=100, blank=True, null=True)
+   track_secret_key = models.CharField(max_length=100, blank=True, null=True)
+   account_number = models.CharField(max_length=50, blank=True, null=True)
+   account_country_code = models.CharField(
+       max_length=3, blank=True, null=True, choices=providers.COUNTRIES
+   )


You need to replace these the the client_id and client_secret that NinjaVan support

backendArchitect · 2024-05-30T02:19:13Z

ThankYou so much @danh91 for detailed review and guide
I'll update it and let you know

backendArchitect · 2024-06-07T11:44:53Z

Hello @danh91
I'm having trouble in generating migration file can you please help me with that ??

# Generated by Django 4.2.11 on 2024-06-07 11:53

from django.db import migrations, models
import django.db.models.deletion


class Migration(migrations.Migration):

    dependencies = [
        ("providers", "0072_rename_eshippersettings_eshipperxmlsettings_and_more"),
    ]

    operations = [
        migrations.CreateModel(
            name="NinjaVanSettings",
            fields=[
                (
                    "carrier_ptr",
                    models.OneToOneField(
                        auto_created=True,
                        on_delete=django.db.models.deletion.CASCADE,
                        parent_link=True,
                        primary_key=True,
                        serialize=False,
                        to="providers.carrier",
                    ),
                ),
                ("client_id", models.CharField(max_length=255)),
                ("client_secret", models.CharField(max_length=255)),
                (
                    "grant_type",
                    models.CharField(default="client_credentials", max_length=255),
                ),
            ],
            options={
                "verbose_name": "NinjaVan Settings",
                "verbose_name_plural": "NinjaVan Settings",
                "db_table": "ninjavan_settings",
            },
            bases=("providers.carrier",),
        ),
    ]

I wrote mannual migration

danh91 · 2024-06-07T12:11:33Z

Hello @danh91

I'm having trouble in generating migration file can you please help me with that ??


# Generated by Django 4.2.11 on 2024-06-07 11:53



from django.db import migrations, models

import django.db.models.deletion





class Migration(migrations.Migration):



    dependencies = [

        ("providers", "0072_rename_eshippersettings_eshipperxmlsettings_and_more"),

    ]



    operations = [

        migrations.CreateModel(

            name="NinjaVanSettings",

            fields=[

                (

                    "carrier_ptr",

                    models.OneToOneField(

                        auto_created=True,

                        on_delete=django.db.models.deletion.CASCADE,

                        parent_link=True,

                        primary_key=True,

                        serialize=False,

                        to="providers.carrier",

                    ),

                ),

                ("client_id", models.CharField(max_length=255)),

                ("client_secret", models.CharField(max_length=255)),

                (

                    "grant_type",

                    models.CharField(default="client_credentials", max_length=255),

                ),

            ],

            options={

                "verbose_name": "NinjaVan Settings",

                "verbose_name_plural": "NinjaVan Settings",

                "db_table": "ninjavan_settings",

            },

            bases=("providers.carrier",),

        ),

    ]

I wrote mannual migration

Can you share more details?
What command did you run? Did you get any errors?
Is there any error logs you can share?

backendArchitect added 3 commits May 29, 2024 10:50

feat: Add Ninja Van connector files and tests

14feaf9

feat: Add Ninja Van connector files and tests

52fdad4

Merge branch 'main' into feat/add-ninjaVan-carrier-integration

abc057c

danh91 requested changes May 29, 2024

View reviewed changes

backendArchitect added 5 commits September 10, 2024 10:26

fix: mappers

6333eef

update schemas and other data

78ea89c

add migrations

0659066

Merge branch 'main' into feat/add-ninjaVan-carrier-integration

19ef8b5

Add Ninja Van carrier integration

481f340

backendArchitect requested a review from danh91 September 10, 2024 06:09

	url=f"{self.settings.server_url}/service",
	url=f"{self.settings.server_url}/1.0/public/price",

	url=f"{self.settings.server_url}/service",
	url=f"{self.settings.server_url}/4.2/orders",

Uh oh!

Conversation

backendArchitect commented May 29, 2024

Changes

Feat:

Uh oh!

danh91 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

backendArchitect commented May 30, 2024

Uh oh!

backendArchitect commented Jun 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

danh91 commented Jun 7, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

backendArchitect commented Jun 7, 2024 •

edited

Loading