Created model SDG (#249)

* feat: add model: Sdg
* feat: register admin: sdg
* feat: add endpoints: sdg

app/core/admin.py

@@ -13,6 +13,7 @@
 from .models import PracticeArea
 from .models import ProgramArea
 from .models import Project
+from .models import Sdg
 from .models import Skill
 from .models import SponsorPartner
 from .models import StackElementType
@@ -213,3 +214,8 @@ class StackElementType(admin.ModelAdmin):
         "name",
         "description",
     )
+
+
+@admin.register(Sdg)
+class SdgAdmin(admin.ModelAdmin):
+    list_display = ("name", "description", "image")

app/core/api/serializers.py

@@ -9,6 +9,7 @@
 from core.models import PracticeArea
 from core.models import ProgramArea
 from core.models import Project
+from core.models import Sdg
 from core.models import Skill
 from core.models import SponsorPartner
 from core.models import StackElementType
@@ -275,3 +276,23 @@ class Meta:
             "created_at",
             "updated_at",
         )
+
+
+class SdgSerializer(serializers.ModelSerializer):
+    """
+    Used to retrieve Sdg
+    """
+
+    class Meta:
+        model = Sdg
+        fields = (
+            "uuid",
+            "name",
+            "description",
+            "image",
+        )
+        read_only_fields = (
+            "uuid",
+            "created_at",
+            "updated_at",
+        )

app/core/api/urls.py

@@ -9,6 +9,7 @@
 from .views import PracticeAreaViewSet
 from .views import ProgramAreaViewSet
 from .views import ProjectViewSet
+from .views import SdgViewSet
 from .views import SkillViewSet
 from .views import SponsorPartnerViewSet
 from .views import StackElementTypeViewSet
@@ -32,7 +33,7 @@
 router.register(
     r"stack-element-types", StackElementTypeViewSet, basename="stack-element-type"
 )
-
+router.register(r"sdgs", SdgViewSet, basename="sdg")
 urlpatterns = [
     path("me/", UserProfileAPIView.as_view(), name="my_profile"),
 ]

app/core/api/views.py

@@ -19,6 +19,7 @@
 from ..models import PracticeArea
 from ..models import ProgramArea
 from ..models import Project
+from ..models import Sdg
 from ..models import Skill
 from ..models import SponsorPartner
 from ..models import StackElementType
@@ -31,6 +32,7 @@
 from .serializers import PracticeAreaSerializer
 from .serializers import ProgramAreaSerializer
 from .serializers import ProjectSerializer
+from .serializers import SdgSerializer
 from .serializers import SkillSerializer
 from .serializers import SponsorPartnerSerializer
 from .serializers import StackElementTypeSerializer
@@ -298,3 +300,17 @@ class StackElementTypeViewSet(viewsets.ModelViewSet):
     permission_classes = [IsAuthenticated]
     queryset = StackElementType.objects.all()
     serializer_class = StackElementTypeSerializer
+
+
+@extend_schema_view(
+    list=extend_schema(description="Return a list of all the recurring events"),
+    create=extend_schema(description="Create a new recurring event"),
+    retrieve=extend_schema(description="Return the details of a recurring event"),
+    destroy=extend_schema(description="Delete a recurring event"),
+    update=extend_schema(description="Update a recurring event"),
+    partial_update=extend_schema(description="Patch a recurring event"),
+)
+class SdgViewSet(viewsets.ModelViewSet):
+    permission_classes = [IsAuthenticated]
+    queryset = Sdg.objects.all()
+    serializer_class = SdgSerializer

app/core/migrations/0021_sdg.py

@@ -0,0 +1,28 @@
+# Generated by Django 4.0.10 on 2024-01-26 05:45
+
+from django.db import migrations, models
+import uuid
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0020_rename_is_sponsor_sponsorpartner_is_org_partner_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Sdg',
+            fields=[
+                ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True)),
+                ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='Created at')),
+                ('updated_at', models.DateTimeField(auto_now=True, verbose_name='Updated at')),
+                ('name', models.CharField(max_length=255)),
+                ('description', models.TextField(blank=True)),
+                ('image', models.URLField(blank=True)),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

app/core/migrations/max_migration.txt

@@ -1 +1 @@
-0020_rename_is_sponsor_sponsorpartner_is_org_partner_and_more
+0021_sdg

app/core/models.py

@@ -314,3 +314,18 @@ class StackElementType(AbstractBaseModel):
 
     def __str__(self):
         return f"{self.name}"
+
+
+class Sdg(AbstractBaseModel):
+    """
+    Dictionary of SDGs
+    """
+
+    name = models.CharField(max_length=255)
+    description = models.TextField(blank=True)
+    image = models.URLField(blank=True)
+
+    # PK of this model is the ForeignKey for sdg_target_indicator
+
+    def __str__(self):
+        return f"{self.name}"

app/core/tests/conftest.py

@@ -9,6 +9,7 @@
 from ..models import PracticeArea
 from ..models import ProgramArea
 from ..models import Project
+from ..models import Sdg
 from ..models import Skill
 from ..models import SponsorPartner
 from ..models import StackElementType
@@ -133,3 +134,8 @@ def permission_type2():
 @pytest.fixture
 def stack_element_type():
     return StackElementType.objects.create(name="Test Stack Element Type")
+
+
+@pytest.fixture
+def sdg():
+    return Sdg.objects.create(name="Test SDG name")

app/core/tests/test_api.py

@@ -21,6 +21,7 @@
 TECHNOLOGY_URL = reverse("technology-list")
 PERMISSION_TYPE = reverse("permission-type-list")
 STACK_ELEMENT_TYPE_URL = reverse("stack-element-type-list")
+SDG_URL = reverse("sdg-list")
 
 CREATE_USER_PAYLOAD = {
     "username": "TestUserAPI",
@@ -302,3 +303,14 @@ def test_create_stack_element_type(auth_client):
     res = auth_client.post(STACK_ELEMENT_TYPE_URL, payload)
     assert res.status_code == status.HTTP_201_CREATED
     assert res.data["name"] == payload["name"]
+
+
+def test_create_sdg(auth_client):
+    payload = {
+        "name": "Test SDG name",
+        "description": "Test SDG description",
+        "image": "https://unsplash.com",
+    }
+    res = auth_client.post(SDG_URL, payload)
+    assert res.status_code == status.HTTP_201_CREATED
+    assert res.data["name"] == payload["name"]

app/core/tests/test_models.py

@@ -66,3 +66,7 @@ def test_permission_type2(permission_type2):
 
 def test_stack_element_type(stack_element_type):
     assert str(stack_element_type) == "Test Stack Element Type"
+
+
+def test_sdg(sdg):
+    assert str(sdg) == "Test SDG name"