rack-bert-rpc 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Crystal Commerce
+
+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/Manifest.txt

@@ -0,0 +1,9 @@
+LICENSE
+README.md
+Manifest.txt
+lib/rack/bert_rpc.rb
+lib/rack/bert_rpc/encoding.rb
+lib/rack/bert_rpc/mod.rb
+lib/rack/bert_rpc/server_error.rb
+lib/rack/bert_rpc/server.rb
+lib/rack/bert_rpc/version.rb

data/README.md

@@ -0,0 +1,117 @@
+rack-bert-rpc
+=============
+
+rack-bert-rpc a Rack middleware BERT-RPC Server
+implementation. HTTP requests matching the specified path are
+intercepted by the middleware and interpreted as BERT-RPC requests.
+
+For more information about the BERT-RPC specification go to
+[bert-rpc.org](http://bert-rpc.org).
+
+rack-bert-rpc varies from other BERT-RPC server implementations in
+that it requires the requests to be made over HTTP. This increases the
+complexity and size of the requests, but allows for them to be handled
+by the same server that is serving a web application. For this reason
+services exposed through rack-bert-rpc cannot be called using
+traditional BERT-RPC libraries such as
+[bertrpc](http://github.com/mojombo/bertrpc)
+
+Currently rack-bert-rpc only supports the following BERT-RPC features:
+
+* `call` requests
+* `cast` requests
+
+The design and implementation of rack-bert-rpc derives heavily from
+[ernie](http://github.com/mojombo/ernie)
+
+Installation
+------------
+
+    $ [sudo] gem install rack-bert-rpc
+
+Usage
+-----
+
+Install rack-bert-rpc as part of your application's middleware stack.
+
+    use Rack::BertRpc, :expose => {
+      :mod => Mod
+    }
+
+The `BertRpc` middle takes several configuration parameters:
+
+* `expose`
+  Takes a `Hash` of module name to actual module
+* `path`
+  Any requests coming in to this path will be handled as RPC
+  requests. Defaults to '/rpc'
+* `server`
+  Used for testing, switches out the backend `BertRpc::Server` so the
+  requests can be handled by a different one
+
+Example
+-------
+
+First define a module containing the function that you want to call:
+
+    module HelloWorld
+      def say_hello(name)
+        "Hello, #{name}!"
+      end
+    end
+
+Next in your application's `config.ru` install rack-bert-rpc and
+expose the `HelloWorld` module
+
+    require 'rack/bert_rpc'
+    require 'hello_world'
+
+    use Rack::BertRpc, :expose => {
+      :hello => HelloWorld
+    }
+    run lambda{ |env| [200, {}, "success"] }
+
+Since we are calling BERT-RPC over HTTP we can't use the default
+`bertrpc` gem. Instead here's a sample script to send a BERT-RPC
+request over HTTP to test our module
+
+    require 'bert'
+    require 'net/http'
+
+    def encode(msg)
+      m = BERT.encode(msg)
+      [m.length].pack('N') + m
+    end
+
+    def decode(msg)
+      io = StringIO.new(body)
+      length = io.read(4).unpack('N').first
+      BERT.decode(io.read(length))
+    end
+
+    req = Net::HTTP::Post.new('/rpc')
+    req.body = encode(t[:call, :hello, :say_hello, ["Ryan"]])
+    resp = nil
+    Net::HTTP.start('localhost', 3001){ |http| resp = http.request(req) }
+
+    puts decode(resp.body)[1]
+
+Next start up your rack server on the appropriate port
+
+    $ rackup -p 3001 config.ru
+
+And finally run the script to make the BERT-RPC request
+
+    $ ruby -rubygems call_bert.rb
+    Hello, Ryan!
+
+Contribute
+---------
+
+If you'd like to contribue to rack-bert-rpc fork the project on
+GitHub:
+
+    http://github.com/crystalcommerce/rack-bert-rpc
+
+When your changes are ready, push the code to GitHub and send us a
+pull request.

data/lib/rack/bert_rpc/encoding.rb

@@ -0,0 +1,48 @@
+# We prefer to not define a global 't' method so we will use Crystal Commerce's
+# fork of Bert if it is available.
+# http://github.com/crystalcommerce/bert
+begin
+  require 'bert/core'
+rescue LoadError
+  require 'bert'
+end
+
+module Rack
+  class BertRpc
+    module Encoding
+      def read_rpc(input)
+        raw = input.read(4)
+        return nil unless raw
+        length = raw.unpack('N').first
+        return nil unless length
+        bert = input.read(length)
+        BERT.decode(bert)
+      end
+
+      def error_response(type, error)
+        if error.is_a? String
+          berpify(BERT.encode(BERT::Tuple[:error,
+                                BERT::Tuple[type, 0, error]]))
+        else
+          berpify(BERT.encode(BERT::Tuple[:error,
+                                BERT::Tuple[type, 0, error.class.to_s,
+                                  error.message, error.backtrace]]))
+        end
+      end
+
+      def reply_response(response)
+        berpify(BERT.encode(BERT::Tuple[:reply, response]))
+      end
+
+      def noreply_response
+        berpify(BERT.encode(BERT::Tuple[:noreply]))
+      end
+
+      private
+
+      def berpify(msg)
+        [msg.length].pack("N") + msg
+      end
+    end
+  end
+end

data/lib/rack/bert_rpc/mod.rb

@@ -0,0 +1,40 @@
+module Rack
+  class BertRpc
+    class Mod
+      attr_reader :source_module, :funs
+      attr_writer :loaded
+
+      def initialize(source_module)
+        @source_module = source_module
+        @loaded = false
+        @funs = {}
+      end
+
+      def call_fun(fun, args)
+        unless loaded?
+          load_module
+        end
+
+        if funs[fun].nil?
+          raise(ServerError.new("No such function " +
+                                "'#{source_module.name}##{fun}'"))
+        end
+
+        funs[fun].call(*args)
+      end
+
+      def loaded?
+        @loaded
+      end
+
+      def load_module
+        @context = Object.new
+        @context.extend source_module
+        source_module.public_instance_methods.each do |meth|
+          funs[meth.to_sym] = @context.method(meth)
+        end
+        self.loaded = true
+      end
+    end
+  end
+end

data/lib/rack/bert_rpc/server.rb

@@ -0,0 +1,53 @@
+require 'rack/bert_rpc/mod'
+require 'rack/bert_rpc/encoding'
+require 'rack/bert_rpc/server_error'
+
+module Rack
+  class BertRpc
+    class Server
+      include Encoding
+
+      attr_reader :mods
+
+      def initialize
+        @mods = {}
+      end
+
+      def expose(sym, mod)
+        mods[sym] = Mod.new(mod)
+      end
+
+      def handle(input)
+        rpc = read_rpc(input)
+
+        if rpc.size == 4 && rpc[0] == :call
+          begin
+            resp = dispatch(*rpc[1..3])
+            reply_response(resp)
+          rescue ServerError => e
+            error_response(:server, e)
+          rescue Object => e
+            error_response(:user, e)
+          end
+        elsif rpc.size == 4 && rpc[0] == :cast
+          begin
+            dispatch(*rpc[1..3])
+          rescue Object => e
+            # Just ignore errors here
+          end
+          noreply_response
+        else
+          error_response(:server, "Invalid request: #{rpc.inspect}")
+        end
+      end
+
+      def dispatch(mod, fun, args)
+        if mods[mod].nil?
+          raise(ServerError.new("No such module '#{mod}'"))
+        end
+
+        mods[mod].call_fun(fun, args)
+      end
+    end
+  end
+end

data/lib/rack/bert_rpc/server_error.rb

@@ -0,0 +1,6 @@
+module Rack
+  class BertRpc
+    class ServerError < StandardError
+    end
+  end
+end

data/lib/rack/bert_rpc/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class BertRpc
+    VERSION = "0.1.0"
+  end
+end

data/lib/rack/bert_rpc.rb

@@ -0,0 +1,27 @@
+require 'rack'
+
+module Rack
+  class BertRpc
+    attr_reader :path
+
+    def initialize(app, options = {})
+      @path = options[:path] || '/rpc'
+      @app = app
+      @server = options[:server] || Server.new
+      options[:expose].each do |sym, mod|
+        @server.expose(sym, mod)
+      end unless options[:expose].nil?
+    end
+
+    def call(env)
+      if path == env["PATH_INFO"]
+        response = @server.handle(env["rack.input"])
+        [200, { "Content-Type" => "application/bert" }, response]
+      else
+        @app.call(env)
+      end
+    end
+  end
+end
+
+require 'rack/bert_rpc/server'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: rack-bert-rpc
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ryan Burrows
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bert
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: rack-bert-rpc is rack middleware that provides a BERT-RPC server implemenation for using BERT-RPC over HTTP
+email: rhburrows@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.md
+- Manifest.txt
+- lib/rack/bert_rpc.rb
+- lib/rack/bert_rpc/encoding.rb
+- lib/rack/bert_rpc/mod.rb
+- lib/rack/bert_rpc/server_error.rb
+- lib/rack/bert_rpc/server.rb
+- lib/rack/bert_rpc/version.rb
+has_rdoc: true
+homepage: http://github.com/crystalcommerce/rack-bert-rpc
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Rack middleware BERT-RPC server
+test_files: []
+