django-ajaxutils 0.2

Requiring authentication

If your view requires the user to be authenticated, just write it:

@ajax(login_required=True)
def some_very_private_view(request):
    data = perform_something_private()
    return {
        'data': data
    }

In case of an unauthenticated request, a 401: Unauthorized response containing the following JSON object will be returned:

{
    'status': 'error',
    'error': 'Unauthorized',
}

Requiring GET / POST

@ajax also allows you a quick way to require a particular method for requesting the view. For example, if your view will edit some server-side data, you may accept only POST requests. With @ajax this is as easy as remembering the first two decimal digits of PI (which are 1 and 4, btw):

@ajax(login_required=True, require_POST=True)
def submit_my_data(request):
    new_obj = save_my_data()
    return {
        'id': new_obj.pk
    }

This will return a 405: Method not allowed response with the following JSON object in case of illegal requests:

{
    'status': 'error',
    'error': 'Method not allowed',
}

You can of course set require_GET=True for GET requests.

You can also use this alternative syntax:

@ajax(require="GET")
def my_cool_view(request):
    return {
        'hello': 'world!'
    }

Custom Status Codes

What if you don’t want to return an HTTP 200? Do you want to return a 404? Write:

from django.http import Http404

@ajax()
def my_cool_view(request):
    raise Http404

This returns:

{
    'status': 'error',
    'error': 'Not found',
}

Or maybe a 400 - Bad Request:

from django.http import HttpResponseBadRequest

@ajax()
def my_cool_view(request):
    return HttpResponseBadRequest('My error message')

This returns:

{
    'status': 'error',
    'error': 'My error message',
}

and the HTTP response has status code 400.

Another syntax, more Flask-ish:

@ajax()
def my_cool_view(request):
    return {
        "i'm a": 'teapot'
    }, 418

From infinity import json

Tired of writing infinite import statements to choose the best json module? Let ajaxutils do it for you:

from ajaxutils import json

At the moment, ajaxutils prefers simplejson over the stdlib json. No other json module is used. In the future we will probably provide support to ujson using a Django setting.