Created SuccessStory model in DB, added model to admin, created seria…

.flake8

@@ -12,3 +12,4 @@ ignore =
 exclude =
     __pycache__
     testing.py
+    migrations

src/api/admin.py

@@ -5,6 +5,7 @@
     Location,
     Scholarship,
     ScholarshipApplication,
+    SuccessStory,
     TeamMember,
 )
 
@@ -73,3 +74,13 @@ class CodeSchoolAdmin(admin.ModelAdmin):
     )
 
     search_fields = ("name", "rep_name", "rep_email", "url")
+
+
+@admin.register(SuccessStory)
+class SuccessStoryAdmin(admin.ModelAdmin):
+    list_display = (
+        "created_by",
+        "created_at",
+        "text",
+        "is_approved",
+    )

src/api/migrations/0009_successstory.py

@@ -0,0 +1,31 @@
+# Generated by Django 2.2.10 on 2020-05-01 14:35
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("api", "0008_codeschool_is_vet_tec_approved"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="SuccessStory",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("created_by", models.CharField(blank=True, max_length=256, null=True)),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("text", models.TextField(blank=True, null=True)),
+                ("is_approved", models.BooleanField(blank=True, null=True)),
+            ],
+        ),
+    ]

src/api/migrations/0010_auto_20200505_1711.py

@@ -0,0 +1,33 @@
+# Generated by Django 2.2.10 on 2020-05-05 17:11
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("api", "0009_successstory"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="successstory", options={"verbose_name_plural": "Success Stories"},
+        ),
+        migrations.AlterField(
+            model_name="successstory",
+            name="created_by",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.DO_NOTHING,
+                to=settings.AUTH_USER_MODEL,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="successstory",
+            name="is_approved",
+            field=models.BooleanField(default=False),
+        ),
+    ]

src/api/models.py

@@ -92,3 +92,22 @@ def __str__(self):
 
     class Meta:
         db_table = "api_team_members"
+
+
+class SuccessStory(models.Model):
+    """
+    Model that holds user success stories.
+    """
+
+    created_by = models.ForeignKey(
+        User, models.DO_NOTHING, blank=True, null=True, unique=False
+    )
+    created_at = models.DateTimeField(auto_now_add=True, unique=False)
+    text = models.TextField(blank=True, null=True, unique=False)
+    is_approved = models.BooleanField(default=False, unique=False)
+
+    def __str__(self):
+        return f"{self.created_by} - {self.is_approved}"
+
+    class Meta:
+        verbose_name_plural = "Success Stories"

src/api/serializers.py

@@ -5,6 +5,7 @@
     Location,
     Scholarship,
     ScholarshipApplication,
+    SuccessStory,
     TeamMember,
 )
 
@@ -39,3 +40,9 @@ class TeamMemberSerializer(serializers.HyperlinkedModelSerializer):
     class Meta:
         model = TeamMember
         fields = "__all__"
+
+
+class SuccessStorySerializer(serializers.HyperlinkedModelSerializer):
+    class Meta:
+        model = SuccessStory
+        fields = "__all__"

src/api/urls.py

@@ -9,5 +9,6 @@
 router.register("scholarships", views.ScholarshipViewSet)
 router.register("scholarshipApplications", views.ScholarshipApplicationViewSet)
 router.register("teamMembers", views.TeamMemberViewSet)
+router.register("sucessStory", views.SuccessStoryViewSet)
 
 urlpatterns = [path("", include(router.urls))]

src/api/views.py

@@ -1,18 +1,20 @@
-from rest_framework.permissions import IsAuthenticated
-from rest_framework.viewsets import ReadOnlyModelViewSet
+from rest_framework.permissions import IsAuthenticated, IsAuthenticatedOrReadOnly
+from rest_framework.viewsets import ModelViewSet, ReadOnlyModelViewSet
 
 from api.models import (
     CodeSchool,
     Location,
     Scholarship,
     ScholarshipApplication,
+    SuccessStory,
     TeamMember,
 )
 from api.serializers import (
     CodeSchoolSerializer,
     LocationSerializer,
     ScholarshipApplicationSerializer,
     ScholarshipSerializer,
+    SuccessStorySerializer,
     TeamMemberSerializer,
 )
 
@@ -41,3 +43,9 @@ class ScholarshipApplicationViewSet(ReadOnlyModelViewSet):
 class TeamMemberViewSet(ReadOnlyModelViewSet):
     serializer_class = TeamMemberSerializer
     queryset = TeamMember.objects.all()
+
+
+class SuccessStoryViewSet(ModelViewSet):
+    serializer_class = SuccessStorySerializer
+    queryset = SuccessStory.objects.all()
+    permission_classes = (IsAuthenticatedOrReadOnly,)

src/tests/factories.py

@@ -1,3 +1,4 @@
+import datetime
 import threading
 
 from allauth.account.models import EmailAddress
@@ -13,14 +14,17 @@
     SubFactory,
     django,
 )
+from faker import Faker
 
+from api.models import SuccessStory
 from core.models import Profile
 from tests.test_data import (
     DEFAULT_PASSWORD,
     fake,
     random_branch,
     random_mos,
     random_pay_grade,
+    random_text,
 )
 
 
@@ -86,3 +90,12 @@ class Meta:
     )
     profile = RelatedFactory(ProfileFactory, "user")
     active_email = RelatedFactory(EmailAddressFactory, "user", email=email)
+
+
+class SuccessFactory(DjangoModelFactory):
+    class Meta:
+        model = SuccessStory
+
+    created_at = datetime.datetime.now()
+    text = LazyFunction(fake.paragraph)
+    is_approved = LazyFunction(fake.pybool)

src/tests/fixtures.py

@@ -85,3 +85,11 @@ def random_profile_dict(request):
     profile = request.param
     profile.pop("user")
     return request.param
+
+
+@pytest.fixture
+def success_story(db, user):
+    story = f.SuccessFactory()
+    story.created_by = user
+    story.save()
+    return story

src/tests/integration/test_success_story.py

@@ -0,0 +1,14 @@
+import pytest
+from django.db import models
+
+from api.models import SuccessStory
+from tests.factories import SuccessFactory
+
+
+@pytest.mark.django_db
+def test_stories(success_story):
+    db = SuccessStory.objects.all()
+    assert db.get(created_by=success_story.created_by)
+    assert db.get(created_at=success_story.created_at)
+    assert db.get(text=success_story.text)
+    assert db.get(is_approved=success_story.is_approved)

src/tests/test_data.py

@@ -13,6 +13,10 @@ def random_branch():
     )
 
 
+def random_text():
+    return fake.random_text(max_nb_chars=200)
+
+
 def random_pay_grade():
     return f"{fake.random_element(('E', 'O'))}{fake.random_digit()}"