stillwater 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.8.7@balancer --create

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in balancer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Trae Robrock
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# Stillwater
+
+A simple connection pool, that allows connections to different servers (or anything else)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stillwater'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stillwater
+
+## Usage
+
+    pool = Stillwater::ConnectionPool.new
+    %q{ host1.com host2.com }.each do |host|
+      pool.add { MyConnectionClass.new(host) }
+    end
+
+    # Basic connection handling
+    pool.with_connection do |connection|
+      # Do some stuff with your connection
+    end
+
+    # Retry connections
+    # This will retry your code with a new connection and mark the tried
+    # connection as bad. The bad connection will be put back in the pool
+    # at the default period of 5 minutes.
+    pool.retry_connection_from(ServerConnectionFailed) do |connection|
+      # Do some stuff with your connection
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Contributors
+
+* Trae Robrock ( https://github.com/trobrock )
+* Julio Santos ( https://github.com/julio )

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/stillwater.rb

@@ -0,0 +1,5 @@
+require "stillwater/version"
+require "stillwater/connection_pool"
+
+module Stillwater
+end

data/lib/stillwater/connection_pool.rb

@@ -0,0 +1,122 @@
+require 'active_support/core_ext/array'
+
+module Stillwater
+  class ConnectionNotAvailable < StandardError ; end
+
+  class ConnectionPool
+    attr_accessor :reactivate_timeout, :retry_count
+
+    def initialize
+      @pool = []
+      @reactivate_timeout = 5 * 60 # 5 minutes
+      @retry_count = 3
+    end
+
+    def add(&builder)
+      @pool << connection_info_from(builder)
+    end
+
+    def reactivate_timeout=(seconds)
+      running = !!@thread
+      @thread.kill if running
+      @thread = nil
+      @reactivate_timeout = seconds
+      start_polling if running
+    end
+
+    def with_connection(&block)
+      conn = checkout
+      result = yield conn
+      checkin conn
+
+      result
+    end
+
+    def retry_connection_from(exception_class, &block)
+      count = 0
+      conn  = checkout
+      yield conn
+    rescue exception_class
+      deactivate conn
+      count += 1
+      raise if count >= @retry_count
+      retry
+    ensure
+      checkin conn
+    end
+
+    def checkout
+      connection_info = available.sample
+      raise ConnectionNotAvailable if connection_info.nil?
+      connection_info[:state] = :in_use
+
+      connection_info[:connection]
+    end
+
+    def checkin(conn)
+      connection_info = in_use.detect { |info| info[:connection] == conn }
+      connection_info[:state] = :available unless connection_info.nil?
+
+      true
+    end
+
+    def deactivate(conn)
+      connection_info = @pool.detect { |info| info[:connection] == conn }
+      connection_info[:connection] = nil
+      connection_info[:state] = :inactive
+
+      start_polling
+      true
+    end
+
+    def reactivate_all
+      inactive.each do |info|
+        info[:connection] = info[:builder].call
+        info[:state] = :available
+      end
+
+      true
+    end
+
+    def available_count
+      available.size
+    end
+
+    def inactive_count
+      inactive.size
+    end
+
+    def in_use_count
+      in_use.size
+    end
+
+    private
+
+    def start_polling
+      @thread ||= Thread.new do
+        sleep @reactivate_timeout
+        reactivate_all
+      end
+    end
+
+    def available
+      find_by_state :available
+    end
+
+    def in_use
+      find_by_state :in_use
+    end
+
+    def inactive
+      find_by_state :inactive
+    end
+
+    def find_by_state(state)
+      @pool.select { |info| info[:state] == state }
+    end
+
+    def connection_info_from(builder)
+      { :builder => builder, :state => :available, :connection => builder.call }
+    end
+  end
+end

data/lib/stillwater/version.rb

@@ -0,0 +1,3 @@
+module Stillwater
+  VERSION = "0.0.1"
+end

data/spec/connection_pool_spec.rb

@@ -0,0 +1,173 @@
+require 'spec_helper'
+
+class TestConnection
+  attr_accessor :name
+  def initialize(name)
+    @name = name
+  end
+end
+
+class TestException < StandardError ; end
+
+module Stillwater
+  describe ConnectionPool do
+    subject { ConnectionPool.new }
+
+    describe "#add" do
+      it "should add an available connection" do
+        subject.add { TestConnection.new("one") }
+
+        subject.available_count.should == 1
+      end
+    end
+
+    context "with a connection" do
+      before(:each) do
+        subject.add { TestConnection.new("one") }
+      end
+
+      describe "#checkout" do
+        it "should return a connection" do
+          conn = subject.checkout
+
+          conn.should be_instance_of(TestConnection)
+          subject.available_count.should == 0
+          subject.in_use_count.should == 1
+        end
+
+        it "should not be able to check out inactive connections" do
+          conn = subject.checkout
+          subject.deactivate conn
+
+          lambda { subject.checkout }.should raise_error(ConnectionNotAvailable)
+        end
+      end
+
+      describe "#checkin" do
+        it "should return the connection to the pool" do
+          conn = subject.checkout
+          subject.available_count.should == 0
+          subject.in_use_count.should == 1
+
+          subject.checkin(conn)
+          subject.available_count.should == 1
+          subject.in_use_count.should == 0
+        end
+      end
+
+      describe "#with_connection" do
+        it "should run some code with a connection" do
+          result = subject.with_connection do |connection|
+            subject.available_count.should == 0
+            connection.name.should == "one"
+
+            "bob"
+          end
+
+          result.should == "bob"
+          subject.available_count.should == 1
+        end
+      end
+
+      describe "#retry_connection_from" do
+        before(:each) do
+          subject.add { TestConnection.new("two") }
+        end
+
+        it "should retry a connection when receiving specific exception type" do
+          client_obj = mock("ClientObject")
+          client_obj.stubs(:do_something).raises(TestException).then.returns("client result")
+
+          result = subject.retry_connection_from(TestException) do |conn|
+            client_obj.do_something
+          end
+
+          subject.available_count.should == 1
+          subject.inactive_count.should == 1
+          result.should == "client result"
+        end
+
+        it "should respect the retry limit" do
+          subject.retry_count = 1
+
+          lambda {
+            subject.retry_connection_from(TestException) do |conn|
+              raise TestException
+            end
+          }.should raise_error(TestException)
+
+          subject.available_count.should == 1
+          subject.inactive_count.should == 1
+        end
+
+        it "should fail if all connections get deactivated" do
+          lambda {
+            subject.retry_connection_from(TestException) do |conn|
+              raise TestException
+            end
+          }.should raise_error(ConnectionNotAvailable)
+        end
+      end
+
+      describe "#deactivate" do
+        before(:each) do
+          subject.add { TestConnection.new("two") }
+          subject.add { TestConnection.new("three") }
+        end
+
+        it "should remove a deactivated connection from the pool" do
+          subject.available_count.should == 3
+          subject.inactive_count.should == 0
+
+          subject.with_connection do |connection|
+            subject.deactivate connection
+          end
+
+          subject.available_count.should == 2
+          subject.inactive_count.should == 1
+        end
+      end
+
+      describe "#reactivate" do
+        before(:each) do
+          subject.add { TestConnection.new("two") }
+          subject.add { TestConnection.new("three") }
+        end
+
+        it "should be able to reactivate inactive connections" do
+          subject.available_count.should == 3
+          subject.inactive_count.should == 0
+
+          conn1 = subject.checkout
+          conn2 = subject.checkout
+
+          subject.deactivate conn1
+          subject.deactivate conn2
+
+          subject.available_count.should == 1
+          subject.inactive_count.should == 2
+
+          subject.reactivate_all
+
+          subject.available_count.should == 3
+          subject.inactive_count.should == 0
+        end
+
+        it "should auto reactivate" do
+          subject.reactivate_timeout = 1
+
+          conn1 = subject.checkout
+          conn2 = subject.checkout
+
+          subject.deactivate conn1
+          subject.deactivate conn2
+
+          sleep 2
+
+          subject.available_count.should == 3
+          subject.inactive_count.should == 0
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'stillwater'
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+
+  config.mock_framework = :mocha
+end

data/stillwater.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/stillwater/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Trae Robrock", "Julio Santos"]
+  gem.email         = ["trobrock@gmail.com"]
+  gem.description   = %q{A simple connection pool, that allows connections to different servers (or anything else)}
+  gem.summary       = %q{A simple connection pool, that allows connections to different servers (or anything else)}
+  gem.homepage      = "https://github.com/trobrock/stillwater"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "stillwater"
+  gem.require_paths = ["lib"]
+  gem.version       = Stillwater::VERSION
+
+  gem.add_dependency %q<activesupport>, '~> 2.3.0'
+
+  gem.add_development_dependency %q<rake>
+  gem.add_development_dependency %q<rspec>
+  gem.add_development_dependency %q<mocha>
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: stillwater
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Trae Robrock
+- Julio Santos
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  name: activesupport
+  type: :runtime
+  prerelease: false
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rake
+  type: :development
+  prerelease: false
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rspec
+  type: :development
+  prerelease: false
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: mocha
+  type: :development
+  prerelease: false
+  requirement: *id004
+description: A simple connection pool, that allows connections to different servers (or anything else)
+email: 
+- trobrock@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/stillwater.rb
+- lib/stillwater/connection_pool.rb
+- lib/stillwater/version.rb
+- spec/connection_pool_spec.rb
+- spec/spec_helper.rb
+- stillwater.gemspec
+homepage: https://github.com/trobrock/stillwater
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: A simple connection pool, that allows connections to different servers (or anything else)
+test_files: 
+- spec/connection_pool_spec.rb
+- spec/spec_helper.rb