Merge #663 - bumped threads endpoint

Author: MarkKoz

pydis_site/apps/api/migrations/0081_bumpedthread.py

@@ -0,0 +1,22 @@
+# Generated by Django 3.1.14 on 2022-02-19 16:26
+
+import django.core.validators
+from django.db import migrations, models
+import pydis_site.apps.api.models.mixins
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0080_add_aoc_tables'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='BumpedThread',
+            fields=[
+                ('thread_id', models.BigIntegerField(help_text='The thread ID that should be bumped.', primary_key=True, serialize=False, validators=[django.core.validators.MinValueValidator(limit_value=0, message='Thread IDs cannot be negative.')], verbose_name='Thread ID')),
+            ],
+            bases=(pydis_site.apps.api.models.mixins.ModelReprMixin, models.Model),
+        ),
+    ]

pydis_site/apps/api/models/__init__.py

@@ -1,9 +1,10 @@
 # flake8: noqa
 from .bot import (
-    FilterList,
     BotSetting,
+    BumpedThread,
     DocumentationLink,
     DeletedMessage,
+    FilterList,
     Infraction,
     Message,
     MessageDeletionContext,

pydis_site/apps/api/models/bot/__init__.py

@@ -1,8 +1,9 @@
 # flake8: noqa
-from .filter_list import FilterList
 from .bot_setting import BotSetting
+from .bumped_thread import BumpedThread
 from .deleted_message import DeletedMessage
 from .documentation_link import DocumentationLink
+from .filter_list import FilterList
 from .infraction import Infraction
 from .message import Message
 from .aoc_completionist_block import AocCompletionistBlock

pydis_site/apps/api/models/bot/bumped_thread.py

@@ -0,0 +1,22 @@
+from django.core.validators import MinValueValidator
+from django.db import models
+
+from pydis_site.apps.api.models.mixins import ModelReprMixin
+
+
+class BumpedThread(ModelReprMixin, models.Model):
+    """A list of thread IDs to be bumped."""
+
+    thread_id = models.BigIntegerField(
+        primary_key=True,
+        help_text=(
+            "The thread ID that should be bumped."
+        ),
+        validators=(
+            MinValueValidator(
+                limit_value=0,
+                message="Thread IDs cannot be negative."
+            ),
+        ),
+        verbose_name="Thread ID",
+    )

pydis_site/apps/api/serializers.py

@@ -16,6 +16,7 @@
     AocAccountLink,
     AocCompletionistBlock,
     BotSetting,
+    BumpedThread,
     DeletedMessage,
     DocumentationLink,
     FilterList,
@@ -41,6 +42,32 @@ class Meta:
         fields = ('name', 'data')
 
 
+class ListBumpedThreadSerializer(ListSerializer):
+    """Custom ListSerializer to override to_representation() when list views are triggered."""
+
+    def to_representation(self, objects: list[BumpedThread]) -> int:
+        """
+        Used by the `ListModelMixin` to return just the list of bumped thread ids.
+
+        Only the thread_id field is useful, hence it is unnecessary to create a nested dictionary.
+
+        Additionally, this allows bumped thread routes to simply return an
+        array of thread_id ints instead of objects, saving on bandwidth.
+        """
+        return [obj.thread_id for obj in objects]
+
+
+class BumpedThreadSerializer(ModelSerializer):
+    """A class providing (de-)serialization of `BumpedThread` instances."""
+
+    class Meta:
+        """Metadata defined for the Django REST Framework."""
+
+        list_serializer_class = ListBumpedThreadSerializer
+        model = BumpedThread
+        fields = ('thread_id',)
+
+
 class DeletedMessageSerializer(ModelSerializer):
     """
     A class providing (de-)serialization of `DeletedMessage` instances.

pydis_site/apps/api/tests/test_bumped_threads.py

@@ -0,0 +1,63 @@
+from django.urls import reverse
+
+from .base import AuthenticatedAPITestCase
+from ..models import BumpedThread
+
+
+class UnauthedBumpedThreadAPITests(AuthenticatedAPITestCase):
+    def setUp(self):
+        super().setUp()
+        self.client.force_authenticate(user=None)
+
+    def test_detail_lookup_returns_401(self):
+        url = reverse('api:bot:bumpedthread-detail', args=(1,))
+        response = self.client.get(url)
+
+        self.assertEqual(response.status_code, 401)
+
+    def test_list_returns_401(self):
+        url = reverse('api:bot:bumpedthread-list')
+        response = self.client.get(url)
+
+        self.assertEqual(response.status_code, 401)
+
+    def test_create_returns_401(self):
+        url = reverse('api:bot:bumpedthread-list')
+        response = self.client.post(url, {"thread_id": 3})
+
+        self.assertEqual(response.status_code, 401)
+
+    def test_delete_returns_401(self):
+        url = reverse('api:bot:bumpedthread-detail', args=(1,))
+        response = self.client.delete(url)
+
+        self.assertEqual(response.status_code, 401)
+
+
+class BumpedThreadAPITests(AuthenticatedAPITestCase):
+    @classmethod
+    def setUpTestData(cls):
+        cls.thread1 = BumpedThread.objects.create(
+            thread_id=1234,
+        )
+
+    def test_returns_bumped_threads_as_flat_list(self):
+        url = reverse('api:bot:bumpedthread-list')
+
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), [1234])
+
+    def test_returns_204_for_existing_data(self):
+        url = reverse('api:bot:bumpedthread-detail', args=(1234,))
+
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, 204)
+        self.assertEqual(response.content, b"")
+
+    def test_returns_404_for_non_existing_data(self):
+        url = reverse('api:bot:bumpedthread-detail', args=(42,))
+
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, 404)
+        self.assertEqual(response.json(), {"detail": "Not found."})

pydis_site/apps/api/urls.py

@@ -6,6 +6,7 @@
     AocAccountLinkViewSet,
     AocCompletionistBlockViewSet,
     BotSettingViewSet,
+    BumpedThreadViewSet,
     DeletedMessageViewSet,
     DocumentationLinkViewSet,
     FilterListViewSet,
@@ -21,13 +22,21 @@
 # https://www.django-rest-framework.org/api-guide/routers/#defaultrouter
 bot_router = DefaultRouter(trailing_slash=False)
 bot_router.register(
-    'filter-lists',
-    FilterListViewSet
+    "aoc-account-links",
+    AocAccountLinkViewSet
+)
+bot_router.register(
+    "aoc-completionist-blocks",
+    AocCompletionistBlockViewSet
 )
 bot_router.register(
     'bot-settings',
     BotSettingViewSet
 )
+bot_router.register(
+    'bumped-threads',
+    BumpedThreadViewSet
+)
 bot_router.register(
     'deleted-messages',
     DeletedMessageViewSet
@@ -37,12 +46,8 @@
     DocumentationLinkViewSet
 )
 bot_router.register(
-    "aoc-account-links",
-    AocAccountLinkViewSet
-)
-bot_router.register(
-    "aoc-completionist-blocks",
-    AocCompletionistBlockViewSet
+    'filter-lists',
+    FilterListViewSet
 )
 bot_router.register(
     'infractions',

pydis_site/apps/api/viewsets/__init__.py

@@ -1,9 +1,10 @@
 # flake8: noqa
 from .bot import (
-    FilterListViewSet,
     BotSettingViewSet,
+    BumpedThreadViewSet,
     DeletedMessageViewSet,
     DocumentationLinkViewSet,
+    FilterListViewSet,
     InfractionViewSet,
     NominationViewSet,
     OffensiveMessageViewSet,

pydis_site/apps/api/viewsets/bot/__init__.py

@@ -1,6 +1,7 @@
 # flake8: noqa
 from .filter_list import FilterListViewSet
 from .bot_setting import BotSettingViewSet
+from .bumped_thread import BumpedThreadViewSet
 from .deleted_message import DeletedMessageViewSet
 from .documentation_link import DocumentationLinkViewSet
 from .infraction import InfractionViewSet

pydis_site/apps/api/viewsets/bot/bumped_thread.py

@@ -0,0 +1,66 @@
+from rest_framework.mixins import (
+    CreateModelMixin, DestroyModelMixin, ListModelMixin
+)
+from rest_framework.request import Request
+from rest_framework.response import Response
+from rest_framework.viewsets import GenericViewSet
+
+from pydis_site.apps.api.models.bot import BumpedThread
+from pydis_site.apps.api.serializers import BumpedThreadSerializer
+
+
+class BumpedThreadViewSet(
+    GenericViewSet, CreateModelMixin, DestroyModelMixin, ListModelMixin
+):
+    """
+    View providing CRUD (Minus the U) operations on threads to be bumped.
+
+    ## Routes
+    ### GET /bot/bumped-threads
+    Returns all BumpedThread items in the database.
+
+    #### Response format
+    >>> list[int]
+
+    #### Status codes
+    - 200: returned on success
+    - 401: returned if unauthenticated
+
+    ### GET /bot/bumped-threads/<thread_id:int>
+    Returns whether a specific BumpedThread exists in the database.
+
+    #### Status codes
+    - 204: returned on success
+    - 404: returned if a BumpedThread with the given thread_id was not found.
+
+    ### POST /bot/bumped-threads
+    Adds a single BumpedThread item to the database.
+
+    #### Request body
+    >>> {
+    ...    'thread_id': int,
+    ... }
+
+    #### Status codes
+    - 201: returned on success
+    - 400: if one of the given fields is invalid
+
+    ### DELETE /bot/bumped-threads/<thread_id:int>
+    Deletes the BumpedThread item with the given `thread_id`.
+
+    #### Status codes
+    - 204: returned on success
+    - 404: if a BumpedThread with the given `thread_id` does not exist
+    """
+
+    serializer_class = BumpedThreadSerializer
+    queryset = BumpedThread.objects.all()
+
+    def retrieve(self, request: Request, *args, **kwargs) -> Response:
+        """
+        DRF method for checking if the given BumpedThread exists.
+
+        Called by the Django Rest Framework in response to the corresponding HTTP request.
+        """
+        self.get_object()
+        return Response(status=204)