initial commit

Author: gaker

README.rst

@@ -0,0 +1,96 @@
+===============================
+Ember and Django Rest Framework
+===============================
+
+EmberJS is extremely opinionated on how JSON REST requests and responses
+should look. Going against the grain can lead to frustrated Javascript
+developers.
+
+By default, Django REST Framework will produce a response like::
+
+    {
+        "id": 1,
+        "username": "john",
+        "full_name": "John Coltrane"
+    }
+
+
+However, if this is an ``identity`` model in EmberJS, Ember expects a
+response to look like the following::
+
+    {
+        "identity": {
+            "id": 1,
+            "username": "john",
+            "full_name": "John Coltrane"
+        }
+    }
+
+
+------------
+Requirements
+------------
+
+1. Django
+2. Django REST Framework
+
+------------
+Installation
+------------
+
+::
+
+    pip install rest_framework_ember
+
+
+-----
+Usage
+-----
+
+
+``rest_framework_ember`` assumes you are using class-based views in Django 
+Rest Framework.
+
+
+Settings
+^^^^^^^^
+
+One can either add ``rest_framework_ember.parsers.EmberJSONParser`` and 
+``rest_framework_ember.renderers.JSONRenderer`` to each ``ViewSet`` class, or
+override ``settings.REST_FRAMEWORK``::
+
+
+    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.BrowsableAPIRenderer',
+        ),
+        'DATETIME_FORMAT': '%Y-%m-%d %H:%M:%S',
+    }
+
+
+resource_name property
+^^^^^^^^^^^^^^^^^^^^^^
+
+On resources that do not subclass ``rest_framework.viewsets.ModelViewSet``,
+the ``resource_name`` property is required on the class.::
+
+    class Me(generics.GenericAPIView):
+        """
+        Current user's identity endpoint.
+
+        GET /me
+        """
+        resource_name = 'data'
+        serializer_class = identity_serializers.IdentitySerializer
+        allowed_methods = ['GET']
+        permission_classes = (permissions.IsAuthenticated, )
+
+
+
+

rest_framework_ember/__init__.py

@@ -0,0 +1,34 @@
+"""
+Parsers
+"""
+from rest_framework.parsers import JSONParser
+
+from rest_framework_ember.utils import get_resource_name
+
+
+class EmberJSONParser(JSONParser):
+    """
+    By default, EmberJS sends a payload that looks like the following::
+
+        {
+            "identity": {
+                "id": 1,
+                "first_name": "John",
+                "last_name": "Coltrane"
+            }
+        }
+
+    So we can work with the grain on both Ember and RestFramework,
+    Do some tweaks to the payload so DRF gets what it expects.
+    """
+
+    def parse(self, stream, media_type=None, parser_context=None):
+        """
+        Parses the incoming bytestream as JSON and returns the resulting data
+        """
+        result = super(EmberJSONParser, self).parse(
+            stream, media_type=None, parser_context=None)
+
+        resource_name = get_resource_name(parser_context.get('view', None))
+        return result.get(resource_name)
+

rest_framework_ember/parsers.py

@@ -0,0 +1,32 @@
+import copy
+from rest_framework import renderers
+
+from rest_framework_ember.utils import get_resource_name
+
+
+class JSONRenderer(renderers.JSONRenderer):
+    """
+    Render a JSON response the way Ember Data wants it. Such as:
+    {
+        "company": {
+            "id": 1,
+            "name": "nGen Works",
+            "slug": "ngen-works",
+            "date_created": "2014-03-13 16:33:37"
+        }
+    }
+    """
+    def render(self, data, accepted_media_type=None, renderer_context=None):
+        view = renderer_context.get('view')
+
+        resource_name = get_resource_name(view)
+
+        try:
+            data_copy = copy.copy(data)
+            content = data_copy.pop('results')
+            data = {resource_name : content, "meta" : data_copy}
+        except (TypeError, KeyError, AttributeError) as e:
+            data = {resource_name : data}
+        return super(JSONRenderer, self).render(
+            data, accepted_media_type, renderer_context)
+

rest_framework_ember/renderers.py

@@ -0,0 +1,32 @@
+"""
+Resource name utilities.
+"""
+
+def get_resource_name(view):
+    """
+Return the name of a resource
+"""
+    try:
+        # is the resource name set directly on the view?
+        resource_name = getattr(view, 'resource_name')
+    except AttributeError:
+        try:
+            # was it set in the serializer Meta class?
+            resource_name = getattr(view, 'serializer_class')\
+                .Meta.resource_name
+        except AttributeError:
+            # camelCase the name of the model if it hasn't been set
+            # in either of the other places
+            try:
+                name = resource_name = getattr(view, 'serializer_class')\
+                    .Meta.model.__name__
+            except AttributeError:
+                try:
+                    name = view.model.__name__
+                except AttributeError:
+                    name = view.__class__.__name__
+
+            resource_name = name[:1].lower() + name[1:]
+
+    return resource_name
+

rest_framework_ember/utils.py

@@ -0,0 +1,14 @@
+#!/usr/bin/env python
+from setuptools import setup, find_packages
+
+setup(
+    name='rest_framework_ember',
+    version='1.0',
+    description="Make EmberJS and Django Rest Framework play nice together.",
+    author="nGen Works",
+    author_email='[email protected]',
+    url='http://www.ngenworks.com',
+    packages=find_packages(),
+    package_data={'rest_framework_ember': []},
+)
+