thrift_client 0.1.1 → 0.1.2

data/CHANGELOG

@@ -1,4 +1,6 @@
 
+v0.1.2. Support default responses.
+
 v0.1.1. Support server_retry_period.
 
 v0.1. First release.

data/Manifest

@@ -4,5 +4,6 @@ Manifest
 README
 Rakefile
 lib/thrift_client.rb
+lib/thrift_client/thrift.rb
 test/test_helper.rb
 test/thrift_client_test.rb

data/README

@@ -11,11 +11,24 @@ The public certificate for this gem is here[http://rubyforge.org/frs/download.ph
 
 == Features
 
-* clean encapsulation of the Thrift API
+* Transparent connection management
+* Configurable failover and retry backoff
 * Ruby 1.9 compatibility
 
 The Github source repository is {here}[http://github.com/fauna/thrift_client/]. Patches and contributions are very welcome.
 
+== Usage
+
+Instantiate a client:
+
+  client = ThriftClient.new(CassandraRb::Client, '127.0.0.1:9160', :retries => 2)
+
+You can then make calls to the server via the <tt>client</tt> instance as if was your internal Thrift client. The connection will be opened lazily and methods will be proxied through.
+
+  client.get_string_list_property("keyspaces")
+  
+On failures, the client will try the remaining servers in the list before giving up. See ThriftClient for more.
+
 == Installation
 
 You need Ruby 1.8 or 1.9. If you have those, just run:

data/lib/thrift_client/thrift.rb

@@ -0,0 +1,22 @@
+
+module Thrift
+  class BufferedTransport
+    def timeout=(timeout)
+      @transport.timeout = timeout
+    end
+  
+    def timeout
+      @transport.timeout
+    end
+  end
+  
+  module Client
+    def timeout=(timeout)
+      @iprot.trans.timeout = timeout
+    end
+  
+    def timeout
+      @iprot.trans.timeout
+    end
+  end
+end

data/lib/thrift_client.rb

@@ -1,28 +1,47 @@
 
 require 'rubygems'
 require 'thrift'
+require 'thrift_client/thrift'
 
 class ThriftClient
 
+  class NoServersAvailable < StandardError; end
+
   DEFAULTS = {
     :protocol => Thrift::BinaryProtocol,
     :transport => Thrift::FramedTransport,
-    :socket_timeout => 1,
     :randomize_server_list => true,
     :exception_classes => [
       IOError,
       Thrift::Exception,
       Thrift::ProtocolException,
       Thrift::ApplicationException,
-      Thrift::TransportException],
+      Thrift::TransportException,
+      NoServersAvailable],
     :raise => true,
     :retries => nil,
-    :server_retry_period => nil
+    :server_retry_period => nil,
+    :timeouts => Hash.new(1),
+    :defaults => {}
   }.freeze
 
   attr_reader :client, :client_class, :server_list, :options
 
-  class NoServersAvailable < StandardError; end
+=begin rdoc
+Create a new ThriftClient instance. Accepts an internal Thrift client class (such as CassandraRb::Client), a list of servers with ports, and optional parameters.
+
+Valid optional parameters are:
+
+<tt>:protocol</tt>:: Which Thrift protocol to use. Defaults to <tt>Thrift::BinaryProtocol</tt>.
+<tt>:transport</tt>:: Which Thrift transport to use. Defaults to <tt>Thrift::FramedTransport</tt>.
+<tt>:randomize_server_list</tt>:: Whether to connect to the servers randomly, instead of in order. Defaults to <tt>true</tt>.
+<tt>:raise</tt>:: Whether to reraise errors if no responsive servers are found. Defaults to <tt>true</tt>.
+<tt>:retries</tt>:: How many times to retry a request. Defaults to the number of servers defined.
+<tt>:server_retry_period</tt>:: How long to wait before trying to reconnect after marking all servers as down. Defaults to <tt>nil</tt> (do not wait).
+<tt>:timeouts</tt>:: Specify timeouts on a per-method basis. Defaults to 1 second for everything. (Per-method values only work with <tt>Thrift::BufferedTransport</tt>.)
+<tt>:defaults</tt>:: Specify defaults to return on a per-method basis, if <tt>:raise</tt> is set to false.
+
+=end rdoc
 
   def initialize(client_class, servers, options = {})
     @options = DEFAULTS.merge(options)
@@ -31,10 +50,12 @@ class ThriftClient
     @retries = options[:retries] || @server_list.size
     @server_list = @server_list.sort_by { rand } if @options[:randomize_server_list]
 
+    @set_timeout = @options[:transport].instance_methods.include?("timeout=")
     @live_server_list = @server_list.dup
     @last_retry = Time.now
   end
 
+  # Force the client to disconnect from the server.
   def disconnect!
     @transport.close rescue nil
     @client = nil
@@ -42,31 +63,39 @@ class ThriftClient
 
   private
 
-  def method_missing(*args)
+  def method_missing(method_name, *args)
     connect! unless @client
-    @client.send(*args)
-  rescue *@options[:exception_classes]
+    set_timeout!(method_name) if @set_timeout
+    @client.send(method_name, *args)
+  rescue *@options[:exception_classes] => e
     tries ||= @retries
     tries -= 1
-    if tries.zero?
-      raise if @options[:raise]
+    if tries.zero? or e.is_a?(NoServersAvailable)
+      handle_exception(e, method_name, args)
     else
       disconnect!
       retry
     end
-  rescue NoServersAvailable
-    raise if @options[:raise]
   end
   
+  def set_timeout!(method_name)
+    @client.timeout = @options[:timeouts][:method_name.to_sym]
+  end
+  
+  def handle_exception(e, method_name, args)
+    raise e if @options[:raise]
+    @options[:defaults][method_name.to_sym]
+  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]))
+      Thrift::Socket.new(server.first, server.last.to_i, @options[:timeouts].default))
     @transport.open
     @client = @client_class.new(@options[:protocol].new(@transport, false))
-  end  
+  end
 
   def next_server
     if @live_server_list.empty?

data/test/thrift_client_test.rb

@@ -23,13 +23,23 @@ class ThriftClientTest < Test::Unit::TestCase
       ThriftClient.new(ScribeThrift::Client, @servers.first, :raise => false).Log(@entry)
     end
   end
+  
+  def test_dont_raise_with_defaults
+    client = ThriftClient.new(ScribeThrift::Client, @servers.first, :raise => false,  :defaults => {:Log => 1})
+    assert_equal 1, client.Log(@entry)
+  end
+  
+  def test_defaults_dont_override_no_method_error
+    client = ThriftClient.new(ScribeThrift::Client, @servers, :raise => false,  :defaults => {:Missing => 2})
+    assert_raises(NoMethodError) { client.Missing(@entry) }  
+  end
 
   def test_random_server_list
     @lists = []
     @lists << ThriftClient.new(ScribeThrift::Client, @servers).server_list while @lists.size < 10
     assert @lists.uniq.size > 1
   end
-
+  
   def test_random_fall_through
     assert_nothing_raised do
       10.times { ThriftClient.new(ScribeThrift::Client, @servers).Log(@entry) }

data/thrift_client.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{thrift_client}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   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-14}
+  s.date = %q{2009-10-19}
   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"]
-  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "lib/thrift_client.rb", "test/test_helper.rb", "test/thrift_client_test.rb", "thrift_client.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/thrift_client.rb", "lib/thrift_client/thrift.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "lib/thrift_client.rb", "lib/thrift_client/thrift.rb", "test/test_helper.rb", "test/thrift_client_test.rb", "thrift_client.gemspec"]
   s.homepage = %q{http://blog.evanweaver.com/files/doc/fauna/thrift_client/}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Thrift_client", "--main", "README"]
   s.require_paths = ["lib"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thrift_client
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Evan Weaver
@@ -30,7 +30,7 @@ cert_chain:
   yZ0=
   -----END CERTIFICATE-----
 
-date: 2009-10-14 00:00:00 -07:00
+date: 2009-10-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,6 +54,7 @@ extra_rdoc_files:
 - LICENSE
 - README
 - lib/thrift_client.rb
+- lib/thrift_client/thrift.rb
 files: 
 - CHANGELOG
 - LICENSE
@@ -61,6 +62,7 @@ files:
 - README
 - Rakefile
 - lib/thrift_client.rb
+- lib/thrift_client/thrift.rb
 - test/test_helper.rb
 - test/thrift_client_test.rb
 - thrift_client.gemspec