bertrpc 1.0.0 → 1.1.0

data/History.txt

@@ -1,3 +1,6 @@
+= 1.1.0 / 2009-10-27
+  * Add read socket timeout
+
 = 1.0.0 / 2009-10-19
   * No changes. Production ready!
 

data/README.md

@@ -3,7 +3,8 @@ BERTRPC
 
 By Tom Preston-Werner (tom@mojombo.com)
 
-BERT-RPC client library for Ruby. Makes it ridiculously simple to interface with BERT-RPC servers.
+BERT-RPC client library for Ruby. Makes it ridiculously simple to interface
+with BERT-RPC servers.
 
 See the full BERT-RPC specification at [bert-rpc.org](http://bert-rpc.org).
 
@@ -12,7 +13,9 @@ This library currently only supports the following BERT-RPC features:
 * `call` requests
 * `cast` requests
 
-BERTRPC was developed for GitHub and is currently in production use performing millions of RPC requests every day. The stability and performance have been exemplary.
+BERTRPC was developed for GitHub and is currently in production use performing
+millions of RPC requests every day. The stability and performance have been
+exemplary.
 
 
 Installation
@@ -50,6 +53,18 @@ The underlying BERT-RPC transaction of the above cast is:
     <- {noreply}
 
 
+Documentation
+-------------
+
+Creating a service:
+
+    # No timeout
+    svc = BERTRPC::Service.new('localhost', 9999)
+    
+    # 10s socket read timeout, raises BERTRPC::ReadTimeoutError
+    svc = BERTRPC::Service.new('localhost', 9999, 10)
+
+
 Copyright
 ---------
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/bertrpc.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bertrpc}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tom Preston-Werner"]
-  s.date = %q{2009-10-19}
+  s.date = %q{2009-10-27}
   s.email = %q{tom@mojombo.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
      "bertrpc.gemspec",
      "lib/bertrpc.rb",
      "lib/bertrpc/action.rb",
+     "lib/bertrpc/buffered_io.rb",
      "lib/bertrpc/encodes.rb",
      "lib/bertrpc/errors.rb",
      "lib/bertrpc/mod.rb",

data/lib/bertrpc/action.rb

@@ -24,7 +24,7 @@ module BERTRPC
     end
 
     def transaction(bert_request)
-      sock = TCPSocket.new(@svc.host, @svc.port)
+      sock = connect_to(@svc.host, @svc.port, @svc.timeout)
 
       if @req.options
         if @req.options[:cache] && @req.options[:cache][0] == :validation
@@ -44,6 +44,22 @@ module BERTRPC
       bert_response
     rescue Errno::ECONNREFUSED
       raise ConnectionError.new("Unable to connect to #{@svc.host}:#{@svc.port}")
+    rescue Timeout::Error
+      raise ReadTimeoutError.new("No response from #{@svc.host}:#{@svc.port} in #{@svc.timeout}s")
+    end
+
+    # Creates a socket object which does speedy, non-blocking reads
+    # and can perform reliable read timeouts.
+    #
+    # Raises Timeout::Error on timeout.
+    #
+    #   +host+ String address of the target TCP server
+    #   +port+ Integer port of the target TCP server
+    #   +timeout+ Optional Integer (in seconds) of the read timeout
+    def connect_to(host, port, timeout = nil)
+      io = BufferedIO.new(TCPSocket.new(host, port))
+      io.read_timeout = timeout
+      io
     end
   end
-end
+end

data/lib/bertrpc/buffered_io.rb

@@ -0,0 +1,28 @@
+module BERTRPC
+  # Taken with love from memcache-client.
+  #
+  # See http://is.gd/4CWRA for the code and
+  # http://is.gd/4CYde for the discussion.
+  class BufferedIO < Net::BufferedIO # :nodoc:
+    BUFSIZE = 1024 * 16
+
+    if RUBY_VERSION < '1.9.1'
+      def rbuf_fill
+        begin
+          @rbuf << @io.read_nonblock(BUFSIZE)
+        rescue Errno::EWOULDBLOCK
+          retry unless @read_timeout
+          if IO.select([@io], nil, nil, @read_timeout)
+            retry
+          else
+            raise Timeout::Error, 'IO timeout'
+          end
+        end
+      end
+    end
+
+    def setsockopt(*args)
+      @io.setsockopt(*args)
+    end
+  end
+end

data/lib/bertrpc/errors.rb

@@ -28,6 +28,10 @@ module BERTRPC
 
   end
 
+  class ReadTimeoutError < BERTRPCError
+
+  end
+
   class ProtocolError < BERTRPCError
     NO_HEADER = [0, "Unable to read length header from server."]
     NO_DATA = [1, "Unable to read data from server."]

data/lib/bertrpc/service.rb

@@ -1,10 +1,11 @@
 module BERTRPC
   class Service
-    attr_accessor :host, :port
+    attr_accessor :host, :port, :timeout
 
-    def initialize(host, port)
+    def initialize(host, port, timeout = nil)
       @host = host
       @port = port
+      @timeout = timeout
     end
 
     def call(options = nil)
@@ -31,4 +32,4 @@ module BERTRPC
       end
     end
   end
-end
+end

data/lib/bertrpc.rb

@@ -1,9 +1,11 @@
 require 'bert'
 require 'socket'
+require 'net/protocol'
 
 require 'bertrpc/service'
 require 'bertrpc/request'
 require 'bertrpc/mod'
 require 'bertrpc/encodes'
 require 'bertrpc/action'
-require 'bertrpc/errors'
+require 'bertrpc/errors'
+require 'bertrpc/buffered_io'

data/test/action_test.rb

@@ -49,7 +49,7 @@ class ActionTest < Test::Unit::TestCase
         @req = @svc.call
         @call = BERTRPC::Action.new(@svc, @req, :mymod, :myfun, [])
       end
-    
+
       should "read and write BERT-Ps from the socket" do
         io = stub()
         io.expects(:write).with("\000\000\000\003")
@@ -57,7 +57,7 @@ class ActionTest < Test::Unit::TestCase
         io.expects(:read).with(4).returns("\000\000\000\003")
         io.expects(:read).with(3).returns("bar")
         io.expects(:close)
-        TCPSocket.expects(:new).returns(io)
+        @call.expects(:connect_to).returns(io)
         assert_equal "bar", @call.transaction("foo")
       end
 
@@ -66,7 +66,7 @@ class ActionTest < Test::Unit::TestCase
         io.expects(:write).with("\000\000\000\003")
         io.expects(:write).with("foo")
         io.expects(:read).with(4).returns(nil)
-        TCPSocket.expects(:new).returns(io)
+        @call.expects(:connect_to).returns(io)
         begin
           @call.transaction("foo")
           fail "Should have thrown an error"
@@ -74,14 +74,14 @@ class ActionTest < Test::Unit::TestCase
           assert_equal 0, e.code
         end
       end
-      
+
       should "raise a ProtocolError when the data is invalid" do
         io = stub()
         io.expects(:write).with("\000\000\000\003")
         io.expects(:write).with("foo")
         io.expects(:read).with(4).returns("\000\000\000\003")
         io.expects(:read).with(3).returns(nil)
-        TCPSocket.expects(:new).returns(io)
+        @call.expects(:connect_to).returns(io)
          begin
           @call.transaction("foo")
           fail "Should have thrown an error"
@@ -89,6 +89,20 @@ class ActionTest < Test::Unit::TestCase
           assert_equal 1, e.code
         end
       end
+
+      should "raise a ReadTimeoutError when the connection times out" do
+        io = stub()
+        io.expects(:write).with("\000\000\000\003")
+        io.expects(:write).with("foo")
+        io.expects(:read).with(4).raises(Timeout::Error)
+        @call.expects(:connect_to).returns(io)
+        begin
+          @call.transaction("foo")
+          fail "Should have thrown an error"
+        rescue BERTRPC::ReadTimeoutError => e
+          assert_equal 0, e.code
+        end
+      end
     end
   end
-end
+end

data/test/service_test.rb

@@ -2,10 +2,15 @@ require 'test_helper'
 
 class ServiceTest < Test::Unit::TestCase
   context "A Service" do
-    should "be created with host and port" do
+    should "be creatable with host and port" do
       svc = BERTRPC::Service.new('localhost', 9941)
       assert svc.is_a?(BERTRPC::Service)
     end
+
+    should "be creatable with host, port, and timeout" do
+      svc = BERTRPC::Service.new('localhost', 9941, 5)
+      assert svc.is_a?(BERTRPC::Service)
+    end
   end
 
   context "A Service Instance's" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bertrpc
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Tom Preston-Werner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-19 00:00:00 -07:00
+date: 2009-10-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,7 @@ files:
 - bertrpc.gemspec
 - lib/bertrpc.rb
 - lib/bertrpc/action.rb
+- lib/bertrpc/buffered_io.rb
 - lib/bertrpc/encodes.rb
 - lib/bertrpc/errors.rb
 - lib/bertrpc/mod.rb