Merge branch 'dev' into feature-bulk-edit

src/documents/serialisers.py

@@ -1,17 +1,23 @@
 import magic
+from django.utils.text import slugify
 from pathvalidate import validate_filename, ValidationError
 from rest_framework import serializers
+from rest_framework.fields import SerializerMethodField
 
 from .models import Correspondent, Tag, Document, Log, DocumentType
 from .parsers import is_mime_type_supported
 
 
-class CorrespondentSerializer(serializers.HyperlinkedModelSerializer):
+class CorrespondentSerializer(serializers.ModelSerializer):
 
     document_count = serializers.IntegerField(read_only=True)
 
     last_correspondence = serializers.DateTimeField(read_only=True)
 
+    def get_slug(self, obj):
+        return slugify(obj.name)
+    slug = SerializerMethodField()
+
     class Meta:
         model = Correspondent
         fields = (
@@ -26,10 +32,14 @@ class CorrespondentSerializer(serializers.HyperlinkedModelSerializer):
         )
 
 
-class DocumentTypeSerializer(serializers.HyperlinkedModelSerializer):
+class DocumentTypeSerializer(serializers.ModelSerializer):
 
     document_count = serializers.IntegerField(read_only=True)
 
+    def get_slug(self, obj):
+        return slugify(obj.name)
+    slug = SerializerMethodField()
+
     class Meta:
         model = DocumentType
         fields = (
@@ -43,10 +53,14 @@ class DocumentTypeSerializer(serializers.HyperlinkedModelSerializer):
         )
 
 
-class TagSerializer(serializers.HyperlinkedModelSerializer):
+class TagSerializer(serializers.ModelSerializer):
 
     document_count = serializers.IntegerField(read_only=True)
 
+    def get_slug(self, obj):
+        return slugify(obj.name)
+    slug = SerializerMethodField()
+
     class Meta:
         model = Tag
         fields = (
@@ -83,6 +97,18 @@ class DocumentSerializer(serializers.ModelSerializer):
     tags = TagsField(many=True)
     document_type = DocumentTypeField(allow_null=True)
 
+    original_file_name = SerializerMethodField()
+    archived_file_name = SerializerMethodField()
+
+    def get_original_file_name(self, obj):
+        return obj.get_public_filename()
+
+    def get_archived_file_name(self, obj):
+        if obj.archive_checksum:
+            return obj.get_public_filename(archive=True)
+        else:
+            return None
+
     class Meta:
         model = Document
         depth = 1
@@ -96,7 +122,9 @@ class DocumentSerializer(serializers.ModelSerializer):
             "created",
             "modified",
             "added",
-            "archive_serial_number"
+            "archive_serial_number",
+            "original_file_name",
+            "archived_file_name",
         )
 
 
@@ -178,8 +206,7 @@ class PostDocumentSerializer(serializers.Serializer):
         required=False,
     )
 
-    def validate(self, attrs):
-        document = attrs.get('document')
+    def validate_document(self, document):
 
         try:
             validate_filename(document.name)
@@ -191,32 +218,31 @@ class PostDocumentSerializer(serializers.Serializer):
 
         if not is_mime_type_supported(mime_type):
             raise serializers.ValidationError(
-                "This mime type is not supported.")
+                "This file type is not supported.")
 
-        attrs['document_data'] = document_data
+        return document.name, document_data
 
-        title = attrs.get('title')
+    def validate_title(self, title):
+        if title:
+            return title
+        else:
+            # do not return empty strings.
+            return None
 
-        if not title:
-            attrs['title'] = None
-
-        correspondent = attrs.get('correspondent')
+    def validate_correspondent(self, correspondent):
         if correspondent:
-            attrs['correspondent_id'] = correspondent.id
+            return correspondent.id
         else:
-            attrs['correspondent_id'] = None
+            return None
 
-        document_type = attrs.get('document_type')
+    def validate_document_type(self, document_type):
         if document_type:
-            attrs['document_type_id'] = document_type.id
+            return document_type.id
         else:
-            attrs['document_type_id'] = None
+            return None
 
-        tags = attrs.get('tags')
+    def validate_tags(self, tags):
         if tags:
-            tag_ids = [tag.id for tag in tags]
-            attrs['tag_ids'] = tag_ids
+            return [tag.id for tag in tags]
         else:
-            attrs['tag_ids'] = None
-
-        return attrs
+            return None