Added new serializers for BLogs to test default serializer behaviour in request response cycle

Author: Alig1493

example/serializers.py

@@ -4,6 +4,7 @@
 from packaging import version
 
 from rest_framework_json_api import relations, serializers
+from rest_framework import serializers as drf_serilazers
 
 from example.models import (
     ArtProject,
@@ -27,6 +28,13 @@ class Meta:
         fields = ('tag',)
 
 
+# DRF default serializer to test default DRF functionalities
+class TaggedItemDRFSerializer(drf_serilazers.ModelSerializer):
+    class Meta:
+        model = TaggedItem
+        fields = ('tag',)
+
+
 class BlogSerializer(serializers.ModelSerializer):
     copyright = serializers.SerializerMethodField()
     tags = TaggedItemSerializer(many=True, read_only=True)
@@ -50,6 +58,25 @@ class Meta:
         meta_fields = ('copyright',)
 
 
+# DRF default serializer to test default DRF functionalities
+class BlogDRFSerializer(serializers.ModelSerializer):
+    copyright = serializers.SerializerMethodField()
+    tags = TaggedItemSerializer(many=True, read_only=True)
+
+    def get_copyright(self, resource):
+        return datetime.now().year
+
+    def get_root_meta(self, resource, many):
+        return {
+            'api_docs': '/docs/api/blogs'
+        }
+
+    class Meta:
+        model = Blog
+        fields = ('name', 'url', 'tags')
+        read_only_fields = ('tags',)
+
+
 class EntrySerializer(serializers.ModelSerializer):
     def __init__(self, *args, **kwargs):
         super(EntrySerializer, self).__init__(*args, **kwargs)

example/tests/unit/test_default_drf_serializers.py

@@ -1,8 +1,10 @@
 import json
 
+from django.urls import reverse
 from rest_framework.serializers import ModelSerializer, SerializerMethodField
 from rest_framework import viewsets
 
+from example.tests.test_views import TestBlogViewSet
 from rest_framework_json_api.renderers import JSONRenderer
 
 from example.models import Comment, Entry
@@ -46,6 +48,7 @@ def render_dummy_test_serialized_view(view_class):
         renderer_context={'view': view_class()})
 
 
+# tests
 def test_simple_reverse_relation_included_renderer():
     """
     Test renderer when a single reverse fk relation is passed.
@@ -73,3 +76,24 @@ def test_render_format_keys(settings):
 
     result = json.loads(rendered.decode())
     assert result['data']['attributes']['json-field'] == {'json-key': 'JsonValue'}
+
+
+class TestDRFBlogViewSet(TestBlogViewSet):
+
+    def test_get_object_gives_correct_blog(self):
+        url = reverse('drf-entry-blog', kwargs={'entry_pk': self.entry.id})
+        resp = self.client.get(url)
+        expected = {
+            'data': {
+                'attributes': {'name': self.blog.name},
+                'id': '{}'.format(self.blog.id),
+                'links': {'self': 'http://testserver/blogs/{}'.format(self.blog.id)},
+                'meta': {'copyright': 2018},
+                'relationships': {'tags': {'data': []}},
+                'type': 'blogs'
+            },
+            'meta': {'apiDocs': '/docs/api/blogs'}
+        }
+        got = resp.json()
+        print(got)
+        self.assertEqual(got, expected)

example/urls_test.py

@@ -16,12 +16,14 @@
     NoFiltersetEntryViewSet,
     NonPaginatedEntryViewSet,
     ProjectTypeViewset,
-    ProjectViewset
-)
+    ProjectViewset,
+    DRFBlogViewSet)
 
 router = routers.DefaultRouter(trailing_slash=False)
 
 router.register(r'blogs', BlogViewSet)
+# router to test default DRF functionalities
+router.register(r'blogs', DRFBlogViewSet)
 router.register(r'entries', EntryViewSet)
 # these "flavors" of entries are used for various tests:
 router.register(r'nopage-entries', NonPaginatedEntryViewSet, 'nopage-entry')
@@ -48,6 +50,11 @@
         BlogViewSet.as_view({'get': 'retrieve'}),
         name='entry-blog'
         ),
+    # url to test default DRF functionalities
+    url(r'^entries/(?P<entry_pk>[^/.]+)/blog',
+        DRFBlogViewSet.as_view({'get': 'retrieve'}),
+        name='drf-entry-blog'
+        ),
     url(r'^entries/(?P<entry_pk>[^/.]+)/comments',
         CommentViewSet.as_view({'get': 'list'}),
         name='entry-comments'

example/views.py

@@ -2,6 +2,7 @@
 import rest_framework.parsers
 import rest_framework.renderers
 from rest_framework.filters import SearchFilter
+from rest_framework import viewsets
 
 import rest_framework_json_api.metadata
 import rest_framework_json_api.parsers
@@ -21,8 +22,8 @@
     CompanySerializer,
     EntrySerializer,
     ProjectSerializer,
-    ProjectTypeSerializer
-)
+    ProjectTypeSerializer,
+    BlogDRFSerializer)
 
 HTTP_422_UNPROCESSABLE_ENTITY = 422
 
@@ -39,6 +40,18 @@ def get_object(self):
         return super(BlogViewSet, self).get_object()
 
 
+class DRFBlogViewSet(viewsets.ModelViewSet):
+    queryset = Blog.objects.all()
+    serializer_class = BlogDRFSerializer
+
+    def get_object(self):
+        entry_pk = self.kwargs.get('entry_pk', None)
+        if entry_pk is not None:
+            return Entry.objects.get(id=entry_pk).blog
+
+        return super(DRFBlogViewSet, self).get_object()
+
+
 class JsonApiViewSet(ModelViewSet):
     """
     This is an example on how to configure DRF-jsonapi from