feat: add model: user_status_type

app/core/admin.py

@@ -23,6 +23,7 @@
 from .models import StackElementType
 from .models import UrlType
 from .models import User
+from .models import UserStatusType
 
 
 class UserCreationForm(DefaultUserCreationForm):
@@ -251,3 +252,8 @@ class SocMajorAdmin(admin.ModelAdmin):
 @admin.register(UrlType)
 class UrlTypeAdmin(admin.ModelAdmin):
     list_display = ("name", "description")
+
+
+@admin.register(UserStatusType)
+class UserStatusTypeAdmin(admin.ModelAdmin):
+    list_display = ("name", "description")

app/core/api/serializers.py

@@ -20,6 +20,7 @@
 from core.models import UrlType
 from core.models import User
 from core.models import UserPermission
+from core.models import UserStatusType
 
 
 class PracticeAreaSerializer(serializers.ModelSerializer):
@@ -377,3 +378,12 @@ class Meta:
         model = UrlType
         fields = ("uuid", "name", "description")
         read_only_fields = ("uuid", "created_at", "updated_at")
+
+
+class UserStatusTypeSerializer(serializers.ModelSerializer):
+    """Used to retrieve user_status_type info"""
+
+    class Meta:
+        model = UserStatusType
+        fields = ("uuid", "name", "description")
+        read_only_fields = ("uuid", "created_at", "updated_at")

app/core/api/urls.py

@@ -20,6 +20,7 @@
 from .views import UrlTypeViewSet
 from .views import UserPermissionViewSet
 from .views import UserProfileAPIView
+from .views import UserStatusTypeViewSet
 from .views import UserViewSet
 
 router = routers.SimpleRouter()
@@ -48,6 +49,9 @@
 router.register(r"check-types", CheckTypeViewSet, basename="check-type")
 router.register(r"soc-majors", SocMajorViewSet, basename="soc-major")
 router.register(r"url-types", UrlTypeViewSet, basename="url-type")
+router.register(
+    r"user-status-types", UserStatusTypeViewSet, basename="user-status-type"
+)
 urlpatterns = [
     path("me/", UserProfileAPIView.as_view(), name="my_profile"),
 ]

app/core/api/views.py

@@ -29,6 +29,7 @@
 from ..models import StackElementType
 from ..models import UrlType
 from ..models import UserPermission
+from ..models import UserStatusType
 from .serializers import AffiliateSerializer
 from .serializers import AffiliationSerializer
 from .serializers import CheckTypeSerializer
@@ -48,6 +49,7 @@
 from .serializers import UrlTypeSerializer
 from .serializers import UserPermissionSerializer
 from .serializers import UserSerializer
+from .serializers import UserStatusTypeSerializer
 
 
 class UserProfileAPIView(RetrieveModelMixin, GenericAPIView):
@@ -390,3 +392,17 @@ class UrlTypeViewSet(viewsets.ModelViewSet):
     permission_classes = [IsAuthenticated]
     queryset = UrlType.objects.all()
     serializer_class = UrlTypeSerializer
+
+
+@extend_schema_view(
+    list=extend_schema(description="Return a list of all the user status types"),
+    create=extend_schema(description="Create a new user status type"),
+    retrieve=extend_schema(description="Return the details of a user status type"),
+    destroy=extend_schema(description="Delete a user status type"),
+    update=extend_schema(description="Update a user status type"),
+    partial_update=extend_schema(description="Patch a user status type"),
+)
+class UserStatusTypeViewSet(viewsets.ModelViewSet):
+    permission_classes = [IsAuthenticated]
+    queryset = UserStatusType.objects.all()
+    serializer_class = UserStatusTypeSerializer

app/core/initial_data/PD_ Table and field explanations - UserStatus - Data.csv

@@ -0,0 +1,5 @@
+id,name,description
+1,Inactive,Member who has not checked into their project or Community of Practice for 4 weeks and does not have a timeAwayHold
+2,Active,Member that is checking into meetings
+3,Time Away Hold,Hold placed by the member or their leader after they have announced a temporary absence
+4,Barred,Member who has been removed from the community

app/core/migrations/0031_userstatustype_user_user_status.py

@@ -0,0 +1,52 @@
+# Generated by Django 4.2.11 on 2024-10-31 16:06
+
+from django.db import migrations, models
+import django.db.models.deletion
+import uuid
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("core", "0030_urltype"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="UserStatusType",
+            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)),
+            ],
+            options={
+                "abstract": False,
+            },
+        ),
+        migrations.AddField(
+            model_name="user",
+            name="user_status",
+            field=models.ForeignKey(
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                to="core.userstatustype",
+            ),
+        ),
+    ]

app/core/migrations/max_migration.txt

@@ -1 +1 @@
-0030_urltype
+0031_userstatustype_user_user_status

app/core/models.py

@@ -74,7 +74,9 @@ class User(PermissionsMixin, AbstractBaseUser, AbstractBaseModel):
     gmail = models.EmailField(blank=True)
     preferred_email = models.EmailField(blank=True)
 
-    # user_status = models.ForeignKey(user_status_type, on_delete=models.PROTECT)
+    user_status = models.ForeignKey(
+        "UserStatusType", null=True, on_delete=models.PROTECT
+    )
     # current_practice_area = models.ManyToManyField("PracticeArea")
     # target_practice_area = models.ManyToManyField("PracticeArea")
 
@@ -451,3 +453,11 @@ class UrlType(AbstractBaseModel):
 
     def __str__(self):
         return self.name
+
+
+class UserStatusType(AbstractBaseModel):
+    name = models.CharField(max_length=255)
+    description = models.TextField(blank=True)
+
+    def __str__(self):
+        return f"{self.name}"

app/core/tests/conftest.py

@@ -23,6 +23,7 @@
 from ..models import UrlType
 from ..models import User
 from ..models import UserPermission
+from ..models import UserStatusType
 
 
 @pytest.fixture
@@ -299,3 +300,10 @@ def url_type():
         name="This is a test url type name",
         description="This is a test url type description",
     )
+
+
+@pytest.fixture
+def user_status_type():
+    return UserStatusType.objects.create(
+        name="Test User Status Type", description="Test User Status Type description"
+    )

app/core/tests/test_api.py

@@ -12,6 +12,7 @@
 USER_PERMISSIONS_URL = reverse("user-permission-list")
 PROJECTS_URL = reverse("project-list")
 ME_URL = reverse("my_profile")
+USER_STATUS_TYPES_URL = reverse("user-status-type-list")
 USERS_URL = reverse("user-list")
 EVENTS_URL = reverse("event-list")
 PRACTICE_AREA_URL = reverse("practice-area-list")
@@ -419,3 +420,13 @@ def test_create_url_type(auth_client):
     assert res.status_code == status.HTTP_201_CREATED
     assert res.data["name"] == payload["name"]
     assert res.data["description"] == payload["description"]
+
+
+def test_create_user_status_type(auth_client):
+    payload = {
+        "name": "Test User Status Type",
+        "description": "Test User Status Type description",
+    }
+    res = auth_client.post(USER_STATUS_TYPES_URL, payload)
+    assert res.status_code == status.HTTP_201_CREATED
+    assert res.data["name"] == payload["name"]

app/core/tests/test_models.py

@@ -171,3 +171,7 @@ def test_project_sdg_relationship(project):
 
 def test_url_type(url_type):
     assert str(url_type) == "This is a test url type name"
+
+
+def test_user_status_type(user_status_type):
+    assert str(user_status_type) == "Test User Status Type"

app/data/migrations/0008_userstatustype_seed.py

@@ -0,0 +1,32 @@
+from django.db import migrations
+
+from core.models import UserStatusType
+
+
+def forward(__code__, __reverse_code__):
+    items = [
+        (
+            1,
+            "Inactive",
+            "Member who has not checked into their project or Community of Practice for 4 weeks and does not have a timeAwayHold",
+        ),
+        (2, "Active", "Member that is checking into meetings"),
+        (
+            3,
+            "Time Away Hold",
+            "Hold placed by the member or their leader after they have announced a temporary absence",
+        ),
+        (4, "Barred", "Member who has been removed from the community"),
+    ]
+    for uuid, name, description in items:
+        UserStatusType.objects.create(uuid=uuid, name=name, description=description)
+
+
+def reverse(__code__, __reverse_code__):
+    UserStatusType.objects.all().delete()
+
+
+class Migration(migrations.Migration):
+    dependencies = [("data", "0007_urltype_seed")]
+
+    operations = [migrations.RunPython(forward, reverse)]

app/data/migrations/max_migration.txt

@@ -1 +1 @@
-0007_urltype_seed
+0008_userstatustype_seed