Added basic test for model resource_name property

Author: scottfisk

example/models.py

@@ -34,6 +34,18 @@ def __str__(self):
         return self.name
 
 
+@python_2_unicode_compatible
+class RenamedAuthor(Author):
+    class Meta:
+        proxy = True
+
+    class JSONAPIMeta:
+        resource_name = "super-author"
+
+    def __str__(self):
+        return self.name
+
+
 @python_2_unicode_compatible
 class Entry(BaseModel):
     blog = models.ForeignKey(Blog)

example/serializers.py

@@ -1,5 +1,5 @@
 from rest_framework_json_api import serializers, relations
-from example.models import Blog, Entry, Author, Comment
+from example.models import Blog, Entry, Author, Comment, RenamedAuthor
 
 
 class BlogSerializer(serializers.ModelSerializer):
@@ -45,6 +45,13 @@ class Meta:
         fields = ('name', 'email',)
 
 
+class RenamedAuthorSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = RenamedAuthor
+        fields = ('name', 'email',)
+
+
 class CommentSerializer(serializers.ModelSerializer):
 
     class Meta:

example/tests/integration/test_model_resource_name.py

@@ -0,0 +1,13 @@
+import pytest
+from django.core.urlresolvers import reverse
+
+from example.tests.utils import load_json
+
+pytestmark = pytest.mark.django_db
+
+
+def test_model_resource_name_on_list(single_entry, client):
+    response = client.get(reverse("renamed-authors-list"))
+    data = load_json(response.content)['data']
+    # name should be super-author instead of model name RenamedAuthor
+    assert [x.get('type') for x in data] == ['super-author'], 'List included types are incorrect'

example/urls_test.py

@@ -2,14 +2,15 @@
 from rest_framework import routers
 
 from example.views import BlogViewSet, EntryViewSet, AuthorViewSet, EntryRelationshipView, BlogRelationshipView, \
-    CommentRelationshipView, AuthorRelationshipView
+    CommentRelationshipView, AuthorRelationshipView, RenamedAuthorViewSet
 from .api.resources.identity import Identity, GenericIdentity
 
 router = routers.DefaultRouter(trailing_slash=False)
 
 router.register(r'blogs', BlogViewSet)
 router.register(r'entries', EntryViewSet)
 router.register(r'authors', AuthorViewSet)
+router.register(r'renamed-authors', RenamedAuthorViewSet, base_name='renamed-authors')
 
 # for the old tests
 router.register(r'identities', Identity)

example/views.py

@@ -1,8 +1,9 @@
 from rest_framework import viewsets
 from rest_framework_json_api.views import RelationshipView
-from example.models import Blog, Entry, Author, Comment
+from example.models import Blog, Entry, Author, Comment, RenamedAuthor
 from example.serializers import (
-        BlogSerializer, EntrySerializer, AuthorSerializer, CommentSerializer)
+        BlogSerializer, EntrySerializer, AuthorSerializer, CommentSerializer,
+        RenamedAuthorSerializer)
 
 
 class BlogViewSet(viewsets.ModelViewSet):
@@ -21,6 +22,11 @@ class AuthorViewSet(viewsets.ModelViewSet):
     serializer_class = AuthorSerializer
 
 
+class RenamedAuthorViewSet(viewsets.ModelViewSet):
+    queryset = RenamedAuthor.objects.all()
+    serializer_class = RenamedAuthorSerializer
+
+
 class CommentViewSet(viewsets.ModelViewSet):
     queryset = Comment.objects.all()
     serializer_class = CommentSerializer
@@ -41,4 +47,3 @@ class CommentRelationshipView(RelationshipView):
 class AuthorRelationshipView(RelationshipView):
     queryset = Author.objects.all()
     self_link_view_name = 'author-relationships'
-