Merge pull request #4592 from unicef/ordering-models

ordering models

Author: domdinicola

src/hct_mis_api/api/models.py

@@ -30,14 +30,13 @@ def choices(cls) -> Tuple[Tuple[Any, Any], ...]:
 class APIToken(models.Model):
     user = models.ForeignKey(User, on_delete=models.CASCADE)
     key = models.CharField(_("Key"), max_length=40, unique=True, blank=True)
-    allowed_ips = models.CharField(_("IPs"), max_length=200, blank=True, null=True)
-    valid_from = models.DateField(default=timezone.now)
-    valid_to = models.DateField(blank=True, null=True)
-
-    valid_for = models.ManyToManyField(BusinessArea)
     grants = ChoiceArrayField(
         models.CharField(choices=Grant.choices(), max_length=255),
     )
+    valid_from = models.DateField(default=timezone.now)
+    valid_to = models.DateField(blank=True, null=True)
+    valid_for = models.ManyToManyField(BusinessArea)
+    allowed_ips = models.CharField(_("IPs"), max_length=200, blank=True, null=True)
 
     def __str__(self) -> str:
         return f"Token #{self.pk}"

src/hct_mis_api/apps/account/admin/user_role.py

@@ -24,6 +24,7 @@ class UserRoleInline(admin.TabularInline):
     model = account_models.UserRole
     extra = 0
     formset = UserRoleInlineFormSet
+    raw_id_fields = ("business_area", "role")
 
 
 @admin.register(account_models.UserRole)

src/hct_mis_api/apps/account/models.py

@@ -322,9 +322,9 @@ def formfield(self, form_class: Optional[Any] = ..., choices_form_class: Optiona
 
 
 class UserRole(NaturalKeyModel, TimeStampedUUIDModel):
-    business_area = models.ForeignKey("core.BusinessArea", related_name="user_roles", on_delete=models.CASCADE)
     user = models.ForeignKey("account.User", related_name="user_roles", on_delete=models.CASCADE)
     role = models.ForeignKey("account.Role", related_name="user_roles", on_delete=models.CASCADE)
+    business_area = models.ForeignKey("core.BusinessArea", related_name="user_roles", on_delete=models.CASCADE)
     expiry_date = models.DateField(
         blank=True, null=True, help_text="After expiry date this User Role will be inactive."
     )
@@ -337,9 +337,9 @@ def __str__(self) -> str:
 
 
 class UserGroup(NaturalKeyModel, models.Model):
-    business_area = models.ForeignKey("core.BusinessArea", related_name="user_groups", on_delete=models.CASCADE)
     user = models.ForeignKey("account.User", related_name="user_groups", on_delete=models.CASCADE)
     group = models.ForeignKey(Group, related_name="user_groups", on_delete=models.CASCADE)
+    business_area = models.ForeignKey("core.BusinessArea", related_name="user_groups", on_delete=models.CASCADE)
 
     class Meta:
         unique_together = ("business_area", "user", "group")

src/hct_mis_api/apps/accountability/admin.py

@@ -56,9 +56,14 @@ class MessageAdmin(AdminAdvancedFiltersMixin, HOPEModelAdminBase, IsOriginalAdmi
         "title",
         "body",
         "business_area",
+        "program",
+        "payment_plan",
         "registration_data_import",
         "sampling_type",
         "sample_size",
+        "created_by",
+        "copied_from",
+        "is_original",
     )
     list_display = (
         "unicef_id",
@@ -92,6 +97,13 @@ class SurveyAdmin(HOPEModelAdminBase):
         "sample_file",
         "sample_size",
     )
+    readonly_fields = (
+        "category",
+        "created_by",
+        "payment_plan",
+        "program",
+        "business_area",
+    )
     list_filter = ("category", ("flow_id", AutoCompleteFilter))
     search_fields = ("unicef_id", "title")
     raw_id_fields = ("created_by", "payment_plan", "program", "business_area")

src/hct_mis_api/apps/accountability/models.py

@@ -118,7 +118,6 @@ class Feedback(TimeStampedUUIDModel, AdminUrlMixin, UnicefIdentifiedModel):
         (NEGATIVE_FEEDBACK, _("Negative feedback")),
     )
 
-    business_area = models.ForeignKey("core.BusinessArea", on_delete=models.CASCADE)
     issue_type = models.CharField(verbose_name=_("Issue type"), choices=ISSUE_TYPE_CHOICES, max_length=20)
     household_lookup = models.ForeignKey(
         "household.Household",
@@ -136,13 +135,13 @@ class Feedback(TimeStampedUUIDModel, AdminUrlMixin, UnicefIdentifiedModel):
         on_delete=models.SET_NULL,
         verbose_name=_("Individual lookup"),
     )
-    description = models.TextField()
-    comments = models.TextField(blank=True, null=True)
-    admin2 = models.ForeignKey("geo.Area", null=True, blank=True, on_delete=models.SET_NULL)
+    business_area = models.ForeignKey("core.BusinessArea", on_delete=models.CASCADE)
+    program = models.ForeignKey("program.Program", null=True, blank=True, on_delete=models.CASCADE)
     area = models.CharField(max_length=250, blank=True)
+    admin2 = models.ForeignKey("geo.Area", null=True, blank=True, on_delete=models.SET_NULL)
+    description = models.TextField()
     language = models.TextField(blank=True)
-    consent = models.BooleanField(default=True)
-    program = models.ForeignKey("program.Program", null=True, blank=True, on_delete=models.CASCADE)
+    comments = models.TextField(blank=True, null=True)
     created_by = models.ForeignKey(
         settings.AUTH_USER_MODEL,
         on_delete=models.SET_NULL,
@@ -159,6 +158,7 @@ class Feedback(TimeStampedUUIDModel, AdminUrlMixin, UnicefIdentifiedModel):
         blank=True,
         verbose_name=_("Linked grievance"),
     )
+    consent = models.BooleanField(default=True)
     is_original = models.BooleanField(db_index=True, default=False)
     copied_from = models.ForeignKey(
         "self",
@@ -267,15 +267,15 @@ class Survey(UnicefIdentifiedModel, AdminUrlMixin, TimeStampedUUIDModel):
         on_delete=models.SET_NULL,
     )
     business_area = models.ForeignKey("core.BusinessArea", on_delete=models.CASCADE)
+    flow_id = models.CharField(max_length=255, blank=True, null=True)
+
+    sampling_type = models.CharField(max_length=50, choices=SAMPLING_CHOICES, default=SAMPLING_FULL_LIST)
+    sample_size = models.PositiveIntegerField(default=0)
     sample_file = models.FileField(upload_to="", blank=True, null=True)
     sample_file_generated_at = models.DateTimeField(blank=True, null=True)
 
-    sampling_type = models.CharField(max_length=50, choices=SAMPLING_CHOICES, default=SAMPLING_FULL_LIST)
     full_list_arguments = models.JSONField(default=dict)
     random_sampling_arguments = models.JSONField(default=dict)
-    sample_size = models.PositiveIntegerField(default=0)
-
-    flow_id = models.CharField(max_length=255, blank=True, null=True)
     successful_rapid_pro_calls = ArrayField(models.JSONField(), default=list)
 
     class Meta:

src/hct_mis_api/apps/core/admin.py

@@ -562,6 +562,7 @@ class XLSXKoboTemplateAdmin(SoftDeletableAdminMixin, HOPEModelAdminBase):
         "file",
         "import_status",
         "error_description",
+        "first_connection_failed_time",
     )
 
     def import_status(self, obj: Any) -> str:

src/hct_mis_api/apps/core/models.py

@@ -70,36 +70,43 @@ class BusinessArea(NaturalKeyModel, TimeStampedUUIDModel):
     code_to_cash_assist_mapping = {"575RE00000": "SLVK"}
     cash_assist_to_code_mapping = {v: k for k, v in code_to_cash_assist_mapping.items()}
     code = models.CharField(max_length=10, unique=True)
-    name = models.CharField(max_length=255)
-    long_name = models.CharField(max_length=255)
-    region_code = models.CharField(max_length=8)
-    region_name = models.CharField(max_length=8)
-    kobo_username = models.CharField(max_length=255, null=True, blank=True)
-    kobo_token = models.CharField(max_length=255, null=True, blank=True)
-    kobo_url = models.URLField(max_length=255, null=True, blank=True)
-    rapid_pro_host = models.URLField(null=True, blank=True)
-    rapid_pro_payment_verification_token = models.CharField(max_length=40, null=True, blank=True)
-    rapid_pro_messages_token = models.CharField(max_length=40, null=True, blank=True)
-    rapid_pro_survey_token = models.CharField(max_length=40, null=True, blank=True)
     slug = models.CharField(
         max_length=250,
         unique=True,
         db_index=True,
     )
-    custom_fields = JSONField(default=dict, blank=True)
-
-    has_data_sharing_agreement = models.BooleanField(default=False)
+    name = models.CharField(max_length=255)
+    long_name = models.CharField(max_length=255)
     parent = models.ForeignKey(
         "self",
         related_name="children",
         on_delete=models.SET_NULL,
         null=True,
         blank=True,
     )
+    partners = models.ManyToManyField(
+        to="account.Partner", through=BusinessAreaPartnerThrough, related_name="business_areas"
+    )
+    countries = models.ManyToManyField("geo.Country", related_name="business_areas")
+
     is_split = models.BooleanField(default=False)
+    region_code = models.CharField(max_length=8)
+    region_name = models.CharField(max_length=8)
+    has_data_sharing_agreement = models.BooleanField(default=False)
+    is_accountability_applicable = models.BooleanField(default=False)
+    active = models.BooleanField(default=False)
+    enable_email_notification = models.BooleanField(default=True, verbose_name="Automatic Email notifications enabled")
+
+    kobo_username = models.CharField(max_length=255, null=True, blank=True)
+    kobo_token = models.CharField(max_length=255, null=True, blank=True)
+    kobo_url = models.URLField(max_length=255, null=True, blank=True)
+
+    rapid_pro_host = models.URLField(null=True, blank=True)
+    rapid_pro_payment_verification_token = models.CharField(max_length=40, null=True, blank=True)
+    rapid_pro_messages_token = models.CharField(max_length=40, null=True, blank=True)
+    rapid_pro_survey_token = models.CharField(max_length=40, null=True, blank=True)
 
     postpone_deduplication = models.BooleanField(default=False)
-    countries = models.ManyToManyField("geo.Country", related_name="business_areas")
     deduplication_duplicate_score = models.FloatField(
         default=6.0,
         validators=[MinValueValidator(0.0)],
@@ -134,13 +141,8 @@ class BusinessArea(NaturalKeyModel, TimeStampedUUIDModel):
         help_text="Threshold for Face Image Deduplication",
         validators=[MinValueValidator(0.0), MaxValueValidator(100.0)],
     )
-    is_accountability_applicable = models.BooleanField(default=False)
-    active = models.BooleanField(default=False)
-    enable_email_notification = models.BooleanField(default=True, verbose_name="Automatic Email notifications enabled")
 
-    partners = models.ManyToManyField(
-        to="account.Partner", through=BusinessAreaPartnerThrough, related_name="business_areas"
-    )
+    custom_fields = JSONField(default=dict, blank=True)
 
     def save(self, *args: Any, **kwargs: Any) -> None:
         unique_slugify(self, self.name, slug_field_name="slug")
@@ -226,9 +228,12 @@ class FlexibleAttribute(SoftDeletableModel, NaturalKeyModel, TimeStampedUUIDMode
         (ASSOCIATED_WITH_INDIVIDUAL, _("Individual")),
     )
 
-    type = models.CharField(max_length=16, choices=TYPE_CHOICE)
     name = models.CharField(max_length=255)
-    required = models.BooleanField(default=False)
+    group = models.ForeignKey(
+        "core.FlexibleAttributeGroup", on_delete=models.CASCADE, related_name="flex_attributes", null=True, blank=True
+    )
+    type = models.CharField(max_length=16, choices=TYPE_CHOICE)
+    associated_with = models.SmallIntegerField(choices=ASSOCIATED_WITH_CHOICES)
     program = models.ForeignKey(
         "program.Program",
         on_delete=models.CASCADE,
@@ -243,12 +248,9 @@ class FlexibleAttribute(SoftDeletableModel, NaturalKeyModel, TimeStampedUUIDMode
         null=True,
         related_name="flex_field",
     )
+    required = models.BooleanField(default=False)
     label = JSONField(default=dict, validators=[label_contains_english_en_validator])
     hint = JSONField(default=dict)
-    group = models.ForeignKey(
-        "core.FlexibleAttributeGroup", on_delete=models.CASCADE, related_name="flex_attributes", null=True, blank=True
-    )
-    associated_with = models.SmallIntegerField(choices=ASSOCIATED_WITH_CHOICES)
 
     class Meta:
         constraints = [
@@ -347,8 +349,8 @@ class PeriodicFieldData(models.Model):
     )
 
     subtype = models.CharField(max_length=16, choices=TYPE_CHOICES)
-    number_of_rounds = models.IntegerField()
     rounds_names = ArrayField(models.CharField(max_length=255), default=list)
+    number_of_rounds = models.IntegerField()
 
     class Meta:
         verbose_name = "Periodic Field Data"
@@ -540,12 +542,10 @@ class Type(models.TextChoices):
         STANDARD = "STANDARD", "Standard"
         SOCIAL = "SOCIAL", "Social Workers"
 
-    label = models.CharField(max_length=32, blank=True)
     code = models.CharField(max_length=32)
+    label = models.CharField(max_length=32, blank=True)
     type = models.CharField(choices=Type.choices, null=True, blank=True, max_length=32)
     description = models.TextField(blank=True)
-    compatible_types = models.ManyToManyField("self", blank=True, symmetrical=False)
-    limit_to = models.ManyToManyField(to="BusinessArea", related_name="data_collecting_types", blank=True)
     active = models.BooleanField(default=True)
     deprecated = models.BooleanField(
         default=False, help_text="Cannot be used in new programs, totally hidden in UI, only admin have access"
@@ -554,6 +554,8 @@ class Type(models.TextChoices):
     household_filters_available = models.BooleanField(default=True)
     recalculate_composition = models.BooleanField(default=False)
     weight = models.PositiveSmallIntegerField(default=0)
+    compatible_types = models.ManyToManyField("self", blank=True, symmetrical=False)
+    limit_to = models.ManyToManyField(to="BusinessArea", related_name="data_collecting_types", blank=True)
 
     def __str__(self) -> str:
         return self.label

src/hct_mis_api/apps/grievance/admin.py

@@ -106,7 +106,7 @@ class TicketNoteAdmin(LinkedObjectsMixin, HOPEModelAdminBase):
 
 @admin.register(TicketComplaintDetails)
 class TicketComplaintDetailsAdmin(LinkedObjectsMixin, HOPEModelAdminBase):
-    raw_id_fields = ("ticket", "household", "individual")
+    raw_id_fields = ("ticket", "household", "individual", "payment")
 
 
 @admin.register(TicketSensitiveDetails)
@@ -136,7 +136,7 @@ class TicketDeleteIndividualDetailsAdmin(LinkedObjectsMixin, HOPEModelAdminBase)
 
 @admin.register(TicketDeleteHouseholdDetails)
 class TicketDeleteHouseholdDetailsAdmin(LinkedObjectsMixin, HOPEModelAdminBase):
-    raw_id_fields = ("ticket", "household")
+    raw_id_fields = ("ticket", "household", "reason_household")
 
 
 @admin.register(TicketNeedsAdjudicationDetails)
@@ -154,7 +154,7 @@ class TicketNeedsAdjudicationDetailsAdmin(LinkedObjectsMixin, HOPEModelAdminBase
 
 @admin.register(TicketPaymentVerificationDetails)
 class TicketPaymentVerificationDetailsAdmin(LinkedObjectsMixin, HOPEModelAdminBase):
-    raw_id_fields = ("ticket",)
+    raw_id_fields = ("ticket", "payment_verifications")
     filter_horizontal = ["payment_verifications"]