hot_tub 0.2.5 → 0.2.6

data/.gitignore

@@ -3,4 +3,4 @@
 Gemfile.lock
 pkg/*
 .DS_Store
-nbproject/
+coverage/

data/.travis.yml

@@ -9,7 +9,5 @@ rvm:
   - jruby-head
 matrix:
   allow_failures:
-    - rvm: jruby-19mode
-    - rvm: rbx-19mode
     - rvm: jruby-head
     - rvm: ruby-head

data/Gemfile

@@ -3,9 +3,10 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in http_hot_tub.gemspec
 gemspec
 gem 'rake'
-gem 'coveralls', require: false
+
 group :development do
   platform :ruby do
+  	gem 'coveralls', :require => false
     gem 'eventmachine'
     gem 'em-http-request', '~> 1.0', :require => 'em-http'
     gem 'em-synchrony', '~> 1.0', :require => ['em-synchrony', 'em-synchrony/em-http']

data/HISTORY.md

@@ -0,0 +1,9 @@
+HotTub Changelog
+=====================
+
+HEAD
+=======
+
+- Rename unsafe methods with leading "_"
+- Add register to pool to track all connections
+- EM.add_shutdown_hook for EM connections

data/README.md

@@ -6,18 +6,22 @@ A simple thread-safe connection pool and sessions gem. Out-of-the-box support fo
 ## Features
 
 ### HotTub::Pool
-* Thread safe
+* Thread safe / Fiber safe (with EM::HttpRequest + EM::Synchrony)
 * Lazy clients/connections (created only when necessary)
 * Can be used with any client library
 * Support for cleaning dirty resources
 * Set to expand pool under load that is eventually reaped back down to set size (never_block), can be disabled
-* Attempts to close clients/connections at_exit
+* Attempts to close clients/connections on shutdown
 
 ### HotTub::Session
-* Thread safe
+* Thread safe / Fiber safe (with EM::HttpRequest + EM::Synchrony)
 * The same api as HotTub::Pool
 * Can be used with HotTub::Pool or any client library 
-* Attempts to close clients/connections at_exit
+* Attempts to close clients/connections on shutdown
+
+## Requirements
+HotTub is tested on MRI, JRUBY and Rubinius
+* Ruby >= 1.9
 
 ## Installation
 
@@ -25,7 +29,7 @@ HotTub is available through [Rubygems](https://rubygems.org/gems/hot_tub) and ca
 
     $ gem install hot_tub
 
-## Rails setup
+### Rails setup
 
 Add hot_tub to your gemfile:
     
@@ -49,19 +53,20 @@ Configure Logger by creating a hot_tub.rb initializer and adding the following:
     require 'em-synchrony/em-http'
     EM.synchrony do {
       pool = HotTub::Pool.new(:size => 12) { EM::HttpRequest.new("http://somewebservice.com") }
+      # Make sure we set :keepalive as true
       pool.run { |clnt| clnt.aget(:query => results, :keepalive => true) }
       EM.stop
     }
 
 ### Other
-You can use any library you want with HotTub::Pool, regardless of that clients thread-safety status.
-Close and clean can be defined at initialization with lambdas, if they are not defined they are ignored.
+You can use any library you want with HotTub::Pool. Close and clean can be defined at initialization 
+with lambdas, if they are not defined they are ignored.
 
     url = "http://test12345.com"
     pool = HotTub::Pool.new({:size => 10, :close => lambda {|clnt| clnt.close}}) { MyHttpLib.new }
-    pool.run { |clnt| clnt.get(@@url,query).body }
+    pool.run { |clnt| clnt.get(url,query).body }
  
-## HotTub::Session Usage 
+## HotTub::Session
 HotTub::Sessions are a synchronized hash of clients/pools and are implemented similar HotTub::Pool. 
 For example, Excon is thread safe but you set a single url at the client level so sessions 
 are handy if you need to access multiple urls but would prefer a single object.
@@ -82,22 +87,22 @@ are handy if you need to access multiple urls but would prefer a single object.
     end
 
 ### HotTub::Session with HotTub::Pool
-Suppose you have a client that is not thread safe, you can use HotTub::Pool with HotTub::Sessions to get what you need.
+Suppose you have a client that lacks pooling and session features you can use HotTub::Pool with HotTub::Sessions to get what you need.
     
     require 'hot_tub'
     require "em-synchrony"
     require "em-synchrony/em-http"
 
-    # We ust tell HotTub::Session to use HotTub::Pool, pass any pool options in our 
+    # We must tell HotTub::Session to use HotTub::Pool, pass any pool options in our 
     # options has, and our client block must accept the url argument
     EM.synchrony do {
       sessions = HotTub::Session.new(:with_pool => true, :size => 12) {|url| EM::HttpRequest.new(url, :inactivity_timeout => 0) }
 
       sessions.run("http://somewebservice.com") do |clnt|    
-        puts clnt.get(:query => results).response_header.status
+        puts clnt.get(:query => results, :keepalive => true).response_header.status
       end
       sessions.run("https://someotherwebservice.com") do |clnt|    
-        puts clnt.get(:query => results).response_header.status
+        puts clnt.get(:query => results, :keepalive => true).response_header.status
       end
       EM.stop
     }

data/hot_tub.gemspec

@@ -10,13 +10,13 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/JoshMcKin/hot_tub"
   s.license     = "MIT"
   s.summary     = %q{A simple thread-safe http connection pooling gem.}
-  s.description = %q{A simple thread-safe http connection pooling gem. Http client options include HTTPClient and EM-Http-Request}
+  s.description = %q{A simple thread-safe http connection pooling gem. Out-of-the-box support for Excon and EM-Http-Request}
 
   s.rubyforge_project = "hot_tub"
   
   s.add_development_dependency "rspec"
   s.add_development_dependency "sinatra"
-  s.add_development_dependency "puma", "~> 2.0.0.b7"
+  s.add_development_dependency "puma", "~> 2.0.0"
   s.add_development_dependency "excon"
   
   s.files         = `git ls-files`.split("\n")

data/lib/hot_tub/pool.rb

@@ -26,7 +26,6 @@ module HotTub
     #
     def initialize(options={},&client_block)
       raise ArgumentError, 'a block that initializes a new client is required' unless block_given?
-      at_exit { close_all } # close connections at exit
       @client_block = client_block
       @options = {
         :size => 5,
@@ -35,11 +34,13 @@ module HotTub
         :close => nil,            # => lambda {|clnt| clnt.close}
         :clean => nil             # => lambda {|clnt| clnt.clean}
       }.merge(options)
-      @pool = []
-      @current_size = 0
-      @mutex = (fiber_mutex? ? EM::Synchrony::Thread::Mutex.new : Mutex.new)
-      @last_activity = Time.now
-      @fetching_client = false
+      @pool             = []    # stores available connection
+      @register         = []    # stores all connections at all times
+      @current_size     = 0
+      @pool_mutex       = (em_client? ? EM::Synchrony::Thread::Mutex.new : Mutex.new)
+      @last_activity    = Time.now
+      @fetching_client  = false
+      HotTub.hot_at_exit( em_client? ) {close_all}
     end
 
     # Hand off to client.run
@@ -56,8 +57,9 @@ module HotTub
 
     # Calls close on all connections and reset the pools
     def close_all
-      @mutex.synchronize do
-        while clnt = @pool.pop
+      @pool_mutex.synchronize do
+        while clnt = @register.pop
+          @pool.delete(clnt)
           begin
             close_client(clnt)
           rescue => e
@@ -70,7 +72,7 @@ module HotTub
 
     private
 
-    def fiber_mutex?
+    def em_client?
       begin
         (HotTub.em_synchrony? && @client_block.call.is_a?(EventMachine::HttpConnection))
       rescue
@@ -97,10 +99,15 @@ module HotTub
       raise BlockingTimeout, message
     end
 
-    # Safely add client back to pool
+    # Safely add client back to pool, only if
+    # that clnt is registered
     def push(clnt)
-      @mutex.synchronize do
-        @pool << clnt
+      @pool_mutex.synchronize do
+        if @register.include?(clnt)
+          @pool << clnt 
+        else
+          close_client(clnt)
+        end
       end
       nil # make sure never return the pool
     end
@@ -108,11 +115,11 @@ module HotTub
     # Safely pull client from pool, adding if allowed
     def pop
       @fetching_client = true # kill reap_pool
-      @mutex.synchronize do
-        add if add?
+      @pool_mutex.synchronize do
+        _add if add?
         clnt = @pool.pop # get warm connection
         if (clnt.nil? && @options[:never_block])
-          add
+          _add
           clnt = @pool.pop
         end
         @fetching_client = false
@@ -133,27 +140,32 @@ module HotTub
       (@pool.length == 0 && (@options[:size] > @current_size))
     end
 
-    def add
-      @last_activity = Time.now
-      @current_size += 1
-      nc = new_client
-      HotTub.logger.info "Adding HotTub client: #{nc.class.name} to pool"
-      @pool << nc
-    end
-
     def reap_pool?
       (!@fetching_client && (@current_size > @options[:size]) && ((@last_activity + (600)) < Time.now))
     end
 
     # Remove extra connections from front of pool
     def reap_pool
-      @mutex.synchronize do
+      @pool_mutex.synchronize do
         if reap_pool? && clnt = @pool.shift
+          @register.delete(clnt)
           @current_size -= 1
           close_client(clnt)
         end
       end
     end
+
+    # _add is volatile; and may cause theading issues 
+    # if called outside @pool_mutex.synchronize {}
+    def _add
+      @last_activity = Time.now
+      @current_size += 1
+      nc = new_client
+      HotTub.logger.info "Adding HotTub client: #{nc.class.name} to pool"
+      @register << nc
+      @pool << nc
+    end
+    # end volatile 
   end
   class BlockingTimeout < StandardError;end
 end

data/lib/hot_tub/session.rb

@@ -33,11 +33,11 @@ module HotTub
     #
     def initialize(options={},&client_block)
       raise ArgumentError, "HotTub::Sessions requre a block on initialization that accepts a single argument" unless block_given?
-      at_exit { close_all } # close connections at exit
       @options = options || {}
       @client_block = client_block
       @sessions = Hash.new
-      @mutex = (fiber_mutex? ? EM::Synchrony::Thread::Mutex.new : Mutex.new)
+      @mutex = (em_client? ? EM::Synchrony::Thread::Mutex.new : Mutex.new)
+      HotTub.hot_at_exit( em_client? ) {close_all}
     end
 
     # Synchronizes initialization of our sessions
@@ -81,7 +81,7 @@ module HotTub
 
     private
 
-    def fiber_mutex?
+    def em_client?
       begin
         (HotTub.em_synchrony? && @client_block.call("http://moc").is_a?(EventMachine::HttpConnection))
       rescue

data/lib/hot_tub/version.rb

@@ -1,3 +1,3 @@
 module HotTub
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/lib/hot_tub.rb

@@ -30,4 +30,12 @@ module HotTub
   def self.rbx?
     defined?(RUBY_ENGINE) and RUBY_ENGINE == 'rbx'
   end
+
+  def self.hot_at_exit with_em=false, &blk
+    if with_em
+      EM.add_shutdown_hook &blk
+    else
+      at_exit &blk
+    end
+  end
 end

data/spec/pool_spec.rb

@@ -82,9 +82,18 @@ describe HotTub::Pool do
     before(:each) do
       @pool = HotTub::Pool.new(:size => 5) { MocClient.new }
       5.times do
-        @pool.send(:add)
+        @pool.send(:_add)
       end
     end
+
+    it "should reset register" do
+      @pool.current_size.should eql(5)
+      @pool.instance_variable_get(:@register).length.should eql(5)
+      @pool.close_all
+      @pool.instance_variable_get(:@register).length.should eql(0)
+      @pool.current_size.should eql(0)
+    end
+
     it "should reset pool" do
       @pool.current_size.should eql(5)
       @pool.instance_variable_get(:@pool).length.should eql(5)
@@ -126,10 +135,31 @@ describe HotTub::Pool do
       end
     end
 
-    describe '#add' do
+    describe '#_add' do
       it "should add connections for supplied url"do
-        @pool.send(:add)
-        @pool.instance_variable_get(:@pool).should_not be_nil
+        pre_add_length = @pool.instance_variable_get(:@pool).length
+        @pool.send(:_add)
+        @pool.instance_variable_get(:@pool).length.should be > pre_add_length
+      end
+    end
+
+    describe '#push' do
+      context "connection is registered" do
+        it "should push connection back to pool" do
+          @pool.send(:_add)
+          clnt = @pool.instance_variable_get(:@pool).pop
+          @pool.send(:push,clnt)
+          @pool.instance_variable_get(:@pool).include?(clnt).should be_true
+        end
+      end
+      context "connection is not registered" do
+        it "should not push connection back to pool" do
+          @pool.send(:_add)
+          clnt = @pool.instance_variable_get(:@pool).pop
+          @pool.instance_variable_get(:@register).delete(clnt)
+          @pool.send(:push,clnt)
+          @pool.instance_variable_get(:@pool).include?(clnt).should be_false
+        end
       end
     end
   end
@@ -260,7 +290,7 @@ describe HotTub::Pool do
   end
 
   unless HotTub.jruby?
-    describe "fiber_mutex?" do
+    describe "em_client?" do
         context 'EM::HttpRequest as client' do
           before(:each) do
             @pool = HotTub::Pool.new { EM::HttpRequest.new(HotTub::Server.url) }
@@ -268,20 +298,20 @@ describe HotTub::Pool do
           context "EM::Synchrony is present" do
             it "should be true" do
               HotTub.stub(:em_synchrony?).and_return(true)
-              @pool.send(:fiber_mutex?).should be_true
+              @pool.send(:em_client?).should be_true
             end
           end
           context "EM::Synchrony is not present" do
             it "should be false" do
               HotTub.stub(:em_synchrony?).and_return(false)
-              @pool.send(:fiber_mutex?).should be_false
+              @pool.send(:em_client?).should be_false
             end
           end
         end
         context 'client is not EM::HttpRequest' do
           it "should be false" do
             pool = HotTub::Pool.new {|url| MocClient.new}
-            pool.send(:fiber_mutex?).should be_false
+            pool.send(:em_client?).should be_false
           end
         end
       end
@@ -294,7 +324,7 @@ describe HotTub::Pool do
       it "should work" do
         EM.synchrony do
           status = []
-          c = HotTub::Pool.new(:fiber_mutex => true) {EM::HttpRequest.new(@url)}
+          c = HotTub::Pool.new {EM::HttpRequest.new(@url)}
           c.run { |conn| status << conn.head(:keepalive => true).response_header.status}
           c.run { |conn| status << conn.ahead(:keepalive => true).response_header.status}
           c.run { |conn| status << conn.head(:keepalive => true).response_header.status}

data/spec/session_spec.rb

@@ -120,7 +120,6 @@ describe HotTub::Session do
         failed = false
         start_time = Time.now
         stop_time = nil
-        mutex = Mutex.new
         threads = []
         lambda {
           10.times.each do
@@ -146,7 +145,7 @@ describe HotTub::Session do
 
     unless HotTub.jruby?
 
-      describe "fiber_mutex?" do
+      describe "em_client?" do
 
         context 'EM::HttpRequest as client' do
           before(:each) do
@@ -155,20 +154,20 @@ describe HotTub::Session do
           context "EM::Synchrony is present" do
             it "should be true" do
               HotTub.stub(:em_synchrony?).and_return(true)
-              @session.send(:fiber_mutex?).should be_true
+              @session.send(:em_client?).should be_true
             end
           end
           context "EM::Synchrony is not present" do
             it "should be false" do
               HotTub.stub(:em_synchrony?).and_return(false)
-              @session.send(:fiber_mutex?).should be_false
+              @session.send(:em_client?).should be_false
             end
           end
         end
         context 'client is not EM::HttpRequest' do
           it "should be false" do
             session = HotTub::Session.new {|url| MocClient.new}
-            session.send(:fiber_mutex?).should be_false
+            session.send(:em_client?).should be_false
           end
         end
       end
@@ -205,7 +204,6 @@ describe HotTub::Session do
             sessions.instance_variable_get(:@sessions).keys.length.should eql(1)
             (sessions.sessions(@url).instance_variable_get(:@pool).length >= 5).should be_true #make sure work got done
             failed.should be_false # Make sure our requests worked
-            sessions.close_all
             EM.stop
           end
         end

data/spec/spec_helper.rb

@@ -6,8 +6,10 @@ require 'excon'
 require 'helpers/moc_client'
 require 'helpers/server'
 require 'net/https'
-require 'coveralls'
-Coveralls.wear! unless HotTub.jruby? || HotTub.rbx?
+unless HotTub.jruby? || HotTub.rbx?
+  require 'coveralls'
+  Coveralls.wear!
+end
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
@@ -15,12 +17,12 @@ Coveralls.wear! unless HotTub.jruby? || HotTub.rbx?
 HotTub.logger.level = Logger::ERROR
 
 RSpec.configure do |config|
- config.before(:suite) do
-  HotTub::Server.run
-  HotTub::Server2.run
- end
- config.after(:suite) do
-  HotTub::Server.teardown
-  HotTub::Server2.teardown
- end
-end
+  config.before(:suite) do
+    HotTub::Server.run
+    HotTub::Server2.run
+  end
+  config.after(:suite) do
+    HotTub::Server.teardown
+    HotTub::Server2.teardown
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hot_tub
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-08 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0.b7
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0.b7
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
@@ -75,8 +75,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A simple thread-safe http connection pooling gem. Http client options
-  include HTTPClient and EM-Http-Request
+description: A simple thread-safe http connection pooling gem. Out-of-the-box support
+  for Excon and EM-Http-Request
 email:
 - joshmckin@gmail.com
 executables: []
@@ -87,6 +87,7 @@ files:
 - .rspec
 - .travis.yml
 - Gemfile
+- HISTORY.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -116,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1839309947224613127
+      hash: -3131859420697003965
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -125,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1839309947224613127
+      hash: -3131859420697003965
 requirements: []
 rubyforge_project: hot_tub
 rubygems_version: 1.8.25