Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add missing attachements on SensitivityArea APIs #3348

Merged
merged 11 commits into from
Feb 1, 2023
4 changes: 4 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ CHANGELOG
- New ``XMLParser`` to import content from XML
- ApidaeTrekParser: import trek's contact info into description

**Improvements**

- Sensitivity: Add missing attachments list to sensitive areas API

**Bug fixes**

- Fix shp zipfile import
Expand Down
2 changes: 1 addition & 1 deletion geotrek/api/tests/test_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,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([
Expand Down
3 changes: 2 additions & 1 deletion geotrek/api/v2/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -847,6 +847,7 @@ class SensitiveAreaSerializer(DynamicFieldsMixin, serializers.ModelSerializer):
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)
Expand Down Expand Up @@ -875,7 +876,7 @@ class Meta:
'id', 'contact', 'create_datetime', 'description', 'elevation',
'geometry', 'info_url', 'kml_url', 'name', 'period',
'practices', 'published', 'species_id', 'provider', 'structure',
'update_datetime', 'url'
'update_datetime', 'url', 'attachments'
)

class BubbleSensitiveAreaSerializer(SensitiveAreaSerializer):
Expand Down
16 changes: 11 additions & 5 deletions geotrek/api/v2/views/sensitivity.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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:
Expand Down
4 changes: 3 additions & 1 deletion geotrek/sensitivity/serializers.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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):
Expand Down
2 changes: 2 additions & 0 deletions geotrek/sensitivity/tests/test_functional.py
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down Expand Up @@ -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),
Expand Down
1 change: 1 addition & 0 deletions geotrek/sensitivity/tests/test_views.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Loading