hot_tub 0.0.2 → 0.0.3

data/README.md

@@ -10,7 +10,7 @@ HotTub is available through [Rubygems](https://rubygems.org/gems/hot_tub) and ca
 
 ## Setup 
     class MyClass
-      @@pool = HotTub::Session.new({:size => 2 :client => HotTub::EmSynchronyClient.new('https://google.com'), :never_block => true})
+      @@pool = HotTub::Session.new(HotTub::ExconClient.new('https://google.com'),{:size => 2, :never_block => true})
 
       def self.fetch_results(query)
         @@pool.get(:query => query) # keepalive has be defaulted to true in the client

data/lib/hot_tub/clients/client.rb

@@ -23,14 +23,18 @@ module HotTub
     
     # Override this method to perform the necessary action for ensure a client
     # is clean for use.
-    def sanitize_hot_tub_client
+    def clean
       @client
     end
     
-    def close_hot_tub_client
+    def close
       @client
     end
     
+    def dup
+      self.class.new(@url,@options)
+    end
+    
     class << self
       def mutex
         Mutex.new

data/lib/hot_tub/clients/em_synchrony_client.rb

@@ -9,7 +9,7 @@ module HotTub
       @client = EM::HttpRequest.new(url,options)
     end
     
-    def sanitize_hot_tub_client     
+    def clean   
       if @client.conn && @client.conn.error?
         HotTub.logger.info "Sanitizing connection : #{EventMachine::report_connection_error_status(@client.conn.instance_variable_get(:@signature))}"
         @client.conn.close_connection
@@ -18,7 +18,7 @@ module HotTub
       @client
     end
     
-    def close_hot_tub_client
+    def close
       @client.conn.close_connection if @client.conn
     end
     
@@ -31,10 +31,6 @@ module HotTub
       end
     end
     
-    def dup
-      self.class.new(@url,@options)
-    end
-    
     class << self
       # Use a fiber safe mutex
       def mutex

data/lib/hot_tub/clients/excon_client.rb

@@ -12,16 +12,13 @@ module HotTub
     end
     
     # pretty sure Excon handles this internally
-    def sanitize_hot_tub_client
+    def clean
       @client
     end
     
-    def close_hot_tub_client
+    def close
       @client.socket.close
     end
-    
-    def dup
-      self.class.new(@url,@options)
-    end
+
   end
 end

data/lib/hot_tub/clients/http_client_client.rb

@@ -13,14 +13,14 @@ module HotTub
     end
     
     # pretty sure HttpClient handles this internally
-    def sanitize_hot_tub_client
+    def clean
       @client
     end
     
-    def close_hot_tub_client
+    def close
       @client.shutdown
     end
-    
+    # HttpClient has different initialization attributes so we need a custom dup
     def dup
       self.class.new(@options)
     end  

data/lib/hot_tub/session.rb

@@ -3,28 +3,23 @@ module HotTub
    
     # OPTIONS
     # * :size - number of connections for each pool
-    # * :inactivity_timeout - number of seconds to wait before disconnecting, 
-    # setting to 0 means the connection will not be closed
+    # * :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, 
     # 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
-    def initialize(options={})     
+    def initialize(client,options={})     
       @options = {
         :size => 5,
         :never_block => false,
         :blocking_timeout => 0.5
       }.merge(options || {})
-      if @options[:client]
-        @pool = []
-        @pool_data = {:current_size => 0}   
-        @client = @options[:client]
-        @mutex = (@client.respond_to?(:mutex) ? @client.mutex : Mutex.new)
-      else
-        raise ArgumentError, "The option :client is required for HotTub::Session.new"
-      end
+      @pool = []
+      @pool_data = {:current_size => 0}   
+      @client = client
+      @mutex = (@client.respond_to?(:mutex) ? @client.mutex : Mutex.new)  
     end
             
     def pool
@@ -44,7 +39,6 @@ module HotTub
       # 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."
@@ -52,14 +46,14 @@ module HotTub
           client.mark_temporary
         end
       end
-      client.sanitize_hot_tub_client
+      client.clean
       client
     end
   
     # return a client to the pool
     def return_client(client)
       if client.temporary?
-        client.close_hot_tub_client # Too hot in the hot tub...
+        client.close # Too hot in the hot tub...
       else
         @pool << client 
       end
@@ -70,11 +64,11 @@ module HotTub
     # is used for mulitple requests. For HTTP requests make sure you request has
     # keep-alive properly set for your client
     # EX:
-    #   @pool = HotTub.new("https://some_web_site.com")
+    #   @pool = HotTub.new(HotTub::ExconClient.new("https://some_web_site.com"))
     #   results = []
     #   @pool.run do |client|
-    #     results.push  (client.get(:query => {:foo => "bar"}, :keepalive => true))
-    #     results.push  (client.get(:query => {:bar => "foo"}, :keepalive => true)) # reuse client
+    #     results.push  (client.get(:query => {:foo => "bar"}))
+    #     results.push  (client.get(:query => {:bar => "foo"})) # reuse client
     #   end
     #
     def run(&block)
@@ -92,9 +86,9 @@ module HotTub
     # Let pool instance respond to client methods. For HTTP request make sure you 
     # requests has keep-alive properly set for your client
     # EX: 
-    #   @pool = HotTub.new("https://some_web_site.com")
-    #   r1 = @pool.get(:query => {:foo => "bar"}, :keepalive => true)
-    #   r2 = @pool.get(:query => {:bar => "foo"}, :keepalive => true) # uses a different client
+    #   @pool = HotTub.new(HotTub::ExconClient.new("https://some_web_site.com"))
+    #   r1 = @pool.get(:query => {:foo => "bar"})
+    #   r2 = @pool.get(:query => {:bar => "foo"}) # uses a different client
     #
     def method_missing(method, *args, &blk)
       client = fetch

data/lib/hot_tub/version.rb

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

data/spec/session_spec.rb

@@ -9,15 +9,10 @@ require 'spec_helper'
   end
 
 describe HotTub::Session do
-  
-  describe '#initialize' do
-     it "should raise ArgumentError if :client option is nil" do
-      lambda { HotTub::Session.new}.should raise_error(ArgumentError)
-    end
-  end
+
   before(:each) do
     @url = "http://www.testurl123.com/"
-    @tub = HotTub::Session.new(:client => MocClient.new(@url)) 
+    @tub = HotTub::Session.new(MocClient.new(@url)) 
   end
 
   context 'default configuration' do

data/spec/test_helper_methods.rb

@@ -11,8 +11,7 @@ module TestHelperMethods
     normal = Time.now - start
     
     # we want a whole new pool to make sure we don't cheat
-    connection_pool = HotTub::Session.new(
-      :client => client)
+    connection_pool = HotTub::Session.new(client)
     
     start = Time.now
     50.times.each do

metadata

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