Create a PackageListing Report API

Create an API for reporting PackageListings (creating a PackageReport)

Author: x753

django/thunderstore/community/api/experimental/serializers.py

@@ -4,6 +4,8 @@
 from thunderstore.repository.api.experimental.serializers import (
     CommunityFilteredModelChoiceField,
 )
+from thunderstore.repository.models import PackageVersion
+from thunderstore.repository.serializer_fields import ModelChoiceField
 
 
 class PackageListingUpdateRequestSerializer(serializers.Serializer):
@@ -16,6 +18,22 @@ class PackageListingUpdateRequestSerializer(serializers.Serializer):
     )
 
 
+class PackageListingReportRequestSerializer(serializers.Serializer):
+    package_version_id = ModelChoiceField(
+        PackageVersion.objects.all(), "pk", required=True
+    )
+    reason = serializers.CharField(
+        required=True,
+        allow_blank=False,
+        allow_null=False,
+    )
+    description = serializers.CharField(
+        required=False,
+        allow_blank=True,
+        allow_null=True,
+    )
+
+
 class PackageCategoryExperimentalSerializer(serializers.Serializer):
     name = serializers.CharField()
     slug = serializers.SlugField()

django/thunderstore/community/api/experimental/urls.py

@@ -10,6 +10,7 @@
 from thunderstore.community.api.experimental.views.listing import (
     PackageListingApproveApiView,
     PackageListingRejectApiView,
+    PackageListingReportApiView,
     PackageListingUpdateApiView,
 )
 
@@ -44,4 +45,9 @@
         PackageListingRejectApiView.as_view(),
         name="package-listing.reject",
     ),
+    path(
+        "package-listing/<int:pk>/report/",
+        PackageListingReportApiView.as_view(),
+        name="package-listing.report",
+    ),
 ]

django/thunderstore/community/api/experimental/views/listing.py

@@ -2,14 +2,18 @@
 from rest_framework import serializers, status
 from rest_framework.exceptions import PermissionDenied
 from rest_framework.generics import GenericAPIView
+from rest_framework.permissions import IsAuthenticated
 from rest_framework.response import Response
 
 from thunderstore.community.api.experimental.serializers import (
+    PackageListingReportRequestSerializer,
     PackageListingUpdateRequestSerializer,
     PackageListingUpdateResponseSerializer,
 )
 from thunderstore.community.models import PackageListing
+from thunderstore.repository.models import Package, PackageVersion
 from thunderstore.repository.views.package._utils import get_package_listing_or_404
+from thunderstore.ts_reports.models import PackageReport
 
 
 class PackageListingUpdateApiView(GenericAPIView):
@@ -126,3 +130,38 @@ def post(self, request, *args, **kwargs):
             return Response(status=status.HTTP_200_OK)
         except PermissionError:
             raise PermissionDenied()
+
+
+class PackageListingReportApiView(GenericAPIView):
+    queryset = PackageListing.objects.active().select_related(
+        "package",
+    )
+    serializer_class = PackageListingReportRequestSerializer
+    permission_classes = [IsAuthenticated]
+
+    @swagger_auto_schema(
+        operation_id="experimental.package_listing.report",
+        request_body=PackageListingReportRequestSerializer,
+        responses={200: "Success"},
+        tags=["experimental"],
+    )
+    def post(self, request, *args, **kwargs):
+        serializer = self.get_serializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+
+        listing: PackageListing = self.get_object()
+        package: Package = listing.package
+        version: PackageVersion = serializer.validated_data["package_version_id"]
+
+        try:
+            PackageReport.handle_user_report(
+                reason=serializer.validated_data["reason"],
+                submitted_by=request.user,
+                package=package,
+                package_listing=listing,
+                package_version=version,
+                description=serializer.validated_data["description"],
+            )
+            return Response(status=status.HTTP_200_OK)
+        except PermissionError:
+            raise PermissionDenied()

django/thunderstore/ts_reports/models/package_report.py

@@ -57,7 +57,6 @@ def __str__(self):
     @classmethod
     def handle_user_report(
         cls,
-        category: str,
         reason: str,
         submitted_by: UserType,
         package: Package,
@@ -66,7 +65,7 @@ def handle_user_report(
         description: Optional[str],
     ) -> "PackageReport":
         return cls.objects.create(
-            category=category,
+            category="UserReport",
             reason=reason,
             submitted_by=submitted_by,
             package=package,