Setup/projects and users

.dictionary/custom.txt

@@ -1,3 +1,5 @@
+viewsets
+projs
 evenodd
 heebo
 svgr
@@ -69,3 +71,18 @@ xlwt
 xmlfile
 gitcommitmessage
 headlessui
+isort
+pylint
+tomli
+tomlkit
+projectmembership
+Qcet
+ZIZW
+runserver
+pgdata
+pyca
+pycryptodome
+zustand
+probs
+Customise
+popperjs

backend/.env

@@ -2,9 +2,9 @@ DEBUG=True
 DEVELOPMENT_MODE=True
 DJANGO_ALLOWED_HOSTS='localhost,0.0.0.0,127.0.0.1,192.168.1.220'
 
-DB_NAME = default_db
-DB_USERNAME = default_admin
-DB_PASSWORD = default_password 
-DB_HOST = default_host 
-DB_PORT = 25060
+DB_NAME = crumpet_db
+DB_USERNAME = head_baker
+DB_PASSWORD = Crumpet2023 
+DB_HOST = db
+DB_PORT = 5432
 DB_SSL_MODE = require

backend/Dockerfile

@@ -1,5 +1,5 @@
 # syntax=docker/dockerfile:1
-FROM python:3.11.2
+FROM python:3.10-bullseye
 
 ENV PYTHONDONTWRITEBYTECODE=1
 ENV PYTHONUNBUFFERED=1

backend/app/authentication.py

@@ -0,0 +1,17 @@
+from rest_framework.authentication import BaseAuthentication
+from rest_framework.exceptions import AuthenticationFailed
+
+from .models import Project
+
+
+class ProjectAPIKeyAuthentication(BaseAuthentication):
+    def authenticate(self, request):
+        api_key = request.headers.get("X-API-KEY")
+        if not api_key:
+            return None
+
+        try:
+            project = Project.objects.get(api_key=api_key)
+            return (project, None)  # authentication successful
+        except Project.DoesNotExist:
+            raise AuthenticationFailed("Invalid API key.")

backend/app/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.1.5 on 2023-05-12 12:00
+# Generated by Django 4.1.5 on 2023-07-17 09:42
 
 from django.conf import settings
 import django.core.validators
@@ -111,21 +111,6 @@ class Migration(migrations.Migration):
                 "abstract": False,
             },
         ),
-        migrations.CreateModel(
-            name="Application",
-            fields=[
-                (
-                    "id",
-                    models.BigAutoField(
-                        auto_created=True,
-                        primary_key=True,
-                        serialize=False,
-                        verbose_name="ID",
-                    ),
-                ),
-                ("name", models.CharField(max_length=100)),
-            ],
-        ),
         migrations.CreateModel(
             name="Element",
             fields=[
@@ -262,6 +247,21 @@ class Migration(migrations.Migration):
                 ),
             ],
         ),
+        migrations.CreateModel(
+            name="Project",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=100)),
+            ],
+        ),
         migrations.CreateModel(
             name="Selector",
             fields=[
@@ -286,30 +286,8 @@ class Migration(migrations.Migration):
                 ),
             ],
         ),
-        migrations.AddField(
-            model_name="element",
-            name="event",
-            field=models.ForeignKey(
-                blank=True,
-                null=True,
-                on_delete=django.db.models.deletion.SET_NULL,
-                related_name="associated_elements",
-                to="app.event",
-            ),
-        ),
-        migrations.AddField(
-            model_name="element",
-            name="parent",
-            field=models.ForeignKey(
-                blank=True,
-                null=True,
-                on_delete=django.db.models.deletion.CASCADE,
-                related_name="children",
-                to="app.element",
-            ),
-        ),
         migrations.CreateModel(
-            name="ApplicationMembership",
+            name="ProjectMembership",
             fields=[
                 (
                     "id",
@@ -329,10 +307,9 @@ class Migration(migrations.Migration):
                     ),
                 ),
                 (
-                    "application",
+                    "project",
                     models.ForeignKey(
-                        on_delete=django.db.models.deletion.CASCADE,
-                        to="app.application",
+                        on_delete=django.db.models.deletion.CASCADE, to="app.project"
                     ),
                 ),
                 (
@@ -345,14 +322,36 @@ class Migration(migrations.Migration):
             ],
         ),
         migrations.AddField(
-            model_name="application",
+            model_name="project",
             name="members",
             field=models.ManyToManyField(
-                related_name="applications",
-                through="app.ApplicationMembership",
+                related_name="projects",
+                through="app.ProjectMembership",
                 to=settings.AUTH_USER_MODEL,
             ),
         ),
+        migrations.AddField(
+            model_name="element",
+            name="event",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="associated_elements",
+                to="app.event",
+            ),
+        ),
+        migrations.AddField(
+            model_name="element",
+            name="parent",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="children",
+                to="app.element",
+            ),
+        ),
         migrations.CreateModel(
             name="ButtonElement",
             fields=[],

backend/app/migrations/0002_project_api_key.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.1.5 on 2023-09-08 17:45
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("app", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="project",
+            name="api_key",
+            field=models.CharField(
+                default="NIzNPqaU5CpCs7ItQ01x8dcvXozQcetR", max_length=256, unique=True
+            ),
+        ),
+    ]

backend/app/migrations/0003_alter_project_api_key.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.1.5 on 2023-09-08 17:52
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("app", "0002_project_api_key"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="project",
+            name="api_key",
+            field=models.CharField(
+                default="PhZIZWGhUv2snEoQ5S4G3O1FQ608FUx8", max_length=256, unique=True
+            ),
+        ),
+    ]

backend/app/migrations/0004_alter_project_api_key.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.1.5 on 2023-09-08 20:36
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("app", "0003_alter_project_api_key"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="project",
+            name="api_key",
+            field=models.CharField(
+                default="<function uuid4 at 0x105dc6200>", max_length=256, unique=True
+            ),
+        ),
+    ]

backend/app/migrations/0005_alter_project_api_key.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.1.5 on 2023-09-08 20:44
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("app", "0004_alter_project_api_key"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="project",
+            name="api_key",
+            field=models.CharField(
+                default="<function uuid4 at 0x101eda200>", max_length=256, unique=True
+            ),
+        ),
+    ]

backend/app/migrations/0006_alter_project_api_key.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.1.5 on 2023-09-08 20:46
+
+from django.db import migrations, models
+import uuid
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("app", "0005_alter_project_api_key"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="project",
+            name="api_key",
+            field=models.CharField(default=uuid.uuid4, max_length=256, unique=True),
+        ),
+    ]

backend/app/models/__init__.py

@@ -11,5 +11,5 @@
     ButtonElement,
 )
 from .user import User
-from .application import Application, ApplicationMembership
+from .project import Project, ProjectMembership
 from .selector import Selector

backend/app/models/application.py → backend/app/models/project.py

@@ -1,26 +1,37 @@
-from django.db import models
+# from django.utils.crypto import get_random_string
+import uuid
+
 from app.models import User
+from django.db import models
 
 
-class Application(models.Model):
+class Project(models.Model):
     name = models.CharField(max_length=100)
     members = models.ManyToManyField(
         User,
-        through="ApplicationMembership",
-        related_name="applications",
+        through="ProjectMembership",
+        related_name="projects",
+    )
+    # TODO: Replace this with proper key generation
+    api_key = models.CharField(
+        max_length=256,
+        unique=True,
+        default=uuid.uuid4,
+        null=False,
+        blank=False,
     )
 
     def __str__(self):
         return self.name
 
 
-class ApplicationMembership(models.Model):
+class ProjectMembership(models.Model):
     class MembershipType(models.TextChoices):
         ADMIN = "ADM", "Admin"
         MEMBER = "MEM", "Member"
 
     user = models.ForeignKey(User, on_delete=models.CASCADE)
-    application = models.ForeignKey(Application, on_delete=models.CASCADE)
+    project = models.ForeignKey(Project, on_delete=models.CASCADE)
 
     type = models.CharField(
         max_length=3,

backend/app/models/user.py

@@ -8,7 +8,7 @@
 
 class UserManager(BaseUserManager):
     """
-    Custom user model manager with email is the identifier.
+    Custom user model manager with email as the identifier.
     """
 
     model: Type["User"]
@@ -19,7 +19,7 @@ def create_user(self, email, password, first_name, last_name, **extra_fields):
         if not first_name:
             raise ValueError("Users must have a first name")
         if not last_name:
-            raise ValueError("Users must have a password")
+            raise ValueError("Users must have a last name")
         email = self.normalize_email(email)
         user = self.model(
             email=email, first_name=first_name, last_name=last_name, **extra_fields

backend/app/models/utils.py

@@ -0,0 +1,10 @@
+import uuid
+
+from django.db import models
+
+
+class UUIDModel(models.Model):
+    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
+
+    class Meta:
+        abstract = True

backend/app/permissions/__init__.py

@@ -0,0 +1 @@
+from .projects import ProjectAdminPermission, ProjectMemberPermission

backend/app/permissions/base.py

@@ -0,0 +1,7 @@
+from rest_framework import permissions
+
+
+class CrumpetBasePermission(permissions.BasePermission):
+    """
+    A base class for custom permissions.
+    """