Implement Feedback submission

backend/.env.example

@@ -4,6 +4,9 @@ DJANGO_ALGOLIA_WRITE_API_KEY=None
 DJANGO_ALLOWED_HOSTS=*
 DJANGO_AWS_ACCESS_KEY_ID=None
 DJANGO_AWS_SECRET_ACCESS_KEY=None
+DJANGO_AWS_STORAGE_BUCKET_NAME=None
+DJANGO_AWS_S3_REGION_NAME=None
+DJANGO_FEEDBACK_SHEET_KEY=None
 DJANGO_CONFIGURATION=Test
 DJANGO_DB_HOST=None
 DJANGO_DB_NAME=None

backend/apps/feedback/admin.py

@@ -0,0 +1 @@
+# Register your models here.

backend/apps/feedback/api/feedback.py

@@ -0,0 +1,95 @@
+"""Handle feedback submission, saving to local DB and uploading to S3."""
+
+import csv
+from datetime import datetime, timezone
+from io import StringIO
+
+import boto3
+import botocore
+from django.conf import settings
+from django.core.exceptions import ValidationError
+from rest_framework import status, viewsets
+from rest_framework.permissions import AllowAny
+from rest_framework.response import Response
+
+
+class FeedbackViewSet(viewsets.ModelViewSet):
+    """ViewSet for handling feedback."""
+
+    permission_classes = [AllowAny]
+
+    def create(self, request):
+        """Handle POST request for feedback submission."""
+        try:
+            s3_client = self._get_s3_client()
+            output, writer = self._get_or_create_tsv(s3_client)
+            self._write_feedback_to_tsv(writer, request.data)
+            self._upload_tsv_to_s3(s3_client, output)
+            return Response(status=status.HTTP_201_CREATED)
+        except ValidationError:
+            return Response({"error": "Invalid Credentials"}, status=status.HTTP_400_BAD_REQUEST)
+
+    def _get_s3_client(self):
+        """Initialize and returns the S3 client."""
+        return boto3.client(
+            "s3",
+            aws_access_key_id=settings.AWS_ACCESS_KEY_ID,
+            aws_secret_access_key=settings.AWS_SECRET_ACCESS_KEY,
+            region_name=settings.AWS_S3_REGION_NAME,
+        )
+
+    def _get_or_create_tsv(self, s3_client, tsv_key="feedbacks.tsv"):
+        """Get the existing TSV file or creates a new one if it doesn't exist."""
+        output = StringIO()
+        writer = csv.writer(output, delimiter="\t")
+
+        try:
+            response = s3_client.get_object(
+                Bucket=settings.AWS_STORAGE_BUCKET_NAME,
+                Key=tsv_key,
+            )
+            # read the content from the body of the response
+            existing_content = response["Body"].read()
+            # decode the content to utf-8 format
+            decoded_content = existing_content.decode("utf-8")
+            # write the decoded content to the output file
+            output.write(decoded_content)
+            # move the cursor to the end of the file
+            output.seek(0, 2)
+        except botocore.exceptions.ClientError as e:
+            if e.response["Error"]["Code"] == "NoSuchKey":
+                writer.writerow(
+                    ["Name", "Email", "Message", "is_anonymous", "is_nestbot", "created_at"]
+                )
+        return output, writer
+
+    def _write_feedback_to_tsv(self, writer, feedback_data):
+        """Write the new feedback data to the TSV file."""
+        writer.writerow(
+            (
+                feedback_data["name"],
+                feedback_data["email"],
+                feedback_data["message"],
+                feedback_data["is_anonymous"],
+                feedback_data["is_nestbot"],
+                datetime.now(timezone.utc).isoformat(),
+            )
+        )
+
+    def _upload_tsv_to_s3(self, s3_client, output):
+        """Upload the updated TSV file back to S3."""
+        output.seek(0)
+        s3_client.put_object(
+            Bucket=settings.AWS_STORAGE_BUCKET_NAME,
+            Key="feedbacks.tsv",
+            Body=output.getvalue(),
+            ContentType="text/tab-separated-values",
+        )
+
+    def write_feedback_to_tsv(self, writer, feedback_data):
+        """Public method to write feedback data to TSV format."""
+        self._write_feedback_to_tsv(writer, feedback_data)
+
+    def get_s3_client(self):
+        """Public method to get the S3 client."""
+        return self._get_s3_client()

backend/apps/feedback/api/urls.py

@@ -0,0 +1,9 @@
+"""Feedback API URLs."""
+
+from rest_framework import routers
+
+from apps.feedback.api.feedback import FeedbackViewSet
+
+router = routers.SimpleRouter()
+
+router.register(r"feedback", FeedbackViewSet, basename="feedback")

backend/apps/feedback/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class FeedbackConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "apps.feedback"

backend/apps/feedback/models/models.py

@@ -0,0 +1 @@
+"""Module contains the models for the feedback app."""