sugarcrm 0.9.11 → 0.9.12

data/lib/sugarcrm/connection_pool.rb

@@ -0,0 +1,162 @@
+require 'monitor'
+
+module SugarCRM; class ConnectionPool
+  attr_reader :size, :timeout
+  def initialize(session)
+    @session = session
+    
+    # The cache of reserved connections mapped to threads
+    @reserved_connections = {}
+    
+    # The mutex used to synchronize pool access
+    @connection_mutex = Monitor.new
+    @queue = @connection_mutex.new_cond
+    @timeout = config_timeout || 5
+    
+    # default max pool size to 5
+    @size = config_pool_size || default_pool_size
+    
+    @connections = []
+    @checked_out = []
+  end
+  
+  # If a connection already exists yield it to the block. If no connection
+  # exists checkout a connection, yield it to the block, and checkin the
+  # connection when finished.
+  def with_connection
+    connection_id = current_connection_id
+    fresh_connection = true unless @reserved_connections[connection_id]
+    yield connection
+  ensure
+    release_connection(connection_id) if fresh_connection
+  end
+  
+  # Retrieve the connection associated with the current thread, or call
+  # #checkout to obtain one if necessary.
+  #
+  # #connection can be called any number of times; the connection is
+  # held in a hash keyed by the thread id.
+  def connection
+    @reserved_connections[current_connection_id] ||= checkout
+  end
+  
+  # Check-out a sugarcrm connection from the pool, indicating that you want
+  # to use it. You should call #checkin when you no longer need this.
+  #
+  # This is done by either returning an existing connection, or by creating
+  # a new connection. If the maximum number of connections for this pool has
+  # already been reached, but the pool is empty (i.e. they're all being used),
+  # then this method will wait until a thread has checked in a connection.
+  # The wait time is bounded however: if no connection can be checked out
+  # within the timeout specified for this pool, then a ConnectionTimeoutError
+  # exception will be raised.
+  def checkout
+    # Checkout an available connection
+    @connection_mutex.synchronize do
+      loop do
+        conn = if @checked_out.size < @connections.size
+                  checkout_existing_connection
+                elsif @connections.size < @size
+                  checkout_new_connection
+                end
+        return conn if conn
+
+        @queue.wait(@timeout)
+
+        if(@checked_out.size < @connections.size)
+          next
+        else
+          clear_stale_cached_connections!
+          if @size == @checked_out.size
+            raise SugarCRM::ConnectionTimeoutError, "could not obtain a sugarcrm connection#{" within #{@timeout} seconds" if @timeout}. The max pool size is currently #{@size}; consider increasing it."
+          end
+        end
+
+      end
+    end
+  end
+  
+  # Check-in a sugarcrm connection back into the pool, indicating that you
+  # no longer need this connection.
+  def checkin(conn)
+    @connection_mutex.synchronize do
+      @checked_out.delete conn
+      @queue.signal
+    end
+  end
+  
+  # Disconnects all connections in the pool, and clears the pool.
+  def disconnect!
+    @reserved_connections.each_value do |conn|
+      checkin conn
+    end
+    @reserved_connections = {}
+    @connections.each do |conn|
+      conn.logout
+    end
+    @connections = []
+  end
+  
+  # Return any checked-out connections back to the pool by threads that
+  # are no longer alive.
+  def clear_stale_cached_connections!
+    keys = @reserved_connections.keys - Thread.list.find_all { |t|
+      t.alive?
+    }.map { |thread| thread.object_id }
+    keys.each do |key|
+      checkin @reserved_connections[key]
+      @reserved_connections.delete(key)
+    end
+  end
+  
+  private
+  def new_connection
+    c = Connection.new(@session.config[:base_url], @session.config[:username], @session.config[:password], @session.config[:options])
+    c.session = @session
+    c
+  end
+  
+  def checkout_new_connection
+    c = new_connection
+    @connections << c
+    checkout_connection(c)
+  end
+
+  def checkout_existing_connection
+    c = (@connections - @checked_out).first
+    checkout_connection(c)
+  end
+  
+  def checkout_connection(c)
+    @checked_out << c
+    c
+  end
+  
+  def current_connection_id #:nodoc:
+    Thread.current.object_id
+  end
+  
+  # Returns the connection pool timeout, if present
+  def config_timeout
+    begin
+      @session.config[:options][:connection_pool][:wait_timeout] && @session.config[:options][:connection_pool][:wait_timeout].to_i
+    rescue
+      false
+    end
+  end
+  
+  # Returns the connection pool size, if present
+  def config_pool_size
+    begin
+      @session.config[:options][:connection_pool][:size] && @session.config[:options][:connection_pool][:size].to_i
+    rescue
+      false
+    end
+  end
+  
+  # The default for the connection pool's maximum size depends on environment:
+  # default pool size will be 1 unless used within Rails
+  def default_pool_size
+    defined?(Rails) ? 5 : 1
+  end
+end; end

data/lib/sugarcrm/exceptions.rb

@@ -3,6 +3,7 @@ module SugarCRM
   class MultipleSessions < RuntimeError; end
   class LoginError < RuntimeError; end
   class MissingCredentials < RuntimeError; end
+  class ConnectionTimeoutError < RuntimeError; end
   class EmptyResponse < RuntimeError; end
   class UnhandledResponse < RuntimeError; end
   class InvalidSugarCRMUrl < RuntimeError; end

data/lib/sugarcrm/module_methods.rb

@@ -15,7 +15,7 @@ module SugarCRM
   end
   
   # store the various connected sessions
-  # key = session.id, value = session instance
+  # key = session.object_id, value = session instance
   @@sessions = {}
   def self.sessions
     @@sessions
@@ -23,11 +23,11 @@ module SugarCRM
   
   def self.add_session(session)
     @@used_namespaces << session.namespace unless @@used_namespaces.include? session.namespace
-    @@sessions[session.id] = session
+    @@sessions[session.object_id] = session
   end
   
   def self.remove_session(session)
-    @@sessions.delete(session.id)
+    @@sessions.delete(session.object_id)
   end
   
   def self.session

data/lib/sugarcrm/session.rb

@@ -1,7 +1,7 @@
 # This class hold an individual connection to a SugarCRM server.
 # There can be several such simultaneous connections
 module SugarCRM; class Session
-  attr_reader :config, :connection, :extensions_path, :id, :namespace, :namespace_const
+  attr_reader :config, :connection_pool, :extensions_path, :namespace, :namespace_const
   attr_accessor :modules
   def initialize(url, user, pass, opts={})
     options = { 
@@ -19,51 +19,69 @@ module SugarCRM; class Session
     connect_and_add_session
   end
   
-  # create a new session from the credentials present in a file
-  def self.new_from_file(path, opts={})
-    config = load_and_parse_config(path)
+  # Creates a new session from the credentials present in a file
+  def self.from_file(path, opts={})
+    config_values = self.parse_config_file(path)
+    self.from_hash(config_values[:config], opts)
+  end
+  
+  # Creates a new session from the credentials in the hash
+  def self.from_hash(hash, opts={})
+    pool_options = parse_connection_pool_options(hash)
+    options = opts
+    (options = {:connection_pool => pool_options}.merge(opts)) if pool_options.size > 0
+    
     begin
-      session = self.new(config[:base_url], config[:username], config[:password], opts)
+      session = self.new(hash[:base_url], hash[:username], hash[:password], options)
     rescue MissingCredentials => e
       return false
     end
     session.namespace_const
   end
   
+  # Returns a hash with the content in the YAML argument file
+  def self.parse_config_file(path)
+    self.validate_path path
+    contents = YAML.load_file(path)
+    return {} unless contents
+    self.symbolize_keys(contents)
+  end
+  
   def setup_connection
     load_config_files unless connection_info_loaded?
     raise MissingCredentials, "Missing login credentials. Make sure you provide the SugarCRM URL, username, and password" unless connection_info_loaded?
   end
   
-  # re-use this session and namespace if the user wants to connect with different credentials
   def connect(url=nil, user=nil, pass=nil, opts={})
     options = { 
-      :debug  => (@connection && @connection.debug?),
+      :debug  => @config[:options][:debug],
       :register_modules => true
     }.merge(opts)
     
+    # store the params used to connect
     {:base_url => url, :username => user, :password => pass}.each{|k,v|
       @config[k] = v  unless v.nil?
     }
     
     SugarCRM::Module.deregister_all(self)
-    SugarCRM.remove_session(self)
-    @connection = SugarCRM::Connection.new(@config[:base_url], @config[:username], @config[:password], options) if connection_info_loaded?
-    @connection.session = self
-    @id = @connection.session_id
-    SugarCRM.add_session(self) # must be removed and added back, as the session id (used as the hash key) changes
+    @connection_pool = SugarCRM::ConnectionPool.new(self)
     SugarCRM::Module.register_all(self)
     load_extensions
     true
   end
   alias :connect! :connect
-  alias :reconnect :connect
-  alias :reconnect! :connect
-  alias :reload! :connect
+  
+  # Re-uses this session and namespace if the user wants to connect with different credentials
+  def reconnect(url=nil, user=nil, pass=nil, opts={})
+    @connection_pool.disconnect!
+    connect(url, user, pass, opts)
+  end
+  alias :reconnect! :reconnect
+  alias :reload! :reconnect
   
   # log out from SugarCRM and cleanup (deregister modules, remove session, etc.)
   def disconnect
-    @connection.logout
+    @connection_pool.disconnect!
     SugarCRM::Module.deregister_all(self)
     namespace = @namespace
     SugarCRM.instance_eval{ remove_const namespace } # remove NamespaceX from SugarCRM
@@ -71,6 +89,11 @@ module SugarCRM; class Session
   end
   alias :disconnect! :disconnect
   
+  # Returns a connection from the connection pool, if available
+  def connection
+    @connection_pool.connection
+  end
+  
   def extensions_folder=(folder, dirstring=nil)
     path = File.expand_path(folder, dirstring)
     @extensions_path = path
@@ -79,7 +102,8 @@ module SugarCRM; class Session
   
   # load credentials from file, and (re)connect to SugarCRM
   def load_config(path)
-    @config = self.class.load_and_parse_config(path)
+    new_config = self.class.parse_config_file(path)
+    @config[:config] = new_config[:config] if new_config
     reconnect(@config[:base_url], @config[:username], @config[:password]) if connection_info_loaded?
     @config
   end
@@ -93,20 +117,21 @@ module SugarCRM; class Session
   
   # lazy load the SugarCRM version we're connecting to
   def sugar_version
-    @version ||= @connection.get_server_info["version"]
+    @version ||= connection.get_server_info["version"]
   end
   
   private
-  def self.load_and_parse_config(path)
-    validate_path path
-    hash = {}
-    config = YAML.load_file(path)
-    if config && config["config"]
-      config["config"].each{|k,v|
-        hash[k.to_sym] = v
-      }
-    end
-    hash
+  # Converts all hash keys to symbols (if a hash value is itself a hash, call the method recursively)
+  #   Session.symbolize_keys({"one" => 1, "two" => {"foo" => "bar"}}) # => {:one => 1, :two => {:foo => "bar"}}
+  def self.symbolize_keys(hash)
+    hash.inject({}){|memo,(k,v)|
+      unless v.class == Hash
+        memo[k.to_sym] = v
+      else
+        memo[k.to_sym] = self.symbolize_keys(v)
+      end
+      memo
+    }
   end
   
   def self.validate_path(path)
@@ -121,6 +146,7 @@ module SugarCRM; class Session
   end
   
   def connection_info_loaded?
+    return false unless @config
     @config[:base_url] && @config[:username] && @config[:password]
   end
   
@@ -176,4 +202,13 @@ module SugarCRM; class Session
     SugarCRM.add_session(self)
   end
   
+  # Returns hash containing only keys/values relating to connection pool options. These are removed from parameter hash.
+  def self.parse_connection_pool_options(config_values)
+    result = {}
+    pool_size = config_values.delete(:pool)
+    result[:size] = pool_size if pool_size
+    wait_timeout = config_values.delete(:wait_timeout)
+    result[:wait_timeout] = wait_timeout if wait_timeout
+    result
+  end
 end; end

data/sugarcrm.gemspec

@@ -0,0 +1,143 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sugarcrm}
+  s.version = "0.9.12"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Carl Hicks", "David Sulc"]
+  s.date = %q{2011-03-02}
+  s.default_executable = %q{sugarcrm}
+  s.email = %q{carl.hicks@gmail.com}
+  s.executables = ["sugarcrm"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    "./Gemfile",
+    "./LICENSE",
+    "./README.rdoc",
+    "./Rakefile",
+    "./VERSION",
+    "./lib/rails/generators/sugarcrm/config/config_generator.rb",
+    "./lib/rails/generators/sugarcrm/config/templates/initializer.rb",
+    "./lib/rails/generators/sugarcrm/config/templates/sugarcrm.yml",
+    "./lib/sugarcrm.rb",
+    "./lib/sugarcrm/associations.rb",
+    "./lib/sugarcrm/associations/association.rb",
+    "./lib/sugarcrm/associations/association_cache.rb",
+    "./lib/sugarcrm/associations/association_collection.rb",
+    "./lib/sugarcrm/associations/association_methods.rb",
+    "./lib/sugarcrm/associations/associations.rb",
+    "./lib/sugarcrm/attributes.rb",
+    "./lib/sugarcrm/attributes/attribute_methods.rb",
+    "./lib/sugarcrm/attributes/attribute_serializers.rb",
+    "./lib/sugarcrm/attributes/attribute_typecast.rb",
+    "./lib/sugarcrm/attributes/attribute_validations.rb",
+    "./lib/sugarcrm/base.rb",
+    "./lib/sugarcrm/config/sugarcrm.yaml",
+    "./lib/sugarcrm/connection.rb",
+    "./lib/sugarcrm/connection/api/get_available_modules.rb",
+    "./lib/sugarcrm/connection/api/get_document_revision.rb",
+    "./lib/sugarcrm/connection/api/get_entries.rb",
+    "./lib/sugarcrm/connection/api/get_entries_count.rb",
+    "./lib/sugarcrm/connection/api/get_entry.rb",
+    "./lib/sugarcrm/connection/api/get_entry_list.rb",
+    "./lib/sugarcrm/connection/api/get_module_fields.rb",
+    "./lib/sugarcrm/connection/api/get_note_attachment.rb",
+    "./lib/sugarcrm/connection/api/get_relationships.rb",
+    "./lib/sugarcrm/connection/api/get_report_entries.rb",
+    "./lib/sugarcrm/connection/api/get_server_info.rb",
+    "./lib/sugarcrm/connection/api/get_user_id.rb",
+    "./lib/sugarcrm/connection/api/get_user_team_id.rb",
+    "./lib/sugarcrm/connection/api/login.rb",
+    "./lib/sugarcrm/connection/api/logout.rb",
+    "./lib/sugarcrm/connection/api/seamless_login.rb",
+    "./lib/sugarcrm/connection/api/search_by_module.rb",
+    "./lib/sugarcrm/connection/api/set_campaign_merge.rb",
+    "./lib/sugarcrm/connection/api/set_document_revision.rb",
+    "./lib/sugarcrm/connection/api/set_entries.rb",
+    "./lib/sugarcrm/connection/api/set_entry.rb",
+    "./lib/sugarcrm/connection/api/set_note_attachment.rb",
+    "./lib/sugarcrm/connection/api/set_relationship.rb",
+    "./lib/sugarcrm/connection/api/set_relationships.rb",
+    "./lib/sugarcrm/connection/connection.rb",
+    "./lib/sugarcrm/connection/helper.rb",
+    "./lib/sugarcrm/connection/request.rb",
+    "./lib/sugarcrm/connection/response.rb",
+    "./lib/sugarcrm/connection_pool.rb",
+    "./lib/sugarcrm/exceptions.rb",
+    "./lib/sugarcrm/extensions/README.txt",
+    "./lib/sugarcrm/finders.rb",
+    "./lib/sugarcrm/finders/dynamic_finder_match.rb",
+    "./lib/sugarcrm/finders/finder_methods.rb",
+    "./lib/sugarcrm/module.rb",
+    "./lib/sugarcrm/module_methods.rb",
+    "./lib/sugarcrm/session.rb",
+    "./sugarcrm.gemspec",
+    "./sugarcrm.tmproj"
+  ]
+  s.homepage = %q{http://github.com/chicks/sugarcrm}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A less clunky way to interact with SugarCRM via REST.}
+  s.test_files = [
+    "test/connection/test_get_available_modules.rb",
+    "test/connection/test_get_entries.rb",
+    "test/connection/test_get_entry.rb",
+    "test/connection/test_get_entry_list.rb",
+    "test/connection/test_get_module_fields.rb",
+    "test/connection/test_get_relationships.rb",
+    "test/connection/test_get_server_info.rb",
+    "test/connection/test_get_user_id.rb",
+    "test/connection/test_get_user_team_id.rb",
+    "test/connection/test_login.rb",
+    "test/connection/test_logout.rb",
+    "test/connection/test_set_document_revision.rb",
+    "test/connection/test_set_note_attachment.rb",
+    "test/connection/test_set_relationship.rb",
+    "test/extensions_test/patch.rb",
+    "test/helper.rb",
+    "test/test_association_collection.rb",
+    "test/test_associations.rb",
+    "test/test_connection.rb",
+    "test/test_connection_pool.rb",
+    "test/test_module.rb",
+    "test/test_response.rb",
+    "test/test_session.rb",
+    "test/test_sugarcrm.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+