Merge pull request #73 from wildjames/dev

Users are invited to households

Author: wildjames

todoqueue_backend/run_server.sh

@@ -21,6 +21,11 @@ python manage.py collectstatic --noinput && \
 echo "Starting Nginx..."
 nginx &
 
+# Default to a host port of 8000, and if the environment variable is set then use that
+if [[ -z "$DJANGO_HOST_PORT" ]]; then
+   export DJANGO_HOST_PORT=8000
+fi
+
 # Start the Django server
 echo "Starting the Django server..."
 exec gunicorn todoqueue_backend.wsgi:application --bind 0.0.0.0:$DJANGO_HOST_PORT

todoqueue_backend/tasks/migrations/0005_invitation.py

@@ -0,0 +1,27 @@
+# Generated by Django 4.2.5 on 2023-11-05 19:45
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('tasks', '0004_alter_flexibletask_description_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Invitation',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('accepted', models.BooleanField(default=False)),
+                ('timestamp', models.DateTimeField(auto_now_add=True)),
+                ('household', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='tasks.household')),
+                ('recipient', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='received_invitations', to=settings.AUTH_USER_MODEL)),
+                ('sender', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='sent_invitations', to=settings.AUTH_USER_MODEL)),
+            ],
+        ),
+    ]

todoqueue_backend/tasks/models.py

@@ -20,6 +20,8 @@
 from rest_framework.response import Response
 from rest_framework.validators import UniqueValidator
 
+from accounts.serializers import CustomUserSerializer
+
 logger = getLogger(__name__)
 usermodel = get_user_model()
 
@@ -328,6 +330,25 @@ def get_task_by_id(task_id):
     return None, None
 
 
+class Invitation(models.Model):
+    household = models.ForeignKey("Household", on_delete=models.CASCADE)
+    sender = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        related_name="sent_invitations",
+        on_delete=models.CASCADE,
+    )
+    recipient = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        related_name="received_invitations",
+        on_delete=models.CASCADE,
+    )
+    accepted = models.BooleanField(default=False)
+    timestamp = models.DateTimeField(auto_now_add=True)
+
+    def __str__(self):
+        return f"Invitation from {self.sender} to {self.recipient} for {self.household}"
+
+
 # Serializers have to live here, to avoid circular imports :(
 
 
@@ -336,7 +357,9 @@ class ScheduledTaskSerializer(serializers.ModelSerializer):
     next_due = serializers.SerializerMethodField()
     last_due = serializers.SerializerMethodField()
     mean_completion_time = serializers.SerializerMethodField()
-    description = serializers.CharField(required=False, allow_blank=True, validators=[validate_profanity])
+    description = serializers.CharField(
+        required=False, allow_blank=True, validators=[validate_profanity]
+    )
 
     class Meta:
         model = ScheduledTask
@@ -358,7 +381,9 @@ def get_mean_completion_time(self, obj):
 class FlexibleTaskSerializer(serializers.ModelSerializer):
     staleness = serializers.SerializerMethodField()
     mean_completion_time = serializers.SerializerMethodField()
-    description = serializers.CharField(required=False, allow_blank=True, validators=[validate_profanity])
+    description = serializers.CharField(
+        required=False, allow_blank=True, validators=[validate_profanity]
+    )
 
     class Meta:
         model = FlexibleTask
@@ -488,7 +513,11 @@ class Meta:
 
 class CreateHouseholdSerializer(serializers.ModelSerializer):
     name = serializers.CharField(
-        max_length=255, validators=[UniqueValidator(queryset=Household.objects.all()), validate_profanity]
+        max_length=255,
+        validators=[
+            UniqueValidator(queryset=Household.objects.all()),
+            validate_profanity,
+        ],
     )
 
     class Meta:
@@ -498,3 +527,21 @@ class Meta:
     def create(self, validated_data):
         logger.info(f"Creating household with name: {validated_data['name']}")
         return Household.objects.create(name=validated_data["name"])
+
+
+class InvitationSerializer(serializers.ModelSerializer):
+    sender = CustomUserSerializer(read_only=True)
+    recipient = CustomUserSerializer(read_only=True)
+    household = HouseholdSerializer(read_only=True)
+
+    class Meta:
+        model = Invitation
+        fields = ["id", "household", "sender", "recipient", "accepted", "timestamp"]
+
+    def create(self, validated_data):
+        # Custom create method, if needed. Might be useful if I ever add push notifications.
+        return super().create(validated_data)
+
+    def update(self, instance, validated_data):
+        # Custom update method, if needed. Could push notification when invite is accepted
+        return super().update(instance, validated_data)

todoqueue_backend/tasks/urls.py

@@ -11,16 +11,12 @@
 
 urlpatterns = [
     path("", include(router.urls)),
+    path("toggle_frozen/<uuid:taskId>/", views.toggle_frozen, name="toggle_frozen"),
     path(
         "calculate_brownie_points/",
         views.calculate_brownie_points_view,
         name="calculate_brownie_points",
     ),
-    path(
-        "households/<int:pk>/get_dummy_task_id/",
-        views.get_dummy_task_id,
-        name="get_dummy_task_id",
-    ),
     path(
         "user_statistics/", views.UserStatisticsView.as_view(), name="user_statistics"
     ),
@@ -30,14 +26,33 @@
         name="create_household",
     ),
     path(
-        "households/<pk>/add_user/",
-        views.AddUserToHouseholdView.as_view(),
-        name="add_user_to_household",
+        "households/<int:pk>/get_dummy_task_id/",
+        views.get_dummy_task_id,
+        name="get_dummy_task_id",
     ),
+    # path(
+    #     "households/<pk>/add_user/",
+    #     views.AddUserToHouseholdView.as_view(),
+    #     name="add_user_to_household",
+    # ),
     path(
         "households/<pk>/remove_user/",
         views.RemoveUserFromHouseholdView.as_view(),
         name="remove_user_from_household",
     ),
-    path("toggle_frozen/<uuid:taskId>/", views.toggle_frozen, name="toggle_frozen"),
+    path(
+        "households/<int:pk>/invite_user/",
+        views.InviteUserToHouseholdView.as_view(),
+        name="invite_user_to_household",
+    ),
+    path(
+        "invitations/pending/",
+        views.PendingInvitationsView.as_view(),
+        name="pending_invitations",
+    ),
+    path(
+        "invitations/<int:invitation_id>/respond/",
+        views.RespondToInvitationView.as_view(),
+        name="respond_to_invitation",
+    ),
 ]

todoqueue_backend/tasks/views.py

@@ -28,6 +28,8 @@
     FlexibleTaskSerializer,
     Household,
     HouseholdSerializer,
+    Invitation,
+    InvitationSerializer,
     ScheduledTask,
     ScheduledTaskSerializer,
     AllTasksSerializer,
@@ -333,6 +335,93 @@ def post(self, request, pk):
         return Response("OK", 200)
 
 
+class InviteUserToHouseholdView(APIView):
+    permission_classes = (IsAuthenticated,)
+
+    def post(self, request, pk):
+        email = request.data.get("email")
+        if not email:
+            return Response(
+                {"detail": "Missing email"}, status=status.HTTP_400_BAD_REQUEST
+            )
+
+        try:
+            household = Household.objects.get(pk=pk)
+        except Household.DoesNotExist:
+            return Response(
+                {"detail": "Household does not exist"}, status=status.HTTP_404_NOT_FOUND
+            )
+
+        try:
+            recipient = get_user_model().objects.get(email=email)
+        except get_user_model().DoesNotExist:
+            return Response(
+                {"detail": "User does not exist"}, status=status.HTTP_404_NOT_FOUND
+            )
+
+        # Check if the user is already a member of the household
+        if household.users.filter(pk=recipient.pk).exists():
+            return Response(
+                {"detail": "User is already a member of the household"},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        # Create the invitation
+        Invitation.objects.create(
+            household=household, sender=request.user, recipient=recipient
+        )
+
+        # TODO: Send a notification to the recipient about the invitation
+
+        return Response(
+            {"detail": "Invitation sent successfully"}, status=status.HTTP_200_OK
+        )
+
+
+class PendingInvitationsView(APIView):
+    permission_classes = (IsAuthenticated,)
+
+    def get(self, request):
+        invitations = Invitation.objects.filter(recipient=request.user, accepted=False)
+        serializer = InvitationSerializer(invitations, many=True)
+        return Response(serializer.data)
+
+
+class RespondToInvitationView(APIView):
+    permission_classes = (IsAuthenticated,)
+
+    def post(self, request, invitation_id):
+        action = request.data.get("action")
+        if action not in ["accept", "decline"]:
+            return Response(
+                {"detail": "Invalid action"}, status=status.HTTP_400_BAD_REQUEST
+            )
+
+        try:
+            invitation = Invitation.objects.get(
+                id=invitation_id, recipient=request.user
+            )
+        except Invitation.DoesNotExist:
+            return Response(
+                {"detail": "Invitation does not exist"},
+                status=status.HTTP_404_NOT_FOUND,
+            )
+
+        if action == "accept":
+            invitation.household.users.add(request.user)
+            invitation.accepted = True
+            invitation.save()
+            return Response(
+                {"detail": "You have joined the household"}, status=status.HTTP_200_OK
+            )
+        elif action == "decline":
+            invitation.delete()
+            return Response(
+                {"detail": "You have declined the invitation"},
+                status=status.HTTP_200_OK,
+            )
+
+
 class RemoveUserFromHouseholdView(APIView):
     permission_classes = (IsAuthenticated,)