Bug #127870199

example/serializers.py

@@ -51,8 +51,7 @@ def get_body_format(self, obj):
     class Meta:
         model = Entry
         fields = ('blog', 'headline', 'body_text', 'pub_date', 'mod_date',
-                'authors', 'comments', 'suggested',)
-        meta_fields = ('body_format',)
+                  'authors', 'comments', 'suggested',)
 
 
 class AuthorBioSerializer(serializers.ModelSerializer):

example/tests/integration/test_model_resource_name.py

@@ -0,0 +1,137 @@
+import pytest
+from django.core.urlresolvers import reverse
+
+from example.tests.utils import load_json
+
+from example import models, serializers, views
+pytestmark = pytest.mark.django_db
+
+
+class _PatchedModel:
+    class JSONAPIMeta:
+        resource_name = "resource_name_from_JSONAPIMeta"
+
+
+def _check_resource_and_relationship_comment_type_match(django_client):
+    entry_response = django_client.get(reverse("entry-list"))
+    comment_response = django_client.get(reverse("comment-list"))
+
+    comment_resource_type = load_json(comment_response.content).get('data')[0].get('type')
+    comment_relationship_type = load_json(entry_response.content).get(
+        'data')[0].get('relationships').get('comments').get('data')[0].get('type')
+
+    assert comment_resource_type == comment_relationship_type, "The resource type seen in the relationships and head resource do not match"
+
+
+def _check_relationship_and_included_comment_type_are_the_same(django_client, url):
+    response = django_client.get(url + "?include=comments")
+    data = load_json(response.content).get('data')[0]
+    comment = load_json(response.content).get('included')[0]
+
+    comment_relationship_type = data.get('relationships').get('comments').get('data')[0].get('type')
+    comment_included_type = comment.get('type')
+
+    assert comment_relationship_type == comment_included_type, "The resource type seen in the relationships and included do not match"
+
+
+@pytest.mark.usefixtures("single_entry")
+class TestModelResourceName:
+
+    def test_model_resource_name_on_list(self, client):
+        models.Comment.__bases__ += (_PatchedModel,)
+        response = client.get(reverse("comment-list"))
+        data = load_json(response.content)['data'][0]
+        # name should be super-author instead of model name RenamedAuthor
+        assert (data.get('type') == 'resource_name_from_JSONAPIMeta'), (
+            'resource_name from model incorrect on list')
+
+    # Precedence tests
+    def test_resource_name_precendence(self, client):
+        # default
+        response = client.get(reverse("comment-list"))
+        data = load_json(response.content)['data'][0]
+        assert (data.get('type') == 'comments'), (
+            'resource_name from model incorrect on list')
+
+        # model > default
+        models.Comment.__bases__ += (_PatchedModel,)
+        response = client.get(reverse("comment-list"))
+        data = load_json(response.content)['data'][0]
+        assert (data.get('type') == 'resource_name_from_JSONAPIMeta'), (
+            'resource_name from model incorrect on list')
+
+        # serializer > model
+        serializers.CommentSerializer.Meta.resource_name = "resource_name_from_serializer"
+        response = client.get(reverse("comment-list"))
+        data = load_json(response.content)['data'][0]
+        assert (data.get('type') == 'resource_name_from_serializer'), (
+            'resource_name from serializer incorrect on list')
+
+        # view > serializer > model
+        views.CommentViewSet.resource_name = 'resource_name_from_view'
+        response = client.get(reverse("comment-list"))
+        data = load_json(response.content)['data'][0]
+        assert (data.get('type') == 'resource_name_from_view'), (
+            'resource_name from view incorrect on list')
+
+    def teardown_method(self, method):
+        models.Comment.__bases__ = (models.Comment.__bases__[0],)
+        try:
+            delattr(serializers.CommentSerializer.Meta, "resource_name")
+        except AttributeError:
+            pass
+        try:
+            delattr(views.CommentViewSet, "resource_name")
+        except AttributeError:
+            pass
+
+
+@pytest.mark.usefixtures("single_entry")
+class TestResourceNameConsistency:
+
+    # Included rename tests
+    def test_type_match_on_included_and_inline_base(self, client):
+        _check_relationship_and_included_comment_type_are_the_same(client, reverse("entry-list"))
+
+    def test_type_match_on_included_and_inline_with_JSONAPIMeta(self, client):
+        models.Comment.__bases__ += (_PatchedModel,)
+
+        _check_relationship_and_included_comment_type_are_the_same(client, reverse("entry-list"))
+
+    def test_type_match_on_included_and_inline_with_serializer_resource_name(self, client):
+        serializers.CommentSerializer.Meta.resource_name = "resource_name_from_serializer"
+
+        _check_relationship_and_included_comment_type_are_the_same(client, reverse("entry-list"))
+
+    def test_type_match_on_included_and_inline_with_serializer_resource_name_and_JSONAPIMeta(self, client):
+        models.Comment.__bases__ += (_PatchedModel,)
+        serializers.CommentSerializer.Meta.resource_name = "resource_name_from_serializer"
+
+        _check_relationship_and_included_comment_type_are_the_same(client, reverse("entry-list"))
+
+    # Relation rename tests
+    def test_resource_and_relationship_type_match(self, client):
+        _check_resource_and_relationship_comment_type_match(client)
+
+    def test_resource_and_relationship_type_match_with_serializer_resource_name(self, client):
+        serializers.CommentSerializer.Meta.resource_name = "resource_name_from_serializer"
+
+        _check_resource_and_relationship_comment_type_match(client)
+
+    def test_resource_and_relationship_type_match_with_JSONAPIMeta(self, client):
+        models.Comment.__bases__ += (_PatchedModel,)
+
+        _check_resource_and_relationship_comment_type_match(client)
+
+    def test_resource_and_relationship_type_match_with_serializer_resource_name_and_JSONAPIMeta(self, client):
+        models.Comment.__bases__ += (_PatchedModel,)
+        serializers.CommentSerializer.Meta.resource_name = "resource_name_from_serializer"
+
+        _check_resource_and_relationship_comment_type_match(client)
+
+    def teardown_method(self, method):
+        models.Comment.__bases__ = (models.Comment.__bases__[0],)
+        try:
+            delattr(serializers.CommentSerializer.Meta, "resource_name")
+        except AttributeError:
+            pass

example/urls_test.py

@@ -2,14 +2,15 @@
 from rest_framework import routers
 
 from example.views import BlogViewSet, EntryViewSet, AuthorViewSet, EntryRelationshipView, BlogRelationshipView, \
-    CommentRelationshipView, AuthorRelationshipView
+    CommentRelationshipView, AuthorRelationshipView, CommentViewSet
 from .api.resources.identity import Identity, GenericIdentity
 
 router = routers.DefaultRouter(trailing_slash=False)
 
 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)

example/views.py

@@ -41,4 +41,3 @@ class CommentRelationshipView(RelationshipView):
 class AuthorRelationshipView(RelationshipView):
     queryset = Author.objects.all()
     self_link_view_name = 'author-relationships'
-

rest_framework_json_api/__init__.py

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

rest_framework_json_api/exceptions.py

@@ -2,12 +2,18 @@
 from django.utils import six, encoding
 from django.utils.translation import ugettext_lazy as _
 from rest_framework import status, exceptions
-from rest_framework.views import exception_handler as drf_exception_handler
 
 from rest_framework_json_api.utils import format_value
 
 
 def exception_handler(exc, context):
+    # Import this here to avoid potential edge-case circular imports, which
+    # crashes with:
+    # "ImportError: Could not import 'rest_framework_json_api.parsers.JSONParser' for API setting
+    # 'DEFAULT_PARSER_CLASSES'. ImportError: cannot import name 'exceptions'.'"
+    #
+    # Also see: https://github.com/django-json-api/django-rest-framework-json-api/issues/158
+    from rest_framework.views import exception_handler as drf_exception_handler
     response = drf_exception_handler(exc, context)
 
     if not response:

rest_framework_json_api/metadata.py

@@ -138,6 +138,7 @@ def get_field_info(self, field):
                 for choice_value, choice_name in field.choices.items()
             ]
 
+        #Allow includes for all Relations unless explicitly
         if hasattr(serializer, 'included_serializers') and 'relationship_resource' in field_info:
             field_info['allows_include'] = field.field_name in serializer.included_serializers
 

rest_framework_json_api/mixins.py

@@ -14,7 +14,12 @@ def get_queryset(self):
             ids = dict(self.request.query_params).get('ids[]')
         else:
             ids = dict(self.request.QUERY_PARAMS).get('ids[]')
+
+        if 'filter[id]' in self.request.query_params:
+            ids = self.request.query_params.get('filter[id]').split(',')
+
         if ids:
-            self.queryset = self.queryset.filter(id__in=ids)
+            self.queryset = self.queryset.filter(pk__in=ids)
+
         return self.queryset
 

rest_framework_json_api/parsers.py

@@ -39,53 +39,62 @@ def parse_relationships(data):
         # Parse the relationships
         parsed_relationships = dict()
         for field_name, field_data in relationships.items():
-            field_data = field_data.get('data')
+            field_data = field_data.get('data', None)
             if isinstance(field_data, dict):
                 parsed_relationships[field_name] = field_data
             elif isinstance(field_data, list):
                 parsed_relationships[field_name] = list(relation for relation in field_data)
+            elif field_data == None:
+                parsed_relationships[field_name] = field_data
         return parsed_relationships
 
     def parse(self, stream, media_type=None, parser_context=None):
         """
         Parses the incoming bytestream as JSON and returns the resulting data
         """
         result = super(JSONParser, self).parse(stream, media_type=media_type, parser_context=parser_context)
+
         data = result.get('data')
 
         if data:
-            from rest_framework_json_api.views import RelationshipView
-            if isinstance(parser_context['view'], RelationshipView):
-                # We skip parsing the object as JSONAPI Resource Identifier Object and not a regular Resource Object
-                if isinstance(data, list):
-                    for resource_identifier_object in data:
-                        if not (resource_identifier_object.get('id') and resource_identifier_object.get('type')):
-                            raise ParseError(
-                                'Received data contains one or more malformed JSONAPI Resource Identifier Object(s)'
-                            )
-                elif not (data.get('id') and data.get('type')):
-                    raise ParseError('Received data is not a valid JSONAPI Resource Identifier Object')
+            type = data.get('type')
+            # if type is defined, treat it like a full object, otherwise just pass through the data
+            if type:
+                from rest_framework_json_api.views import RelationshipView
+                if isinstance(parser_context['view'], RelationshipView):
+                    # We skip parsing the object as JSONAPI Resource Identifier Object and not a regular Resource Object
+                    if isinstance(data, list):
+                        for resource_identifier_object in data:
+                            if not (resource_identifier_object.get('id') and resource_identifier_object.get('type')):
+                                raise ParseError(
+                                        'Received data contains one or more malformed JSONAPI Resource Identifier Object(s)'
+                                )
+                    elif not (data.get('id') and data.get('type')):
+                        raise ParseError('Received data is not a valid JSONAPI Resource Identifier Object')
 
-                return data
+                    return data
 
-            request = parser_context.get('request')
+                request = parser_context.get('request')
 
-            # Check for inconsistencies
-            resource_name = utils.get_resource_name(parser_context)
-            if data.get('type') != resource_name and request.method in ('PUT', 'POST', 'PATCH'):
-                raise exceptions.Conflict(
-                    "The resource object's type ({data_type}) is not the type "
-                    "that constitute the collection represented by the endpoint ({resource_type}).".format(
-                        data_type=data.get('type'),
-                        resource_type=resource_name
+                # Check for inconsistencies
+                resource_name = utils.get_resource_name(parser_context)
+                if data.get('type') != resource_name and request.method in ('PUT', 'POST', 'PATCH'):
+                    raise exceptions.Conflict(
+                            "The resource object's type ({data_type}) is not the type "
+                            "that constitute the collection represented by the endpoint ({resource_type}).".format(
+                                    data_type=data.get('type'),
+                                    resource_type=resource_name
+                            )
                     )
-                )
 
-            # Construct the return data
-            parsed_data = {'id': data.get('id')}
-            parsed_data.update(self.parse_attributes(data))
-            parsed_data.update(self.parse_relationships(data))
-            return parsed_data
+                # Construct the return data
+                parsed_data = {'id': data.get('id')}
+                parsed_data.update(self.parse_attributes(data))
+                parsed_data.update(self.parse_relationships(data))
+                return parsed_data
+
+            else:
+                return data
 
         else:
-            raise ParseError('Received document does not contain primary data')
+            return {}