nhomar/ooorest

OpenObject On Rails, the REST way! A Restful engine and framework to unleash OpenERP in Rails applications...

Basic REST Usage

Require the gem in your Gemfile with:

gem 'ooorest', git: 'https://github.com/akretion/ooorest.git'

then run

bundle install

Finally mount in your Rails application as an engine, for instance by adding this line in your config/routes.rb

mount Ooorest::Engine => "/ooorest"

You can now talk to OpenERP using REST webservices in JSON or XML formats!

You may run

rake routes

to discover the basic REST routes.

For instance you can get the list of OpenERP users with:

GET /ooorest/res-users.json

You can also read user with 1 with:

GET /ooorest/res-users/1.json

the OpenERP model name param should come after the engine scope ('ooorest' here). Note that '.' from OpenERP model names are replaced by '-' (res.users -> res-users).

Usage as a Rails framework

You may also just require ooorest but not necessarily mount the engine. You may simply enjoy using the RequestHelper class that makes it easy to write your own custom Rails controllers to deal with OpenERP objects seamlessly.

You can choose to bootstrap a default public OOOR connection in your Rails app by setting an appropriate config/ooor.yml config file (see in test/dummy/config/ooor.yml for an example). In this case the mentionned classes will be bootstraped and you'll be able to use them in your Rails application. These classes will use the credentials defined in ooor.yml. Warning! this can be a security issue! So make sure that the public credentials you use here only have basic acess rights, possibly no write permissions at all in your OpenERP (specially if you mount the engine and hence enable default CRUD actions).

If you want to enable users to write in your OpenERP, you should instead use an authentication system such as Devise and then use the ooor_object method from RequestHelper, for instance:

ooor_object('product.product')

wich will appropriately instanciate OpenERP proxies with appropriate specific OpenERP credentials according to the Rails logged user. TODO to be explained better.