Merge pull request #1857 from IFRCGo/feature/molnix-1813

Create a MolnixTagGroup model. A MolnixTag can belong to many MolnixTagGroups

Author: szabozoltan69

api/management/commands/sync_molnix.py

@@ -5,7 +5,7 @@
 from django.conf import settings
 from api.molnix_utils import MolnixApi
 from api.logger import logger
-from deployments.models import MolnixTag, PersonnelDeployment, Personnel
+from deployments.models import MolnixTag, MolnixTagGroup, PersonnelDeployment, Personnel
 from notifications.models import SurgeAlert, SurgeAlertType, SurgeAlertCategory
 from api.models import Event, Country, CronJobStatus
 from api.create_cron import create_cron_record
@@ -30,6 +30,7 @@
     'ICRC': 'ICRC'
 }
 
+
 def get_unique_tags(deployments, open_positions):
     tags = []
     tag_ids = []
@@ -41,7 +42,7 @@ def get_unique_tags(deployments, open_positions):
     return tags
 
 
-def add_tags(molnix_tags):
+def add_tags(molnix_tags, api):
     modality = ['In Person', 'Remote']
     region = ['ASIAP', 'AMER', 'AFRICA', 'MENA', 'EURO']
     scope = ['REGIONAL', 'GLOBAL']
@@ -52,6 +53,16 @@ def add_tags(molnix_tags):
 
     for molnix_tag in molnix_tags:
         tag, created = MolnixTag.objects.get_or_create(molnix_id=molnix_tag['id'])
+        tag_groups = api.get_tag_groups(molnix_tag['id']) if molnix_tag['id'] else []
+        for g in tag_groups:
+            tag_group, created = MolnixTagGroup.objects.get_or_create(
+                molnix_id=g['id'],
+                name=g['name'])
+            if created:
+                tag_group.created_at = g['created_at']
+            tag_group.updated_at = g['updated_at']
+            tag_group.save()
+            tag.groups.add(tag_group)
         tag.molnix_id = molnix_tag['id']
         tag.name = n = molnix_tag['name']
         tag.description = molnix_tag['description']
@@ -388,7 +399,7 @@ def handle(self, *args, **options):
 
         try:
             used_tags = get_unique_tags(deployments, open_positions)
-            add_tags(used_tags)
+            add_tags(used_tags, molnix)  # FIXME 2nd arg: a workaround to be able to get the group details inside.
             positions_messages, positions_warnings, positions_created = sync_open_positions(open_positions, molnix, countries)
             deployments_messages, deployments_warnings, deployments_created = sync_deployments(deployments, molnix, countries)
         except Exception as ex:

api/molnix_utils.py

@@ -55,6 +55,9 @@ def login(self):
     def get_tags(self):
         return self.call_api(path='tags')['tags']
 
+    def get_tag_groups(self, id):
+        return self.call_api(path='tags/edit/%d' % id)['tag']['groups']
+
     def get_open_positions(self):
         #return self.call_api_paginated(path='positions', response_key='positions')
         return self.call_api(path='positions/open')

deployments/admin.py

@@ -46,6 +46,13 @@ class SectorTagAdmin(CompareVersionAdmin, admin.ModelAdmin):
     search_fields = ('title',)
 
 
+class MolnixTagGroupAdmin(CompareVersionAdmin, admin.ModelAdmin):
+    model = models.MolnixTagGroup
+    list_display = ['name', 'molnix_id']
+    ordering = ('molnix_id',)
+    search_fields = ('name',)
+
+
 @admin.register(models.ERU)
 class ERUAdmin(CompareVersionAdmin, admin.ModelAdmin):
     search_fields = ('national_society_country__name',)
@@ -315,3 +322,4 @@ class EmergencyProjectAdmin(CompareVersionAdmin, admin.ModelAdmin):
 admin.site.register(models.ERUReadiness, ERUReadinessAdmin)
 admin.site.register(models.Sector, SectorAdmin)
 admin.site.register(models.SectorTag, SectorTagAdmin)
+admin.site.register(models.MolnixTagGroup, MolnixTagGroupAdmin)

deployments/migrations/0083_auto_20230727_0853.py

@@ -0,0 +1,33 @@
+# Generated by Django 3.2.20 on 2023-07-27 08:53
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('deployments', '0082_personnel_surge_alert'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='MolnixTagGroup',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('molnix_id', models.IntegerField()),
+                ('name', models.CharField(max_length=255, verbose_name='name')),
+                ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='created at')),
+                ('updated_at', models.DateTimeField(auto_now=True, verbose_name='updated at')),
+                ('is_deprecated', models.BooleanField(default=False, help_text='Is this a deprecated group?')),
+            ],
+            options={
+                'verbose_name': 'Molnix Tag Group',
+                'verbose_name_plural': 'Molnix Tag Groups',
+            },
+        ),
+        migrations.AddField(
+            model_name='molnixtag',
+            name='groups',
+            field=models.ManyToManyField(blank=True, related_name='groups', to='deployments.MolnixTagGroup'),
+        ),
+    ]

deployments/models.py

@@ -157,6 +157,22 @@ def __str__(self):
         return "%s, %s" % (self.country_deployed_to, self.region_deployed_to)
 
 
+@reversion.register()
+class MolnixTagGroup(models.Model):
+    molnix_id = models.IntegerField()
+    name = models.CharField(max_length=255, verbose_name=_("name"))
+    created_at = models.DateTimeField(verbose_name=_("created at"), auto_now_add=True)
+    updated_at = models.DateTimeField(verbose_name=_("updated at"), auto_now=True)
+    is_deprecated = models.BooleanField(default=False, help_text=_("Is this a deprecated group?"))
+
+    class Meta:
+        verbose_name = _("Molnix Tag Group")
+        verbose_name_plural = _("Molnix Tag Groups")
+
+    def __str__(self):
+        return self.name
+
+
 @reversion.register()
 class MolnixTag(models.Model):
     """
@@ -170,6 +186,11 @@ class MolnixTag(models.Model):
     color = models.CharField(max_length=6)
     tag_type = models.CharField(max_length=127)
     tag_category = models.CharField(null=True, max_length=127)
+    groups = models.ManyToManyField(
+        MolnixTagGroup,
+        related_name="groups",
+        blank=True,
+    )
 
     def __str__(self):
         return self.name

deployments/serializers.py

@@ -29,6 +29,7 @@
     ERU,
     PersonnelDeployment,
     MolnixTag,
+    MolnixTagGroup,
     Personnel,
     PartnerSocietyActivities,
     PartnerSocietyDeployment,
@@ -117,11 +118,18 @@ class Meta:
 
 
 class MolnixTagSerializer(ModelSerializer):
+    groups = serializers.SerializerMethodField()
 
     class Meta:
-        fields = ('id', 'molnix_id', 'name', 'description', 'color', 'tag_type')
+        fields = ('id', 'molnix_id', 'name', 'description', 'color', 'tag_type', 'groups')
         model = MolnixTag
 
+    @staticmethod
+    def get_groups(obj):
+        return [t.name for t in obj.groups.all() if not t.is_deprecated]
+        # or a detailed response, if needed:
+        # return [{"molnix_id": t.molnix_id, "name": t.name} for t in obj.groups.all() if not t.is_deprecated]
+
 
 class PersonnelDeploymentCsvSerializer(ModelSerializer):
     event_deployed_to = SmallEventForPersonnelCsvSerializer()