Add FAQ app

- Includes API and tests for the API
- TODO: add UI for FAQ

Author: cache-rules

config/settings/base.py

@@ -41,8 +41,9 @@
     "django.contrib.staticfiles",
     "rest_framework",
     "nerd_herder",
-    "nerd_herder.code_of_conduct",
     "nerd_herder.users",
+    "nerd_herder.code_of_conduct",
+    "nerd_herder.faq",
     "nerd_herder.talk_proposals",
     "nerd_herder.slack",
     # "nerd_herder.speakers",

config/urls.py

@@ -28,4 +28,5 @@
         include("nerd_herder.talk_proposals.urls", namespace="talk_proposals"),
     ),
     path("api/v1/slack/", include("nerd_herder.slack.urls", namespace="slack")),
+    path("api/v1/faq/", include("nerd_herder.faq.urls", namespace="faq")),
 ]

nerd_herder/faq/__init__.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

nerd_herder/faq/admin.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class FaqConfig(AppConfig):
+    name = 'nerd_herder.faq'

nerd_herder/faq/apps.py

@@ -0,0 +1,28 @@
+# Generated by Django 2.0.1 on 2018-07-07 20:27
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Entry',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', models.DateTimeField(auto_now_add=True)),
+                ('updated', models.DateTimeField(auto_now=True)),
+                ('position', models.IntegerField()),
+                ('question', models.TextField()),
+                ('answer', models.TextField()),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

nerd_herder/faq/migrations/0001_initial.py

@@ -0,0 +1,9 @@
+from django.db import models
+
+from nerd_herder.models import TimeStampedModel
+
+
+class Entry(TimeStampedModel):
+    position = models.IntegerField()
+    question = models.TextField()
+    answer = models.TextField()

nerd_herder/faq/migrations/__init__.py

@@ -0,0 +1,9 @@
+from rest_framework.serializers import ModelSerializer
+
+from .models import Entry
+
+
+class EntrySerializer(ModelSerializer):
+    class Meta:
+        model = Entry
+        fields = ('id', 'position', 'question', 'answer')

nerd_herder/faq/models.py

@@ -0,0 +1,174 @@
+import json
+
+import pytest
+from django.test import Client
+
+from nerd_herder.faq.models import Entry
+
+BASE_URL = "/api/v1/faq/"
+REQUIRED_ERROR = ["This field is required."]
+NULL_ERROR = ["This field may not be null."]
+FIELDS = ["question", "answer", "position"]
+ENTRIES = [
+    {
+        "question": "What version of Python should I use?",
+        "answer": "Python 3 or above",
+        "position": 0,
+    },
+    {
+        "question": "Flask or Django?",
+        "answer": "Whatever floats your boat",
+        "position": 1,
+    },
+]
+
+
+@pytest.mark.django_db
+def test_add_entry(client: Client):
+    entry = ENTRIES[0]
+    payload = json.dumps(entry)
+    r = client.post(BASE_URL, payload, content_type="application/json")
+
+    assert 201 == r.status_code
+    body = r.json()
+    assert entry["question"] == body["question"]
+    assert entry["answer"] == body["answer"]
+    assert entry["position"] == body["position"]
+    assert 1 == len(Entry.objects.all())
+
+
+@pytest.mark.django_db
+@pytest.mark.parametrize(
+    "payload,expected",
+    [
+        ({}, {field: REQUIRED_ERROR for field in FIELDS}),
+        ({field: None for field in FIELDS}, {field: NULL_ERROR for field in FIELDS}),
+        ({**ENTRIES[0], "question": False}, {"question": ["Not a valid string."]}),
+        ({**ENTRIES[0], "answer": False}, {"answer": ["Not a valid string."]}),
+        (
+            {**ENTRIES[0], "position": False},
+            {"position": ["A valid integer is required."]},
+        ),
+    ],
+)
+def test_add_entry_bad(client: Client, payload, expected):
+    req = client.post(BASE_URL, json.dumps(payload), "application/json")
+
+    assert 400 == req.status_code
+    assert expected == req.json()
+
+
+@pytest.mark.django_db
+def test_update_entry(client: Client):
+    entry = Entry.objects.create(**ENTRIES[0])
+    question = "I am a new title"
+    url = f"{BASE_URL}{entry.id}"
+    r = client.put(
+        url,
+        json.dumps({**ENTRIES[0], "question": question}),
+        content_type="application/json",
+    )
+    assert 200 == r.status_code
+    assert {**ENTRIES[0], "id": entry.id, "question": question} == r.json()
+
+
+@pytest.mark.django_db
+@pytest.mark.parametrize("field", FIELDS)
+def test_update_entry_bad(client: Client, field):
+    entry = Entry.objects.create(**ENTRIES[0])
+    url = f"{BASE_URL}{entry.id}"
+
+    r = client.put(
+        url, json.dumps({**ENTRIES[0], field: None}), content_type="application/json"
+    )
+
+    assert 400 == r.status_code
+
+    copy = {**ENTRIES[0]}
+    copy.pop(field)
+    r = client.put(url, json.dumps(copy), content_type="application/json")
+
+    assert 400 == r.status_code
+
+    r = client.put(
+        url, json.dumps({**ENTRIES[0], field: False}), content_type="application/json"
+    )
+
+    assert 400 == r.status_code
+
+
+@pytest.mark.django_db
+def test_delete_entry(client: Client):
+    entry = Entry.objects.create(**ENTRIES[0])
+    url = f"{BASE_URL}{entry.id}"
+    r = client.delete(url)
+
+    assert 204 == r.status_code
+
+    r = client.get(url)
+
+    assert 404 == r.status_code
+
+
+@pytest.mark.django_db
+def test_get_entries(client: Client):
+    for entry in ENTRIES:
+        Entry.objects.create(**entry)
+
+    r = client.get(BASE_URL, content_type="application/json")
+
+    assert r.status_code == 200
+    body = r.json()
+    assert 2 == len(body)
+
+    for idx, entry in enumerate(body):
+        assert ENTRIES[idx]["question"] == entry["question"]
+        assert ENTRIES[idx]["answer"] == entry["answer"]
+        assert ENTRIES[idx]["position"] == entry["position"]
+
+
+@pytest.mark.django_db
+def test_change_entry_order(client: Client):
+    entries = []
+
+    for entry in ENTRIES:
+        entries.append(Entry.objects.create(**entry))
+
+    payload = {
+        'order': {
+            str(entries[0].id): 1,
+            str(entries[1].id): 0,
+        }
+    }
+
+    r = client.put(BASE_URL, json.dumps(payload), content_type='application/json')
+
+    assert 200 == r.status_code
+    assert payload == r.json()
+
+    r = client.get(BASE_URL)
+
+    assert 200 == r.status_code
+    body = r.json()
+    assert entries[0].id == body[1]['id']
+    assert entries[1].id == body[0]['id']
+
+
+@pytest.mark.django_db
+def test_change_entry_order_bad(client: Client):
+    entries = []
+
+    for entry in ENTRIES:
+        entries.append(Entry.objects.create(**entry))
+
+    payload = {
+        'order': {
+            str(entries[0].id): 1,
+        }
+    }
+
+    r = client.put(BASE_URL, json.dumps(payload), content_type='application/json')
+
+    assert 400 == r.status_code
+    assert {'order': [f'Missing position value for entry with id "{entries[1].id}"']} == r.json()
+

nerd_herder/faq/serializers.py

@@ -0,0 +1,10 @@
+from django.urls import path
+
+from .views import EntriesList, EntryDetail
+
+app_name = 'faq'
+
+urlpatterns = [
+    path('', EntriesList.as_view()),
+    path('<int:pk>', EntryDetail.as_view()),
+]

nerd_herder/faq/tests/__init__.py

@@ -0,0 +1,38 @@
+import logging
+
+from rest_framework import status
+from rest_framework.generics import ListCreateAPIView, RetrieveUpdateDestroyAPIView
+from rest_framework.response import Response
+
+from .models import Entry
+from .serializers import EntrySerializer
+
+logger = logging.getLogger(__name__)
+
+
+class EntriesList(ListCreateAPIView):
+    queryset = Entry.objects.all().order_by('position')
+    serializer_class = EntrySerializer
+
+    def put(self, request):
+        try:
+            new_order = request.data['order']
+        except KeyError:
+            return Response({'order': ['This field is required.']},
+                            status=status.HTTP_400_BAD_REQUEST)
+
+        for entry in Entry.objects.all():
+            try:
+                entry.position = new_order[str(entry.id)]
+            except KeyError:
+                error = f'Missing position value for entry with id "{entry.id}"'
+                return Response({'order': [error]}, status=status.HTTP_400_BAD_REQUEST)
+
+            entry.save()
+
+        return Response({'order': new_order}, status=status.HTTP_200_OK)
+
+
+class EntryDetail(RetrieveUpdateDestroyAPIView):
+    queryset = Entry.objects.all()
+    serializer_class = EntrySerializer