Merge pull request #5 from abarax/master

Ember Rest Adapter multi-ID support

Author: jerel

example/api/api.py

@@ -6,7 +6,7 @@
 from rest_framework import serializers, generics, viewsets
 from rest_framework.response import Response
 
-from rest_framework_ember import renderers, parsers
+from rest_framework_ember import renderers, parsers, mixins
 
 
 class IdentitySerializer(serializers.ModelSerializer):
@@ -58,3 +58,5 @@ class EmberUserModelViewSet(viewsets.ModelViewSet):
     parser_classes = (parsers.EmberJSONParser, )
 
 
+class EmberDataMixinUserModelViewSet(mixins.EmberDataModelMixin, EmberUserModelViewSet):
+    queryset = auth_models.User.objects.all()

example/api/urls.py

@@ -2,13 +2,15 @@
 Example app URLs
 """
 from django.conf.urls import patterns, include, url
-from .api import User, UserEmber, EmberUserModelViewSet
+from .api import User, UserEmber, EmberUserModelViewSet, EmberDataMixinUserModelViewSet
 
 from rest_framework import routers
 
 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/$', EmberDataMixinUserModelViewSet.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+)/$',

example/tests/test_ember_data_model_mixin.py

@@ -0,0 +1,71 @@
+
+
+import json
+from example.tests import TestBase
+from django.contrib.auth import get_user_model
+from django.core.urlresolvers import reverse, reverse_lazy
+from django.conf import settings
+
+
+class EmberDataModelMixinTests(TestBase):
+    """
+    Test usage with EmberDataModelMixin
+
+    [<RegexURLPattern user-list ^user-viewsets/$>, <RegexURLPattern user-detail ^user-viewsets/(?P<pk>[^/]+)/$>]
+    """
+    list_url = reverse_lazy('user-list')
+
+    def setUp(self):
+        super(EmberDataModelMixinTests, self).setUp()
+
+    def test_single_id_in_query_params(self):
+        """
+        Ensure single ID in query params returns correct result
+        """
+        url = '/user-mixin-viewset/?ids[]=%s' % self.miles.pk
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, 200)
+
+        expected = {
+            'user': [{
+                'id': self.miles.pk,
+                'first_name': self.miles.first_name,
+                'last_name': self.miles.last_name,
+                'email': self.miles.email
+            }]
+        }
+
+        json_content = json.loads(response.content)
+        meta = json_content.get("meta")
+
+        self.assertEquals(expected.get('user'), json_content.get('user'))
+        self.assertEquals(meta.get('count', 0), 1)
+        self.assertEquals(meta.get("next"), None)
+        self.assertEqual(None, meta.get("next_link"))
+        self.assertEqual(meta.get("page"), 1)
+
+    def test_multiple_ids_in_query_params(self):
+        """
+        Ensure multiple IDs in query params return correct result
+        """
+        url = '/user-mixin-viewset/?ids[]=%s&ids[]=%s' % (self.miles.pk, self.john.pk)
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, 200)
+
+        expected = {
+            'user': [{
+                'id': self.john.pk,
+                'first_name': self.john.first_name,
+                'last_name': self.john.last_name,
+                'email': self.john.email
+            }]
+        }
+
+        json_content = json.loads(response.content)
+        meta = json_content.get("meta")
+
+        self.assertEquals(expected.get('user'), json_content.get('user'))
+        self.assertEquals(meta.get('count', 0), 2)
+        self.assertEquals(meta.get("next"), 2)
+        self.assertEqual('http://testserver/user-mixin-viewset/?ids%5B%5D=2&ids%5B%5D=1&page=2', meta.get("next_link"))
+        self.assertEqual(meta.get("page"), 1)

rest_framework_ember/mixins.py

@@ -0,0 +1,11 @@
+
+
+class EmberDataModelMixin(object):
+    """
+    Override get_queryset for multiple id support
+    """
+    def get_queryset(self):
+        ids = dict(self.request.QUERY_PARAMS).get('ids[]')
+        if ids:
+            self.queryset = self.queryset.filter(id__in=ids)
+        return self.queryset