Merge remote-tracking branch 'origin/develop' into polymorphism

Conflicts:
	.travis.yml
	example/factories/__init__.py
	example/models.py
	example/serializers.py
	example/tests/conftest.py
	example/urls_test.py
	example/views.py
	requirements-development.txt
	rest_framework_json_api/parsers.py
	rest_framework_json_api/relations.py
	rest_framework_json_api/renderers.py
	rest_framework_json_api/serializers.py
	rest_framework_json_api/utils.py
	setup.py

.travis.yml

@@ -40,7 +40,7 @@ before_install:
   # Force an upgrade of py & pytest to avoid VersionConflict
   - pip install --upgrade py
   - pip install "pytest>=2.8,<3"
-  - pip install codecov
+  - pip install codecov flake8
 install:
   - pip install Django${DJANGO} djangorestframework${DRF}
   - python setup.py install

example/factories/__init__.py

@@ -2,23 +2,22 @@
 
 import factory
 from faker import Factory as FakerFactory
-from example import models
-
+from example.models import Blog, Author, AuthorBio, Entry, Comment, TaggedItem, ArtProject, ResearchProject, Company
 
 faker = FakerFactory.create()
 faker.seed(983843)
 
 
 class BlogFactory(factory.django.DjangoModelFactory):
     class Meta:
-        model = models.Blog
+        model = Blog
 
     name = factory.LazyAttribute(lambda x: faker.name())
 
 
 class AuthorFactory(factory.django.DjangoModelFactory):
     class Meta:
-        model = models.Author
+        model = Author
 
     name = factory.LazyAttribute(lambda x: faker.name())
     email = factory.LazyAttribute(lambda x: faker.email())
@@ -28,15 +27,15 @@ class Meta:
 
 class AuthorBioFactory(factory.django.DjangoModelFactory):
     class Meta:
-        model = models.AuthorBio
+        model = AuthorBio
 
     author = factory.SubFactory(AuthorFactory)
     body = factory.LazyAttribute(lambda x: faker.text())
 
 
 class EntryFactory(factory.django.DjangoModelFactory):
     class Meta:
-        model = models.Entry
+        model = Entry
 
     headline = factory.LazyAttribute(lambda x: faker.sentence(nb_words=4))
     body_text = factory.LazyAttribute(lambda x: faker.text())
@@ -55,32 +54,41 @@ def authors(self, create, extracted, **kwargs):
 
 class CommentFactory(factory.django.DjangoModelFactory):
     class Meta:
-        model = models.Comment
+        model = Comment
 
     entry = factory.SubFactory(EntryFactory)
     body = factory.LazyAttribute(lambda x: faker.text())
     author = factory.SubFactory(AuthorFactory)
 
 
+class TaggedItemFactory(factory.django.DjangoModelFactory):
+
+    class Meta:
+        model = TaggedItem
+
+    content_object = factory.SubFactory(EntryFactory)
+    tag = factory.LazyAttribute(lambda x: faker.word())
+
+
 class ArtProjectFactory(factory.django.DjangoModelFactory):
     class Meta:
-        model = models.ArtProject
+        model = ArtProject
 
     topic = factory.LazyAttribute(lambda x: faker.catch_phrase())
     artist = factory.LazyAttribute(lambda x: faker.name())
 
 
 class ResearchProjectFactory(factory.django.DjangoModelFactory):
     class Meta:
-        model = models.ResearchProject
+        model = ResearchProject
 
     topic = factory.LazyAttribute(lambda x: faker.catch_phrase())
     supervisor = factory.LazyAttribute(lambda x: faker.name())
 
 
 class CompanyFactory(factory.django.DjangoModelFactory):
     class Meta:
-        model = models.Company
+        model = Company
 
     name = factory.LazyAttribute(lambda x: faker.company())
     current_project = factory.SubFactory(ArtProjectFactory)

example/serializers.py

@@ -1,6 +1,13 @@
 from datetime import datetime
 from rest_framework_json_api import serializers, relations
-from example import models
+from example.models import Blog, Entry, Author, AuthorBio, Comment, TaggedItemm, Project, ArtProject, ResearchProject, Company
+
+
+class TaggedItemSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = TaggedItem
+        fields = ('tag', )
 
 
 class BlogSerializer(serializers.ModelSerializer):
@@ -21,20 +28,21 @@ def get_root_meta(self, resource, many):
         }
 
     class Meta:
-        model = models.Blog
-        fields = ('name', 'url',)
+        model = Blog
+        fields = ('name', 'url', 'tags')
+        read_only_fields = ('tags', )
         meta_fields = ('copyright',)
 
 
 class EntrySerializer(serializers.ModelSerializer):
 
     def __init__(self, *args, **kwargs):
-        super(EntrySerializer, self).__init__(*args, **kwargs)
         # to make testing more concise we'll only output the
         # `featured` field when it's requested via `include`
         request = kwargs.get('context', {}).get('request')
         if request and 'featured' not in request.query_params.get('include', []):
-            self.fields.pop('featured', None)
+            self.fields.pop('featured')
+        super(EntrySerializer, self).__init__(*args, **kwargs)
 
     included_serializers = {
         'authors': 'example.serializers.AuthorSerializer',
@@ -45,27 +53,32 @@ def __init__(self, *args, **kwargs):
     }
 
     body_format = serializers.SerializerMethodField()
-    # Many related from model
+    # many related from model
     comments = relations.ResourceRelatedField(
-        source='comment_set', many=True, read_only=True)
-    # Many related from serializer
+        many=True, read_only=True)
+    # many related from serializer
     suggested = relations.SerializerMethodResourceRelatedField(
-        source='get_suggested', model=models.Entry, many=True, read_only=True)
-    # Single related from serializer
+        source='get_suggested', model=Entry, many=True, read_only=True,
+        related_link_view_name='entry-suggested',
+        related_link_url_kwarg='entry_pk',
+        self_link_view_name='entry-relationships',
+    )
+    # single related from serializer
     featured = relations.SerializerMethodResourceRelatedField(
-        source='get_featured', model=models.Entry, read_only=True)
+        source='get_featured', model=Entry, read_only=True)
+    tags = TaggedItemSerializer(many=True, read_only=True)
 
     def get_suggested(self, obj):
-        return models.Entry.objects.exclude(pk=obj.pk)
+        return Entry.objects.exclude(pk=obj.pk)
 
     def get_featured(self, obj):
-        return models.Entry.objects.exclude(pk=obj.pk).first()
+        return Entry.objects.exclude(pk=obj.pk).first()
 
     def get_body_format(self, obj):
         return 'text'
 
     class Meta:
-        model = models.Entry
+        model = Entry
         fields = ('blog', 'headline', 'body_text', 'pub_date', 'mod_date',
                   'authors', 'comments', 'featured', 'suggested', 'tags')
         read_only_fields = ('tags', )
@@ -78,7 +91,7 @@ class JSONAPIMeta:
 class AuthorBioSerializer(serializers.ModelSerializer):
 
     class Meta:
-        model = models.AuthorBio
+        model = AuthorBio
         fields = ('author', 'body',)
 
 
@@ -88,7 +101,7 @@ class AuthorSerializer(serializers.ModelSerializer):
     }
 
     class Meta:
-        model = models.Author
+        model = Author
         fields = ('name', 'email', 'bio')
 
 
@@ -99,41 +112,41 @@ class CommentSerializer(serializers.ModelSerializer):
     }
 
     class Meta:
-        model = models.Comment
+        model = Comment
         exclude = ('created_at', 'modified_at',)
         # fields = ('entry', 'body', 'author',)
 
 
 class ArtProjectSerializer(serializers.ModelSerializer):
     class Meta:
-        model = models.ArtProject
+        model = ArtProject
         exclude = ('polymorphic_ctype',)
 
 
 class ResearchProjectSerializer(serializers.ModelSerializer):
     class Meta:
-        model = models.ResearchProject
+        model = ResearchProject
         exclude = ('polymorphic_ctype',)
 
 
 class ProjectSerializer(serializers.PolymorphicModelSerializer):
     polymorphic_serializers = [ArtProjectSerializer, ResearchProjectSerializer]
 
     class Meta:
-        model = models.Project
+        model = Project
         exclude = ('polymorphic_ctype',)
 
 
 class CompanySerializer(serializers.ModelSerializer):
     current_project = relations.PolymorphicResourceRelatedField(
-        ProjectSerializer, queryset=models.Project.objects.all())
+        ProjectSerializer, queryset=Project.objects.all())
     future_projects = relations.PolymorphicResourceRelatedField(
-        ProjectSerializer, queryset=models.Project.objects.all(), many=True)
+        ProjectSerializer, queryset=Project.objects.all(), many=True)
 
     included_serializers = {
         'current_project': ProjectSerializer,
         'future_projects': ProjectSerializer,
     }
 
     class Meta:
-        model = models.Company
+        model = Company

example/tests/conftest.py

@@ -1,20 +1,23 @@
 import pytest
 from pytest_factoryboy import register
 
-from example import factories
-
-register(factories.BlogFactory)
-register(factories.AuthorFactory)
-register(factories.AuthorBioFactory)
-register(factories.EntryFactory)
-register(factories.CommentFactory)
-register(factories.ArtProjectFactory)
-register(factories.ResearchProjectFactory)
-register(factories.CompanyFactory)
-
+from example.factories import (
+    BlogFactory, AuthorFactory, AuthorBioFactory, EntryFactory, CommentFactory,
+    TaggedItemFactory
+)
+
+register(BlogFactory)
+register(AuthorFactory)
+register(AuthorBioFactory)
+register(EntryFactory)
+register(CommentFactory)
+register(TaggedItemFactory)
+register(ArtProjectFactory)
+register(ResearchProjectFactory)
+register(CompanyFactory)
 
 @pytest.fixture
-def single_entry(blog, author, entry_factory, comment_factory, tagged_item_factory):
+def single_entry(blog, author, entry_factory, comment_factory):
 
     entry = entry_factory(blog=blog, authors=(author,))
     comment_factory(entry=entry)

example/urls_test.py

@@ -2,8 +2,10 @@
 from rest_framework import routers
 
 from example.views import (
-    BlogViewSet, EntryViewSet, AuthorViewSet, CommentViewSet, CompanyViewset, ProjectViewset,
-    EntryRelationshipView, BlogRelationshipView, CommentRelationshipView, AuthorRelationshipView)
+    BlogViewSet, EntryViewSet, AuthorViewSet, CommentViewSet, EntryRelationshipView,
+    BlogRelationshipView, CommentRelationshipView, AuthorRelationshipView,
+    CompanyViewset, ProjectViewset,
+)
 from .api.resources.identity import Identity, GenericIdentity
 
 router = routers.DefaultRouter(trailing_slash=False)

example/views.py

@@ -4,11 +4,12 @@
 import rest_framework_json_api.metadata
 import rest_framework_json_api.parsers
 import rest_framework_json_api.renderers
-from rest_framework_json_api.views import RelationshipView
+from rest_framework_json_api.views import ModelViewSet, RelationshipView
 from example.models import Blog, Entry, Author, Comment, Company, Project
 from example.serializers import (
     BlogSerializer, EntrySerializer, AuthorSerializer, CommentSerializer, CompanySerializer,
-    ProjectSerializer)
+    ProjectSerializer,
+)
 
 from rest_framework_json_api.utils import format_drf_errors
 
@@ -72,12 +73,12 @@ class CommentViewSet(ModelViewSet):
     serializer_class = CommentSerializer
 
 
-class CompanyViewset(viewsets.ModelViewSet):
+class CompanyViewset(ModelViewSet):
     queryset = Company.objects.all()
     serializer_class = CompanySerializer
 
 
-class ProjectViewset(viewsets.ModelViewSet):
+class ProjectViewset(ModelViewSet):
     queryset = Project.objects.all()
     serializer_class = ProjectSerializer
 

requirements-development.txt

@@ -2,7 +2,10 @@
 pytest>=2.9.0,<3.0
 pytest-django
 pytest-factoryboy
-fake-factory
+Faker
+recommonmark
+Sphinx
+sphinx_rtd_theme
 django-polymorphic
 tox
 mock