bertrpc 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.md
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tom Preston-Werner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+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.
+
+
+Description
+-----------
+
+BERTRPC is a Ruby BERT-RPC client library.
+
+
+Installation
+------------
+
+    gem install mojombo-bertrpc -s http://gems.github.com
+
+
+Example
+-------
+
+    require 'bertrpc'
+    
+    svc = BERTRPC::Service.new('localhost', 9999)
+    svc.call.calc.add(1, 2)
+    # => 3
+
+This generates a BERT-RPC request like so:
+
+    -> {call, calc, add, [1, 2]}
+
+
+Copyright
+---------
+
+Copyright (c) 2009 Tom Preston-Werner. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "bertrpc"
+    gem.summary = %Q{BERTRPC is a Ruby BERT-RPC client library.}
+    gem.email = "tom@mojombo.com"
+    gem.homepage = "http://github.com/mojombo/bertrpc"
+    gem.authors = ["Tom Preston-Werner"]
+    gem.add_dependency('erlectricity', '>= 1.0.1')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bertrpc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bertrpc.gemspec

@@ -0,0 +1,63 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bertrpc}
+  s.version = "0.2.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-08-13}
+  s.email = %q{tom@mojombo.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "bertrpc.gemspec",
+     "lib/bertrpc.rb",
+     "lib/bertrpc/call.rb",
+     "lib/bertrpc/call_proxy.rb",
+     "lib/bertrpc/encodes.rb",
+     "lib/bertrpc/errors.rb",
+     "lib/bertrpc/mod.rb",
+     "lib/bertrpc/service.rb",
+     "test/call_proxy_test.rb",
+     "test/call_test.rb",
+     "test/encodes_test.rb",
+     "test/mod_test.rb",
+     "test/service_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mojombo/bertrpc}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{BERTRPC is a Ruby BERT-RPC client library.}
+  s.test_files = [
+    "test/call_proxy_test.rb",
+     "test/call_test.rb",
+     "test/encodes_test.rb",
+     "test/mod_test.rb",
+     "test/service_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<erlectricity>, [">= 1.0.1"])
+    else
+      s.add_dependency(%q<erlectricity>, [">= 1.0.1"])
+    end
+  else
+    s.add_dependency(%q<erlectricity>, [">= 1.0.1"])
+  end
+end

data/lib/bertrpc/call.rb

@@ -0,0 +1,33 @@
+module BERTRPC
+  class Call
+    include Encodes
+    
+    def initialize(svc, mod, fun, args)
+      @svc = svc
+      @mod = mod
+      @fun = fun
+      @args = args
+    end
+
+    def execute
+      bert_request = encode_ruby_request([:call, @mod, @fun, @args])
+      bert_response = sync_request(bert_request)
+      decode_bert_response(bert_response)
+    end
+
+    #private
+
+    def sync_request(bert_request)
+      sock = TCPSocket.new(@svc.host, @svc.port)
+      sock.write([bert_request.length].pack("N"))
+      sock.write(bert_request)
+      lenheader = sock.read(4)
+      raise ProtocolError.new("Unable to read length header from server.") unless lenheader
+      len = lenheader.unpack('N').first
+      bert_response = sock.read(len)
+      raise ProtocolError.new("Unable to read data from server.") unless bert_response
+      sock.close
+      bert_response
+    end
+  end
+end

data/lib/bertrpc/call_proxy.rb

@@ -0,0 +1,11 @@
+module BERTRPC
+  class CallProxy
+    def initialize(svc)
+      @svc = svc
+    end
+
+    def method_missing(cmd, *args)
+      Mod.new(@svc, Call, cmd)
+    end
+  end
+end

data/lib/bertrpc/encodes.rb

@@ -0,0 +1,61 @@
+module BERTRPC
+  module Encodes
+    def encode_ruby_request(ruby_request)
+      ruby_payload = convert(ruby_request)
+      Erlectricity::Encoder.encode(ruby_payload)
+    end
+
+    def decode_bert_response(bert_response)
+      ruby_response = Erlectricity::Decoder.decode(bert_response)
+      case ruby_response[0]
+        when :reply
+          deconvert(ruby_response[1])
+        when :error
+          error(ruby_response[1])
+        else
+          raise
+      end
+    end
+
+    def error(err)
+      case err[0]
+        when :protocol
+          raise ProtocolError.new(err[2])
+        when :server
+          raise ServerError.new(err[2])
+        when :user
+          raise UserError.new(err[2])
+        when :proxy
+          raise ProxyError.new(err[2])
+        else
+          raise
+      end
+    end
+
+    def convert(item)
+      if item.instance_of?(Hash)
+        a = [:dict]
+        item.each_pair { |k, v| a << [convert(k), convert(v)] }
+        a
+      elsif item.instance_of?(Array)
+        item.map { |x| convert(x) }
+      else
+        item
+      end
+    end
+
+    def deconvert(item)
+      if item.instance_of?(Array)
+        if item.first == :dict
+          item[1..-1].inject({}) do |acc, x|
+            acc[deconvert(x[0])] = deconvert(x[1]); acc
+          end
+        else
+          item.map { |x| deconvert(x) }
+        end
+      else
+        item
+      end
+    end
+  end
+end

data/lib/bertrpc/errors.rb

@@ -0,0 +1,21 @@
+module BERTRPC
+  class BERTRPCError < StandardError
+
+  end
+
+  class ProtocolError < BERTRPCError
+
+  end
+
+  class ServerError < BERTRPCError
+
+  end
+
+  class UserError < BERTRPCError
+
+  end
+
+  class ProxyError < BERTRPCError
+
+  end
+end

data/lib/bertrpc/mod.rb

@@ -0,0 +1,14 @@
+module BERTRPC
+  class Mod
+    def initialize(svc, type, mod)
+      @svc = svc
+      @type = type
+      @mod = mod
+    end
+
+    def method_missing(cmd, *args)
+      args = [*args]
+      @type.new(@svc, @mod, cmd, args).execute
+    end
+  end
+end

data/lib/bertrpc/service.rb

@@ -0,0 +1,14 @@
+module BERTRPC
+  class Service
+    attr_accessor :host, :port
+
+    def initialize(host, port)
+      @host = host
+      @port = port
+    end
+
+    def call
+      CallProxy.new(self)
+    end
+  end
+end

data/lib/bertrpc.rb

@@ -0,0 +1,9 @@
+require 'erlectricity'
+require 'socket'
+
+require 'bertrpc/service'
+require 'bertrpc/call_proxy'
+require 'bertrpc/mod'
+require 'bertrpc/encodes'
+require 'bertrpc/call'
+require 'bertrpc/errors'

data/test/call_proxy_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class CallProxyTest < Test::Unit::TestCase
+  context "A CallProxy" do
+    setup do
+      @svc = BERTRPC::Service.new('localhost', 9941)
+    end
+
+    should "be created with a Service" do
+      assert BERTRPC::CallProxy.new(@svc).is_a?(BERTRPC::CallProxy)
+    end
+  end
+
+  context "A CallProxy instance" do
+    setup do
+      svc = BERTRPC::Service.new('localhost', 9941)
+      @cp = BERTRPC::CallProxy.new(@svc)
+    end
+
+    should "return a Mod instance" do
+      assert @cp.myfun.is_a?(BERTRPC::Mod)
+    end
+  end
+end

data/test/call_test.rb

@@ -0,0 +1,85 @@
+require 'test_helper'
+
+class CallTest < Test::Unit::TestCase
+  context "A Call" do
+    setup do
+      @svc = BERTRPC::Service.new('localhost', 9941)
+    end
+
+    should "be created with a Service, module name, fun name, and args" do
+      assert BERTRPC::Call.new(@svc, :mymod, :myfun, [1, 2]).is_a?(BERTRPC::Call)
+    end
+  end
+
+  context "A Call instance" do
+    setup do
+      @svc = BERTRPC::Service.new('localhost', 9941)
+      @enc = Enc.new
+    end
+
+    should "call with single-arity" do
+      req = @enc.encode_ruby_request([:call, :mymod, :myfun, [1]])
+      res = @enc.encode_ruby_request([:reply, 2])
+      call = BERTRPC::Call.new(@svc, :mymod, :myfun, [1])
+      call.expects(:sync_request).with(req).returns(res)
+      assert_equal 2, call.execute
+    end
+
+    should "call with single-arity array" do
+      req = @enc.encode_ruby_request([:call, :mymod, :myfun, [[1, 2, 3]]])
+      res = @enc.encode_ruby_request([:reply, [4, 5, 6]])
+      call = BERTRPC::Call.new(@svc, :mymod, :myfun, [[1, 2, 3]])
+      call.expects(:sync_request).with(req).returns(res)
+      assert_equal [4, 5, 6], call.execute
+    end
+
+    should "call with multi-arity" do
+      req = @enc.encode_ruby_request([:call, :mymod, :myfun, [1, 2, 3]])
+      res = @enc.encode_ruby_request([:reply, [4, 5, 6]])
+      call = BERTRPC::Call.new(@svc, :mymod, :myfun, [1, 2, 3])
+      call.expects(:sync_request).with(req).returns(res)
+      assert_equal [4, 5, 6], call.execute
+    end
+
+    context "sync_request" do
+      setup do
+        @svc = BERTRPC::Service.new('localhost', 9941)
+        @call = BERTRPC::Call.new(@svc, :mymod, :myfun, [])
+      end
+    
+      should "read and write BERT-Ps from the socket" 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("bar")
+        io.expects(:close)
+        TCPSocket.expects(:new).returns(io)
+        assert_equal "bar", @call.sync_request("foo")
+      end
+
+      should "raise a ProtocolError when the length is invalid" do
+        io = stub()
+        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)
+        assert_raises(BERTRPC::ProtocolError) do
+          @call.sync_request("foo")
+        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)
+        assert_raises(BERTRPC::ProtocolError) do
+          @call.sync_request("foo")
+        end
+      end
+    end
+  end
+end

data/test/encodes_test.rb

@@ -0,0 +1,80 @@
+require 'test_helper'
+
+class EncodesTest < Test::Unit::TestCase
+  context "An Encodes includer" do
+    setup do
+      @enc = Enc.new
+    end
+
+    context "converter" do
+      should "convert top level hashes to BERT-RPC dict form" do
+        assert_equal([:dict, [:foo, 1], [:bar, 2]], @enc.convert({:foo => 1, :bar => 2}))
+      end
+
+      should "convert nested hashes in the same way" do
+        assert_equal([1, 2, [:dict, [:foo, 1]]], @enc.convert([1, 2, {:foo => 1}]))
+      end
+
+      should "keep everything else the same" do
+        assert_equal [1, 2, "foo", :bar, 3.14], @enc.convert([1, 2, "foo", :bar, 3.14])
+      end
+    end
+
+    context "deconverter" do
+      should "convert top level BERT-RPC dict forms to hashes" do
+        assert_equal({:foo => 1, :bar => 2}, @enc.deconvert([:dict, [:foo, 1], [:bar, 2]]))
+      end
+
+      should "convert nested dicts in the same way" do
+        assert_equal([1, 2, {:foo => 1}], @enc.deconvert([1, 2, [:dict, [:foo, 1]]]))
+      end
+
+      should "keep everything else the same" do
+        assert_equal [1, 2, "foo", :bar, 3.14], @enc.deconvert([1, 2, "foo", :bar, 3.14])
+      end
+    end
+    
+    context "ruby request encoder" do
+      should "return BERT-RPC encoded request" do
+        bert = "\203h\004d\000\004calld\000\005mymodd\000\005myfunh\003a\001a\002a\003"
+        assert_equal bert, @enc.encode_ruby_request([:call, :mymod, :myfun, [1, 2, 3]])
+      end
+    end
+    
+    context "bert response decoder" do
+      should "return response when successful" do
+        req = @enc.encode_ruby_request([:reply, [1, 2, 3]])
+        res = @enc.decode_bert_response(req)
+        assert_equal [1, 2, 3], res
+      end
+
+      should "raise a ProtocolError error when protocol level error is returned" do
+        req = @enc.encode_ruby_request([:error, [:protocol, 1, "invalid"]])
+        assert_raises(BERTRPC::ProtocolError) do
+          @enc.decode_bert_response(req)
+        end
+      end
+
+      should "raise a ServerError error when server level error is returned" do
+        req = @enc.encode_ruby_request([:error, [:server, 1, "invalid"]])
+        assert_raises(BERTRPC::ServerError) do
+          @enc.decode_bert_response(req)
+        end
+      end
+
+      should "raise a UserError error when user level error is returned" do
+        req = @enc.encode_ruby_request([:error, [:user, 1, "invalid"]])
+        assert_raises(BERTRPC::UserError) do
+          @enc.decode_bert_response(req)
+        end
+      end
+
+      should "raise a ProxyError error when proxy level error is returned" do
+        req = @enc.encode_ruby_request([:error, [:proxy, 1, "invalid"]])
+        assert_raises(BERTRPC::ProxyError) do
+          @enc.decode_bert_response(req)
+        end
+      end
+    end
+  end
+end

data/test/mod_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class ModTest < Test::Unit::TestCase
+  context "A Mod" do
+    setup do
+      @svc = BERTRPC::Service.new('localhost', 9941)
+    end
+
+    should "be created with a Service and type and module name" do
+      assert BERTRPC::Mod.new(@svc, BERTRPC::Call, :mymod).is_a?(BERTRPC::Mod)
+    end
+  end
+
+  context "A Mod instance" do
+    setup do
+      @svc = BERTRPC::Service.new('localhost', 9941)
+      @mod = BERTRPC::Mod.new(@svc, BERTRPC::Call, :mymod)
+    end
+
+    should "call execute on the type" do
+      m = mock(:execute => nil)
+      BERTRPC::Call.expects(:new).with(@svc, :mymod, :myfun, [1, 2, 3]).returns(m)
+      @mod.myfun(1, 2, 3)
+      
+      m = mock(:execute => nil)
+      BERTRPC::Call.expects(:new).with(@svc, :mymod, :myfun, [1]).returns(m)
+      @mod.myfun(1)
+    end
+  end
+end

data/test/service_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class ServiceTest < Test::Unit::TestCase
+  context "A Service" do
+    should "be created with host and port" do
+      svc = BERTRPC::Service.new('localhost', 9941)
+      assert svc.is_a?(BERTRPC::Service)
+    end
+  end
+
+  context "A Service Instance" do
+    setup do
+      @svc = BERTRPC::Service.new('localhost', 9941)
+    end
+
+    should "return it's host" do
+      assert_equal 'localhost', @svc.host
+    end
+
+    should "return it's port" do
+      assert_equal 9941, @svc.port
+    end
+
+    should "return a Call instance" do
+      assert @svc.call.is_a?(BERTRPC::CallProxy)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'bertrpc'
+
+class Enc
+  include BERTRPC::Encodes
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: bertrpc
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Tom Preston-Werner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: erlectricity
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+    version: 
+description: 
+email: tom@mojombo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bertrpc.gemspec
+- lib/bertrpc.rb
+- lib/bertrpc/call.rb
+- lib/bertrpc/call_proxy.rb
+- lib/bertrpc/encodes.rb
+- lib/bertrpc/errors.rb
+- lib/bertrpc/mod.rb
+- lib/bertrpc/service.rb
+- test/call_proxy_test.rb
+- test/call_test.rb
+- test/encodes_test.rb
+- test/mod_test.rb
+- test/service_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mojombo/bertrpc
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: BERTRPC is a Ruby BERT-RPC client library.
+test_files: 
+- test/call_proxy_test.rb
+- test/call_test.rb
+- test/encodes_test.rb
+- test/mod_test.rb
+- test/service_test.rb
+- test/test_helper.rb