Close #130. Data is now included on detail and list endpoints

Author: jerel

example/tests/integration/test_includes.py

@@ -1,18 +1,20 @@
 import pytest, json
 from django.core.urlresolvers import reverse
+from example.tests.utils import load_json
 
 pytestmark = pytest.mark.django_db
 
 
-def test_included_data_on_list(single_entry, client):
+def test_included_data_on_list(multiple_entries, client):
+    multiple_entries[1].comments = []
     response = client.get(reverse("entry-list") + '?include=comments')
-    included = json.loads(response.content).get('included')
+    included = load_json(response.content).get('included')
 
     assert [x.get('type') for x in included] == ['comments']
 
 def test_included_data_on_detail(single_entry, client):
     response = client.get(reverse("entry-detail", kwargs={'pk': single_entry.pk}) + '?include=comments')
-    included = json.loads(response.content).get('included')
+    included = load_json(response.content).get('included')
 
     assert [x.get('type') for x in included] == ['comments']
 

example/tests/utils.py

@@ -3,6 +3,10 @@
 from django.utils.encoding import force_bytes, force_text
 
 
+def load_json(data):
+    return json.loads(force_text(data))
+
+
 def dump_json(data):
     '''
     Converts a Python object to a JSON formatted string.

rest_framework_json_api/utils.py

@@ -402,8 +402,11 @@ def extract_relationships(fields, resource, resource_instance):
 
 
 def extract_included(fields, resource, resource_instance, included_resources):
-    included_data = list()
+    # this function may be called with an empty record (example: Browsable Interface)
+    if not resource_instance:
+        return
 
+    included_data = list()
     current_serializer = fields.serializer
     context = current_serializer.context
     included_serializers = get_included_serializers(current_serializer)
@@ -419,12 +422,18 @@ def extract_included(fields, resource, resource_instance, included_resources):
 
         try:
             included_resources.remove(field_name)
-            new_included_resources = [key.replace('%s.' % field_name, '', 1) for key in included_resources]
-            relation_instance_or_manager = getattr(resource_instance, field_name)
-            serializer_data = resource.get(field_name)
         except ValueError:
             # Skip fields not in requested included resources
             continue
+        else:
+            new_included_resources = [key.replace('%s.' % field_name, '', 1) for key in included_resources]
+            serializer_data = resource.get(field_name)
+
+        try:
+            relation_instance_or_manager = getattr(resource_instance, field_name)
+        except AttributeError:
+            # For ManyRelatedFields if `related_name` is not set we need to access `foo_set` from `source`
+            relation_instance_or_manager = getattr(resource_instance, field.child_relation.source)
 
         if isinstance(field, ManyRelatedField):
             serializer_class = included_serializers.get(field_name)