thrift_client 0.1 → 0.1.1

data/CHANGELOG

@@ -1,2 +1,4 @@
 
+v0.1.1. Support server_retry_period.
+
 v0.1. First release.

data/lib/thrift_client.rb

@@ -2,69 +2,80 @@
 require 'rubygems'
 require 'thrift'
 
-class ThriftClient  
+class ThriftClient
 
-  DEFAULTS = { 
+  DEFAULTS = {
     :protocol => Thrift::BinaryProtocol,
     :transport => Thrift::FramedTransport,
-    :socket_timeout => 1, 
+    :socket_timeout => 1,
     :randomize_server_list => true,
     :exception_classes => [
-      IOError, 
-      Thrift::Exception, 
-      Thrift::ProtocolException, 
-      Thrift::ApplicationException, 
+      IOError,
+      Thrift::Exception,
+      Thrift::ProtocolException,
+      Thrift::ApplicationException,
       Thrift::TransportException],
     :raise => true,
-    :retries => nil
+    :retries => nil,
+    :server_retry_period => nil
   }.freeze
-  
+
   attr_reader :client, :client_class, :server_list, :options
 
+  class NoServersAvailable < StandardError; end
+
   def initialize(client_class, servers, options = {})
     @options = DEFAULTS.merge(options)
-    @client_class = client_class        
+    @client_class = client_class
     @server_list = Array(servers)
     @retries = options[:retries] || @server_list.size
     @server_list = @server_list.sort_by { rand } if @options[:randomize_server_list]
-    
-    @attempts = 0
-    @live_server_list = []    
+
+    @live_server_list = @server_list.dup
+    @last_retry = Time.now
   end
-  
+
+  def disconnect!
+    @transport.close rescue nil
+    @client = nil
+  end
+
   private
-  
+
   def method_missing(*args)
-    tries ||= @retries
     connect! unless @client
-    @client.send(*args)    
+    @client.send(*args)
   rescue *@options[:exception_classes]
-    if tries == 0
+    tries ||= @retries
+    tries -= 1
+    if tries.zero?
       raise if @options[:raise]
     else
       disconnect!
-      tries -= 1
       retry
     end
-  end  
+  rescue NoServersAvailable
+    raise if @options[:raise]
+  end
   
   def connect!
     server = next_server.to_s.split(":")
     raise ArgumentError, 'Servers must be in the form "host:port"' if server.size != 2
-
+    
     @transport = @options[:transport].new(
       Thrift::Socket.new(server.first, server.last.to_i, @options[:socket_timeout]))
     @transport.open
     @client = @client_class.new(@options[:protocol].new(@transport, false))
-  end
-  
-  def disconnect!
-    @transport.close rescue nil
-    @client = nil
-  end
-  
+  end  
+
   def next_server
-    @live_server_list = @server_list.dup if @live_server_list.empty?
+    if @live_server_list.empty?
+      if @options[:server_retry_period] and Time.now < @last_retry + @options[:server_retry_period]
+        raise NoServersAvailable, "No live servers in #{@server_list.inspect} since #{@last_retry.inspect}."
+      end
+      @last_retry = Time.now
+      @live_server_list = @server_list.dup
+    end
     @live_server_list.pop
-  end  
+  end
 end

data/test/test_helper.rb

@@ -1,5 +1,6 @@
 
 require 'test/unit'
-require "#{File.expand_path(File.dirname(__FILE__))}/../lib/thrift_client"
+$LOAD_PATH << "#{File.expand_path(File.dirname(__FILE__))}/../lib"
+require 'thrift_client'
 require 'scribe'
 begin; require 'ruby-debug'; rescue LoadError; end

data/test/thrift_client_test.rb

@@ -5,7 +5,7 @@ class ThriftClientTest < Test::Unit::TestCase
     @entry = [ScribeThrift::LogEntry.new(:message => "something", :category => "thrift_client")]
     @servers = ["127.0.0.1:1461", "127.0.0.1:1462", "127.0.0.1:1463"]
   end
-  
+
   def test_live_server
     assert_nothing_raised do
       ThriftClient.new(ScribeThrift::Client, @servers.last).Log(@entry)
@@ -17,13 +17,13 @@ class ThriftClientTest < Test::Unit::TestCase
       ThriftClient.new(ScribeThrift::Client, @servers, :randomize_server_list => false).Log(@entry)
     end
   end
-  
+
   def test_dont_raise
     assert_nothing_raised do
       ThriftClient.new(ScribeThrift::Client, @servers.first, :raise => false).Log(@entry)
-    end    
+    end
   end
-  
+
   def test_random_server_list
     @lists = []
     @lists << ThriftClient.new(ScribeThrift::Client, @servers).server_list while @lists.size < 10
@@ -35,16 +35,24 @@ class ThriftClientTest < Test::Unit::TestCase
       10.times { ThriftClient.new(ScribeThrift::Client, @servers).Log(@entry) }
     end
   end
-  
+
   def test_lazy_connection
     assert_nothing_raised do
       ThriftClient.new(ScribeThrift::Client, @servers[0,2])
-    end  
+    end
   end
-  
+
   def test_no_servers_eventually_raise
     assert_raises(Thrift::TransportException) do
       ThriftClient.new(ScribeThrift::Client, @servers[0,2]).Log(@entry)
     end
-  end  
+  end
+
+  def test_retry_period
+    client = ThriftClient.new(ScribeThrift::Client, @servers[0,2], :server_retry_period => 1)
+    assert_raises(Thrift::TransportException) { client.Log(@entry) }
+    assert_raises(ThriftClient::NoServersAvailable) { client.Log(@entry) }
+    sleep 1
+    assert_raises(Thrift::TransportException) { client.Log(@entry) }
+  end
 end

data/thrift_client.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{thrift_client}
-  s.version = "0.1"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0.8") if s.respond_to? :required_rubygems_version=
   s.authors = ["Evan Weaver"]
   s.cert_chain = ["/Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-public_cert.pem"]
-  s.date = %q{2009-10-13}
+  s.date = %q{2009-10-14}
   s.description = %q{A Thrift client wrapper that encapsulates some common failover behavior.}
   s.email = %q{}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/thrift_client.rb"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thrift_client
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: 0.1.1
 platform: ruby
 authors: 
 - Evan Weaver
@@ -30,7 +30,7 @@ cert_chain:
   yZ0=
   -----END CERTIFICATE-----
 
-date: 2009-10-13 00:00:00 -07:00
+date: 2009-10-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency