AB#241769: add ! beneficiary_group (#60)

* add ! beneficiary_group

* chg ! beneficiary group

Author: vitali-yanushchyk-valor

src/country_workspace/admin/__init__.py

@@ -6,6 +6,7 @@
 
 from ..cache.smart_panel import panel_cache
 from .batch import BatchAdmin  # noqa
+from .beneficiary_group import BeneficiaryGroupAdmin  # noqa
 from .constance import ConstanceAdmin  # noqa
 from .household import HouseholdAdmin  # noqa
 from .individual import IndividualAdmin  # noqa

src/country_workspace/admin/beneficiary_group.py

@@ -0,0 +1,27 @@
+from django.contrib import admin
+from django.http import HttpRequest
+
+from country_workspace.models import BeneficiaryGroup
+from .base import BaseModelAdmin
+
+
+@admin.register(BeneficiaryGroup)
+class BeneficiaryGroupAdmin(BaseModelAdmin):
+    list_display = ("name", "group_label", "group_label_plural", "member_label", "member_label_plural", "master_detail")
+    search_fields = (
+        "name",
+        "group_label",
+        "group_label_plural",
+        "member_label",
+        "member_label_plural",
+    )
+    ordering = ("name",)
+
+    def has_add_permission(self, request: HttpRequest) -> bool:
+        return False
+
+    def has_delete_permission(self, request: HttpRequest, obj: BeneficiaryGroup = None) -> bool:
+        return False
+
+    def has_change_permission(self, request: HttpRequest, obj: BeneficiaryGroup = None) -> bool:
+        return False

src/country_workspace/admin/program.py

@@ -20,6 +20,7 @@ class ProgramAdmin(BaseModelAdmin):
     list_display = (
         "name",
         "sector",
+        "beneficiary_group",
         "status",
         "active",
         "beneficiary_validator",
@@ -32,6 +33,7 @@ class ProgramAdmin(BaseModelAdmin):
         "status",
         "active",
         "sector",
+        "beneficiary_group",
         "beneficiary_validator",
         "household_checker",
         "individual_checker",

src/country_workspace/contrib/hope/sync/office.py

@@ -3,7 +3,7 @@
 from django.core.cache import cache
 from hope_flex_fields.models import DataChecker
 
-from country_workspace.models import Office, Program, SyncLog
+from country_workspace.models import BeneficiaryGroup, Office, Program, SyncLog
 
 from .. import constants
 from ..client import HopeClient
@@ -30,10 +30,11 @@ def sync_offices(stdout: TextIOBase | None = None) -> dict[str, int]:
                 )
                 totals["add" if created else "upd"] += 1
         SyncLog.objects.register_sync(Office)
-        return totals
+    return totals
 
 
 def sync_programs(limit_to_office: "Office | None" = None, stdout: TextIOBase | None = None) -> dict[str, int]:
+    sync_beneficiary_groups(stdout=stdout)
     if stdout:
         stdout.write("Fetching Programs data from HOPE...")
     client = HopeClient()
@@ -50,6 +51,7 @@ def sync_programs(limit_to_office: "Office | None" = None, stdout: TextIOBase |
                 office = Office.objects.get(code=record["business_area_code"])
                 if record["status"] not in [Program.ACTIVE, Program.DRAFT]:
                     continue
+                beneficiary_group = BeneficiaryGroup.objects.get(hope_id=record["beneficiary_group"])
                 p, created = Program.objects.get_or_create(
                     hope_id=record["id"],
                     defaults={
@@ -58,6 +60,7 @@ def sync_programs(limit_to_office: "Office | None" = None, stdout: TextIOBase |
                         "status": record["status"],
                         "sector": record["sector"],
                         "country_office": office,
+                        "beneficiary_group": beneficiary_group,
                     },
                 )
                 if created:
@@ -73,6 +76,29 @@ def sync_programs(limit_to_office: "Office | None" = None, stdout: TextIOBase |
     return totals
 
 
+def sync_beneficiary_groups(stdout: TextIOBase | None = None) -> bool:
+    totals = {"add": 0, "upd": 0}
+    client = HopeClient()
+    if stdout:
+        stdout.write("Fetching Beneficiary Groups data from HOPE...")
+    with cache.lock("sync-beneficiary-groups"):
+        for record in client.get("beneficiary-groups"):
+            __, created = BeneficiaryGroup.objects.get_or_create(
+                hope_id=record["id"],
+                defaults={
+                    "name": record["name"],
+                    "group_label": record["group_label"],
+                    "group_label_plural": record["group_label_plural"],
+                    "member_label": record["member_label"],
+                    "member_label_plural": record["member_label_plural"],
+                    "master_detail": record["master_detail"],
+                },
+            )
+            totals["add" if created else "upd"] += 1
+        SyncLog.objects.register_sync(BeneficiaryGroup)
+    return totals
+
+
 def sync_all(stdout: TextIOBase | None = None) -> bool:
     sync_offices(stdout=stdout)
     sync_programs(stdout=stdout)

src/country_workspace/migrations/0009_beneficiarygroup_alter_asyncjob_options_and_more.py

@@ -0,0 +1,68 @@
+# Generated by Django 5.1.7 on 2025-03-25 13:44
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("country_workspace", "0008_alter_individual_options"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="BeneficiaryGroup",
+            fields=[
+                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                (
+                    "hope_id",
+                    models.CharField(
+                        blank=True, help_text="Unique ID from HOPE", max_length=100, null=True, unique=True
+                    ),
+                ),
+                ("name", models.CharField(help_text="Name of the beneficiary group", max_length=255, unique=True)),
+                ("group_label", models.CharField(help_text="Label for the group", max_length=255)),
+                ("group_label_plural", models.CharField(help_text="Plural label for the group", max_length=255)),
+                ("member_label", models.CharField(help_text="Label for the member", max_length=255)),
+                ("member_label_plural", models.CharField(help_text="Plural label for the member", max_length=255)),
+                (
+                    "master_detail",
+                    models.BooleanField(default=True, help_text="Indicates if this is a master-detail group"),
+                ),
+            ],
+            options={
+                "verbose_name": "Beneficiary Group",
+                "verbose_name_plural": "Beneficiary Groups",
+                "ordering": ("name",),
+            },
+        ),
+        migrations.AlterModelOptions(
+            name="asyncjob",
+            options={
+                "permissions": (("debug_job", "Can debug background jobs"),),
+                "verbose_name": "Async Job",
+                "verbose_name_plural": "Async Jobs",
+            },
+        ),
+        migrations.AlterModelOptions(
+            name="batch",
+            options={"verbose_name": "Batch", "verbose_name_plural": "Batches"},
+        ),
+        migrations.AlterField(
+            model_name="office",
+            name="kobo_country_code",
+            field=models.CharField(blank=True, max_length=3, null=True),
+        ),
+        migrations.AddField(
+            model_name="program",
+            name="beneficiary_group",
+            field=models.ForeignKey(
+                blank=True,
+                help_text="Beneficiary group to which this program belongs",
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="programs",
+                to="country_workspace.beneficiarygroup",
+            ),
+        ),
+    ]

src/country_workspace/models/__init__.py

@@ -1,4 +1,5 @@
 from .batch import Batch  # noqa
+from .beneficiary_group import BeneficiaryGroup  # noqa
 from .household import Household  # noqa
 from .individual import Individual  # noqa
 from .jobs import AsyncJob  # noqa

src/country_workspace/models/batch.py

@@ -1,4 +1,5 @@
 from django.db import models
+from django.utils.translation import gettext as _
 
 from .base import BaseModel
 from .user import User
@@ -19,6 +20,8 @@ class BatchSource(models.TextChoices):
 
     class Meta:
         unique_together = (("import_date", "name"),)
+        verbose_name = _("Batch")
+        verbose_name_plural = _("Batches")
 
     def __str__(self) -> str:
         return self.name or f"Batch self.pk ({self.country_office})"

src/country_workspace/models/beneficiary_group.py

@@ -0,0 +1,19 @@
+from django.db import models
+
+
+class BeneficiaryGroup(models.Model):
+    hope_id = models.CharField(max_length=100, blank=True, null=True, unique=True, help_text="Unique ID from HOPE")
+    name = models.CharField(max_length=255, unique=True, help_text="Name of the beneficiary group")
+    group_label = models.CharField(max_length=255, help_text="Label for the group")
+    group_label_plural = models.CharField(max_length=255, help_text="Plural label for the group")
+    member_label = models.CharField(max_length=255, help_text="Label for the member")
+    member_label_plural = models.CharField(max_length=255, help_text="Plural label for the member")
+    master_detail = models.BooleanField(default=True, help_text="Indicates if this is a master-detail group")
+
+    class Meta:
+        verbose_name = "Beneficiary Group"
+        verbose_name_plural = "Beneficiary Groups"
+        ordering = ("name",)
+
+    def __str__(self) -> str:
+        return self.name

src/country_workspace/models/jobs.py

@@ -27,6 +27,8 @@ class JobType(models.TextChoices):
 
     class Meta:
         permissions = (("debug_job", "Can debug background jobs"),)
+        verbose_name = "Async Job"
+        verbose_name_plural = "Async Jobs"
 
     def __str__(self) -> str:
         return self.description or f"Background Job #{self.pk}"

src/country_workspace/models/program.py

@@ -7,6 +7,7 @@
 from strategy_field.utils import fqn
 
 from country_workspace.models.office import Office
+from country_workspace.models.beneficiary_group import BeneficiaryGroup
 
 from ..validators.registry import NoopValidator, beneficiary_validator_registry
 from .base import BaseModel, Validable
@@ -44,6 +45,14 @@ class Program(BaseModel):
         (WASH, _("WASH")),
     )
     hope_id = models.CharField(max_length=200, unique=True, editable=False)
+    beneficiary_group = models.ForeignKey(
+        BeneficiaryGroup,
+        on_delete=models.PROTECT,
+        related_name="programs",
+        null=True,
+        blank=True,
+        help_text="Beneficiary group to which this program belongs",
+    )
     country_office = models.ForeignKey(Office, on_delete=models.CASCADE, related_name="programs")
     name = models.CharField(max_length=255)
     code = models.CharField(max_length=255, blank=True, null=True)