From c63ab0be5add5f37a11c3e8a7de33bb75a3eccae Mon Sep 17 00:00:00 2001
From: Johannes Christ <jc@jchri.st>
Date: Fri, 2 Aug 2024 14:38:47 +0200
Subject: [PATCH] Add endpoint to fetch filters in JSON format

While this is an API endpoint consumed by the bot, keep it in the
`resources` app instead of the `api` app, as all the logic and data for
resources is contained within the `resources` app and we don't want to
start messing around with that.

The response format from the endpoint is as follows:

    {
        "topics": [
            "algorithms-and-data-structures",
            "data-science",
            "databases",
            "discord-bots",
            "game-development",
            "general",
            "microcontrollers",
            "security",
            "software-design",
            "testing",
            "tooling",
            "user-interface",
            "web-development",
            "other"
        ],
        "payment_tiers": [
            "free",
            "paid",
            "subscription"
        ],
        "type": [
            "book",
            "community",
            "course",
            "interactive",
            "podcast",
            "project-ideas",
            "tool",
            "tutorial",
            "video"
        ],
        "difficulty": [
            "beginner",
            "intermediate"
        ]
    }

Closes #710.
---
 pydis_site/apps/resources/tests/test_views.py | 11 +++++++++++
 pydis_site/apps/resources/urls.py             |  3 ++-
 pydis_site/apps/resources/views.py            | 11 ++++++++++-
 3 files changed, 23 insertions(+), 2 deletions(-)

diff --git a/pydis_site/apps/resources/tests/test_views.py b/pydis_site/apps/resources/tests/test_views.py
index a2a203ce9..72c9ed951 100644
--- a/pydis_site/apps/resources/tests/test_views.py
+++ b/pydis_site/apps/resources/tests/test_views.py
@@ -27,3 +27,14 @@ def test_resources_with_invalid_argument(self):
         url = reverse("resources:index", kwargs={"resource_type": "urinal-cake"})
         response = self.client.get(url)
         self.assertEqual(response.status_code, 404)
+
+
+class TestResourceFilterView(TestCase):
+    def test_resource_filter_response(self):
+        """Check that the filter endpoint returns JSON-formatted filters."""
+        url = reverse('resources:filters')
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, 200)
+        content = response.json()
+        self.assertIn('difficulty', content)
+        self.assertIsInstance(content['difficulty'], list)
diff --git a/pydis_site/apps/resources/urls.py b/pydis_site/apps/resources/urls.py
index cb33a9d70..3a10d1083 100644
--- a/pydis_site/apps/resources/urls.py
+++ b/pydis_site/apps/resources/urls.py
@@ -1,11 +1,12 @@
 from django_distill import distill_path
 
-from pydis_site.apps.resources.views import ResourceView
+from pydis_site.apps.resources.views import ResourceView, ResourceFilterView
 
 app_name = "resources"
 urlpatterns = [
     # Using `distill_path` instead of `path` allows this to be available
     # in static preview builds.
     distill_path("", ResourceView.as_view(), name="index"),
+    distill_path("filters", ResourceFilterView.as_view(), name="filters"),
     distill_path("<resource_type>/", ResourceView.as_view(), name="index"),
 ]
diff --git a/pydis_site/apps/resources/views.py b/pydis_site/apps/resources/views.py
index 3632b2e29..6683299f4 100644
--- a/pydis_site/apps/resources/views.py
+++ b/pydis_site/apps/resources/views.py
@@ -2,7 +2,7 @@
 
 from django.apps import apps
 from django.core.handlers.wsgi import WSGIRequest
-from django.http import HttpResponse, HttpResponseNotFound
+from django.http import HttpResponse, HttpResponseNotFound, JsonResponse
 from django.shortcuts import render
 from django.views import View
 
@@ -38,3 +38,12 @@ def get(self, request: WSGIRequest, resource_type: str | None = None) -> HttpRes
                 "resource_type": resource_type,
             }
         )
+
+
+class ResourceFilterView(View):
+    """Exposes resource filters for the bot."""
+
+    def get(self, request: WSGIRequest) -> HttpResponse:
+        """Return resource filters as JSON."""
+        app = apps.get_app_config(APP_NAME)
+        return JsonResponse(app.valid_filters)