Rename model and viewsets from HeaProfile to UserProfile and address PR feedback see HEA-580

Author: girumb

apps/common/migrations/0010_heaprofile.py renamed to apps/common/migrations/0010_userprofile.py

@@ -1,4 +1,4 @@
-# Generated by Django 5.1.1 on 2024-11-17 15:34
+# Generated by Django 5.0.2 on 2024-11-22 06:07
 
 import django.db.models.deletion
 import django.utils.timezone
@@ -16,7 +16,7 @@ class Migration(migrations.Migration):
 
     operations = [
         migrations.CreateModel(
-            name="HeaProfile",
+            name="UserProfile",
             fields=[
                 (
                     "created",
@@ -39,14 +39,11 @@ class Migration(migrations.Migration):
                         to=settings.AUTH_USER_MODEL,
                     ),
                 ),
-                ("expert", models.BooleanField(default=False)),
-                ("skip_tour", models.BooleanField(default=False)),
-                ("tour_last_viewed", models.DateField(null=True)),
-                ("livelihood_explorer_data", models.JSONField(blank=True, default=dict, null=True)),
+                ("profile_data", models.JSONField(blank=True, default=dict, null=True)),
             ],
             options={
-                "verbose_name": "hea user profile",
-                "verbose_name_plural": "hea user profiles",
+                "verbose_name": "user profile",
+                "verbose_name_plural": "user profiles",
             },
         ),
     ]

apps/common/models.py

@@ -953,21 +953,17 @@ class Meta:
         ]
 
 
-class HeaProfile(Model):
+class UserProfile(Model):
     """
-    A profile to store data associated with a user to be used by the Livelihoods Explorer
-    to create a dynamic user experience.
+    A profile to store data associated with a user to enable a customized user experience
     """
 
     user = models.OneToOneField(User, on_delete=CASCADE, primary_key=True, unique=True)
-    expert = models.BooleanField(default=False)
-    skip_tour = models.BooleanField(default=False)
-    tour_last_viewed = models.DateField(null=True)
-    livelihood_explorer_data = models.JSONField(default=dict, null=True, blank=True)
+    profile_data = models.JSONField(default=dict, null=True, blank=True)
 
     def __str__(self):
-        return f"hea_profile: {str(self.user)}"
+        return f"user_profile: {str(self.user)}"
 
     class Meta:
-        verbose_name = _("hea user profile")
-        verbose_name_plural = _("hea user profiles")
+        verbose_name = _("user profile")
+        verbose_name_plural = _("user profiles")

apps/common/serializers.py

@@ -1,7 +1,7 @@
 from django.contrib.auth.models import User
 from rest_framework import serializers
 
-from .models import ClassifiedProduct, Country, Currency, HeaProfile, UnitOfMeasure
+from .models import ClassifiedProduct, Country, Currency, UnitOfMeasure, UserProfile
 
 
 class CountrySerializer(serializers.ModelSerializer):
@@ -92,7 +92,7 @@ class Meta:
         ]
 
 
-class HeaProfileSerializer(serializers.ModelSerializer):
+class UserProfileSerializer(serializers.ModelSerializer):
     class Meta:
-        model = HeaProfile
-        fields = ("user", "expert", "skip_tour", "tour_last_viewed", "livelihood_explorer_data")
+        model = UserProfile
+        fields = ("user", "profile_data")

apps/common/tests/factories.py

@@ -60,9 +60,9 @@ def groups(self, create, extracted, **kwargs):
                 self.groups.add(group)
 
 
-class HeaProfileFactory(factory.django.DjangoModelFactory):
+class UserProfileFactory(factory.django.DjangoModelFactory):
     class Meta:
-        model = "common.HeaProfile"
+        model = "common.UserProfile"
         django_get_or_create = ("user",)
 
     user = factory.SubFactory(UserFactory)

apps/common/tests/test_viewsets.py

@@ -9,9 +9,9 @@
     ClassifiedProductFactory,
     CountryFactory,
     CurrencyFactory,
-    HeaProfileFactory,
     UnitOfMeasureFactory,
     UserFactory,
+    UserProfileFactory,
 )
 
 
@@ -212,12 +212,12 @@ def test_search_users(self):
         self.assertEqual(response.data[0]["first_name"], "Search")
 
 
-class HeaProfileViewSetTestCase(APITestCase):
+class UserProfileViewSetTestCase(APITestCase):
     def setUp(self):
         self.user = UserFactory(username="testuser", password="password123")
-        self.profile = HeaProfileFactory(user=self.user)
+        self.profile = UserProfileFactory(user=self.user)
         self.client.force_authenticate(user=self.user)
-        self.url = reverse("heaprofile-list")
+        self.url = reverse("userprofile-list")
 
     def test_get_current_profile(self):
         response = self.client.get(f"{self.url}current/")
@@ -233,7 +233,7 @@ def test_superuser_access_profiles(self):
 
     def test_queryset_filters(self):
         other_user = UserFactory(username="otheruser", password="password123")
-        HeaProfileFactory(user=other_user)
+        UserProfileFactory(user=other_user)
 
         # Current user profile only
         response = self.client.get(f"{self.url}?pk=current")

apps/common/viewsets.py

@@ -10,14 +10,14 @@
 
 from .fields import translation_fields
 from .filters import MultiFieldFilter
-from .models import ClassifiedProduct, Country, Currency, HeaProfile, UnitOfMeasure
+from .models import ClassifiedProduct, Country, Currency, UnitOfMeasure, UserProfile
 from .serializers import (
     ClassifiedProductSerializer,
     CountrySerializer,
     CurrencySerializer,
     CurrentUserSerializer,
-    HeaProfileSerializer,
     UnitOfMeasureSerializer,
+    UserProfileSerializer,
     UserSerializer,
 )
 
@@ -368,15 +368,15 @@ def current(self, request, *args, **kwargs):
         return self.retrieve(request, *args, **kwargs)
 
 
-class HeaProfileViewSet(BaseModelViewSet):
-    queryset = HeaProfile.objects.all()
-    serializer_class = HeaProfileSerializer
+class UserProfileViewSet(BaseModelViewSet):
+    queryset = UserProfile.objects.all()
+    serializer_class = UserProfileSerializer
     permission_classes = [CurrentUserOnly, IsAuthenticated]
 
     def get_object(self):
         pk = self.kwargs.get("pk")
         if pk == "current":
-            return self.request.user.heaprofile if self.request.user.id else None
+            return self.request.user.userprofile if self.request.user.id else None
         return super().get_object()
 
     def get_queryset(self):

hea/urls.py

@@ -49,9 +49,9 @@
     ClassifiedProductViewSet,
     CountryViewSet,
     CurrencyViewSet,
-    HeaProfileViewSet,
     UnitOfMeasureViewSet,
     UserViewSet,
+    UserProfileViewSet,
 )
 from metadata.viewsets import (
     HazardCategoryViewSet,
@@ -70,7 +70,7 @@
 router.register(r"unitofmeasure", UnitOfMeasureViewSet)
 router.register(r"classifiedproduct", ClassifiedProductViewSet)
 router.register(r"user", UserViewSet)
-router.register(r"heaprofile", HeaProfileViewSet)
+router.register(r"userprofile", UserProfileViewSet)
 
 # Metadata
 router.register(r"livelihoodcategory", LivelihoodCategoryViewSet)