bertrpc 0.4.2 → 1.0.0

data/History.txt

@@ -1,10 +1,5 @@
-= 0.4.2 / 2009-11-27
-  * Major changes
-    * Switch to using raw socket timeouts over buffered io (Linux only)
-
-= 0.4.1 / 2009-11-26
-  * Major changes
-    * Backport timeout option
+= 1.0.0 / 2009-10-19
+  * No changes. Production ready!
 
 = 0.4.0 / 2009-10-08
   * Major changes

data/README.md

@@ -3,28 +3,22 @@ BERTRPC
 
 By Tom Preston-Werner (tom@mojombo.com)
 
-WARNING: This software is alpha and should not be used in production without
-extensive testing. You should not consider this project production ready until
-it is released as 1.0.
+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).
 
-Description
------------
+This library currently only supports the following BERT-RPC features:
 
-BERTRPC is a Ruby BERT-RPC client library.
+* `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.
 
 
 Installation
 ------------
 
-From GemCutter:
-
-    gem install bertrpc
-
-From GitHub:
-
-    gem install mojombo-bertrpc -s http://gems.github.com \
-                                -s http://gemcutter.org
+    $ gem install bertrpc -s http://gemcutter.org
 
 
 Examples
@@ -56,18 +50,6 @@ 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/Rakefile

@@ -9,8 +9,8 @@ begin
     gem.email = "tom@mojombo.com"
     gem.homepage = "http://github.com/mojombo/bertrpc"
     gem.authors = ["Tom Preston-Werner"]
-    gem.add_dependency('bert', '>= 0.1.0')
-    gem.add_dependency('erlectricity', '>= 1.0.1')
+    gem.add_dependency('bert', '>= 1.0.0')
+    gem.add_dependency('erlectricity', '>= 1.1.0')
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 

data/VERSION

@@ -1 +1 @@
-0.4.2
+1.0.0

data/bertrpc.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{bertrpc}
-  s.version = "0.4.2"
+  s.version = "1.0.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-11-28}
+  s.date = %q{2009-10-19}
   s.email = %q{tom@mojombo.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -59,15 +59,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<bert>, [">= 0.1.0"])
-      s.add_runtime_dependency(%q<erlectricity>, [">= 1.0.1"])
+      s.add_runtime_dependency(%q<bert>, [">= 1.0.0"])
+      s.add_runtime_dependency(%q<erlectricity>, [">= 1.1.0"])
     else
-      s.add_dependency(%q<bert>, [">= 0.1.0"])
-      s.add_dependency(%q<erlectricity>, [">= 1.0.1"])
+      s.add_dependency(%q<bert>, [">= 1.0.0"])
+      s.add_dependency(%q<erlectricity>, [">= 1.1.0"])
     end
   else
-    s.add_dependency(%q<bert>, [">= 0.1.0"])
-    s.add_dependency(%q<erlectricity>, [">= 1.0.1"])
+    s.add_dependency(%q<bert>, [">= 1.0.0"])
+    s.add_dependency(%q<erlectricity>, [">= 1.1.0"])
   end
 end
-

data/lib/bertrpc/action.rb

@@ -24,7 +24,7 @@ module BERTRPC
     end
 
     def transaction(bert_request)
-      sock = connect_to(@svc.host, @svc.port, @svc.timeout)
+      sock = TCPSocket.new(@svc.host, @svc.port)
 
       if @req.options
         if @req.options[:cache] && @req.options[:cache][0] == :validation
@@ -44,31 +44,6 @@ module BERTRPC
       bert_response
     rescue Errno::ECONNREFUSED
       raise ConnectionError.new("Unable to connect to #{@svc.host}:#{@svc.port}")
-    rescue Errno::EAGAIN
-      raise ReadTimeoutError.new(@svc.host, @svc.port, @svc.timeout)
-    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)
-      sock = TCPSocket.new(host, port)
-      sock.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
-
-      if timeout
-        secs = Integer(timeout)
-        usecs = Integer((timeout - secs) * 1_000_000)
-        optval = [secs, usecs].pack("l_2")
-        sock.setsockopt Socket::SOL_SOCKET, Socket::SO_RCVTIMEO, optval
-        sock.setsockopt Socket::SOL_SOCKET, Socket::SO_SNDTIMEO, optval
-      end
-
-      sock
     end
   end
-end
+end

data/lib/bertrpc/errors.rb

@@ -28,16 +28,6 @@ module BERTRPC
 
   end
 
-  # Raised when we don't get a response from a server in a timely
-  # manner. This typically occurs in spite of a successful connection.
-  class ReadTimeoutError < BERTRPCError
-    attr_reader :host, :port, :timeout
-    def initialize(host, port, timeout)
-      @host, @port, @timeout = host, port, timeout
-      super("No response from #{host}:#{port} in #{timeout}s")
-    end
-  end
-
   class ProtocolError < BERTRPCError
     NO_HEADER = [0, "Unable to read length header from server."]
     NO_DATA = [1, "Unable to read data from server."]
@@ -58,4 +48,4 @@ module BERTRPC
   class InvalidOption < BERTRPCError
 
   end
-end
+end

data/lib/bertrpc/service.rb

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

data/lib/bertrpc.rb

@@ -1,10 +1,9 @@
 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'

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)
-        @call.expects(:connect_to).returns(io)
+        TCPSocket.expects(:new).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)
-        @call.expects(:connect_to).returns(io)
+        TCPSocket.expects(:new).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)
-        @call.expects(:connect_to).returns(io)
+        TCPSocket.expects(:new).returns(io)
          begin
           @call.transaction("foo")
           fail "Should have thrown an error"
@@ -89,22 +89,6 @@ 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(Errno::EAGAIN)
-        @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
-          assert_equal 'localhost', e.host
-          assert_equal 9941, e.port
-        end
-      end
     end
   end
-end
+end

data/test/service_test.rb

@@ -2,15 +2,10 @@ require 'test_helper'
 
 class ServiceTest < Test::Unit::TestCase
   context "A Service" do
-    should "be creatable with host and port" do
+    should "be created 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: 0.4.2
+  version: 1.0.0
 platform: ruby
 authors: 
 - Tom Preston-Werner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-28 00:00:00 -08:00
+date: 2009-10-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.0
+        version: 1.0.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: erlectricity
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.1
+        version: 1.1.0
     version: 
 description: 
 email: tom@mojombo.com