hot_tub 0.0.3 → 0.0.4

data/lib/hot_tub/clients/client.rb

@@ -13,14 +13,6 @@ module HotTub
       @client.send(method,*args,&blk)
     end
     
-    def temporary?
-      @temporary == true
-    end
-    
-    def mark_temporary
-      @temporary = true
-    end
-    
     # Override this method to perform the necessary action for ensure a client
     # is clean for use.
     def clean

data/lib/hot_tub/session.rb

@@ -2,14 +2,14 @@ module HotTub
   class Session
    
     # OPTIONS
-    # * :size - number of connections for each pool
+    # * :size - number of clients/connections for each pool
     # * :inactivity_timeout - number of seconds to wait before disconnecting, setting to 0 means the connection will not be closed
-    # * :pool_timeout - the amount of seconds to block waiting for an availble connection, 
+    # * :pool_timeout - the amount of seconds to block waiting for an available client, 
     # because this is blocking it should be an extremely short amount of 
     # time default to 0.5 seconds, if you need more consider enlarging your pool
     # instead of raising this number
-    # :never_block - if set to true, a connection will always be returned, but 
-    # these extra connections are not added to the pool when the request is completed
+    # :never_block - if set to true, a client will always be returned, 
+    # but the pool size will never grow past that :size option, extra clients are closed
     def initialize(client,options={})     
       @options = {
         :size => 5,
@@ -21,47 +21,22 @@ module HotTub
       @client = client
       @mutex = (@client.respond_to?(:mutex) ? @client.mutex : Mutex.new)  
     end
-            
-    def pool
+    
+    # The synchronized pool for all our clients.
+    #
+    def pool(client=nil)
       @mutex.synchronize do
-        add_client if add_client?
+        if client
+          return_client(client)
+        else   
+          add_client if add_client?
+       end
         @pool
       end
     end
-  
-    # Fetches an avaible client from the pool.
-    # Hot tubs are not always clean... Make sure we have a good connection. The client
-    # should respond to sanitize_hot_tub_connection, which checks to make sure
-    # the connection is still viable, and resets if not
-    def fetch        
-      client = nil
-      alarm = (Time.now + @options[:blocking_timeout])       
-      # block until we get an available connection or Timeout::Error     
-      while client.nil?
-        raise_alarm if alarm <= Time.now
-        client = pool.shift
-        if client.nil? && (@options[:never_block])
-          HotTub.logger.info "Adding never_block client for #{@client.class.name}, will not be returned to pool."
-          client = new_client
-          client.mark_temporary
-        end
-      end
-      client.clean
-      client
-    end
-  
-    # return a client to the pool
-    def return_client(client)
-      if client.temporary?
-        client.close # Too hot in the hot tub...
-      else
-        @pool << client 
-      end
-      @pool
-    end
     
-    # Run the block on the retrieved connection. Good for ensure the same client
-    # is used for mulitple requests. For HTTP requests make sure you request has
+    # Run the block on the retrieved client. Good for ensure the same client
+    # is used for multiple requests. For HTTP requests make sure you request has
     # keep-alive properly set for your client
     # EX:
     #   @pool = HotTub.new(HotTub::ExconClient.new("https://some_web_site.com"))
@@ -79,7 +54,7 @@ module HotTub
         raise ArgumentError, 'Run requires a block.'
       end
     ensure
-      return_client(client) if client
+      pool(client) if client
     end
    
 
@@ -94,7 +69,7 @@ module HotTub
       client = fetch
       client.send(method,*args,&blk)
     ensure
-      return_client(client) if client
+      pool(client) if client
     end
     
     private
@@ -102,6 +77,10 @@ module HotTub
     def add_client?
       (@pool.empty? && (@pool_data[:current_size] < @options[:size]))
     end
+             
+    def new_client
+      @client.dup
+    end 
         
     def add_client
       HotTub.logger.info "Adding HotTub client: #{@client.class.name} to pool"
@@ -109,11 +88,38 @@ module HotTub
       @pool << new_client         
       @pool
     end
-        
-    def new_client
-      @client.dup
-    end  
-
+    
+    # return a client to the pool
+    def return_client(client)
+      if @pool.length < @options[:size]
+        @pool << client
+      else
+        HotTub.logger.info "Closed extra client for #{@client.class.name}."
+        client.close # Too hot in the hot tub...
+      end
+    end
+    
+    # Fetches an available client from the pool.
+    # Hot tubs are not always clean... Make sure we have a good client. The client
+    # should respond to clean, which checks to make sure the client is still 
+    # viable, and reset if necessary.
+    def fetch        
+      client = nil
+      alarm = (Time.now + @options[:blocking_timeout])       
+      # block until we get an available client or raise Timeout::Error     
+      while client.nil?
+        raise_alarm if alarm <= Time.now
+        client = pool.shift
+        if client.nil? && (@options[:never_block])
+          HotTub.logger.info "Adding never_block client for #{@client.class.name}."
+          client = new_client
+          client.mark_temporary
+        end
+      end
+      client.clean
+      client
+    end
+ 
     def raise_alarm
       message = "Could not fetch a free client in time. Consider increasing your pool size for #{@client.class.name}."
       HotTub.logger.error message

data/lib/hot_tub/version.rb

@@ -1,3 +1,3 @@
 module HotTub
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/session_spec.rb

@@ -48,20 +48,20 @@ describe HotTub::Session do
     end
   end   
         
-  describe '#fetch_connection' do
+  describe '#fetch' do
     it "should raise Timeout::Error if an available is not found in time"do
       @tub.stub(:pool).and_return([])
-      lambda { @tub.fetch}.should raise_error(Timeout::Error)
+      lambda { @tub.send(:fetch)}.should raise_error(Timeout::Error)
     end
     
     it "should not raise Timeout::Error if an available is not found in time"do
       @tub.instance_variable_get(:@options)[:never_block] = true
       @tub.stub(:pool).and_return([])
-      lambda { @tub.fetch}.should_not raise_error(Timeout::Error)
+      lambda { @tub.send(:fetch)}.should_not raise_error(Timeout::Error)
     end
     
     it "should return an instance of the driver" do
-      @tub.fetch.should be_instance_of(MocClient)
+      @tub.send(:fetch).should be_instance_of(MocClient)
     end
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hot_tub
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-02 00:00:00.000000000Z
+date: 2012-07-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70179585887100 !ruby/object:Gem::Requirement
+  requirement: &70279127174460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70179585887100
+  version_requirements: *70279127174460
 description: A very simple ruby pool gem
 email:
 - joshmckin@gmail.com