fixed rendering of non paginated responses

Author: abdulhaq-e

example/settings/dev.py

@@ -39,9 +39,12 @@
 JSON_API_FORMAT_KEYS = 'camelize'
 JSON_API_FORMAT_RELATION_KEYS = 'camelize'
 REST_FRAMEWORK = {
-    'PAGINATE_BY': 5,
-    'PAGINATE_BY_PARAM': 'page_size',
-    'MAX_PAGINATE_BY': 100,
+    # 'PAGINATE_BY': 5,
+    # 'PAGINATE_BY_PARAM': 'page_size',
+    # 'MAX_PAGINATE_BY': 100,
+    'PAGE_SIZE': 5,
+    # 'PAGINATE_BY_PARAM' should now be in the pagination class
+    # Same for 'MAX_PAGINATE_BY'.
     'EXCEPTION_HANDLER': 'rest_framework_json_api.exceptions.exception_handler',
     'DEFAULT_PAGINATION_CLASS':
         'rest_framework_json_api.pagination.PageNumberPagination',

example/settings/test.py

@@ -13,5 +13,6 @@
 JSON_API_FORMAT_RELATION_KEYS = 'camelize'
 JSON_API_PLURALIZE_RELATION_TYPE = True
 REST_FRAMEWORK.update({
-    'PAGINATE_BY': 1,
+    # 'PAGINATE_BY': 1,
+    'PAGE_SIZE': 1,
 })

example/tests/conftest.py

@@ -6,3 +6,27 @@
 register(BlogFactory)
 register(AuthorFactory)
 register(EntryFactory)
+
+
+@pytest.fixture
+def single_entry(author_factory, entry_factory):
+
+    author = author_factory(name="Joel Spolsky")
+    entry = entry_factory(
+        headline=("The Absolute Minimum Every Software Developer"
+                  "Absolutely, Positively Must Know About Unicode "
+                  "and Character Sets (No Excuses!)"),
+        blog__name='Joel on Software',
+        authors=(author, )
+    )
+
+
+@pytest.fixture
+def multiple_entries(single_entry, author_factory, entry_factory):
+
+    author = author_factory(name="Ned Batchelder")
+    entry = entry_factory(
+        headline=("Pragmatic Unicode"),
+        blog__name='Ned Batchelder Blog',
+        authors=(author, )
+    )

example/tests/test_format_keys.py

@@ -18,12 +18,17 @@ def setUp(self):
         self.detail_url = reverse('user-detail', kwargs={'pk': self.miles.pk})
 
         # Set the format keys settings.
-        setattr(settings, 'JSON_API_FORMAT_KEYS', 'camelize')
+        # The below line is redundant because the default settings already
+        # use 'camelize'
+        # setattr(settings, 'JSON_API_FORMAT_KEYS', 'camelize')
         # CAMELIZE capitalize the type, needs to be checked
 
     def tearDown(self):
+        pass
         # Remove the format keys settings.
-        setattr(settings, 'JSON_API_FORMAT_KEYS', 'dasherize')
+        # The below line is redundant because the default settings already
+        # use 'camelize'
+        # setattr(settings, 'JSON_API_FORMAT_KEYS', 'camelize')
 
 
     def test_camelization(self):

example/tests/test_generic_viewset.py

@@ -11,6 +11,16 @@ class GenericViewSet(TestBase):
     """
     Test expected responses coming from a Generic ViewSet
     """
+
+    def setUp(self):
+        super(GenericViewSet, self).setUp()
+
+        setattr(settings, 'JSON_API_FORMAT_KEYS', 'dasherize')
+
+    def tearDown(self):
+
+        setattr(settings, 'JSON_API_FORMAT_KEYS', 'camelize')
+
     def test_default_rest_framework_behavior(self):
         """
         This is more of an example really, showing default behavior

example/tests/test_model_viewsets.py

@@ -3,6 +3,7 @@
 from django.contrib.auth import get_user_model
 from django.utils import encoding
 from django.core.urlresolvers import reverse
+from django.conf import settings
 
 from example.tests import TestBase
 from example.tests.utils import dump_json, redump_json
@@ -22,6 +23,12 @@ def setUp(self):
         super(ModelViewSetTests, self).setUp()
         self.detail_url = reverse('user-detail', kwargs={'pk': self.miles.pk})
 
+        setattr(settings, 'JSON_API_FORMAT_KEYS', 'dasherize')
+
+    def tearDown(self):
+
+        setattr(settings, 'JSON_API_FORMAT_KEYS', 'camelize')
+
     def test_key_in_list_result(self):
         """
         Ensure the result has a 'user' key since that is the name of the model

example/tests/test_non_paginated_responses.py

@@ -0,0 +1,78 @@
+from django.core.urlresolvers import reverse
+from django.conf import settings
+
+import pytest
+
+from ..views import EntryViewSet
+from rest_framework_json_api.pagination import PageNumberPagination
+
+from example.tests.utils import dump_json, redump_json
+
+pytestmark = pytest.mark.django_db
+
+
+def test_multiple_entries_no_pagination(rf, multiple_entries):
+
+    expected = {
+        "data": [
+            {
+                "type": "posts",
+                "id": "1",
+                "attributes":
+                {
+                    "headline": "The Absolute Minimum Every Software DeveloperAbsolutely, Positively Must Know About Unicode and Character Sets (No Excuses!)",
+                    "bodyText": "Here goes the body text",
+                    "pubDate": None,
+                    "modDate": None
+                },
+                "relationships":
+                {
+                    "blog": {
+                        "data": {"type": "blogs", "id": "1"}
+                    },
+                    "authors": {
+                        "meta": {"count": 1},
+                        "data": [{"type": "authors", "id": "1"}]
+                    }
+                }
+            },
+            {
+                "type": "posts",
+                "id": "2",
+                "attributes":
+                {
+                    "headline": "Pragmatic Unicode",
+                    "bodyText": "Here goes the body text",
+                    "pubDate": None,
+                    "modDate": None
+                },
+                "relationships":
+                {
+                    "blog": {
+                        "data": {"type": "blogs", "id": "2"}
+                    },
+                    "authors": {
+                        "meta": {"count": 1},
+                        "data": [{"type": "authors", "id": "2"}]
+                    }
+                }
+            },
+        ]
+    }
+
+    class NoPagination(PageNumberPagination):
+        page_size = None
+
+    class NonPaginatedEntryViewSet(EntryViewSet):
+        pagination_class = NoPagination
+
+    request = rf.get(
+        reverse("entry-list"))
+    view = NonPaginatedEntryViewSet.as_view({'get': 'list'})
+    response = view(request)
+    response.render()
+    # print response.content
+    content_dump = redump_json(response.content)
+    expected_dump = dump_json(expected)
+
+    assert content_dump == expected_dump

example/tests/test_pagination.py

@@ -6,19 +6,6 @@
 pytestmark = pytest.mark.django_db
 
 
-@pytest.fixture
-def single_entry(author_factory, entry_factory):
-
-    author = author_factory(name="Joel Spolsky")
-    entry = entry_factory(
-        headline=("The Absolute Minimum Every Software Developer"
-                  "Absolutely, Positively Must Know About Unicode "
-                  "and Character Sets (No Excuses!)"),
-        blog__name='Joel on Software',
-        authors=(author, )
-    )
-
-
 def test_pagination_with_single_entry(single_entry, client):
 
     expected = {
@@ -29,9 +16,9 @@ def test_pagination_with_single_entry(single_entry, client):
                 "attributes":
                 {
                     "headline": "The Absolute Minimum Every Software DeveloperAbsolutely, Positively Must Know About Unicode and Character Sets (No Excuses!)",
-                    "body-text": "Here goes the body text",
-                    "pub-date": None,
-                    "mod-date": None
+                    "bodyText": "Here goes the body text",
+                    "pubDate": None,
+                    "modDate": None
                 },
                 "relationships":
                 {

rest_framework_json_api/pagination.py

@@ -109,6 +109,9 @@ class PageNumberPagination(BasePagination):
     A json-api compatible pagination format
     """
 
+    page_size_query_param = 'page_size'
+    max_page_size = 100
+
     def build_link(self, index):
         if not index:
             return None

rest_framework_json_api/renderers.py

@@ -75,22 +75,26 @@ def render(self, data, accepted_media_type=None, renderer_context=None):
 
         json_api_included = list()
 
-        if view and hasattr(view, 'action') and view.action == 'list' and \
-                isinstance(data, dict) and 'results' in data:
+        if view and hasattr(view, 'action') and view.action == 'list':
+            # The below is not true for non-paginated responses
+            # and isinstance(data, dict):
+
             # If detail view then json api spec expects dict, otherwise a list
             # - http://jsonapi.org/format/#document-top-level
             # The `results` key may be missing if unpaginated or an OPTIONS request
+            if 'results' in data:
+                resources = data["results"]
+            else:
+                resources = data
 
-            results = data["results"]
-
-            resource_serializer = results.serializer
+            resource_serializer = resources.serializer
 
             # Get the serializer fields
             fields = utils.get_serializer_fields(resource_serializer)
 
             json_api_data = list()
-            for position in range(len(results)):
-                resource = results[position]  # Get current resource
+            for position in range(len(resources)):
+                resource = resources[position]  # Get current resource
                 resource_instance = resource_serializer.instance[position]  # Get current instance
                 json_api_data.append(
                     utils.build_json_resource_obj(fields, resource, resource_instance, resource_name))