Merge pull request #1375 from IFRCGo/feature/import-admin2

Add Admin2 to backend

Author: szabozoltan69

api/drf_views.py

@@ -36,6 +36,7 @@
     CountrySnippet,
 
     District,
+    Admin2,
 
     Event,
     Snippet,
@@ -80,6 +81,8 @@
     MiniDistrictGeoSerializer,
     DistrictSerializerRMD,
 
+    Admin2Serializer,
+
     SnippetSerializer,
     ListMiniEventSerializer,
     ListEventSerializer,
@@ -337,6 +340,19 @@ def get_serializer_class(self):
             return DistrictSerializer
 
 
+class Admin2Filter(filters.FilterSet):
+    class Meta:
+        model = Admin2
+        fields = ('admin1',)  
+
+
+class Admin2Viewset(viewsets.ReadOnlyModelViewSet):
+    queryset = Admin2.objects.all()
+    filterset_class = Admin2Filter
+    search_fields = ('name', 'district__name', 'district__country__name')
+    serializer_class = Admin2Serializer
+
+
 class EventFilter(filters.FilterSet):
     dtype = filters.NumberFilter(field_name='dtype', lookup_expr='exact')
     is_featured = filters.BooleanFilter(field_name='is_featured')

api/management/commands/import_admin2s_csv.py

@@ -0,0 +1,34 @@
+from django.db import transaction
+import csv
+from django.core.management.base import BaseCommand, CommandError
+from api.models import District, Admin2
+
+
+class Command(BaseCommand):
+    help = "Import admin2 data from CSV"
+    missing_args_message = "Filename is missing. Filename / path to CSV file required. Required headers in CSV: distr_code, GOadm2code, ADM2"
+
+    def add_arguments(self, parser):
+        parser.add_argument('filename', nargs='+', type=str)
+
+    @transaction.atomic
+    def handle(self, *args, **options):
+        filename = options['filename'][0]
+        with open(filename) as csvfile:
+            reader = csv.DictReader(csvfile)
+            for row in reader:
+                print(row)
+                district_code = row['distr_code']
+                district = District.objects.get(code=district_code)
+                print(district.name)
+                adm2_code = row['GOadm2code']
+                try:
+                    adm2 = Admin2.objects.get(code=adm2_code)
+                except:
+                    print('HELLO')
+                    adm2 = Admin2()
+                adm2.code = adm2_code
+                adm2.admin1 = district
+                adm2.name = row['ADM2']
+                adm2.save()
+                print(f'{adm2.name} saved')

api/migrations/0150_admin2_admin2geoms.py

@@ -0,0 +1,38 @@
+# Generated by Django 2.2.27 on 2022-03-23 11:22
+
+import django.contrib.gis.db.models.fields
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0149_auto_20220318_0413'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Admin2',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=100, verbose_name='name')),
+                ('code', models.CharField(max_length=64, unique=True, verbose_name='code')),
+                ('centroid', django.contrib.gis.db.models.fields.PointField(blank=True, null=True, srid=4326)),
+                ('bbox', django.contrib.gis.db.models.fields.PolygonField(blank=True, null=True, srid=4326)),
+                ('admin1', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='api.District', verbose_name='Admin 1')),
+            ],
+            options={
+                'verbose_name': 'admin2',
+                'verbose_name_plural': 'admin2s',
+                'ordering': ('code',),
+            },
+        ),
+        migrations.CreateModel(
+            name='Admin2Geoms',
+            fields=[
+                ('geom', django.contrib.gis.db.models.fields.MultiPolygonField(blank=True, null=True, srid=4326)),
+                ('admin2', models.OneToOneField(on_delete=django.db.models.deletion.DO_NOTHING, primary_key=True, serialize=False, to='api.Admin2', verbose_name='admin2')),
+            ],
+        ),
+    ]

api/migrations/0151_merge_20220325_1027.py

@@ -0,0 +1,14 @@
+# Generated by Django 2.2.27 on 2022-03-25 10:27
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0150_event_emergency_response_contact_email'),
+        ('api', '0150_admin2_admin2geoms'),
+    ]
+
+    operations = [
+    ]

api/models.py

@@ -271,6 +271,22 @@ def __str__(self):
         return f'{country_name} - {self.name}'
 
 
+class Admin2(models.Model):
+    """ Used for admin2, District refers to admin1 """
+    admin1 = models.ForeignKey(District, verbose_name=_('Admin 1'), on_delete=models.PROTECT)
+    name = models.CharField(verbose_name=_('name'), max_length=100)
+    code = models.CharField(verbose_name=_('code'), max_length=64, unique=True)
+    centroid = models.PointField(srid=4326, blank=True, null=True)
+    bbox = models.PolygonField(srid=4326, blank=True, null=True)    
+
+    class Meta:
+        verbose_name = _('admin2')
+        verbose_name_plural = _('admin2s')
+        ordering = ('code',)
+
+    def __str__(self):
+        return f'{self.admin1} - {self.name}'
+
 class CountryGeoms(models.Model):
     """ Admin0 geometries """
     geom = models.MultiPolygonField(srid=4326, blank=True, null=True)
@@ -282,6 +298,10 @@ class DistrictGeoms(models.Model):
     geom = models.MultiPolygonField(srid=4326, blank=True, null=True)
     district = models.OneToOneField(District, verbose_name=_('district'), on_delete=models.DO_NOTHING, primary_key=True)
 
+class Admin2Geoms(models.Model):
+    """ Admin2 geometries """
+    geom = models.MultiPolygonField(srid=4326, blank=True, null=True)
+    admin2 = models.OneToOneField(Admin2, verbose_name=_('admin2'), on_delete=models.DO_NOTHING, primary_key=True)
 
 class VisibilityChoices(IntEnum):
     MEMBERSHIP = 1

api/serializers.py

@@ -16,6 +16,7 @@
     Region,
     Country,
     District,
+    Admin2,
     CountryKeyFigure,
     RegionKeyFigure,
     CountrySnippet,
@@ -52,6 +53,28 @@
 from notifications.models import Subscription
 
 
+class GeoSerializerMixin:
+    '''
+        A mixin class to encapsulate common methods
+        used across serializers that deal with geo objects.
+        Will allow us to avoid repeating code to convert objects
+        to GeoJSON, etc.
+
+        FIXME: use this base class for existing serializers using geo objects.
+        FIXME: the methods can probably be thought through a bit better
+    '''
+    def get_bbox(self, district):
+        if district.bbox:
+            return json.loads(district.bbox.geojson)
+        else:
+            return None
+
+    def get_centroid(self, district):
+        if district.centroid:
+            return json.loads(district.centroid.geojson)
+        else:
+            return None
+
 class DisasterTypeSerializer(ModelSerializer):
     class Meta:
         model = DisasterType
@@ -185,13 +208,25 @@ class Meta:
         fields = ('name', 'code', 'country', 'id', 'is_deprecated',)
 
 
+
+
+class Admin2Serializer(GeoSerializerMixin, ModelSerializer):
+    bbox = serializers.SerializerMethodField()
+    centroid = serializers.SerializerMethodField()
+    district_id = serializers.IntegerField(source='admin1.id', read_only=True)
+
+    class Meta:
+        model = Admin2
+        fields = ('district_id', 'name', 'code', 'bbox', 'centroid',)
+
+
 class MiniDistrictSerializer(ModelSerializer):
     class Meta:
         model = District
         fields = ('name', 'code', 'id', 'is_enclave', 'is_deprecated',)
 
 
-class MiniDistrictGeoSerializer(ModelSerializer):
+class MiniDistrictGeoSerializer(GeoSerializerMixin, ModelSerializer):
     bbox = serializers.SerializerMethodField()
     centroid = serializers.SerializerMethodField()
     country_name = serializers.CharField(source='country.name', read_only=True)

api/test_views.py

@@ -397,3 +397,24 @@ def test_historical_events(self):
         response = self.client.get(f'/api/v2/go-historical/?region={region1.id}').json()
         self.assertEqual(response['count'], 1)
         self.assertEqual(response['results'][0]['id'], event1.id)
+
+
+class Admin2Test(APITestCase):
+
+    def test_admin2_api(self):
+        region = models.Region.objects.create(name=1)
+        country = models.Country.objects.create(name='Nepal', iso3='NLP', region=region)
+        admin1_1 = models.District.objects.create(name='admin1 1', code='NLP01', country=country)
+        admin1_2 = models.District.objects.create(name='admin1 2', code='NLP02', country=country)
+        admin2_1 = models.Admin2.objects.create(name='test 1', admin1=admin1_1, code='1')
+        admin2_2 = models.Admin2.objects.create(name='test 2', admin1=admin1_2, code='2')
+
+        # test fetching all admin2
+        response = self.client.get('/api/v2/admin2/').json()
+        self.assertEqual(response['count'], 2)
+
+        # test filtering by district
+        response = self.client.get(f'/api/v2/admin2/?admin1={admin1_1.id}').json()
+        self.assertEqual(response['count'], 1)
+        self.assertEqual(response['results'][0]['name'], 'test 1')
+

main/urls.py

@@ -85,6 +85,7 @@
 router.register(r'country_snippet', api_views.CountrySnippetViewset, basename='country_snippet')
 router.register(r'data-bank/country-overview', CountryOverviewViewSet)
 router.register(r'disaster_type', api_views.DisasterTypeViewset, basename='disaster_type')
+router.register(r'admin2', api_views.Admin2Viewset, basename='admin2')
 router.register(r'district', api_views.DistrictViewset, basename='district')
 router.register(r'district_rmd', api_views.DistrictRMDViewset, basename='district_rmd')
 router.register(r'domainwhitelist', registration_views.DomainWhitelistViewset)