ooorest 0.0.5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [Raphaël Valyi]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+OOOREST - OpenObject On Rails, REST layer
+====
+
+<table>
+    <tr>
+        <td><a href="http://github.com/rvalyi/ooor" title="OOOR - OpenObject On Rails"><img src="http://sites.google.com/site/assetserversite/_/rsrc/1257126460164/home/ooor_s.jpg" width="159px" height="124px" /></a></td>
+        <td><b>BY</b></td>
+        <td><a href="http://www.akretion.com" title="Akretion - open source to spin the world"><img src="http://sites.google.com/site/assetserversite/_/rsrc/1257126470309/home/akretion_s.png" width="228px" height="124px" /></a></td>
+        <td>
+OOOR stands for OpenObject On Rails. OpenObject is the RAD framework behind OpenERP,
+the ERP that doesn't hurt, just like Rails is "web development that doesn't hurt".
+So OOOR exposes seamlessly your OpenOpbject application, to your custom Rails application.
+Needless to say, OOOR doubly doesn't hurt.
+Furthermore, OOOR only depends on the "activeresource" gem. So it can even be used
+in any (J)Ruby application without Rails.
+        </td>
+    </tr>
+</table>
+
+OooREST enables REST HTTP routes to your OpenERP models:
+Before anything, make sure you read the doc of [OOOR](http://github.com/rvalyi/ooor)
+Install the gem using gem install ooorest.
+
+we assume you created a working Rails application, in your config/environment.rb
+Inside the Rails::Initializer.run do |config| statement, paste the following gem dependency (along with the ooor dependency):
+
+    $ config.gem "ooorest"
+
+in your config/route.rb, you can alternatively enable routes to all your OpenERP models by addding:
+    $ OOOREST.load_all_controllers(map)
+
+Or only enable the route to some specific model instead (here partners):
+    $ map.resources :res_partner
+
+
+REST HTTP API:
+
+    $ http://localhost:3000/res_partner
+    $ http://localhost:3000/res_partner.xml
+    $ http://localhost:3000/res_partner.json
+    $ http://localhost:3000/res_partner/2
+    $ http://localhost:3000/res_partner/2.json
+    $ http://localhost:3000/res_partner/2.xml
+    $ http://localhost:3000/res_partner/[2,3,4].xml
+    $ http://localhost:3000/res_partner/[2,3,4].json
+
+    $ TODO http://localhost:3000/res_partner.xml?active=1
+
+    $ TODO http://localhost:3000/res_partner.xml?domain=TODO
+
+
+FAQ
+------------
+
+
+### Can I extend the OOOR controllers?
+
+Yes, you can do that, see the "how to extends models" section as it's very similar. Instead, in the app/controllers directory, you'll re-open defined controllers,
+for the product.product controllers, it means creating a product_product_controller.rb file with:
+
+    $ class ProductProduct < OpenObjectsController
+    $   def foo
+    $     render :text => "bar"
+    $   end
+    $ end
+
+Now, if you register that new method in your route.rb file GET /product_product/1/foo will render "bar" on your browser screen.
+You could instead just customize the existing CRUD methods so you don't need to regiter any other route in route.rb.

data/lib/app/controllers/open_objects_controller.rb

@@ -0,0 +1,123 @@
+require 'action_controller'
+
+class OpenObjectsController < ActionController::Base
+
+  #TODO get lang from URL in before filter
+  #TODO use timezone from HTTP header and put is in context
+
+  # ******************** class methods ********************
+  class << self
+
+    cattr_accessor :logger
+    attr_accessor :model_class
+
+    def model_class
+        if defined?(@model_class)
+          @model_class
+        elsif superclass != Object && superclass.model_class
+          superclass.model_class.dup.freeze
+        end
+    end
+
+    def model_class=(_model_class)
+      @model_class = _model_class
+    end
+
+    def ids_from_param(param)
+      if param.split(',').size > 0
+        return eval param
+      else
+        return param
+      end
+    end
+
+  end
+
+
+  # ******************** instance methods ********************
+
+  # GET /models
+  # GET /models.xml
+  def index
+    @models = self.class.model_class.find(:all)
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @models }
+    end
+  end
+
+  # GET /models/1
+  # GET /models/1.xml
+  def show
+    @models = self.class.model_class.find(self.class.ids_from_param(params[:id]))
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @models }
+      format.json  { render :json => @models }
+    end
+  end
+
+  # GET /models/new
+  # GET /models/new.xml
+  def new
+    @models = self.class.model_class.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @models }
+    end
+  end
+
+  # GET /models/1/edit
+  def edit
+    @models = self.class.model_class.find(params[:id])
+  end
+
+  # POST /models
+  # POST /models.xml
+  def create
+    @models = self.class.model_class.new(params[:partners])
+
+    respond_to do |format|
+      if @models.save
+        flash[:notice] = 'Model was successfully created.'
+        format.html { redirect_to(@models) }
+        format.xml  { render :xml => @models, :status => :created, :location => @models }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @models.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /models/1
+  # PUT /models/1.xml
+  def update
+    @models = self.class.model_class.find(params[:id])
+
+    respond_to do |format|
+      if @models.update_attributes(params[:partners])
+        flash[:notice] = 'Partners was successfully updated.'
+        format.html { redirect_to(@models) }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @models.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /models/1
+  # DELETE /models/1.xml
+  def destroy
+    @models = self.class.model_class.find(params[:id])
+    @models.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(url_for(:action => index)) }
+      format.xml  { head :ok }
+    end
+  end
+end

data/lib/ooorest.rb

@@ -0,0 +1,33 @@
+require 'app/controllers/open_objects_controller'
+
+class OooREST
+
+  attr_accessor :ooor
+
+  def initialize(ooor)
+    @ooor = ooor
+    models = @ooor.config[:models] && @ooor.all_loaded_models.select {|model| ooor.config[:models].index(model.openerp_model)} || @ooor.all_loaded_models
+    OpenObjectsController.logger = @ooor.logger
+    models.each {|model| define_openerp_controller(model)}
+  end
+
+  def define_openerp_controller(model_class)
+    controller_class_name = model_class.to_s + "Controller"
+    OpenObjectsController.logger.info "registering #{controller_class_name} as a Rails ActiveResource Controller wrapper for OpenObject #{model_class} model"
+    klass = Class.new(OpenObjectsController)
+    klass.model_class = model_class
+    Object.const_set(controller_class_name, klass)
+    klass
+  end
+
+  def load_all_controllers(map)
+    @ooor.all_loaded_models.each do |model|
+      map.resources model.openerp_model.gsub('.', '_').to_sym
+    end
+  end
+
+end
+
+if defined?(Rails) && defined?(OOOR)
+  OOOREST = OooREST.new(OOOR)
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: ooorest
+version: !ruby/object:Gem::Version 
+  version: 0.0.5
+platform: ruby
+authors: 
+  - Raphael Valyi - www.akretion.com
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-19 00:00:00 -02:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: ooor
+    type: :runtime
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 1.2.0
+      version: 
+  - !ruby/object:Gem::Dependency 
+    name: actionpack
+    type: :runtime
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 2.3.1
+      version: 
+description: OOOREST is a thin layer over the OOOR Model layer, an ActiveResource proxy for OpenERP models. OOOREST depends on actionpack and OOOR, thus OpenERP models Restfully over HTTP, using the Rails formats.
+email: rvalyi@akretion.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - README.md
+  - MIT-LICENSE
+  - lib/ooorest.rb
+  - lib/app/controllers/open_objects_controller.rb
+has_rdoc: true
+homepage: http://github.com/rvalyi/ooor
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: OOOR - OpenObject On Rails
+test_files: []
+