kangaroo 0.0.1.pre

data/features/connection.feature

@@ -0,0 +1,5 @@
+Feature: Connection
+  Scenario: Connect to an OpenERP server
+    Given i have a configuration file
+    When i setup a configuration
+    Then i should be able to login

data/features/env.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec/expectations'
+require 'cucumber/rspec/doubles'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w(.. .. lib)))
+require 'kangaroo'

data/features/step_definitions/basic_steps.rb

@@ -0,0 +1,24 @@
+Given /^i'm connected to an OpenERP server$/ do
+  logger = Logger.new(File.open("/dev/null", 'w'))
+  @config = Kangaroo::Util::Configuration.new 'features/support/test.yml', logger
+  @config.login
+end
+
+Given /^setup a proxy to "([^"]*)"$/ do |service|  
+  proxy = Kangaroo::Util::Proxy.const_get(service.camelize).new @config.client.send("#{service}_service")
+  self.instance_variable_set "@#{service}", proxy
+end
+
+When /^i call (.*)\.(.*)$/ do |service, method|
+  proxy = instance_variable_get "@#{service}"
+  @result = proxy.__send__ method
+  puts @result.inspect
+end
+
+Then /^i should see "([^"]*)"$/ do |arg1|
+  @result.should include(arg1)
+end
+
+Then /^the list should include "([^"]*)"$/ do |arg1|
+  @result.flatten.join("\n").should include(arg1)
+end

data/features/step_definitions/connection_steps.rb

@@ -0,0 +1,13 @@
+Given /^i have a configuration file$/ do
+  @config_hash = YAML.load "features/support/test.yml"
+end
+
+When /^i setup a configuration$/ do
+  @logger = Logger.new(STDERR)
+  @config = Kangaroo::Util::Configuration.new @config_hash, @logger
+end
+
+Then /^i should be able to login$/ do
+  @logger.should_not_receive :warn
+  @config.login
+end

data/features/support/test.yml

@@ -0,0 +1,11 @@
+host: 127.0.0.1
+port: 8069
+
+database:
+  name: kangaroo_test_database
+  user: admin
+  password: admin
+  
+  models:
+    - res.*
+    - product.product

data/features/utility_services.feature

@@ -0,0 +1,39 @@
+Feature: Utility Services
+  Scenario: Get server information
+    Given i'm connected to an OpenERP server
+    And setup a proxy to "common"
+    When i call common.about
+    Then i should see "OpenERP"
+    
+  Scenario: Get server environment
+    Given i'm connected to an OpenERP server
+    And setup a proxy to "common"
+    When i call common.get_server_environment
+    Then i should see "OpenERP-Server Version : 6"
+    And i should see "Python Version : 2.6"
+    
+  Scenario: Get server stats
+    Given i'm connected to an OpenERP server
+    And setup a proxy to "common"
+    When i call common.get_stats
+    Then i should see "HTTPd: running"
+    
+  Scenario: List available HTTP services
+    Given i'm connected to an OpenERP server
+    And setup a proxy to "common"
+    When i call common.list_http_services
+    Then the list should include "service.http_server.XMLRPCRequestHandler"
+    
+  Scenario: List available databases
+    Given i'm connected to an OpenERP server
+    And setup a proxy to "db"
+    When i call db.list
+    Then the list should include "kangaroo_test_database"
+    
+  Scenario: List available languages
+    Given i'm connected to an OpenERP server
+    And setup a proxy to "db"
+    When i call db.list_lang
+    Then the list should include "English"
+    
+  

data/kangaroo.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "kangaroo/version"
+
+Gem::Specification.new do |s|
+  s.name        = "kangaroo"
+  s.version     = Kangaroo::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.date        = Time.now.strftime("%Y-%m-%d")
+  s.authors     = ["Michael Eickenberg", "Marian Theisen"]
+  s.email       = 'marian@cice-online.net'
+  s.summary     = "Kang! ActiveRecord-ish OpenObject"
+  s.homepage    = "http://github.com/cice/kangARoo"
+  s.description = "ActiveRecord-ish OpenObject Wrapper"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'rapuncel', '~> 0.0.2'
+  s.add_dependency "activerecord", ">= 3.0.0"
+  s.add_dependency "activesupport", ">= 3.0.0"
+  
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'ruby-debug'
+  s.add_development_dependency 'cucumber'
+end

data/lib/kangaroo.rb

@@ -0,0 +1,6 @@
+require 'kangaroo/railtie' if defined?(Rails)
+require 'kangaroo/util/configuration'
+require 'kangaroo/model/base'
+
+module Kangaroo
+end

data/lib/kangaroo/exception.rb

@@ -0,0 +1,7 @@
+module Kangaroo
+  class Exception < ::Exception ; end
+  class RecordNotFound < Exception ; end
+  class RecordSavingFailed < Exception ; end
+  class InstantiatedRecordNeedsIDError < Exception ; end
+  class ChildDefinedBeforeParentError < Exception ; end
+end

data/lib/kangaroo/model/attributes.rb

@@ -0,0 +1,124 @@
+require 'active_model/dirty'
+
+module Kangaroo
+  module Attributes
+    # @private
+    def self.included base
+      base.send :include, ActiveModel::Dirty
+      base.extend ClassMethods
+    end
+
+    # Read an attribute value by name
+    #
+    # @param [String, Symbol] name attribute name
+    # @return attribute value
+    def read_attribute name
+      @attributes[name.to_s]
+    end
+
+    # Write an attribute by name
+    #
+    # @param [String, Symbol] name attribute name
+    # @param value attribute value to set
+    # @return attribute value
+    def write_attribute name, value
+      attribute_will_change! name.to_s
+      @attributes[name.to_s] = value
+    end
+
+    # Mass set attributes. Attribute values are set via setters, not directly stored
+    # in the @attributes Hash.
+    #
+    # @param [Hash] attributes Hash of attribute names and values
+    # @return [Hash] attributes
+    def attributes= attributes
+      attributes.except('id', :id).map do |key_value|
+        __send__ "#{key_value.first}=", key_value.last
+      end
+
+      self.attributes
+    end
+
+    # Read all attributes. Attributes are read via getters.
+    #
+    # @return [Hash] attributes
+    def attributes
+      {}.tap do |attributes|
+        self.class.attribute_names.each do |key|
+          attributes[key] = send(key)
+        end
+      end
+    end
+
+    # Freeze this object
+    def freeze
+      @changed_attributes.freeze
+      @attributes.freeze
+      super
+    end
+
+    module ClassMethods
+      # If you need to customize your models, e.g. add attributes
+      # not covered by fields_get, you can call {extend_attribute_methods}
+      #
+      # @param [Array] attributes list of attribute names to define accessors for
+      def extend_attribute_methods *attributes
+        attributes.flatten.each do |attr|
+          next if attribute_names.include?(attr.to_s)
+          define_accessors attr
+        end
+      end
+
+      # Define getters for attributes
+      #
+      # @param [Array] attribute_names
+      def define_getters *attribute_names
+        attribute_names.flatten.each do |name|
+          define_getter name
+        end
+      end
+
+      # Define getter
+      #
+      # @param [String, Symbol] attribute_name
+      def define_getter attribute_name
+        define_method attribute_name do
+          read_attribute attribute_name
+        end
+      end
+
+      # Get a list of available attributes
+      #
+      # @return [Array] attribute names
+      def attribute_names
+        @attribute_names ||= []
+      end
+
+      # Define getter and setter for an attribute
+      #
+      # @param [String, Symbol] attribute_name
+      def define_accessors attribute_name
+        define_method attribute_name do
+          read_attribute attribute_name
+        end
+
+        define_method "#{attribute_name}=" do |value|
+          write_attribute attribute_name, value
+        end
+
+        attribute_names << attribute_name.to_s
+      end
+
+      # Define getters and setters for attributes
+      #
+      # @param [Array] attribute_names
+      def define_multiple_accessors *attribute_names
+        define_attribute_methods attribute_names.map(&:to_s)
+
+        attribute_names.each do |attribute_name|
+          define_accessors attribute_name
+        end
+      end
+    end
+  end
+end

data/lib/kangaroo/model/base.rb

@@ -0,0 +1,70 @@
+require 'kangaroo/model/relation'
+require 'kangaroo/model/attributes'
+require 'kangaroo/model/default_attributes'
+require 'kangaroo/model/inspector'
+require 'kangaroo/model/persistence'
+require 'kangaroo/model/open_object_orm'
+require 'kangaroo/model/finder'
+require 'kangaroo/model/remote_execute'
+require 'active_model/callbacks'
+require 'active_support/core_ext/class'
+
+module Kangaroo
+  module Model
+    class Base
+      class_attribute :database
+      class_inheritable_array :field_names
+
+      extend ActiveModel::Callbacks
+      define_model_callbacks :initialize
+
+      include Attributes
+      include Persistence
+      include DefaultAttributes
+      include Inspector
+      extend OpenObjectOrm
+      extend Finder
+      include RemoteExecute
+
+      attr_reader :id
+
+      # Initialize a new object, and set attributes
+      #
+      # @param [Hash] attributes
+      def initialize attributes = {}
+        @attributes = {}
+
+        _run_initialize_callbacks do
+          self.attributes = attributes
+        end
+      end
+
+      # Send method calls via xmlrpc to OpenERP
+      #
+      def remote
+        self.class.remote
+      end
+
+      class << self
+        def fields
+          @fields ||= fields_get
+        end
+        
+        def namespace
+          ("::" + name.match(/^(?:\:\:)?([^\:]+)/)[1]).constantize
+        end
+        
+        # Return this models OpenObject name
+        def oo_name
+          namespace.ruby_to_oo self.name
+        end
+
+        # Send method calls via xmlrpc to OpenERP
+        #
+        def remote
+          @remote ||= database.object oo_name
+        end
+      end
+    end
+  end
+end

data/lib/kangaroo/model/condition_normalizer.rb

@@ -0,0 +1,63 @@
+module Kangaroo
+  module Model
+    module ConditionNormalizer
+      CONDITION_OPERATORS = *%w(= != > >= < <= ilike like in child_of parent_left parent_right).freeze
+      CONDITION_PATTERN = /\A(.*)\s+(#{CONDITION_OPERATORS * "|"})\s+(.*)\Z/i.freeze
+
+      protected
+      def normalize_conditions conditions
+        conditions = if Hash === conditions
+          return [] if conditions.blank?
+          [conditions]
+        else
+          Array(conditions)
+        end
+
+        conditions.map do |condition|
+          normalize_condition condition
+        end
+      end
+
+      def normalize_condition condition
+        case condition
+        when Array
+          condition
+        when Hash
+          convert_hash_condition condition
+        when String
+          convert_string_condition condition
+        else
+          raise "Expected Array, Hash or String"
+        end
+      end
+
+      def convert_hash_condition condition
+        condition.sum([]) do |key_val|
+          convert_key_value_condition *key_val
+        end
+      end
+
+      def convert_key_value_condition field, value
+        operator = if Array === value
+          value = value.map &:to_s
+          'in'
+        else
+          value = value.to_s
+          '='
+        end
+
+        [field.to_s, operator, value]
+      end
+
+      def convert_string_condition string
+        # Ugly workaround, if you know how to make 'not in' work along the other operators
+        # with a single RegExp, please let me now
+        if (key_val = string.split("not in")).length > 1
+          [key_val.first.strip, 'not in', key_val.last.strip]
+        else
+          CONDITION_PATTERN.match(string).try(:captures) || string
+        end
+      end
+    end
+  end
+end

data/lib/kangaroo/model/default_attributes.rb

@@ -0,0 +1,22 @@
+module Kangaroo
+  module DefaultAttributes
+    # @private
+    def self.included klass
+      klass.extend ClassMethods
+
+      klass.before_initialize do
+        return true if persisted?
+
+        self.class.default_attributes.each do |name, value|
+          write_attribute name, value
+        end
+      end
+    end
+
+    module ClassMethods
+      def default_attributes
+        default_get :fields => attribute_names
+      end
+    end
+  end
+end

data/lib/kangaroo/model/field.rb

@@ -0,0 +1,20 @@
+require 'kangaroo/model/attributes'
+
+module Kangaroo
+  module Model
+    class Field
+      include Attributes
+
+      attr_accessor :name
+
+      def initialize name, attributes = {}
+        @attributes = {}
+        @name = name
+
+        attributes.each do |key, val|
+          write_attribute key, val
+        end
+      end
+    end
+  end
+end