Added updated pagination to support DRF 3.1 pagination style

Author: jerel

README.rst

@@ -111,6 +111,10 @@ override ``settings.REST_FRAMEWORK``::
         'PAGINATE_BY': 10,
         'PAGINATE_BY_PARAM': 'page_size',
         'MAX_PAGINATE_BY': 100,
+        # DRF v3.1+
+        'DEFAULT_PAGINATION_CLASS':
+            'rest_framework_ember.pagination.PageNumberPagination',
+        # older than DRF v3.1
         'DEFAULT_PAGINATION_SERIALIZER_CLASS':
             'rest_framework_ember.pagination.PaginationSerializer',
         'DEFAULT_PARSER_CLASSES': (

example/settings.py

@@ -37,6 +37,10 @@
     'PAGINATE_BY': 1,
     'PAGINATE_BY_PARAM': 'page_size',
     'MAX_PAGINATE_BY': 100,
+    # DRF v3.1+
+    'DEFAULT_PAGINATION_CLASS':
+        'rest_framework_ember.pagination.PageNumberPagination',
+    # DRF v3.0 and older
     'DEFAULT_PAGINATION_SERIALIZER_CLASS':
         'rest_framework_ember.pagination.PaginationSerializer',
     'DEFAULT_PARSER_CLASSES': (

example/tests/test_model_viewsets.py

@@ -42,6 +42,7 @@ def test_key_in_list_result(self):
         meta = json_content.get('meta')
 
         self.assertEquals(expected.get('user'), json_content.get('user'))
+        self.assertEquals(meta.get('total'), 2)
         self.assertEquals(meta.get('count', 0),
             get_user_model().objects.count())
         self.assertEquals(meta.get('next'), 2)
@@ -75,10 +76,16 @@ def test_page_two_in_list_result(self):
         self.assertIsNone(meta.get('next'))
         self.assertIsNone(meta.get('next_link'))
         self.assertEqual(meta.get('previous'), 1)
-        self.assertEqual(u'http://testserver/identities?page=1',
-            meta.get('previous_link'))
         self.assertEqual(meta.get('page'), 2)
 
+        # Older versions of DRF add page=1 for first page. Later trim to root
+        try:
+            self.assertEqual(u'http://testserver/identities',
+                meta.get('previous_link'))
+        except AssertionError:
+            self.assertEqual(u'http://testserver/identities?page=1',
+                meta.get('previous_link'))
+
     def test_page_range_in_list_result(self):
         """
         Ensure that the range of a page can be changed from the client,

rest_framework_ember/pagination.py

@@ -6,6 +6,7 @@
 
 from rest_framework import serializers
 from rest_framework import pagination
+from rest_framework.views import Response
 from rest_framework.templatetags.rest_framework import replace_query_param
 
 # DRF 2.4.X compatibility.
@@ -76,7 +77,14 @@ def to_representation(self, value):
         return value.number
 
 
-class PaginationSerializer(pagination.BasePaginationSerializer):
+# compatibility for DRF 3.0 and older
+try:
+    BasePagination = pagination.PageNumberPagination
+except:
+    BasePagination = pagination.BasePaginationSerializer
+
+
+class PaginationSerializer(BasePagination):
     """
     Pagination serializer.
     """
@@ -95,3 +103,27 @@ class EmberPaginationSerializer(PaginationSerializer):
     """
     pass
 
+
+class PageNumberPagination(BasePagination):
+    """
+    An Ember (soon to be json-api) compatible pagination format
+    """
+    def get_paginated_response(self, data):
+        previous = None
+        next = None
+        if self.page.has_previous():
+            previous = self.page.previous_page_number()
+        if self.page.has_next():
+            next = self.page.next_page_number()
+
+        return Response({
+            'results': data,
+            'next': next,
+            'next_link': self.get_next_link(),
+            'page': self.page.number,
+            'previous': previous,
+            'previous_link': self.get_previous_link(),
+            'count': self.page.paginator.count,
+            'total': self.page.paginator.num_pages,
+        })
+