Merge pull request #69 from django-json-api/feature/drf-nested-routers

Introduced support for nested relationships urls with drf-nested-routers HyperlinkedRouterField

Author: jsenecal

rest_framework_json_api/renderers.py

@@ -69,17 +69,20 @@ def render(self, data, accepted_media_type=None, renderer_context=None):
             fields = utils.get_serializer_fields(resource_serializer)
 
             json_api_data = list()
-            for resource in results:
+            for position in range(len(results)):
+                resource = results[position]  # Get current resource
+                resource_instance = resource_serializer.instance[position]  # Get current instance
                 json_api_data.append(
-                    utils.build_json_resource_obj(fields, resource, resource_name))
+                    utils.build_json_resource_obj(fields, resource, resource_instance, resource_name))
                 included = utils.extract_included(fields, resource)
                 if included:
                     json_api_included.extend(included)
         else:
             # Check if data contains a serializer
             if hasattr(data, 'serializer'):
                 fields = utils.get_serializer_fields(data.serializer)
-                json_api_data = utils.build_json_resource_obj(fields, data, resource_name)
+                resource_instance = data.serializer.instance
+                json_api_data = utils.build_json_resource_obj(fields, data, resource_instance, resource_name)
                 included = utils.extract_included(fields, data)
                 if included:
                     json_api_included.extend(included)

rest_framework_json_api/utils.py

@@ -13,6 +13,7 @@
 
 from django.utils.six.moves.urllib.parse import urlparse
 
+
 try:
     from rest_framework.compat import OrderedDict
 except ImportError:
@@ -23,6 +24,11 @@
 except ImportError:
     ManyRelatedField = type(None)
 
+try:
+    from rest_framework_nested.relations import HyperlinkedRouterField
+except ImportError:
+    HyperlinkedRouterField = type(None)
+
 
 def get_resource_name(context):
     """
@@ -122,13 +128,13 @@ def format_value(value, format_type=None):
     return value
 
 
-def build_json_resource_obj(fields, resource, resource_name):
+def build_json_resource_obj(fields, resource, resource_instance, resource_name):
     resource_data = [
         ('type', resource_name),
         ('id', extract_id(fields, resource)),
         ('attributes', extract_attributes(fields, resource)),
     ]
-    relationships = extract_relationships(fields, resource)
+    relationships = extract_relationships(fields, resource, resource_instance)
     if relationships:
         resource_data.append(('relationships', relationships))
     # Add 'self' link if field is present and valid
@@ -139,9 +145,8 @@ def build_json_resource_obj(fields, resource, resource_name):
 
 
 def get_related_resource_type(relation):
-    queryset = relation.queryset
-    if queryset is not None:
-        relation_model = queryset.model
+    if hasattr(relation, 'get_queryset') and relation.get_queryset() is not None:
+        relation_model = relation.get_queryset().model
     else:
         parent_serializer = relation.parent
         if hasattr(parent_serializer, 'Meta'):
@@ -198,7 +203,7 @@ def extract_attributes(fields, resource):
     return format_keys(data)
 
 
-def extract_relationships(fields, resource):
+def extract_relationships(fields, resource, resource_instance):
     data = OrderedDict()
     for field_name, field in six.iteritems(fields):
         # Skip URL field
@@ -209,6 +214,24 @@ def extract_relationships(fields, resource):
         if not isinstance(field, (RelatedField, ManyRelatedField, BaseSerializer)):
             continue
 
+        if isinstance(field, HyperlinkedRouterField):
+            # special case for HyperlinkedRouterField
+            relation_data = list()
+            relation_type = get_related_resource_type(field)
+            related = getattr(resource_instance, field_name).all()
+            for relation in related:
+                relation_data.append(OrderedDict([('type', relation_type), ('id', relation.pk)]))
+
+            data.update({field_name: {
+                'links': {
+                    "related": resource.get(field_name)},
+                'data': relation_data,
+                'meta': {
+                    'count': len(relation_data)
+                }
+            }})
+            continue
+
         if isinstance(field, (PrimaryKeyRelatedField, HyperlinkedRelatedField)):
             relation_type = get_related_resource_type(field)