django-content-studio 1.0.0b8__py3-none-any.whl → 1.0.0b10__py3-none-any.whl

content_studio/__init__.py

@@ -1,5 +1,5 @@
 __title__ = "Django Content Studio"
-__version__ = "1.0.0-beta.8"
+__version__ = "1.0.0-beta.10"
 __author__ = "Leon van der Grient"
 __license__ = "MIT"
 

content_studio/admin.py

@@ -13,6 +13,7 @@ from .token_backends import TokenBackendManager
 from .utils import get_related_field_name, flatten
 
 register = admin.register
+display = admin.display
 
 
 class StackedInline(admin.StackedInline):
@@ -102,6 +103,12 @@ class AdminSite(admin.AdminSite):
         """
         return obj.file.url
 
+    def get_tenants(self, tenant_model: Type[models.Model], **kwargs):
+        """
+        Method for getting the list of available tenants.
+        """
+        return tenant_model.objects.all()
+
 
 admin_site = AdminSite()
 
@@ -217,7 +224,7 @@ class AdminSerializer:
             "list": {
                 "per_page": admin_class.list_per_page,
                 "description": getattr(admin_class, "list_description", ""),
-                "display": admin_class.list_display,
+                "display": self.get_list_display(),
                 "search": len(admin_class.search_fields) > 0,
                 "filter": admin_class.list_filter,
                 "sortable_by": admin_class.sortable_by,
@@ -254,6 +261,27 @@ class AdminSerializer:
             for i in self.get_edit_sidebar(getattr(admin_class, "edit_sidebar", None))
         ]
 
+    def get_list_display(self):
+        admin_class = self.admin_class
+        fields = []
+
+        for field in admin_class.list_display:
+            if hasattr(admin_class, field):
+                method = getattr(admin_class, field)
+                description = getattr(method, "short_description", None)
+                empty_value = getattr(method, "empty_value", None)
+                fields.append(
+                    {
+                        "name": field,
+                        "description": description,
+                        "empty_value": empty_value,
+                    }
+                )
+            else:
+                fields.append({"name": field})
+
+        return fields
+
     def get_edit_main(self, edit_main):
         """
         Returns a normalized list of form set groups.

content_studio/apps.py

@@ -4,7 +4,7 @@ from django.contrib import admin
 from . import VERSION
 from .paginators import ContentPagination
 from .settings import cs_settings
-from .utils import is_runserver
+from .utils import is_runserver, get_tenant_field_name
 
 
 class DjangoContentStudioConfig(AppConfig):
@@ -68,7 +68,7 @@ class DjangoContentStudioConfig(AppConfig):
             _admin_model = admin_model
             is_singleton = getattr(admin_model, "is_singleton", False)
             pagination_class = Pagination
-            queryset = _model.objects.all()
+            queryset = _model.objects.none()
             search_fields = list(getattr(_admin_model, "search_fields", []))
 
             def get_serializer_class(self):
@@ -90,6 +90,16 @@ class DjangoContentStudioConfig(AppConfig):
 
                 return Serializer
 
+            def get_queryset(self):
+                tenant_model = cs_settings.TENANT_MODEL
+                tenant_id = self.request.headers.get("x-dcs-tenant", None)
+                field_name = get_tenant_field_name(self._model)
+
+                if tenant_model and tenant_id and field_name:
+                    return self._model.objects.filter(**{f"{field_name}_id": tenant_id})
+
+                return self._model.objects.all()
+
         if parent:
             prefix = f"api/inlines/{parent._meta.label_lower}/{model._meta.label_lower}"
             basename = f"content_studio_api-{parent._meta.label_lower}-{model._meta.label_lower}"

content_studio/dashboard/__init__.py

@@ -1,3 +1,6 @@
+import uuid
+
+from rest_framework import serializers
 from rest_framework.decorators import action
 from rest_framework.exceptions import NotFound
 from rest_framework.parsers import JSONParser
@@ -31,7 +34,11 @@ class Dashboard:
     def serialize(self):
         return {
             "widgets": [
-                {"name": w.__class__.__name__, "col_span": getattr(w, "col_span", 1)}
+                {
+                    "name": w.name,
+                    "widget_id": w.widget_id,
+                    "col_span": w.col_span,
+                }
                 for w in self.widgets
             ]
         }
@@ -50,15 +57,37 @@ class DashboardViewSet(ViewSet):
             admin_site.token_backend.active_backend.authentication_class
         ]
 
-    @action(detail=False, url_path="(?P<name>[^/.]+)")
-    def get(self, request, name=None):
+    @action(detail=False, url_path="widgets/(?P<widget_id>[^/.]+)")
+    def get(self, request, widget_id=None):
         widget = None
 
         for w in self.dashboard.widgets:
-            if name == w.__class__.__name__.lower():
+            if widget_id == str(w.widget_id):
                 widget = w
 
         if not widget:
             raise NotFound()
 
-        return Response(data=widget.get_data(request))
+        data = widget.get_data(request)
+
+        if isinstance(data, serializers.Serializer):
+            data.is_valid(raise_exception=True)
+            data = data.data
+
+        return Response(data=data)
+
+
+class BaseWidget:
+    col_span = 1
+    widget_id = None
+
+    def __init__(self):
+        self.widget_id = self.widget_id or uuid.uuid4()
+
+
+class SpacingWidget(BaseWidget):
+    name = "SpacingWidget"
+
+    def __init__(self, col_span=1):
+        self.col_span = col_span
+        super().__init__()

content_studio/dashboard/activity_log.py

@@ -1,7 +1,9 @@
-from content_studio.serializers import ContentSerializer
 from django.contrib.admin.models import LogEntry
 from rest_framework import serializers
 
+from content_studio.serializers import ContentSerializer
+from ..dashboard import BaseWidget
+
 
 class LogEntrySerializer(ContentSerializer):
     object_model = serializers.SerializerMethodField()
@@ -22,11 +24,13 @@ class LogEntrySerializer(ContentSerializer):
         return f"{obj.content_type.app_label}.{obj.content_type.model}"
 
 
-class ActivityLogWidget:
+class ActivityLogWidget(BaseWidget):
     """
     Widget for showing activity logs.
     """
 
+    name = "ActivityLogWidget"
+
     col_span = 2
 
     def get_data(self, request):

content_studio/dashboard/statistic.py

@@ -0,0 +1,27 @@
+from rest_framework import serializers
+
+from ..dashboard import BaseWidget
+
+
+class StatisticWidgetSerializer(serializers.Serializer):
+    value = serializers.IntegerField()
+    prefix = serializers.CharField(default="", allow_blank=True, required=False)
+    suffix = serializers.CharField(default="", allow_blank=True, required=False)
+    title = serializers.CharField(default="", allow_blank=True, required=False)
+    trend = serializers.DecimalField(
+        max_digits=5, decimal_places=1, allow_null=True, required=False
+    )
+    trend_sentiment = serializers.ChoiceField(
+        default="default", required=False, choices=["default", "positive", "negative"]
+    )
+
+
+class StatisticWidget(BaseWidget):
+    """
+    Widget for showing some statistic.
+    """
+
+    name = "StatisticWidget"
+
+    def get_data(self, request):
+        raise NotImplementedError("You need to implement get_data for your widget.")

content_studio/models.py

@@ -1,6 +1,6 @@
 from django.db import models
 
-from .utils import is_jsonable
+from .utils import is_jsonable, get_tenant_field_name
 
 
 class ModelSerializer:
@@ -10,11 +10,14 @@ class ModelSerializer:
     def serialize(self):
         model = self.model
 
+        tenant_field = get_tenant_field_name(self.model)
+
         return {
             "label": model._meta.label_lower,
             "verbose_name": model._meta.verbose_name,
             "verbose_name_plural": model._meta.verbose_name_plural,
             "fields": self.get_fields(),
+            "tenant_field": tenant_field,
         }
 
     def get_fields(self):

content_studio/settings.py

@@ -31,6 +31,7 @@ DEFAULTS = {
     "CREATED_AT_ATTR": "created_at",
     "MEDIA_LIBRARY_MODEL": None,
     "MEDIA_LIBRARY_FOLDER_MODEL": None,
+    "TENANT_MODEL": None,
 }
 
 
@@ -40,6 +41,7 @@ IMPORT_STRINGS = [
     "LOGIN_BACKENDS",
     "MEDIA_LIBRARY_MODEL",
     "MEDIA_LIBRARY_FOLDER_MODEL",
+    "TENANT_MODEL",
 ]
 
 
@@ -150,3 +152,5 @@ def reload_settings(*args, **kwargs):
 
 
 setting_changed.connect(reload_settings)
+
+allowed_cors_headers = ("x-dcs-tenant",)