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

karrio/server/events/__init__.py

@@ -0,0 +1,3 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore
+
+default_app_config = "karrio.server.events.apps.EventsConfig"

karrio/server/events/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

karrio/server/events/apps.py

@@ -0,0 +1,11 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class EventsConfig(AppConfig):
+    name = 'karrio.server.events'
+    verbose_name = _('Custom Pricing')
+
+    def ready(self):
+        from karrio.server.events import signals
+        signals.register_signals()

karrio/server/events/filters.py

@@ -0,0 +1,63 @@
+import typing
+from django.db.models import Q
+
+import karrio.server.events.serializers as serializers
+import karrio.server.events.models as models
+import karrio.server.filters as filters
+
+
+class WebhookFilter(filters.FilterSet):
+    created_after = filters.DateTimeFilter(field_name="created_at", lookup_expr="gte")
+    created_before = filters.DateTimeFilter(field_name="created_at", lookup_expr="lte")
+    description = filters.CharFilter(field_name="description", lookup_expr="icontains")
+    events = filters.MultipleChoiceFilter(
+        field_name="enabled_events",
+        method="events_filter",
+        choices=[(s, s) for s in serializers.EVENT_TYPES],
+    )
+    disabled = filters.BooleanFilter(field_name="disabled")
+    test_mode = filters.BooleanFilter(field_name="test_mode")
+    url = filters.CharFilter(field_name="url", lookup_expr="icontains")
+
+    class Meta:
+        model = models.Webhook
+        fields: typing.List[str] = []
+
+    def events_filter(self, queryset, name, values):
+        if any(values):
+            query = Q(enabled_events__icontains=values[0])
+
+            for value in values[1:]:
+                query &= Q(enabled_events__icontains=value)
+
+            return queryset.filter(query | Q(enabled_events__icontains="all"))
+
+        return queryset.filter(enabled_events__icontains="all")
+
+
+class EventFilter(filters.FilterSet):
+    entity_id = filters.CharFilter(method="entity_filter", field_name="response")
+    date_after = filters.DateTimeFilter(field_name="created_at", lookup_expr="gte")
+    date_before = filters.DateTimeFilter(field_name="created_at", lookup_expr="lte")
+    type = filters.MultipleChoiceFilter(
+        field_name="type",
+        method="types_filter",
+        choices=[
+            (c.value, c.value)
+            for c in list(serializers.EventTypes)
+            if c != serializers.EventTypes.all
+        ],
+    )
+
+    class Meta:
+        model = models.Event
+        fields: typing.List[str] = []
+
+    def entity_filter(self, queryset, name, value):
+        try:
+            return queryset.filter(data__id=value)
+        except:
+            return queryset
+
+    def types_filter(self, queryset, name, values):
+        return queryset.filter(Q(type__in=values))

karrio/server/events/migrations/0001_initial.py

@@ -0,0 +1,65 @@
+# Generated by Django 3.1.7 on 2021-03-16 23:17
+
+from django.conf import settings
+import django.contrib.postgres.fields
+from django.db import migrations, models
+import django.db.models.deletion
+import functools
+import karrio.server.core.models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Webhook",
+            fields=[
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                (
+                    "id",
+                    models.CharField(
+                        default=functools.partial(
+                            karrio.server.core.models.uuid, *(), **{"prefix": "web_"}
+                        ),
+                        editable=False,
+                        max_length=50,
+                        primary_key=True,
+                        serialize=False,
+                    ),
+                ),
+                (
+                    "enabled_events",
+                    karrio.server.core.fields.MultiChoiceField(blank=True),
+                ),
+                ("url", models.URLField()),
+                ("test_mode", models.BooleanField()),
+                ("disabled", models.BooleanField(default=False, null=True)),
+                (
+                    "description",
+                    models.CharField(blank=True, max_length=200, null=True),
+                ),
+                ("last_event_at", models.DateTimeField(null=True)),
+                ("failure_streak_count", models.IntegerField(default=0)),
+                (
+                    "created_by",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Webhook",
+                "verbose_name_plural": "Webhooks",
+                "db_table": "webhook",
+                "ordering": ["-created_at"],
+            },
+        ),
+    ]

karrio/server/events/migrations/0002_event.py

@@ -0,0 +1,39 @@
+# Generated by Django 3.2.9 on 2021-11-13 13:38
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+import functools
+import karrio.server.core.models.base
+import karrio.server.core.utils
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('events', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Event',
+            fields=[
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('id', models.CharField(default=functools.partial(karrio.server.core.models.base.uuid, *(), **{'prefix': 'evt_'}), editable=False, max_length=50, primary_key=True, serialize=False)),
+                ('type', models.CharField(max_length=50)),
+                ('data', models.JSONField(default=functools.partial(karrio.server.core.utils.identity, *(), **{'value': {}}))),
+                ('test_mode', models.BooleanField()),
+                ('pending_webhooks', models.IntegerField(default=0)),
+                ('created_by', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'verbose_name': 'Event',
+                'verbose_name_plural': 'Events',
+                'db_table': 'event',
+                'ordering': ['-created_at'],
+            },
+            bases=(karrio.server.core.models.base.ControlledAccessModel, models.Model),
+        ),
+    ]

karrio/server/events/migrations/0003_auto_20220303_1210.py

@@ -0,0 +1,25 @@
+# Generated by Django 3.2.11 on 2022-03-03 12:10
+
+from django.db import migrations, models
+import functools
+import karrio.server.core.models.base
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('events', '0002_event'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='webhook',
+            name='secret',
+            field=models.CharField(default=functools.partial(karrio.server.core.models.base.uuid, *(), **{'prefix': 'whsec_'}), max_length=100),
+        ),
+        migrations.AlterField(
+            model_name='webhook',
+            name='id',
+            field=models.CharField(default=functools.partial(karrio.server.core.models.base.uuid, *(), **{'prefix': 'weh_'}), editable=False, max_length=50, primary_key=True, serialize=False),
+        ),
+    ]

karrio/server/events/migrations/0004_custom_migration_2022_4.py

@@ -0,0 +1,41 @@
+# Generated by Django 3.2.3 on 2022-03-28 03:40
+
+from django.db import migrations
+
+
+def forwards_func(apps, schema_editor):
+    db_alias = schema_editor.connection.alias
+    Event = apps.get_model("events", "Event")
+    Webhook = apps.get_model("events", "Webhook")
+
+    for event in Event.objects.using(db_alias).filter(type__icontains=".").iterator():
+        event.type = event.type.replace(".", "_")
+        event.save()
+
+    for webhook in Webhook.objects.using(db_alias).all():
+        webhook.enabled_events = [e.replace(".", "_") for e in webhook.enabled_events]
+        webhook.save()
+
+
+def reverse_func(apps, schema_editor):
+    db_alias = schema_editor.connection.alias
+    Event = apps.get_model("events", "Event")
+    Webhook = apps.get_model("events", "Webhook")
+
+    for event in Event.objects.using(db_alias).filter(type__icontains=".").iterator():
+        event.type = event.type.replace("_", ".")
+        event.save()
+
+    for webhook in Webhook.objects.using(db_alias).all():
+        webhook.enabled_events = [e.replace("_", ".") for e in webhook.enabled_events]
+        webhook.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("events", "0003_auto_20220303_1210"),
+    ]
+
+    operations = [
+        migrations.RunPython(forwards_func, reverse_func),
+    ]

karrio/server/events/migrations/0005_event_event_object_idx.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.13 on 2022-07-10 13:07
+
+from django.db import migrations, models
+import django.db.models.fields.json
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('events', '0004_custom_migration_2022_4'),
+    ]
+
+    operations = [
+        migrations.AddIndex(
+            model_name='event',
+            index=models.Index(django.db.models.fields.json.KeyTextTransform('id', 'data'), condition=models.Q(('data__id__isnull', False)), name='event_object_idx'),
+        ),
+    ]

karrio/server/events/migrations/0006_webhook_events_alter_event_data.py

@@ -0,0 +1,85 @@
+# Generated by Django 4.1.3 on 2022-11-30 00:34
+
+from django.db import migrations, models
+from django.conf import settings
+import functools
+import karrio.server.core.fields
+import karrio.server.core.models
+
+
+def forwards_func(apps, schema_editor):
+    db_alias = schema_editor.connection.alias
+    Webhook = apps.get_model("events", "Webhook")
+    webhooks = (
+        Webhook.objects.using(db_alias).raw(
+            "SELECT id, to_jsonb(enabled_events) AS enabled_events FROM webhook"
+        )
+        if "postgres" in settings.DB_ENGINE
+        else Webhook.objects.using(db_alias).all()
+    )
+    _webhooks = []
+
+    for webhook in webhooks:
+        webhook.events = webhook.enabled_events
+        _webhooks.append(webhook)
+
+    Webhook.objects.using(db_alias).bulk_update(_webhooks, ["events"])
+
+
+def reverse_func(apps, schema_editor):
+    pass
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("events", "0005_event_event_object_idx"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="webhook",
+            name="events",
+            field=karrio.server.core.fields.MultiChoiceField(
+                choices=[
+                    ("all", "all"),
+                    ("shipment_purchased", "shipment_purchased"),
+                    ("shipment_cancelled", "shipment_cancelled"),
+                    ("shipment_fulfilled", "shipment_fulfilled"),
+                    ("tracker_created", "tracker_created"),
+                    ("tracker_updated", "tracker_updated"),
+                    ("order_created", "order_created"),
+                    ("order_updated", "order_updated"),
+                    ("order_fulfilled", "order_fulfilled"),
+                    ("order_cancelled", "order_cancelled"),
+                    ("order_delivered", "order_delivered"),
+                    ("batch_queued", "batch_queued"),
+                    ("batch_failed", "batch_failed"),
+                    ("batch_running", "batch_running"),
+                    ("batch_completed", "batch_completed"),
+                ],
+                default=functools.partial(
+                    karrio.server.core.models._identity, *(), **{"value": []}
+                ),
+                help_text="Webhook events",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="event",
+            name="data",
+            field=models.JSONField(
+                default=functools.partial(
+                    karrio.server.core.models._identity, *(), **{"value": {}}
+                )
+            ),
+        ),
+        migrations.RunPython(forwards_func, reverse_func),
+        migrations.RemoveField(
+            model_name="webhook",
+            name="enabled_events",
+        ),
+        migrations.RenameField(
+            model_name="webhook",
+            old_name="events",
+            new_name="enabled_events",
+        ),
+    ]

karrio/server/events/migrations/0007_auto_20221130_0255.py

@@ -0,0 +1,30 @@
+# Generated by Django 4.1.3 on 2022-11-30 02:55
+
+from django.db import migrations
+import karrio.lib as lib
+
+
+def forwards_func(apps, schema_editor):
+    db_alias = schema_editor.connection.alias
+    Webhook = apps.get_model("events", "Webhook")
+    _webhooks = []
+
+    for webhook in Webhook.objects.using(db_alias).all().iterator():
+        webhook.enabled_events = lib.to_dict(webhook.enabled_events)
+        _webhooks.append(webhook)
+
+    Webhook.objects.using(db_alias).bulk_update(_webhooks, ["enabled_events"])
+
+
+def reverse_func(apps, schema_editor):
+    pass
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("events", "0006_webhook_events_alter_event_data"),
+    ]
+
+    operations = [
+        migrations.RunPython(forwards_func, reverse_func),
+    ]

karrio/server/events/migrations/0008_alter_event_type.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.1.3 on 2022-12-10 17:09
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("events", "0007_auto_20221130_0255"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="event",
+            name="type",
+            field=models.CharField(db_index=True, max_length=50),
+        ),
+    ]

karrio/server/events/migrations/0009_alter_webhook_enabled_events.py

@@ -0,0 +1,45 @@
+# Generated by Django 4.2 on 2023-04-18 10:18
+
+from django.db import migrations
+import functools
+import karrio.server.core.fields
+import karrio.server.core.models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("events", "0008_alter_event_type"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="webhook",
+            name="enabled_events",
+            field=karrio.server.core.fields.MultiChoiceField(
+                choices=[
+                    ("all", "all"),
+                    ("shipment_purchased", "shipment_purchased"),
+                    ("shipment_cancelled", "shipment_cancelled"),
+                    ("shipment_fulfilled", "shipment_fulfilled"),
+                    ("shipment_out_for_delivery", "shipment_out_for_delivery"),
+                    ("shipment_needs_attention", "shipment_needs_attention"),
+                    ("shipment_delivery_failed", "shipment_delivery_failed"),
+                    ("tracker_created", "tracker_created"),
+                    ("tracker_updated", "tracker_updated"),
+                    ("order_created", "order_created"),
+                    ("order_updated", "order_updated"),
+                    ("order_fulfilled", "order_fulfilled"),
+                    ("order_cancelled", "order_cancelled"),
+                    ("order_delivered", "order_delivered"),
+                    ("batch_queued", "batch_queued"),
+                    ("batch_failed", "batch_failed"),
+                    ("batch_running", "batch_running"),
+                    ("batch_completed", "batch_completed"),
+                ],
+                default=functools.partial(
+                    karrio.server.core.models._identity, *(), **{"value": []}
+                ),
+                help_text="Webhook events",
+            ),
+        ),
+    ]

karrio/server/events/models.py

@@ -0,0 +1,83 @@
+from functools import partial
+from django.db import models
+from django.conf import settings
+from django.db.models.fields import json
+
+import karrio.server.core.models as core
+import karrio.server.core.fields as core_fields
+import karrio.server.events.serializers.base as serializers
+
+
+@core.register_model
+class Webhook(core.OwnedEntity):
+    HIDDEN_PROPS = (*(("org",) if settings.MULTI_ORGANIZATIONS else tuple()),)
+
+    class Meta:
+        db_table = "webhook"
+        verbose_name = "Webhook"
+        verbose_name_plural = "Webhooks"
+        ordering = ["-created_at"]
+
+    id = models.CharField(
+        max_length=50,
+        primary_key=True,
+        default=partial(core.uuid, prefix="weh_"),
+        editable=False,
+    )
+
+    enabled_events = core_fields.MultiChoiceField(
+        choices=serializers.EVENT_TYPES,
+        default=core.field_default([]),
+        help_text="Webhook events",
+    )
+    url = models.URLField(max_length=200)
+    secret = models.CharField(
+        max_length=100, default=partial(core.uuid, prefix="whsec_")
+    )
+    test_mode = models.BooleanField(null=False)
+    disabled = models.BooleanField(null=True, default=False)
+    description = models.CharField(max_length=200, null=True, blank=True)
+    last_event_at = models.DateTimeField(null=True)
+
+    # System Reference fields
+    failure_streak_count = models.IntegerField(default=0)
+
+    def __str__(self):
+        return f"{self.id} + {self.url}"
+
+    @property
+    def object_type(self):
+        return "webhook"
+
+
+class Event(core.OwnedEntity):
+    HIDDEN_PROPS = (*(("org",) if settings.MULTI_ORGANIZATIONS else tuple()),)
+
+    class Meta:
+        db_table = "event"
+        verbose_name = "Event"
+        verbose_name_plural = "Events"
+        ordering = ["-created_at"]
+        indexes = [
+            models.Index(
+                json.KeyTextTransform("id", "data"),
+                condition=models.Q(data__id__isnull=False),
+                name="event_object_idx",
+            ),
+        ]
+
+    id = models.CharField(
+        max_length=50,
+        primary_key=True,
+        default=partial(core.uuid, prefix="evt_"),
+        editable=False,
+    )
+
+    type = models.CharField(max_length=50, db_index=True)
+    data = models.JSONField(default=core.field_default({}))
+    test_mode = models.BooleanField(null=False)
+    pending_webhooks = models.IntegerField(default=0)
+
+    @property
+    def object_type(self):
+        return "event"

karrio/server/events/router.py

@@ -0,0 +1,3 @@
+from rest_framework.routers import DefaultRouter
+
+router = DefaultRouter(trailing_slash=False)

karrio/server/events/serializers/__init__.py

@@ -0,0 +1 @@
+from karrio.server.events.serializers.base import *

karrio/server/events/serializers/base.py

@@ -0,0 +1,63 @@
+import karrio.lib as lib
+import karrio.server.serializers as serializers
+
+
+class EventTypes(lib.StrEnum):
+    all = "all"
+    shipment_purchased = "shipment_purchased"
+    shipment_cancelled = "shipment_cancelled"
+    shipment_fulfilled = "shipment_fulfilled"
+    shipment_out_for_delivery = "shipment_out_for_delivery"
+    shipment_needs_attention = "shipment_needs_attention"
+    shipment_delivery_failed = "shipment_delivery_failed"
+    tracker_created = "tracker_created"
+    tracker_updated = "tracker_updated"
+    order_created = "order_created"
+    order_updated = "order_updated"
+    order_fulfilled = "order_fulfilled"
+    order_cancelled = "order_cancelled"
+    order_delivered = "order_delivered"
+    batch_queued = "batch_queued"
+    batch_failed = "batch_failed"
+    batch_running = "batch_running"
+    batch_completed = "batch_completed"
+
+
+EVENT_TYPES = [(c.value, c.value) for c in list(EventTypes)]
+
+
+class WebhookData(serializers.Serializer):
+    url = serializers.URLField(
+        required=True, help_text="The URL of the webhook endpoint."
+    )
+    description = serializers.CharField(
+        required=False,
+        allow_blank=True,
+        allow_null=True,
+        help_text="An optional description of what the webhook is used for.",
+    )
+    enabled_events = serializers.ListField(
+        required=True,
+        child=serializers.ChoiceField(choices=EVENT_TYPES),
+        help_text="The list of events to enable for this endpoint.",
+    )
+    disabled = serializers.BooleanField(
+        required=False,
+        allow_null=True,
+        help_text="Indicates that the webhook is disabled",
+    )
+
+
+class Webhook(serializers.EntitySerializer, WebhookData):
+    object_type = serializers.CharField(
+        default="webhook", help_text="Specifies the object type"
+    )
+    last_event_at = serializers.DateTimeField(
+        required=False,
+        allow_null=True,
+        help_text="The datetime of the last event sent.",
+    )
+    secret = serializers.CharField(help_text="Header signature secret")
+    test_mode = serializers.BooleanField(
+        help_text="Specified whether it was created with a carrier in test mode",
+    )

karrio/server/events/serializers/event.py

@@ -0,0 +1,9 @@
+import karrio.server.serializers as serializers
+import karrio.server.events.models as models
+
+
+@serializers.owned_model_serializer
+class EventSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = models.Event
+        exclude = ["created_at", "updated_at", "created_by"]

karrio/server/events/serializers/webhook.py

@@ -0,0 +1,27 @@
+from karrio.server.serializers import owned_model_serializer
+from karrio.server.events.serializers import WebhookData, Webhook
+import karrio.server.events.models as models
+
+
+@owned_model_serializer
+class WebhookSerializer(WebhookData):
+    def create(self, validated_data: dict, context, **kwargs) -> models.Webhook:
+        return models.Webhook.objects.create(
+            test_mode=getattr(context, "test_mode", False),
+            **validated_data,
+        )
+
+    def update(
+        self, instance: models.Webhook, validated_data: dict, **kwargs
+    ) -> models.Webhook:
+        if (
+            "disabled" in validated_data
+            and validated_data["disabled"] != instance.disabled
+        ):
+            instance.failure_streak_count = 0
+
+        for key, val in validated_data.items():
+            setattr(instance, key, val)
+
+        instance.save()
+        return instance