feat: add missing attachements on SensitivityArea APIs

docs/changelog.rst

@@ -110,6 +110,10 @@ In preparation for HD Views developments (PR #3298)
 - New ``POIParser`` to import POIs from files (with and without dynamic segmentation)
 - Change default color of imported filelayer (#306)
 
+**Improvements**
+
+- Sensitivity: Add missing attachments list to sensitive areas API
+
 **Bug fixes**
 
 - Fix shp zipfile import

geotrek/api/tests/test_v2.py

@@ -163,7 +163,7 @@
 SENSITIVE_AREA_PROPERTIES_JSON_STRUCTURE = sorted([
     'id', 'contact', 'create_datetime', 'description', 'elevation', 'geometry',
     'info_url', 'kml_url', 'name', 'period', 'practices', 'provider', 'published', 'species_id',
-    'structure', 'update_datetime', 'url'
+    'structure', 'update_datetime', 'url', 'attachments'
 ])
 
 SENSITIVE_AREA_SPECIES_PROPERTIES_JSON_STRUCTURE = sorted([

geotrek/api/v2/serializers.py

@@ -913,6 +913,7 @@ class SensitiveAreaSerializer(DynamicFieldsMixin, TimeStampedSerializer):
         geometry = geo_serializers.GeometryField(read_only=True, source="geom_transformed", precision=7)
         species_id = serializers.SerializerMethodField()
         kml_url = serializers.SerializerMethodField()
+        attachments = AttachmentSerializer(many=True)
 
         def get_name(self, obj):
             return get_translation_or_dict('name', self, obj.species)
@@ -941,7 +942,7 @@ class Meta(TimeStampedSerializer.Meta):
                 'id', 'contact', 'description', 'elevation',
                 'geometry', 'info_url', 'kml_url', 'name', 'period',
                 'practices', 'published', 'species_id', 'provider', 'structure',
-                'url'
+                'url', 'attachments'
             )
 
     class BubbleSensitiveAreaSerializer(SensitiveAreaSerializer):

geotrek/api/v2/views/sensitivity.py

@@ -1,8 +1,9 @@
 from django.conf import settings
 from django.contrib.gis.db.models.functions import Transform
-from django.db.models import F, Case, When
+from django.db.models import F, Case, When, Prefetch
 from django_filters.rest_framework.backends import DjangoFilterBackend
 
+from geotrek.common.models import Attachment
 from geotrek.api.v2 import serializers as api_serializers, \
     viewsets as api_viewsets
 from geotrek.common.functions import GeometryType, Buffer, Area
@@ -32,11 +33,16 @@ def get_serializer_class(self):
         return api_serializers.override_serializer(format_output, base_serializer_class)
 
     def get_queryset(self):
-        queryset = sensitivity_models.SensitiveArea.objects.existing() \
-            .filter(published=True) \
-            .select_related('species', 'structure') \
-            .prefetch_related('species__practices') \
+        queryset = (
+            sensitivity_models.SensitiveArea.objects.existing()
+            .filter(published=True)
+            .select_related('species', 'structure')
+            .prefetch_related(
+                'species__practices',
+                Prefetch('attachments', queryset=Attachment.objects.select_related('license', 'filetype', 'filetype__structure'))
+            )
             .alias(geom_type=GeometryType(F('geom')))
+        )
         if 'bubble' in self.request.GET:
             queryset = queryset.annotate(geom_transformed=Transform(F('geom'), settings.API_SRID))
         else:

geotrek/sensitivity/mixins.py

@@ -0,0 +1,56 @@
+import logging
+
+from django.conf import settings
+from django.contrib.gis.db.models.functions import Transform
+from django.db.models import F, Case, When, Prefetch
+from geotrek.common.models import Attachment
+from geotrek.common.functions import GeometryType, Buffer, Area
+
+logger = logging.getLogger(__name__)
+
+class SensitiveAreaQueryset:
+    """Mixin used for to properly querying SensitiveAreas"""
+
+    def get_queryset(self, *args, **kwargs):
+        qs = super(SensitiveAreaQueryset, self).get_queryset()
+        qs = (
+            (
+                qs
+                .filter(published=True)
+                .select_related("species", "structure")
+                .prefetch_related(
+                    "species__practices",
+                    Prefetch(
+                        "attachments",
+                        queryset=Attachment.objects.select_related(
+                            "license", "filetype", "filetype__structure"
+                        ),
+                    ),
+                )
+            )
+            .annotate(geom_type=GeometryType(F("geom")))
+            .annotate(
+                geom2d_transformed=Case(
+                    When(
+                        geom_type="POINT",
+                        then=Transform(
+                            Buffer(F("geom"), F("species__radius"), 4),
+                            settings.API_SRID,
+                        ),
+                    ),
+                    When(
+                        geom_type__in=("POLYGON", "MULTIPOLYGON"),
+                        then=Transform(F("geom"), settings.API_SRID),
+                    ),
+                )
+            )
+            .annotate(area=Area("geom2d_transformed"))
+            .order_by("-area")
+            )
+
+        if "practices" in self.request.GET:
+            qs = qs.filter(
+                species__practices__name__in=self.request.GET["practices"].split(",")
+            )
+
+        return qs

geotrek/sensitivity/serializers.py

@@ -1,6 +1,7 @@
 from django.urls import reverse
 from django.utils.translation import get_language
 from drf_dynamic_fields import DynamicFieldsMixin
+from geotrek.api.v2.serializers import AttachmentSerializer
 from mapentity.serializers import MapentityGeojsonModelSerializer
 from rest_framework import serializers as rest_serializers
 from rest_framework_gis import fields as rest_gis_fields
@@ -49,13 +50,14 @@ class Meta(MapentityGeojsonModelSerializer.Meta):
 class SensitiveAreaAPISerializer(TranslatedModelSerializer):
     species = SpeciesSerializer()
     kml_url = rest_serializers.SerializerMethodField()
+    attachments = AttachmentSerializer(many=True)
 
     def get_kml_url(self, obj):
         return reverse('sensitivity:sensitivearea_kml_detail', kwargs={'lang': get_language(), 'pk': obj.pk})
 
     class Meta:
         model = sensitivity_models.SensitiveArea
-        fields = ('id', 'species', 'description', 'contact', 'published', 'publication_date', 'kml_url')
+        fields = ('id', 'species', 'description', 'contact', 'published', 'publication_date', 'kml_url', 'attachments')
 
 
 class SensitiveAreaAPIGeojsonSerializer(GeoFeatureModelSerializer, SensitiveAreaAPISerializer):

geotrek/sensitivity/tests/test_functional.py

@@ -21,6 +21,7 @@ class SensitiveAreaViewsTests(GeotrekAPITestCase, CommonTest):
 
     def get_expected_json_attrs(self):
         return {
+            'attachments': [],
             'contact': '<a href="mailto:[email protected]">[email protected]</a>',
             'description': 'Blabla',
             'kml_url': '/api/en/sensitiveareas/{}.kml'.format(self.obj.pk),
@@ -91,6 +92,7 @@ class RegulatorySensitiveAreaViewsTests(GeotrekAPITestCase, CommonTest):
 
     def get_expected_json_attrs(self):
         return {
+            'attachments': [],
             'contact': '<a href="mailto:[email protected]">[email protected]</a>',
             'description': 'Blabla',
             'kml_url': '/api/en/sensitiveareas/{}.kml'.format(self.obj.pk),

geotrek/sensitivity/tests/test_views.py

@@ -89,6 +89,7 @@ def setUp(self):
             'update_datetime': self.sensitivearea.date_update.isoformat().replace('+00:00', 'Z'),
             'description': "Blabla",
             "elevation": None,
+            'attachments': [],
             'contact': '<a href="mailto:[email protected]">[email protected]</a>',
             'kml_url': 'http://testserver/api/en/sensitiveareas/{pk}.kml'.format(pk=self.pk),
             'info_url': self.species.url,

geotrek/sensitivity/views.py

@@ -19,6 +19,7 @@
 from geotrek.common.viewsets import GeotrekMapentityViewSet
 from .filters import SensitiveAreaFilterSet
 from .forms import SensitiveAreaForm, RegulatorySensitiveAreaForm
+from .mixins import SensitiveAreaQueryset
 from .models import SensitiveArea, Species
 from .serializers import SensitiveAreaSerializer, SensitiveAreaAPIGeojsonSerializer, SensitiveAreaAPISerializer, \
     SensitiveAreaGeojsonSerializer
@@ -110,28 +111,11 @@ def get_queryset(self):
         return qs
 
 
-class SensitiveAreaAPIViewSet(APIViewSet):
+class SensitiveAreaAPIViewSet(SensitiveAreaQueryset, APIViewSet):
     model = SensitiveArea
     serializer_class = SensitiveAreaAPISerializer
     geojson_serializer_class = SensitiveAreaAPIGeojsonSerializer
-
-    def get_queryset(self):
-        qs = SensitiveArea.objects.existing()
-        qs = qs.filter(published=True)
-        qs = qs.prefetch_related('species')
-        qs = qs.annotate(geom_type=GeometryType(F('geom')))
-        qs = qs.annotate(geom2d_transformed=Case(
-            When(geom_type='POINT', then=Transform(Buffer(F('geom'), F('species__radius'), 4), settings.API_SRID)),
-            When(geom_type__in=('POLYGON', 'MULTIPOLYGON'), then=Transform(F('geom'), settings.API_SRID))
-        ))
-        # Ensure smaller areas are at the end of the list, ie above bigger areas on the map
-        # to ensure we can select every area in case of overlapping
-        qs = qs.annotate(area=Area('geom2d_transformed')).order_by('-area')
-
-        if 'practices' in self.request.GET:
-            qs = qs.filter(species__practices__name__in=self.request.GET['practices'].split(','))
-
-        return qs
+    queryset = SensitiveArea.objects.existing()
 
 
 if 'geotrek.trekking' in settings.INSTALLED_APPS: