kangaroo 0.0.3 → 0.1.0.alpha1

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

@@ -1,5 +1,20 @@
 module Kangaroo
   module Util
+    # Proxy to the object service (at /xmlrpc/object), which provides everything
+    # to read, create and modify OpenERP objects.
+    #
+    # @example Configure Kangaroo and get the database instance
+    #     config = Kangaroo::Util::Configuration.new 'spec/test_env/test.yml'
+    #     client = config.client
+    #     database = client.database
+    #
+    # @example
+    #     database.object('product.product').fields_get ['name', 'description']
+    #
+    # @note OpenERPs object service actually only exposes the method 'execute', which needs the 
+    #     ORM method to call (e.g. fields_get) as first argument, and then the model to operate on.
+    #     Proxy::Object already takes care of that, so that you can call ORM methods directly. (see example)
+    #     
     class Proxy::Object < Proxy
       # Call function via execute on OpenERPs object service.
       #
@@ -115,7 +130,7 @@ module Kangaroo
       # @param [Hash] context
       # @return [Array] Array of Hashes with field names and values
       def read ids, fields = [], context = nil
-        call! :read, ids, fields
+        call! :read, ids, fields, context
       end
 
       # Update records
@@ -147,6 +162,30 @@ module Kangaroo
       def read_group domain, fields, groupby, offset = 0, limit = nil, order = nil
         call! :read_group, domain, fields, groupby, offset, limit, order
       end
+      
+      # Export a set of records
+      #
+      # @param [Array] ids list of ids of records to export
+      # @param [Array] fields list of fields of the selected records to export
+      # @param [Hash] context
+      def export_data ids, fields, context = nil
+        call! :export_data, ids, fields, context
+      end
+      
+      # Import a set of records with a single request
+      #
+      # @param [Array] fields fields to import
+      # @param [Array<Hash>] data an Array of Hashes which represent the records to import
+      # @param [Hash] options for options see OpenERPs Technical Memento
+      def import_data fields, data, options = {}
+        options = {
+          :mode => 'init',
+          :current_module => '',
+          :noupdate => false
+        }.merge options.symbolize_keys
+        
+        call! :import_data, fields, data, *options.values_at(:mode, :current_module, :noupdate, :context, :filename)
+      end
     end
   end
 end

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

@@ -1,5 +1,18 @@
 module Kangaroo
   module Util
+    
+    # Proxy to the Db service (at /xmlrpc/db), specifically
+    # to those functions, that 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
+    #     superadmin_proxy = client.superadmin 'admin'
+    #     superadmin_proxy.drop 'test_database'
+    #
+    # For functions that need superadmin authentication (like create, drop etc)
+    # @see Kangaroo::Util::Proxy::Superadmin
     class Proxy::Superadmin < Proxy
       # Create a new database
       #

data/lib/kangaroo/version.rb

@@ -1,3 +1,3 @@
 module Kangaroo
-  VERSION = "0.0.3"
+  VERSION = "0.1.0.alpha1"
 end

data/lib/kangaroo/viz.rb

@@ -0,0 +1 @@
+require 'kangaroo/viz/base'

data/lib/kangaroo/viz/base.rb

@@ -0,0 +1,92 @@
+require 'graphviz'
+require 'ruby-debug'
+
+module Kangaroo
+  module Viz
+    class Base
+      attr_accessor :namespace, :models, :file, :type
+      
+      def initialize namespace
+        @namespace = namespace
+        @models = models_in namespace
+      end
+      
+      def generate
+        @graph = GraphViz.new :G
+        
+        @models.each do |model|
+          @graph.add_node model.name, node_opts_for(model)
+        end
+        
+        @namespace.dont_load_models = true
+        @models.each do |model|
+          model.fields.each do |field|
+            next unless field.association?
+         
+            @graph.add_edge model.name, field.relation_class.name, edge_opts_for(field) if field.relation_class
+          end
+        end
+        
+        @graph.output type.to_sym => file
+      end
+      
+      def models_in namespace
+        models = []
+        
+        namespace.constants.each do |const_name|
+          const = namespace.const_get const_name
+          models << const if is_a_model?(const)
+          models += models_in(const) if is_a_namespace?(const) || is_a_model?(const)
+        end
+        
+        models
+      end
+      
+      protected
+      def node_opts_for model
+        {
+          :label => "#{model.name}\n#{model.oo_name}"
+        }
+      end
+      
+      def edge_opts_for field
+        color = color_for_association(field)
+        
+        {
+          :label => label_for_association(field),
+          :color => color,
+          :fontcolor => color,
+          :fontsize => 10
+        }
+      end
+      
+      def label_for_association field
+        type = case field.type
+        when 'one2many'   then '1..N'
+        when 'many2one'   then 'N..1'
+        when 'one2one'    then '1..1'
+        when 'many2many'  then 'N..N'
+        end
+        
+        "#{type}\n#{field.name}"
+      end
+      
+      def color_for_association field
+        case field.type
+        when 'one2many'   then 'green'
+        when 'many2one'   then 'blue'
+        when 'one2one'    then 'red'
+        when 'many2many'  then 'orange'
+        end
+      end
+      
+      def is_a_model? const
+        const.is_a?(Class) && const.superclass == Kangaroo::Model::Base
+      end
+      
+      def is_a_namespace? const
+        const.is_a?(Module) && const.respond_to?(:namespace)
+      end
+    end
+  end
+end

data/spec/commands/base_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'kangaroo/commands/base'
+
+describe Kangaroo::Commands::Base do
+  
+  describe 'configuration, called with' do
+    let(:argv) { [] }
+    subject { described_class.new(*argv).configuration }
+  
+    context 'with --config file' do
+      let(:argv) { %w(--config spec/test_env/test.yml) }
+      
+      its(['host']) { should == "127.0.0.1" }
+      its(['database']) { should include('user' => 'admin')}
+      its(['database']) { should include('password' => 'admin')}
+      its(['database']) { should include('name' => 'kangaroo_test_database')}
+      
+      context 'and --host localhost' do
+        let(:argv) { %w(--config spec/test_env/test.yml --host localhost) }
+        its(['host']) { should == 'localhost'}
+      end
+    end
+    
+    context 'short arguments' do
+      let(:argv) { %w(-u admin -p admin -d kangaroo_test_database) }
+      its(['port']) { should == 8069 }
+      its(['host']) { should == "localhost" }
+      its(['database']) { should include('user' => 'admin')}
+      its(['database']) { should include('password' => 'admin')}
+      its(['database']) { should include('name' => 'kangaroo_test_database')}
+    end
+    
+    context 'with --user, --password and --database' do
+      let(:argv) { %w(--user admin --password admin --database kangaroo_test_database) }
+      its(['port']) { should == 8069 }
+      its(['host']) { should == "localhost" }
+      its(['database']) { should include('user' => 'admin')}
+      its(['database']) { should include('password' => 'admin')}
+      its(['database']) { should include('name' => 'kangaroo_test_database')}
+    end
+  end
+end

data/spec/functional/associations/many2one_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+module Kangaroo
+  describe Model::Associations, 'Many2one' do
+    before :all do
+      config = Kangaroo::Util::Configuration.new 'spec/test_env/test.yml'
+      config.login
+  
+      Kangaroo::Util::Loader.new(%w(res.partner res.partner.address), config.database, 'AssociationsSpec').load!
+    end
+    
+    after :each do
+      @cleanup && @cleanup.call
+    end
+    
+    it 'reads id and name of associated object' do
+      address = AssociationsSpec::Res::Partner::Address.find 1
+      partner = AssociationsSpec::Res::Partner.find 1
+      
+      address.partner_id_id.should == 1
+      address.partner_id_name.should == partner.name
+    end
+    
+    it 'reads id and name of association object after a change' do
+      address = AssociationsSpec::Res::Partner::Address.find 1
+      address.partner_id_id = 2
+      partner = AssociationsSpec::Res::Partner.find 2
+      
+      address.partner_id_id.should == 2
+      address.partner_id_name.should == partner.name
+    end
+    
+    it 'writes id of object to associate' do
+      @cleanup = lambda do
+        address = AssociationsSpec::Res::Partner::Address.find 1
+        address.partner_id = 1
+        address.save!
+      end
+      
+      address = AssociationsSpec::Res::Partner::Address.find 1
+      address.partner_id_id = 2
+      address.save!
+      
+      address = AssociationsSpec::Res::Partner::Address.find 1
+      address.partner_id_id.should == 2
+    end
+    
+    it 'reads associated object' do
+      address = AssociationsSpec::Res::Partner::Address.find 1
+      partner = AssociationsSpec::Res::Partner.find 1
+      
+      address.partner_id_id.should == 1
+      address.partner_id_obj.should == partner
+    end
+    
+    it 'writes association' do
+      @cleanup = lambda do
+        address = AssociationsSpec::Res::Partner::Address.find 1
+        address.partner_id = 1
+        address.save!
+      end
+      
+      address = AssociationsSpec::Res::Partner::Address.find 1
+      partner = AssociationsSpec::Res::Partner.find 2
+      address.partner_id_obj = partner
+      address.save!
+      
+      address = AssociationsSpec::Res::Partner::Address.find 1
+      address.partner_id_id.should == 2
+    end
+  end
+end

data/spec/functional/associations/one2many_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+module Kangaroo
+  describe Model::Associations, 'One2many' do
+    before :all do
+      config = Kangaroo::Util::Configuration.new 'spec/test_env/test.yml'
+      config.login
+  
+      Kangaroo::Util::Loader.new(%w(res.partner res.partner.address), config.database, 'AssociationsSpec').load!
+    end
+    
+    after :each do
+      @cleanup && @cleanup.call
+    end
+    
+    it 'reads ids of associated objects' do
+      partner = AssociationsSpec::Res::Partner.find 1
+      
+      partner.address_ids.should == [1]
+    end
+    
+    it 'reads ids of associate objects after change' do
+      partner = AssociationsSpec::Res::Partner.find 1
+      
+      partner.address_ids = [2]
+      partner.address_ids.should == [2]
+    end
+    
+    it 'writes ids of objects to associate' do
+      @cleanup = lambda do
+        partner = AssociationsSpec::Res::Partner.find 1
+        partner.address = [[6, 0, [1]]]
+        partner.save!
+      end
+      
+      partner = AssociationsSpec::Res::Partner.find 1
+      partner.address_ids = [2]
+      partner.save!
+      
+      partner = AssociationsSpec::Res::Partner.find 1
+      partner.address.should == [2]
+    end
+    
+    it 'reads associated objects' do
+      partner = AssociationsSpec::Res::Partner.find 1
+      address = AssociationsSpec::Res::Partner::Address.find 1
+      
+      partner.address_objs.should be_an Array
+      partner.address_objs.to_a.should == [address]
+    end
+    
+    it 'writes association' do
+      @cleanup = lambda do
+        address = AssociationsSpec::Res::Partner::Address.find 1
+        address.partner_id = 1
+        address.save!
+      end
+      
+      address = AssociationsSpec::Res::Partner::Address.find 1
+      partner = AssociationsSpec::Res::Partner.find 2
+
+      partner.address_objs = [address]
+    end
+  end
+end

data/spec/functional/common_service_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module Kangaroo
+  describe 'Common service' do
+    before :all do
+      @config = Kangaroo::Util::Configuration.new 'spec/test_env/test.yml'
+      @config.login
+  
+      Kangaroo::Util::Loader.new('res.partner', @config.database, 'CommonServiceSpec').load!
+    end
+    
+    it "can change log levels" do
+      @config.client.common.set_loglevel('admin', :debug).should == true
+      @config.client.common.set_loglevel 'admin', :error
+    end
+    
+    it "can read number of sql queries executed" do
+      @config.client.common.set_loglevel 'admin', :debug_sql
+      
+      CommonServiceSpec::Res::Partner.first
+      @config.client.common.get_sqlcount('admin').should > 0
+      @config.client.common.set_loglevel 'admin', :error
+    end
+  end
+end

data/spec/functional/data_import_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+module Kangaroo
+  describe Model::DataImport do
+    before :all do
+      config = Kangaroo::Util::Configuration.new 'spec/test_env/test.yml'
+      config.login
+  
+      Kangaroo::Util::Loader.new('res.country', config.database, 'DataImportSpec').load!
+    end
+    
+    after :each do
+      @cleanup && @cleanup.call
+    end
+    
+    it 'updates records' do
+      a = DataImportSpec::Res::Country.find 1
+      
+      old_name = a.name
+      @cleanup = lambda do
+        a = DataImportSpec::Res::Country.find 1
+        a.name = old_name
+        a.save!
+      end
+      a.name = 'abcdefg'
+      
+      old_count = DataImportSpec::Res::Country.count
+      DataImportSpec::Res::Country.import_all [a]
+      DataImportSpec::Res::Country.count.should == old_count
+      
+      DataImportSpec::Res::Country.find(1).name.should == 'abcdefg'
+    end
+    
+    it 'creates new records' do
+      a = DataImportSpec::Res::Country.new :code => 'XY', :name => 'a_new_country'
+      
+      @cleanup = lambda do
+        DataImportSpec::Res::Country.where(:code => 'XY').first.destroy
+      end
+      
+      old_count = DataImportSpec::Res::Country.count
+      puts DataImportSpec::Res::Country.import_all([a]).inspect
+      DataImportSpec::Res::Country.count.should == old_count + 1
+      
+      DataImportSpec::Res::Country.where(:code => 'XY').first.name.should == 'a_new_country'
+    end
+  end
+end

data/spec/functional/dynamic_finder_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+module Kangaroo
+  describe Model::DynamicFinder do
+    before :all do
+      config = Kangaroo::Util::Configuration.new 'spec/test_env/test.yml'
+      config.login
+  
+      Kangaroo::Util::Loader.new('res.country', config.database, 'DynamicFinderSpec').load!
+    end
+    
+    after :each do
+      @cleanup && @cleanup.call
+    end
+    
+    it 'catches find_by_* calls' do
+      DynamicFinderSpec::Res::Country.should respond_to :find_by_code
+      DynamicFinderSpec::Res::Country.find_by_code('DE').code.should == 'DE'
+    end
+    
+    it 'captches find_by_*_and_* calls' do
+      DynamicFinderSpec::Res::Country.should respond_to :find_by_code_and_name
+      DynamicFinderSpec::Res::Country.find_by_code_and_name('DE', 'Germany').name.should == 'Germany'
+    end
+    
+    it 'Dynamic Finder can be used on relations' do
+      DynamicFinderSpec::Res::Country.select(:code).find_by_code('DE').code.should == 'DE'
+    end
+    
+    it 'catches find_all_by_* calls' do
+      DynamicFinderSpec::Res::Country.find_all_by_code('DE').should be_an Array
+      DynamicFinderSpec::Res::Country.find_all_by_code('DE').first.code.should == 'DE'
+    end
+  end
+end