Add page and size to response meta info for Pagination

rolepoint · May 11, 2016 · dc7c50d · dc7c50d
1 parent 609e251
commit dc7c50d
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 4 deletions.
diff --git a/flump/pagination.py b/flump/pagination.py
@@ -65,6 +65,13 @@ def _make_get_many_response(self, entity_data, **kwargs):
         """
         Returns a `schemas.ManyResponseData` with the links replaced with
         those returned by `get_pagination_links`.
+
+        Also adds the `max_results` and `page` args to the meta.
         """
         response = super()._make_get_many_response(entity_data, **kwargs)
-        return response._replace(links=self.get_pagination_links(**kwargs))
+        response = response._replace(links=self.get_pagination_links(**kwargs))
+        pagination_args = self.get_pagination_args()
+        meta = response.meta
+        meta['extra'] = {'size': pagination_args.size,
+                         'page': pagination_args.page}
+        return response._replace(meta=meta)
diff --git a/flump/schemas.py b/flump/schemas.py
@@ -82,6 +82,10 @@ class LinkSchema(Schema):
 
     class MetaSchema(Schema):
         total_count = fields.Integer()
+        # This may contain extra data depending on the context. For instance
+        # the PageSizePagination mixin makes use of this field to include the
+        # current page and size in the response.
+        extra = fields.Dict()
 
     class JsonApiResponseSchema(Schema):
         data = fields.Nested(data_schema, many=many)

diff --git a/test/methods/test_get_many.py b/test/methods/test_get_many.py
@@ -76,7 +76,7 @@ def test_get_many(self, flask_client):
 
         assert response.status_code == 200
         assert response.json == {
-            'meta': {'total_count': 3},
+            'meta': {'total_count': 3, 'extra': {'size': 2, 'page': 1}},
             'data': [
                 {
                     'attributes': {'name': 'Carl', 'age': 26},
@@ -100,7 +100,7 @@ def test_get_many(self, flask_client):
 
         assert response.status_code == 200
         assert response.json == {
-            'meta': {'total_count': 3},
+            'meta': {'total_count': 3, 'extra': {'size': 2, 'page': 2}},
             'data': [
                 {
                     'attributes': {'name': 'Carl', 'age': 26},
@@ -129,7 +129,7 @@ def test_get_many_uses_query_string(self, flask_client):
 
         assert response.status_code == 200
         assert response.json == {
-            'meta': {'total_count': 10},
+            'meta': {'total_count': 10, 'extra': {'size': 3, 'page': 2}},
             'data': [
                 {
                     'attributes': {'name': 'Carl', 'age': 26},