initial rasaddam backend project

common/constants.py

@@ -0,0 +1 @@
+# Add your common constants here that are common for all other apps.

common/models.py

@@ -0,0 +1,84 @@
+# Standard library imports
+import uuid
+
+# Django imports
+from django.conf import settings
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+# Django Rest Framework imports
+
+# Third party imports
+
+# Local imports
+
+user_model = settings.AUTH_USER_MODEL
+
+
+class IsDeletedManager(models.Manager):
+    def get_queryset(self):
+        return super().get_queryset().filter(is_deleted=False)
+
+
+class BaseModel(models.Model):
+    """
+    Tracks instance creations, updates, and (soft) deletions.
+    """
+
+    uuid = models.UUIDField(
+        verbose_name=_("UUID"), unique=True, default=uuid.uuid4, editable=False
+    )
+
+    created_by = models.ForeignKey(
+        to=user_model,
+        verbose_name=_("Created by"),
+        null=True,
+        blank=True,
+        related_name="%(class)s_created",
+        on_delete=models.SET_NULL,
+    )
+
+    created_at = models.DateTimeField(
+        verbose_name=_("Created at"),
+        auto_now_add=True,
+        editable=False,
+        db_index=True,
+    )
+
+    updated_by = models.ForeignKey(
+        to=user_model,
+        verbose_name=_("Updated by"),
+        null=True,
+        blank=True,
+        related_name="%(class)s_updated",
+        on_delete=models.SET_NULL,
+    )
+
+    updated_at = models.DateTimeField(
+        verbose_name=_("Updated at"),
+        auto_now=True,
+        null=True,
+        blank=True,
+    )
+
+    deleted_by = models.ForeignKey(
+        to=user_model,
+        verbose_name=_("Deleted by"),
+        null=True,
+        blank=True,
+        related_name="%(class)s_deleted",
+        on_delete=models.SET_NULL,
+    )
+
+    deleted_at = models.DateTimeField(
+        verbose_name=_("Deleted at"), null=True, blank=True, default=None
+    )
+
+    is_deleted = models.BooleanField(verbose_name=_("Is deleted"), default=False)
+
+    objects = IsDeletedManager()
+
+    objects_all = models.Manager()
+
+    class Meta:
+        abstract = True

common/serializers.py

@@ -0,0 +1,43 @@
+from typing import List
+
+from rest_framework.request import Request
+from rest_framework.serializers import ModelSerializer, Serializer
+
+
+class DynamicFieldsModelSerializer(ModelSerializer):
+    """
+    A ModelSerializer that takes an additional `fields` argument that
+    controls which fields should be displayed.
+    """
+
+    def __init__(self, *args, **kwargs):
+        # Don't pass the 'fields' arg up to the superclass
+        fields = kwargs.pop("fields", None)
+
+        # Instantiate the superclass normally
+        super().__init__(*args, **kwargs)
+
+        if fields is not None:
+            # Drop any fields that are not specified in the `fields` argument.
+            allowed = set(fields)
+            existing = set(self.fields)
+            for field_name in existing - allowed:
+                self.fields.pop(field_name)
+
+
+def create_validated_instance(serializer: Serializer, request: Request):
+    serializer = serializer(data=request.data, context={"request": request})
+    serializer.is_valid(raise_exception=True)
+    return serializer.save(), serializer.validated_data
+
+
+def get_validated_data(
+    serializer: Serializer, request: Request, fields: List[str] = None
+):
+    if fields and issubclass(serializer, DynamicFieldsModelSerializer):
+        serializer = serializer(fields=fields, data=request.data)
+    else:
+        serializer = serializer(data=request.data)
+
+    serializer.is_valid(raise_exception=True)
+    return serializer.validated_data