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

Author: jerel

.travis.yml

@@ -0,0 +1,7 @@
+language: python
+python:
+  - "2.7"
+install:
+  - pip install -e .
+script: django-admin.py test --settings=example.settings
+

README.rst

@@ -2,6 +2,9 @@
 Ember Data and Django Rest Framework
 ===============================
 
+.. image:: https://travis-ci.org/ngenworks/rest_framework_ember.svg?branch=master
+   :target: https://travis-ci.org/ngenworks/rest_framework_ember
+
 The default Ember Data REST Adapter conventions differ from the default
 Django Rest Framework JSON request and response format. Instead of adding
 a Django specific adapter to Ember Data we use this adapter in Django to

example/__init__.py

@@ -0,0 +1,51 @@
+"""
+Test Serializer and Resource
+"""
+from django.contrib.auth import models as auth_models
+
+from rest_framework import serializers, generics
+from rest_framework.response import Response
+
+from rest_framework_ember import renderers, parsers
+
+
+class IdentitySerializer(serializers.ModelSerializer):
+    """
+    Identity Serializer
+    """
+    class Meta:
+        model = auth_models.User
+        fields = (
+            'id', 'first_name', 'last_name', 'email', )
+
+
+class User(generics.GenericAPIView):
+    """
+    Current user's identity endpoint.
+
+    GET /me
+    """
+    serializer_class = IdentitySerializer
+    allowed_methods = ['GET']
+
+    def get_queryset(self):
+        return auth_models.User.objects.all()
+
+    def get(self, request, pk=None):
+        """
+        GET request
+        """
+        obj = self.get_object()
+        serializer = self.serializer_class(obj)
+        return Response(serializer.data)
+
+
+class UserEmber(User):
+    """
+    Use the rest_framework_ember Renderer/Parser
+    """
+    resource_name = 'data'
+
+    renderer_classes = (renderers.JSONRenderer, )
+    parser_classes = (parsers.EmberJSONParser, )
+

example/api/__init__.py

@@ -0,0 +1,12 @@
+"""
+Example app URLs
+"""
+from django.conf.urls import patterns, include, url
+from .api import User, UserEmber
+
+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'),
+
+)
+

example/api/api.py

@@ -0,0 +1,48 @@
+import os
+
+SITE_ID = 1
+
+MEDIA_ROOT = os.path.normcase(os.path.dirname(os.path.abspath(__file__)))
+MEDIA_URL = '/media/'
+
+DATABASE_ENGINE = 'sqlite3'
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': ':memory:',
+    }
+}
+
+INSTALLED_APPS = [
+    'django.contrib.contenttypes',
+    'django.contrib.sites',
+    'django.contrib.auth',
+    'django.contrib.admin',
+    'rest_framework',
+    'example.api',
+]
+
+ROOT_URLCONF = 'example.api.urls'
+
+SECRET_KEY = 'abc123'
+
+PASSWORD_HASHERS = ('django.contrib.auth.hashers.UnsaltedMD5PasswordHasher', )
+
+
+REST_FRAMEWORK = {
+    'DEFAULT_PARSER_CLASSES': (
+        # 'rest_framework_ember.parsers.EmberJSONParser',
+        'rest_framework.parsers.FormParser',
+        'rest_framework.parsers.MultiPartParser'
+    ),
+    'DEFAULT_RENDERER_CLASSES': (
+        # 'rest_framework_ember.renderers.JSONRenderer',
+        'rest_framework.renderers.JSONRenderer',
+        'rest_framework.renderers.BrowsableAPIRenderer',
+    ),
+    'DATETIME_FORMAT': '%Y-%m-%d %H:%M:%S',
+}
+
+
+

example/api/urls.py

@@ -0,0 +1,43 @@
+
+from django.contrib.auth import get_user_model
+from rest_framework.test import APITestCase
+
+
+class TestBase(APITestCase):
+    """
+    Test base class to setup a couple users.
+    """
+    def setUp(self):
+        """
+        Create those users
+        """
+        super(TestBase, self).setUp()
+        self.create_users()
+
+    def create_user(self, username, email, password="pw",
+                     first_name='', last_name=''):
+        """
+        Helper method to create a user
+        """
+        User = get_user_model()
+
+        user = User.objects.create_user(
+            username, email, password=password
+        )
+        if first_name or last_name:
+            user.first_name = first_name
+            user.last_name = last_name
+            user.save()
+        return user
+
+    def create_users(self):
+        """
+        Create a couple users
+        """
+        self.john = self.create_user(
+            'trane', '[email protected]',
+            first_name='John', last_name="Coltrane")
+        self.miles = self.create_user(
+            'miles', '[email protected]',
+            first_name="Miles", last_name="Davis")
+

example/settings.py

@@ -0,0 +1,51 @@
+
+import json
+from example.tests import TestBase
+from django.core.urlresolvers import reverse
+from django.conf import settings
+
+
+class GenericViewSet(TestBase):
+    """
+    Test expected responses coming from a Generic ViewSet
+    """
+    def test_default_rest_framework_behavior(self):
+        """
+        This is more of an example really, showing default behavior
+        """
+        url = reverse('user-default', kwargs={'pk': self.miles.pk})
+
+        response = self.client.get(url)
+
+        self.assertEqual(200, response.status_code)
+        self.assertEqual(
+            json.loads(response.content),
+            {
+                'id': 2,
+                'first_name': u'Miles',
+                'last_name': u'Davis',
+                'email': u'[email protected]'
+            }
+        )
+
+    def test_ember_expected_renderer(self):
+        """
+        The :class:`UserEmber` ViewSet has the ``resource_name`` of 'data'
+        so that should be the key in the JSON response.
+        """
+        url = reverse('user-ember', kwargs={'pk': self.miles.pk})
+
+        response = self.client.get(url)
+        self.assertEqual(200, response.status_code)
+        self.assertEqual(
+            json.loads(response.content),
+            {
+                'data': {
+                    'id': 2,
+                    'first_name': u'Miles',
+                    'last_name': u'Davis',
+                    'email': u'[email protected]'
+                }
+            }
+        )
+

example/tests/__init__.py

@@ -8,7 +8,9 @@
     author="nGen Works",
     author_email='[email protected]',
     url='http://www.ngenworks.com',
+    license='BSD',
+    keywords="EmberJS Django REST",
     packages=find_packages(),
-    package_data={'rest_framework_ember': []},
+    install_requires=['django', 'djangorestframework' ],
 )