Merge branch 'master' into user_endpoint

the Pipfile.lock conflict was resolved by re-locking the pipfile.

3 files changed, 53 insertions, 35 deletions

diff --git a/pydis_site/apps/api/tests/test_models.py b/pydis_site/apps/api/tests/test_models.py
index e0e347bb..853e6621 100644
--- a/pydis_site/apps/api/tests/test_models.py
+++ b/pydis_site/apps/api/tests/test_models.py
@@ -14,7 +14,6 @@ from pydis_site.apps.api.models import (
     OffensiveMessage,
     Reminder,
     Role,
-    Tag,
     User
 )
 from pydis_site.apps.api.models.mixins import ModelReprMixin
@@ -104,10 +103,6 @@ class StringDunderMethodTests(SimpleTestCase):
                 ),
                 creation=dt.utcnow()
             ),
-            Tag(
-                title='bob',
-                embed={'content': "the builder"}
-            ),
             User(
                 id=5,
                 name='bob',
diff --git a/pydis_site/apps/api/tests/test_off_topic_channel_names.py b/pydis_site/apps/api/tests/test_off_topic_channel_names.py
index bd42cd81..3ab8b22d 100644
--- a/pydis_site/apps/api/tests/test_off_topic_channel_names.py
+++ b/pydis_site/apps/api/tests/test_off_topic_channel_names.py
@@ -10,12 +10,14 @@ class UnauthenticatedTests(APISubdomainTestCase):
         self.client.force_authenticate(user=None)
 
     def test_cannot_read_off_topic_channel_name_list(self):
+        """Return a 401 response when not authenticated."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(url)
 
         self.assertEqual(response.status_code, 401)
 
     def test_cannot_read_off_topic_channel_name_list_with_random_item_param(self):
+        """Return a 401 response when `random_items` provided and not authenticated."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(f'{url}?random_items=no')
 
@@ -24,6 +26,7 @@ class UnauthenticatedTests(APISubdomainTestCase):
 
 class EmptyDatabaseTests(APISubdomainTestCase):
     def test_returns_empty_object(self):
+        """Return empty list when no names in database."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(url)
 
@@ -31,6 +34,7 @@ class EmptyDatabaseTests(APISubdomainTestCase):
         self.assertEqual(response.json(), [])
 
     def test_returns_empty_list_with_get_all_param(self):
+        """Return empty list when no names and `random_items` param provided."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(f'{url}?random_items=5')
 
@@ -38,6 +42,7 @@ class EmptyDatabaseTests(APISubdomainTestCase):
         self.assertEqual(response.json(), [])
 
     def test_returns_400_for_bad_random_items_param(self):
+        """Return error message when passing not integer as `random_items`."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(f'{url}?random_items=totally-a-valid-integer')
 
@@ -47,6 +52,7 @@ class EmptyDatabaseTests(APISubdomainTestCase):
         })
 
     def test_returns_400_for_negative_random_items_param(self):
+        """Return error message when passing negative int as `random_items`."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(f'{url}?random_items=-5')
 
@@ -59,10 +65,11 @@ class EmptyDatabaseTests(APISubdomainTestCase):
 class ListTests(APISubdomainTestCase):
     @classmethod
     def setUpTestData(cls):
-        cls.test_name = OffTopicChannelName.objects.create(name='lemons-lemonade-stand')
-        cls.test_name_2 = OffTopicChannelName.objects.create(name='bbq-with-bisk')
+        cls.test_name = OffTopicChannelName.objects.create(name='lemons-lemonade-stand', used=False)
+        cls.test_name_2 = OffTopicChannelName.objects.create(name='bbq-with-bisk', used=True)
 
     def test_returns_name_in_list(self):
+        """Return all off-topic channel names."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(url)
 
@@ -76,11 +83,21 @@ class ListTests(APISubdomainTestCase):
         )
 
     def test_returns_single_item_with_random_items_param_set_to_1(self):
+        """Return not-used name instead used."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(f'{url}?random_items=1')
 
         self.assertEqual(response.status_code, 200)
         self.assertEqual(len(response.json()), 1)
+        self.assertEqual(response.json(), [self.test_name.name])
+
+    def test_running_out_of_names_with_random_parameter(self):
+        """Reset names `used` parameter to `False` when running out of names."""
+        url = reverse('bot:offtopicchannelname-list', host='api')
+        response = self.client.get(f'{url}?random_items=2')
+
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), [self.test_name.name, self.test_name_2.name])
 
 
 class CreationTests(APISubdomainTestCase):
@@ -93,6 +110,7 @@ class CreationTests(APISubdomainTestCase):
         self.assertEqual(response.status_code, 201)
 
     def test_returns_201_for_unicode_chars(self):
+        """Accept all valid characters."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         names = (
             '𝖠𝖡𝖢𝖣𝖤𝖥𝖦𝖧𝖨𝖩𝖪𝖫𝖬𝖭𝖮𝖯𝖰𝖱𝖲𝖳𝖴𝖵𝖶𝖷𝖸𝖹',
@@ -104,6 +122,7 @@ class CreationTests(APISubdomainTestCase):
             self.assertEqual(response.status_code, 201)
 
     def test_returns_400_for_missing_name_param(self):
+        """Return error message when name not provided."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.post(url)
         self.assertEqual(response.status_code, 400)
@@ -112,6 +131,7 @@ class CreationTests(APISubdomainTestCase):
         })
 
     def test_returns_400_for_bad_name_param(self):
+        """Return error message when invalid characters provided."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         invalid_names = (
             'space between words',
@@ -134,18 +154,21 @@ class DeletionTests(APISubdomainTestCase):
         cls.test_name_2 = OffTopicChannelName.objects.create(name='bbq-with-bisk')
 
     def test_deleting_unknown_name_returns_404(self):
+        """Return 404 reponse when trying to delete unknown name."""
         url = reverse('bot:offtopicchannelname-detail', args=('unknown-name',), host='api')
         response = self.client.delete(url)
 
         self.assertEqual(response.status_code, 404)
 
     def test_deleting_known_name_returns_204(self):
+        """Return 204 response when deleting was successful."""
         url = reverse('bot:offtopicchannelname-detail', args=(self.test_name.name,), host='api')
         response = self.client.delete(url)
 
         self.assertEqual(response.status_code, 204)
 
     def test_name_gets_deleted(self):
+        """Name gets actually deleted."""
         url = reverse('bot:offtopicchannelname-detail', args=(self.test_name_2.name,), host='api')
         response = self.client.delete(url)
 
diff --git a/pydis_site/apps/api/tests/test_validators.py b/pydis_site/apps/api/tests/test_validators.py
index 241af08c..8bb7b917 100644
--- a/pydis_site/apps/api/tests/test_validators.py
+++ b/pydis_site/apps/api/tests/test_validators.py
@@ -5,7 +5,7 @@ from django.test import TestCase
 
 from ..models.bot.bot_setting import validate_bot_setting_name
 from ..models.bot.offensive_message import future_date_validator
-from ..models.bot.tag import validate_tag_embed
+from ..models.utils import validate_embed
 
 
 REQUIRED_KEYS = (
@@ -25,77 +25,77 @@ class BotSettingValidatorTests(TestCase):
 class TagEmbedValidatorTests(TestCase):
     def test_rejects_non_mapping(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed('non-empty non-mapping')
+            validate_embed('non-empty non-mapping')
 
     def test_rejects_missing_required_keys(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'unknown': "key"
             })
 
     def test_rejects_one_correct_one_incorrect(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'provider': "??",
                 'title': ""
             })
 
     def test_rejects_empty_required_key(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'title': ''
             })
 
     def test_rejects_list_as_embed(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed([])
+            validate_embed([])
 
     def test_rejects_required_keys_and_unknown_keys(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'title': "the duck walked up to the lemonade stand",
                 'and': "he said to the man running the stand"
             })
 
     def test_rejects_too_long_title(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'title': 'a' * 257
             })
 
     def test_rejects_too_many_fields(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'fields': [{} for _ in range(26)]
             })
 
     def test_rejects_too_long_description(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'description': 'd' * 2049
             })
 
     def test_allows_valid_embed(self):
-        validate_tag_embed({
+        validate_embed({
             'title': "My embed",
             'description': "look at my embed, my embed is amazing"
         })
 
     def test_allows_unvalidated_fields(self):
-        validate_tag_embed({
+        validate_embed({
             'title': "My embed",
             'provider': "what am I??"
         })
 
     def test_rejects_fields_as_list_of_non_mappings(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'fields': ['abc']
             })
 
     def test_rejects_fields_with_unknown_fields(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'fields': [
                     {
                         'what': "is this field"
@@ -105,7 +105,7 @@ class TagEmbedValidatorTests(TestCase):
 
     def test_rejects_fields_with_too_long_name(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'fields': [
                     {
                         'name': "a" * 257
@@ -115,7 +115,7 @@ class TagEmbedValidatorTests(TestCase):
 
     def test_rejects_one_correct_one_incorrect_field(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'fields': [
                     {
                         'name': "Totally valid",
@@ -131,7 +131,7 @@ class TagEmbedValidatorTests(TestCase):
 
     def test_rejects_missing_required_field_field(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'fields': [
                     {
                         'name': "Totally valid",
@@ -142,7 +142,7 @@ class TagEmbedValidatorTests(TestCase):
 
     def test_rejects_invalid_inline_field_field(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'fields': [
                     {
                         'name': "Totally valid",
@@ -153,7 +153,7 @@ class TagEmbedValidatorTests(TestCase):
             })
 
     def test_allows_valid_fields(self):
-        validate_tag_embed({
+        validate_embed({
             'fields': [
                 {
                     'name': "valid",
@@ -174,14 +174,14 @@ class TagEmbedValidatorTests(TestCase):
 
     def test_rejects_footer_as_non_mapping(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'title': "whatever",
                 'footer': []
             })
 
     def test_rejects_footer_with_unknown_fields(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'title': "whatever",
                 'footer': {
                     'duck': "quack"
@@ -190,7 +190,7 @@ class TagEmbedValidatorTests(TestCase):
 
     def test_rejects_footer_with_empty_text(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'title': "whatever",
                 'footer': {
                     'text': ""
@@ -198,7 +198,7 @@ class TagEmbedValidatorTests(TestCase):
             })
 
     def test_allows_footer_with_proper_values(self):
-        validate_tag_embed({
+        validate_embed({
             'title': "whatever",
             'footer': {
                 'text': "django good"
@@ -207,14 +207,14 @@ class TagEmbedValidatorTests(TestCase):
 
     def test_rejects_author_as_non_mapping(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'title': "whatever",
                 'author': []
             })
 
     def test_rejects_author_with_unknown_field(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'title': "whatever",
                 'author': {
                     'field': "that is unknown"
@@ -223,7 +223,7 @@ class TagEmbedValidatorTests(TestCase):
 
     def test_rejects_author_with_empty_name(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'title': "whatever",
                 'author': {
                     'name': ""
@@ -232,7 +232,7 @@ class TagEmbedValidatorTests(TestCase):
 
     def test_rejects_author_with_one_correct_one_incorrect(self):
         with self.assertRaises(ValidationError):
-            validate_tag_embed({
+            validate_embed({
                 'title': "whatever",
                 'author': {
                     # Relies on "dictionary insertion order remembering" (D.I.O.R.) behaviour
@@ -242,7 +242,7 @@ class TagEmbedValidatorTests(TestCase):
             })
 
     def test_allows_author_with_proper_values(self):
-        validate_tag_embed({
+        validate_embed({
             'title': "whatever",
             'author': {
                 'name': "Bob"