Crate api for eap create, update, get

- Modified models
- Added serializers
- Added views
- Added test cases, factories

Author: Rup-Narayan-Rajbanshi

eap/admin.py

@@ -1,3 +1,9 @@
 from django.contrib import admin
 
 # Register your models here.
+from .models import EAP
+
+
+@admin.register(EAP)
+class EAPAdmin(admin.ModelAdmin):
+    pass

eap/factories.py

@@ -0,0 +1,76 @@
+import datetime
+import factory
+from factory import fuzzy
+from datetime import timezone
+
+from django.core.files.base import ContentFile
+
+from api.factories import (
+    disaster_type,
+    country,
+    district,
+)
+
+from .models import (
+    EAP,
+    EAPDocument,
+)
+
+
+class EAPDocumentFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = EAPDocument
+
+    file = factory.LazyAttribute(
+        lambda _: ContentFile(
+            factory.django.ImageField()._make_data(
+                {'width': 1024, 'height': 768}
+            ), 'flash_update.jpg'
+        )
+    )
+
+
+class EAPFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = EAP
+
+    district = factory.SubFactory(district.DistrictFactory)
+    country = factory.SubFactory(country.CountryFactory)
+    disaster_type = factory.SubFactory(disaster_type.DisasterTypeFactory)
+    document = factory.SubFactory(EAPDocumentFactory)
+    eap_number = fuzzy.FuzzyText(length=20)
+    approval_date = fuzzy.FuzzyDateTime(datetime.datetime(2008, 1, 1, tzinfo=timezone.utc))
+    status = fuzzy.FuzzyChoice(EAP.Status)
+    operational_timeframe = fuzzy.FuzzyInteger(0, 2)
+    lead_time = fuzzy.FuzzyInteger(0, 2)
+    eap_timeframe = fuzzy.FuzzyInteger(0, 2)
+    num_of_people = fuzzy.FuzzyInteger(0, 5)
+    total_budget = fuzzy.FuzzyInteger(0, 5)
+    readiness_budget = fuzzy.FuzzyInteger(0, 5)
+    pre_positioning_budget = fuzzy.FuzzyInteger(0, 5)
+    early_action_budget = fuzzy.FuzzyInteger(0, 5)
+    trigger_statement = fuzzy.FuzzyText(length=20)
+    overview = fuzzy.FuzzyText(length=50)
+    originator_name = fuzzy.FuzzyText(length=50)
+    originator_title = fuzzy.FuzzyText(length=50)
+    originator_email = fuzzy.FuzzyText(length=50)
+    originator_phone = fuzzy.FuzzyInteger(0, 9)
+
+    nsc_name = fuzzy.FuzzyText(length=50)
+    nsc_title = fuzzy.FuzzyText(length=50)
+    nsc_email = fuzzy.FuzzyText(length=50)
+    nsc_phone = fuzzy.FuzzyInteger(0, 9)
+
+    ifrc_focal_name = fuzzy.FuzzyText(length=50)
+    ifrc_focal_title = fuzzy.FuzzyText(length=50)
+    ifrc_focal_email = fuzzy.FuzzyText(length=50)
+    ifrc_focal_phone = fuzzy.FuzzyInteger(0, 9)
+
+    @factory.post_generation
+    def early_actions(self, create, extracted, **kwargs):
+        if not create:
+            return
+
+        if extracted:
+            for early_action in extracted:
+                self.early_actions.add(early_action)

eap/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 2.2.28 on 2022-07-08 05:56
+# Generated by Django 2.2.28 on 2022-07-13 05:26
 
 import deployments.models
 from django.conf import settings
@@ -13,8 +13,8 @@ class Migration(migrations.Migration):
     initial = True
 
     dependencies = [
-        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
         ('api', '0156_appealfilter_comment'),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
     ]
 
     operations = [
@@ -24,9 +24,9 @@ class Migration(migrations.Migration):
                 ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='created at')),
                 ('modified_at', models.DateTimeField(auto_now=True, verbose_name='updated at')),
-                ('eap_number', models.CharField(max_length=50, verbose_name='EAP Number')),
+                ('eap_number', models.CharField(editable=False, max_length=50, verbose_name='EAP Number')),
                 ('approval_date', models.DateField(verbose_name='Date of EAP Approval')),
-                ('status', models.CharField(choices=[('approved', 'Approved'), ('in_process', 'In Process')], default=eap.models.EAP.Status('in_process'), max_length=255, verbose_name='EAP Status')),
+                ('status', models.CharField(choices=[('approved', 'Approved'), ('activated', 'Activated')], default=eap.models.EAP.Status('approved'), max_length=255, verbose_name='EAP Status')),
                 ('operational_timeframe', models.IntegerField(verbose_name='Operational Timeframe (Months)')),
                 ('lead_time', models.IntegerField(verbose_name='Lead Time')),
                 ('eap_timeframe', models.IntegerField(verbose_name='EAP Timeframe (Years)')),
@@ -37,7 +37,6 @@ class Migration(migrations.Migration):
                 ('early_action_budget', models.IntegerField(blank=True, null=True, verbose_name='Early Actions Budget (CHF)')),
                 ('trigger_statement', models.TextField(verbose_name='Trigger Statement (Threshold for Activation)')),
                 ('overview', models.TextField(verbose_name='EAP Overview')),
-                ('document', models.FileField(blank=True, null=True, upload_to='eap/documents/', verbose_name='EAP Documents')),
                 ('originator_name', models.CharField(blank=True, max_length=255, null=True, verbose_name='Originator Name')),
                 ('originator_title', models.CharField(blank=True, max_length=255, null=True, verbose_name='Originator Title')),
                 ('originator_email', models.CharField(blank=True, max_length=255, null=True, verbose_name='Originator Email')),
@@ -90,16 +89,16 @@ class Migration(migrations.Migration):
             },
         ),
         migrations.CreateModel(
-            name='EAPRefrence',
+            name='EAPReference',
             fields=[
                 ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('source', models.CharField(blank=True, max_length=255, null=True, verbose_name='Name')),
                 ('url', models.URLField(blank=True, null=True, verbose_name='URL')),
                 ('eap', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='eap_reference', to='eap.EAP', verbose_name='EAP')),
             ],
             options={
-                'verbose_name': 'EAP Refrence',
-                'verbose_name_plural': 'EAP Refrences',
+                'verbose_name': 'EAP Reference',
+                'verbose_name_plural': 'EAP References',
             },
         ),
         migrations.CreateModel(
@@ -115,6 +114,23 @@ class Migration(migrations.Migration):
                 'verbose_name_plural': 'EAP Partners',
             },
         ),
+        migrations.CreateModel(
+            name='EAPDocument',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('file', models.FileField(blank=True, null=True, upload_to='')),
+                ('created_by', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='document_created_by', to=settings.AUTH_USER_MODEL, verbose_name='Created by')),
+            ],
+            options={
+                'verbose_name': 'Document',
+                'verbose_name_plural': 'Documents',
+            },
+        ),
+        migrations.AddField(
+            model_name='eap',
+            name='document',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='eap_document', to='eap.EAPDocument', verbose_name='EAP Documents'),
+        ),
         migrations.AddField(
             model_name='eap',
             name='early_actions',

eap/migrations/0002_auto_20220708_0747.py

@@ -50,10 +50,25 @@ def __str__(self):
         return f'{self.sector}'
 
 
+class EAPDocument(models.Model):
+    file = models.FileField(null=True, blank=True)
+    created_by = models.ForeignKey(
+        settings.AUTH_USER_MODEL, verbose_name=_('Created by'), related_name='document_created_by',
+        null=True, blank=True, on_delete=models.SET_NULL,
+    )
+
+    class Meta:
+        verbose_name = _('Document')
+        verbose_name_plural = _('Documents')
+
+    def __str__(self):
+        return str(self.id)
+
+
 class EAP(models.Model):
     class Status(TextChoices):  # TODO some more status choices are to be expected by client.
         APPROVED = 'approved', _('Approved')
-        IN_PROCESS = 'in_process', _('In Process')
+        ACTIVATED = 'activated', _('Activated')
 
     created_by = models.ForeignKey(
         settings.AUTH_USER_MODEL, verbose_name=_('Created by'), related_name='eap_created_by',
@@ -78,10 +93,10 @@ class Status(TextChoices):  # TODO some more status choices are to be expected b
         DisasterType, on_delete=models.SET_NULL, verbose_name=_('Disaster Type'),
         related_name='eap_disaster_type', null=True
     )
-    eap_number = models.CharField(max_length=50, verbose_name=_('EAP Number'))
+    eap_number = models.CharField(max_length=50, editable=False, verbose_name=_('EAP Number'))
     approval_date = models.DateField(verbose_name=_('Date of EAP Approval'))
     status = models.CharField(
-        max_length=255, choices=Status.choices, default=Status.IN_PROCESS,
+        max_length=255, choices=Status.choices, default=Status.APPROVED,
         verbose_name=_('EAP Status')
     )
     operational_timeframe = models.IntegerField(verbose_name=_('Operational Timeframe (Months)'))
@@ -94,8 +109,9 @@ class Status(TextChoices):  # TODO some more status choices are to be expected b
     early_action_budget = models.IntegerField(verbose_name=_('Early Actions Budget (CHF)'), null=True, blank=True)
     trigger_statement = models.TextField(verbose_name=_('Trigger Statement (Threshold for Activation)'))
     overview = models.TextField(verbose_name=_('EAP Overview'))
-    document = models.FileField(
-        verbose_name=_('EAP Documents'), upload_to='eap/documents/',
+    document = models.ForeignKey(
+        EAPDocument, on_delete=models.SET_NULL,
+        verbose_name=_('EAP Documents'), related_name='eap_document',
         null=True, blank=True
     )
     early_actions = models.ManyToManyField(
@@ -165,3 +181,4 @@ class Meta:
 
     def __str__(self):
         return f'{self.id}'
+

eap/models.py

@@ -0,0 +1,129 @@
+from django.utils.translation import ugettext
+
+from rest_framework import serializers
+
+from enumfields.drf.serializers import EnumSupportSerializerMixin
+
+from api.serializers import (
+    UserNameSerializer,
+    DisasterTypeSerializer,
+    CountrySerializer,
+    MiniDistrictSerializer,
+)
+
+from eap.models import (
+    EAP,
+    Action,
+    EAPPartner,
+    EAPReference,
+    EarlyAction,
+    EarlyActionIndicator,
+    EAPDocument,
+)
+
+from main.writable_nested_serializers import (
+    NestedCreateMixin,
+    NestedUpdateMixin,
+)
+
+
+class EAPReferenceSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = EAPReference
+        fields = '__all__'
+        read_only_fields = ('eap',)
+
+
+class EAPPartnerSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = EAPPartner
+        fields = '__all__'
+        read_only_fields = ('eap',)
+
+
+class EarlyActionIndicatorSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = EarlyActionIndicator
+        fields = ('__all__')
+
+
+class ActionSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Action
+        fields = ('__all__')
+        read_only_fields = ('early_action',)
+
+
+class EarlyActionSerializer(
+    NestedUpdateMixin,
+    NestedCreateMixin,
+    serializers.ModelSerializer
+):
+    indicators = EarlyActionIndicatorSerializer(many=True, required=False)
+    actions = ActionSerializer(source='action', many=True, required=False)
+    sector_display = serializers.CharField(source='get_sector_display', read_only=True)
+
+    class Meta:
+        model = EarlyAction
+        fields = ('__all__')
+
+
+class EAPActionSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Action
+        fields = ('__all__')
+        read_only_fields = ('early_action',)
+
+
+class EAPDocumentSerializer(serializers.ModelSerializer):
+    created_by_details = UserNameSerializer(source='created_by', read_only=True)
+    file = serializers.FileField(required=False)
+
+    class Meta:
+        model = EAPDocument
+        fields = '__all__'
+        read_only_fields = ('created_by',)
+
+    def create(self, validated_data):
+        validated_data['created_by'] = self.context['request'].user
+        return super().create(validated_data)
+
+
+class EAPSerializer(
+    EnumSupportSerializerMixin,
+    NestedUpdateMixin,
+    NestedCreateMixin,
+    serializers.ModelSerializer
+):
+    country_details = CountrySerializer(source='country', read_only=True)
+    district_details = MiniDistrictSerializer(source='district', read_only=True)
+    references = EAPReferenceSerializer(source='eap_reference', many=True, required=False)
+    partners = EAPPartnerSerializer(source='eap_partner', many=True, required=False)
+    early_actions = EarlyActionSerializer(many=True)
+    created_by_details = UserNameSerializer(source='created_by', read_only=True)
+    hazard_type_details = DisasterTypeSerializer(source='disaster_type', read_only=True)
+    document_details = EAPDocumentSerializer(source='document', read_only=True, required=False)
+
+    class Meta:
+        model = EAP
+        fields = '__all__'
+
+    def validate(self, validated_data):
+        district = validated_data['district']
+        if district:
+            if district.country != validated_data['country']:
+                raise serializers.ValidationError({
+                    'district': ugettext('Different districts found for given country')
+                })
+        return validated_data
+
+    def create(self, validated_data):
+        validated_data['created_by'] = self.context['request'].user
+        eap = super().create(validated_data)
+        return eap
+
+    def update(self, instance, validated_data):
+        validated_data['modified_by'] = self.context['request'].user
+        eap = super().update(instance, validated_data)
+        return eap
+