thrift_client 0.7.0 → 0.7.1

data/CHANGELOG

@@ -1,3 +1,6 @@
+v0.7.1 Added support for :before_method and :on_exception callback types.
+Added support for registering multiple callbacks of a given type.
+
 v0.7.0 Updated thrift gem dependency to 0.7.0
 
 v0.6.3 Document the :connect_timeout option.

data/lib/thrift_client/abstract_thrift_client.rb

@@ -72,9 +72,19 @@ class AbstractThriftClient
     end
   end
 
-  def add_callback(cb, &blk)
-    if cb == :post_connect
-      @callbacks[cb] = blk
+  # Adds a callback that will be invoked at a certain time. The valid callback types are:
+  #   :post_connect  - should accept a single AbstractThriftClient argument, which is the client object to
+  #                    which the callback was added. Called after a connection to the remote thrift server
+  #                    is established.
+  #   :before_method - should accept a single method name argument. Called before a method is invoked on the
+  #                    thrift server.
+  #   :on_exception  - should accept 2 args: an Exception instance and a method name. Called right before the
+  #                    exception is raised.
+  def add_callback(callback_type, &block)
+    case callback_type
+    when :post_connect, :before_method, :on_exception
+      @callbacks[callback_type] ||= []
+      @callbacks[callback_type].push(block)
       # Allow chaining
       return self
     else
@@ -96,7 +106,7 @@ class AbstractThriftClient
     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]
+    do_callbacks(:post_connect, self)
   end
 
   def disconnect!
@@ -108,6 +118,14 @@ class AbstractThriftClient
 
   private
 
+  # Calls all callbacks of the specified type with the given args
+  def do_callbacks(callback_type_sym, *args)
+    return unless @callbacks[callback_type_sym]
+    @callbacks[callback_type_sym].each do |callback|
+      callback.call(*args)
+    end
+  end
+
   def next_live_server
     @server_index ||= 0
     @server_list.length.times do |i|
@@ -128,6 +146,7 @@ class AbstractThriftClient
         @client.timeout = @options[:timeout_overrides][method_name.to_sym] || @options[:timeout]
       end
       @request_count += 1
+      do_callbacks(:before_method, method_name)
       @client.send(method_name, *args)
     rescue *@options[:exception_class_overrides] => e
       raise_or_default(e, method_name)
@@ -147,13 +166,14 @@ class AbstractThriftClient
 
   def raise_or_default(e, method_name)
     if @options[:raise]
-      raise_wrapped_error(e)
+      raise_wrapped_error(e, method_name)
     else
       @options[:defaults][method_name.to_sym]
     end
   end
 
-  def raise_wrapped_error(e)
+  def raise_wrapped_error(e, method_name)
+    do_callbacks(:on_exception, e, method_name)
     if @options[:wrapped_exception_classes].include?(e.class)
       raise @client_class.const_get(e.class.to_s.split('::').last), e.message, e.backtrace
     else

data/test/thrift_client_test.rb

@@ -98,6 +98,35 @@ class ThriftClientTest < Test::Unit::TestCase
     assert_equal(1, calledcnt)
   end
 
+  def test_before_method_cb
+    before_method_counts = Hash.new { |hash, key| hash[key] = 0 }
+    client = ThriftClient.new(Greeter::Client, @servers, @options.merge(:retries => 2))
+    r = client.add_callback :before_method do |method_name|
+      before_method_counts[method_name.to_sym] += 1
+    end
+    assert_equal(client, r)
+    assert_nothing_raised do
+      client.greeting("someone")
+      client.yo("dude")
+      client.yo("dawg")
+      client.disconnect!
+    end
+    assert_equal({:greeting => 1, :yo => 2}, before_method_counts)
+  end
+
+  def test_on_exception_cb
+    on_exception_counts = Hash.new { |h1, method_name| h1[method_name] = Hash.new { |h2, clazz| h2[clazz] = 0 }}
+    client = ThriftClient.new(Greeter::Client, @servers[0,2], @options.merge(:retries => 2))
+    r = client.add_callback :on_exception do |error, method_name|
+      on_exception_counts[method_name.to_sym][error.class] += 1
+    end
+    assert_equal(client, r)
+    assert_raises(ThriftClient::NoServersAvailable) do
+      client.greeting("someone")
+      client.disconnect!
+    end
+    assert_equal({:greeting => {ThriftClient::NoServersAvailable => 1}}, on_exception_counts)
+  end
 
   def test_unknown_cb
     calledcnt = 0
@@ -108,6 +137,23 @@ class ThriftClientTest < Test::Unit::TestCase
     assert_equal(nil, r)
   end
 
+  def test_multiple_cb
+    calledcnt = 0
+    client = ThriftClient.new(Greeter::Client, @servers, @options.merge(:retries => 2))
+    2.times do |i|
+      r = client.add_callback :post_connect do |cl|
+        calledcnt += 1
+        assert_equal(client, cl)
+      end
+      assert_equal(client, r)
+    end
+    assert_nothing_raised do
+      client.greeting("someone")
+      client.disconnect!
+    end
+    assert_equal(2, calledcnt)
+  end
+
   def test_no_servers_eventually_raise
     wascalled = false
     client = ThriftClient.new(Greeter::Client, @servers[0,2], @options.merge(:retries => 2))

data/thrift_client.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{thrift_client}
-  s.version = "0.7.0"
+  s.version = "0.7.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0.8") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Evan Weaver, Ryan King, Jeff Hodges}]
-  s.date = %q{2011-08-22}
+  s.date = %q{2011-09-02}
   s.description = %q{A Thrift client wrapper that encapsulates some common failover behavior.}
   s.email = %q{}
   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}]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: thrift_client
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 0
   - 7
-  - 0
-  version: 0.7.0
+  - 1
+  version: 0.7.1
 platform: ruby
 authors: 
 - Evan Weaver, Ryan King, Jeff Hodges
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-22 00:00:00 Z
+date: 2011-09-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thrift