Rename "suggested" posts to "featured" so we can use suggested as many=True

Author: jerel

example/serializers.py

@@ -25,25 +25,25 @@ class EntrySerializer(serializers.ModelSerializer):
 
     def __init__(self, *args, **kwargs):
         # to make testing more concise we'll only output the
-        # `suggested` field when it's requested via `include`
+        # `featured` field when it's requested via `include`
         request = kwargs.get('context', {}).get('request')
-        if request and 'suggested' not in request.query_params.get('include', []):
-            self.fields.pop('suggested')
+        if request and 'featured' not in request.query_params.get('include', []):
+            self.fields.pop('featured')
         super(EntrySerializer, self).__init__(*args, **kwargs)
 
     included_serializers = {
         'authors': 'example.serializers.AuthorSerializer',
         'comments': 'example.serializers.CommentSerializer',
-        'suggested': 'example.serializers.EntrySerializer',
+        'featured': 'example.serializers.EntrySerializer',
     }
 
     body_format = serializers.SerializerMethodField()
     comments = relations.ResourceRelatedField(
             source='comment_set', many=True, read_only=True)
-    suggested = relations.SerializerMethodResourceRelatedField(
-            source='get_suggested', model=Entry, read_only=True)
+    featured = relations.SerializerMethodResourceRelatedField(
+            source='get_featured', model=Entry, read_only=True)
 
-    def get_suggested(self, obj):
+    def get_featured(self, obj):
         return Entry.objects.exclude(pk=obj.pk).first()
 
     def get_body_format(self, obj):
@@ -52,7 +52,7 @@ def get_body_format(self, obj):
     class Meta:
         model = Entry
         fields = ('blog', 'headline', 'body_text', 'pub_date', 'mod_date',
-                  'authors', 'comments', 'suggested',)
+                  'authors', 'comments', 'featured',)
         meta_fields = ('body_format',)
 
 

example/tests/integration/test_includes.py

@@ -31,7 +31,7 @@ def test_included_data_on_detail(single_entry, client):
 
 def test_dynamic_related_data_is_included(single_entry, entry_factory, client):
     entry_factory()
-    response = client.get(reverse("entry-detail", kwargs={'pk': single_entry.pk}) + '?include=suggested')
+    response = client.get(reverse("entry-detail", kwargs={'pk': single_entry.pk}) + '?include=featured')
     included = load_json(response.content).get('included')
 
     assert [x.get('type') for x in included] == ['entries'], 'Dynamic included types are incorrect'