API support for downloading compressed archives of multiple documents

src/documents/serialisers.py

@@ -192,14 +192,34 @@ class SavedViewSerializer(serializers.ModelSerializer):
         return saved_view
 
 
-class BulkEditSerializer(serializers.Serializer):
+class DocumentListSerializer(serializers.Serializer):
 
     documents = serializers.ListField(
-        child=serializers.IntegerField(),
+        required=True,
         label="Documents",
-        write_only=True
+        write_only=True,
+        child=serializers.IntegerField()
     )
 
+    def _validate_document_id_list(self, documents, name="documents"):
+        if not type(documents) == list:
+            raise serializers.ValidationError(f"{name} must be a list")
+        if not all([type(i) == int for i in documents]):
+            raise serializers.ValidationError(
+                f"{name} must be a list of integers")
+        count = Document.objects.filter(id__in=documents).count()
+        if not count == len(documents):
+            raise serializers.ValidationError(
+                f"Some documents in {name} don't exist or were "
+                f"specified twice.")
+
+    def validate_documents(self, documents):
+        self._validate_document_id_list(documents)
+        return documents
+
+
+class BulkEditSerializer(DocumentListSerializer):
+
     method = serializers.ChoiceField(
         choices=[
             "set_correspondent",
@@ -215,18 +235,6 @@ class BulkEditSerializer(serializers.Serializer):
 
     parameters = serializers.DictField(allow_empty=True)
 
-    def _validate_document_id_list(self, documents, name="documents"):
-        if not type(documents) == list:
-            raise serializers.ValidationError(f"{name} must be a list")
-        if not all([type(i) == int for i in documents]):
-            raise serializers.ValidationError(
-                f"{name} must be a list of integers")
-        count = Document.objects.filter(id__in=documents).count()
-        if not count == len(documents):
-            raise serializers.ValidationError(
-                f"Some documents in {name} don't exist or were "
-                f"specified twice.")
-
     def _validate_tag_id_list(self, tags, name="tags"):
         if not type(tags) == list:
             raise serializers.ValidationError(f"{name} must be a list")
@@ -238,10 +246,6 @@ class BulkEditSerializer(serializers.Serializer):
             raise serializers.ValidationError(
                 f"Some tags in {name} don't exist or were specified twice.")
 
-    def validate_documents(self, documents):
-        self._validate_document_id_list(documents)
-        return documents
-
     def validate_method(self, method):
         if method == "set_correspondent":
             return bulk_edit.set_correspondent
@@ -392,9 +396,24 @@ class PostDocumentSerializer(serializers.Serializer):
             return None
 
 
-class SelectionDataSerializer(serializers.Serializer):
+class BulkDownloadSerializer(DocumentListSerializer):
 
-    documents = serializers.ListField(
-        required=True,
-        child=serializers.IntegerField()
+    content = serializers.ChoiceField(
+        choices=["archive", "originals", "both"],
+        default="archive"
     )
+
+    compression = serializers.ChoiceField(
+        choices=["none", "deflated", "bzip2", "lzma"],
+        default="none"
+    )
+
+    def validate_compression(self, compression):
+        import zipfile
+
+        return {
+            "none": zipfile.ZIP_STORED,
+            "deflated": zipfile.ZIP_DEFLATED,
+            "bzip2": zipfile.ZIP_BZIP2,
+            "lzma": zipfile.ZIP_LZMA
+        }[compression]