Merge branch develop into feature/compound_documents

Author: jerel

.travis.yml

@@ -6,23 +6,25 @@ script: tox
 env:
   - TOXENV=py27-django17-drf31
   - TOXENV=py27-django17-drf32
-  - TOXENV=py32-django17-drf31
-  - TOXENV=py32-django17-drf32
   - TOXENV=py33-django17-drf31
   - TOXENV=py33-django17-drf32
   - TOXENV=py34-django17-drf31
   - TOXENV=py34-django17-drf32
   - TOXENV=py27-django18-drf31
   - TOXENV=py27-django18-drf32
-  - TOXENV=py32-django18-drf31
-  - TOXENV=py32-django18-drf32
+  - TOXENV=py27-django18-drf33
   - TOXENV=py33-django18-drf31
   - TOXENV=py33-django18-drf32
+  - TOXENV=py33-django18-drf33
   - TOXENV=py34-django18-drf31
   - TOXENV=py34-django18-drf32
+  - TOXENV=py34-django18-drf33
   - TOXENV=py27-django19-drf31
   - TOXENV=py27-django19-drf32
+  - TOXENV=py27-django19-drf33
   - TOXENV=py34-django19-drf31
   - TOXENV=py34-django19-drf32
+  - TOXENV=py34-django19-drf33
   - TOXENV=py35-django19-drf31
   - TOXENV=py35-django19-drf32
+  - TOXENV=py35-django19-drf33

example/serializers.py

@@ -11,17 +11,31 @@ class Meta:
 
 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`
+        request = kwargs.get('context', {}).get('request')
+        if request and 'suggested' not in request.query_params.get('include', []):
+            self.fields.pop('suggested')
+        super(EntrySerializer, self).__init__(*args, **kwargs)
+
     included_serializers = {
         'comments': 'example.serializers.CommentSerializer',
+        'suggested': 'example.serializers.EntrySerializer',
     }
 
     comments = relations.ResourceRelatedField(
             source='comment_set', many=True, read_only=True)
+    suggested = relations.SerializerMethodResourceRelatedField(
+            source='get_suggested', model=Entry, read_only=True)
+
+    def get_suggested(self, obj):
+        return Entry.objects.exclude(pk=obj.pk).first()
 
     class Meta:
         model = Entry
         fields = ('blog', 'headline', 'body_text', 'pub_date', 'mod_date',
-                'authors', 'comments',)
+                'authors', 'comments', 'suggested',)
 
 
 class AuthorSerializer(serializers.ModelSerializer):

example/tests/integration/test_includes.py

@@ -27,3 +27,12 @@ def test_included_data_on_detail(single_entry, client):
     comment_count = len([resource for resource in included if resource["type"] == "comments"])
     expected_comment_count = single_entry.comment_set.count()
     assert comment_count == expected_comment_count, 'Detail comment count is incorrect'
+
+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')
+    included = load_json(response.content).get('included')
+
+    assert [x.get('type') for x in included] == ['entries'], 'Dynamic included types are incorrect'
+    assert len(included) == 1, 'The dynamically included blog entries are of an incorrect count'
+

example/tests/integration/test_sparse_fieldsets.py

@@ -0,0 +1,13 @@
+from django.core.urlresolvers import reverse
+
+import pytest
+
+
+pytestmark = pytest.mark.django_db
+
+
+def test_sparse_fieldset_ordered_dict_error(multiple_entries, client):
+    base_url = reverse('entry-list')
+    querystring = '?fields[entries]=blog,headline'
+    response = client.get(base_url + querystring)  # RuntimeError: OrderedDict mutated during iteration
+    assert response.status_code == 200  # succeed if we didn't fail due to the above RuntimeError

example/tests/unit/test_renderer_class_methods.py

@@ -0,0 +1,50 @@
+import pytest
+from django.contrib.auth import get_user_model
+
+from rest_framework_json_api import serializers
+from rest_framework_json_api.renderers import JSONRenderer
+
+pytestmark = pytest.mark.django_db
+
+class ResourceSerializer(serializers.ModelSerializer):
+    class Meta:
+        fields = ('username',)
+        model = get_user_model()
+
+
+def test_build_json_resource_obj():
+    resource = {
+        'pk': 1,
+        'username': 'Alice',
+    }
+
+    serializer = ResourceSerializer(data={'username': 'Alice'})
+    serializer.is_valid()
+    resource_instance = serializer.save()
+
+    output = {
+        'type': 'user',
+        'id': '1',
+        'attributes': {
+            'username': 'Alice'
+        },
+    }
+
+    assert JSONRenderer.build_json_resource_obj(
+        serializer.fields, resource, resource_instance, 'user') == output
+
+
+def test_extract_attributes():
+    fields = {
+        'id': serializers.Field(),
+        'username': serializers.Field(),
+        'deleted': serializers.ReadOnlyField(),
+    }
+    resource = {'id': 1, 'deleted': None, 'username': 'jerel'}
+    expected = {
+        'username': 'jerel',
+        'deleted': None
+    }
+    assert sorted(JSONRenderer.extract_attributes(fields, resource)) == sorted(expected), 'Regular fields should be extracted'
+    assert sorted(JSONRenderer.extract_attributes(fields, {})) == sorted(
+        {'username': ''}), 'Should not extract read_only fields on empty serializer'

example/tests/unit/test_utils.py

@@ -1,39 +1,35 @@
 import pytest
-from django.utils import six
 from django.conf import settings
 from django.contrib.auth import get_user_model
+from django.utils import six
 from rest_framework import serializers
+from rest_framework.generics import GenericAPIView
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
-from rest_framework_json_api import utils
 from example.serializers import (EntrySerializer, BlogSerializer,
                                  AuthorSerializer, CommentSerializer)
+from rest_framework_json_api import utils
 from rest_framework_json_api.utils import get_included_serializers
 
 pytestmark = pytest.mark.django_db
 
 
-class ResourceView(APIView):
-    pass
-
-
 class ResourceSerializer(serializers.ModelSerializer):
-    class Meta():
+    class Meta:
         fields = ('username',)
         model = get_user_model()
 
 
 def test_get_resource_name():
-    view = ResourceView()
+    view = APIView()
     context = {'view': view}
     setattr(settings, 'JSON_API_FORMAT_RELATION_KEYS', None)
-    assert 'ResourceViews' == utils.get_resource_name(context), 'not formatted'
+    assert 'APIViews' == utils.get_resource_name(context), 'not formatted'
 
-    view = ResourceView()
     context = {'view': view}
     setattr(settings, 'JSON_API_FORMAT_RELATION_KEYS', 'dasherize')
-    assert 'resource-views' == utils.get_resource_name(context), 'derived from view'
+    assert 'api-views' == utils.get_resource_name(context), 'derived from view'
 
     view.model = get_user_model()
     assert 'users' == utils.get_resource_name(context), 'derived from view model'
@@ -47,9 +43,9 @@ def test_get_resource_name():
     view.response = Response(status=500)
     assert 'errors' == utils.get_resource_name(context), 'handles 500 error'
 
-    view = ResourceView()
-    context = {'view': view}
+    view = GenericAPIView()
     view.serializer_class = ResourceSerializer
+    context = {'view': view}
     assert 'users' == utils.get_resource_name(context), 'derived from serializer'
 
     view.serializer_class.Meta.resource_name = 'rcustom'
@@ -90,28 +86,6 @@ def test_format_relation_name():
     assert utils.format_relation_name('first_name', 'camelize') == 'firstNames'
 
 
-def test_build_json_resource_obj():
-    resource = {
-        'pk': 1,
-        'username': 'Alice',
-    }
-
-    serializer = ResourceSerializer(data={'username': 'Alice'})
-    serializer.is_valid()
-    resource_instance = serializer.save()
-
-    output = {
-        'type': 'user',
-        'id': '1',
-        'attributes': {
-            'username': 'Alice'
-        },
-    }
-
-    assert utils.build_json_resource_obj(
-        serializer.fields, resource, resource_instance, 'user') == output
-
-
 class SerializerWithIncludedSerializers(EntrySerializer):
     included_serializers = {
         'blog': BlogSerializer,

rest_framework_json_api/pagination.py

@@ -1,9 +1,9 @@
 """
 Pagination fields
 """
+from collections import OrderedDict
 from rest_framework import serializers
 from rest_framework.views import Response
-from rest_framework.compat import OrderedDict
 from rest_framework.pagination import PageNumberPagination
 from rest_framework.templatetags.rest_framework import replace_query_param
 

rest_framework_json_api/relations.py

@@ -31,6 +31,11 @@ def __init__(self, self_link_view_name=None, related_link_view_name=None, **kwar
         self.related_link_lookup_field = kwargs.pop('related_link_lookup_field', self.related_link_lookup_field)
         self.related_link_url_kwarg = kwargs.pop('related_link_url_kwarg', self.related_link_lookup_field)
 
+        # check for a model class that was passed in for the relation type
+        model = kwargs.pop('model', None)
+        if model:
+            self.model = model
+
         # 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.
@@ -104,7 +109,11 @@ def get_links(self, obj=None, lookup_field='pk'):
 
     def to_internal_value(self, data):
         if isinstance(data, six.text_type):
-            data = json.loads(data)
+            try:
+                data = json.loads(data)
+            except ValueError:
+                # show a useful error if they send a `pk` instead of resource object
+                self.fail('incorrect_type', data_type=type(data).__name__)
         if not isinstance(data, dict):
             self.fail('incorrect_type', data_type=type(data).__name__)
         expected_relation_type = get_resource_type_from_queryset(self.queryset)
@@ -136,3 +145,12 @@ def choices(self):
             for item in queryset
         ])
 
+
+class SerializerMethodResourceRelatedField(ResourceRelatedField):
+    def get_attribute(self, instance):
+        # check for a source fn defined on the serializer instead of the model
+        if self.source and hasattr(self.parent, self.source):
+            serializer_method = getattr(self.parent, self.source)
+            if hasattr(serializer_method, '__call__'):
+                return serializer_method(instance)
+        return super(ResourceRelatedField, self).get_attribute(instance)