Add Custom CSV serialier for Project

- Update Factory models
    - Add prefix for all name attributes
    - Fix project secondary_sectors post_generation logic
- Add visibility_display to Project API
- Add test for snapshot test for Project CSV serializer
- Add condition to skip opencensus if Instrumentaion key is not defined
  (For local development)

.flake8

@@ -1,5 +1,5 @@
 [flake8]
 ignore = C901, W504
 max-line-length = 130
-exclude = .git,__pycache__,old,build,dist,*migrations*
+exclude = .git,__pycache__,old,build,dist,*migrations*,*snapshots*
 max-complexity = 10

TESTING.md

@@ -53,7 +53,7 @@ generate random values for each instance of `ExampleModel` created by
 
 ```
 class ExampleFactory(factory.django.DjangoModelFactory):
-    name = fuzzy.FuzzyText(length=10)
+    name = fuzzy.FuzzyText(length=10, prefix='example-')
     age = fuzzy.FuzzyInteger(0)
 ```
 

api/factories/country.py

@@ -10,11 +10,11 @@ class CountryFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = models.Country
 
-    name = fuzzy.FuzzyText(length=100)
+    name = fuzzy.FuzzyText(length=50, prefix='country-')
     record_type = fuzzy.FuzzyChoice(models.CountryType)
     iso = fuzzy.FuzzyText(length=2)
     iso3 = fuzzy.FuzzyText(length=3)
-    society_name = fuzzy.FuzzyText(length=500)
+    society_name = fuzzy.FuzzyText(length=50, prefix='society-name-')
     society_url = fuzzy.FuzzyText(length=200)
     url_ifrc = fuzzy.FuzzyText(length=200)
     region = factory.SubFactory(region.RegionFactory)

api/factories/disaster_type.py

@@ -8,5 +8,5 @@ class DisasterTypeFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = models.DisasterType
 
-    name = fuzzy.FuzzyText(length=100)
+    name = fuzzy.FuzzyText(length=50, prefix='disaster-type-')
     summary = fuzzy.FuzzyText(length=500)

api/factories/district.py

@@ -9,7 +9,7 @@ class DistrictFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = models.District
 
-    name = fuzzy.FuzzyText(length=100)
+    name = fuzzy.FuzzyText(length=50, prefix='district-')
     code = fuzzy.FuzzyText(length=10)
     country = factory.SubFactory(country.CountryFactory)
     is_enclave = fuzzy.FuzzyChoice([True, False])

api/factories/event.py

@@ -4,14 +4,14 @@
 import pytz
 
 from .. import models
-from . import country, disaster_type
+from . import disaster_type
 
 
 class EventFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = models.Event
 
-    name = fuzzy.FuzzyText(length=100)
+    name = fuzzy.FuzzyText(length=50, prefix='event-')
     slug = fuzzy.FuzzyText(length=50)
     dtype = factory.SubFactory(disaster_type.DisasterTypeFactory)
 

api/serializers.py

@@ -147,7 +147,7 @@ class Meta:
 
 class DistrictSerializer(ModelSerializer):
     country = MiniCountrySerializer()
- 
+
     class Meta:
         model = District
         fields = ('name', 'code', 'country', 'id', 'is_deprecated',)
@@ -180,7 +180,10 @@ def get_centroid(self, district):
 
     class Meta:
         model = District
-        fields = ('name', 'code', 'country_name','country_iso','country_iso3', 'id', 'is_enclave', 'bbox', 'centroid', 'is_deprecated',)
+        fields = (
+            'id', 'name', 'code', 'country_name', 'country_iso', 'country_iso3',
+            'is_enclave', 'bbox', 'centroid', 'is_deprecated',
+        )
 
 
 class RegionKeyFigureSerializer(ModelSerializer):

deployments/drf_views.py

@@ -50,6 +50,7 @@
     PartnerDeploymentTableauSerializer,
     RegionalProjectSerializer,
     ProjectSerializer,
+    ProjectCsvSerializer,
 )
 
 
@@ -183,11 +184,16 @@ class ProjectViewset(RevisionMixin, ReadOnlyVisibilityViewsetMixin, viewsets.Mod
     queryset = Project.objects.prefetch_related(
         'user', 'reporting_ns', 'project_districts', 'event', 'dtype', 'regional_project',
     ).all()
-    # TODO: May require different permission for UNSAFE_METHODS (Also Country Level)
     filter_class = ProjectFilter
     serializer_class = ProjectSerializer
     ordering_fields = ('name',)
 
+    def get_serializer_class(self):
+        request_format_type = self.request.GET.get('format', 'json')
+        if request_format_type == 'csv':
+            return ProjectCsvSerializer
+        return super().get_serializer_class()
+
     def get_permissions(self):
         # Require authentication for unsafe methods only
         if self.action in ['list', 'retrieve']:

deployments/factories/project.py

@@ -2,7 +2,6 @@
 from factory import fuzzy
 import datetime
 import pytz
-from random import randrange
 
 from .. import models
 from . import user, regional_project
@@ -29,7 +28,7 @@ def project_districts(self, create, extracted, **kwargs):
 
     event = factory.SubFactory(event.EventFactory)
     dtype = factory.SubFactory(disaster_type.DisasterTypeFactory)
-    name = fuzzy.FuzzyText(length=500)
+    name = fuzzy.FuzzyText(length=50, prefix='project-')
     programme_type = fuzzy.FuzzyChoice(models.ProgrammeTypes)
     primary_sector = fuzzy.FuzzyChoice(models.Sectors)
 
@@ -39,8 +38,7 @@ def secondary_sectors(self, create, extracted, **kwargs):
             return
 
         if extracted:
-            for secondary_sector in extracted:
-                self.secondary_sectors.add(secondary_sector)
+            self.secondary_sectors = extracted
 
     operation_type = fuzzy.FuzzyChoice(models.OperationTypes)
     start_date = factory.LazyFunction(

deployments/factories/regional_project.py

@@ -10,6 +10,6 @@ class RegionalProjectFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = models.RegionalProject
 
-    name = fuzzy.FuzzyText(length=100)
+    name = fuzzy.FuzzyText(length=50, prefix='regional-project-')
     created_at = fuzzy.FuzzyDateTime(datetime.datetime(2008, 1, 1, tzinfo=pytz.utc))
     modified_at = fuzzy.FuzzyDateTime(datetime.datetime(2008, 1, 1, tzinfo=pytz.utc))

deployments/serializers.py

@@ -2,6 +2,7 @@
 from rest_framework import serializers
 from enumfields.drf.serializers import EnumSupportSerializerMixin
 
+from main.utils import get_merged_items_by_fields
 from lang.serializers import ModelSerializer
 from api.serializers import (
     DisasterTypeSerializer,
@@ -164,6 +165,7 @@ class ProjectSerializer(EnumSupportSerializerMixin, ModelSerializer):
     programme_type_display = serializers.CharField(source='get_programme_type_display', read_only=True)
     operation_type_display = serializers.CharField(source='get_operation_type_display', read_only=True)
     status_display = serializers.CharField(source='get_status_display', read_only=True)
+    visibility_display = serializers.CharField(source='get_visibility_display', read_only=True)
     secondary_sectors_display = serializers.ListField(source='get_secondary_sectors_display', read_only=True)
 
     class Meta:
@@ -201,3 +203,25 @@ def create(self, validated_data):
         project.user = self.context['request'].user
         project.save()
         return project
+
+
+class ProjectCsvSerializer(ProjectSerializer):
+    secondary_sectors = serializers.SerializerMethodField()
+    secondary_sectors_display = serializers.SerializerMethodField()
+    project_districts_detail = serializers.SerializerMethodField()
+
+    class Meta:
+        model = Project
+        exclude = ['project_districts']
+
+    def get_secondary_sectors(self, obj):
+        return ', '.join([str(sector.value) for sector in obj.secondary_sectors])
+
+    def get_secondary_sectors_display(self, obj):
+        return ', '.join(obj.get_secondary_sectors_display())
+
+    def get_project_districts_detail(self, obj):
+        return get_merged_items_by_fields(
+            obj.project_districts.all(),
+            ['name', 'code', 'id', 'is_enclave', 'is_deprecated']
+        )