django-piston (PBS Education Version)

Info

piston is a REST API framework for use with django projects

Keywords

REST, API, django

Original Doc

https://bitbucket.org/jespern/django-piston/wiki/Home

Changes in PBS Education Version

In order to implement best practices in API development, we have incorporated the following new features

• Resource definition subsystem
• Pluggable envelopes
• Form error feedback

Example of API building

Here we demonstrate how to use the new features along with the existing ones

We'll start by selecting a few models

models.py:

from django.db import models

class Author(models.Model):
    name = models.CharField(max_length=200)
    biography = models.CharField(required=False)
    url = models.URLField(verify_exists=False, required=False)


class Book(models.Model):
    title = models.CharField(max_length=200)
    summary = models.CharField(max_length=2000, required=False)
    isbn10 = models.CharField(max_length=10)
    isbn13 = models.CharField(max_length=13)
    pages = models.IntegerField(required=False)
    language = models.CharField(max_length=200)
    authors = models.ManyToManyField(Author, related_name='books')
    time_created = models.DateTimeField(auto_now_add=True)


class Publisher(models.Model):
    name = models.CharField(max_length=200)
    url = models.URLField(verify_exists=False, required=False)


class Edition(models.Model):
    book = models.ForeignKey(Book, related_name='editions')
    publisher = models.ForeignKey(Book, related_name='editions')
    number = models.IntegerField()
    date_published = models.DateTimeField()


class Award(models.Model):
    name = models.CharField(max_length=200) 
    book = models.ForeignKey(Book, related_name='awards')
    date_awarded = models.DateTimeField()

Introducing PistonView

One of the major new features added to piston by PBS Education is the PistonView.

views/piston.py:

import datetime
from piston.handler import PistonView, Field

class EditionSummaryView(PistonView):
    fields = [
            'id',
            'number',
            'publisher.name',
            Field('', lambda x: x.date_published.strftime("%m/%d/%y"), destination='date_published'),
            ]


class AwardSummaryView(PistonView):
    fields = [
            'id',
            'name',
            'date_awarded.year',
            ]


class BookSummaryView(PistonView):
    fields = [
            'id',
            'title',
            'isbn10',
            Field('', lambda x: [y.name for y in x.authors.all()], destination='authors'),
            ]


class BookDetailedView(PistonView):
    fields = [
            'id',
            'title',
            'isbn10',
            'isbn13',
            'language',
            'pages',
            Field('', lambda x: [y.name for y in x.authors.all()], destination='authors'),
            Field('', lambda x: [EditionSummaryView(y) for y in x.editions.all()], destination='editions'),
            Field('', lambda x: [AwardSummaryView(y) for y in x.awards.all()], destination='awards'),
            Field('', lambda x: datetime.datetime.now().strftime("%m/%d/%y"), destination='time_retrieved'),
            ]

Let's also write a PaginationView while we're at it. It takes the django page object and some relevant information:

from piston.handler import PistonView, Field

class PaginationView(PistonView):
    fields = [
            Field('number', destination='page'),
            Field('paginator.num_pages', destination='pages'),
            Field('paginator.count', destination='count'),
            Field('paginator.per_page', destination='per_page'),
            Field('has_next'),
            Field('has_previous'),
            Field('start_index', destination='start'),
            Field('end_index', destination='end'),
            ]

Handlers

Now let's write some Piston handlers.

handlers.py:

from piston.handler import BaseHandler
from piston.resource import PistonNotFoundException
from myproject.utils.forms import PaginationForm


class BooksHandler(BaseHandler):
    allowed_methods = ('GET', 'POST', 'PUT', 'DELETE',)

def read(self, request, id=None):
    if id is None:
        return self.list(request)
    return BookDetailedView(self.get(request, id))

def list(self, request):
    form = PaginationForm(request.GET)
    per_page, page_num = form.get_pagination_params()

    paginator = Paginator(Book.objects.all(), per_page)
    page = paginator.page(page_num)
    return {
        'pagination': PaginationView(page),
        'books': BookSummaryView([x for x in page.object_list]),
        }

def get(self, request, id):
    try:
        book = Book.objects.get(id=id)
    except (ValidationError, Book.DoesNotExist):
        raise PistonNotFoundException('Error retrieving book with ID %s' % id)
    return book

@login_required()
def create(self, request, id=None):
    if id is not None:
        raise PistonNotFoundException('ID not expected when creating books')

    form = BookForm(request.data)
    if not form.is_valid():
        raise FormValidationError(form)

    book = form.save()

    return BookDetailedView(book)

@login_required()
def update(self, request, id):
    form = BookForm(request.data)
    if not form.is_valid():
        raise FormValidationError(form)

    book = form.save()

    return BookDetailedView(book)

@login_required()
def delete(self, request, id):
    book = self.get(request, id)
    book.delete()

    return rc.DELETED

Utilities & Auth

Let's add some cool stuff:

• A new envelope class (included in this piston release)
• A serialization selector URL wrapper
• A new Oauth authentication handler

utils.py:

from django.conf.urls.defaults import url as django_url
from piston import resource


class Resource(resource.Resource):
    def __init__(self, *args, **kwargs):
        if 'response_class' not in kwargs:
            kwargs['response_class'] = resource.EnhancedResponse
        super(Resource, self).__init__(*args, **kwargs)


def api_url(pattern, *args, **kwargs):
    assert pattern.endswith('$'), 'API urls must be terminal.'
    # Ensure that all negative look behind formats are fixed width.
    pattern = r'%s(\.(?P<emitter_format>json|xml|jsonp)|(?<!.\.json|..\.xml|\.jsonp))$' % pattern[:-1]
    return django_url(pattern, *args, **kwargs)

auth.py:

from django.conf import settings
from django.http import HttpResponse

from piston import oauth
from piston.authentication import OAuthAuthentication, send_oauth_error

class OAuthApiAuthentication(OAuthAuthentication):
    def is_authenticated(self, request):
        if self.is_valid_request(request):
            try:
                consumer, token, parameters = self.validate_token(request)
            except oauth.OAuthError, err:
                if settings.DEBUG and request.GET.get('debug'):
                    print send_oauth_error(err)
                return False

            if consumer and token:
                request.user = token.user
                request.consumer = consumer
                request.throttle_extra = token.consumer.id
                return True

        return False

URLs

Finally urls.py:

from django.conf.urls.defaults import patterns

from myproject.apps.api.auth import OAuthApiAuthentication
from myproject.apps.api.utils import api_url, Resource
from myproject.apps.books.handlers import BooksHandler

auth = OAuthApiAuthentication()
books_handler = Resource(BooksHandler, authentication=auth)

urlpatterns = patterns(
    '',
    api_url(r'^(/(?P<id>\w{24}))?$', books_handler),
    )

Responses

So what does this get you?

If you use the default envelope (from legacy piston), then:

For a GET request you see:

{
    'title': "The Tiger's Wife",
    'isbn10': '0385343833',
    'isbn13': '978-0385343831',
    'language': 'English',
    'pages': 352,
    'authors': ['T�a Obreht',
            ],
    'editions': [{
             'publisher': 'Random House',
             'edition': 1,
             'date_published': '03/08/2011',
             }],
    'awards': [{
                  'name': 'Orange Prize',
                  'year': 2011,
              }],
    'is_favorite': 'true',
}

If you use the EnhancedResponse envelope we added, for the same request, you see:

{
    "status_code": 200,
    "form_errors": {},
    "error_code": null,
    "error_message": '',
    "data": {
        'title': "The Tiger's Wife",
        'isbn10': '0385343833',
        'isbn13': '978-0385343831',
        'language': 'English',
        'pages': 352,
        'authors': ['T�a Obreht',
                ],
        'editions': [{
                 'publisher': 'Random House',
                 'edition': 1,
                 'date_published': '03/08/2011',
                 }],
        'awards': [{
                      'name': 'Orange Prize',
                      'year': 2011,
                  }],
        'is_favorite': 'true',
    }
}

In order to get form error feedback, error metadata you have to use the EnhancedResponse.

With that, if you have issues with your data and it could not be validated, you see:

{
    "status_code": 400,
    "form_errors": {
        'title': ['This field is required'],
        'isbn10': ['Value is not a valid ISBN10 number'],
        'authors': ['Could not find author with name Samuel L. Jackson'],
    },
    "error_code": null,
    "error_message": '',
    "data": {}
}    

We currently don't mandate default usage of the error code or message. You can use it to define your own error scheme.

If you're retrieving a list of books, you'll see something like:

{
    "status_code": 200,
    "form_errors": {},
    "error_code": null,
    "error_message": "",
    "data": {
        'pagination': {
                'page': 2,
                'pages': 13,
                'count': 254,
                'per_page': 20,
                'has_next': true,
                'has_previous': false,
                'start': 21,
                'end': 40,
                },
        'books': [{
                    'id': 1,
                    'title': "The Tiger's Wife",
                    'isbn10': '0385343833',
                    'authors': ['T�a Obreht'],
                    },
                  {
                    'id': 2,
                    'title': "A Game of Thrones: A Song of Ice and Fire: Book One",
                    'isbn10': '0553386794',
                    'authors': ['George R.R. Martin'],
                    },
                  ...
                  ],
              }
        }
    }