Fix included resources not being included on list (django-json-api#307)

* Fix included resources not being included on list

* Fix included resources M2M type (TODO test)

* PR django-json-api#307: Remove TODO comment

* PR django-json-api#307: Fix included_resources assumption

* PR django-json-api#307: Fix redundant try/except

Author: rpatterson

example/serializers.py

@@ -68,6 +68,9 @@ class Meta:
                   'authors', 'comments', 'featured', 'suggested',)
         meta_fields = ('body_format',)
 
+    class JSONAPIMeta:
+        included_resources = ['comments']
+
 
 class AuthorBioSerializer(serializers.ModelSerializer):
 

example/tests/integration/test_includes.py

@@ -3,15 +3,9 @@
 
 from example.tests.utils import load_json
 
-try:
-    from unittest import mock
-except ImportError:
-    import mock
-
 pytestmark = pytest.mark.django_db
 
 
-@mock.patch('rest_framework_json_api.utils.get_default_included_resources_from_serializer', new=lambda s: ['comments'])
 def test_default_included_data_on_list(multiple_entries, client):
     return test_included_data_on_list(multiple_entries=multiple_entries, client=client, query='?page_size=5')
 
@@ -28,7 +22,6 @@ def test_included_data_on_list(multiple_entries, client, query='?include=comment
     assert comment_count == expected_comment_count, 'List comment count is incorrect'
 
 
-@mock.patch('rest_framework_json_api.utils.get_default_included_resources_from_serializer', new=lambda s: ['comments'])
 def test_default_included_data_on_detail(single_entry, client):
     return test_included_data_on_detail(single_entry=single_entry, client=client, query='')
 

example/tests/integration/test_non_paginated_responses.py

@@ -1,6 +1,11 @@
 from django.core.urlresolvers import reverse
 from django.conf import settings
 
+try:
+    from unittest import mock
+except ImportError:
+    import mock
+
 import pytest
 
 from example.views import EntryViewSet
@@ -12,6 +17,10 @@
 
 
 # rf == request_factory
+@mock.patch(
+    'rest_framework_json_api.utils'
+    '.get_default_included_resources_from_serializer',
+    new=lambda s: [])
 def test_multiple_entries_no_pagination(multiple_entries, rf):
 
     expected = {

example/tests/integration/test_pagination.py

@@ -1,11 +1,19 @@
 from django.core.urlresolvers import reverse
 
+try:
+    from unittest import mock
+except ImportError:
+    import mock
+
 import pytest
 from example.tests.utils import load_json
 
 pytestmark = pytest.mark.django_db
 
-
+@mock.patch(
+    'rest_framework_json_api.utils'
+    '.get_default_included_resources_from_serializer',
+    new=lambda s: [])
 def test_pagination_with_single_entry(single_entry, client):
 
     expected = {

rest_framework_json_api/utils.py

@@ -186,6 +186,13 @@ def get_related_resource_type(relation):
         relation_model = relation.model
     elif hasattr(relation, 'get_queryset') and relation.get_queryset() is not None:
         relation_model = relation.get_queryset().model
+    elif (
+            getattr(relation, 'many', False) and
+            hasattr(relation.child, 'Meta') and
+            hasattr(relation.child.Meta, 'model')):
+        # For ManyToMany relationships, get the model from the child
+        # serializer of the list serializer
+        relation_model = relation.child.Meta.model
     else:
         parent_serializer = relation.parent
         parent_model = None
@@ -266,10 +273,10 @@ def get_included_resources(request, serializer=None):
 
 
 def get_default_included_resources_from_serializer(serializer):
-    try:
-        return list(serializer.JSONAPIMeta.included_resources)
-    except AttributeError:
-        return []
+    meta = getattr(serializer, 'JSONAPIMeta', None)
+    if meta is None and getattr(serializer, 'many', False):
+        meta = getattr(serializer.child, 'JSONAPIMeta', None)
+    return list(getattr(meta, 'included_resources', []))
 
 
 def get_included_serializers(serializer):