restorm 0.1

Features

• Object relational mapping of webservice resources.

• Flexible client architecture that can be used with your own or third party clients (like oauth).

• Extensive mocking module allows you to mock webservice responses, or even complete webservices.

Create a mock webservice

In order to test your client, you can emulate a whole webservice using the MockApiClient. However, sometimes it’s faster or easier to use a single, predefined response, using the MockClient and MockResponse (sub)classes.

You can also use FileResponse class to return the contents of a file as response in combination with the MockApiClient.

The mock webservice below contains a list of books and a list of authors. To keep it simple, both lists contain only 1 item

from restorm.clients.mockclient import MockApiClient

client = MockApiClient(
    responses={
        '/api/book/': {
            'GET': ({'Status': 200}, [{'id': 1, 'name': 'Dive into Python', 'resource_url': 'http://www.example.com/api/book/1'}]),
            'POST': ({'Status': 201, 'Location': 'http://www.example.com/api/book/2'}, ''),
        },
        '/api/book/1': {'GET': ({'Status': 200}, {'id': 1, 'name': 'Dive into Python', 'author': 'http://www.example.com/api/author/1'})},
        '/api/author/': {'GET': ({'Status': 200}, [{'id': 1, 'name': 'Mark Pilgrim', 'resource_url': 'http://www.example.com/api/author/1'}])},
        '/api/author/1': {'GET': ({'Status': 200}, {'id': 1, 'name': 'Mark Pilgrim'})}
    },
    root_uri='http://www.example.com'
)

Define resources

Setup your client side resource definitions:

from restorm.resource import Resource

class Book(Resource):
    class Meta:
        list = (r'^book/$', 'book_set')
        item = r'^book/(?P<id>\d)$'
        root = 'http://www.example.com/api/'

Make it work

You can simply access the Book resource:

>>> book = Book.objects.get(id=1, client=client) # Get book with ID 1.
>>> book.data['name'] # Get the value of the key "name".
u'Dive Into Python'
>>> book.data['author'] # Get the value of the key "author".
u'http://www.example.com/api/author/1'
>>> author = book.data.author # Perform a GET on the "author" resource.
>>> author.data['name']
u'Mark Pilgrim'