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

karrio/server/graph/serializers.py

@@ -0,0 +1,388 @@
+import typing
+import strawberry
+from django.db import transaction
+from django.contrib.auth import get_user_model
+from django.utils.translation import gettext_lazy as _
+from rest_framework import exceptions
+
+import karrio.server.serializers as serializers
+import karrio.server.core.validators as validators
+import karrio.server.providers.models as providers
+import karrio.server.manager.models as manager
+import karrio.server.graph.models as graph
+import karrio.server.core.models as core
+import karrio.server.user.models as auth
+
+
+class UserModelSerializer(serializers.ModelSerializer):
+    email = serializers.CharField(required=False)
+
+    class Meta:
+        model = get_user_model()
+        extra_kwargs = {
+            field: {"read_only": True}
+            for field in ["id", "is_staff", "last_login", "date_joined"]
+        }
+        fields = [
+            "email",
+            "full_name",
+            "is_active",
+            "is_staff",
+            "last_login",
+            "date_joined",
+        ]
+
+    @transaction.atomic
+    def update(self, instance, data: dict, **kwargs):
+        user = super().update(instance, data)
+
+        if data.get("is_active") == False:
+            user.save(update_fields=["is_active"])
+
+        return user
+
+
+@serializers.owned_model_serializer
+class WorkspaceConfigModelSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = auth.WorkspaceConfig
+        extra_kwargs = {field: {"read_only": True} for field in ["id"]}
+        exclude = ["created_at", "updated_at", "created_by"]
+
+    def create(
+        self, validated_data: dict, context: serializers.Context = None, **kwargs
+    ):
+        instance = super().create(validated_data, context=context, **kwargs)
+
+        if (
+            hasattr(auth.WorkspaceConfig, "org")
+            and getattr(context, "org", None) is not None
+        ):
+            context.org.config = instance
+            context.org.save()
+
+        return instance
+
+
+@serializers.owned_model_serializer
+class MetafieldModelSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = core.Metafield
+        extra_kwargs = {field: {"read_only": True} for field in ["id"]}
+        exclude = ["created_at", "updated_at", "created_by"]
+
+
+@serializers.owned_model_serializer
+class AddressModelSerializer(
+    validators.AugmentedAddressSerializer, serializers.ModelSerializer
+):
+    country_code = serializers.CharField(required=False)
+
+    class Meta:
+        model = manager.Address
+        extra_kwargs = {field: {"read_only": True} for field in ["id", "validation"]}
+        exclude = ["created_at", "updated_at", "created_by", "validation"]
+
+
+@serializers.owned_model_serializer
+class CommodityModelSerializer(serializers.ModelSerializer):
+    weight_unit = serializers.CharField()
+    value_currency = serializers.CharField(required=False)
+    origin_country = serializers.CharField(required=False)
+
+    class Meta:
+        model = manager.Commodity
+        exclude = ["created_at", "updated_at", "created_by", "parent"]
+        extra_kwargs = {field: {"read_only": True} for field in ["id", "parent"]}
+
+
+@serializers.owned_model_serializer
+class CustomsModelSerializer(serializers.ModelSerializer):
+    NESTED_FIELDS = ["commodities"]
+
+    incoterm = serializers.CharField(required=False, allow_null=True, allow_blank=True)
+    commodities = serializers.make_fields_optional(CommodityModelSerializer)(
+        many=True, allow_null=True, required=False
+    )
+
+    class Meta:
+        model = manager.Customs
+        exclude = ["created_at", "updated_at", "created_by"]
+        extra_kwargs = {field: {"read_only": True} for field in ["id"]}
+
+    @transaction.atomic
+    def create(self, validated_data: dict, context: dict):
+        data = {
+            name: value
+            for name, value in validated_data.items()
+            if name not in self.NESTED_FIELDS
+        }
+
+        instance = super().create(data)
+
+        serializers.save_many_to_many_data(
+            "commodities",
+            CommodityModelSerializer,
+            instance,
+            payload=validated_data,
+            context=context,
+        )
+
+        return instance
+
+    @transaction.atomic
+    def update(
+        self, instance: manager.Customs, validated_data: dict, **kwargs
+    ) -> manager.Customs:
+        data = {
+            name: value
+            for name, value in validated_data.items()
+            if name not in self.NESTED_FIELDS
+        }
+
+        return super().update(instance, data)
+
+
+@serializers.owned_model_serializer
+class ParcelModelSerializer(validators.PresetSerializer, serializers.ModelSerializer):
+    weight_unit = serializers.CharField(
+        required=False, allow_null=True, allow_blank=True
+    )
+    dimension_unit = serializers.CharField(
+        required=False, allow_null=True, allow_blank=True
+    )
+
+    class Meta:
+        model = manager.Parcel
+        exclude = ["created_at", "updated_at", "created_by", "items"]
+        extra_kwargs = {field: {"read_only": True} for field in ["id"]}
+
+
+@serializers.owned_model_serializer
+class TemplateModelSerializer(serializers.ModelSerializer):
+    address = serializers.make_fields_optional(AddressModelSerializer)(required=False)
+    customs = serializers.make_fields_optional(CustomsModelSerializer)(required=False)
+    parcel = serializers.make_fields_optional(ParcelModelSerializer)(required=False)
+
+    class Meta:
+        model = graph.Template
+        exclude = ["created_at", "updated_at", "created_by"]
+        extra_kwargs = {field: {"read_only": True} for field in ["id"]}
+
+    @transaction.atomic
+    def create(self, validated_data: dict, context: dict, **kwargs) -> graph.Template:
+        data = {
+            **validated_data,
+            "address": serializers.save_one_to_one_data(
+                "address",
+                AddressModelSerializer,
+                payload=validated_data,
+                context=context,
+            ),
+            "customs": serializers.save_one_to_one_data(
+                "customs",
+                CustomsModelSerializer,
+                payload=validated_data,
+                context=context,
+            ),
+            "parcel": serializers.save_one_to_one_data(
+                "parcel", ParcelModelSerializer, payload=validated_data, context=context
+            ),
+        }
+
+        ensure_unique_default_related_data(validated_data, context=context)
+
+        return super().create(data)
+
+    @transaction.atomic
+    def update(
+        self, instance: graph.Template, validated_data: dict, **kwargs
+    ) -> graph.Template:
+        data = {
+            key: value
+            for key, value in validated_data.items()
+            if key not in ["address", "customs", "parcel"]
+        }
+
+        serializers.save_one_to_one_data(
+            "address", AddressModelSerializer, instance, payload=validated_data
+        )
+        serializers.save_one_to_one_data(
+            "customs", CustomsModelSerializer, instance, payload=validated_data
+        )
+        serializers.save_one_to_one_data(
+            "parcel", ParcelModelSerializer, instance, payload=validated_data
+        )
+
+        ensure_unique_default_related_data(validated_data, instance)
+
+        return super().update(instance, data)
+
+
+def ensure_unique_default_related_data(
+    data: dict = None, instance: typing.Optional[graph.Template] = None, context=None
+):
+    _get = lambda key: data.get(key, getattr(instance, key, None))
+    if _get("is_default") is not True:
+        return
+
+    if _get("address") is not None:
+        query = dict(address__isnull=False, is_default=True)
+    elif _get("customs") is not None:
+        query = dict(customs__isnull=False, is_default=True)
+    elif _get("parcel") is not None:
+        query = dict(parcel__isnull=False, is_default=True)
+    else:
+        return
+
+    graph.Template.access_by(context or instance.created_by).exclude(
+        id=_get("id")
+    ).filter(**query).update(is_default=False)
+
+
+@serializers.owned_model_serializer
+class ServiceLevelModelSerializer(serializers.ModelSerializer):
+    dimension_unit = serializers.CharField(
+        required=False, allow_null=True, allow_blank=True
+    )
+    weight_unit = serializers.CharField(
+        required=False, allow_null=True, allow_blank=True
+    )
+    currency = serializers.CharField(required=False, allow_null=True, allow_blank=True)
+
+    class Meta:
+        model = providers.ServiceLevel
+        exclude = ["created_at", "updated_at", "created_by"]
+        extra_kwargs = {field: {"read_only": True} for field in ["id"]}
+
+    def update_zone(self, zone_index: int, zone_data: dict) -> None:
+        """Update a specific zone in the service level."""
+        if zone_index >= len(self.instance.zones):
+            raise exceptions.ValidationError(
+                _(f"Zone index {zone_index} is out of range"),
+                code="invalid_zone_index",
+            )
+
+        self.instance.zones[zone_index].update(
+            {k: v for k, v in zone_data.items() if v != strawberry.UNSET}
+        )
+        self.instance.save(update_fields=["zones"])
+
+    def update(self, instance, validated_data):
+        """Handle partial updates of service level data including zones."""
+        zones_data = validated_data.pop("zones", None)
+        instance = super().update(instance, validated_data)
+
+        if zones_data is not None:
+            # Handle zone updates if provided
+            existing_zones = instance.zones or []
+            updated_zones = []
+
+            for idx, zone_data in enumerate(zones_data):
+                if idx < len(existing_zones):
+                    # Update existing zone
+                    zone = existing_zones[idx].copy()
+                    zone.update(
+                        {k: v for k, v in zone_data.items() if v != strawberry.UNSET}
+                    )
+                    updated_zones.append(zone)
+                else:
+                    # Add new zone
+                    updated_zones.append(zone_data)
+
+            instance.zones = updated_zones
+            instance.save(update_fields=["zones"])
+
+        return instance
+
+
+@serializers.owned_model_serializer
+class LabelTemplateModelSerializer(serializers.ModelSerializer):
+    template_type = serializers.CharField(required=False)
+
+    class Meta:
+        model = providers.LabelTemplate
+        exclude = ["created_at", "updated_at", "created_by"]
+        extra_kwargs = {field: {"read_only": True} for field in ["id"]}
+
+
+@serializers.owned_model_serializer
+class RateSheetModelSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = providers.RateSheet
+        exclude = ["created_at", "updated_at", "created_by"]
+        extra_kwargs = {field: {"read_only": True} for field in ["id", "services"]}
+
+    def update_services(
+        self, services_data: list, remove_missing: bool = False
+    ) -> None:
+        """Update services of the rate sheet."""
+        existing_services = {s.id: s for s in self.instance.services.all()}
+
+        for service_data in services_data:
+            service_id = service_data.get("id")
+            if service_id and service_id in existing_services:
+                # Update existing service
+                service = existing_services[service_id]
+                service_serializer = ServiceLevelModelSerializer(
+                    service,
+                    data=service_data,
+                    context=self.context,
+                    partial=True,
+                )
+                service_serializer.is_valid(raise_exception=True)
+                service_serializer.save()
+            else:
+                # Create new service
+                service_serializer = ServiceLevelModelSerializer(
+                    data=service_data,
+                    context=self.context,
+                )
+                service_serializer.is_valid(raise_exception=True)
+                service = service_serializer.save()
+                self.instance.services.add(service)
+
+        # Remove services that are not in the update
+        if remove_missing:
+            service_ids = {s.get("id") for s in services_data if "id" in s}
+            for service in existing_services.values():
+                if service.id not in service_ids:
+                    self.instance.services.remove(service)
+                    service.delete()
+
+    def update_carriers(self, carriers: list) -> None:
+        """Update carrier associations."""
+        if carriers is not None:
+            _ids = set(
+                [*carriers, *(self.instance.carriers.values_list("id", flat=True))]
+            )
+            _carriers = gateway.Carriers.list(
+                context=self.context,
+                carrier_name=self.instance.carrier_name,
+            ).filter(id__in=list(_ids))
+
+            for carrier in _carriers:
+                carrier.settings.rate_sheet = (
+                    self.instance if carrier.id in carriers else None
+                )
+                carrier.settings.save(update_fields=["rate_sheet"])
+
+    def update(self, instance, validated_data, **kwargs):
+        """Handle updates of rate sheet data including services and carriers."""
+        services_data = validated_data.pop("services", None)
+        carriers = (
+            validated_data.pop("carriers", None)
+            if "carriers" in validated_data
+            else None
+        )
+        remove_missing_services = validated_data.pop("remove_missing_services", False)
+
+        instance = super().update(instance, validated_data)
+
+        if services_data is not None:
+            self.update_services(services_data, remove_missing_services)
+
+        if carriers is not None:
+            self.update_carriers(carriers)
+
+        return instance

karrio/server/graph/templates/graphql/graphiql.html

@@ -0,0 +1,142 @@
+{% load i18n static %}
+<!DOCTYPE html>
+<html>
+
+  <head>
+    <meta charset="utf-8">
+    <meta name="theme-color" content="#ffffff">
+    <link rel="shortcut icon" href="{% static 'branding/favicon.ico' %}">
+
+    <title>{{ APP_NAME }} Graph</title>
+
+    <style>
+      html, body {
+        height: 100%;
+        margin: 0;
+        overflow: hidden;
+        width: 100%;
+      }
+
+      #graphiql {
+        height: 100vh;
+        display: flex;
+      }
+
+      .docExplorerHide {
+        display: none;
+      }
+
+      .doc-explorer-contents {
+        overflow-y: hidden !important;
+      }
+
+      .docExplorerWrap {
+        width: unset !important;
+        min-width: unset !important;
+      }
+
+      .graphiql-explorer-actions select {
+        margin-left: 4px;
+      }
+
+      .admin-link {
+        position: fixed;
+        bottom: 44px;
+        right: 30px;
+        width: 40px;
+        height: 40px;
+        background-color: rgba(50, 50, 159, 70%);
+        border-radius: 50%;
+        z-index: 10;
+        box-shadow: rgb(0 0 0 / 30%) 0px 0px 20px;
+      }
+
+      @media screen and (max-width: 50rem) {
+        .admin-link {
+          bottom: 112px;
+        }
+      }
+    </style>
+
+    <script
+      crossorigin
+      src="https://unpkg.com/react@17.0.2/umd/react.development.js"
+      integrity="sha384-xQwCoNcK/7P3Lpv50IZSEbJdpqbToWEODAUyI/RECaRXmOE2apWt7htari8kvKa/"
+    ></script>
+    <script
+      crossorigin
+      src="https://unpkg.com/react-dom@17.0.2/umd/react-dom.development.js"
+      integrity="sha384-E9IgxDsnjKgh0777N3lXen7NwXeTsOpLLJhI01SW7idG046SRqJpsW2rJwsOYk0L"
+    ></script>
+    <script
+      crossorigin
+      src="https://unpkg.com/js-cookie@3.0.1/dist/js.cookie.min.js"
+      integrity="sha384-ETDm/j6COkRSUfVFsGNM5WYE4WjyRgfDhy4Pf4Fsc8eNw/eYEMqYZWuxTzMX6FBa"
+    ></script>
+
+    <link
+      crossorigin
+      rel="stylesheet"
+      href="https://unpkg.com/graphiql@2.0.3/graphiql.min.css"
+      integrity="sha384-AKx2Bh1kuZ1tUTwbmHASXvBtHBX4WWVwdTQjArDlqPCL2uuBTyJkajuxdczWhzTN"
+    />
+  </head>
+
+  <body>
+      <div id="graphiql" class="graphiql-container">Loading...</div>
+
+      <script
+        crossorigin
+        src="https://unpkg.com/graphiql@2.0.3/graphiql.min.js"
+        integrity="sha384-WI6ayyBMb7Ln13us9JlWopMH4Kz33Pt9bYbkO5oY/xryP/pbGmz5Q08oS2dcrLmc"
+      ></script>
+      <script
+        crossorigin
+        src="https://unpkg.com/@graphiql/plugin-explorer@0.1.0/dist/graphiql-plugin-explorer.umd.js"
+        integrity="sha384-XyAmNqmxnLsRHkMhQYTqC0ub7uXpNbwdkhjn70ZF3J3XSb7bouSdRVfzDojimcMd"
+      ></script>
+      <script>
+        const EXAMPLE_QUERY = `# Welcome to GraphiQL`;
+
+        const fetchURL = window.location.href;
+
+        function httpUrlToWebSockeUrl(url) {
+          return url.replace(/(http)(s)?\:\/\//, "ws$2://");
+        }
+
+        const headers = {};
+        const csrfToken = Cookies.get("csrftoken");
+
+        if (csrfToken) {
+          headers["x-csrftoken"] = csrfToken;
+        }
+
+        const fetcher = GraphiQL.createFetcher({
+          url: fetchURL,
+          headers: headers,
+        });
+
+        function GraphiQLWithExplorer() {
+          const [query, setQuery] = React.useState(EXAMPLE_QUERY);
+          const explorerPlugin = GraphiQLPluginExplorer.useExplorerPlugin({
+            query: query,
+            onEdit: setQuery,
+          });
+          return React.createElement(GraphiQL, {
+            fetcher: fetcher,
+            defaultEditorToolsVisibility: true,
+            plugins: [explorerPlugin],
+            query: query,
+            onEditQuery: setQuery,
+            graphiqlHeaderEditorEnabled: true,
+          });
+        }
+
+        ReactDOM.render(
+          React.createElement(GraphiQLWithExplorer),
+          document.getElementById("graphiql")
+        );
+      </script>
+  </body>
+
+</html>

karrio/server/graph/templates/karrio/email_change_email.html

@@ -0,0 +1,13 @@
+{% load i18n %}{% autoescape off %}
+{% blocktrans %}You're receiving this email because you requested an email change for your user account at {{ APP_NAME }}.{% endblocktrans %}
+<br /><br />
+{% trans "Please open the following link to confirm:" %}<br />
+{% block change_link %}
+{{ link }}?token={{ token }}
+{% endblock %}
+<br /><br />
+{% trans "Thanks for using our platform!" %}
+<br />
+{% blocktrans %}The {{ APP_NAME }} team{% endblocktrans %}
+
+{% endautoescape %}

karrio/server/graph/templates/karrio/email_change_email.txt

@@ -0,0 +1,13 @@
+{% load i18n %}{% autoescape off %}
+{% blocktrans %}You're receiving this email because you requested an email change for your user account at {{ APP_NAME }}.{% endblocktrans %}
+
+{% trans "Please open the following link to confirm:" %}
+{% block change_link %}
+{{ link }}?token={{ token }}
+{% endblock %}
+
+{% trans "Thanks for using our platform!" %}
+
+{% blocktrans %}The {{ APP_NAME }} team{% endblocktrans %}
+
+{% endautoescape %}

karrio/server/graph/templates/karrio/password_reset_email.html

@@ -0,0 +1,14 @@
+{% load i18n %}{% autoescape off %}
+{% blocktrans %}You're receiving this email because you requested a password reset for your user account at {{ app_name }}.{% endblocktrans %}
+
+{% trans "Please go to the following page and choose a new password:" %}
+{% block reset_link %}
+{{ redirect_url }}?uidb64={{ uid }}&token={{ token }}
+{% endblock %}
+{% trans 'Your username, in case you’ve forgotten:' %} {{ user.get_username }}
+
+{% trans "Thanks for using our platform!" %}
+
+{% blocktrans %}The {{ app_name }} team{% endblocktrans %}
+
+{% endautoescape %}

karrio/server/graph/tests/__init__.py

@@ -0,0 +1,9 @@
+import logging
+
+logging.disable(logging.CRITICAL)
+
+from karrio.server.graph.tests.test_templates import *
+from karrio.server.graph.tests.test_carrier_connections import *
+from karrio.server.graph.tests.test_user_info import *
+from karrio.server.graph.tests.test_rate_sheets import *
+from karrio.server.graph.tests.test_metafield import *