hot_tub 0.1.0 → 0.1.1

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head

data/Gemfile

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

data/README.md

@@ -1,8 +1,8 @@
-# HotTub
+# HotTub [![Build Status](https://travis-ci.org/JoshMcKin/hot_tub.png?branch=master)](https://travis-ci.org/JoshMcKin/hot_tub)
 A simple thread-safe connection pooling gem. Supports [HTTPClient](https://github.com/nahi/httpclient) (default) and
 [EM-Http-Requests](https://github.com/igrigorik/em-http-request) via [EM-Synchrony](https://github.com/igrigorik/em-synchrony). 
 There are a couple Ruby connection pool libraries out there but HotTub differs from most in that its connections are lazy 
-(created only when necessary), accomidates libraries that do not clean their dirty connections automatically, and manages unexpected usage increases by opening new connections rather than just blocking or throwings exception (never_block), although never_block can be disabled. 
+(created only when necessary), accomidates libraries that do not clean their dirty connections automatically, and manages unexpected usage increases by opening new connections rather than just blocking or throwing exceptions (never_block), although never_block can be disabled. 
 
 ## Installation
 
@@ -69,6 +69,7 @@ seperate pools for you various domains based on URI.
     # Assuming EM is running
     require 'hot_tub/clients/em_http_request_client'
     class EMClass
+      # Our client block must accept the url argument
       @@sessons = HotTub::Sessions.new {|url| HotTub::EmHttpRequestClient.new(url,{:connect_timeout => 5}) }
       def async_post_results(query = {})
         @@sessons.run("http://somewebservice.com") do |connection|    

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+task :default => :spec
+RSpec::Core::RakeTask.new

data/{http_hot_tub.gemspec → hot_tub.gemspec}

@@ -12,7 +12,6 @@ Gem::Specification.new do |s|
   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.rubyforge_project = "hot_tub"
   s.add_runtime_dependency "httpclient"
   s.add_development_dependency "rspec"

data/lib/hot_tub/pool.rb

@@ -55,21 +55,19 @@ module HotTub
     #     end
     #
     def initialize(options={},&client_block)
+      at_exit { close_all } # close connections at exit
       @client_block = (block_given? ? client_block : lambda { HTTPClient.new })
       @options = {
         :size => 5,
-        :never_block => true,
-        :blocking_timeout => 10,
-        :close => nil,
-        :clean => nil
+        :never_block => true,     # Return new client if we run out
+        :blocking_timeout => 10,  # in seconds
+        :close => nil,            # => lambda {|clnt| clnt.close}
+        :clean => nil             # => lambda {|clnt| clnt.clean}
       }.merge(options)
       @pool = []
       @current_size = 0
       @clients = []
       @mutex = (HotTub.em? ? EM::Synchrony::Thread::Mutex.new : Mutex.new)
-      @blocking_timeout = @options[:blocking_timeout]
-      @never_block = @options[:never_block]
-      @size = @options[:size]
     end
 
     # Hand off to client.run
@@ -104,7 +102,7 @@ module HotTub
     # Returns an instance of the client for this pool.
     def client
       clnt = nil
-      alarm = (Time.now + @blocking_timeout)
+      alarm = (Time.now + @options[:blocking_timeout])
       # block until we get an available client or raise Timeout::Error
       while clnt.nil?
         raise_alarm if alarm <= Time.now
@@ -123,7 +121,6 @@ module HotTub
       end
     end
 
-
     # Attempts to close the provided client, checking the options first for a close block
     # then checking the known clients
     def close_client(clnt)
@@ -142,7 +139,7 @@ module HotTub
     # Safely add client back to pool
     def push(clnt)
       @mutex.synchronize do
-        if @pool.length < @size
+        if @pool.length < @options[:size]
           @pool << clnt
         else
           @clients.delete(clnt)
@@ -157,7 +154,7 @@ module HotTub
       @mutex.synchronize do
         add if add?
         clnt = @pool.pop
-        if (clnt.nil? && @never_block)
+        if (clnt.nil? && @options[:never_block])
           HotTub.logger.info "Adding never_block client for #{@client.class.name}."
           clnt = new_client
         end
@@ -175,7 +172,7 @@ module HotTub
     # Only want to add a client if the pool is empty in keeping with
     # a lazy model.
     def add?
-      (@pool.length == 0 && @current_size <= @size)
+      (@pool.length == 0 && @current_size <= @options[:size])
     end
 
     def add

data/lib/hot_tub/session.rb

@@ -49,15 +49,17 @@ module HotTub
     # Synchronize access to our key hash
     # expects a url string or URI
     def sessions(url)
+      if url.is_a?(String)
+        uri = URI(url)
+      elsif url.is_a?(URI)
+        uri = url
+      else
+        raise ArgumentError, "you must pass a string or a URI object"
+      end
+      key = "#{uri.scheme}-#{uri.host}"
+      return @sessions[key] if @sessions[key]
       @mutex.synchronize do
-        if url.is_a?(String)
-          uri = URI(url)
-        elsif url.is_a?(URI)
-          uri = url
-        else
-          raise ArgumentError, "you must pass a string or a URI object"
-        end
-        @sessions["#{uri.scheme}-#{uri.host}"] ||= HotTub::Pool.new(@options) { @client_block.call(url) }
+        @sessions[key] ||= HotTub::Pool.new(@options) { @client_block.call(url) }
       end
     end
 

data/lib/hot_tub/version.rb

@@ -1,3 +1,3 @@
 module HotTub
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/pool_spec.rb

@@ -11,11 +11,11 @@ describe HotTub::Pool do
     end
 
     it "should have :size of 5" do
-      @pool.instance_variable_get(:@size).should eql(5)
+      @pool.instance_variable_get(:@options)[:size].should eql(5)
     end
 
     it "should have :blocking_timeout of 0.5" do
-      @pool.instance_variable_get(:@blocking_timeout).should eql(10)
+      @pool.instance_variable_get(:@options)[:blocking_timeout].should eql(10)
     end
 
     it "should have default :client" do
@@ -23,7 +23,7 @@ describe HotTub::Pool do
     end
 
     it "should be true" do
-      @pool.instance_variable_get(:@never_block).should be_true
+      @pool.instance_variable_get(:@options)[:never_block].should be_true
     end
   end
 
@@ -33,11 +33,11 @@ describe HotTub::Pool do
     end
 
     it "should have :size of 5" do
-      @pool.instance_variable_get(:@size).should eql(10)
+      @pool.instance_variable_get(:@options)[:size].should eql(10)
     end
 
     it "should have :blocking_timeout of 0.5" do
-      @pool.instance_variable_get(:@blocking_timeout).should eql(1.0)
+      @pool.instance_variable_get(:@options)[:blocking_timeout].should eql(1.0)
     end
 
     it "should have defult :client" do
@@ -45,7 +45,7 @@ describe HotTub::Pool do
     end
 
     it "should be true" do
-      @pool.instance_variable_get(:@never_block).should be_false
+      @pool.instance_variable_get(:@options)[:never_block].should be_false
     end
   end
 
@@ -116,8 +116,7 @@ describe HotTub::Pool do
 
     describe '#client' do
       it "should raise HotTub::BlockingTimeout if an available is not found in time"do
-        @pool.instance_variable_set(:@never_block,false)
-        @pool.instance_variable_set(:@blocking_timeout,0.1)
+        @pool.instance_variable_set(:@options, {:never_block => false, :blocking_timeout => 0.1})
         @pool.stub(:pop).and_return(nil)
         lambda { puts @pool.send(:client) }.should raise_error(HotTub::BlockingTimeout)
       end
@@ -135,7 +134,7 @@ describe HotTub::Pool do
       end
 
       it "should be false pool has reached pool_size" do
-        @pool.instance_variable_set(:@pool_data,{:current_size => 5})
+        @pool.instance_variable_set(:@options,{:size => 5})
         @pool.instance_variable_set(:@pool,["connection","connection","connection","connection","connection"])
         @pool.send(:add?).should be_false
       end

data/spec/session_spec.rb

@@ -94,4 +94,30 @@ describe HotTub::Session do
       status.should eql(200)
     end
   end
+
+  context 'thread safety' do
+    it "should work" do
+      url = "https://www.google.com/"
+      url2 = "https://www.yahoo.com/"
+      session = HotTub::Session.new({:size => 20}) { |a_url| HTTPClient.new}
+      failed = false
+      lambda {
+        threads = []
+        20.times.each do
+          threads << Thread.new do
+            session.run(url){|connection| failed = true unless connection.head(url).status == 200}
+            session.run(url2){|connection| failed = true unless connection.head(url).status == 200}
+          end
+        end
+        sleep(0.01)
+        threads.each do |t|
+          t.join
+        end
+      }.should_not raise_error
+      session.instance_variable_get(:@sessions).keys.length.should eql(2) # make sure work got done
+      session.instance_variable_get(:@sessions).values.first.instance_variable_get(:@pool).length.should eql(20) # make sure work got done
+      session.instance_variable_get(:@sessions).values.last.instance_variable_get(:@pool).length.should eql(20) # make sure work got done
+      failed.should be_false # Make sure our requests woked
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hot_tub
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-31 00:00:00.000000000 Z
+date: 2013-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -53,11 +53,12 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- http_hot_tub.gemspec
+- hot_tub.gemspec
 - lib/hot_tub.rb
 - lib/hot_tub/pool.rb
 - lib/hot_tub/session.rb
@@ -78,12 +79,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 518626986870371684
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 518626986870371684
 requirements: []
 rubyforge_project: hot_tub
 rubygems_version: 1.8.25