bertrem 0.0.4

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2009 Benjamin Black
+
+Derived in part from work that is 
+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,120 @@
+BERTREM
+======
+
+By Benjamin Black (b@b3k.us)
+
+BERTREM is a BERT-RPC client and server implementation that uses an EventMachine server to accept incoming connections, and then delegates the request to loadable Ruby handlers.  BERTREM is derived from [Ernie](http://github.com/mojombo/ernie), by Tom Preston-Warner.
+
+See the full BERT-RPC specification at [bert-rpc.org](http://bert-rpc.org).
+
+BERTREM currently supports the following BERT-RPC features:
+
+* `call` requests
+* `cast` requests
+
+
+Installation
+------------
+
+	$ gem install bertrem -s http://gemcutter.org
+	
+
+Example Handler
+---------------
+
+A simple Ruby module for use in a BERTREM server:
+
+    require 'bertrem'
+    
+    module Calc
+      def add(a, b)
+        a + b
+      end
+    end
+
+
+Example Server
+--------------
+
+A simple BERTREM server using the Calc module defined above:
+
+	require 'eventmachine'
+	require 'bertrem'
+
+	EM.run {
+	  BERTREM::Server.expose(:calc, Calc)
+	  svc = BERTREM::Server.start('localhost', 9999)
+	}
+	
+	
+Logging
+-------
+
+You can have logging sent to a file by adding these lines to your handler:
+
+    logfile('/var/log/bertrem.log')
+    loglevel(Logger::INFO)
+
+This will log startup info, requests, and error messages to the log. Choosing
+Logger::DEBUG will include the response (be careful, doing this can generate
+very large log files).
+
+
+Using the BERTRPC gem to make calls to BERTREM
+---------------------------------------------__
+
+The BERTREM client supports persistent connections, so you can send multiple requests over the same service connection and responses will return in the order the requests were sent:
+
+	require 'eventmachine'
+	require 'bertrem'
+	
+	EM.run {
+	  client = BERTREM::Client.service('localhost', 9999, true)
+	  rpc = client.call.calc.add(6, 2)
+	  rpc.callback { |res|
+	    puts "Got response! -> #{res}"
+	  }
+  
+	  rpc = client.call.calc.add(2, 2)
+	  rpc.callback { |res|
+	    puts "Got response! -> #{res}"
+	  }
+	}
+	# Got response! -> 8
+	# Got response! -> 4
+	
+Alternatively, you can make BERT-RPC calls from Ruby with the [BERTRPC gem](http://github.com/mojombo/bertrpc):
+
+    require 'bertrpc'
+
+    svc = BERTRPC::Service.new('localhost', 8000)
+    svc.call.calc.add(1, 2)
+    # => 3
+
+
+Contribute
+----------
+
+If you'd like to hack on BERTREM, start by forking my repo on GitHub:
+
+    http://github.com/b/bertrem
+
+To get all of the dependencies, install the gem first
+
+The best way to get your changes merged back into core is as follows:
+
+1. Clone down your fork
+1. Create a topic branch to contain your change
+1. Hack away
+1. Add tests and make sure everything still passes by running `rake`
+1. If you are adding new functionality, document it in the README.md
+1. Do not change the version number, I will do that on my end
+1. If necessary, rebase your commits into logical chunks, without errors
+1. Push the branch up to GitHub
+1. Send me (b) a pull request for your branch
+
+
+Copyright
+---------
+
+Copyright (c) 2009 Benjamin Black. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "bertrem"
+    gem.summary = %Q{BERTREM is a Ruby EventMachine BERT-RPC client and server library.}
+    gem.email = "b@b3k.us"
+    gem.homepage = "http://github.com/b/bertrem"
+    gem.authors = ["Benjamin Black"]
+    gem.add_dependency('bertrpc', '>= 1.1.2', '< 2.0.0')
+    gem.add_dependency('eventmachine')
+    # 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
+
+task :console do
+  exec('irb -Ilib -rbertrpc')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/bertem.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bertem}
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Benjamin Black"]
+  s.date = %q{2009-12-30}
+  s.email = %q{b@b3k.us}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "bertem.gemspec",
+     "lib/bertem.rb",
+     "lib/bertem/action.rb",
+     "lib/bertem/client.rb",
+     "lib/bertem/mod.rb",
+     "lib/bertem/server.rb"
+  ]
+  s.homepage = %q{http://github.com/b/bertem}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{BERTEM is a Ruby EventMachine BERT-RPC client and server library.}
+
+  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<bertrpc>, [">= 1.1.2", "< 2.0.0"])
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
+    else
+      s.add_dependency(%q<bertrpc>, [">= 1.1.2", "< 2.0.0"])
+      s.add_dependency(%q<eventmachine>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bertrpc>, [">= 1.1.2", "< 2.0.0"])
+    s.add_dependency(%q<eventmachine>, [">= 0"])
+  end
+end
+

data/lib/bertrem.rb

@@ -0,0 +1,18 @@
+require 'logger'
+require 'bertrpc'
+require 'eventmachine'
+
+require 'bertrem/action'
+require 'bertrem/mod'
+require 'bertrem/client'
+require 'bertrem/server'
+
+module BERTREM
+  def self.version
+    File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION])).chomp
+  rescue
+    'unknown'
+  end
+
+  VERSION = self.version
+end

data/lib/bertrem/action.rb

@@ -0,0 +1,35 @@
+require 'eventmachine'
+require 'bertrpc'
+
+module BERTRPC
+  class Action
+
+    undef_method :execute
+    undef_method :write
+    undef_method :transaction
+    undef_method :connect_to
+
+    def execute
+      transaction(encode_ruby_request(t[@req.kind, @mod, @fun, @args]))
+      @svc.requests.unshift(EM::DefaultDeferrable.new).first
+    end
+
+    def write(bert)
+      @svc.send_data([bert.length].pack("N"))
+      @svc.send_data(bert)
+    end
+
+    def transaction(bert_request)
+      if @req.options
+        if @req.options[:cache] && @req.options[:cache][0] == :validation
+          token = @req.options[:cache][1]
+          info_bert = encode_ruby_request([:info, :cache, [:validation, token]])
+          write(info_bert)
+        end
+      end
+
+      write(bert_request)
+    end
+
+  end
+end

data/lib/bertrem/client.rb

@@ -0,0 +1,105 @@
+require 'bertrpc'
+require 'logger'
+require 'eventmachine'
+
+module BERTREM
+  # NOTE: ernie (and all other BERTRPC servers?) closes connections after
+  #       responding, so we can't send multiple requests per connection.
+  #       Hence, the default for persistent is false.  If you are dealing
+  #       with a more sophisticated server that supports more than one
+  #       request per connection, call BERTREM.service with
+  #       persistent = true and it should Just Work.
+
+  class Client < EventMachine::Connection
+    include BERTRPC::Encodes
+
+    attr_accessor :requests
+
+    class Request
+      attr_accessor :kind, :options
+
+      def initialize(svc, kind, options)
+        @svc = svc
+        @kind = kind
+        @options = options
+      end
+
+      def method_missing(cmd, *args)
+        BERTRPC::Mod.new(@svc, self, cmd)
+      end
+
+    end
+
+    class << self
+      attr_accessor :persistent
+    end
+    
+    self.persistent = false
+
+    def self.service(host, port, persistent = false, timeout = nil)
+      self.persistent = persistent
+      c = EM.connect(host, port, self)
+      c.pending_connect_timeout = timeout if timeout
+      c
+    end
+
+    def post_init
+      @requests = []
+    end
+
+    def unbind
+			super
+			(@requests || []).each {|r| r.fail}
+    end
+    
+    def persistent
+      Client.persistent
+    end
+
+    def receive_data(bert_response)
+      # This needs to be much more intelligent (retain a buffer, append new response data
+      # to the buffer, remember the length of the msg it is working with if it is incomplete,
+      # etc.)
+      while bert_response.length > 4 do
+        begin
+          raise BERTRPC::ProtocolError.new(BERTRPC::ProtocolError::NO_HEADER) unless bert_response.length > 4
+          len = bert_response.slice!(0..3).unpack('N').first # just here to strip the length header
+          raise BERTRPC::ProtocolError.new(BERTRPC::ProtocolError::NO_DATA) unless bert_response.length > 0
+        rescue Exception => e
+          log "Bad BERT message: #{e.message}\n#{e.backtrace.inspect}\n"          
+        end
+        
+        bert = bert_response.slice!(0..(len - 1))
+        @requests.pop.succeed(decode_bert_response(bert))  
+        unless persistent
+          close_connection
+          break
+        end
+      end
+    end
+
+    def call(options = nil)
+      verify_options(options)
+      Request.new(self, :call, options)
+    end
+
+    def cast(options = nil)
+      verify_options(options)
+      Request.new(self, :cast, options)
+    end
+
+    def verify_options(options)
+      if options
+        if cache = options[:cache]
+          unless cache[0] == :validation && cache[1].is_a?(String)
+            raise BERTRPC::InvalidOption.new("Valid :cache args are [:validation, String]")
+          end
+        else
+          raise BERTRPC::InvalidOption.new("Valid options are :cache")
+        end
+      end
+    end
+
+  end
+
+end

data/lib/bertrem/mod.rb

@@ -0,0 +1,18 @@
+module BERTREM
+  class Mod
+    
+    attr_accessor :name, :funs
+
+    def initialize(name)
+      self.name = name
+      self.funs = {}
+    end
+
+    def fun(name, block)
+      raise TypeError, "block required" if block.nil?
+      self.funs[name] = block
+    end
+    
+  end
+  
+end

data/lib/bertrem/server.rb

@@ -0,0 +1,164 @@
+require 'bert'
+require 'logger'
+require 'eventmachine'
+
+module BERTREM
+  class Server < EventMachine::Connection
+    include BERTRPC::Encodes
+    
+    # This class derived from Ernie/ernie.rb
+    
+    class << self
+      attr_accessor :mods, :current_mod, :log
+    end
+    
+    self.mods = {}
+    self.current_mod = nil
+    self.log = Logger.new(STDOUT)
+    self.log.level = Logger::INFO
+    
+    def self.start(host, port)
+      EM.start_server(host, port, self)
+    end
+    
+    # Record a module.
+    #   +name+ is the module Symbol
+    #   +block+ is the Block containing function definitions
+    #
+    # Returns nothing
+    def self.mod(name, block)
+      m = Mod.new(name)
+      self.current_mod = m
+      self.mods[name] = m
+      block.call
+    end
+
+    # Record a function.
+    #   +name+ is the function Symbol
+    #   +block+ is the Block to associate
+    #
+    # Returns nothing
+    def self.fun(name, block)
+      self.current_mod.fun(name, block)
+    end
+
+    # Expose all public methods in a Ruby module:
+    #   +name+ is the ernie module Symbol
+    #   +mixin+ is the ruby module whose public methods are exposed
+    #
+    # Returns nothing
+    def self.expose(name, mixin)
+      context = Object.new
+      context.extend mixin
+      self.mod(name, lambda {
+        mixin.public_instance_methods.each do |meth|
+          self.fun(meth.to_sym, context.method(meth))
+        end
+      })
+      context
+    end
+
+    # Set the logfile to given path.
+    #   +file+ is the String path to the logfile
+    #
+    # Returns nothing
+    def self.logfile(file)
+      self.log = Logger.new(file)
+    end
+
+    # Set the log level.
+    #   +level+ is the Logger level (Logger::WARN, etc)
+    #
+    # Returns nothing
+    def self.loglevel(level)
+      self.log.level = level
+    end
+    
+    # Dispatch the request to the proper mod:fun.
+    #   +mod+ is the module Symbol
+    #   +fun+ is the function Symbol
+    #   +args+ is the Array of arguments
+    #
+    # Returns the Ruby object response
+    def self.dispatch(mod, fun, args)
+      mods[mod] || raise(ServerError.new("No such module '#{mod}'"))
+      mods[mod].funs[fun] || raise(ServerError.new("No such function '#{mod}:#{fun}'"))
+      mods[mod].funs[fun].call(*args)
+    end
+
+    # Write the given Ruby object to the wire as a BERP.
+    #   +output+ is the IO on which to write
+    #   +ruby+ is the Ruby object to encode
+    #
+    # Returns nothing
+    def write_berp(ruby)
+      data = BERT.encode(ruby)
+      send_data([data.length].pack("N"))
+      send_data(data)
+    end
+    
+    def post_init
+      Server.log.info("(#{Process.pid}) Starting")
+      Server.log.debug(Server.mods.inspect)  
+    end
+    
+    # Receive data on the connection.
+    #
+    def receive_data(data)
+      # This needs to be much more intelligent (retain a buffer, append new request data
+      # to the buffer, remember the length of the msg it is working with if it is incomplete,
+      # etc.)
+      while data.length > 4 do
+        raw = data.slice!(0..3)
+        puts "Could not find BERP length header.  Weird, huh?" unless raw
+        packet_size = raw.unpack('N').first
+        puts "Could not understand BERP packet length.  What gives?" unless packet_size
+        bert = data.slice!(0..(packet_size - 1))
+        iruby = BERT.decode(bert)
+        
+        unless iruby
+          Server.log.info("(#{Process.pid}) No Ruby in this here packet.  On to the next one...")
+          next
+        end
+
+        if iruby.size == 4 && iruby[0] == :call
+          mod, fun, args = iruby[1..3]
+          Server.log.info("-> " + iruby.inspect)
+          begin
+            res = Server.dispatch(mod, fun, args)
+            oruby = t[:reply, res]
+            Server.log.debug("<- " + oruby.inspect)
+            write_berp(oruby)
+          rescue ServerError => e
+            oruby = t[:error, t[:server, 0, e.class.to_s, e.message, e.backtrace]]
+            Server.log.error("<- " + oruby.inspect)
+            Server.log.error(e.backtrace.join("\n"))
+            write_berp(oruby)
+          rescue Object => e
+            oruby = t[:error, t[:user, 0, e.class.to_s, e.message, e.backtrace]]
+            Server.log.error("<- " + oruby.inspect)
+            Server.log.error(e.backtrace.join("\n"))
+            write_berp(oruby)
+          end
+        elsif iruby.size == 4 && iruby[0] == :cast
+          mod, fun, args = iruby[1..3]
+          Server.log.info("-> " + [:cast, mod, fun, args].inspect)
+          begin
+            Server.dispatch(mod, fun, args)
+          rescue Object => e
+            # ignore
+          end
+          write_berp(t[:noreply])
+        else
+          Server.log.error("-> " + iruby.inspect)
+          oruby = t[:error, t[:server, 0, "Invalid request: #{iruby.inspect}"]]
+          Server.log.error("<- " + oruby.inspect)
+          write_berp(oruby)
+        end
+      end
+    end
+  end
+    
+end
+
+class BERTREM::ServerError < StandardError; end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: bertrem
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Benjamin Black
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-01 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bertrpc
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.2
+    - - <
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: b@b3k.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bertem.gemspec
+- lib/bertrem.rb
+- lib/bertrem/action.rb
+- lib/bertrem/client.rb
+- lib/bertrem/mod.rb
+- lib/bertrem/server.rb
+has_rdoc: true
+homepage: http://github.com/b/bertrem
+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: BERTREM is a Ruby EventMachine BERT-RPC client and server library.
+test_files: []
+