Merge pull request #2 from grahamu/add_total_count

Adding "paginator" in "meta" for data collections.

pinax/api/__init__.py

@@ -10,7 +10,6 @@
 from .registry import register, bind, registry  # noqa
 from .relationships import Relationship  # noqa
 from .resource import Resource, Attribute  # noqa
-from .test import TestCase  # noqa
 from .urls import URL as url  # noqa
 from .views import handler404  # noqa
 from .viewsets import ResourceEndpointSet, RelationshipEndpointSet  # noqa

pinax/api/jsonapi.py

@@ -13,6 +13,9 @@
 from .resource import Resource
 
 
+PAGINATOR_PER_PAGE = 100  # default number of items shown per page
+
+
 class Included(set):
 
     def __init__(self, paths):
@@ -48,7 +51,7 @@ def __init__(self, data=None, errors=None, links=False, included=None, meta=None
         self.errors = errors
         self.links = links
         self.included = included
-        self.meta = meta
+        self.meta = meta if meta else {}
         self.linkage = linkage
 
         # internal state
@@ -59,17 +62,17 @@ def get_serializable_data(self, request=None):
             ret = []
             data = self.data
             if request is not None:
-                paginator = Paginator(data, 100)
-                if "page[number]" in request.GET:
-                    try:
-                        page_number = int(request.GET.get("page[number]", "1"))
-                    except ValueError:
-                        page = paginator.page(1)
-                    else:
-                        page = paginator.page(page_number)
-                else:
-                    page = paginator.page(1)
-                self._current_page = data = page
+                per_page, page_number = self.get_pagination_values(request)
+                paginator = Paginator(data, per_page)
+                self._current_page = data = paginator.page(page_number)
+
+                # Obtain pagination meta-data
+                paginator = dict(paginator=dict(
+                    count=paginator.count,
+                    num_pages=paginator.num_pages
+                ))
+                self.meta.update(paginator)
+
             for x in data:
                 ret.append(x.serializable(
                     links=self.links,
@@ -88,6 +91,28 @@ def get_serializable_data(self, request=None):
         else:
             return self.data
 
+    def get_pagination_values(self, request):
+        if "page[size]" in request.GET:
+            try:
+                per_page = int(request.GET.get("page[size]", str(PAGINATOR_PER_PAGE)))
+            except ValueError:
+                per_page = PAGINATOR_PER_PAGE
+        else:
+            per_page = PAGINATOR_PER_PAGE
+        if per_page == 0:
+            # Zero is invalid number of items per page.
+            # Protect against Django division by zero error.
+            per_page = PAGINATOR_PER_PAGE
+
+        if "page[number]" in request.GET:
+            try:
+                page_number = int(request.GET.get("page[number]", "1"))
+            except ValueError:
+                page_number = 1
+        else:
+            page_number = 1
+        return per_page, page_number
+
     def build_links(self, request=None):
         links = {}
         if request is not None:
@@ -128,7 +153,7 @@ def serializable(self, request=None):
             res.update(dict(errors=self.errors))
         if self.included:
             res.update(dict(included=[r.serializable(links=self.links, request=request) for r in self.included]))
-        if self.meta is not None:
+        if self.meta:
             res.update(dict(meta=self.meta))
         if self.links:
             res.update(dict(links=self.build_links(request=request)))

pinax/api/tests/models.py

@@ -0,0 +1,5 @@
+from django.db import models
+
+
+class TestItem(models.Model):
+    title = models.CharField(max_length=100)

pinax/api/tests/resources.py

@@ -0,0 +1,17 @@
+from pinax import api
+
+from .models import TestItem
+
+
+@api.register
+class TestItemResource(api.Resource):
+
+    api_type = "testitem"
+    model = TestItem
+    attributes = [
+        "title",
+    ]
+
+    @property
+    def id(self):
+        return self.obj.pk

pinax/api/tests/tests.py → pinax/api/tests/test_assert.py

@@ -1,6 +1,6 @@
 from __future__ import unicode_literals
 
-from ..test import TestCase
+from .test import TestCase
 
 
 class TestAssertResourceGraph(TestCase):