fl-thrift_client 0.4.2

data/CHANGELOG

@@ -0,0 +1,33 @@
+v0.4.2 Allow per-method overrides of retries. Fix several bugs with EventMachine.
+
+v0.4.1 Making ThriftClient decoratable. Able to add new functionality a class definition.
+
+v0.4.0. Add new EventMachine transport.  This requires two layers of transport
+configurability: 
+  options[:transport] for EventMachine or Socket transports
+  options[:transport_wrapper] for optional Buffered or Framed Transport.
+Clients will need to update their options to ensure they don't conflict with this change. (mperham)
+Revert global timeouts. (ryanking)
+Add support for HTTPClientTransport (Chris Sepic)
+
+v0.3.3. Allow for a timeout over all requests in a call.
+
+v0.3.2. Fix connection close bug (nkallen, mattknox).
+
+v0.3.1. Add ability to reset connection after N requests.
+
+v0.3. Change default timeout semantics; hash default was too sneaky. Fix bug.
+
+v0.2.2. Fix connect bug.
+
+v0.2.1. Don't turn off strict_read by default; allow override.
+
+v0.2. Add ThriftClient::Simple (Robey).
+
+v0.1.3. Define methods explicitly.
+
+v0.1.2. Support default responses.
+
+v0.1.1. Support server_retry_period.
+
+v0.1. First release.

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Manifest

@@ -0,0 +1,23 @@
+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

data/README.rdoc

@@ -0,0 +1,50 @@
+
+thrift_client
+
+A Thrift client wrapper that encapsulates some common failover behavior.
+
+== License
+
+Copyright 2009 Twitter, Inc. See included LICENSE file.
+
+The public certificate for this gem is here[http://blog.evanweaver.com/files/evan_weaver-original-public_cert.pem].
+
+== Features
+
+* Transparent connection management
+* Configurable failover and retry backoff
+* Ruby 1.9 compatibility
+* ThriftClient::Simple class, for working without generated bindings.
+
+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:
+
+  sudo gem install thrift_client
+
+== Contributing
+
+To contribute changes:
+
+1. Fork the project
+2. make your change, adding tests
+3. send a pull request to fauna and ryanking
+
+== Reporting problems
+
+The Github issue tracker is {here}[http://github.com/fauna/thrift_client/issues].
+

data/Rakefile

@@ -0,0 +1,16 @@
+
+require 'rubygems'
+require 'echoe'
+
+Echoe.new("thrift_client") do |p|
+  p.author = "Evan Weaver"
+  p.project = "fauna"
+  p.summary = "A Thrift client wrapper that encapsulates some common failover behavior."
+  p.rubygems_version = ">= 0.8"
+  p.dependencies = ['thrift']
+  p.ignore_pattern = /^(vendor\/thrift)/
+  p.rdoc_pattern = /^(lib|bin|tasks|ext)|^README|^CHANGELOG|^TODO|^LICENSE|^COPYING$/
+  p.url = "http://blog.evanweaver.com/files/doc/fauna/thrift_client/"
+  p.docs_host = "blog.evanweaver.com:~/www/bax/public/files/doc/"
+  p.spec_pattern = "spec/*_spec.rb"
+end

data/lib/thrift_client/abstract_thrift_client.rb

@@ -0,0 +1,217 @@
+class AbstractThriftClient
+
+  DEFAULTS = {
+    :protocol => Thrift::BinaryProtocol,
+    :protocol_extra_params => [],
+    :transport => Thrift::Socket,
+    :transport_wrapper => Thrift::FramedTransport,
+    :raise => true,
+    :defaults => {}
+  }.freeze
+
+  attr_reader :client, :client_class, :current_server, :server_list, :options, :client_methods
+
+  def initialize(client_class, servers, options = {})
+    @options = DEFAULTS.merge(options)
+    @client_class = client_class
+    @server_list = Array(servers)
+    @current_server = @server_list.first
+
+    @client_methods = []
+    @client_class.instance_methods.each do |method_name|
+      if method_name =~ /^recv_(.*)$/
+        instance_eval("def #{$1}(*args); handled_proxy(:'#{$1}', *args); end", __FILE__, __LINE__)
+        @client_methods << $1
+      end
+    end
+  end
+
+  def inspect
+    "<#{self.class}(#{client_class}) @current_server=#{@current_server}>"
+  end
+
+  # Force the client to connect to the server. Not necessary to be
+  # called as the connection will be made on the first RPC method
+  # call.
+  def connect!
+    @connection = Connection::Factory.create(@options[:transport], @options[:transport_wrapper], @current_server, @options[:timeout])
+    @connection.connect!
+    @client = @client_class.new(@options[:protocol].new(@connection.transport, *@options[:protocol_extra_params]))
+  rescue Thrift::TransportException, Errno::ECONNREFUSED => e
+    @transport.close rescue nil
+    raise e
+  end
+
+  def disconnect!
+    @connection.close rescue nil
+    @client = nil
+    @current_server = nil
+  end
+
+  private
+  def handled_proxy(method_name, *args)
+    proxy(method_name, *args)
+  rescue Exception => e
+    handle_exception(e, method_name, args)
+  end
+
+  def proxy(method_name, *args)
+    connect! unless @client
+    send_rpc(method_name, *args)
+  end
+
+  def send_rpc(method_name, *args)
+    @client.send(method_name, *args)
+  end
+
+  def disconnect_on_error!
+    @connection.close rescue nil
+    @client = nil
+    @current_server = nil
+  end
+
+  def handle_exception(e, method_name, args=nil)
+    raise e if @options[:raise]
+    @options[:defaults][method_name.to_sym]
+  end
+
+  module RetryingThriftClient
+    DISCONNECT_ERRORS = [
+                         IOError,
+                         Thrift::Exception,
+                         Thrift::ProtocolException,
+                         Thrift::ApplicationException,
+                         Thrift::TransportException
+                        ].freeze
+
+    RETRYING_DEFAULTS = {
+      :exception_classes => DISCONNECT_ERRORS,
+      :randomize_server_list => true,
+      :retries => nil,
+      :server_retry_period => 1,
+      :server_max_requests => nil,
+      :retry_overrides => {}
+    }.freeze
+
+    def initialize(client_class, servers, options = {})
+      super
+      @options = RETRYING_DEFAULTS.merge(@options) # @options is set by super
+      @retries = options[:retries] || @server_list.size
+      @request_count = 0
+      @max_requests = @options[:server_max_requests]
+      @retry_period = @options[:server_retry_period]
+      rebuild_live_server_list!
+    end
+
+    def connect!
+      @current_server = next_server
+      super
+    rescue Thrift::TransportException, Errno::ECONNREFUSED
+      retry
+    end
+
+    def disconnect!
+      # Keep live servers in the list if we have a retry period. Otherwise,
+      # always eject, because we will always re-add them.
+      if @retry_period && @current_server
+        @live_server_list.unshift(@current_server)
+      end
+
+      super()
+      @request_count = 0
+    end
+
+    private
+
+    def next_server
+      if @retry_period
+        rebuild_live_server_list! if Time.now > @last_rebuild + @retry_period
+        raise ThriftClient::NoServersAvailable, "No live servers in #{@server_list.inspect} since #{@last_rebuild.inspect}." if @live_server_list.empty?
+      elsif @live_server_list.empty?
+        rebuild_live_server_list!
+      end
+      @live_server_list.pop
+    end
+
+    def rebuild_live_server_list!
+      @last_rebuild = Time.now
+      if @options[:randomize_server_list]
+        @live_server_list = @server_list.sort_by { rand }
+      else
+        @live_server_list = @server_list.dup
+      end
+    end
+
+    def handled_proxy(method_name, *args)
+      disconnect_on_max! if @max_requests and @request_count >= @max_requests
+      super
+    end
+
+    def proxy(method_name, *args)
+      super
+    rescue *@options[:exception_classes] => e
+      disconnect_on_error!
+      tries ||= (@options[:retry_overrides][method_name.to_sym] || @retries)
+      tries -= 1
+      tries == 0 ? handle_exception(e, method_name, args) : retry
+    end
+
+    def send_rpc(method_name, *args)
+      @request_count += 1
+      super
+    end
+
+    def disconnect_on_max!
+      @live_server_list.push(@current_server)
+      disconnect_on_error!
+    end
+
+    def disconnect_on_error!
+      super
+      @request_count = 0
+    end
+
+  end
+
+  module TimingOutThriftClient
+    TIMINGOUT_DEFAULTS = {
+      :timeout => 1,
+      :timeout_overrides => {}
+    }.freeze
+
+    def initialize(client_class, servers, options = {})
+      super
+      @options = TIMINGOUT_DEFAULTS.merge(@options)
+    end
+
+    def connect!
+      super
+      set_method_timeouts!
+    end
+
+    private
+    def set_method_timeouts!
+      return unless has_timeouts?
+      @client_methods.each do |method_name|
+        @client.timeout = @options[:timeout_overrides][method_name.to_sym] || @options[:timeout]
+      end
+    end
+
+    def has_timeouts?
+      @has_timeouts ||= has_timeouts!
+    end
+
+    def has_timeouts!
+      @options[:timeout_overrides].any? && transport_can_timeout?
+    end
+
+    def transport_can_timeout?
+      if (@options[:transport_wrapper] || @options[:transport]).method_defined?(:timeout=)
+        true
+      else
+        warn "ThriftClient: Timeout overrides have no effect with with transport type #{(@options[:transport_wrapper] || @options[:transport])}"
+        false
+      end
+    end
+  end
+end

data/lib/thrift_client/connection/base.rb

@@ -0,0 +1,19 @@
+module Connection
+  class Base
+    attr_accessor :transport, :server
+
+    def initialize(transport, transport_wrapper, server, timeout)
+      @transport = transport
+      @transport_wrapper = transport_wrapper
+      @server = server
+      @timeout = timeout
+    end
+
+    def connect!
+      raise NotImplementedError
+    end
+
+    def close
+    end
+  end
+end

data/lib/thrift_client/connection/factory.rb

@@ -0,0 +1,11 @@
+module Connection
+  class Factory
+    def self.create(transport, transport_wrapper, server, timeout)
+      if transport == Thrift::HTTPClientTransport
+        Connection::HTTP.new(transport, transport_wrapper, server, timeout)
+      else
+        Connection::Socket.new(transport, transport_wrapper, server, timeout)
+      end
+    end
+  end
+end

data/lib/thrift_client/connection/http.rb

@@ -0,0 +1,18 @@
+module Connection
+  class HTTP < Base
+    def connect!
+      uri = parse_server(@server)
+      @transport = Thrift::HTTPClientTransport.new(@server)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.get(uri.path)
+    end
+
+  private
+    def parse_server(server)
+      uri = URI.parse(server)
+      raise ArgumentError, 'Servers must start with http' unless uri.scheme =~ /^http/
+      uri
+    end
+  end
+end

data/lib/thrift_client/connection/socket.rb

@@ -0,0 +1,22 @@
+module Connection
+  class Socket < Base
+    def close
+      @transport.close
+    end
+
+    def connect!
+      host, port = parse_server(@server)
+      @transport = @transport.new(*[host, port.to_i, @timeout])
+      @transport = @transport_wrapper.new(@transport) if @transport_wrapper
+      @transport.open
+    end
+
+  private
+
+    def parse_server(server)
+      host, port = server.to_s.split(":")
+      raise ArgumentError, 'Servers must be in the form "host:port"' unless host and port
+      [host, port]
+    end
+  end
+end

data/lib/thrift_client/connection.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/connection")
+require "base"
+require "socket"
+require "http"
+require "factory"