Wind Potion

##About REST API for use with Tornado and SQLAlchemy Elixir

##Dependeces Tested in python 2.7

• Tornado 3
• Elixir

##Installing

python setup.py install

Or directly from github

sudo pip install git+https://github.com/rubenspgcavalcante/Wind-Potion.git

##How to use

Simple use

First create a service, (Here we'll create a user service), and annotates like a service of the entity user, (the elixir Entity):

from windpotion.annotations import service

@windpotion.annotations.service(User)
class UserService(object):
    pass

Ok, now simply create a REST handler which inherits from RestHandler, annotates like a REST using as a service the previous made UserService

from windpotion.annotations import REST
from windpotion.handlers import RestHandler

@windpotion.annotations.REST(UserService)
class UserRESTHandler(RestHandler):
    """
    User REST handler
    """
    def __init__(self, application, request, **kwargs):
        RestHandler.__init__(self, application, request, **kwargs)

Authenticated validation

If you want to permit only a logged user to use the REST methods from handler, it's just use the SecureRestHandler:

from windpotion.annotations import REST
from windpotion.handlers import SecureRestHandler

@REST(UserService)
class UserRESTHandler(SecureRestHandler):
    """
    User REST handler
    """
    def __init__(self, application, request, **kwargs):
        SecureRestHandler.__init__(self, application, request, **kwargs)

If only a few REST methods must be secured by authentication, (in this exmaple the DELETE) simply do:

from windpotion.annotations import REST, authenticated
from windpotion.handlers import RestHandler

@REST(UserService)
class UserRESTHandler(RestHandler):
    """
    User REST handler
    """
    def __init__(self, application, request, **kwargs):
        super(UserHandler, self).__init__(application, request, **kwargs)

    @authenticated
    def delete(self, id):
        # You can use the super method too: super(UserHandler, self).delete(id)
        self._service.delete(id)

Note the _service property. Every RestHandler has one service associated, and can be acessed using the _service property.

Overrinding Services

You want override the service default methods? I'll show a example of all users created has the named turned to upper case:

from windpotion.annotations import service

@service(User)
class UserService(object):

    def create(self, dict_args):
        dict_args['name'] = dict_args['name'].upper()
        self._meta.create(self, dict_args)

Note the _meta property, this is because the original create method is from a metaclass, so you can access all the ServiceMeta methods using this property.

Adding methods to services

Other ussefull property to is the _entity property. It's the elixir entity which this service is associated. So if you want to build more methods and needs the entity to do queries, just use the _entity property:

from windpotion.annotations import service

@service(User)
class UserService(object):
    
    #Example custom method: Will show the first ten results
    def listFirstTen(self):
        return self._entity.query.limit(10).all()

##Getting the default routers You can get the router bys using the RestHandler.getRouter method:

#Adding to the application the UserRestHandler router
application = tornado.web.Application(
        RestHandler.getRouter(UserRESTHandler)
    ,**settings)

Using as reference the MyEntity elixir entity, the table of route is this:

Method	Default route
GET	/myentity
GET	/myentity/:id
POST	/myentity
PUT	/myentity
DELETE	/myentity/:id

#Author Rubens Pinheiro Gonçalves Cavalcante email: rubenspgcavalcante@gmail.com

##License & Rights *Using GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 gnu.org