thrift_client 0.6.2 → 0.6.3

data/CHANGELOG

@@ -1,3 +1,11 @@
+v0.6.3 Document the :connect_timeout option.
+Add support for specifying client-side timeouts when using FramedTransport
+set transport timeout after connection is established
+Add a method `add_callback` allowing a client to register a block that is invoked at a certain event.
+Fixup socket timeouts.
+
+
+
 v0.6.2 Remove lingering thrift v0.5.0 reference.
 
 v0.6.1 Add connect timeout. Bump thrift dependency to ~> v0.6.0.

data/lib/thrift_client.rb

@@ -21,6 +21,7 @@ Valid optional parameters are:
 <tt>:server_retry_period</tt>:: How many seconds to wait before trying to reconnect to a dead server. Defaults to <tt>1</tt>. Set to <tt>nil</tt> to disable.
 <tt>:server_max_requests</tt>:: How many requests to perform before moving on to the next server in the pool, regardless of error status. Defaults to <tt>nil</tt> (no limit).
 <tt>:timeout</tt>:: Specify the default timeout in seconds. Defaults to <tt>1</tt>.
+<tt>:connect_timeout</tt>:: Specify the connection timeout in seconds. Defaults to <tt>0.1</tt>.
 <tt>:timeout_overrides</tt>:: Specify additional timeouts on a per-method basis, in seconds. Only works with <tt>Thrift::BufferedTransport</tt>.
 <tt>:defaults</tt>:: Specify default values to return on a per-method basis, if <tt>:raise</tt> is set to false.
 =end rdoc

data/lib/thrift_client/abstract_thrift_client.rb

@@ -52,6 +52,7 @@ class AbstractThriftClient
     @server_list = Array(servers).collect{|s| Server.new(s)}.sort_by { rand }
     @current_server = @server_list.first
 
+    @callbacks = {}
     @client_methods = []
     @client_class.instance_methods.each do |method_name|
       if method_name != 'send_message' && method_name =~ /^send_(.*)$/
@@ -70,6 +71,16 @@ class AbstractThriftClient
     end
   end
 
+  def add_callback(cb, &blk)
+    if cb == :post_connect
+      @callbacks[cb] = blk
+      # Allow chaining
+      return self
+    else
+      return nil
+    end
+  end
+
   def inspect
     "<#{self.class}(#{client_class}) @current_server=#{@current_server}>"
   end
@@ -81,7 +92,10 @@ class AbstractThriftClient
     @current_server = next_live_server
     @connection = Connection::Factory.create(@options[:transport], @options[:transport_wrapper], @current_server.connection_string, @options[:connect_timeout])
     @connection.connect!
-    @client = @client_class.new(@options[:protocol].new(@connection.transport, *@options[:protocol_extra_params]))
+    transport = @connection.transport
+    transport.timeout = @options[:timeout] if transport_can_timeout?
+    @client = @client_class.new(@options[:protocol].new(transport, *@options[:protocol_extra_params]))
+    @callbacks[:post_connect].call(self) if @callbacks[:post_connect]
   end
 
   def disconnect!

data/lib/thrift_client/thrift.rb

@@ -1,4 +1,13 @@
 module Thrift
+  class BaseTransport
+    def timeout=(timeout)
+    end
+
+    def timeout
+      nil
+    end
+  end
+
   class BufferedTransport
     def timeout=(timeout)
       @transport.timeout = timeout
@@ -9,6 +18,16 @@ module Thrift
     end
   end
 
+  class FramedTransport
+    def timeout=(timeout)
+      @transport.timeout = timeout
+    end
+
+    def timeout
+      @transport.timeout
+    end
+  end
+  
   module Client
     def timeout=(timeout)
       @iprot.trans.timeout = timeout

data/test/test_helper.rb

@@ -1,4 +1,4 @@
-
+require 'rubygems'
 require 'test/unit'
 require 'benchmark'
 $LOAD_PATH << "#{File.expand_path(File.dirname(__FILE__))}/../lib"

data/test/thrift_client_test.rb

@@ -83,12 +83,42 @@ class ThriftClientTest < Test::Unit::TestCase
     end
   end
 
+  def test_post_conn_cb
+    calledcnt = 0
+    client = ThriftClient.new(Greeter::Client, @servers, @options.merge(:retries => 2))
+    r = client.add_callback :post_connect do |cl|
+      calledcnt += 1
+      assert_equal(client, cl)
+    end
+    assert_equal(client, r)
+    assert_nothing_raised do
+      client.greeting("someone")
+      client.disconnect!
+    end
+    assert_equal(1, calledcnt)
+  end
+
+
+  def test_unknown_cb
+    calledcnt = 0
+    client = ThriftClient.new(Greeter::Client, @servers, @options.merge(:retries => 2))
+    r = client.add_callback :unknown do |cl|
+      assert(false)
+    end
+    assert_equal(nil, r)
+  end
+
   def test_no_servers_eventually_raise
+    wascalled = false
     client = ThriftClient.new(Greeter::Client, @servers[0,2], @options.merge(:retries => 2))
+    client.add_callback :post_connect do
+      wascalled = true
+    end
     assert_raises(ThriftClient::NoServersAvailable) do
       client.greeting("someone")
       client.disconnect!
     end
+    assert(!wascalled)
   end
 
   def test_socket_timeout
@@ -100,7 +130,7 @@ class ThriftClientTest < Test::Unit::TestCase
             ).greeting("someone")
         end
       end
-      assert(measurement.real > 0.5 && measurement.real < 1)
+      assert(measurement.real > 0.5 && measurement.real < 1.05)
     end
   end
 

data/thrift_client.gemspec

@@ -2,22 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{thrift_client}
-  s.version = "0.6.2"
+  s.version = "0.6.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0.8") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Evan Weaver, Ryan King, Jeff Hodges"]
-  s.date = %q{2011-05-09}
+  s.authors = [%q{Evan Weaver, Ryan King, Jeff Hodges}]
+  s.date = %q{2011-06-30}
   s.description = %q{A Thrift client wrapper that encapsulates some common failover behavior.}
   s.email = %q{}
-  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.rdoc", "lib/thrift_client.rb", "lib/thrift_client/abstract_thrift_client.rb", "lib/thrift_client/connection.rb", "lib/thrift_client/connection/base.rb", "lib/thrift_client/connection/factory.rb", "lib/thrift_client/connection/http.rb", "lib/thrift_client/connection/socket.rb", "lib/thrift_client/event_machine.rb", "lib/thrift_client/simple.rb", "lib/thrift_client/thrift.rb"]
-  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.rdoc", "Rakefile", "lib/thrift_client.rb", "lib/thrift_client/abstract_thrift_client.rb", "lib/thrift_client/connection.rb", "lib/thrift_client/connection/base.rb", "lib/thrift_client/connection/factory.rb", "lib/thrift_client/connection/http.rb", "lib/thrift_client/connection/socket.rb", "lib/thrift_client/event_machine.rb", "lib/thrift_client/simple.rb", "lib/thrift_client/thrift.rb", "test/greeter/greeter.rb", "test/greeter/greeter.thrift", "test/greeter/server.rb", "test/multiple_working_servers_test.rb", "test/simple_test.rb", "test/test_helper.rb", "test/thrift_client_http_test.rb", "test/thrift_client_test.rb", "thrift_client.gemspec"]
+  s.extra_rdoc_files = [%q{CHANGELOG}, %q{LICENSE}, %q{README.rdoc}, %q{lib/thrift_client.rb}, %q{lib/thrift_client/abstract_thrift_client.rb}, %q{lib/thrift_client/connection.rb}, %q{lib/thrift_client/connection/base.rb}, %q{lib/thrift_client/connection/factory.rb}, %q{lib/thrift_client/connection/http.rb}, %q{lib/thrift_client/connection/socket.rb}, %q{lib/thrift_client/event_machine.rb}, %q{lib/thrift_client/simple.rb}, %q{lib/thrift_client/thrift.rb}]
+  s.files = [%q{CHANGELOG}, %q{LICENSE}, %q{Manifest}, %q{README.rdoc}, %q{Rakefile}, %q{lib/thrift_client.rb}, %q{lib/thrift_client/abstract_thrift_client.rb}, %q{lib/thrift_client/connection.rb}, %q{lib/thrift_client/connection/base.rb}, %q{lib/thrift_client/connection/factory.rb}, %q{lib/thrift_client/connection/http.rb}, %q{lib/thrift_client/connection/socket.rb}, %q{lib/thrift_client/event_machine.rb}, %q{lib/thrift_client/simple.rb}, %q{lib/thrift_client/thrift.rb}, %q{test/greeter/greeter.rb}, %q{test/greeter/greeter.thrift}, %q{test/greeter/server.rb}, %q{test/multiple_working_servers_test.rb}, %q{test/simple_test.rb}, %q{test/test_helper.rb}, %q{test/thrift_client_http_test.rb}, %q{test/thrift_client_test.rb}, %q{thrift_client.gemspec}]
   s.homepage = %q{http://fauna.github.com/fauna/thrift_client/}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Thrift_client", "--main", "README.rdoc"]
-  s.require_paths = ["lib"]
+  s.rdoc_options = [%q{--line-numbers}, %q{--inline-source}, %q{--title}, %q{Thrift_client}, %q{--main}, %q{README.rdoc}]
+  s.require_paths = [%q{lib}]
   s.rubyforge_project = %q{fauna}
-  s.rubygems_version = %q{1.7.2}
+  s.rubygems_version = %q{1.8.5}
   s.summary = %q{A Thrift client wrapper that encapsulates some common failover behavior.}
-  s.test_files = ["test/multiple_working_servers_test.rb", "test/simple_test.rb", "test/test_helper.rb", "test/thrift_client_http_test.rb", "test/thrift_client_test.rb"]
+  s.test_files = [%q{test/multiple_working_servers_test.rb}, %q{test/simple_test.rb}, %q{test/test_helper.rb}, %q{test/thrift_client_http_test.rb}, %q{test/thrift_client_test.rb}]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: thrift_client
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 0
   - 6
-  - 2
-  version: 0.6.2
+  - 3
+  version: 0.6.3
 platform: ruby
 authors: 
 - Evan Weaver, Ryan King, Jeff Hodges
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-09 00:00:00 Z
+date: 2011-06-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thrift
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: fauna
-rubygems_version: 1.7.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: A Thrift client wrapper that encapsulates some common failover behavior.