Work done on included data extraction

Author: jsenecal

rest_framework_json_api/renderers.py

@@ -50,6 +50,8 @@ def render(self, data, accepted_media_type=None, renderer_context=None):
                 {resource_name: data}, accepted_media_type, renderer_context
             )
 
+        json_api_included = list()
+
         # If detail view then json api spec expects dict, otherwise a list
         # - http://jsonapi.org/format/#document-top-level
         if view and view.action == 'list':
@@ -59,12 +61,9 @@ def render(self, data, accepted_media_type=None, renderer_context=None):
             resource_serializer = results.serializer
 
             # Get the serializer fields
-            if hasattr(resource_serializer, 'child'):
-                fields = getattr(resource_serializer.child, 'fields')
-            else:
-                fields = getattr(resource_serializer, 'fields')
+            fields = utils.get_serializer_fields(resource_serializer)
 
-            json_api_data = []
+            json_api_data = list()
             for resource in results:
                 resource_data = [
                     ('type', resource_name),
@@ -75,8 +74,12 @@ def render(self, data, accepted_media_type=None, renderer_context=None):
                 # Add 'self' link if field is present and valid
                 if api_settings.URL_FIELD_NAME in resource and \
                         isinstance(fields[api_settings.URL_FIELD_NAME], RelatedField):
-                        resource_data.append(('links', {'self': resource[api_settings.URL_FIELD_NAME]}))
+                    resource_data.append(('links', {'self': resource[api_settings.URL_FIELD_NAME]}))
                 json_api_data.append(OrderedDict(resource_data))
+                included = utils.extract_included(fields, resource)
+                if included:
+                    json_api_included.extend(included)
+
         else:
             result_id = data.pop('id', None)
             json_api_data = {
@@ -93,7 +96,10 @@ def render(self, data, accepted_media_type=None, renderer_context=None):
         else:
             # on detail views we don't render anything but serializer data
             rendered_data = {}
+
         rendered_data['data'] = json_api_data
+        if len(json_api_included) > 0:
+            rendered_data['included'] = sorted(json_api_included, key=lambda item: (item['type'], item['id']))
 
         return super(JSONRenderer, self).render(
             rendered_data, accepted_media_type, renderer_context

rest_framework_json_api/utils.py

@@ -9,7 +9,7 @@
 from django.utils.six.moves.urllib.parse import urlparse, urlunparse
 from django.utils.translation import ugettext_lazy as _
 
-from rest_framework.serializers import BaseSerializer
+from rest_framework.serializers import BaseSerializer, ListSerializer
 from rest_framework.relations import RelatedField, HyperlinkedRelatedField
 from rest_framework.settings import api_settings
 from rest_framework.exceptions import APIException
@@ -50,15 +50,11 @@ def get_resource_name(context):
     except AttributeError:
         try:
             # Check the meta class
-            resource_name = (
-                getattr(view, 'serializer_class')
-                    .Meta.resource_name)
+            resource_name = (getattr(view, 'serializer_class').Meta.resource_name)
         except AttributeError:
             # Use the model
             try:
-                resource_name = (
-                    getattr(view, 'serializer_class')
-                        .Meta.model.__name__)
+                resource_name = (getattr(view, 'serializer_class').Meta.model.__name__)
             except AttributeError:
                 try:
                     resource_name = view.model.__name__
@@ -82,6 +78,13 @@ def get_resource_name(context):
     return resource_name
 
 
+def get_serializer_fields(serializer):
+    if hasattr(serializer, 'child'):
+        return getattr(serializer.child, 'fields')
+    else:
+        return getattr(serializer, 'fields')
+
+
 def format_keys(obj, format_type=None):
     """
     Takes either a dict or list and returns it with camelized keys only if
@@ -173,3 +176,40 @@ def extract_relationships(fields, resource):
                 data.update({field_name: {'data': relation_data}})
 
     return format_keys(data)
+
+
+def extract_included(fields, resource):
+    included_data = list()
+    for field_name, field in six.iteritems(fields):
+        # Skip URL field
+        if field_name == api_settings.URL_FIELD_NAME:
+            continue
+
+        # Skip fields without serialized data
+        if not isinstance(field, BaseSerializer):
+            continue
+
+        if isinstance(field, ListSerializer):
+
+            serializer = field.child
+            model = serializer.Meta.model
+            relation_type = inflection.pluralize(model.__name__).lower()
+
+            # Get the serializer fields
+            serializer_fields = get_serializer_fields(serializer)
+            serializer_data = resource[field_name]
+            if isinstance(serializer_data, list):
+                for serializer_resource in serializer_data:
+                    resource_data = [
+                        ('type', relation_type),
+                        ('id', extract_id(serializer_fields, serializer_resource)),
+                        ('attributes', extract_attributes(serializer_fields, serializer_resource)),
+                        ('relationships', extract_relationships(serializer_fields, serializer_resource)),
+                    ]
+                    # Add 'self' link if field is present and valid
+                    if api_settings.URL_FIELD_NAME in serializer_resource and \
+                            isinstance(serializer_fields[api_settings.URL_FIELD_NAME], RelatedField):
+                        resource_data.append(('links', {'self': serializer_resource[api_settings.URL_FIELD_NAME]}))
+                    included_data.append(OrderedDict(resource_data))
+
+    return format_keys(included_data)