ruote-amqp 0.9.20 → 0.9.21

data/History.txt

@@ -1,3 +1,10 @@
+=== 0.9.21 2009-07-13
+
+* Depend on ruote-0.9.21 for flexible JSON backends
+* Support for default queues
+* Support for mapping participant names to queue names
+* Plenty of RDOC fixed
+
 === 0.9.20 2009-07-13
 
 * 1 major enhancement:

data/Manifest.txt

@@ -3,6 +3,7 @@ Manifest.txt
 PostInstall.txt
 README.rdoc
 Rakefile
+TODO.txt
 lib/ruote-amqp.rb
 lib/ruote-amqp/listener.rb
 lib/ruote-amqp/participant.rb

data/README.rdoc

@@ -23,13 +23,31 @@ Please review the detailed RDOC in RuoteAMQP::Participant and Ruote::AMQP::Liste
 
 == REQUIREMENTS:
 
-* ruote[http://openwfe.rubyforge.org] 0.9.20 or later
+* ruote[http://openwfe.rubyforge.org] 0.9.21 or later
 * amqp[http://github.com/tmm1/amqp] 0.6.1 or later
 
-NOTE: It might be required that you build the amqp gem yourself
+NOTE: It might be required that you build the amqp gem yourself.
+
+ruote 0.9.21 is currently only available to build on your own since John 
+Mettraux is working tirelessly to ship ruote 2.0. To build your own ruote 
+0.9.21 gem run these commands:
+
+  $ git clone git://github.com/jmettraux/ruote.git
+  $ cd ruote
+  $ rake gem
+  $ sudo gem install pkg/ruote-0.9.21.gem
+
+Please note that this requires Rubygems 1.3.2 or newer to work
+
+If you're using ruote 0.9.20 and would like to use ruote-amqp, you can install
+ruote-amqp-0.9.20, like so:
+
+  $ sudo gem install ruote-amqp -v 0.9.20
 
 == INSTALL:
 
+Please be sure to have read the requirements section above
+
 * sudo gem install ruote-amqp
 
 == DAEMON-KIT:

data/TODO.txt

@@ -0,0 +1,4 @@
+ruote-amqp TODO
+===============
+
+[ ] Launch processes over AMQP

data/lib/ruote-amqp/listener.rb

@@ -6,10 +6,10 @@ module RuoteAMQP
   #
   # = AMQP Listeners
   #
-  # Used in conjunction with the AMQPParticipant, the AMQPListener
+  # Used in conjunction with the RuoteAMQP::Participant, the Listener
   # subscribes to a specific direct exchange and monitors for
   # incoming workitems. It expects workitems to arrive serialized as
-  # JSON (prefered), XML or YAML.
+  # JSON.
   #
   # == Configuration
   #
@@ -27,12 +27,12 @@ module RuoteAMQP
   #
   # Register the listener with the engine:
   #
-  #   engine.register_listener( OpenWFE::Extras::AMQPListener )
+  #   engine.register_listener( RuoteAMQP::Listener )
   #
   # The listener leverages the asynchronous nature of the amqp gem,
   # so no timers are setup when initialized.
   #
-  # See the AMQPParticipany docs for information on sending
+  # See the RuoteAMQP::Participant docs for information on sending
   # workitems out to remote participants, and have them send replies
   # to the correct direct exchange specified in the workitem
   # attributes.
@@ -40,13 +40,13 @@ module RuoteAMQP
   class Listener < OpenWFE::Service
     include OpenWFE::WorkItemListener
 
-    # Listening queue
-    @@queue = 'ruote'
-
     class << self
 
+      # Listening queue
+      attr_writer :queue
+
       def queue
-        @@queue
+        @queue ||= 'ruote'
       end
 
     end
@@ -56,7 +56,7 @@ module RuoteAMQP
     def initialize( service_name, options )
 
       if q = options.delete(:queue)
-        @@queue = q
+        self.class.queue = q
       end
 
       super( service_name, options )
@@ -65,9 +65,9 @@ module RuoteAMQP
         @em_thread = Thread.new { EM.run } unless EM.reactor_running?
       #end
 
-      MQ.queue( @@queue, :durable => true ).subscribe do |message|
+      MQ.queue( self.class.queue, :durable => true ).subscribe do |message|
         workitem = decode_workitem( message )
-        ldebug { "workitem from '#{@@queue}': #{workitem.inspect}" }
+        ldebug { "workitem from '#{self.class.queue}': #{workitem.inspect}" }
         handle_item( workitem )
       end
     end
@@ -85,7 +85,7 @@ module RuoteAMQP
     def decode_workitem( msg )
       ldebug { "decoding workitem from: #{msg}" }
 
-      hash = JSON.parse(msg)
+      hash = OpenWFE::Json.decode(msg)
       OpenWFE.workitem_from_h( hash )
     end
   end

data/lib/ruote-amqp/participant.rb

@@ -2,9 +2,9 @@ module RuoteAMQP
 
   # = AMQP Participants
   #
-  # The AMQPParticipant allows you to send workitems (serialized as
+  # The RuoteAMQP::Participant allows you to send workitems (serialized as
   # JSON) or messages to any AMQP queues right from the process
-  # definition. When combined with the AMQPListener you can easily
+  # definition. When combined with the RuoteAMQP::Listener you can easily
   # leverage an extremely powerful local/remote participant
   # combinations.
   #
@@ -30,12 +30,12 @@ module RuoteAMQP
   # Setting up the participant
   #
   #   engine.register_participant(
-  #     :amqp, OpenWFE::Extras::AMQPParticipant )
+  #     :amqp, RuoteAMQP::Participant )
   #
   # Setup a participant that always replies to the engine
   #
   #   engine.register_participant(
-  #     :amp, OpenWFE::Extras::AMQPParticipant.new(:reply_by_default => true ) )
+  #     :amqp, RuoteAMQP::Participant.new(:reply_by_default => true ) )
   #
   # Sending a message example
   #
@@ -63,13 +63,41 @@ module RuoteAMQP
   #
   # When waiting for a reply it only makes sense to send a workitem.
   #
+  # Keeping things DRY with participant name to queue maps:
+  #
+  #   amqp = RuoteAMQP::Participant.new( :default_queue => 'test' )
+  #   amqp.map_participant 'george', 'whitehouse'
+  #   amqp.map_participant 'barak', 'whitehouse'
+  #   amqp.map_participant 'greenspan', 'treasury'
+  #
+  #   engine.register_participant( :george, amqp )
+  #   engine.register_participant( :barak, amqp )
+  #   engine.register_participant( :greespan, amqp )
+  #   engine.register_participant( :amqp, amqp )
+  #
+  #   class DryAmqProcess0 < OpenWFE::ProcessDefinition
+  #     cursor :break_if => "${f:economy_recovered}" do
+  #       # Workitem sent to 'whitehouse' queue
+  #       george :activity => 'Tank economy'
+  #
+  #       # Workitem sent to 'treasury' queue
+  #       greenspan :activity => 'Resign'
+  #
+  #       # Workitem sent to 'whitehouse' queue
+  #       barak :activity => 'Cleanup mess'
+  #
+  #       # Workitem sent to default 'test' queue
+  #       amqp :activity => 'Notify CNN'
+  #     end
+  #   end
+  #
   # == Workitem modifications
   #
   # To ease replies, and additional workitem attribute is set:
   #
   #   'reply_queue'
   #
-  # +reply_queue+ has the name of the queue where the AMQPListener
+  # +reply_queue+ has the name of the queue where the RuoteAMQP::Listener
   # expects replies from remote participants
   #
   # == AMQP notes
@@ -87,12 +115,20 @@ module RuoteAMQP
     # Accepts an options hash with the following keys:
     #
     # * :reply_by_default => (bool) false by default
+    # * :default_queue => (string) nil by default
     def initialize( options = {} )
       ensure_reactor!
 
       @options = {
-        :reply_by_default => false
+        :reply_by_default => false,
+        :default_queue => nil
       }.merge( options )
+
+      @participant_maps = {}
+    end
+
+    def map_participant( name, queue )
+      @participant_maps[ name ] = queue
     end
 
     # Process the workitem at hand. By default the workitem will be
@@ -106,7 +142,7 @@ module RuoteAMQP
       ldebug { "consuming workitem" }
       ensure_reactor!
 
-      if target_queue = workitem.params['queue']
+      if target_queue = determine_queue( workitem )
 
         q = MQ.queue( target_queue, :durable => true )
 
@@ -138,12 +174,18 @@ module RuoteAMQP
       @em_thread.join if @em_thread
     end
 
-    protected
+    private
+
+    def determine_queue( workitem )
+      workitem.params['queue'] ||
+      @participant_maps[ workitem.participant_name ] ||
+      @options[:default_queue]
+    end
 
     # Encode (and extend) the workitem as JSON
     def encode_workitem( wi )
       wi.attributes['reply_queue'] = Listener.queue
-      JSON.generate( wi.to_h )
+      OpenWFE::Json.encode( wi.to_h )
     end
 
     def ensure_reactor!

data/lib/ruote-amqp.rb

@@ -5,21 +5,20 @@ begin
   require 'openwfe'
 rescue LoadError
   require 'rubygems'
-  gem 'ruote', '>= 0.9.20'
+  gem 'ruote', '>= 0.9.21'
   require 'openwfe'
 end
 require 'openwfe/version'
 
-if OpenWFE::OPENWFERU_VERSION < '0.9.20'
-  raise "ruote-amqp requires at least ruote-0.9.20"
+if OpenWFE::OPENWFERU_VERSION < '0.9.21'
+  raise "ruote-amqp requires at least ruote-0.9.21"
 end
 
 require 'yaml'
-require 'json'
 require 'mq'
 
 module RuoteAMQP
-  VERSION = '0.9.20'
+  VERSION = '0.9.21'
 
   autoload 'Participant', 'ruote-amqp/participant'
   autoload 'Listener',    'ruote-amqp/listener'

data/spec/listener_spec.rb

@@ -29,17 +29,17 @@ describe RuoteAMQP::Listener do
 
         loop do
           break unless @msg.nil?
-          sleep 1
+          sleep 0.1
         end
       end
     rescue Timeout::Error
       violated "Timeout waiting for message"
     end
 
-    wi = OpenWFE::InFlowWorkItem.from_h( JSON.parse( @msg ) )
+    wi = OpenWFE::InFlowWorkItem.from_h( OpenWFE::Json.decode( @msg ) )
     wi.attributes['foo'] = "bar"
 
-    MQ.queue( wi.attributes['reply_queue'] ).publish( JSON.generate( wi.to_h ) )
+    MQ.queue( wi.attributes['reply_queue'] ).publish( OpenWFE::Json.encode( wi.to_h ) )
 
     wait( fei )
 

data/spec/participant_spec.rb

@@ -27,7 +27,7 @@ describe RuoteAMQP::Participant, :type => :ruote do
 
         loop do
           break unless @msg.nil?
-          sleep 1
+          sleep 0.1
         end
       end
     rescue Timeout::Error
@@ -62,7 +62,7 @@ describe RuoteAMQP::Participant, :type => :ruote do
 
         loop do
           break unless @msg.nil?
-          sleep 1
+          sleep 0.1
         end
       end
     rescue Timeout::Error
@@ -96,7 +96,7 @@ describe RuoteAMQP::Participant, :type => :ruote do
 
         loop do
           break unless @msg.nil?
-          sleep 1
+          sleep 0.1
         end
       end
     rescue Timeout::Error
@@ -105,4 +105,79 @@ describe RuoteAMQP::Participant, :type => :ruote do
 
     @msg.should == 'foo'
   end
+
+  it "should support a default queue name" do
+
+    pdef = <<-EOF
+    class AmqpParticipant0 < OpenWFE::ProcessDefinition
+
+      sequence do
+        amqp 'reply_anyway' => true
+        echo 'done.'
+      end
+    end
+    EOF
+
+    amqp = RuoteAMQP::Participant.new( :default_queue => 'test5' )
+    @engine.register_participant( :amqp, amqp )
+
+    run_definition( pdef )
+
+    @tracer.to_s.should == 'done.'
+
+    begin
+      Timeout::timeout(10) do
+        @msg = nil
+        MQ.queue('test5').subscribe { |msg| @msg = msg }
+
+        loop do
+          break unless @msg.nil?
+          sleep 0.1
+        end
+      end
+    rescue Timeout::Error
+      violated "Timeout waiting for message"
+    end
+  end
+
+  it "should support mapping participant names to queue names" do
+    pdef = <<-EOF
+    class AmqpParticipant0 < OpenWFE::ProcessDefinition
+
+      sequence do
+        q1
+        q2
+        amqp
+        echo 'done.'
+      end
+    end
+    EOF
+
+    amqp = RuoteAMQP::Participant.new( :reply_by_default => true, :default_queue => 'test6' )
+    amqp.map_participant( 'q1', 'test7' )
+    amqp.map_participant( 'q2', 'test8' )
+    @engine.register_participant( :amqp, amqp )
+    @engine.register_participant( :q1, amqp )
+    @engine.register_participant( :q2, amqp )
+
+    run_definition( pdef )
+
+    @tracer.to_s.should == 'done.'
+
+    [ 'test6', 'test7', 'test8' ].each do |q|
+      begin
+        Timeout::timeout(10) do
+          @msg = nil
+          MQ.queue( q ).subscribe { |msg| @msg = msg }
+
+          loop do
+            break unless @msg.nil?
+            sleep 0.1
+          end
+        end
+      rescue Timeout::Error
+        violated "Timeout waiting for message on #{q}"
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruote-amqp
 version: !ruby/object:Gem::Version 
-  version: 0.9.20
+  version: 0.9.21
 platform: ruby
 authors: 
 - Kenneth Kalmer
@@ -42,7 +42,12 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.3.2
     version: 
-description: ruote-amqp provides an AMQP participant/listener pair that allows you to  distribute workitems out to AMQP consumers for processing.  To learn more about remote participants in ruote please see http://openwfe.rubyforge.org/part.html
+description: |-
+  ruote-amqp provides an AMQP participant/listener pair that allows you to 
+  distribute workitems out to AMQP consumers for processing.
+  
+  To learn more about remote participants in ruote please see
+  http://openwfe.rubyforge.org/part.html
 email: 
 - kenneth.kalmer@gmail.com
 executables: []
@@ -53,12 +58,14 @@ extra_rdoc_files:
 - History.txt
 - Manifest.txt
 - PostInstall.txt
+- TODO.txt
 files: 
 - History.txt
 - Manifest.txt
 - PostInstall.txt
 - README.rdoc
 - Rakefile
+- TODO.txt
 - lib/ruote-amqp.rb
 - lib/ruote-amqp/listener.rb
 - lib/ruote-amqp/participant.rb
@@ -76,6 +83,8 @@ files:
 - tasks/rspec.rake
 has_rdoc: true
 homepage: http://github.com/kennethkalmer/ruote-amqp
+licenses: []
+
 post_install_message: PostInstall.txt
 rdoc_options: 
 - --main
@@ -97,9 +106,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ruote-amqp
-rubygems_version: 1.3.1
+rubygems_version: 1.3.4
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: ruote-amqp provides an AMQP participant/listener pair that allows you to  distribute workitems out to AMQP consumers for processing
 test_files: []