ooor 1.0.4 → 1.0.5

data/lib/app/controllers/open_objects_controller.rb

@@ -42,7 +42,7 @@ class OpenObjectsController < ActionController::Base
     end
 
     def load_all_controllers(map)
-      OpenObjectResource.all_loaded_models.each do |model|
+      Ooor.all_loaded_models.each do |model|
         map.resources model.gsub('.', '_').to_sym
       end
     end

data/lib/app/models/open_object_resource.rb

@@ -1,11 +1,6 @@
 require 'xmlrpc/client'
 require 'activeresource'
 
-#TODO support name_search via search + param
-#see name_search(self, cr, user, name='', args=None, operator='ilike', context=None, limit=None):
-#TODO support offset, limit and order
-#see def search(self, cr, user, args, offset=0, limit=None, order=None, context=None, count=False):
-
 class OpenObjectResource < ActiveResource::Base
 
   # ******************** class methods ********************
@@ -14,7 +9,7 @@ class OpenObjectResource < ActiveResource::Base
     cattr_accessor :logger
     attr_accessor :openerp_id, :info, :access_ids, :name, :openerp_model, :field_ids, :state, #model class attributes assotiated to the OpenERP ir.model
                   :field_defined, :many2one_relations, :one2many_relations, :many2many_relations,
-                  :openerp_database, :all_loaded_models
+                  :openerp_database, :user_id
 
     def class_name_from_model_key(model_key)
       model_key.split('.').collect {|name_part| name_part[0..0].upcase + name_part[1..-1]}.join
@@ -22,11 +17,6 @@ class OpenObjectResource < ActiveResource::Base
 
     def reload_fields_definition(force = false)
       if self != IrModel and self != IrModelFields and (force or not @field_defined)#TODO have a way to force reloading @field_ids too eventually
-        unless @field_ids
-           model_def = IrModel.find(:all, :domain => [['model', '=', @openerp_model]])
-           @field_ids = model_def.field_id
-           @access_ids = model_def.access_ids
-        end
         fields = IrModelFields.find(@field_ids)
         @fields = {}
         @many2one_relations = {}
@@ -52,15 +42,14 @@ class OpenObjectResource < ActiveResource::Base
     def define_openerp_model(arg, url, database, user_id, pass, binding)
       param = (arg.is_a? OpenObjectResource) ? arg.attributes.merge(arg.relations) : {'model' => arg}
       model_key = param['model']
-      @all_loaded_models ||= []
-      all_loaded_models.push(model_key)
+      Ooor.all_loaded_models.push(model_key)
       model_class_name = class_name_from_model_key(model_key)
       logger.info "registering #{model_class_name} as a Rails ActiveResource Model wrapper for OpenObject #{model_key} model"
       definition = "
       class #{model_class_name} < OpenObjectResource
-        self.site = '#{url}'
+        self.site = '#{url || Ooor.object_url}'
         self.user = #{user_id}
-        self.password = '#{pass}'
+        self.password = #{pass || false}
         self.openerp_database = '#{database}'
         self.openerp_model = '#{model_key}'
         self.openerp_id = #{param['id'] || false}
@@ -84,8 +73,14 @@ class OpenObjectResource < ActiveResource::Base
       rpc_execute('search', domain, offset, limit, order, context, count)
     end
 
-    def client
-      @client ||= XMLRPC::Client.new2(@site.to_s.gsub(/\/$/,'')) #always remove trailing / to make OpenERP happy
+    def client(url)
+      @clients ||= {}
+      @client = @clients[url]
+      unless @clientl
+        @client ||= XMLRPC::Client.new2(url)
+        @clients[url] = @client
+      end
+      return @client
     end
 
     #corresponding method for OpenERP osv.execute(self, db, uid, obj, method, *args, **kw) method
@@ -94,25 +89,25 @@ class OpenObjectResource < ActiveResource::Base
     end
 
     def rpc_execute_with_object(object, method, *args)
-      rpc_execute_with_all(@openerp_database, @user, @password, object, method, *args)
+      rpc_execute_with_all(@database || Ooor.config[:database], @user_id || Ooor.config[:user_id], @password || Ooor.config[:password], object, method, *args)
     end
 
     #corresponding method for OpenERP osv.execute(self, db, uid, obj, method, *args, **kw) method
     def rpc_execute_with_all(db, uid, pass, obj, method, *args)
-      try_with_pretty_error_log { client.call("execute", db, uid, pass, obj, method, *args) }
+      try_with_pretty_error_log { client(@database && @site || Ooor.object_url).call("execute",  db, uid, pass, obj, method, *args) }
     end
 
      #corresponding method for OpenERP osv.exec_workflow(self, db, uid, obj, method, *args)
-    def rpc_exec_workflow(method, *args)
-      rpc_exec_workflow_with_object(@openerp_model, method, *args)
+    def rpc_exec_workflow(action, *args)
+      rpc_exec_workflow_with_object(@openerp_model, action, *args)
     end
 
-    def rpc_exec_workflow_with_object(object, method, *args)
-      rpc_exec_workflow_with_all(@openerp_database, @user, @password, object, method, *args)
+    def rpc_exec_workflow_with_object(object, action, *args)
+      rpc_exec_workflow_with_all(@database || Ooor.config[:database], @user_id || Ooor.config[:user_id], @password || Ooor.config[:password], object, action, *args)
     end
 
-    def rpc_exec_workflow_with_all(method, *args)
-      try_with_pretty_error_log { client.call("exec_workflow", db, uid, pass, obj, method,  *args) }
+    def rpc_exec_workflow_with_all(db, uid, pass, obj, action, *args)
+      try_with_pretty_error_log { client(@database && @site || Ooor.object_url).call("exec_workflow", db, uid, pass, obj, action, *args) }
     end
 
     #grab the eventual error log from OpenERP response as OpenERP doesn't enforce carefuly
@@ -134,6 +129,10 @@ class OpenObjectResource < ActiveResource::Base
 
     def load_relation(model_key, ids, *arguments)
       options = arguments.extract_options!
+      unless Ooor.all_loaded_models.index(model_key)
+        model = IrModel.find(:first, :domain => [['model', '=', model_key]])
+        define_openerp_model(model, nil, nil, nil, nil, Ooor.binding)
+      end
       relation_model_class = eval class_name_from_model_key(model_key)
       relation_model_class.send :find, ids, :fields => options[:fields] || [], :context => options[:context] || {}
     end
@@ -192,6 +191,8 @@ class OpenObjectResource < ActiveResource::Base
 
   # ******************** instance methods ********************
 
+  attr_accessor :ooor_user, :ooor_password
+
   def pre_cast_attributes
     @attributes.each {|k, v| @attributes[k] = ((v.is_a? BigDecimal) ? Float(v) : v)}
   end
@@ -205,7 +206,7 @@ class OpenObjectResource < ActiveResource::Base
         when Array
            relations[key.to_s] = value #the relation because we want the method to load the association through method missing
         when Hash
-          resource = find_or_create_resource_for(key)
+          resource = find_or_create_resource_for(key) #TODO check!
           @attributes[key.to_s] = resource@attributes[key.to_s].new(value)
         else
           @attributes[key.to_s] = value.dup rescue value
@@ -247,11 +248,18 @@ class OpenObjectResource < ActiveResource::Base
   #Generic OpenERP on_change method
   def on_change(on_change_method, *args)
     result = self.class.rpc_execute(on_change_method, *args)
+    session
     self.classlogger.info result["warning"]["title"] if result["warning"]
     self.class.logger.info result["warning"]["message"] if result["warning"]
     load(result["value"])
   end
 
+  #wrapper for OpenERP exec_workflow Business Process Management engine
+  def wkf_action(action, context={})
+    self.class.rpc_exec_workflow(action, self.id) #FIXME looks like OpenERP exec_workflow doesn't accept context but it might be a bug
+    load(self.class.find(self.id, :context => context).attributes)
+  end
+
 
   # ******************** fake associations like much like ActiveRecord according to the cached OpenERP data model ********************
 
@@ -273,17 +281,19 @@ class OpenObjectResource < ActiveResource::Base
   end
 
   def method_missing(method_id, *arguments)
+    @loaded_relations ||= {}
+    result = @loaded_relations[method_id.to_s]
+    return result if result
     result = relationnal_result(method_id, *arguments)
     if result
-      return result
+      @loaded_relations[method_id.to_s] = result
+      return result 
     elsif @relations and @relations[method_id.to_s] and !self.class.many2one_relations.empty?
       #maybe the relation is inherited or could be inferred from a related field
       self.class.many2one_relations.each do |k, field|
         model = self.class.load_relation(field.relation, @relations[method_id.to_s][0], *arguments)
         result = model.relationnal_result(method_id, *arguments)
-        if result
-          return result
-        end
+        return result if result
       end
       super
     end

data/lib/ooor.rb

@@ -1,83 +1,72 @@
 require 'logger'
+require 'xmlrpc/client'
 
 module Ooor
 
-  @ooor_logger = ((defined?(RAILS_ENV) and RAILS_ENV != "development") ? Rails.logger : Logger.new(STDOUT))
-
-  #load the custom configuration
-  def self.load_config(config_file=nil, env=nil)
-    config_file ||= defined?(RAILS_ROOT) && "#{RAILS_ROOT}/config/ooor.yml" || 'ooor.yml'
-    env ||= defined?(RAILS_ENV) && RAILS_ENV || 'development'
-    @ooor_config = YAML.load_file(config_file)[env]
-  rescue SystemCallError
-    @ooor_logger.error """failed to load OOOR yaml configuration file.
-       make sure your app has a #{config_file} file correctly set up
-       if not, just copy/paste the default ooor.yml file from the OOOR Gem
-       to #{RAILS_ROOT}/config/ooor.yml and customize it properly\n\n"""
-    raise
-  end
+  class << self
 
-  def self.loaded?
-    OpenObjectResource.all_loaded_models.is_a? Array and OpenObjectResource.all_loaded_models.size > 0
-  end
+    attr_accessor :logger, :config, :all_loaded_models, :binding, :common_url, :object_url
 
-  def self.reload!(config=false, env=false, keep_config=false)
-    @ooor_config = config.is_a?(Hash) && config or keep_config && @ooor_config or self.load_config(config, env)
-    @ooor_config.symbolize_keys!
-
-    begin
-      url = @ooor_config[:url]
-      database = @ooor_config[:database]
-      user = @ooor_config[:username]
-      pass = @ooor_config[:password]
-      @ooor_logger.level = @ooor_config[:log_level] if @ooor_config[:log_level]
-    rescue Exception => error
-      @ooor_logger.error """ooor.yml failed: #{error.inspect}
-       #{error.backtrace}
-       You probably didn't configure the ooor.yml file properly because we can't load it"""
+    #load the custom configuration
+    def load_config(config_file=nil, env=nil)
+      config_file ||= defined?(RAILS_ROOT) && "#{RAILS_ROOT}/config/ooor.yml" || 'ooor.yml'
+      env ||= defined?(RAILS_ENV) && RAILS_ENV || 'development'
+      Ooor.config = YAML.load_file(config_file)[env]
+    rescue SystemCallError
+      Ooor.logger.error """failed to load OOOR yaml configuration file.
+         make sure your app has a #{config_file} file correctly set up
+         if not, just copy/paste the default ooor.yml file from the OOOR Gem
+         to #{RAILS_ROOT}/config/ooor.yml and customize it properly\n\n"""
       raise
     end
 
-    require 'xmlrpc/client'
-    begin
-      login_url = url.gsub(/\/$/,'') + "/common"
-      client = XMLRPC::Client.new2(login_url)
-      user_id = client.call("login", database, user, pass)
+    def loaded?
+      Ooor.all_loaded_models.size > 0
+    end
+
+    def global_login(user, password)
+      begin
+      Ooor.config[:username] = user
+      Ooor.config[:password] = password
+      client = OpenObjectResource.client(Ooor.common_url)
+      OpenObjectResource.try_with_pretty_error_log { client.call("login", Ooor.config[:database], user, password)}
+      rescue SocketError => error
+        Ooor.logger.error """login to OpenERP server failed:
+         #{error.inspect}
+         Are your sure the server is started? Are your login parameters correct? Can this server ping the OpenERP server?
+         login XML/RPC url was #{Ooor.config[:url].gsub(/\/$/,'') + "/common"}"""
+      end
+    end
 
+    def reload!(config=false, env=false, keep_config=false)
+      Ooor.config = config.is_a?(Hash) && config or keep_config && Ooor.config or self.load_config(config, env)
+      Ooor.config.symbolize_keys!
+      Ooor.logger.level = Ooor.config[:log_level] if Ooor.config[:log_level]
+      Ooor.common_url = Ooor.config[:url].gsub(/\/$/,'') + "/common"
+      Ooor.object_url = Ooor.config[:url].gsub(/\/$/,'') + "/object"
+      Ooor.config[:user_id] = global_login(Ooor.config[:username] || 'admin', Ooor.config[:password] || 'admin')
 
       #*************** load the models
 
-      models_url = url.gsub(/\/$/,'') + "/object"
-      OpenObjectResource.logger = @ooor_logger
-      @ooor_binding = lambda {}
-      OpenObjectResource.define_openerp_model("ir.model", models_url, database, user_id, pass, @ooor_binding)
-      OpenObjectResource.define_openerp_model("ir.model.fields", models_url, database, user_id, pass, @ooor_binding)
-
+      Ooor.all_loaded_models = []
+      OpenObjectResource.logger = Ooor.logger
+      OpenObjectResource.define_openerp_model("ir.model", nil, nil, nil, nil, Ooor.binding)
+      OpenObjectResource.define_openerp_model("ir.model.fields", nil, nil, nil, nil, Ooor.binding)
 
-      if @ooor_config[:models] #we load only a customized subset of the OpenERP models
-        models = IrModel.find(:all, :domain => [['model', 'in', @ooor_config[:models]]])
+      if Ooor.config[:models] #we load only a customized subset of the OpenERP models
+        models = IrModel.find(:all, :domain => [['model', 'in', Ooor.config[:models]]])
       else #we load all the models
         models = IrModel.find(:all)
       end
 
-      models.each {|openerp_model| OpenObjectResource.define_openerp_model(openerp_model, models_url, database, user_id, pass, @ooor_binding) }
-
+      models.each {|openerp_model| OpenObjectResource.define_openerp_model(openerp_model, nil, nil, nil, nil, Ooor.binding)}
 
       # *************** load the models REST controllers
       if defined?(ActionController)
-        OpenObjectsController.logger = @ooor_logger
-        models.each {|openerp_model| OpenObjectsController.define_openerp_controller(openerp_model.model, @ooor_binding) }
+        OpenObjectsController.logger = Ooor.logger
+        models.each {|openerp_model| OpenObjectsController.define_openerp_controller(openerp_model.model, Ooor.binding) }
       end
 
-
-    rescue SystemCallError => error
-      @ooor_logger.error """login to OpenERP server failed:
-       #{error.inspect}
-       #{error.backtrace}
-       Are your sure the server is started? Are your login parameters correct? Can this server ping the OpenERP server?
-       login XML/RPC url was #{login_url}
-       database: #{database}; user name: #{user}; password: #{pass}
-       OOOR plugin not loaded! Continuing..."""
     end
 
   end
@@ -85,6 +74,9 @@ module Ooor
 end
 
 
+Ooor.logger = ((defined?(RAILS_ENV) and RAILS_ENV != "development") ? Rails.logger : Logger.new(STDOUT))
+Ooor.binding = lambda {}
+
 require 'app/models/open_object_resource'
 require 'app/controllers/open_objects_controller'
 

data/ooor.yml

@@ -0,0 +1,27 @@
+#In order Rails knows how to t=connect to your OpenERP server, you should create a file APPLICATION_ROOT/config/ooor.yml
+#with the following pattern customized with your OpenERP server URL, your target OpenERP database, your login and password.
+
+development:
+  url: http://localhost:8069/xmlrpc         #the OpenERP XML/RPC server
+  database: database_name                #the OpenERP database you want to connect to
+  username: admin
+  password: admin
+  #comment the following line if you want to load ALL the available models (slower startup), or complete it with all the OpenERP models you want to be loaded
+  models: [res.partner, product.template, product.product, product.category, sale.order, sale.order.line, account.invoice]
+  bootstrap: true   #true if you want to load OpenObject models (will hit OpenERP server) at startup; else use Ooor.reload!(lambda {}) to reload the Ooor models at any time
+
+test:
+  url: http://localhost:8069/xmlrpc
+  database: database_name
+  username: admin
+  password: admin
+  models: [res.partner, product.template, product.product, product.category, sale.order, sale.order.line, account.invoice]
+  bootstrap: true
+
+production:
+  url: http://localhost:8069/xmlrpc
+  database: database_name
+  username: admin
+  password: admin
+  models: [res.partner, product.template, product.product, product.category, sale.order, sale.order.line, account.invoice]
+  bootstrap: true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ooor
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors: 
   - Raphael Valyi - www.akretion.com
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-04 00:00:00 -02:00
+date: 2009-11-08 00:00:00 -02:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -36,6 +36,7 @@ files:
   - lib/ooor.rb
   - lib/app/models/open_object_resource.rb
   - lib/app/controllers/open_objects_controller.rb
+  - ooor.yml
 has_rdoc: true
 homepage: http://github.com/rvalyi/ooor
 licenses: []