rjr 0.6.1 → 0.7.0

data/Rakefile

@@ -1,7 +1,7 @@
 # rjr project Rakefile
 #
-# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
-# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+# Copyright (C) 2010-2012 Mohammed Morsi <mo@morsi.org>
+# Licensed under the Apache License, Version 2.0
 
 require 'rdoc/task'
 require "rspec/core/rake_task"

data/bin/rjr-server

@@ -5,8 +5,8 @@
 # Flags:
 #  -h --help
 #
-# Copyright (C) 2011 Mohammed Morsi <mo@morsi.org>
-# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+# Copyright (C) 2011-2012 Mohammed Morsi <mo@morsi.org>
+# Licensed under the Apache License, Version 2.0
 
 require 'rubygems'
 require 'optparse'

data/lib/rjr/amqp_node.rb

@@ -1,7 +1,7 @@
 # RJR AMQP Endpoint
 #
 # Copyright (C) 2012 Mohammed Morsi <mo@morsi.org>
-# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+# Licensed under the Apache License, Version 2.0
 
 # establish client connection w/ specified args and invoke block w/ 
 # newly created client, returning it after block terminates
@@ -57,7 +57,6 @@ class AMQPNode < RJR::Node
                                          :rjr_callback =>
                                            AMQPNodeCallback.new(:node => self,
                                                                 :exchange => @exchange,
-                                                                :amqp_lock => @amqp_lock,
                                                                 :destination => reply_to,
                                                                 :headers => headers))
     response = ResponseMessage.new(:id => msg.msg_id, :result => result, :headers => headers)
@@ -74,8 +73,9 @@ class AMQPNode < RJR::Node
     end
 
     @response_lock.synchronize{
-      @result = [res]
-      @result << err if !err.nil?
+      result = [msg.msg_id, res]
+      result << err if !err.nil?
+      @responses << result
       @response_cv.signal
     }
   end
@@ -88,7 +88,10 @@ class AMQPNode < RJR::Node
      @broker    = args[:broker]
      @connection_event_handlers = {:closed => [], :error => []}
      @response_lock = Mutex.new
-     @response_cv = ConditionVariable.new
+     @response_cv   = ConditionVariable.new
+     @response_check_cv   = ConditionVariable.new
+     @responses     = []
+     @amqp_lock     = Mutex.new
   end
 
   # Initialize the amqp subsystem
@@ -106,11 +109,11 @@ class AMQPNode < RJR::Node
      @exchange    = @channel.default_exchange
 
      @listening = false
-     @disconnected = false
+     #@disconnected = false
 
      @exchange.on_return do |basic_return, metadata, payload|
          puts "#{payload} was returned! reply_code = #{basic_return.reply_code}, reply_text = #{basic_return.reply_text}"
-         @disconnected = true # FIXME member will be set on wrong class
+         #@disconnected = true # FIXME member will be set on wrong class
          connection_event(:error)
          connection_event(:closed)
      end
@@ -118,25 +121,41 @@ class AMQPNode < RJR::Node
 
   # publish a message using the amqp exchange
   def publish(*args)
-    raise RJR::Errors::ConnectionError.new("client unreachable") if @disconnected
-    @exchange.publish *args
+    @amqp_lock.synchronize {
+      #raise RJR::Errors::ConnectionError.new("client unreachable") if @disconnected
+      @exchange.publish *args
+    }
+    nil
   end
 
   # subscribe to messages using the amqp queue
   def subscribe(*args, &bl)
     return if @listening
-    @listening = true
-    @queue.subscribe do |metadata, msg|
-      bl.call metadata, msg
-    end
+    @amqp_lock.synchronize {
+      @listening = true
+      @queue.subscribe do |metadata, msg|
+        bl.call metadata, msg
+      end
+    }
+    nil
   end
 
   def wait_for_result(message)
     res = nil
-    @response_lock.synchronize{
-      @response_cv.wait @response_lock
-      res = @result
-    }
+    while res.nil?
+      @response_lock.synchronize{
+        @response_cv.wait @response_lock
+        # FIXME throw err if more than 1 match found
+        res = @responses.select { |response| message.msg_id == response.first }.first
+        unless res.nil?
+          @responses.delete(res)
+        else
+          @response_cv.signal
+          @response_check_cv.wait @response_lock
+        end
+        @response_check_cv.signal
+      }
+    end
     return res
   end
 
@@ -185,14 +204,15 @@ class AMQPNode < RJR::Node
       publish message.to_s, :routing_key => routing_key, :reply_to => @queue_name
     end
 
+    # TODO optional timeout for response ?
     result = wait_for_result(message)
-    self.stop
-    self.join unless self.em_running?
+    #self.stop
+    #self.join unless self.em_running?
 
-    if result.size > 1
-      raise result[1]
+    if result.size > 2
+      raise result[2]
     end
-    return result.first
+    return result[1]
   end
 
 end

data/lib/rjr/common.rb

@@ -1,7 +1,7 @@
 # RJR Utility Methods
 #
 # Copyright (C) 2011 Mohammed Morsi <mo@morsi.org>
-# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+# Licensed under the Apache License, Version 2.0
 
 require 'logger'
 

data/lib/rjr/dispatcher.rb

@@ -1,7 +1,7 @@
 # RJR Request / Response Dispatcher
 #
 # Copyright (C) 2012 Mohammed Morsi <mo@morsi.org>
-# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+# Licensed under the Apache License, Version 2.0
 
 # establish client connection w/ specified args and invoke block w/ 
 # newly created client, returning it after block terminates

data/lib/rjr/errors.rb

@@ -1,7 +1,7 @@
 # RJR Errors
 #
 # Copyright (C) 2012 Mohammed Morsi <mo@morsi.org>
-# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+# Licensed under the Apache License, Version 2.0
 
 # establish client connection w/ specified args and invoke block w/ 
 # newly created client, returning it after block terminates

data/lib/rjr/local_node.rb

@@ -1,7 +1,7 @@
 # RJR Local Endpoint
 #
 # Copyright (C) 2012 Mohammed Morsi <mo@morsi.org>
-# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+# Licensed under the Apache License, Version 2.0
 
 # establish client connection w/ specified args and invoke block w/ 
 # newly created client, returning it after block terminates
@@ -19,6 +19,7 @@ class LocalNodeCallback
   end
 
   def invoke(callback_method, *data)
+    # TODO any exceptions from handler will propagate here, surround w/ begin/rescue block
     @node.invoke_request(callback_method, *data)
     # TODO support local_node 'disconnections'
   end

data/lib/rjr/message.rb

@@ -1,7 +1,7 @@
 # RJR Message
 #
 # Copyright (C) 2012 Mohammed Morsi <mo@morsi.org>
-# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+# Licensed under the Apache License, Version 2.0
 
 # establish client connection w/ specified args and invoke block w/ 
 # newly created client, returning it after block terminates

data/lib/rjr/multi_node.rb

@@ -1,7 +1,7 @@
 # RJR MultiNode Endpoint
 #
 # Copyright (C) 2012 Mohammed Morsi <mo@morsi.org>
-# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+# Licensed under the Apache License, Version 2.0
 
 # establish client connection w/ specified args and invoke block w/ 
 # newly created client, returning it after block terminates

data/lib/rjr/node.rb

@@ -1,7 +1,7 @@
 # RJR Node
 #
 # Copyright (C) 2012 Mohammed Morsi <mo@morsi.org>
-# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+# Licensed under the Apache License, Version 2.0
 
 # establish client connection w/ specified args and invoke block w/ 
 # newly created client, returning it after block terminates
@@ -20,11 +20,19 @@ class Node
   # attitional parameters to set on messages
   attr_accessor :message_headers
 
+  attr_reader :thread_pool
+
   def initialize(args = {})
      @node_id = args[:node_id]
 
      @message_headers = {}
      @message_headers.merge!(args[:headers]) if args.has_key?(:headers)
+
+     ObjectSpace.define_finalizer(self, self.class.finalize(self))
+  end
+
+  def self.finalize(node)
+    proc { node.halt ; node.join }
   end
 
   # run job in event machine
@@ -46,7 +54,7 @@ class Node
           begin
             EventMachine.run
           rescue Exception => e
-            puts "Critical exception #{e}"
+            puts "Critical exception #{e}\n#{e.backtrace.join("\n")}"
           ensure
           end
         }
@@ -60,10 +68,10 @@ class Node
   end
 
   def join
-    if @@em_thread
-      @@em_thread.join
-      @@em_thread = nil
-    end
+    @@em_thread.join if @@em_thread
+    @@em_thread = nil
+    @thread_pool.join if @thread_pool
+    @thread_pool = nil
   end
 
   def stop
@@ -77,6 +85,7 @@ class Node
   def halt
     @@em_jobs = 0
     EventMachine.stop
+    @thread_pool.stop unless @thread_pool.nil?
   end
 
 end

data/lib/rjr/tcp_node.rb

@@ -1 +1,174 @@
-# TODO
+# RJR TCP Endpoint
+#
+# Copyright (C) 2012 Mohammed Morsi <mo@morsi.org>
+# Licensed under the Apache License, Version 2.0
+
+require 'uri'
+require 'eventmachine'
+
+require 'rjr/node'
+require 'rjr/message'
+
+module RJR
+
+# TCP client node callback interface,
+# send data back to client via established tcp socket.
+class TCPNodeCallback
+  def initialize(args = {})
+    @endpoint        = args[:endpoint]
+    @message_headers = args[:headers]
+  end
+
+  def invoke(callback_method, *data)
+    msg = RequestMessage.new :method => callback_method, :args => data, :headers => @message_headers
+    # TODO surround w/ begin/rescue block incase of socket errors
+    @endpoint.send_data msg.to_s
+  end
+end
+
+# helper class intialized by event machine corresponding to
+# a client or server socket connection
+class TCPNodeEndpoint < EventMachine::Connection
+  def initialize(args = {})
+    @rjr_node        = args[:rjr_node]
+
+    # these params should be set for clients
+    @send_message    = args[:init_message]
+  end
+
+  def post_init
+    unless @send_message.nil?
+      send_data @send_message.to_s
+      @send_message = nil
+    end
+  end
+
+  def receive_data(data)
+    if RequestMessage.is_request_message?(data)
+      @rjr_node.thread_pool << ThreadPoolJob.new { handle_request(data) }
+
+    elsif ResponseMessage.is_response_message?(data)
+      handle_response(data)
+
+    end
+  end
+
+
+  def handle_request(data)
+    client_port, client_ip = Socket.unpack_sockaddr_in(get_peername)
+    msg    = RequestMessage.new(:message => data, :headers => @rjr_node.message_headers)
+    headers = @rjr_node.message_headers.merge(msg.headers)
+    result = Dispatcher.dispatch_request(msg.jr_method,
+                                         :method_args => msg.jr_args,
+                                         :headers => headers,
+                                         :client_ip     => client_ip,
+                                         :client_port   => client_port,
+                                         :rjr_node      => @rjr_node,
+                                         :rjr_node_id   => @rjr_node.node_id,
+                                         :rjr_node_type => TCPNode::RJR_NODE_TYPE,
+                                         :rjr_callback =>
+                                           TCPNodeCallback.new(:endpoint => self,
+                                                               :headers => headers))
+    response = ResponseMessage.new(:id => msg.msg_id, :result => result, :headers => headers)
+    send_data(response.to_s)
+  end
+
+  def handle_response(data)
+    msg    = ResponseMessage.new(:message => data, :headers => @rjr_node.message_headers)
+    res = err = nil
+    begin
+      res = Dispatcher.handle_response(msg.result)
+    rescue Exception => e
+      err = e
+    end
+
+    @rjr_node.response_lock.synchronize {
+      @rjr_node.responses << [msg.msg_id, res]
+      @rjr_node.responses.last << err unless err.nil?
+      @rjr_node.response_cv.signal
+    }
+  end
+end
+
+# TCP node definition, listen for and invoke json-rpc requests via tcp sockets
+class TCPNode < RJR::Node
+  RJR_NODE_TYPE = :tcp
+
+  attr_accessor :response_lock
+  attr_accessor :response_cv
+  attr_accessor :responses
+
+  public
+  # initialize the node w/ the specified params
+  def initialize(args = {})
+     super(args)
+     @host      = args[:host]
+     @port      = args[:port]
+
+     @response_lock = Mutex.new
+     @response_cv   = ConditionVariable.new
+     @response_cv   = ConditionVariable.new
+     @response_check_cv   = ConditionVariable.new
+     @responses     = []
+
+     @connection_event_handlers = {:closed => [], :error => []}
+  end
+
+  # register connection event handler
+  def on(event, &handler)
+    if @connection_event_handlers.keys.include?(event)
+      @connection_event_handlers[event] << handler
+    end
+  end
+
+  # Initialize the tcp subsystem
+  def init_node
+  end
+
+  # Instruct Node to start listening for and dispatching rpc requests
+  def listen
+    em_run {
+      init_node
+      EventMachine::start_server @host, @port, TCPNodeEndpoint, { :rjr_node => self }
+    }
+  end
+
+  # Instructs node to send rpc request, and wait for / return response
+  def invoke_request(uri, rpc_method, *args)
+    uri = URI.parse(uri)
+    host,port = uri.host, uri.port
+
+    message = RequestMessage.new :method => rpc_method,
+                                 :args   => args,
+                                 :headers => @message_headers
+    em_run{
+      init_node
+      EventMachine::connect host, port, TCPNodeEndpoint, { :rjr_node     => self,
+                                                           :init_message => message }
+    }
+
+    # wait for matching response
+    res = nil
+    while res.nil?
+      @response_lock.synchronize {
+        @response_cv.wait response_lock
+        res = @responses.select { |response| message.msg_id == response.first }.first
+        unless res.nil?
+          @responses.delete(res)
+        else
+          @response_cv.signal
+          @response_check_cv.wait @response_lock
+        end
+        @response_check_cv.signal
+      }
+    end
+
+    # raise error or return result
+    if res.size > 2
+      raise res[2]
+    end
+    return res[1]
+  end
+end
+
+end # module RJR

data/lib/rjr/thread_pool.rb

@@ -1,27 +1,7 @@
 # Thread Pool
 #
-# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
-#
-# 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.
+# Copyright (C) 2010-2012 Mohammed Morsi <mo@morsi.org>
+# Licensed under the Apache License, Version 2.0
 
 # Work item to be executed in thread pool
 class ThreadPoolJob
@@ -72,7 +52,7 @@ class ThreadPool
     def running?
       res = nil
       @thread_lock.synchronize{
-        res = (@thread.status != false)
+        res = (!@thread.nil? && (@thread.status != false))
       }
       res
     end
@@ -93,6 +73,13 @@ class ThreadPool
           @thread.kill
           @thread.join
         end
+        @thread = nil
+      }
+    end
+
+    def join
+      @thread_lock.synchronize {
+        @thread.join unless @thread.nil?
       }
     end
   end
@@ -130,7 +117,7 @@ class ThreadPool
   end
 
   def running?
-    !terminate && (@timeout.nil? || @timeout_thread.status) &&
+    !terminate && (@timeout.nil? || (!@timeout_thread.nil? && @timeout_thread.status)) &&
     @job_runners.all? { |r| r.running? }
   end
 
@@ -157,9 +144,17 @@ class ThreadPool
   # Terminate the thread pool
   def stop
     terminate = true
-    @timeout_thread.join unless @timout_thread.nil?
+    unless @timout_thread.nil?
+      @timeout_thread.join
+      @timeout_thread.terminate
+    end
+    @timeout_thread = nil
     @work_queue.clear
     @job_runners_lock.synchronize { @job_runners.each { |jr| jr.stop } }
   end
+
+  def join
+    @job_runners_lock.synchronize { @job_runners.each { |jr| jr.join } }
+  end
 end
 

data/lib/rjr/web_node.rb

@@ -1,7 +1,7 @@
 # RJR WWW Endpoint
 #
 # Copyright (C) 2012 Mohammed Morsi <mo@morsi.org>
-# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+# Licensed under the Apache License, Version 2.0
 
 # establish client connection w/ specified args and invoke block w/ 
 # newly created client, returning it after block terminates

data/lib/rjr/ws_node.rb

@@ -1,7 +1,7 @@
 # RJR WebSockets Endpoint
 #
 # Copyright (C) 2012 Mohammed Morsi <mo@morsi.org>
-# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+# Licensed under the Apache License, Version 2.0
 
 # establish client connection w/ specified args and invoke block w/ 
 # newly created client, returning it after block terminates
@@ -26,6 +26,7 @@ class WSNodeCallback
     #msg = CallbackMessage.new(:data => data)
     msg = RequestMessage.new :method => callback_method, :args => data, :headers => @message_headers
     raise RJR::Errors::ConnectionError.new("websocket closed") if @socket.state == :closed
+    # TODO surround w/ begin/rescue block incase of other socket errors?
     @socket.send(msg.to_s)
   end
 end

data/lib/rjr.rb

@@ -1,7 +1,7 @@
-# json-rpc over qpid
+# rjr - Ruby Json Rpc
 #
-# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
-# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+# Copyright (C) 2010-2012 Mohammed Morsi <mo@morsi.org>
+# Licensed under the Apache License, Version 2.0
 
 require 'rjr/common'
 require 'rjr/errors'
@@ -14,4 +14,5 @@ require 'rjr/local_node'
 require 'rjr/amqp_node'
 require 'rjr/ws_node'
 require 'rjr/web_node'
+require 'rjr/tcp_node'
 require 'rjr/multi_node'

data/specs/tcp_node_spec.rb

@@ -0,0 +1,32 @@
+require 'rjr/tcp_node'
+require 'rjr/dispatcher'
+
+describe RJR::TCPNode do
+  it "should invoke and satisfy tcp requests" do
+    server = RJR::TCPNode.new :node_id => 'tcp', :host => 'localhost', :port => 9987
+    client = RJR::TCPNode.new
+
+    foobar_invoked = false
+    RJR::Dispatcher.init_handlers
+    RJR::Dispatcher.add_handler('foobar') { |param|
+      @client_ip.should == "127.0.0.1"
+      #@client_port.should == 9987
+      @rjr_node.should == server
+      @rjr_node_id.should == 'tcp'
+      @rjr_node_type.should == :tcp
+      param.should == 'myparam'
+      foobar_invoked = true
+      'retval'
+    }
+
+    server.listen
+    sleep 1
+    res = client.invoke_request 'jsonrpc://localhost:9987', 'foobar', 'myparam'
+    res.should == 'retval'
+    server.halt
+    server.join
+    foobar_invoked.should == true
+  end
+
+  # TODO ensure closed / error event handlers are invoked
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rjr
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-25 00:00:00.000000000 Z
+date: 2012-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -53,6 +53,7 @@ files:
 - specs/dispatcher_spec.rb
 - specs/node_spec.rb
 - specs/amqp_node_spec.rb
+- specs/tcp_node_spec.rb
 - specs/multi_node_spec.rb
 - specs/local_node_spec.rb
 - specs/web_node_spec.rb