Now supporting links for RelationshipView

Author: jsenecal

example/tests/test_views.py

@@ -79,6 +79,16 @@ def test_get_empty_to_one_relationship(self):
 
         assert response.data == expected_data
 
+    def test_get_to_many_relationship_self_link(self):
+        url = '/authors/{}/relationships/comment_set'.format(self.author.id)
+
+        response = self.client.get(url)
+        expected_data = {
+            'links': {'self': 'http://testserver/authors/1/relationships/comment_set'},
+            'data': [{'id': str(self.second_comment.id), 'type': format_relation_name('Comment')}]
+        }
+        assert json.loads(response.content.decode('utf-8')) == expected_data
+
     def test_patch_to_one_relationship(self):
         url = '/entries/{}/relationships/blog'.format(self.first_entry.id)
         request_data = {

example/views.py

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

rest_framework_json_api/renderers.py

@@ -39,11 +39,12 @@ def render(self, data, accepted_media_type=None, renderer_context=None):
         from rest_framework_json_api.views import RelationshipView
         if isinstance(view, RelationshipView):
             # Special case for RelationshipView
-            links = view.get_links()
             render_data = OrderedDict([
-                ('data', data),
-                (('links', links) if links else None),
+                ('data', data)
             ])
+            links = view.get_links()
+            if links:
+                render_data.update({'links': links}),
             return super(JSONRenderer, self).render(
                 render_data, accepted_media_type, renderer_context
             )

rest_framework_json_api/views.py

@@ -1,8 +1,12 @@
+from django.core.exceptions import ImproperlyConfigured
+from django.core.urlresolvers import NoReverseMatch
 from django.db.models import Model, QuerySet
 from django.db.models.manager import BaseManager
 from rest_framework import generics
+from rest_framework.relations import Hyperlink
 from rest_framework.response import Response
 from rest_framework.exceptions import NotFound, MethodNotAllowed
+from rest_framework.reverse import reverse
 
 from rest_framework_json_api.exceptions import Conflict
 from rest_framework_json_api.serializers import ResourceIdentifierObjectSerializer
@@ -11,19 +15,52 @@
 
 class RelationshipView(generics.GenericAPIView):
     serializer_class = ResourceIdentifierObjectSerializer
-    self_view_name = None
-    related_view_name = None
+    self_link_view_name = None
+    related_link_view_name = None
 
-    def get_self_link(self):
-        return 'self_link'
+    def __init__(self, **kwargs):
+        super(RelationshipView, self).__init__(**kwargs)
+        # We include this simply for dependency injection in tests.
+        # We can't add it as a class attributes or it would expect an
+        # implicit `self` argument to be passed.
+        self.reverse = reverse
 
-    def get_related_link(self):
-        return 'related_link'
+
+
+    def get_url(self, name, view_name, kwargs, request):
+        """
+        Given an object, return the URL that hyperlinks to the object.
+
+        May raise a `NoReverseMatch` if the `view_name` and `lookup_field`
+        attributes are not configured to correctly match the URL conf.
+        """
+
+        # Return None if the view name is not supplied
+        if not view_name:
+            return None
+
+        # Return the hyperlink, or error if incorrectly configured.
+        try:
+            url = self.reverse(view_name, kwargs=kwargs, request=request)
+        except NoReverseMatch:
+            msg = (
+                'Could not resolve URL for hyperlinked relationship using '
+                'view name "%s". You may have failed to include the related '
+                'model in your API, or incorrectly configured the '
+                '`lookup_field` attribute on this field.'
+            )
+            raise ImproperlyConfigured(msg % view_name)
+
+        if url is None:
+            return None
+
+        return Hyperlink(url, name)
 
     def get_links(self):
         return_data = OrderedDict()
-        self_link = self.get_self_link()
-        related_link = self.get_related_link()
+        self_link = self.get_url('self', self.self_link_view_name, self.kwargs, self.request)
+        related_kwargs = {self.lookup_field: self.kwargs.get(self.lookup_field)}
+        related_link = self.get_url('related', self.related_link_view_name, related_kwargs, self.request)
         if self_link:
             return_data.update({'self': self_link})
         if related_link: