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

karrio/server/data/admin.py

@@ -0,0 +1 @@
+from django.contrib import admin

karrio/server/data/apps.py

@@ -0,0 +1,13 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class DataConfig(AppConfig):
+    name = "karrio.server.data"
+    verbose_name = _("Import/Export")
+    default_auto_field = "django.db.models.BigAutoField"
+
+    def ready(self):
+        from karrio.server.data import signals
+
+        signals.register_all()

karrio/server/data/filters.py

@@ -0,0 +1,43 @@
+import karrio.server.filters as filters
+import karrio.server.data.models as models
+import karrio.server.data.serializers as serializers
+
+
+class DataTemplateFilter(filters.FilterSet):
+    name = filters.CharFilter(field_name="name", lookup_expr="icontains")
+    slug = filters.CharFilter(field_name="slug", lookup_expr="icontains")
+    resource_type = filters.MultipleChoiceFilter(
+        field_name="resource_type",
+        choices=[(c.value, c.value) for c in list(serializers.ResourceType)],
+        help_text=f"""
+        the data template resource type
+        Values: {', '.join([f"`{s.name}`" for s in list(serializers.ResourceType)])}
+        """,
+    )
+
+    class Meta:
+        model = models.DataTemplate
+        fields: list = []
+
+
+class BatchOperationFilter(filters.FilterSet):
+    resource_type = filters.MultipleChoiceFilter(
+        field_name="resource_type",
+        choices=[(c.value, c.value) for c in list(serializers.ResourceType)],
+        help_text=f"""
+        the batch resource type
+        Values: {', '.join([f"`{s.name}`" for s in list(serializers.ResourceType)])}
+        """,
+    )
+    status = filters.MultipleChoiceFilter(
+        field_name="status",
+        choices=[(c.value, c.value) for c in list(serializers.BatchOperationStatus)],
+        help_text=f"""
+        the batch operation status
+        Values: {', '.join([f"`{s.name}`" for s in list(serializers.BatchOperationStatus)])}
+        """,
+    )
+
+    class Meta:
+        model = models.BatchOperation
+        fields: list = []

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

@@ -0,0 +1,62 @@
+# Generated by Django 3.2.13 on 2022-07-05 20:23
+
+from django.conf import settings
+import django.core.validators
+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):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='BatchOperation',
+            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': 'batch_'}), editable=False, max_length=50, primary_key=True, serialize=False)),
+                ('status', models.CharField(choices=[('queued', 'queued'), ('running', 'running'), ('completed', 'completed'), ('failed', 'failed')], default='queued', max_length=25)),
+                ('resource_type', models.CharField(choices=[('order', 'order'), ('shipment', 'shipment'), ('tracking', 'tracking'), ('billing', 'billing')], default='order', max_length=25)),
+                ('resources', models.JSONField(blank=True, default=functools.partial(karrio.server.core.utils.identity, *(), **{'value': []}), null=True)),
+                ('test_mode', models.BooleanField()),
+                ('created_by', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'verbose_name': 'Batch Operation',
+                'verbose_name_plural': 'Batch Operations',
+                'db_table': 'batch-operation',
+                'ordering': ['-created_at'],
+            },
+            bases=(karrio.server.core.models.base.ControlledAccessModel, models.Model),
+        ),
+        migrations.CreateModel(
+            name='DataTemplate',
+            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': 'data_'}), editable=False, max_length=50, primary_key=True, serialize=False)),
+                ('name', models.CharField(max_length=50)),
+                ('slug', models.SlugField(max_length=25, validators=[django.core.validators.RegexValidator('^[a-z0-9_]+$')])),
+                ('description', models.CharField(blank=True, max_length=50, null=True)),
+                ('resource_type', models.CharField(choices=[('order', 'order'), ('shipment', 'shipment'), ('tracking', 'tracking'), ('billing', 'billing')], max_length=25)),
+                ('fields_mapping', models.JSONField(default=functools.partial(karrio.server.core.utils.identity, *(), **{'value': {}}), help_text="\n        The fields is a mapping of key value pairs linking the resource type's\n        data field (key) to header used for import/export.\n\n        e.g: resource: tracking | fields [{'id': 'ID', 'tracking_number': 'Tracking Number'}]\n        ")),
+                ('created_by', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'verbose_name': 'Data Template',
+                'verbose_name_plural': 'Data Templates',
+                'db_table': 'data-template',
+                'ordering': ['-created_at'],
+            },
+            bases=(karrio.server.core.models.base.ControlledAccessModel, models.Model),
+        ),
+    ]

karrio/server/data/migrations/0002_alter_batchoperation_resource_type_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 4.1.3 on 2022-11-25 17:09
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('data', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='batchoperation',
+            name='resource_type',
+            field=models.CharField(choices=[('orders', 'orders'), ('shipments', 'shipments'), ('trackers', 'trackers'), ('billing', 'billing')], default='orders', max_length=25),
+        ),
+        migrations.AlterField(
+            model_name='batchoperation',
+            name='status',
+            field=models.CharField(choices=[('queued', 'queued'), ('running', 'running'), ('failed', 'failed'), ('completed', 'completed'), ('completed_with_errors', 'completed_with_errors')], default='queued', max_length=25),
+        ),
+        migrations.AlterField(
+            model_name='datatemplate',
+            name='resource_type',
+            field=models.CharField(choices=[('orders', 'orders'), ('shipments', 'shipments'), ('trackers', 'trackers'), ('billing', 'billing')], max_length=25),
+        ),
+    ]

karrio/server/data/migrations/0003_datatemplate_metadata_alter_batchoperation_resources.py

@@ -0,0 +1,36 @@
+# Generated by Django 4.1.7 on 2023-02-22 15:35
+
+from django.db import migrations, models
+import functools
+import karrio.server.core.models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("data", "0002_alter_batchoperation_resource_type_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="datatemplate",
+            name="metadata",
+            field=models.JSONField(
+                blank=True,
+                default=functools.partial(
+                    karrio.server.core.models._identity, *(), **{"value": {}}
+                ),
+                null=True,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="batchoperation",
+            name="resources",
+            field=models.JSONField(
+                blank=True,
+                default=functools.partial(
+                    karrio.server.core.models._identity, *(), **{"value": []}
+                ),
+                null=True,
+            ),
+        ),
+    ]

karrio/server/data/models.py

@@ -0,0 +1,97 @@
+from functools import partial
+from django.db import models
+from django.core.validators import RegexValidator
+
+import karrio.server.core.utils as utils
+import karrio.server.core.models as core
+import karrio.server.data.serializers as serializers
+
+
+@core.register_model
+class BatchOperation(core.OwnedEntity):
+    class Meta:
+        db_table = "batch-operation"
+        verbose_name = "Batch Operation"
+        verbose_name_plural = "Batch Operations"
+        ordering = ["-created_at"]
+
+    id = models.CharField(
+        max_length=50,
+        primary_key=True,
+        default=partial(core.uuid, prefix="batch_"),
+        editable=False,
+    )
+
+    status = models.CharField(
+        max_length=25,
+        choices=serializers.OPERATION_STATUS,
+        default=serializers.OPERATION_STATUS[0][0],
+    )
+    resource_type = models.CharField(
+        max_length=25,
+        choices=serializers.RESOURCE_TYPE,
+        default=serializers.RESOURCE_TYPE[0][0],
+    )
+    resources = models.JSONField(
+        blank=True,
+        null=True,
+        default=core.field_default([]),
+    )
+    test_mode = models.BooleanField(null=False)
+
+    @property
+    def object_type(self):
+        return "batch"
+
+
+@core.register_model
+class DataTemplate(core.OwnedEntity):
+    class Meta:
+        db_table = "data-template"
+        verbose_name = "Data Template"
+        verbose_name_plural = "Data Templates"
+        ordering = ["-created_at"]
+
+    id = models.CharField(
+        max_length=50,
+        primary_key=True,
+        default=partial(core.uuid, prefix="data_"),
+        editable=False,
+    )
+    name = models.CharField(max_length=50)
+    slug = models.SlugField(max_length=25, validators=[RegexValidator(r"^[a-z0-9_]+$")])
+    description = models.CharField(max_length=50, null=True, blank=True)
+    resource_type = models.CharField(
+        max_length=25, blank=False, null=False, choices=serializers.RESOURCE_TYPE
+    )
+    fields_mapping = models.JSONField(
+        blank=False,
+        null=False,
+        default=partial(utils.identity, value={}),
+        help_text="""
+        The fields is a mapping of key value pairs linking the resource type's
+        data field (key) to header used for import/export.
+
+        e.g: resource: tracking | fields [{'id': 'ID', 'tracking_number': 'Tracking Number'}]
+        """,
+    )
+    metadata = models.JSONField(
+        blank=True,
+        null=True,
+        default=core.field_default({}),
+    )
+
+    @property
+    def object_type(self):
+        return "data_template"
+
+    @property
+    def data_fields(self):
+        default_fields_mapping = serializers.ResourceType.get_default_mapping(
+            self.resource_type
+        )
+
+        return {
+            **default_fields_mapping,
+            **self.fields_mapping,
+        }

karrio/server/data/resources/__init__.py

@@ -0,0 +1,53 @@
+from django.contrib.auth import get_user_model
+from import_export import resources
+
+import karrio.server.data.resources.shipments as shipments
+import karrio.server.data.resources.orders as orders
+import karrio.server.data.resources.trackers as trackers
+import karrio.server.data.models as models
+
+User = get_user_model()
+
+
+def export(
+    resource_type: str, query_params: dict, context, data_fields: dict = None
+) -> dict:
+    """Generate a file to export."""
+
+    resource = get_export_resource(
+        resource_type, query_params, context, data_fields=data_fields
+    )
+
+    return resource.export()
+
+
+def get_export_resource(
+    resource_type: str, params: dict, context, data_fields: dict = None
+) -> resources.ModelResource:
+
+    if resource_type == "orders":
+        return orders.order_export_resource(params, context, data_fields=data_fields)
+
+    if resource_type == "trackers":
+        return trackers.tracker_export_resource(params, context, data_fields=data_fields)
+
+    if resource_type == "shipments":
+        return shipments.shipment_export_resource(params, context, data_fields=data_fields)
+
+    raise Exception("Unsupported resource")
+
+
+def get_import_resource(
+    resource_type: str, params: dict, context, data_fields: dict = None, **kwargs
+) -> resources.ModelResource:
+
+    if resource_type == "orders":
+        return orders.order_import_resource(params, context, data_fields=data_fields, **kwargs)
+
+    if resource_type == "trackers":
+        return trackers.tracker_import_resource(params, context, data_fields=data_fields, **kwargs)
+
+    if resource_type == "shipments":
+        return shipments.shipment_import_resource(params, context, data_fields=data_fields, **kwargs)
+
+    raise Exception("Unsupported resource")