redisrpc 0.3.3

data/lib/redisrpc.rb

@@ -0,0 +1,128 @@
+# Copyright (C) 2012.  Nathan Farrington <nfarring@gmail.com>
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'json'
+
+require 'redis'
+
+module RedisRPC
+
+
+    class RemoteException<Exception
+    end
+
+
+    class FunctionCall
+
+        def initialize(args={})
+            @name = args['name']
+            @args = args['args']
+        end
+
+        def as_ruby_code
+            argstring = ''
+            if @args != nil
+                argstring += ' '
+                argstring += @args.join ','
+            end
+            return @name + argstring
+        end
+
+    end
+
+
+    class Client
+
+        def initialize(redis_server, input_queue)
+            @redis_server = redis_server
+            @input_queue = input_queue
+        end
+
+        def method_missing(sym, *args, &block)
+            function_call = {'name' => sym.to_s, 'args' => args}
+            response_queue = @input_queue + ':rpc:' + rand_string
+            rpc_request = {'function_call' => function_call, 'response_queue' => response_queue}
+            message = JSON.generate rpc_request
+            if $DEBUG
+                $stderr.puts 'RPC Request: ' + message
+            end
+            @redis_server.rpush @input_queue, message
+            timeout_s = 0 # Block forever.
+            message_queue, message = @redis_server.blpop response_queue, timeout_s
+            if $DEBUG
+                if message_queue != response_queue
+                    fail 'assertion failed'
+                end
+                $stderr.puts 'RPC Response: ' + message
+            end
+            rpc_response = JSON.parse message
+            exception = rpc_response['exception']
+            if exception != nil
+                raise RemoteException, exception
+            end
+            if not rpc_response.has_key? 'return_value'
+                raise RemoteException, 'Malformed RPC Response message: ' + rpc_response
+            end
+            return rpc_response['return_value']
+        end 
+
+        def rand_string(size=8, charset=%w{ 1 2 3 4 5 6 7 8 9 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z})
+            return (0...size).map{ charset.to_a[rand(charset.size)] }.join
+        end
+
+        def respond_to?(sym)
+            return true
+        end
+
+    end
+
+
+    class Server
+
+        def initialize(redis_server, input_queue, local_object)
+            @redis_server = redis_server
+            @input_queue = input_queue
+            @local_object = local_object
+        end
+
+        def run
+            loop do
+                message_queue, message = @redis_server.blpop @input_queue, 0
+                if $DEBUG
+                    fail 'assertion failed' if message_queue != @input_queue
+                    $stderr.puts 'RPC Request: ' + message
+                end
+                rpc_request = JSON.parse(message)
+                response_queue = rpc_request['response_queue']
+                function_call = FunctionCall.new(rpc_request['function_call'])
+                code = '@local_object.' + function_call.as_ruby_code
+                begin
+                    return_value = eval code
+                    rpc_response = {'return_value' => return_value}
+                rescue => err
+                    rpc_response = {'exception' => err}
+                end
+                message = JSON.generate rpc_response
+                if $DEBUG
+                    $stderr.puts 'RPC Response: ' + message
+                end
+                @redis_server.rpush response_queue, message
+            end
+        end
+
+    end
+
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: redisrpc
+version: !ruby/object:Gem::Version
+  version: 0.3.3
+  prerelease: 
+platform: ruby
+authors:
+- Nathan Farrington
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &2151871000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151871000
+description: ! 'RedisRPC is the easiest to use RPC library in the world. (No small
+  claim!) It
+
+  has implementations in Ruby, PHP, and Python.
+
+
+  Redis is a powerful in-memory data structure server that is useful for building
+
+  fast distributed systems. Redis implements message queue functionality with its
+
+  use of list data structures and the `LPOP`, `BLPOP`, and `RPUSH` commands.
+
+  RedisRPC implements a lightweight RPC mechanism using Redis message queues to
+
+  temporarily hold RPC request and response messages. These messages are encoded
+
+  as JSON strings for portability.
+
+
+  Many other RPC mechanisms are either programming language specific (e.g.
+
+  JavaRMI or require boiler-plate code for explicit typing (e.g.  Thrift).
+
+  RedisRPC was designed to be extremely easy to use by eliminating boiler-plate
+
+  code while also being programming language neutral.  High performance was not
+
+  an initial goal of RedisRPC and other RPC libraries are likely to have better
+
+  performance. Instead, RedisRPC has better programmer performance; it lets you
+
+  get something working immediately.
+
+'
+email: nfarring@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/redisrpc.rb
+homepage: http://github.com/nfarring/redisrpc
+licenses:
+- GPLv3
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Lightweight RPC for Redis
+test_files: []