Merge pull request #139 from darjeeling/patron

add patron sponsor/patron model

Author: golony6449

sponsor/migrations/0005_patron.py

@@ -0,0 +1,62 @@
+# Generated by Django 4.1.5 on 2023-07-26 15:59
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("sponsor", "0004_alter_sponsor_options_alter_sponsorlevel_options"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Patron",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=100)),
+                (
+                    "total_contribution",
+                    models.IntegerField(default=0, help_text="개인후원한 금액입니다."),
+                ),
+                (
+                    "contribution_datetime",
+                    models.DateTimeField(help_text="개인후원 결제한 일시입니다."),
+                ),
+                (
+                    "contribution_message",
+                    models.TextField(
+                        help_text="후원메시지입니다. emoji 를 입력가능해야하고 html 태그가 들어갈 수 있습니다."
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                (
+                    "creator",
+                    models.ForeignKey(
+                        blank=True,
+                        help_text="개인후원을 등록한 유저",
+                        null=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="patron_user",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "개인후원자",
+                "verbose_name_plural": "개인후원자 목록",
+                "ordering": ["-total_contribution", "contribution_datetime"],
+            },
+        ),
+    ]

sponsor/models.py

@@ -158,3 +158,36 @@ class Meta:
 
     def __str__(self):
         return f"{self.name}/{self.level}"
+
+
+
+class Patron(models.Model):
+    class Meta:
+        ordering = ["-total_contribution", "contribution_datetime"]
+        verbose_name = "개인후원자"
+        verbose_name_plural = "개인후원자 목록"
+
+    name = models.CharField(max_length=100)
+    creator = models.ForeignKey(
+        User,
+        null=True,  # TODO: 추후 로그인 적용 후 입력
+        blank=True,  # TODO: 추후 로그인 적용 후 입력
+        on_delete=models.CASCADE,
+        help_text="개인후원을 등록한 유저",
+        related_name="patron_user",
+    )
+    total_contribution = models.IntegerField(default=0, help_text="개인후원한 금액입니다.")
+    contribution_datetime = models.DateTimeField(
+        help_text="개인후원 결제한 일시입니다."
+    )
+    contribution_message = models.TextField(
+        help_text="후원메시지입니다. emoji 를 입력가능해야하고 html 태그가 들어갈 수 있습니다."
+    )
+    # need html sanitizing before saving
+    # but need to include emoji
+
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    def __str__(self):
+        return f"{self.name}"

sponsor/serializers.py

@@ -1,7 +1,7 @@
 import rest_framework.serializers as serializers
 from rest_framework.fields import SerializerMethodField
 
-from sponsor.models import Sponsor, SponsorLevel
+from sponsor.models import Patron, Sponsor, SponsorLevel
 
 
 class SponsorSerializer(serializers.ModelSerializer):
@@ -74,3 +74,23 @@ def get_remaining(obj):
     @staticmethod
     def get_available(obj: SponsorLevel):
         return True if obj.current_remaining_number > 0 else False
+
+
+class PatronListSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Patron
+        fields = [
+            "name",
+            "contribution_message",
+            "sort_order",
+        ]
+
+    sort_order = serializers.SerializerMethodField()
+
+    def get_sort_order(self, obj: Patron):
+        self._sort_order += 1
+        return self._sort_order
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._sort_order = 0

sponsor/tests.py

@@ -1,13 +1,17 @@
 import pytest
 from django.contrib.auth import get_user_model
+from rest_framework.test import APIClient
 
-from sponsor.models import SponsorLevel
+from sponsor.models import Patron, SponsorLevel
 
 pytestmark = pytest.mark.django_db
 
 UserModel = get_user_model()
 
 
+client = APIClient()
+
+
 @pytest.mark.django_db
 class TestSponsorLevelModel:
     pytestmark = pytest.mark.django_db
@@ -23,4 +27,70 @@ def test_sponsor_level_creation_success(self):
         assert SponsorLevel.objects.count() != 0
 
 
-# Create your tests here.
+@pytest.mark.django_db
+class TestPatron:
+    pytestmark = pytest.mark.django_db
+
+    def test_patron_list_api(self):
+        assert Patron.objects.count() == 0
+        response = client.get("/sponsors/patron/list/", format="json")
+        assert response.status_code == 200
+        assert len(response.data) == 0
+
+        Patron.objects.create(
+            name="Python Lover 1",
+            contribution_message="I love Python",
+            total_contribution=1000000,
+            contribution_datetime="2023-07-27 00:00:00+09:00",
+        )
+        assert Patron.objects.count() == 1
+        response = client.get("/sponsors/patron/list/", format="json")
+        assert response.status_code == 200
+        assert len(response.data) == 1
+        assert response.data[0]["name"] == "Python Lover 1"
+        # check sort order
+        assert response.data[0]["sort_order"] == 1
+
+        # add second patron
+        Patron.objects.create(
+            name="Python Lover 2",
+            contribution_message="I love Python too",
+            total_contribution=1000001,
+            contribution_datetime="2023-07-27 00:00:00+09:00",
+        )
+        assert Patron.objects.count() == 2
+        response = client.get("/sponsors/patron/list/", format="json")
+        assert response.status_code == 200
+        assert len(response.data) == 2
+        assert response.data[0]["name"] == "Python Lover 2"
+        # check sort order
+        assert response.data[0]["sort_order"] == 1
+        assert response.data[1]["name"] == "Python Lover 1"
+        assert response.data[1]["sort_order"] == 2
+
+        # add third patron
+        # check contribution_datetime is earlier than Python Lover 2
+        Patron.objects.create(
+            name="Python Lover 3",
+            contribution_message="I love Python most",
+            total_contribution=1000001,
+            # earlier contribution then Python Lover 2
+            contribution_datetime="2023-07-26 00:00:00+09:00",
+        )
+        assert Patron.objects.count() == 3
+        response = client.get("/sponsors/patron/list/", format="json")
+        assert response.status_code == 200
+        assert len(response.data) == 3
+        assert response.data[0]["name"] == "Python Lover 3"
+        # check sort order
+        assert response.data[0]["sort_order"] == 1
+        assert response.data[1]["name"] == "Python Lover 2"
+        assert response.data[1]["sort_order"] == 2
+
+    @pytest.skip("TODO: implement")
+    def test_patron_message_html_sanitizer(self):
+        assert Patron.objects.count() == 0
+        # check patron save will sanitize html field
+        # allow only <a> tag
+        # allow emoji
+        pass

sponsor/urls.py

@@ -1,11 +1,15 @@
 from django.urls import path
 
-from sponsor.viewsets import SponsorViewSet
+from sponsor.viewsets import PatronListViewSet, SponsorViewSet
 
 urlpatterns = [
     path("list/", SponsorViewSet.as_view({"get": "list"})),
     path(
         "list/<int:id>/",
         SponsorViewSet.as_view({"get": "retrieve", "put": "update"}),
     ),
+    path(
+        "patron/list/",
+        PatronListViewSet.as_view({"get": "list"}),
+    ),
 ]

sponsor/viewsets.py

@@ -4,11 +4,12 @@
 from django.shortcuts import get_object_or_404
 from rest_framework import status
 from rest_framework.response import Response
-from rest_framework.viewsets import ModelViewSet
+from rest_framework.viewsets import ModelViewSet, ViewSet
 
-from sponsor.models import Sponsor, SponsorLevel
+from sponsor.models import Patron, Sponsor, SponsorLevel
 from sponsor.permissions import IsOwnerOrReadOnly, OwnerOnly
 from sponsor.serializers import (
+    PatronListSerializer,
     SponsorDetailSerializer,
     SponsorListSerializer,
     SponsorRemainingAccountSerializer,
@@ -28,7 +29,9 @@ def get_queryset(self):
         return Sponsor.objects.all().order_by("paid_at")
 
     def list(self, request, *args, **kwargs):
-        queryset = Sponsor.objects.filter(paid_at__isnull=False).order_by("level", "paid_at")
+        queryset = Sponsor.objects.filter(paid_at__isnull=False).order_by(
+            "level", "paid_at"
+        )
         serializer = SponsorListSerializer(queryset, many=True)
         return Response(serializer.data)
 
@@ -109,3 +112,10 @@ def list(self, request, *args, **kwargs):
         serializer = self.get_serializer(queryset, many=True)
 
         return Response(serializer.data)
+
+
+class PatronListViewSet(ViewSet):
+    def list(self, request):
+        queryset = Patron.objects.all()
+        serializer = PatronListSerializer(queryset, many=True)
+        return Response(serializer.data)