Merge branch 'develop' of github.com:ngenworks/rest_framework_ember

Author: jerel

.gitignore

@@ -1,5 +1,5 @@
 build/*
 dist/*
-*.egg
+*.egg-info
 *.pyc
 

.travis.yml

@@ -3,5 +3,5 @@ python:
   - "2.7"
 install:
   - pip install -e .
-script: django-admin.py test --settings=example.settings
+script: python runtests.py
 

README.rst

@@ -82,6 +82,14 @@ From Source
     $ cd rest_framework_ember && pip install -e .
 
 
+Running Tests
+^^^^^^^^^^^^^
+
+::
+
+    $ python runtests.py
+
+
 -----
 Usage
 -----
@@ -144,10 +152,9 @@ Ember Data <-> Rest Framework Format Conversion
 *(camelization/underscore/pluralize)*
 
 This package includes the optional ability to automatically convert json requests
-and responses from the Ember Data camelCase to python/rest_framework's preferred 
-underscore. Additionally resource names can be pluralized if more than one object 
-is included in a serialized response as Ember Data expects. To hook this up, 
-include the following in your project settings::
+and responses from the Ember Data camelCase to python/rest_framework's preferred
+underscore. Additionally resource names can be pluralized when an array of objects
+are returned. To hook this up include the following in your project settings::
 
    REST_EMBER_FORMAT_KEYS = True
    REST_EMBER_PLURALIZE_KEYS = True

example/api/api.py

@@ -0,0 +1,66 @@
+from django.contrib.auth import models as auth_models
+from rest_framework import viewsets, generics, renderers, parsers
+from rest_framework.decorators import list_route, detail_route
+from rest_framework.response import Response
+from rest_framework_ember import mixins, utils
+from ..serializers.identity import IdentitySerializer
+from ..serializers.post import PostSerializer
+
+
+class Identity(mixins.MultipleIDMixin, viewsets.ModelViewSet):
+    queryset = auth_models.User.objects.all()
+    serializer_class = IdentitySerializer
+
+    @list_route()
+    def empty_list(self, request):
+        """
+        This is a hack/workaround to return an empty result on a list
+        endpoint because the delete operation in the test_empty_pluralization
+        test doesn't prevent the /identities endpoint from still returning
+        records when called in the same test. Suggestions welcome.
+        """
+        self.queryset = self.queryset.filter(pk=None)
+        return super(Identity, self).list(request)
+
+    # demonstrate sideloading data for use at app boot time
+    @list_route()
+    def posts(self, request):
+        self.resource_name = False
+
+        identities = self.queryset
+        posts = [{'id': 1, 'title': 'Test Blog Post'}]
+
+        data = {
+            u'identities': IdentitySerializer(identities, many=True).data,
+            u'posts': PostSerializer(posts, many=True).data,
+        }
+        return Response(utils.format_keys(data, format_type='camelize'))
+
+    @detail_route()
+    def manual_resource_name(self, request, *args, **kwargs):
+        self.resource_name = 'data'
+        return super(Identity, self).retrieve(request, args, kwargs)
+
+
+class GenericIdentity(generics.GenericAPIView):
+    """
+    An endpoint that uses DRF's default format so we can test that.
+
+    GET /identities/generic
+    """
+    serializer_class = IdentitySerializer
+    allowed_methods = ['GET']
+    renderer_classes = (renderers.JSONRenderer, )
+    parser_classes = (parsers.JSONParser, )
+
+
+    def get_queryset(self):
+        return auth_models.User.objects.all()
+
+    def get(self, request, pk=None):
+        """
+        GET request
+        """
+        obj = self.get_object()
+        return Response(IdentitySerializer(obj).data)
+

example/api/resources/__init__.py

@@ -0,0 +1,13 @@
+from django.contrib.auth import models as auth_models
+from rest_framework import serializers
+
+
+class IdentitySerializer(serializers.ModelSerializer):
+    """
+    Identity Serializer
+    """
+    class Meta:
+        model = auth_models.User
+        fields = (
+            'id', 'first_name', 'last_name', 'email', )
+

example/api/resources/identity.py

@@ -0,0 +1,9 @@
+from rest_framework import serializers
+
+
+class PostSerializer(serializers.Serializer):
+    """
+    Blog post serializer
+    """
+    title = serializers.CharField(max_length=50)
+

example/api/serializers/__init__.py

@@ -2,25 +2,16 @@
 Example app URLs
 """
 from django.conf.urls import patterns, include, url
-from .api import (
-    User, UserEmber, EmberUserModelViewSet, MultipleIDMixinUserModelViewSet,
-    UserCarResource)
-
 from rest_framework import routers
+from .resources.identity import Identity, GenericIdentity
+
+router = routers.DefaultRouter(trailing_slash=False)
+
+router.register(r'identities', Identity)
+
+urlpatterns = router.urls
 
-urlpatterns = patterns('',
-    url(r'^user-default/(?P<pk>\d+)/$', User.as_view(), name='user-default'),
-    url(r'^user-ember/(?P<pk>\d+)/$', UserEmber.as_view(), name='user-ember'),
-    url(r'^user-mixin-viewset/$',
-        MultipleIDMixinUserModelViewSet.as_view({'get': 'list'}),
-        name='mixin-user-list'),
-    url(r'^user-viewset/$', EmberUserModelViewSet.as_view({'get': 'list'}),
-        name='user-list'),
-    url(r'^user-viewset/(?P<pk>\d+)/$',
-        EmberUserModelViewSet.as_view(
-            {'get': 'retrieve', 'post': 'create', 'put': 'update'}),
-        name='user-detail'),
-    url(r'users-cars/$', UserCarResource.as_view(),
-        name='users-cars'),
+urlpatterns += patterns('',
+    url(r'identities/default/(?P<pk>\d+)', GenericIdentity.as_view(), name='user-default'),
 )