Added the current page to meta and tests for pagination

Author: jerel

README.rst

@@ -103,8 +103,10 @@ override ``settings.REST_FRAMEWORK``::
     }
 
 
-If PAGINATE_BY is included the renderer will return a ``meta`` object with
-record count and the next and previous links.
+If `PAGINATE_BY` is set the renderer will return a ``meta`` object with
+record count and the next and previous links. Django Rest Framework looks 
+for the `page` GET parameter by default allowing you to make requests for
+subsets of the data with `this.store.find('identity', {page: 2});`.
 
 
 resource_name property

example/settings.py

@@ -34,6 +34,8 @@
 
 REST_FRAMEWORK = {
     'PAGINATE_BY': 1,
+    'PAGINATE_BY_PARAM': 'page_size',
+    'MAX_PAGINATE_BY': 100,
     'DEFAULT_PAGINATION_SERIALIZER_CLASS':
         'rest_framework_ember.pagination.EmberPaginationSerializer',
     'DEFAULT_PARSER_CLASSES': (

example/tests/test_model_viewsets.py

@@ -35,11 +35,68 @@ def test_key_in_list_result(self):
         }]}
 
         json_content = json.loads(response.content)
+        meta = json_content.get("meta")
+
+        self.assertEquals(expected.get('user'), json_content.get('user'))
+        self.assertEquals(meta.get('count', 0),
+            get_user_model().objects.count())
+        self.assertEquals(meta.get("next"), 2)
+        self.assertEqual(meta.get("page"), 1)
+
+    def test_page_two_in_list_result(self):
+        """
+        Ensure that the second page is reachable and is the correct data.
+        """
+        response = self.client.get(self.list_url, {'page': 2})
+        self.assertEqual(response.status_code, 200)
+
+        user = get_user_model().objects.all()[1]
+        expected = {"user": [{
+            'id': user.pk,
+            'first_name': user.first_name,
+            'last_name': user.last_name,
+            'email': user.email
+        }]}
+
+        json_content = json.loads(response.content)
+        meta = json_content.get("meta")
+
+        self.assertEquals(expected.get('user'), json_content.get('user'))
+        self.assertEquals(meta.get('count', 0),
+            get_user_model().objects.count())
+        self.assertIsNone(meta.get("next"))
+        self.assertEqual(meta.get("previous"), 1)
+        self.assertEqual(meta.get("page"), 2)
+
+    def test_page_range_in_list_result(self):
+        """
+        Ensure that the range of a page can be changed from the client.
+        """
+        response = self.client.get(self.list_url, {'page_size': 2})
+        self.assertEqual(response.status_code, 200)
+
+        users = get_user_model().objects.all()
+        expected = {"user": [
+        {
+            'id': users[0].pk,
+            'first_name': users[0].first_name,
+            'last_name': users[0].last_name,
+            'email': users[0].email
+        },
+        {
+            'id': users[1].pk,
+            'first_name': users[1].first_name,
+            'last_name': users[1].last_name,
+            'email': users[1].email
+        }]}
+
+        json_content = json.loads(response.content)
+        meta = json_content.get("meta")
         self.assertEquals(expected.get('user'), json_content.get('user'))
-        self.assertEquals(
-            json_content.get("meta", {}).get('count', 0),
+        self.assertEquals(meta.get('count', 0),
             get_user_model().objects.count())
 
+
     def test_key_in_detail_result(self):
         """
         Ensure the result has a "user" key.

rest_framework_ember/pagination.py

@@ -59,9 +59,21 @@ def to_native(self, value):
         return value.previous_page_number()
 
 
+class PageField(serializers.Field):
+    """
+    Field that returns a link to the previous page in paginated results.
+    """
+    page_field = 'page'
+
+    def to_native(self, value):
+        return value.number
+
+
+
 class EmberPaginationSerializer(pagination.BasePaginationSerializer):
     next = NextPageField(source='*')
     next_link = NextPageLinkField(source='*')
+    page = PageField(source='*')
     previous = PreviousPageField(source='*')
     previous_link = PreviousPageField(source='*')
     count = serializers.Field(source='paginator.count')