Merge remote-tracking branch 'upstream/develop' into develop

Author: riklaunim

README.rst

@@ -99,7 +99,7 @@ Running the example app
 
     $ git clone https://github.com/django-json-api/django-rest-framework-json-api.git
     $ cd django-rest-framework-json-api && pip install -e .
-    $ django-admin.py runserver
+    $ django-admin.py runserver --settings=example.settings
 
 Browse to http://localhost:8000
 

docs/usage.md

@@ -4,23 +4,18 @@
 The DJA package implements a custom renderer, parser, exception handler, and
 pagination. To get started enable the pieces in `settings.py` that you want to use.
 
-Many features of the JSON:API format standard have been implemented using Mixin classes in `serializers.py`. 
-The easiest way to make use of those features is to import ModelSerializer variants 
+Many features of the JSON:API format standard have been implemented using Mixin classes in `serializers.py`.
+The easiest way to make use of those features is to import ModelSerializer variants
 from `rest_framework_json_api` instead of the usual `rest_framework`
 
 ### Configuration
-We suggest that you simply copy the settings block below and modify it if necessary.
+We suggest that you copy the settings block below and modify it if necessary.
 ``` python
 REST_FRAMEWORK = {
-    'PAGINATE_BY': 10,
-    'PAGINATE_BY_PARAM': 'page_size',
-    'MAX_PAGINATE_BY': 100,
-    # DRF v3.1+
+    'PAGE_SIZE': 10,
+    'EXCEPTION_HANDLER': 'rest_framework_json_api.exceptions.exception_handler',
     'DEFAULT_PAGINATION_CLASS':
         'rest_framework_json_api.pagination.PageNumberPagination',
-    # older than DRF v3.1
-    'DEFAULT_PAGINATION_SERIALIZER_CLASS':
-        'rest_framework_json_api.pagination.PaginationSerializer',
     'DEFAULT_PARSER_CLASSES': (
         'rest_framework_json_api.parsers.JSONParser',
         'rest_framework.parsers.FormParser',
@@ -30,12 +25,14 @@ REST_FRAMEWORK = {
         'rest_framework_json_api.renderers.JSONRenderer',
         'rest_framework.renderers.BrowsableAPIRenderer',
     ),
+    'DEFAULT_METADATA_CLASS': 'rest_framework_json_api.metadata.JSONAPIMetadata',
 }
 ```
 
-If `PAGINATE_BY` is set the renderer will return a `meta` object with
+If `PAGE_SIZE` is set the renderer will return a `meta` object with
 record count and a `links` object with the next, previous, first, and last links.
-Pages can be selected with the `page` GET parameter.
+Pages can be selected with the `page` GET parameter. Page size can be controlled
+per request via the `PAGINATE_BY_PARAM` query parameter (`page_size` by default).
 
 ### Setting the resource_name
 
@@ -226,7 +223,7 @@ When set to pluralize:
 }
 ```
 
-Both `JSON_API_PLURALIZE_RELATION_TYPE` and `JSON_API_FORMAT_RELATION_KEYS` can be combined to 
+Both `JSON_API_PLURALIZE_RELATION_TYPE` and `JSON_API_FORMAT_RELATION_KEYS` can be combined to
 achieve different results.
 
 ### Meta
@@ -248,7 +245,7 @@ def get_root_meta(self, obj):
 ```
 to the serializer. It must return a dict and will be merged with the existing top level `meta`.
 
-<!-- 
+<!--
 ### Relationships
 ### Links
 ### Included

example/serializers.py

@@ -76,4 +76,5 @@ class CommentSerializer(serializers.ModelSerializer):
 
     class Meta:
         model = Comment
-        fields = ('entry', 'body', 'author',)
+        exclude = ('created_at', 'modified_at',)
+        # fields = ('entry', 'body', 'author',)

example/tests/test_serializers.py

@@ -1,3 +1,4 @@
+from django.core.urlresolvers import reverse
 from django.test import TestCase
 from django.utils import timezone
 
@@ -6,6 +7,11 @@
 
 from example.models import Blog, Entry, Author
 
+import pytest
+from example.tests.utils import dump_json, redump_json
+
+pytestmark = pytest.mark.django_db
+
 
 class TestResourceIdentifierObjectSerializer(TestCase):
     def setUp(self):
@@ -71,3 +77,38 @@ def test_deserialize_many(self):
 
         print(serializer.data)
 
+
+class TestModelSerializer(object):
+    def test_model_serializer_with_implicit_fields(self, comment, client):
+        expected = {
+            "data": {
+                "type": "comments",
+                "id": str(comment.pk),
+                "attributes": {
+                    "body": comment.body
+                },
+                "relationships": {
+                    "entry": {
+                        "data": {
+                            "type": "entries",
+                            "id": str(comment.entry.pk)
+                        }
+                    },
+                    "author": {
+                        "data": {
+                            "type": "authors",
+                            "id": str(comment.author.pk)
+                        }
+                    },
+                }
+            }
+        }
+
+        response = client.get(reverse("comment-detail", kwargs={'pk': comment.pk}))
+
+        assert response.status_code == 200
+
+        actual = redump_json(response.content)
+        expected_json = dump_json(expected)
+
+        assert actual == expected_json

example/tests/test_views.py

@@ -145,6 +145,22 @@ def test_delete_to_one_relationship_should_fail(self):
         response = self.client.delete(url, data=json.dumps(request_data), content_type='application/vnd.api+json')
         assert response.status_code == 405, response.content.decode()
 
+    def test_delete_relationship_overriding_with_none(self):
+        url = '/comments/{}'.format(self.second_comment.id)
+        request_data = {
+            'data': {
+                'type': 'comments',
+                'relationships': {
+                    'author': {
+                        'data': None
+                    }
+                }
+            }
+        }
+        response = self.client.patch(url, data=json.dumps(request_data), content_type='application/vnd.api+json')
+        assert response.status_code == 200, response.content.decode()
+        assert response.data['author'] == None
+
     def test_delete_to_many_relationship_with_no_change(self):
         url = '/entries/{}/relationships/comment_set'.format(self.first_entry.id)
         request_data = {

example/urls_test.py

@@ -1,7 +1,7 @@
 from django.conf.urls import include, url
 from rest_framework import routers
 
-from example.views import BlogViewSet, EntryViewSet, AuthorViewSet, EntryRelationshipView, BlogRelationshipView, \
+from example.views import BlogViewSet, EntryViewSet, AuthorViewSet, CommentViewSet, EntryRelationshipView, BlogRelationshipView, \
     CommentRelationshipView, AuthorRelationshipView
 from .api.resources.identity import Identity, GenericIdentity
 
@@ -10,6 +10,7 @@
 router.register(r'blogs', BlogViewSet)
 router.register(r'entries', EntryViewSet)
 router.register(r'authors', AuthorViewSet)
+router.register(r'comments', CommentViewSet)
 
 # for the old tests
 router.register(r'identities', Identity)

rest_framework_json_api/__init__.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 __title__ = 'djangorestframework-jsonapi'
-__version__ = '2.0.0-alpha.3'
+__version__ = '2.0.0-beta.1'
 __author__ = ''
 __license__ = 'MIT'
 __copyright__ = ''

rest_framework_json_api/parsers.py

@@ -40,7 +40,7 @@ def parse_relationships(data):
         parsed_relationships = dict()
         for field_name, field_data in relationships.items():
             field_data = field_data.get('data')
-            if isinstance(field_data, dict):
+            if isinstance(field_data, dict) or field_data is None:
                 parsed_relationships[field_name] = field_data
             elif isinstance(field_data, list):
                 parsed_relationships[field_name] = list(relation for relation in field_data)

rest_framework_json_api/serializers.py

@@ -137,12 +137,6 @@ class ModelSerializer(IncludedResourcesValidationMixin, SparseFieldsetsMixin, Mo
     """
     serializer_related_field = ResourceRelatedField
 
-    def __init__(self, *args, **kwargs):
-        meta_fields = getattr(self.Meta, 'meta_fields', [])
-        # we add meta_fields to fields so they will be serialized like usual
-        self.Meta.fields = tuple(tuple(self.Meta.fields) + tuple(meta_fields))
-        super(ModelSerializer, self).__init__(*args, **kwargs)
-
     def get_field_names(self, declared_fields, info):
         """
         We override the parent to omit explicity defined meta fields (such
@@ -155,5 +149,5 @@ def get_field_names(self, declared_fields, info):
             field = declared_fields[field_name]
             if field_name not in meta_fields:
                 declared[field_name] = field
-        return super(ModelSerializer, self).get_field_names(declared, info)
-
+        fields = super(ModelSerializer, self).get_field_names(declared, info)
+        return list(fields) + list(getattr(self.Meta, 'meta_fields', list()))

setup.py

@@ -76,7 +76,7 @@ def get_package_data(package):
         'inflection>=0.3.0'
     ],
     classifiers=[
-        'Development Status :: 3 - Alpha',
+        'Development Status :: 4 - Beta',
         'Environment :: Web Environment',
         'Framework :: Django',
         'Intended Audience :: Developers',