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

karrio/server/providers/migrations/0081_remove_alliedexpresssettings_carrier_ptr_and_more.py

@@ -0,0 +1,338 @@
+# Generated by Django 5.1.9 on 2025-05-09 06:49
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("providers", "0080_alter_aramexsettings_account_country_code_and_more"),
+    ]
+
+    operations = [
+        # 1. Remove all 'services' and other dependent fields first
+        migrations.RemoveField(
+            model_name="belgianpostsettings",
+            name="services",
+        ),
+        migrations.RemoveField(
+            model_name="colissimosettings",
+            name="services",
+        ),
+        migrations.RemoveField(
+            model_name="dhlparceldesettings",
+            name="services",
+        ),
+        migrations.RemoveField(
+            model_name="dhlpolandsettings",
+            name="services",
+        ),
+        migrations.RemoveField(
+            model_name="dpdhlsettings",
+            name="services",
+        ),
+        migrations.RemoveField(
+            model_name="dpdsettings",
+            name="services",
+        ),
+        migrations.RemoveField(
+            model_name="genericsettings",
+            name="services",
+        ),
+        migrations.RemoveField(
+            model_name="genericsettings",
+            name="label_template",
+        ),
+        # 2. Remove all 'carrier_ptr' fields
+        migrations.RemoveField(
+            model_name="alliedexpresssettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="amazonshippingsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="aramexsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="asendiaussettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="australiapostsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="belgianpostsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="boxknightsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="canadapostsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="canparsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="chronopostsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="colissimosettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="dhlexpresssettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="dhlparceldesettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="dhlpolandsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="dhluniversalsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="dicomsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="dpdhlsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="dpdsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="easypostsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="eshippersettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="fedexsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="fedexwssettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="freightcomsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="genericsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="geodissettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="haypostsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="lapostesettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="locate2usettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="nationexsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="purolatorsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="roadiesettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="royalmailsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="sendlesettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="tgesettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="tntsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="upssettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="uspsinternationalsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="uspssettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="uspswtinternationalsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="uspswtsettings",
+            name="carrier_ptr",
+        ),
+        migrations.RemoveField(
+            model_name="zoom2usettings",
+            name="carrier_ptr",
+        ),
+        # 3. Delete all the models
+        migrations.DeleteModel(
+            name="AlliedExpressLocalSettings",
+        ),
+        migrations.DeleteModel(
+            name="AlliedExpressSettings",
+        ),
+        migrations.DeleteModel(
+            name="AmazonShippingSettings",
+        ),
+        migrations.DeleteModel(
+            name="AramexSettings",
+        ),
+        migrations.DeleteModel(
+            name="AsendiaUSSettings",
+        ),
+        migrations.DeleteModel(
+            name="AustraliaPostSettings",
+        ),
+        migrations.DeleteModel(
+            name="BelgianPostSettings",
+        ),
+        migrations.DeleteModel(
+            name="BoxKnightSettings",
+        ),
+        migrations.DeleteModel(
+            name="CanadaPostSettings",
+        ),
+        migrations.DeleteModel(
+            name="CanparSettings",
+        ),
+        migrations.DeleteModel(
+            name="ChronopostSettings",
+        ),
+        migrations.DeleteModel(
+            name="ColissimoSettings",
+        ),
+        migrations.DeleteModel(
+            name="DHLExpressSettings",
+        ),
+        migrations.DeleteModel(
+            name="DHLParcelDESettings",
+        ),
+        migrations.DeleteModel(
+            name="DHLPolandSettings",
+        ),
+        migrations.DeleteModel(
+            name="DHLUniversalSettings",
+        ),
+        migrations.DeleteModel(
+            name="DicomSettings",
+        ),
+        migrations.DeleteModel(
+            name="DPDHLSettings",
+        ),
+        migrations.DeleteModel(
+            name="DPDSettings",
+        ),
+        migrations.DeleteModel(
+            name="EasyPostSettings",
+        ),
+        migrations.DeleteModel(
+            name="EShipperSettings",
+        ),
+        migrations.DeleteModel(
+            name="FedexSettings",
+        ),
+        migrations.DeleteModel(
+            name="FedexWSSettings",
+        ),
+        migrations.DeleteModel(
+            name="FreightcomSettings",
+        ),
+        migrations.DeleteModel(
+            name="GenericSettings",
+        ),
+        migrations.DeleteModel(
+            name="GEODISSettings",
+        ),
+        migrations.DeleteModel(
+            name="HayPostSettings",
+        ),
+        migrations.DeleteModel(
+            name="LaPosteSettings",
+        ),
+        migrations.DeleteModel(
+            name="Locate2uSettings",
+        ),
+        migrations.DeleteModel(
+            name="NationexSettings",
+        ),
+        migrations.DeleteModel(
+            name="PurolatorSettings",
+        ),
+        migrations.DeleteModel(
+            name="RoadieSettings",
+        ),
+        migrations.DeleteModel(
+            name="RoyalMailSettings",
+        ),
+        migrations.DeleteModel(
+            name="SendleSettings",
+        ),
+        migrations.DeleteModel(
+            name="TGESettings",
+        ),
+        migrations.DeleteModel(
+            name="TNTSettings",
+        ),
+        migrations.DeleteModel(
+            name="UPSSettings",
+        ),
+        migrations.DeleteModel(
+            name="USPSInternationalSettings",
+        ),
+        migrations.DeleteModel(
+            name="USPSSettings",
+        ),
+        migrations.DeleteModel(
+            name="USPSWTInternationalSettings",
+        ),
+        migrations.DeleteModel(
+            name="USPSWTSettings",
+        ),
+        migrations.DeleteModel(
+            name="Zoom2uSettings",
+        ),
+    ]

karrio/server/providers/models/__init__.py

@@ -0,0 +1,17 @@
+
+from karrio.server.providers.models.sheet import RateSheet
+from karrio.server.providers.models.config import CarrierConfig
+from karrio.server.providers.models.service import ServiceLevel
+from karrio.server.providers.models.template import LabelTemplate
+import karrio.server.providers.extension.models as extensions
+from karrio.server.core.models.base import register_model
+from karrio.server.providers.models.utils import has_rate_sheet
+from karrio.server.providers.models.carrier import (
+    Carrier,
+    COUNTRIES,
+    CURRENCIES,
+    WEIGHT_UNITS,
+    DIMENSION_UNITS,
+    CAPABILITIES_CHOICES,
+    create_carrier_proxy,
+)

karrio/server/providers/models/carrier.py

@@ -0,0 +1,309 @@
+import typing
+import functools
+import django.conf as conf
+import django.forms as forms
+import django.db.models as models
+
+import karrio.sdk as karrio
+import karrio.lib as lib
+import karrio.core.units as units
+import django.core.cache as caching
+import karrio.api.gateway as gateway
+import karrio.server.core.models as core
+import karrio.server.core.fields as fields
+import karrio.server.core.datatypes as datatypes
+
+
+COUNTRIES = [(c.name, c.name) for c in units.Country]
+CURRENCIES = [(c.name, c.name) for c in units.Currency]
+WEIGHT_UNITS = [(c.name, c.name) for c in units.WeightUnit]
+DIMENSION_UNITS = [(c.name, c.name) for c in units.DimensionUnit]
+CAPABILITIES_CHOICES = [(c, c) for c in units.CarrierCapabilities.get_capabilities()]
+
+
+class Manager(models.Manager):
+    def get_queryset(self):
+        return (
+            super()
+            .get_queryset()
+            .select_related(
+                "created_by",
+                *(("link",) if conf.settings.MULTI_ORGANIZATIONS else tuple()),
+            )
+        )
+
+
+class CarrierManager(Manager):
+    def get_queryset(self):
+        return super().get_queryset().filter(is_system=False)
+
+
+class SystemCarrierManager(models.Manager):
+    def get_queryset(self):
+        return (
+            super()
+            .get_queryset()
+            .prefetch_related(
+                "configs",
+            )
+            .select_related(
+                "created_by",
+                *(("link",) if conf.settings.MULTI_ORGANIZATIONS else tuple()),
+            )
+            .filter(is_system=True)
+        )
+
+
+@core.register_model
+class Carrier(core.OwnedEntity):
+    class Meta:
+        ordering = ["test_mode", "-created_at"]
+
+    objects = Manager()
+    user_carriers = CarrierManager()
+    system_carriers = SystemCarrierManager()
+
+    id = models.CharField(
+        max_length=50,
+        primary_key=True,
+        default=functools.partial(core.uuid, prefix="car_"),
+        editable=False,
+    )
+    carrier_code = models.CharField(
+        max_length=100,
+        db_index=True,
+        default="generic",
+        help_text="eg. dhl_express, fedex, ups, usps, ...",
+    )
+    carrier_id = models.CharField(
+        max_length=150,
+        db_index=True,
+        help_text="eg. canadapost, dhl_express, fedex, purolator_courrier, ups...",
+    )
+    credentials = models.JSONField(
+        default=core.field_default({}),
+        help_text="Carrier connection credentials",
+    )
+    capabilities = fields.MultiChoiceField(
+        choices=datatypes.CAPABILITIES_CHOICES,
+        default=core.field_default([]),
+        help_text="Select the capabilities of the carrier that you want to enable",
+    )
+    metadata = models.JSONField(
+        blank=True,
+        null=True,
+        default=core.field_default({}),
+        help_text="User defined metadata",
+    )
+    active = models.BooleanField(
+        default=True,
+        db_index=True,
+        help_text="Disable/Hide carrier from clients",
+    )
+    is_system = models.BooleanField(
+        default=False,
+        db_index=True,
+        help_text="Determine that the carrier connection is available system wide.",
+    )
+    test_mode = models.BooleanField(
+        default=True,
+        db_column="test_mode",
+        help_text="Toggle carrier connection mode",
+    )
+
+    created_by = models.ForeignKey(
+        conf.settings.AUTH_USER_MODEL,
+        blank=True,
+        null=True,
+        on_delete=models.CASCADE,
+        editable=False,
+    )
+    active_users = models.ManyToManyField(
+        conf.settings.AUTH_USER_MODEL,
+        blank=True,
+        related_name="connection_users",
+    )
+    rate_sheet = models.ForeignKey(
+        "RateSheet",
+        null=True,
+        blank=True,
+        on_delete=models.SET_NULL,
+    )
+
+    def __str__(self):
+        return self.carrier_id
+
+    @property
+    def object_type(self):
+        return "carrier-connection"
+
+    @property
+    def ext(self) -> str:
+        return (
+            "generic"
+            if "custom_carrier_name" in self.credentials
+            else lib.failsafe(lambda: self.carrier_code) or "generic"
+        )
+
+    @property
+    def carrier_name(self):
+        return (
+            self.credentials.get("custom_carrier_name")
+            if "custom_carrier_name" in self.credentials
+            else lib.failsafe(lambda: self.carrier_code) or "generic"
+        )
+
+    @property
+    def display_name(self):
+        import karrio.references as references
+
+        return self.credentials.get("display_name") or references.REFERENCES[
+            "carriers"
+        ].get(self.ext) or "generic"
+
+    @property
+    def carrier_config(self):
+        return self.__class__.resolve_config(self)
+
+    @property
+    def config(self) -> dict:
+        return getattr(self.carrier_config, "config", {})
+
+    @property
+    def services(self) -> typing.Optional[typing.List[dict]]:
+
+        if self.rate_sheet is None:
+            return None
+
+        return self.rate_sheet.services.all()
+
+    @property
+    def data(self) -> datatypes.CarrierSettings:
+        _computed_data: typing.Dict = dict(
+            id=self.id,
+            config=self.config,
+            test_mode=self.test_mode,
+            metadata=self.metadata,
+            carrier_id=self.carrier_id,
+            carrier_name=self.ext,
+            display_name=self.display_name,
+        )
+
+        if any(self.services or []):
+            _computed_data.update(
+                services=[forms.model_to_dict(s) for s in self.services]
+            )
+
+        # override the config with the system config
+        if self.is_system and self.carrier_config is None:
+            _config = self.__class__.resolve_config(self, is_system_config=True)
+            _computed_data.update(config=getattr(_config, "config", None))
+
+        return datatypes.CarrierSettings.create(
+            {
+                **self.credentials,
+                **_computed_data,
+            }
+        )
+
+    @property
+    def gateway(self) -> gateway.Gateway:
+        import karrio.server.core.middleware as middleware
+
+        _context = middleware.SessionContext.get_current_request()
+        _tracer = getattr(_context, "tracer", lib.Tracer())
+        _cache = lib.Cache(caching.cache)
+
+        return karrio.gateway[self.ext].create(
+            self.data.to_dict(),
+            _tracer,
+            _cache,
+        )
+
+    @staticmethod
+    def resolve_config(
+        carrier, is_user_config: bool = False, is_system_config: bool = False
+    ):
+        """Resolve the config for a carrier.
+        Here are the rules:
+        - If the carrier is a system carrier, return the first config with no org
+        - If the carrier is an org carrier, return the first config from the org
+        - If the carrier is a user carrier, return the first config from the user
+        """
+        import karrio.server.serializers as serializers
+        import karrio.server.core.middleware as middleware
+        from django.contrib.auth.models import AnonymousUser
+        from karrio.server.providers.models.config import CarrierConfig
+
+        if carrier.id is None:
+            return None
+
+        _ctx = serializers.get_object_context(carrier)
+        ctx = lib.identity(
+            _ctx
+            if (_ctx.user or _ctx.org)
+            else lib.failsafe(lambda: middleware.SessionContext.get_current_request())
+        )
+        has_ctx_user = lib.identity(
+            ctx and ((ctx.user and not isinstance(ctx.user, AnonymousUser)) or ctx.org)
+        )
+
+        queryset = lib.identity(
+            CarrierConfig.objects.filter(carrier=carrier)
+            if carrier.is_system
+            else CarrierConfig.access_by(ctx).filter(carrier=carrier)
+        )
+
+        if carrier.is_system:
+            _config = queryset.filter(
+                created_by__is_staff=True,
+                **({"org": None} if hasattr(carrier, "org") else {}),
+            ).first()
+
+            if has_ctx_user:
+                return queryset.filter(
+                    **(
+                        {"org": (None if is_system_config else ctx.org)}
+                        if hasattr(carrier, "org")
+                        else {"created_by": ctx.user}
+                    )
+                ).first() or (None if is_user_config else _config)
+
+            return _config
+
+        return queryset.first()
+
+
+def create_carrier_proxy(carrier_name: str, display_name):
+    class _Manager(Manager):
+        def get_queryset(self):
+            return super().get_queryset().filter(carrier_code=carrier_name)
+
+    class _CarrierManager(CarrierManager):
+        def get_queryset(self):
+            return super().get_queryset().filter(carrier_code=carrier_name)
+
+    class _SystemCarrierManager(SystemCarrierManager):
+        def get_queryset(self):
+            return super().get_queryset().filter(carrier_code=carrier_name)
+
+    return type(
+        f"{carrier_name}Connection",
+        (Carrier,),
+        {
+            "Meta": type(
+                "Meta",
+                (),
+                {
+                    "proxy": True,
+                    "__module__": __name__,
+                    "verbose_name": f"{display_name} Connection",
+                    "verbose_name_plural": f"{display_name} Connections",
+                },
+            ),
+            "__module__": __name__,
+            "objects": _Manager(),
+            "user_carriers": _CarrierManager(),
+            "system_carriers": _SystemCarrierManager(),
+        },
+    )

karrio/server/providers/models/config.py

@@ -0,0 +1,30 @@
+import functools
+import django.db.models as models
+import karrio.server.core.models as core
+
+
+@core.register_model
+class CarrierConfig(core.OwnedEntity):
+    class Meta:
+        db_table = "carrier-config"
+        verbose_name = "Carrier Config"
+        verbose_name_plural = "Carrier Configs"
+        ordering = ["-created_at"]
+
+    id = models.CharField(
+        max_length=50,
+        editable=False,
+        primary_key=True,
+        default=functools.partial(core.uuid, prefix="cfg_"),
+    )
+    carrier = models.ForeignKey(
+        "Carrier",
+        null=False,
+        related_name="configs",
+        on_delete=models.CASCADE,
+    )
+    config = models.JSONField(
+        null=False,
+        blank=False,
+        default=core.field_default({}),
+    )