feat(odk): download xform definition as XML file

aether-odk-module/aether/odk/api/tests/test_views.py

@@ -16,8 +16,10 @@
 # specific language governing permissions and limitations
 # under the License.
 
+from django.http import FileResponse
 from django.test import override_settings
 from django.urls import reverse
+
 from rest_framework import status
 
 from . import CustomTestCase
@@ -152,3 +154,26 @@ def test__is_surveyor(self):
 
         response = self.client.get('/projects.json')
         self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
+
+    def test__project__download(self):
+        xform = self.helper_create_xform()
+
+        content_url = reverse('project-download', kwargs={'pk': xform.project_id})
+        self.assertEqual(content_url, f'/projects/{xform.project_id}/download/')
+        response = self.client.get(content_url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertTrue(isinstance(response, FileResponse))
+        self.assertEqual(
+            response['Content-Disposition'],
+            f'attachment; filename="{xform.project.name}.zip"'
+        )
+
+    def test__xform__download(self):
+        xform = self.helper_create_xform()
+
+        content_url = reverse('xform-download', kwargs={'pk': xform.pk})
+        self.assertEqual(content_url, f'/xforms/{xform.pk}/download/')
+        response = self.client.get(content_url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertTrue(isinstance(response, FileResponse))
+        self.assertEqual(xform.xml_data, response.getvalue().decode())

aether-odk-module/aether/odk/api/views.py

@@ -16,12 +16,18 @@
 # specific language governing permissions and limitations
 # under the License.
 
+import tempfile
+import zipfile
+
+from django.http import FileResponse
+
 from rest_framework import viewsets, status
 from rest_framework.decorators import action
 from rest_framework.permissions import IsAuthenticated
 from rest_framework.response import Response
 
 from aether.sdk.multitenancy.views import MtViewSetMixin, MtUserViewSetMixin
+from aether.sdk.utils import get_file_content
 
 from .models import Project, XForm, MediaFile
 from .serializers import (
@@ -82,6 +88,27 @@ def propagate(self, request, pk=None, *args, **kwargs):
 
         return self.retrieve(request, pk, *args, **kwargs)
 
+    @action(detail=True, methods=['get'])
+    def download(self, request, pk=None, *args, **kwargs):
+        '''
+        Downloads the linked XForm XML definitions.
+
+        Reachable at ``.../project/{pk}/download/``
+        '''
+
+        project = self.get_object_or_404(pk=pk)
+
+        with tempfile.TemporaryDirectory() as temp_dir:
+            zip_name = f'{project.name or project.project_id}.zip'
+            zip_path = f'{temp_dir}/{zip_name}'
+
+            with zipfile.ZipFile(zip_path, 'w') as file_zip:
+                for xform in project.xforms.all():
+                    xml_name = f'{xform.title}.xml'
+                    file_zip.writestr(xml_name, xform.xml_data)
+
+            return get_file_content(zip_name, zip_path, as_attachment=True)
+
 
 class XFormViewSet(MtViewSetMixin, viewsets.ModelViewSet):
     '''
@@ -130,6 +157,25 @@ def propagate(self, request, pk=None, *args, **kwargs):
 
         return self.retrieve(request, pk, *args, **kwargs)
 
+    @action(detail=True, methods=['get'])
+    def download(self, request, pk=None, *args, **kwargs):
+        '''
+        Downloads the linked XML definition.
+
+        Reachable at ``.../xforms/{pk}/download/``
+        '''
+
+        xform = self.get_object_or_404(pk=pk)
+
+        response = FileResponse(
+            streaming_content=xform.xml_data,
+            as_attachment=True,
+            filename=f'{xform.title}.xml',
+            content_type='text/xml',
+        )
+        response['Access-Control-Expose-Headers'] = 'Content-Disposition'
+        return response
+
 
 class MediaFileViewSet(MtViewSetMixin, viewsets.ModelViewSet):
     '''