fastbeans 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: fab0fdaf53dfe7c4f0f821c7ccf713f937034f50
-  data.tar.gz: d14e754ccef7d5ee62ca7e78079dd155401f509f
+  metadata.gz: 158a2d7ac50d0efe24b525b82c28c6a9222c8df6
+  data.tar.gz: fec6f6afc2ad0a825df2f5f70e0d7f468acd09a8
 !binary "U0hBNTEy":
-  metadata.gz: 6ec9d3d4080268b7604dbd51c223b370f1eeeb823fb5e7bc6bc930ca4b0b8e582dd31e2eb576fcb27375ded8b28dc66ed3633c9c65b04f0f37b56700af8e14a2
-  data.tar.gz: 571af395f94112bc12bf2ef2d42666fe68aed6234b932e3a934fd0686865343efa51f164ffb7d7642d4bfad14637777ac0bd7408ad3db158069b12318ab10534
+  metadata.gz: 725a765d91e556af64d0cabc5b8f2daacd3d816e986be956356fbd3d8a0b835fa764fec3e81ad3af75c99892cc507b7ba31d090dda017bdbefff60bf3f9de8ae
+  data.tar.gz: 3a1c0a4cfa84149afccb88745c56ea8b950692d2f26f85e0d5feb8a7c5d6ae1c509e17b64e6f81383908dc3d62e1152b428cf04c61ed87bfccb07a1a2f3ea9f6

data/Rakefile

@@ -1 +1,11 @@
 require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/fastbeans'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/fastbeans.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "connection_pool"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha"
 end

data/lib/fastbeans/client.rb

@@ -1,25 +1,26 @@
 require 'msgpack'
 require 'rufus-lru'
-require 'fastbeans/connection'
-require 'fastbeans/response'
 require 'connection_pool'
+require 'connection'
 
 module Fastbeans
   class Client
     CALL_CACHE_SIZE=100
     
     attr_reader :call_cache
+    attr_accessor :connection_class
 
-    def initialize(host="127.0.0.1", port=12345, cache_size=nil, pool_opts={})
+    def initialize(host='127.0.0.1', port=12345, cache_size=nil, pool_opts={})
       @host, @port = host, port
       @cache_size ||= CALL_CACHE_SIZE
       @call_cache = Rufus::Lru::SynchronizedHash.new(@cache_size)
       @pool_opts =  {:size => 5, :timeout => 5}.update(pool_opts)
+      @connection_class = Fastbeans::Connection
     end
 
     def pool
       @pool ||= ConnectionPool.new(@pool_opts) do
-        Fastbeans::Connection.new(@host, @port)
+        @connection_class.new(@host, @port)
       end
     end
 

data/lib/fastbeans/connection.rb

@@ -1,4 +1,5 @@
 require 'socket'
+require 'fastbeans/request'
 
 module Fastbeans
   class Connection
@@ -9,17 +10,23 @@ module Fastbeans
     def initialize(host, port)
       Fastbeans.debug("Connecting to #{host}:#{port}")
       @host, @port = host, port
-      connect!(@host, @port)
+      @socket = connect!(@host, @port)
     end
 
     def connect!(host, port)
       @socket = TCPSocket.new(host, port)
       @socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+      @socket
+    end
+
+    def get_socket
+      @socket || connect!(@host, @port)
     end
 
     def disconnect!
       if @socket
         @socket.close rescue nil
+        @socket = nil
       end
     end
 
@@ -31,7 +38,7 @@ module Fastbeans
     def call(*data)
       retries = 0
       begin
-        call_without_retries(*data)
+        call_without_retries(data)
       rescue Fastbeans::RemoteConnectionFailed => e
         Fastbeans.debug(e)
         if retries < MAX_RETRIES
@@ -49,18 +56,26 @@ module Fastbeans
       end
     end
 
-    def call_without_retries(*data)
-      payload = MessagePack.pack(data).force_encoding("BINARY")
-      @socket.write([payload.bytesize].pack("N"))
-      @socket.write(payload)
-      raw_resp = MessagePack.load(@socket)
-      resp = Response.new(data, raw_resp)
-      resp.payload
+    def call_without_retries(data)
+      perform(data)
+
     rescue IOError, Errno::EPIPE, MessagePack::MalformedFormatError => e
+      disconnect!
       ne = RemoteConnectionFailed.new(e.message)
       ne.orig_exc = e
       raise ne
+
+    rescue Exception
+      disconnect!
+      raise
     end
 
+    def with_socket
+      yield(get_socket)
+    end
+
+    def perform(data)
+      Request.new(self).perform(data)
+    end
   end
 end

data/lib/fastbeans/errors.rb

@@ -1,13 +1,14 @@
 module Fastbeans
 
-  class Exception < StandardError
+  class RPCException < StandardError
     attr_accessor :orig_exc
   end
 
-  class RemoteCallFailed < Fastbeans::Exception; end
-  class RemoteException < Fastbeans::Exception; end
-  class RemoteConnectionFailed  < Fastbeans::Exception; end
-  class RemoteConnectionDead  < Fastbeans::Exception; end
-  class AutogeneratedException < Fastbeans::Exception; end
+  class RemoteCallFailed < Fastbeans::RPCException; end
+  class RemoteException < Fastbeans::RPCException; end
+  class RemoteConnectionFailed  < Fastbeans::RPCException; end
+  class RemoteConnectionDead  < Fastbeans::RPCException; end
+  class AutogeneratedException < Fastbeans::RPCException; end
+  class ResponseSignatureMismatch < RemoteConnectionFailed; end
   
 end

data/lib/fastbeans/request.rb

@@ -0,0 +1,49 @@
+require 'digest/md5'
+require 'response'
+
+module Fastbeans
+  class Request
+    attr_reader :connection
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def sign(call_data)
+      Digest::MD5.hexdigest(call_data.inspect)
+    end
+
+    def build_payload(call_data)
+      signature = sign(call_data)
+      signed_data = [signature, call_data]
+      payload = MessagePack.pack(signed_data)
+      if payload.respond_to?(:force_encoding)
+        payload.force_encoding('BINARY')
+      end
+      [signature, payload]
+    end
+
+    def write_payload(sock, payload)
+      sock.write([payload.bytesize].pack('N'))
+      sock.write(payload)
+    end
+
+    def read_response(sock, call_data)
+      raw_resp = MessagePack.load(sock)
+      Fastbeans::Response.new(call_data, raw_resp)
+    end
+
+    def perform(call_data)
+      connection.with_socket do |sock|
+        signature, payload = build_payload(call_data)
+        write_payload(sock, payload)
+        resp = read_response(sock, call_data)
+        if resp.signed_with?(signature)
+          resp.payload
+        else
+          raise ResponseSignatureMismatch, "Received #{resp.signature} signature instead of expected #{signature} for #{call_data} call"
+        end
+      end
+    end
+  end
+end

data/lib/fastbeans/response.rb

@@ -1,6 +1,4 @@
 module Fastbeans
-
-
   class Response
 
     def initialize(call_data, raw_response)
@@ -12,9 +10,21 @@ module Fastbeans
       @raw_response.is_a?(Hash) and @raw_response.has_key?("fastbeans-error")
     end
 
+    def signature
+      unless error?
+        @raw_response[0]
+      else
+        nil
+      end
+    end
+
+    def signed_with?(orig_signature)
+      signature == orig_signature
+    end
+
     def payload
       unless error?
-        @raw_response
+        @raw_response[1]
       else
         raise to_exception
       end
@@ -44,9 +54,9 @@ module Fastbeans
       word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
       word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
       word.tr!("-", "_")
+      word.gsub!(/\s+/, "_")
       word.downcase!
       word
     end
   end
-
 end

data/lib/fastbeans/version.rb

@@ -1,3 +1,3 @@
 module Fastbeans
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/lib/fastbeans.rb

@@ -27,9 +27,9 @@ module Fastbeans
 
     def exception(classname)
       begin 
-        Fastbeans.const_get(classname)
+        Fastbeans.const_get(classname.to_s)
       rescue NameError
-        Fastbeans.const_set(classname, Class.new(Fastbeans::AutogeneratedException))
+        Fastbeans.const_set(classname.to_s, Class.new(Fastbeans::AutogeneratedException))
       end
     end
   end

data/test/client_test.rb

@@ -0,0 +1,26 @@
+require_relative 'test_helper'
+
+class ClientTest < MiniTest::Unit::TestCase
+
+  def setup
+    @client = Fastbeans::Client.new
+    @client.connection_class = MockConnection
+  end
+
+  def test_how_call_works
+    real = @client.call("+", 1, 2, 3)
+    assert_equal ["+", 1, 2, 3], real
+  end
+
+  def test_how_cached_call_works
+    real1 = @client.cached_call("+", 1, 2, 3)
+    real2 = @client.cached_call("+", 1, 2, 3)
+    assert_equal real1.object_id, real2.object_id
+
+    @client.clear_call_cache!
+
+    real3 = @client.cached_call("+", 1, 2, 3)
+    assert real1.object_id != real3.object_id
+  end
+end
+

data/test/connection_test.rb

@@ -0,0 +1,85 @@
+require_relative 'test_helper'
+
+class ConnectionTest < MiniTest::Unit::TestCase
+
+  def setup
+    Fastbeans::Connection.any_instance.stubs(:connect!).returns(StringIO.new)
+    @conn = Fastbeans::Connection.new('localhost', 12345)
+    @test_msg = ['+', 1, 2, 3]
+  end
+
+  def test_socket_presence
+    assert_is_a_socket @conn.socket
+  end
+
+  def test_disconnect
+    @conn.disconnect!
+    assert_nil @conn.socket
+  end
+
+  def test_get_socket
+    assert_is_a_socket @conn.get_socket
+
+    @conn.disconnect!
+
+    assert_is_a_socket @conn.get_socket
+  end
+
+  def test_reconnect
+    @conn.expects(:disconnect!)
+    @conn.expects(:connect!).with('localhost', 12345)
+    @conn.reconnect!
+  end
+
+  def test_with_socket
+    @conn.with_socket do |sock|
+      assert_is_a_socket sock
+    end
+  end
+
+  def test_call_without_retries
+    Fastbeans::Request.any_instance.expects(:perform).with(@test_msg).returns(:reply)
+    assert_equal :reply, @conn.call_without_retries(@test_msg)
+  end
+
+  def test_exception_during_call
+    @conn.expects(:perform).with(@test_msg).raises(RuntimeError)
+    @conn.expects(:disconnect!)
+    assert_raises RuntimeError do
+      @conn.call_without_retries(@test_msg)
+    end
+  end
+
+  def test_io_exceptions_during_call
+    ioexcs = [IOError, Errno::EPIPE, MessagePack::MalformedFormatError]
+    ioexcs.each do |exc|
+      @conn.expects(:perform).with(@test_msg).raises(exc)
+      @conn.expects(:disconnect!)
+      assert_raises Fastbeans::RemoteConnectionFailed do
+        @conn.call_without_retries(@test_msg)
+      end
+    end
+  end
+
+  def test_perform
+    req = mock
+    req.expects(:perform).with(@test_msg).returns(:result)
+    Fastbeans::Request.expects(:new).with(@conn).returns(req)
+    assert_equal :result, @conn.perform(@test_msg)
+  end
+
+  def test_call_with_retries
+    @conn.expects(:call_without_retries).
+        with(@test_msg).times(4).
+        raises(Fastbeans::RemoteConnectionFailed)
+    @conn.expects(:reconnect!).times(3)
+    assert_raises Fastbeans::RemoteConnectionDead do
+      assert_nil @conn.call(*@test_msg)
+    end
+  end
+
+  def assert_is_a_socket(sock)
+    assert_instance_of StringIO, sock
+  end
+
+end

data/test/fastbeans_test.rb

@@ -0,0 +1,9 @@
+require_relative 'test_helper'
+
+class FastbeansTest < MiniTest::Unit::TestCase
+
+  def test_should_autocreate_exceptions
+    assert_equal Fastbeans::RemoteException, Fastbeans.exception('RemoteException')
+    assert_equal 'Fastbeans::SomeException', Fastbeans.exception('SomeException').to_s
+  end
+end

data/test/request_test.rb

@@ -0,0 +1,78 @@
+require_relative 'test_helper'
+
+class RequestTest < MiniTest::Unit::TestCase
+
+  def setup
+    @conn = MockConnection.new
+    @req = Fastbeans::Request.new(@conn)
+    @test_msg = ['+', 1, 2, 3]
+    @test_sign = '2446e1d1a2947cfac9bbb0290b40d413'
+    @test_msgpack = "\x92\xDA\0 2446e1d1a2947cfac9bbb0290b40d413\x94\xA1+\x01\x02\x03"
+    @test_msgpack.force_encoding("BINARY")
+  end
+
+  def test_should_sign_call_data
+    samples = {
+      ['a', 1, 2, 3] => '60fb262a7b770985a64bb29e84d92af4',
+      ['a', 1, 2, {:a => 3}] => '3d8e75d66df7134d7260954c6e9c3b64',
+      ['clojure.something/blah', [1, 2, 3]] => 'f8c15a77f1c43ccd1ca29b0b6d969e9f',
+      ['hello'] => '1f0bf5038e61951a95c4a2a9db7c400a',
+      [:hello] => '776222fe61dcc5551da706f3ec5c12c1',
+      @test_msg => @test_sign
+    }
+    samples.each do |inp, outp|
+      assert_equal outp, @req.sign(inp), "Wrong signature for #{inp}"
+    end
+  end
+
+  def test_build_payload
+    signature, payload = @req.build_payload(@test_msg)
+    assert_equal @test_sign, signature
+    assert_equal @test_msgpack, payload
+    if payload.respond_to?(:force_encoding)
+      # Ruby 2.0 case
+      assert_equal Encoding::BINARY, payload.encoding
+    end
+  end
+
+  def test_write_payload
+    io = StringIO.new
+    @req.write_payload(io, "simple-test")
+    io.rewind
+    assert_equal "\0\0\0\vsimple-test", io.read
+  end
+
+  def test_read_response
+    io = StringIO.new(@test_msgpack)
+    resp = @req.read_response(io, @test_msg)
+    assert_instance_of Fastbeans::Response, resp
+    assert_equal '2446e1d1a2947cfac9bbb0290b40d413', resp.signature
+    assert_equal @test_msg, resp.payload
+  end
+
+  def test_perform
+    @conn.socket = StringIO.new
+    @req.expects(:build_payload).with(@test_msg).returns([@test_sign, @test_msgpack])
+    @req.expects(:write_payload).with(@conn.socket, @test_msgpack)
+    resp = mock
+    resp.expects(:signed_with?).with(@test_sign).returns(true)
+    resp.expects(:payload).returns(@test_msg)
+    @req.expects(:read_response).with(@conn.socket, @test_msg).returns(resp)
+
+    assert_equal @test_msg, @req.perform(@test_msg)
+  end
+
+  def test_perform_signature_failure
+    @conn.socket = StringIO.new
+    @req.expects(:build_payload).with(@test_msg).returns([@test_sign, @test_msgpack])
+    @req.expects(:write_payload).with(@conn.socket, @test_msgpack)
+    resp = mock
+    resp.expects(:signed_with?).with(@test_sign).returns(false)
+    resp.expects(:signature).returns("incorrectsignature")
+    @req.expects(:read_response).with(@conn.socket, @test_msg).returns(resp)
+
+    assert_raises Fastbeans::ResponseSignatureMismatch do
+      @req.perform(@test_msg)
+    end
+  end
+end

data/test/response_test.rb

@@ -0,0 +1,47 @@
+require_relative 'test_helper'
+
+class ResponseTest < MiniTest::Unit::TestCase
+
+  def setup
+    @test_msg = ['+', 1, 2, 3]
+    @test_sign = '2446e1d1a2947cfac9bbb0290b40d413'
+    @test_resp = [@test_sign, ['+', 1, 2, 3]]
+    @resp = Fastbeans::Response.new(@test_msg, @test_resp)
+    @err_resp = { 'fastbeans-error' => 'Total screw-up',
+                  'error-information' => 'No ways to recover.'}
+    @eresp = Fastbeans::Response.new(@test_msg, @err_resp)
+  end
+
+  def test_error?
+    assert @eresp.error?
+    assert !@resp.error?
+  end
+
+  def test_signature
+    assert_nil @eresp.signature
+    assert_equal @test_sign, @resp.signature
+  end
+
+  def test_signed_with
+    assert @resp.signed_with?(@test_sign)
+  end
+
+  def test_payload_for_errors
+    begin
+      @eresp.payload
+    rescue Fastbeans::AutogeneratedException => e
+      assert_equal "Fastbeans::TotalScrewUp", e.class.to_s
+    end
+  end
+
+  def test_payload
+    assert_equal @test_msg, @resp.payload
+  end
+
+  def test_support_methods
+    assert_equal 'hello_word', @resp.underscore('hello-word')
+    assert_equal 'hello_word', @resp.underscore('hello  word')
+    assert_equal 'HelloWord', @resp.camelize('hello_word')
+    assert_equal 'ABC', @resp.camelize('a_b_c')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastbeans
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Dima Sabanin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-30 00:00:00.000000000 Z
+date: 2013-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -80,6 +80,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Tiny and fast RPC client for Ruby to call Clojure code
 email:
 - sdmitry@gmail.com
@@ -97,8 +111,14 @@ files:
 - lib/fastbeans/client.rb
 - lib/fastbeans/connection.rb
 - lib/fastbeans/errors.rb
+- lib/fastbeans/request.rb
 - lib/fastbeans/response.rb
 - lib/fastbeans/version.rb
+- test/client_test.rb
+- test/connection_test.rb
+- test/fastbeans_test.rb
+- test/request_test.rb
+- test/response_test.rb
 homepage: https://github.com/dsabanin/fastbeans-rb
 licenses:
 - MIT
@@ -123,5 +143,10 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby piece of Ruby/Clojure RPC system extracted from beanstalkapp.com
-test_files: []
+test_files:
+- test/client_test.rb
+- test/connection_test.rb
+- test/fastbeans_test.rb
+- test/request_test.rb
+- test/response_test.rb
 has_rdoc: