Merge remote-tracking branch 'django-json-api/develop' into develop

Author: Luca Corti

docs/usage.md

@@ -9,18 +9,13 @@ The easiest way to make use of those features is to import ModelSerializer varia
 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 = {
     'PAGE_SIZE': 10,
-    'PAGINATE_BY_PARAM': 'page_size',
-    'MAX_PAGINATE_BY': 100,
-    # DRF v3.1+
+    '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,6 +25,7 @@ REST_FRAMEWORK = {
         'rest_framework_json_api.renderers.JSONRenderer',
         'rest_framework.renderers.BrowsableAPIRenderer',
     ),
+    'DEFAULT_METADATA_CLASS': 'rest_framework_json_api.metadata.JSONAPIMetadata',
 }
 ```
 

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_relations.py

@@ -7,6 +7,7 @@
 from rest_framework_json_api.exceptions import Conflict
 from rest_framework_json_api.utils import format_relation_name
 from example.models import Blog, Entry, Comment, Author
+from example.serializers import CommentSerializer
 from rest_framework_json_api.relations import ResourceRelatedField
 
 
@@ -115,6 +116,15 @@ def test_read_only(self):
         serializer.is_valid(raise_exception=True)
         self.assertNotIn('comment_set', serializer.validated_data)
 
+    def test_invalid_resource_id_object(self):
+        comment = {'body': 'testing 123', 'entry': {'type': 'entry'}, 'author': {'id': '5'}}
+        serializer = CommentSerializer(data=comment)
+        assert not serializer.is_valid()
+        assert serializer.errors == {
+            'author': ["Invalid resource identifier object: missing 'type' attribute"],
+            'entry': ["Invalid resource identifier object: missing 'id' attribute"]
+        }
+
 
 class BlogFKSerializer(serializers.Serializer):
     blog = ResourceRelatedField(queryset=Blog.objects)

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

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/relations.py

@@ -19,6 +19,8 @@ class ResourceRelatedField(PrimaryKeyRelatedField):
         'does_not_exist': _('Invalid pk "{pk_value}" - object does not exist.'),
         'incorrect_type': _('Incorrect type. Expected resource identifier object, received {data_type}.'),
         'incorrect_relation_type': _('Incorrect relation type. Expected {relation_type}, received {received_type}.'),
+        'missing_type': _('Invalid resource identifier object: missing \'type\' attribute'),
+        'missing_id': _('Invalid resource identifier object: missing \'id\' attribute'),
         'no_match': _('Invalid hyperlink - No URL match.'),
     }
 
@@ -117,8 +119,16 @@ def to_internal_value(self, data):
         if not isinstance(data, dict):
             self.fail('incorrect_type', data_type=type(data).__name__)
         expected_relation_type = get_resource_type_from_queryset(self.queryset)
+
+        if 'type' not in data:
+            self.fail('missing_type')
+
+        if 'id' not in data:
+            self.fail('missing_id')
+
         if data['type'] != expected_relation_type:
             self.conflict('incorrect_relation_type', relation_type=expected_relation_type, received_type=data['type'])
+
         return super(ResourceRelatedField, self).to_internal_value(data['id'])
 
     def to_representation(self, value):

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',