@@ -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 --------- README.md @@ -42,8 +42,10 @@ module BERTRPC raise ProtocolError.new(ProtocolError::NO_DATA) unless bert_response sock.close bert_response - rescue Errno::ECONNREFUSED, Timeout::Error + 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 lib/bertrpc/action.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."] lib/bertrpc/errors.rb @@ -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 test/action_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 test/service_test.rb 93edc15f41678e976462630116387a92af1da0f4 Tom Preston-Werner tom@mojombo.com http://github.com/mojombo/bertrpc/commit/53562b96e6f1e2da961c71c426506d6c2168131a 53562b96e6f1e2da961c71c426506d6c2168131a 2009-10-27T15:13:13-07:00 2009-10-27T15:13:13-07:00 make socket read timeout raise a BERTRPC::ReadTimeoutError and enhance readme bd2c2548842a1131c3c80969129d917f951a7009 Tom Preston-Werner tom@mojombo.com