From a6b8c27e68b529b1060b1213b465457c5c0d685a Mon Sep 17 00:00:00 2001
From: D0rs4n <41237606+D0rs4n@users.noreply.github.com>
Date: Mon, 7 Mar 2022 20:18:18 +0100
Subject: Add support for storing AoC related data in site

---
 pydis_site/apps/api/models/__init__.py              |  2 ++
 pydis_site/apps/api/models/bot/__init__.py          |  2 ++
 .../apps/api/models/bot/aoc_completionist_block.py  | 21 +++++++++++++++++++++
 pydis_site/apps/api/models/bot/aoc_link.py          | 20 ++++++++++++++++++++
 4 files changed, 45 insertions(+)
 create mode 100644 pydis_site/apps/api/models/bot/aoc_completionist_block.py
 create mode 100644 pydis_site/apps/api/models/bot/aoc_link.py

(limited to 'pydis_site/apps/api/models')

diff --git a/pydis_site/apps/api/models/__init__.py b/pydis_site/apps/api/models/__init__.py
index fd5bf220..4f616986 100644
--- a/pydis_site/apps/api/models/__init__.py
+++ b/pydis_site/apps/api/models/__init__.py
@@ -10,6 +10,8 @@ from .bot import (
     Nomination,
     NominationEntry,
     OffensiveMessage,
+    AocAccountLink,
+    AocCompletionistBlock,
     OffTopicChannelName,
     Reminder,
     Role,
diff --git a/pydis_site/apps/api/models/bot/__init__.py b/pydis_site/apps/api/models/bot/__init__.py
index ac864de3..ec0e701c 100644
--- a/pydis_site/apps/api/models/bot/__init__.py
+++ b/pydis_site/apps/api/models/bot/__init__.py
@@ -5,6 +5,8 @@ from .deleted_message import DeletedMessage
 from .documentation_link import DocumentationLink
 from .infraction import Infraction
 from .message import Message
+from .aoc_completionist_block import AocCompletionistBlock
+from .aoc_link import AocAccountLink
 from .message_deletion_context import MessageDeletionContext
 from .nomination import Nomination, NominationEntry
 from .off_topic_channel_name import OffTopicChannelName
diff --git a/pydis_site/apps/api/models/bot/aoc_completionist_block.py b/pydis_site/apps/api/models/bot/aoc_completionist_block.py
new file mode 100644
index 00000000..cac41ff1
--- /dev/null
+++ b/pydis_site/apps/api/models/bot/aoc_completionist_block.py
@@ -0,0 +1,21 @@
+from django.db import models
+
+from pydis_site.apps.api.models.bot.user import User
+from pydis_site.apps.api.models.mixins import ModelReprMixin
+
+
+class AocCompletionistBlock(ModelReprMixin, models.Model):
+    """A Discord user blocked from getting the AoC completionist Role."""
+
+    user = models.ForeignKey(
+        User,
+        on_delete=models.CASCADE,
+        help_text="The user that is blocked from getting the AoC Completionist Role"
+    )
+
+    is_blocked = models.BooleanField(
+        default=True,
+        help_text="Whether this user is actively being blocked "
+                  "from getting the AoC Completionist Role",
+        verbose_name="Blocked"
+    )
diff --git a/pydis_site/apps/api/models/bot/aoc_link.py b/pydis_site/apps/api/models/bot/aoc_link.py
new file mode 100644
index 00000000..6c7cc591
--- /dev/null
+++ b/pydis_site/apps/api/models/bot/aoc_link.py
@@ -0,0 +1,20 @@
+from django.db import models
+
+from pydis_site.apps.api.models.bot.user import User
+from pydis_site.apps.api.models.mixins import ModelReprMixin
+
+
+class AocAccountLink(ModelReprMixin, models.Model):
+    """An AoC account link for a Discord User."""
+
+    user = models.ForeignKey(
+        User,
+        on_delete=models.CASCADE,
+        help_text="The user that is blocked from getting the AoC Completionist Role"
+    )
+
+    aoc_username = models.CharField(
+        max_length=120,
+        help_text="The AoC username associated with the Discord User.",
+        blank=False
+    )
-- 
cgit v1.2.3


From 19c6e7b66cf5078a198f4a70fec38d66dd029564 Mon Sep 17 00:00:00 2001
From: D0rs4n <41237606+D0rs4n@users.noreply.github.com>
Date: Tue, 8 Mar 2022 15:54:34 +0100
Subject: Enhance comments and table structure in AoC related modules

- Set the user reference to be a OneToOne relation, on tables: AocCompletionistBlock and  AocAccountLink.
---
 pydis_site/apps/api/migrations/0080_add_aoc_tables.py       | 4 ++--
 pydis_site/apps/api/models/bot/aoc_completionist_block.py   | 2 +-
 pydis_site/apps/api/models/bot/aoc_link.py                  | 2 +-
 pydis_site/apps/api/viewsets/bot/aoc_completionist_block.py | 4 ++--
 pydis_site/apps/api/viewsets/bot/aoc_link.py                | 4 ++--
 5 files changed, 8 insertions(+), 8 deletions(-)

(limited to 'pydis_site/apps/api/models')

diff --git a/pydis_site/apps/api/migrations/0080_add_aoc_tables.py b/pydis_site/apps/api/migrations/0080_add_aoc_tables.py
index f129d86f..c58a5d29 100644
--- a/pydis_site/apps/api/migrations/0080_add_aoc_tables.py
+++ b/pydis_site/apps/api/migrations/0080_add_aoc_tables.py
@@ -17,7 +17,7 @@ class Migration(migrations.Migration):
             fields=[
                 ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('is_blocked', models.BooleanField(default=True, help_text='Whether this user is actively being blocked from getting the AoC Completionist Role', verbose_name='Blocked')),
-                ('user', models.ForeignKey(help_text='The user that is blocked from getting the AoC Completionist Role', on_delete=django.db.models.deletion.CASCADE, to='api.user')),
+                ('user', models.OneToOneField(help_text='The user that is blocked from getting the AoC Completionist Role', on_delete=django.db.models.deletion.CASCADE, to='api.user')),
             ],
             bases=(pydis_site.apps.api.models.mixins.ModelReprMixin, models.Model),
         ),
@@ -26,7 +26,7 @@ class Migration(migrations.Migration):
             fields=[
                 ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('aoc_username', models.CharField(help_text='The AoC username associated with the Discord User.', max_length=120)),
-                ('user', models.ForeignKey(help_text='The user that is blocked from getting the AoC Completionist Role', on_delete=django.db.models.deletion.CASCADE, to='api.user')),
+                ('user', models.OneToOneField(help_text='The user that is blocked from getting the AoC Completionist Role', on_delete=django.db.models.deletion.CASCADE, to='api.user')),
             ],
             bases=(pydis_site.apps.api.models.mixins.ModelReprMixin, models.Model),
         ),
diff --git a/pydis_site/apps/api/models/bot/aoc_completionist_block.py b/pydis_site/apps/api/models/bot/aoc_completionist_block.py
index cac41ff1..a89f9760 100644
--- a/pydis_site/apps/api/models/bot/aoc_completionist_block.py
+++ b/pydis_site/apps/api/models/bot/aoc_completionist_block.py
@@ -7,7 +7,7 @@ from pydis_site.apps.api.models.mixins import ModelReprMixin
 class AocCompletionistBlock(ModelReprMixin, models.Model):
     """A Discord user blocked from getting the AoC completionist Role."""
 
-    user = models.ForeignKey(
+    user = models.OneToOneField(
         User,
         on_delete=models.CASCADE,
         help_text="The user that is blocked from getting the AoC Completionist Role"
diff --git a/pydis_site/apps/api/models/bot/aoc_link.py b/pydis_site/apps/api/models/bot/aoc_link.py
index 6c7cc591..9b47456d 100644
--- a/pydis_site/apps/api/models/bot/aoc_link.py
+++ b/pydis_site/apps/api/models/bot/aoc_link.py
@@ -7,7 +7,7 @@ from pydis_site.apps.api.models.mixins import ModelReprMixin
 class AocAccountLink(ModelReprMixin, models.Model):
     """An AoC account link for a Discord User."""
 
-    user = models.ForeignKey(
+    user = models.OneToOneField(
         User,
         on_delete=models.CASCADE,
         help_text="The user that is blocked from getting the AoC Completionist Role"
diff --git a/pydis_site/apps/api/viewsets/bot/aoc_completionist_block.py b/pydis_site/apps/api/viewsets/bot/aoc_completionist_block.py
index 53bcb546..c5568129 100644
--- a/pydis_site/apps/api/viewsets/bot/aoc_completionist_block.py
+++ b/pydis_site/apps/api/viewsets/bot/aoc_completionist_block.py
@@ -47,8 +47,8 @@ class AocCompletionistBlockViewSet(
 
     #### Request body
     >>> {
-    ... 'user': int,
-    ... 'is_blocked': bool
+    ...     'user': int,
+    ...     'is_blocked': bool
     ... }
 
     #### Status codes
diff --git a/pydis_site/apps/api/viewsets/bot/aoc_link.py b/pydis_site/apps/api/viewsets/bot/aoc_link.py
index b5b5420e..263b548d 100644
--- a/pydis_site/apps/api/viewsets/bot/aoc_link.py
+++ b/pydis_site/apps/api/viewsets/bot/aoc_link.py
@@ -47,8 +47,8 @@ class AocAccountLinkViewSet(
 
     #### Request body
     >>> {
-    ... 'user': int,
-    ... 'aoc_username': str
+    ...     'user': int,
+    ...     'aoc_username': str
     ... }
 
     #### Status codes
-- 
cgit v1.2.3


From b93dce5abcf225579b9407358f938ca3932e67a2 Mon Sep 17 00:00:00 2001
From: D0rs4n <41237606+D0rs4n@users.noreply.github.com>
Date: Wed, 9 Mar 2022 19:37:30 +0100
Subject: Add reason field to AoC completionist block table

---
 pydis_site/apps/api/migrations/0080_add_aoc_tables.py       | 1 +
 pydis_site/apps/api/models/bot/aoc_completionist_block.py   | 4 ++++
 pydis_site/apps/api/serializers.py                          | 2 +-
 pydis_site/apps/api/viewsets/bot/aoc_completionist_block.py | 7 +++++--
 4 files changed, 11 insertions(+), 3 deletions(-)

(limited to 'pydis_site/apps/api/models')

diff --git a/pydis_site/apps/api/migrations/0080_add_aoc_tables.py b/pydis_site/apps/api/migrations/0080_add_aoc_tables.py
index c58a5d29..917c5b7f 100644
--- a/pydis_site/apps/api/migrations/0080_add_aoc_tables.py
+++ b/pydis_site/apps/api/migrations/0080_add_aoc_tables.py
@@ -17,6 +17,7 @@ class Migration(migrations.Migration):
             fields=[
                 ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('is_blocked', models.BooleanField(default=True, help_text='Whether this user is actively being blocked from getting the AoC Completionist Role', verbose_name='Blocked')),
+                ('reason', models.TextField(help_text='The reason for the AoC Completionist Role Block.', null=True)),
                 ('user', models.OneToOneField(help_text='The user that is blocked from getting the AoC Completionist Role', on_delete=django.db.models.deletion.CASCADE, to='api.user')),
             ],
             bases=(pydis_site.apps.api.models.mixins.ModelReprMixin, models.Model),
diff --git a/pydis_site/apps/api/models/bot/aoc_completionist_block.py b/pydis_site/apps/api/models/bot/aoc_completionist_block.py
index a89f9760..6605cbc4 100644
--- a/pydis_site/apps/api/models/bot/aoc_completionist_block.py
+++ b/pydis_site/apps/api/models/bot/aoc_completionist_block.py
@@ -19,3 +19,7 @@ class AocCompletionistBlock(ModelReprMixin, models.Model):
                   "from getting the AoC Completionist Role",
         verbose_name="Blocked"
     )
+    reason = models.TextField(
+        null=True,
+        help_text="The reason for the AoC Completionist Role Block."
+    )
diff --git a/pydis_site/apps/api/serializers.py b/pydis_site/apps/api/serializers.py
index 0b0e4237..c97f7dba 100644
--- a/pydis_site/apps/api/serializers.py
+++ b/pydis_site/apps/api/serializers.py
@@ -259,7 +259,7 @@ class AocCompletionistBlockSerializer(ModelSerializer):
         """Metadata defined for the Django REST Framework."""
 
         model = AocCompletionistBlock
-        fields = ("user", "is_blocked")
+        fields = ("user", "is_blocked", "reason")
 
 
 class AocAccountLinkSerializer(ModelSerializer):
diff --git a/pydis_site/apps/api/viewsets/bot/aoc_completionist_block.py b/pydis_site/apps/api/viewsets/bot/aoc_completionist_block.py
index c5568129..8e7d821c 100644
--- a/pydis_site/apps/api/viewsets/bot/aoc_completionist_block.py
+++ b/pydis_site/apps/api/viewsets/bot/aoc_completionist_block.py
@@ -24,6 +24,7 @@ class AocCompletionistBlockViewSet(
     ...     {
     ...         "user": 2,
     ...         "is_blocked": False
+    ...         "reason": "Too good to be true"
     ...     }
     ... ]
 
@@ -36,6 +37,7 @@ class AocCompletionistBlockViewSet(
     ...     {
     ...         "user": 2,
     ...         "is_blocked": False
+    ...         "reason": "Too good to be true"
     ...     }
 
     #### Status codes
@@ -47,8 +49,9 @@ class AocCompletionistBlockViewSet(
 
     #### Request body
     >>> {
-    ...     'user': int,
-    ...     'is_blocked': bool
+    ...     "user": int,
+    ...     "is_blocked": bool
+    ...     "reason": string
     ... }
 
     #### Status codes
-- 
cgit v1.2.3


From d18d0198f2a43066b7f6cb9542a25adea6e6b3f4 Mon Sep 17 00:00:00 2001
From: D0rs4n <41237606+D0rs4n@users.noreply.github.com>
Date: Wed, 9 Mar 2022 23:07:38 +0100
Subject: Patch AoC tables to use the Discord user as PK.

---
 pydis_site/apps/api/migrations/0080_add_aoc_tables.py    | 16 +++++++---------
 .../apps/api/models/bot/aoc_completionist_block.py       |  3 ++-
 pydis_site/apps/api/models/bot/aoc_link.py               |  3 ++-
 pydis_site/apps/api/viewsets/bot/aoc_link.py             |  8 +++++---
 4 files changed, 16 insertions(+), 14 deletions(-)

(limited to 'pydis_site/apps/api/models')

diff --git a/pydis_site/apps/api/migrations/0080_add_aoc_tables.py b/pydis_site/apps/api/migrations/0080_add_aoc_tables.py
index 917c5b7f..2c0c689a 100644
--- a/pydis_site/apps/api/migrations/0080_add_aoc_tables.py
+++ b/pydis_site/apps/api/migrations/0080_add_aoc_tables.py
@@ -13,21 +13,19 @@ class Migration(migrations.Migration):
 
     operations = [
         migrations.CreateModel(
-            name='AocCompletionistBlock',
+            name='AocAccountLink',
             fields=[
-                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('is_blocked', models.BooleanField(default=True, help_text='Whether this user is actively being blocked from getting the AoC Completionist Role', verbose_name='Blocked')),
-                ('reason', models.TextField(help_text='The reason for the AoC Completionist Role Block.', null=True)),
-                ('user', models.OneToOneField(help_text='The user that is blocked from getting the AoC Completionist Role', on_delete=django.db.models.deletion.CASCADE, to='api.user')),
+                ('user', models.OneToOneField(help_text='The user that is blocked from getting the AoC Completionist Role', on_delete=django.db.models.deletion.CASCADE, primary_key=True, serialize=False, to='api.user')),
+                ('aoc_username', models.CharField(help_text='The AoC username associated with the Discord User.', max_length=120)),
             ],
             bases=(pydis_site.apps.api.models.mixins.ModelReprMixin, models.Model),
         ),
         migrations.CreateModel(
-            name='AocAccountLink',
+            name='AocCompletionistBlock',
             fields=[
-                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('aoc_username', models.CharField(help_text='The AoC username associated with the Discord User.', max_length=120)),
-                ('user', models.OneToOneField(help_text='The user that is blocked from getting the AoC Completionist Role', on_delete=django.db.models.deletion.CASCADE, to='api.user')),
+                ('user', models.OneToOneField(help_text='The user that is blocked from getting the AoC Completionist Role', on_delete=django.db.models.deletion.CASCADE, primary_key=True, serialize=False, to='api.user')),
+                ('is_blocked', models.BooleanField(default=True, help_text='Whether this user is actively being blocked from getting the AoC Completionist Role', verbose_name='Blocked')),
+                ('reason', models.TextField(help_text='The reason for the AoC Completionist Role Block.', null=True)),
             ],
             bases=(pydis_site.apps.api.models.mixins.ModelReprMixin, models.Model),
         ),
diff --git a/pydis_site/apps/api/models/bot/aoc_completionist_block.py b/pydis_site/apps/api/models/bot/aoc_completionist_block.py
index 6605cbc4..acbc0eba 100644
--- a/pydis_site/apps/api/models/bot/aoc_completionist_block.py
+++ b/pydis_site/apps/api/models/bot/aoc_completionist_block.py
@@ -10,7 +10,8 @@ class AocCompletionistBlock(ModelReprMixin, models.Model):
     user = models.OneToOneField(
         User,
         on_delete=models.CASCADE,
-        help_text="The user that is blocked from getting the AoC Completionist Role"
+        help_text="The user that is blocked from getting the AoC Completionist Role",
+        primary_key=True
     )
 
     is_blocked = models.BooleanField(
diff --git a/pydis_site/apps/api/models/bot/aoc_link.py b/pydis_site/apps/api/models/bot/aoc_link.py
index 9b47456d..4e9d4882 100644
--- a/pydis_site/apps/api/models/bot/aoc_link.py
+++ b/pydis_site/apps/api/models/bot/aoc_link.py
@@ -10,7 +10,8 @@ class AocAccountLink(ModelReprMixin, models.Model):
     user = models.OneToOneField(
         User,
         on_delete=models.CASCADE,
-        help_text="The user that is blocked from getting the AoC Completionist Role"
+        help_text="The user that is blocked from getting the AoC Completionist Role",
+        primary_key=True
     )
 
     aoc_username = models.CharField(
diff --git a/pydis_site/apps/api/viewsets/bot/aoc_link.py b/pydis_site/apps/api/viewsets/bot/aoc_link.py
index 263b548d..c3fa6854 100644
--- a/pydis_site/apps/api/viewsets/bot/aoc_link.py
+++ b/pydis_site/apps/api/viewsets/bot/aoc_link.py
@@ -24,7 +24,8 @@ class AocAccountLinkViewSet(
     ...     {
     ...         "user": 2,
     ...         "aoc_username": "AoCUser1"
-    ...     }
+    ...     },
+    ...     ...
     ... ]
 
 
@@ -32,11 +33,12 @@ class AocAccountLinkViewSet(
     Retrieve a AoC account link by User ID
 
     #### Response format
-    >>>
+    >>> [
     ...     {
     ...         "user": 2,
     ...         "aoc_username": "AoCUser1"
-    ...     }
+    ...     },
+    ... ]
 
     #### Status codes
     - 200: returned on success
-- 
cgit v1.2.3