Merge branch 'master' into feat/timeline

6 files changed, 136 insertions, 155 deletions

diff --git a/pydis_site/apps/api/viewsets/__init__.py b/pydis_site/apps/api/viewsets/__init__.py
index 8699517e..f133e77f 100644
--- a/pydis_site/apps/api/viewsets/__init__.py
+++ b/pydis_site/apps/api/viewsets/__init__.py
@@ -10,7 +10,5 @@ from .bot import (
     OffTopicChannelNameViewSet,
     ReminderViewSet,
     RoleViewSet,
-    TagViewSet,
     UserViewSet
 )
-from .log_entry import LogEntryViewSet
diff --git a/pydis_site/apps/api/viewsets/bot/__init__.py b/pydis_site/apps/api/viewsets/bot/__init__.py
index e64e3988..84b87eab 100644
--- a/pydis_site/apps/api/viewsets/bot/__init__.py
+++ b/pydis_site/apps/api/viewsets/bot/__init__.py
@@ -9,5 +9,4 @@ from .off_topic_channel_name import OffTopicChannelNameViewSet
 from .offensive_message import OffensiveMessageViewSet
 from .reminder import ReminderViewSet
 from .role import RoleViewSet
-from .tag import TagViewSet
 from .user import UserViewSet
diff --git a/pydis_site/apps/api/viewsets/bot/off_topic_channel_name.py b/pydis_site/apps/api/viewsets/bot/off_topic_channel_name.py
index d6da2399..826ad25e 100644
--- a/pydis_site/apps/api/viewsets/bot/off_topic_channel_name.py
+++ b/pydis_site/apps/api/viewsets/bot/off_topic_channel_name.py
@@ -1,3 +1,4 @@
+from django.db.models import Case, Value, When
 from django.db.models.query import QuerySet
 from django.http.request import HttpRequest
 from django.shortcuts import get_object_or_404
@@ -20,7 +21,9 @@ class OffTopicChannelNameViewSet(DestroyModelMixin, ViewSet):
     Return all known off-topic channel names from the database.
     If the `random_items` query parameter is given, for example using...
         $ curl api.pythondiscord.local:8000/bot/off-topic-channel-names?random_items=5
-    ... then the API will return `5` random items from the database.
+    ... then the API will return `5` random items from the database
+    that is not used in current rotation.
+    When running out of names, API will mark all names to not used and start new rotation.
 
     #### Response format
     Return a list of off-topic-channel names:
@@ -106,7 +109,27 @@ class OffTopicChannelNameViewSet(DestroyModelMixin, ViewSet):
                     'random_items': ["Must be a positive integer."]
                 })
 
-            queryset = self.get_queryset().order_by('?')[:random_count]
+            queryset = self.get_queryset().order_by('used', '?')[:random_count]
+
+            # When any name is used in our listing then this means we reached end of round
+            # and we need to reset all other names `used` to False
+            if any(offtopic_name.used for offtopic_name in queryset):
+                # These names that we just got have to be excluded from updating used to False
+                self.get_queryset().update(
+                    used=Case(
+                        When(
+                            name__in=(offtopic_name.name for offtopic_name in queryset),
+                            then=Value(True)
+                        ),
+                        default=Value(False)
+                    )
+                )
+            else:
+                # Otherwise mark selected names `used` to True
+                self.get_queryset().filter(
+                    name__in=(offtopic_name.name for offtopic_name in queryset)
+                ).update(used=True)
+
             serialized = self.serializer_class(queryset, many=True)
             return Response(serialized.data)
 
diff --git a/pydis_site/apps/api/viewsets/bot/tag.py b/pydis_site/apps/api/viewsets/bot/tag.py
deleted file mode 100644
index 7e9ba117..00000000
--- a/pydis_site/apps/api/viewsets/bot/tag.py
+++ /dev/null
@@ -1,105 +0,0 @@
-from rest_framework.viewsets import ModelViewSet
-
-from pydis_site.apps.api.models.bot.tag import Tag
-from pydis_site.apps.api.serializers import TagSerializer
-
-
-class TagViewSet(ModelViewSet):
-    """
-    View providing CRUD operations on tags shown by our bot.
-
-    ## Routes
-    ### GET /bot/tags
-    Returns all tags in the database.
-
-    #### Response format
-    >>> [
-    ...     {
-    ...         'title': "resources",
-    ...         'embed': {
-    ...             'content': "Did you really think I'd put something useful here?"
-    ...         }
-    ...     }
-    ... ]
-
-    #### Status codes
-    - 200: returned on success
-
-    ### GET /bot/tags/<title:str>
-    Gets a single tag by its title.
-
-    #### Response format
-    >>> {
-    ...     'title': "My awesome tag",
-    ...     'embed': {
-    ...         'content': "totally not filler words"
-    ...     }
-    ... }
-
-    #### Status codes
-    - 200: returned on success
-    - 404: if a tag with the given `title` could not be found
-
-    ### POST /bot/tags
-    Adds a single tag to the database.
-
-    #### Request body
-    >>> {
-    ...     'title': str,
-    ...     'embed': dict
-    ... }
-
-    The embed structure is the same as the embed structure that the Discord API
-    expects. You can view the documentation for it here:
-        https://discordapp.com/developers/docs/resources/channel#embed-object
-
-    #### Status codes
-    - 201: returned on success
-    - 400: if one of the given fields is invalid
-
-    ### PUT /bot/tags/<title:str>
-    Update the tag with the given `title`.
-
-    #### Request body
-    >>> {
-    ...     'title': str,
-    ...     'embed': dict
-    ... }
-
-    The embed structure is the same as the embed structure that the Discord API
-    expects. You can view the documentation for it here:
-        https://discordapp.com/developers/docs/resources/channel#embed-object
-
-    #### Status codes
-    - 200: returned on success
-    - 400: if the request body was invalid, see response body for details
-    - 404: if the tag with the given `title` could not be found
-
-    ### PATCH /bot/tags/<title:str>
-    Update the tag with the given `title`.
-
-    #### Request body
-    >>> {
-    ...     'title': str,
-    ...     'embed': dict
-    ... }
-
-    The embed structure is the same as the embed structure that the Discord API
-    expects. You can view the documentation for it here:
-        https://discordapp.com/developers/docs/resources/channel#embed-object
-
-    #### Status codes
-    - 200: returned on success
-    - 400: if the request body was invalid, see response body for details
-    - 404: if the tag with the given `title` could not be found
-
-    ### DELETE /bot/tags/<title:str>
-    Deletes the tag with the given `title`.
-
-    #### Status codes
-    - 204: returned on success
-    - 404: if a tag with the given `title` does not exist
-    """
-
-    serializer_class = TagSerializer
-    queryset = Tag.objects.all()
diff --git a/pydis_site/apps/api/viewsets/bot/user.py b/pydis_site/apps/api/viewsets/bot/user.py
index 9571b3d7..3e4b627e 100644
--- a/pydis_site/apps/api/viewsets/bot/user.py
+++ b/pydis_site/apps/api/viewsets/bot/user.py
@@ -1,21 +1,64 @@
+import typing
+from collections import OrderedDict
+
+from rest_framework import status
+from rest_framework.decorators import action
+from rest_framework.pagination import PageNumberPagination
+from rest_framework.request import Request
+from rest_framework.response import Response
+from rest_framework.serializers import ModelSerializer
 from rest_framework.viewsets import ModelViewSet
-from rest_framework_bulk import BulkCreateModelMixin
 
 from pydis_site.apps.api.models.bot.user import User
 from pydis_site.apps.api.serializers import UserSerializer
 
 
-class UserViewSet(BulkCreateModelMixin, ModelViewSet):
+class UserListPagination(PageNumberPagination):
+    """Custom pagination class for the User Model."""
+
+    page_size = 10000
+    page_size_query_param = "page_size"
+
+    def get_next_page_number(self) -> typing.Optional[int]:
+        """Get the next page number."""
+        if not self.page.has_next():
+            return None
+        page_number = self.page.next_page_number()
+        return page_number
+
+    def get_previous_page_number(self) -> typing.Optional[int]:
+        """Get the previous page number."""
+        if not self.page.has_previous():
+            return None
+
+        page_number = self.page.previous_page_number()
+        return page_number
+
+    def get_paginated_response(self, data: list) -> Response:
+        """Override method to send modified response."""
+        return Response(OrderedDict([
+            ('count', self.page.paginator.count),
+            ('next_page_no', self.get_next_page_number()),
+            ('previous_page_no', self.get_previous_page_number()),
+            ('results', data)
+        ]))
+
+
+class UserViewSet(ModelViewSet):
     """
     View providing CRUD operations on Discord users through the bot.
 
     ## Routes
     ### GET /bot/users
-    Returns all users currently known.
+    Returns all users currently known with pagination.
 
     #### Response format
-    >>> [
-    ...     {
+    >>> {
+    ...     'count': 95000,
+    ...     'next_page_no': "2",
+    ...     'previous_page_no': None,
+    ...     'results': [
+    ...      {
     ...         'id': 409107086526644234,
     ...         'name': "Python",
     ...         'discriminator': 4329,
@@ -26,8 +69,13 @@ class UserViewSet(BulkCreateModelMixin, ModelViewSet):
     ...             458226699344019457
     ...         ],
     ...         'in_guild': True
-    ...     }
-    ... ]
+    ...     },
+    ...     ]
+    ... }
+
+    #### Optional Query Parameters
+    - page_size: number of Users in one page, defaults to 10,000
+    - page: page number
 
     #### Status codes
     - 200: returned on success
@@ -56,6 +104,7 @@ class UserViewSet(BulkCreateModelMixin, ModelViewSet):
     ### POST /bot/users
     Adds a single or multiple new users.
     The roles attached to the user(s) must be roles known by the site.
+    Users that already exist in the database will be skipped.
 
     #### Request body
     >>> {
@@ -67,11 +116,13 @@ class UserViewSet(BulkCreateModelMixin, ModelViewSet):
     ... }
 
     Alternatively, request users can be POSTed as a list of above objects,
-    in which case multiple users will be created at once.
+    in which case multiple users will be created at once. In this case,
+    the response is an empty list.
 
     #### Status codes
     - 201: returned on success
     - 400: if one of the given roles does not exist, or one of the given fields is invalid
+    - 400: if multiple user objects with the same id are given
 
     ### PUT /bot/users/<snowflake:int>
     Update the user with the given `snowflake`.
@@ -109,6 +160,34 @@ class UserViewSet(BulkCreateModelMixin, ModelViewSet):
     - 400: if the request body was invalid, see response body for details
     - 404: if the user with the given `snowflake` could not be found
 
+    ### BULK PATCH /bot/users/bulk_patch
+    Update users with the given `ids` and `details`.
+    `id` field and at least one other field is mandatory.
+
+    #### Request body
+    >>> [
+    ...     {
+    ...         'id': int,
+    ...         'name': str,
+    ...         'discriminator': int,
+    ...         'roles': List[int],
+    ...         'in_guild': bool
+    ...     },
+    ...     {
+    ...         'id': int,
+    ...         'name': str,
+    ...         'discriminator': int,
+    ...         'roles': List[int],
+    ...         'in_guild': bool
+    ...     },
+    ... ]
+
+    #### Status codes
+    - 200: returned on success
+    - 400: if the request body was invalid, see response body for details
+    - 400: if multiple user objects with the same id are given
+    - 404: if the user with the given id does not exist
+
     ### DELETE /bot/users/<snowflake:int>
     Deletes the user with the given `snowflake`.
 
@@ -118,4 +197,27 @@ class UserViewSet(BulkCreateModelMixin, ModelViewSet):
     """
 
     serializer_class = UserSerializer
-    queryset = User.objects
+    queryset = User.objects.all().order_by("id")
+    pagination_class = UserListPagination
+
+    def get_serializer(self, *args, **kwargs) -> ModelSerializer:
+        """Set Serializer many attribute to True if request body contains a list."""
+        if isinstance(kwargs.get('data', {}), list):
+            kwargs['many'] = True
+
+        return super().get_serializer(*args, **kwargs)
+
+    @action(detail=False, methods=["PATCH"], name='user-bulk-patch')
+    def bulk_patch(self, request: Request) -> Response:
+        """Update multiple User objects in a single request."""
+        serializer = self.get_serializer(
+            instance=self.get_queryset(),
+            data=request.data,
+            many=True,
+            partial=True
+        )
+
+        serializer.is_valid(raise_exception=True)
+        serializer.save()
+
+        return Response(serializer.data, status=status.HTTP_200_OK)
diff --git a/pydis_site/apps/api/viewsets/log_entry.py b/pydis_site/apps/api/viewsets/log_entry.py
deleted file mode 100644
index 9108a4fa..00000000
--- a/pydis_site/apps/api/viewsets/log_entry.py
+++ /dev/null
@@ -1,36 +0,0 @@
-from rest_framework.mixins import CreateModelMixin
-from rest_framework.viewsets import GenericViewSet
-
-from pydis_site.apps.api.models.log_entry import LogEntry
-from pydis_site.apps.api.serializers import LogEntrySerializer
-
-
-class LogEntryViewSet(CreateModelMixin, GenericViewSet):
-    """
-    View supporting the creation of log entries in the database for viewing via the log browser.
-
-    ## Routes
-    ### POST /logs
-    Create a new log entry.
-
-    #### Request body
-    >>> {
-    ...     'application': str,  # 'bot' | 'seasonalbot' | 'site'
-    ...     'logger_name': str,  # such as 'bot.cogs.moderation'
-    ...     'timestamp': Optional[str],  # from `datetime.utcnow().isoformat()`
-    ...     'level': str,  # 'debug' | 'info' | 'warning' | 'error' | 'critical'
-    ...     'module': str,  # such as 'pydis_site.apps.api.serializers'
-    ...     'line': int,  # > 0
-    ...     'message': str,  # textual formatted content of the logline
-    ... }
-
-    #### Status codes
-    - 201: returned on success
-    - 400: if the request body has invalid fields, see the response for details
-
-    ## Authentication
-    Requires a API token.
-    """
-
-    queryset = LogEntry.objects.all()
-    serializer_class = LogEntrySerializer