client_proxy 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 James Golick
+
+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.rdoc

@@ -0,0 +1,17 @@
+= client_proxy
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 James Golick. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "client_proxy"
+    gem.summary = %Q{Basic ruby proxy class to use around service clients that handles retrying requests and failover.}
+    gem.description = %Q{Basic ruby proxy class to use around service clients that handles retrying requests and failover.}
+    gem.email = "jamesgolick@gmail.com"
+    gem.homepage = "http://github.com/jamesgolick/client_proxy"
+    gem.authors = ["James Golick"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "bourne", "~> 1.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "client_proxy #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/client_proxy.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{client_proxy}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Golick"]
+  s.date = %q{2010-09-08}
+  s.description = %q{Basic ruby proxy class to use around service clients that handles retrying requests and failover.}
+  s.email = %q{jamesgolick@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "client_proxy.gemspec",
+     "lib/client_proxy.rb",
+     "spec/client_proxy_spec.rb",
+     "spec/retrying_client_proxy_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jamesgolick/client_proxy}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Basic ruby proxy class to use around service clients that handles retrying requests and failover.}
+  s.test_files = [
+    "spec/client_proxy_spec.rb",
+     "spec/retrying_client_proxy_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<bourne>, ["~> 1.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<bourne>, ["~> 1.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<bourne>, ["~> 1.0"])
+  end
+end
+

data/lib/client_proxy.rb

@@ -0,0 +1,38 @@
+class ClientProxy
+  def initialize(client_factory, hosts, recoverable_errors, max_retries, randomize_order = true)
+    @client_factory     = client_factory
+    @hosts              = hosts
+    @recoverable_errors = recoverable_errors
+    @max_retries        = max_retries
+    @host_pointer       = randomize_order ? rand(hosts.length) : -1
+  end
+
+  def method_missing(method, *args, &block)
+    attempt(0, method, *args, &block)
+  end
+
+  def attempt(try, method, *args, &block)
+    begin
+      current_client.__send__(method, *args, &block)
+    rescue *@recoverable_errors => e
+      @current_client = nil
+      raise e if try == (@max_retries - 1)
+      attempt(try + 1, method, *args, &block)
+    end
+  end
+
+  private
+    def current_client
+      @current_client ||= next_client
+    end
+
+    def next_client
+      @client_factory.create(next_host)
+    end
+
+    def next_host
+      @host_pointer += 1
+      @host_pointer  = 0 if @host_pointer == @hosts.length
+      @current_host = @hosts[@host_pointer]
+    end
+end

data/spec/client_proxy_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe "ClientProxy" do
+  before do
+    @client_factory = stub("ClientFactory")
+    @host1          = stub("Client(host1)", :do_something => true)
+    @host2          = stub("Client(host2)", :do_something => true)
+    @client_factory.stubs(:create).with("host1:6379").returns(@host1)
+    @client_factory.stubs(:create).with("host2:6379").returns(@host2)
+    @client_proxy   = ClientProxy.new(@client_factory,
+                                      ["host1:6379", "host2:6379"],
+                                      [RuntimeError],
+                                      3,
+                                      false)
+  end
+
+  describe "when a request succeeds" do
+    it "tries the first host" do
+      @client_proxy.do_something.should == true
+      @host1.should have_received(:do_something)
+    end
+  end
+
+  describe "when a request fails with a recoverable exception" do
+    it "recovers and attempts the next host" do
+      @host1.stubs(:do_something).raises(RuntimeError, "Fuck!")
+      @client_proxy.do_something.should == true
+      @host1.should have_received(:do_something)
+      @host2.should have_received(:do_something)
+    end
+  end
+
+  describe "when a request fails more than max_retries times" do
+    it "the error bubbles up" do
+      @host1.stubs(:do_something).raises(RuntimeError, "Fuck!")
+      @host2.stubs(:do_something).raises(RuntimeError, "Fuck!")
+      lambda {
+        @client_proxy.do_something
+      }.should raise_error(RuntimeError)
+      @host1.should have_received(:do_something).twice
+      @host2.should have_received(:do_something).once
+    end
+  end
+end

data/spec/retrying_client_proxy_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe "ClientProxy::RetryingClient" do
+  before do
+    @client_factory = stub("ClientFactory")
+    @host1          = stub("Client::Host1")
+    @host2          = stub("Client::Host2")
+    @client_factory.stubs(:create).with("host1:5432").returns(@host1)
+    @client_factory.stubs(:create).with("host2:5432").returns(@host2)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'client_proxy'
+require 'spec'
+require 'spec/autorun'
+require 'bourne'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: client_proxy
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- James Golick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-08 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bourne
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id002
+description: Basic ruby proxy class to use around service clients that handles retrying requests and failover.
+email: jamesgolick@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- client_proxy.gemspec
+- lib/client_proxy.rb
+- spec/client_proxy_spec.rb
+- spec/retrying_client_proxy_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jamesgolick/client_proxy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Basic ruby proxy class to use around service clients that handles retrying requests and failover.
+test_files: 
+- spec/client_proxy_spec.rb
+- spec/retrying_client_proxy_spec.rb
+- spec/spec_helper.rb