karrio-server-events 2025.5rc1__py3-none-any.whl

karrio/server/events/tests/test_events.py

@@ -0,0 +1,138 @@
+from datetime import datetime
+from unittest.mock import ANY
+
+from karrio.server.events import serializers
+from karrio.server.graph.tests.base import GraphTestCase
+from karrio.server.events.task_definitions.base import webhook
+
+
+class TestEventCreation(GraphTestCase):
+    def setUp(self) -> None:
+        super().setUp()
+
+        event_data = TRACKER_VALUE
+        context = dict(user_id=self.user.id, test_mode=False)
+        event_type = serializers.EventTypes.tracker_created.value
+        event_at = datetime.now().strftime("%Y-%m-%d %H:%M:%S.%f%z")
+
+        webhook.notify_webhook_subscribers(event_type, event_data, event_at, context)
+
+    # def test_query_events(self):
+    #     response = self.query(
+    #         """
+    #         query get_events {
+    #           events {
+    #             edges {
+    #               node {
+    #                 id
+    #                 type
+    #                 data
+    #                 test_mode
+    #                 pending_webhooks
+    #               }
+    #             }
+    #           }
+    #         }
+    #         """,
+    #         operation_name="get_events",
+    #     )
+    #     response_data = response.data
+
+    #     self.assertResponseNoErrors(response)
+    #     self.assertDictEqual(response_data, EVENTS_RESPONSE)
+
+    def test_query_event(self):
+        response = self.query(
+            """
+            query get_event($id: String!) {
+              event(id: $id) {
+                id
+                type
+                data
+                test_mode
+                pending_webhooks
+              }
+            }
+            """,
+            operation_name="get_event",
+            variables=dict(id=self.user.event_set.first().id),
+        )
+        response_data = response.data
+
+        self.assertResponseNoErrors(response)
+        self.assertDictEqual(response_data, EVENT_RESPONSE)
+
+
+TRACKER_VALUE = {
+    "tracking_number": "1Z12345E6205277936",
+    "test_mode": False,
+    "delivered": False,
+    "events": [
+        {
+            "date": "2012-10-04",
+            "description": "Order Processed: Ready for UPS",
+            "location": "FR",
+            "code": "MP",
+            "time": "13:58",
+        }
+    ],
+    "status": "in_transit",
+}
+
+EVENTS_RESPONSE = {
+    "data": {
+        "events": {
+            "edges": [
+                {
+                    "node": {
+                        "id": ANY,
+                        "type": "tracker_created",
+                        "data": {
+                            "events": [
+                                {
+                                    "code": "MP",
+                                    "date": "2012-10-04",
+                                    "time": "13:58",
+                                    "location": "FR",
+                                    "description": "Order Processed: Ready for UPS",
+                                }
+                            ],
+                            "status": "in_transit",
+                            "delivered": False,
+                            "test_mode": False,
+                            "tracking_number": "1Z12345E6205277936",
+                        },
+                        "test_mode": False,
+                        "pending_webhooks": 0,
+                    }
+                }
+            ]
+        }
+    }
+}
+
+EVENT_RESPONSE = {
+    "data": {
+        "event": {
+            "id": ANY,
+            "type": "tracker_created",
+            "data": {
+                "events": [
+                    {
+                        "code": "MP",
+                        "date": "2012-10-04",
+                        "time": "13:58",
+                        "location": "FR",
+                        "description": "Order Processed: Ready for UPS",
+                    }
+                ],
+                "status": "in_transit",
+                "delivered": False,
+                "test_mode": False,
+                "tracking_number": "1Z12345E6205277936",
+            },
+            "test_mode": False,
+            "pending_webhooks": 0,
+        }
+    }
+}

karrio/server/events/tests/test_tracking_tasks.py

@@ -0,0 +1,345 @@
+import json
+import datetime
+from time import sleep
+from unittest.mock import patch, ANY
+from django.urls import reverse
+from rest_framework import status
+from karrio.core.models import TrackingDetails, TrackingEvent
+from karrio.server.core.tests import APITestCase
+from karrio.server.manager import models
+from karrio.server.events.task_definitions.base import tracking
+
+
+class TestTrackersBackgroundUpdate(APITestCase):
+    def setUp(self) -> None:
+        super().setUp()
+        trackers = [
+            {
+                "tracking_number": "1Z12345E6205277936",
+                "test_mode": True,
+                "delivered": False,
+                "events": [
+                    {
+                        "date": "2012-10-04",
+                        "description": "Order Processed: Ready for UPS",
+                        "location": "FR",
+                        "code": "MP",
+                        "time": "13:58",
+                    }
+                ],
+                "status": "in_transit",
+                "created_by": self.user,
+                "tracking_carrier": self.ups_carrier,
+                "info": {
+                    "carrier_tracking_link": "https://www.ups.com/track?loc=en_US&requester=QUIC&tracknum=1Z12345E6205277936/trackdetails",
+                    "shipment_service": "UPS Ground",
+                },
+            },
+            {
+                "tracking_number": "00340434292135100124",
+                "test_mode": True,
+                "delivered": False,
+                "events": [
+                    {
+                        "date": "2021-01-11",
+                        "description": "The instruction data for this shipment have been provided by the sender to DHL electronically",
+                        "location": "BONN",
+                        "code": "pre-transit",
+                        "time": "20:34",
+                    }
+                ],
+                "status": "in_transit",
+                "created_by": self.user,
+                "tracking_carrier": self.dhl_carrier,
+                "info": {
+                    "carrier_tracking_link": "https://www.dhl.com/ca-en/home/tracking/tracking-parcel.html?submit=1&tracking-id=00340434292135100124",
+                    "package_weight": 0.74,
+                    "package_weight_unit": "KG",
+                    "shipping_date": "2021-01-11",
+                },
+            },
+        ]
+        [models.Tracking.objects.create(**t) for t in trackers]
+
+    def test_get_trackers(self):
+        url = reverse("karrio.server.manager:trackers-list")
+
+        response = self.client.get(url)
+        response_data = json.loads(response.content)
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertDictEqual(response_data, TRACKERS_LIST)
+
+    def test_get_updated_trackers(self):
+        url = reverse("karrio.server.manager:trackers-list")
+
+        with patch(
+            "karrio.server.events.task_definitions.base.tracking.utils.identity"
+        ) as mocks:
+            mocks.return_value = RETURNED_UPDATED_VALUE
+            sleep(0.1)
+            tracking.update_trackers(delta=datetime.timedelta(seconds=0.1))
+
+            response = self.client.get(url)
+            response_data = json.loads(response.content)
+
+            self.assertEqual(response.status_code, status.HTTP_200_OK)
+            self.assertDictEqual(response_data, UPDATED_TRACKERS_LIST)
+
+
+RETURNED_VALUE = (
+    [
+        TrackingDetails(
+            carrier_id="ups_package",
+            carrier_name="ups",
+            tracking_number="1Z12345E6205277936",
+            delivered=False,
+            events=[
+                TrackingEvent(
+                    code="KB",
+                    date="2010-08-30",
+                    description="UPS INTERNAL ACTIVITY CODE",
+                    location="BONN",
+                    time="10:39",
+                )
+            ],
+            status="in_transit",
+            info={
+                "carrier_tracking_link": "https://www.ups.com/track?loc=en_US&requester=QUIC&tracknum=1Z12345E6205277936/trackdetails",
+                "shipment_service": "UPS Ground",
+            },
+        )
+    ],
+    [],
+)
+
+TRACKING_RESPONSE = {
+    "id": ANY,
+    "carrier_id": "ups_package",
+    "carrier_name": "ups",
+    "tracking_number": "1Z12345E6205277936",
+    "test_mode": True,
+    "delivered": False,
+    "events": [
+        {
+            "code": "KB",
+            "date": "2010-08-30",
+            "description": "UPS INTERNAL ACTIVITY CODE",
+            "location": "BONN",
+            "time": "10:39",
+        }
+    ],
+}
+
+TRACKERS_LIST = {
+    "count": 2,
+    "next": ANY,
+    "previous": ANY,
+    "results": [
+        {
+            "id": ANY,
+            "info": ANY,
+            "object_type": "tracker",
+            "carrier_name": "dhl_express",
+            "carrier_id": "dhl_express",
+            "tracking_number": "00340434292135100124",
+            "delivery_image_url": None,
+            "signature_image_url": None,
+            "estimated_delivery": ANY,
+            "events": [
+                {
+                    "date": "2021-01-11",
+                    "description": "The instruction data for this shipment have been provided by the sender to DHL electronically",
+                    "location": "BONN",
+                    "code": "pre-transit",
+                    "time": "20:34",
+                    "latitude": None,
+                    "longitude": None,
+                }
+            ],
+            "delivered": False,
+            "status": "in_transit",
+            "test_mode": True,
+            "messages": [],
+            "meta": {},
+            "metadata": {},
+        },
+        {
+            "id": ANY,
+            "info": ANY,
+            "object_type": "tracker",
+            "carrier_name": "ups",
+            "carrier_id": "ups_package",
+            "tracking_number": "1Z12345E6205277936",
+            "delivery_image_url": None,
+            "signature_image_url": None,
+            "estimated_delivery": ANY,
+            "events": [
+                {
+                    "date": "2012-10-04",
+                    "description": "Order Processed: Ready for UPS",
+                    "location": "FR",
+                    "code": "MP",
+                    "time": "13:58",
+                    "latitude": None,
+                    "longitude": None,
+                }
+            ],
+            "delivered": False,
+            "status": "in_transit",
+            "test_mode": True,
+            "messages": [],
+            "meta": {},
+            "metadata": {},
+        },
+    ],
+}
+
+RETURNED_UPDATED_VALUE = (
+    [
+        TrackingDetails(
+            carrier_id="dhl_express",
+            carrier_name="dhl_express",
+            tracking_number="00340434292135100124",
+            delivered=False,
+            events=[
+                TrackingEvent(
+                    code="pre-transit",
+                    date="2021-03-02",
+                    description="JESSICA",
+                    location="Oderweg 2, AMSTERDAM",
+                    time="07:53",
+                ),
+                TrackingEvent(
+                    code="pre-transit",
+                    date="2021-01-11",
+                    description="The instruction data for this shipment have been provided by the sender to DHL electronically",
+                    location="BONN",
+                    time="20:34",
+                ),
+            ],
+            info={
+                "carrier_tracking_link": "https://www.dhl.com/ca-en/home/tracking/tracking-parcel.html?submit=1&tracking-id=00340434292135100124",
+                "package_weight": "0.74",
+                "package_weight_unit": "KG",
+                "shipment_service": "dhl_express_worldwide",
+                "shipping_date": "2021-01-11",
+                "signed_by": "Jane Doe",
+            },
+        )
+    ],
+    [],
+)
+
+UPDATED_TRACKERS_LIST = {
+    "count": 2,
+    "next": None,
+    "previous": None,
+    "results": [
+        {
+            "id": ANY,
+            "object_type": "tracker",
+            "carrier_name": "dhl_express",
+            "carrier_id": "dhl_express",
+            "tracking_number": "00340434292135100124",
+            "events": [
+                {
+                    "date": "2021-03-02",
+                    "description": "JESSICA",
+                    "location": "Oderweg 2, AMSTERDAM",
+                    "code": "pre-transit",
+                    "time": "07:53",
+                    "latitude": None,
+                    "longitude": None,
+                },
+                {
+                    "date": "2021-01-11",
+                    "description": "The instruction data for this shipment have been provided by the sender to DHL electronically",
+                    "location": "BONN",
+                    "code": "pre-transit",
+                    "time": "20:34",
+                    "latitude": None,
+                    "longitude": None,
+                },
+            ],
+            "delivered": False,
+            "test_mode": True,
+            "status": "in_transit",
+            "estimated_delivery": ANY,
+            "delivery_image_url": None,
+            "signature_image_url": None,
+            "messages": [],
+            "meta": {},
+            "metadata": {},
+            "info": {
+                "carrier_tracking_link": "https://www.dhl.com/ca-en/home/tracking/tracking-parcel.html?submit=1&tracking-id=00340434292135100124",
+                "customer_name": None,
+                "expected_delivery": None,
+                "note": None,
+                "order_date": None,
+                "order_id": None,
+                "package_weight": "0.74",
+                "package_weight_unit": "KG",
+                "shipment_delivery_date": None,
+                "shipment_destination_country": None,
+                "shipment_destination_postal_code": None,
+                "shipment_origin_country": None,
+                "shipment_origin_postal_code": None,
+                "shipment_package_count": None,
+                "shipment_pickup_date": None,
+                "shipment_service": "dhl_express_worldwide",
+                "shipping_date": "2021-01-11",
+                "signed_by": "Jane Doe",
+                "source": None,
+            },
+        },
+        {
+            "id": ANY,
+            "object_type": "tracker",
+            "carrier_name": "ups",
+            "carrier_id": "ups_package",
+            "tracking_number": "1Z12345E6205277936",
+            "events": [
+                {
+                    "date": "2012-10-04",
+                    "description": "Order Processed: Ready for UPS",
+                    "location": "FR",
+                    "code": "MP",
+                    "time": "13:58",
+                    "latitude": None,
+                    "longitude": None,
+                }
+            ],
+            "delivered": False,
+            "test_mode": True,
+            "status": "in_transit",
+            "estimated_delivery": ANY,
+            "delivery_image_url": None,
+            "signature_image_url": None,
+            "messages": [],
+            "meta": {},
+            "metadata": {},
+            "info": {
+                "carrier_tracking_link": "https://www.ups.com/track?loc=en_US&requester=QUIC&tracknum=1Z12345E6205277936/trackdetails",
+                "customer_name": None,
+                "expected_delivery": None,
+                "note": None,
+                "order_date": None,
+                "order_id": None,
+                "package_weight": None,
+                "package_weight_unit": None,
+                "shipment_delivery_date": None,
+                "shipment_destination_country": None,
+                "shipment_destination_postal_code": None,
+                "shipment_origin_country": None,
+                "shipment_origin_postal_code": None,
+                "shipment_package_count": None,
+                "shipment_pickup_date": None,
+                "shipment_service": "UPS Ground",
+                "shipping_date": None,
+                "signed_by": None,
+                "source": None,
+            },
+        },
+    ],
+}

karrio/server/events/tests/test_webhooks.py

@@ -0,0 +1,132 @@
+import json
+from unittest.mock import ANY, patch
+from requests import Response
+
+from django.urls import reverse
+from django.utils import timezone
+from rest_framework import status
+
+from karrio.server.core.tests import APITestCase
+from karrio.server.events.models import Webhook
+from karrio.server.events.task_definitions.base.webhook import (
+    notify_webhook_subscribers,
+)
+
+NOTIFICATION_DATETIME = timezone.now()
+
+
+class TestWebhooks(APITestCase):
+    def test_create_webhook(self):
+        url = reverse("karrio.server.events:webhook-list")
+        data = WEBHOOK_DATA
+
+        response = self.client.post(url, data)
+        response_data = json.loads(response.content)
+
+        self.assertEqual(response.status_code, status.HTTP_201_CREATED)
+        self.assertDictEqual(response_data, WEBHOOK_RESPONSE)
+
+
+class TestWebhookDetails(APITestCase):
+    def setUp(self) -> None:
+        super().setUp()
+        self.webhook: Webhook = Webhook.objects.create(
+            **{
+                "url": "http://localhost:8080",
+                "description": "Testing Hook",
+                "enabled_events": ["all"],
+                "test_mode": True,
+                "disabled": False,
+                "id": ANY,
+                "last_event_at": None,
+                "created_by": self.user,
+            }
+        )
+
+    def test_update_webhook(self):
+        url = reverse(
+            "karrio.server.events:webhook-details", kwargs=dict(pk=self.webhook.pk)
+        )
+        data = WEBHOOK_UPDATE_DATA
+
+        response = self.client.patch(url, data)
+        response_data = json.loads(response.content)
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertDictEqual(response_data, WEBHOOK_UPDATED_RESPONSE)
+
+    def test_webhook_notify(self):
+        url = reverse(
+            "karrio.server.events:webhook-details", kwargs=dict(pk=self.webhook.pk)
+        )
+
+        with patch(
+            "karrio.server.events.task_definitions.base.webhook.identity"
+        ) as mocks:
+            response = Response()
+            response.status_code = 200
+            mocks.return_value = response
+
+            notify_webhook_subscribers(
+                event="shipment.purchased",
+                data={"shipment": "content"},
+                event_at=NOTIFICATION_DATETIME,
+                ctx=dict(
+                    user_id=self.user.id,
+                    test_mode=True,
+                ),
+            )
+
+        response = self.client.get(url)
+        response_data = json.loads(response.content)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertDictEqual(response_data, WEBHOOK_NOTIFIED_RESPONSE)
+
+
+WEBHOOK_DATA = {
+    "url": "http://localhost:8080",
+    "description": "Testing Hook",
+    "enabled_events": ["all"],
+    "test_mode": True,
+}
+
+WEBHOOK_RESPONSE = {
+    "url": "http://localhost:8080",
+    "description": "Testing Hook",
+    "enabled_events": ["all"],
+    "test_mode": True,
+    "disabled": False,
+    "id": ANY,
+    "object_type": "webhook",
+    "secret": ANY,
+    "last_event_at": None,
+}
+
+WEBHOOK_UPDATE_DATA = {
+    "description": "Testing Hook Updated",
+    "enabled_events": ["shipment_purchased", "shipment_cancelled"],
+}
+
+WEBHOOK_UPDATED_RESPONSE = {
+    "url": "http://localhost:8080",
+    "description": "Testing Hook Updated",
+    "enabled_events": ["shipment_purchased", "shipment_cancelled"],
+    "test_mode": True,
+    "disabled": False,
+    "id": ANY,
+    "object_type": "webhook",
+    "secret": ANY,
+    "last_event_at": None,
+}
+
+WEBHOOK_NOTIFIED_RESPONSE = {
+    "url": "http://localhost:8080",
+    "description": "Testing Hook",
+    "enabled_events": ["all"],
+    "test_mode": True,
+    "disabled": False,
+    "id": ANY,
+    "object_type": "webhook",
+    "secret": ANY,
+    "last_event_at": NOTIFICATION_DATETIME.strftime("%Y-%m-%dT%H:%M:%S.%fZ"),
+}

karrio/server/events/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

karrio/server/events/urls.py

@@ -0,0 +1,10 @@
+"""
+karrio server events module urls
+"""
+from django.urls import include, path
+from karrio.server.events.views import router
+
+app_name = 'karrio.server.events'
+urlpatterns = [
+    path('v1/', include(router.urls)),
+]

karrio/server/events/views/__init__.py

@@ -0,0 +1,2 @@
+import karrio.server.events.views.webhooks
+from karrio.server.events.router import router