HAL List Serializer

drf_hal_json/serializers.py

@@ -1,26 +1,64 @@
 from collections import defaultdict
 
+from rest_framework.utils.serializer_helpers import ReturnDict
+
 from drf_hal_json import EMBEDDED_FIELD_NAME, LINKS_FIELD_NAME, URL_FIELD_NAME
 from drf_hal_json.fields import HalHyperlinkedPropertyField, HalContributeToLinkField, \
     HalHyperlinkedSerializerMethodField
 from rest_framework.fields import empty, FileField, ImageField
 from rest_framework.relations import HyperlinkedIdentityField, HyperlinkedRelatedField, ManyRelatedField, RelatedField
-from rest_framework.serializers import BaseSerializer, HyperlinkedModelSerializer
+from rest_framework.serializers import BaseSerializer, HyperlinkedModelSerializer, ListSerializer
 from rest_framework.utils.field_mapping import get_nested_relation_kwargs
 
 
+class HalListSerializer(ListSerializer):
+
+    @property
+    def data(self):
+        # The parent class returns ReturnList
+        return ReturnDict(
+            {
+                LINKS_FIELD_NAME: {
+                    URL_FIELD_NAME: {
+                        'href': self.context['request'].build_absolute_uri()
+                    }
+                },
+                EMBEDDED_FIELD_NAME: {
+                    # `items` mirrors hardcoded value in pagination classes
+                    'items': super(ListSerializer, self).data
+                }
+            },
+            serializer=self
+        )
+
+
 class HalModelSerializer(HyperlinkedModelSerializer):
     """
     Serializer for HAL representation of django models
     """
     serializer_related_field = HyperlinkedRelatedField
+    default_list_serializer = HalListSerializer
 
     def __init__(self, instance=None, data=empty, **kwargs):
         super(HalModelSerializer, self).__init__(instance, data, **kwargs)
         self.nested_serializer_class = self.__class__
         if data != empty and not LINKS_FIELD_NAME in data:
             data[LINKS_FIELD_NAME] = dict()  # put links in data, so that field validation does not fail
 
+    @classmethod
+    def many_init(cls, *args, **kwargs):
+        # inject the default into list_serializer_class (if not present)
+        meta = getattr(cls, 'Meta', None)
+        if meta is None:
+            class Meta:
+                pass
+            meta = Meta
+            setattr(cls, 'Meta', meta)
+        list_serializer_class = getattr(meta, 'list_serializer_class', None)
+        if list_serializer_class is None:
+            setattr(meta, 'list_serializer_class', cls.default_list_serializer)
+        return super(HalModelSerializer, cls).many_init(*args, **kwargs)
+
     def build_link_object(self, val):
         if (type([]) == type(val)):
             return [self.build_link_object(v) for v in val]

tests/testproject/tests.py

@@ -121,6 +121,15 @@ def test_pagination(self):
         self.assertIn("next", pages["_links"])
         next_link = pages["_links"]["next"]["href"]
 
+        unpaged = self.client.get("/abundant-unpaged/").data
+        # Renders with _links and _embedded
+        self.assertIn("_links", unpaged)
+        self.assertIn("_embedded", unpaged)
+        self.assertIn("self", unpaged["_links"])
+        # Includes no pages
+        self.assertNotIn("previous", unpaged["_links"])
+        self.assertNotIn("next", unpaged["_links"])
+
         pages = self.client.get(next_link).data
         self.assertIn("self", pages["_links"])
         self.assertIn("previous", pages["_links"])

tests/testproject/urls.py

@@ -4,7 +4,7 @@
 from .views import (AbundantResourceViewSet, CustomResourceViewSet,
                     RelatedResource1ViewSet, RelatedResource2ViewSet,
                     RelatedResource3ViewSet, TestResourceViewSet,
-                    URLResourceViewSet, FileResourceViewSet)
+                    URLResourceViewSet, FileResourceViewSet, AbundantUnpagedViewSet)
 
 router = DefaultRouter()
 router.register(r'test-resources', TestResourceViewSet)
@@ -13,6 +13,7 @@
 router.register(r'related-resources-3', RelatedResource3ViewSet)
 router.register(r'custom-resources', CustomResourceViewSet)
 router.register(r'abundant-resources', AbundantResourceViewSet)
+router.register(r'abundant-unpaged', AbundantUnpagedViewSet)
 router.register(r'url-resources', URLResourceViewSet)
 router.register(r'file-resources', FileResourceViewSet)
 urlpatterns = router.urls

tests/testproject/views.py

@@ -43,6 +43,10 @@ class AbundantResourceViewSet(HalCreateModelMixin, ModelViewSet):
     queryset = AbundantResource.objects.all()
 
 
+class AbundantUnpagedViewSet(AbundantResourceViewSet):
+    pagination_class = None
+
+
 class URLResourceViewSet(HalCreateModelMixin, ModelViewSet):
     serializer_class = HyperlinkedPropertySerializer
     queryset = URLResource.objects.all()