kangaroo 0.0.3 → 0.1.0.alpha1

data/lib/kangaroo/util/configuration.rb

@@ -6,7 +6,12 @@ require 'kangaroo/util/loader'
 module Kangaroo
   module Util
     class Configuration
-      attr_accessor :logger, :database, :models, :client
+      Defaults = {
+        'host' => 'localhost',
+        'port' => 8069
+      }
+      
+      attr_accessor :logger, :database, :models, :client, :namespace
 
       # Initialize the Kangaroo configuration
       #
@@ -25,14 +30,13 @@ module Kangaroo
       # Load configured models with {Kangaroo::Util::Loader Loader}
       #
       def load_models
-        if models.blank?
-          logger.info "No models to load."
-          return
-        end
-
         login
-        Loader.new(models, @database).load!
-        logger.info "Loaded OpenERP models matching #{models.inspect}."
+
+        loaded_models = Loader.new(models, @database, @namespace).load!
+        loaded_models ||= []
+        logger.info "Loaded OpenERP models matching #{models.inspect} into namespace #{@namespace}: #{loaded_models.map(&:name).join(', ')}" if models
+        
+        loaded_models
       rescue Exception => e
         logger.error "Loading of OpenERP models failed.\n#{e.inspect}"
       end
@@ -63,8 +67,9 @@ module Kangaroo
       # @option db_config [String] 'password' Password for authentication
       # @option db_config [Enumerable] 'models' List of models(-patterns) to load
       def configure_database db_config
-        @database = Database.new @client, *db_config.values_at('name', 'user', 'password')
-        @models =  db_config['models']
+        @database  = Database.new @client, *db_config.values_at('name', 'user', 'password')
+        @models    = db_config['models']
+        @namespace = db_config['namespace'] || "Oo"
         logger.info %Q(Configured OpenERP database "#{db_config['name']}" at "#{client.connection.host}")
       end
 

data/lib/kangaroo/util/database.rb

@@ -16,49 +16,49 @@ module Kangaroo
       # Access to the {Kangaroo::Util::Proxy::Superadmin Superadmin Proxy}
       #
       # @param super_password superadmin password
-      # @return superadmin service proxy
+      # @return [Kangaroo::Util::Proxy::Superadmin] superadmin service proxy
       def superadmin super_password
         client.superadmin super_password
       end
 
       # Access to the {Kangaroo::Util::Proxy::Db Database Proxy}
       #
-      # @return database service proxy
+      # @return [Kangaroo::Util::Proxy::Db] database service proxy
       def db
         client.db
       end
 
       # Access to the {Kangaroo::Util::Proxy::Common Common Proxy}
       #
-      # @return common service proxy
+      # @return [Kangaroo::Util::Proxy::Common] common service proxy
       def common
         client.common
       end
 
       # Access to the {Kangaroo::Util::Proxy::Workflow Workflow Proxy}
       #
-      # @return workflow service proxy
+      # @return [Kangaroo::Util::Proxy::Workflow] workflow service proxy
       def workflow
         @workflow_proxy ||= Proxy::Workflow.new client.object_service, db_name, user_id, password
       end
 
-      # Access to the {Kangaroo::Util::Proxy::Object Object Proxy}
+      # Access to the Kangaroo::Util::Proxy::Object
       #
-      # @return object service proxy
+      # @return [Kangaroo::Util::Proxy::Object] object service proxy
       def object model_name
         Proxy::Object.new client.object_service, db_name, user_id, password, model_name
       end
 
       # Access to the {Kangaroo::Util::Proxy::Wizard Wizard Proxy}
       #
-      # @return wizard service proxy
+      # @return [Kangaroo::Util::Proxy::Wizard] wizard service proxy
       def wizard
         @wizard_proxy ||= Proxy::Wizard.new client.wizard_service, db_name, user_id, password
       end
 
       # Access to the {Kangaroo::Util::Proxy::Report Report Proxy}
       #
-      # @return report service proxy
+      # @return [Kangaroo::Util::Proxy::Report] report service proxy
       def report
         @report_proxy ||= Proxy::Report.new client.report_service, db_name, user_id, password
       end

data/lib/kangaroo/util/loader.rb

@@ -4,9 +4,12 @@ require 'kangaroo/ruby_adapter/base'
 module Kangaroo
   module Util
     class Loader
-      autoload :Model, 'kangaroo/util/loader/model'
-      autoload :Namespace, 'kangaroo/util/loader/namespace'
-      autoload :RootNamespace, 'kangaroo/util/loader/root_namespace'
+      autoload :Model,                 'kangaroo/util/loader/model'
+      autoload :Namespace,             'kangaroo/util/loader/namespace'
+      autoload :RootNamespace,         'kangaroo/util/loader/root_namespace'
+      autoload :Reflection,            'kangaroo/util/loader/reflection'
+      autoload :InformationRepository, 'kangaroo/util/loader/information_repository'
+      
       attr_accessor :model_names, :models, :database, :namespace
 
       # Initialize a Loader instance
@@ -17,6 +20,7 @@ module Kangaroo
         @database = database
         @model_names = model_names
         sanitize_model_names
+        root_module.database = database
       end
 
       # Loads matching models and uses {Kangaroo::RubyAdapter::Base RubyAdapter} to
@@ -31,34 +35,26 @@ module Kangaroo
 
       protected
       def root_module
-        namespace.constantize
+        namespace.constantize.tap do |ns|
+          unless ns.respond_to?(:namespace)
+            ns.send :extend, Kangaroo::Util::Loader::Namespace
+          end
+          
+          unless ns.respond_to?(:oo_to_ruby)
+            ns.send :extend, Kangaroo::Util::Loader::RootNamespace
+          end
+        end
         
       rescue NameError
         eval <<-RUBY
           module #{namespace}
             extend Kangaroo::Util::Loader::RootNamespace
-            extend Kangaroo::Util::Loader::Namespace
           end
         RUBY
       end
       
-      def ir_module
-        root_module.const_defined?("Ir") ?
-        root_module.const_get("Ir") :
-        root_module.const_set("Ir", Module.new)
-      end
-      
       def reflection_model
-        ir_module.const_defined?("Model") ?
-        ir_module.const_get("Model") :
-        ir_module.const_set("Model", create_reflection_model)
-      end
-      
-      def create_reflection_model
-        Class.new(Kangaroo::Model::Base).tap do |model|
-          model.send :include, Model
-          model.database = database
-        end
+        root_module.reflection_model
       end
       
       def load_oo_models
@@ -80,7 +76,7 @@ module Kangaroo
       def sanitize_model_names
         @model_names = case @model_names
         when nil, []
-          raise 'No models specified.'
+          []
         when :all
           ['%']
         when String

data/lib/kangaroo/util/loader/information_repository.rb

@@ -0,0 +1,56 @@
+module Kangaroo
+  module Util
+    class Loader
+      module InformationRepository
+        def ir_module
+          const_defined?("Ir") ?
+          const_get("Ir") :
+          define_ir_namespace
+        end
+        
+        def values_model
+          ir_module.const_get('Values')
+        end
+        
+        def ir_get key1, key2, model
+          model = ruby_to_oo model
+          results = values_model.remote.get key1, key2, [model]
+          
+          {}.tap do |hsh|
+            results.each do |result|
+              id, name, value = result
+              hsh[name.to_sym] = value
+            end
+          end
+        end
+        
+        def get_object_reference openerp_module, xml_id = nil
+          openerp_module, xml_id = coerce_xml_id openerp_module, xml_id
+          
+          database.object('ir.model.data').get_object_reference openerp_module.to_s, xml_id.to_s
+        end
+        
+        def by_xml_id openerp_module, xml_id = nil
+          type, id = get_object_reference openerp_module, xml_id
+          
+          class_for(type).find id
+        end
+      
+        private
+        def coerce_xml_id openerp_module, xml_id = nil
+          if xml_id.blank?
+            openerp_module.split('.') 
+          else
+            [openerp_module, xml_id]
+          end
+        end
+        
+        def define_ir_namespace
+          mod = Module.new
+          mod.send :extend, Kangaroo::Util::Loader::Namespace
+          const_set("Ir", mod)
+        end
+      end
+    end
+  end
+end

data/lib/kangaroo/util/loader/namespace.rb

@@ -27,7 +27,7 @@ module Kangaroo
           else
             super
           end
-        rescue
+        rescue Exception => e
           super
         end
       end

data/lib/kangaroo/util/loader/reflection.rb

@@ -0,0 +1,61 @@
+module Kangaroo
+  module Util
+    class Loader
+      module Reflection
+        attr_accessor :dont_load_models
+        
+        # Return the Reflection model ('ir.model') for this namespace
+        def reflection_model
+          @reflection_model ||= begin
+            ir_module.const_defined?("Model") ?
+            ir_module.const_get("Model") :
+            ir_module.const_set("Model", create_reflection_model)
+          end
+        end
+        
+        # Check if a model exists, accepts Ruby or OpenObject name parameter
+        def model_exists? name
+          name = ruby_to_oo name
+          reflection_model.where(:model => name).exists?
+        end
+        
+        # Check if there are (nested) models in a namespace e.g.
+        #
+        #   models.in?('product') #=> true
+        #
+        # as there is at least the OpenObject model 'product.product'
+        def models_in? name
+          name = ruby_to_oo name
+          
+          reflection_model.where("model like #{name}.%").exists?
+        end
+        
+        # Load an additional model into the current namespace
+        def load_model model_name
+          return if @dont_load_models
+          
+          existing_ruby_class = oo_to_ruby(model_name).constantize rescue nil
+          return existing_ruby_class if existing_ruby_class
+          
+          model_name = ruby_to_oo model_name
+          Loader.new([model_name], reflection_model.database, name).load!.first
+        end
+        
+        # Return the model for a specified OpenObject model
+        def class_for oo_name
+          oo_to_ruby(oo_name).constantize
+        end
+      
+        private
+        def create_reflection_model
+          Class.new(Kangaroo::Model::Base).tap do |model|
+            model.oo_name = 'ir.model'
+            model.database = database
+            model.namespace = self
+            model.send :include, Model
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kangaroo/util/loader/root_namespace.rb

@@ -2,32 +2,23 @@ module Kangaroo
   module Util
     class Loader
       module RootNamespace
+        include Namespace
+        include InformationRepository
+        include Reflection
+        
+        mattr_accessor :database
+        
+        # Apply naming convention: convert OpenObject name (e.g. "product.product") to
+        # Ruby class name, respecting current namespace (e.g. "Oo::Product::Product")
         def oo_to_ruby oo_name
           name + "::" + oo_name.gsub('.','/').camelize
         end
 
+        # Apply naming convention: convert
+        # Ruby class name, respecting current namespace (e.g. "Oo::Product::Product")
+        # to OpenObject name (e.g. "product.product")
         def ruby_to_oo ruby_name
-           ruby_name.sub(name + "::",'').underscore.gsub '/', '.'
-        end
-        
-        def reflection_model
-          const_get('Ir').const_get('Model')
-        end
-        
-        def model_exists? name
-          name = ruby_to_oo name
-          reflection_model.where(:model => name).exists?
-        end
-        
-        def models_in? name
-          name = ruby_to_oo name
-          
-          reflection_model.where("model like #{name}.%").exists?
-        end
-        
-        def load_model model_name
-          model_name = ruby_to_oo model_name
-          Loader.new([model_name], reflection_model.database, name).load!.first
+           ruby_name.to_s.sub(name + "::",'').underscore.gsub '/', '.'
         end
       end
     end

data/lib/kangaroo/util/proxy.rb

@@ -18,6 +18,15 @@ module Kangaroo
 
       def call! name, *args
         super name, *__curry__(*args)
+      rescue Rapuncel::Response::Fault => f
+        case f.message
+        when /^Method not found\: (.+)/
+          raise NoMethodError, $1, caller + ["OpenERP Server Traceback:"] + f.backtrace.reverse
+        else
+          message = "OpenERP Server Exception " + f.message.to_s
+          
+          raise Rapuncel::Response::Fault, message, f.backtrace.reverse[0..-2]
+        end
       end
 
       def self.new *args

data/lib/kangaroo/util/proxy/common.rb

@@ -1,6 +1,29 @@
 module Kangaroo
   module Util
+    
+    # Proxy to the Common service (at /xmlrpc/common). This service provides
+    # numerous auxiliary functions to get information about the running OpenERP
+    # instance, and e.g. set the current log level, or login.
+    # You can access this Proxy via your client instance:
+    # @example
+    #    
+    #     config = Kangaroo::Util::Configuration.new 'spec/test_env/test.yml'
+    #     client = config.client
+    #     client.common
+    # 
+    # @note that some of these functions need the superadmin password as first argument. 
     class Proxy::Common < Proxy
+      LogLevel = {
+        :error            => 40,
+        :warning          => 30,
+        :info             => 20,
+        :test             => 15,
+        :debug            => 10,
+        :debug_rpc        => 8,
+        :debug_rpc_answer => 6,
+        :debug_sql        => 5
+      }.freeze
+      
       # Login to an OpenERP database
       #
       # @param [String] db_name The database to log in
@@ -45,10 +68,11 @@ module Kangaroo
       # Set log level
       #
       # @param super_password Superadmin password
-      # @param loglevel Loglevel to set
+      # @param loglevel Loglevel to set, either as integer or as Symbol/String
       # @return true
       def set_loglevel super_password, loglevel
-        call! :set_loglevel, loglevel.upcase
+        loglevel = LogLevel[loglevel.to_sym] unless loglevel.is_a?(Numeric)
+        call! :set_loglevel, super_password, loglevel
       end
 
       # Get server stats
@@ -83,8 +107,8 @@ module Kangaroo
       # Get SQL count, needs loglevel DEBUG_SQL
       #
       # @return Count of SQL queries
-      def get_sqlcount
-        call! :get_sqlcount
+      def get_sqlcount super_password
+        call! :get_sqlcount, super_password
       end
 
       # Get list of available updates, needs valid Publisher's Warranty

data/lib/kangaroo/util/proxy/db.rb

@@ -1,6 +1,20 @@
 module Kangaroo
   module Util
+    
+    # Proxy to the Db service (at /xmlrpc/db), specifically
+    # to those functions, that don't need the superadmin password.
+    # You can access this Proxy via your client instance:
+    # @example
+    #
+    #     config = Kangaroo::Util::Configuration.new 'spec/test_env/test.yml'
+    #     client = config.client
+    #     db_proxy = client.db
+    #     db_proxy.list
+    #
+    # For functions that need superadmin authentication (like create, drop etc)
+    # @see Kangaroo::Util::Proxy::Superadmin
     class Proxy::Db < Proxy
+      
       # Check if a database exists
       #
       # @param db_name Name of database to check