ruote-amqp 2.1.5 → 2.2.0

data/lib/ruote-amqp/receiver.rb

@@ -0,0 +1,147 @@
+
+require 'ruote-amqp'
+
+
+module RuoteAMQP
+
+  #
+  # = AMQP Receiver
+  #
+  # Used in conjunction with the RuoteAMQP::Participant, the WorkitemListener
+  # subscribes to a specific direct exchange and monitors for
+  # incoming workitems. It expects workitems to arrive serialized as
+  # JSON.
+  #
+  # == Configuration
+  #
+  # AMQP configuration is handled by directly manipulating the values of
+  # the +AMQP.settings+ hash, as provided by the AMQP gem. No
+  # defaults are set by the listener. The only +option+ parsed by
+  # the initializer of the workitem listener is the +queue+ key (Hash
+  # expected). If no +queue+ key is set, the listener will subscribe
+  # to the +ruote_workitems+ direct exchange for workitems, otherwise it will
+  # subscribe to the direct exchange provided.
+  #
+  # == Usage
+  #
+  # Register the engine or storage with the listener:
+  #
+  #   RuoteAMQP::Receiver.new(engine_or_storage)
+  #
+  # The workitem listener leverages the asynchronous nature of the amqp gem,
+  # so no timers are setup when initialized.
+  #
+  # == Options
+  #
+  # :queue and :launchitems
+  #
+  # 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.
+  #
+  class Receiver < Ruote::Receiver
+
+    attr_reader :queue
+
+    # Starts a new Receiver
+    #
+    # Two arguments for this method.
+    #
+    # The first oone should be a Ruote::Engine, a Ruote::Storage or
+    # a Ruote::Worker instance.
+    #
+    # The second one is a hash for options. There are two known options :
+    #
+    # :queue for setting the queue on which to listen (defaults to
+    # 'ruote_workitems').
+    #
+    # The :launchitems option :
+    #
+    #   :launchitems => true
+    #     # the receiver accepts workitems and launchitems
+    #   :launchitems => false
+    #     # the receiver only accepts workitems
+    #   :launchitems => :only
+    #     # the receiver only accepts launchitems
+    #
+    def initialize(engine_or_storage, opts={})
+
+      super(engine_or_storage)
+
+      @launchitems = opts[:launchitems]
+
+      @queue =
+        opts[:queue] ||
+        (@launchitems == :only ? 'ruote_launchitems' : 'ruote_workitems')
+
+      RuoteAMQP.start!
+
+      if opts[:unsubscribe]
+        MQ.queue(@queue, :durable => true).unsubscribe
+        sleep 0.300
+      end
+
+      MQ.queue(@queue, :durable => true).subscribe do |message|
+        if AMQP.closing?
+          # do nothing, we're going down
+        else
+          handle(message)
+        end
+      end
+    end
+
+    def stop
+
+      RuoteAMQP.stop!
+    end
+
+    # (feel free to overwrite me)
+    #
+    def decode_workitem(msg)
+
+      (Rufus::Json.decode(msg) rescue nil)
+    end
+
+    private
+
+    def handle(msg)
+
+      item = decode_workitem(msg)
+
+      return unless item.is_a?(Hash)
+
+      not_li = ! item.has_key?('definition')
+
+      return if @launchitems == :only && not_li
+      return unless @launchitems || not_li
+
+      if not_li
+        receive(item) # workitem resumes in its process instance
+      else
+        launch(item) # new process instance launch
+      end
+
+    rescue => e
+      # something went wrong
+      # let's simply discard the message
+      $stderr.puts('=' * 80)
+      $stderr.puts(self.class.name)
+      $stderr.puts("couldn't handle incoming message :")
+      $stderr.puts('')
+      $stderr.puts(msg.inspect)
+      $stderr.puts('')
+      $stderr.puts(Rufus::Json.pretty_encode(item)) rescue nil
+      $stderr.puts('')
+      $stderr.puts(e.inspect)
+      $stderr.puts(e.backtrace)
+      $stderr.puts('=' * 80)
+    end
+
+    def launch(hash)
+
+      super(hash['definition'], hash['fields'] || {}, hash['variables'] || {})
+    end
+  end
+end
+

data/lib/ruote-amqp/version.rb

@@ -0,0 +1,6 @@
+
+module RuoteAMQP
+
+  VERSION = '2.2.0'
+end
+

data/lib/ruote-amqp/workitem_listener.rb

@@ -1,84 +1,12 @@
+
 module RuoteAMQP
 
   #
-  # = AMQP Workitem Listener
-  #
-  # Used in conjunction with the RuoteAMQP::Participant, the WorkitemListener
-  # subscribes to a specific direct exchange and monitors for
-  # incoming workitems. It expects workitems to arrive serialized as
-  # JSON.
-  #
-  # == Configuration
-  #
-  # AMQP configuration is handled by directly manipulating the values of
-  # the +AMQP.settings+ hash, as provided by the AMQP gem. No
-  # defaults are set by the listener. The only +option+ parsed by
-  # the initializer of the workitem listener is the +queue+ key (Hash
-  # expected). If no +queue+ key is set, the listener will subscribe
-  # to the +ruote_workitems+ direct exchange for workitems, otherwise it will
-  # subscribe to the direct exchange provided.
-  #
-  # The participant requires version 0.6.6 or later of the amqp gem.
-  #
-  # == Usage
+  # Got replaced by RuoteAMQP::Receiver
   #
-  # Register the engine or storage with the listener:
+  # This class is kept for backward compatibility.
   #
-  #   RuoteAMQP::WorkitemListener.new( engine_or_storage )
-  #
-  # The workitem listener leverages the asynchronous nature of the amqp gem,
-  # so no timers are setup when initialized.
-  #
-  # 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.
-  #
-  class WorkitemListener < Ruote::Receiver
-
-    class << self
-
-      # Listening queue - set this before initialization
-      attr_writer :queue
-
-      def queue
-        @queue ||= 'ruote_workitems'
-      end
-
-    end
-
-    # Starts a new WorkitemListener
-    #
-    # @param [ Ruote::Engine, Ruote::Storage ] A configured ruote engine or storage instance
-    # @param [ String ] An optional queue name
-    def initialize( engine_or_storage, queue = nil )
-
-      @storage = engine_or_storage.respond_to?( :storage ) ? engine_or_storage.storage : engine_or_storage
-
-      self.class.queue = queue if queue
-
-      RuoteAMQP.start!
-
-      MQ.queue( self.class.queue, :durable => true ).subscribe do |message|
-        if AMQP.closing?
-          # Do nothing, we're going down
-        else
-          workitem = decode_workitem( message )
-          reply( workitem )
-        end
-      end
-    end
-
-    def stop
-      RuoteAMQP.stop!
-    end
-
-    private
-
-    # Complicated guesswork that needs to happen here to detect the format
-    def decode_workitem( msg )
-      hash = Rufus::Json.decode( msg )
-      Ruote::Workitem.new( hash )
-    end
+  class WorkitemListener < ::RuoteAMQP::Receiver
   end
 end
+

data/ruote-amqp.gemspec

@@ -1,83 +1,32 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 Gem::Specification.new do |s|
-  s.name = %q{ruote-amqp}
-  s.version = "2.1.5"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["kenneth.kalmer@gmail.com"]
-  s.date = %q{2010-02-04}
-  s.email = %q{kenneth.kalmer@gmail.com}
-  s.extra_rdoc_files = [
-    "History.txt",
-     "Manifest.txt",
-     "PostInstall.txt",
-     "README.rdoc",
-     "TODO.txt"
-  ]
-  s.files = [
-    ".gitignore",
-     "History.txt",
-     "Manifest.txt",
-     "PostInstall.txt",
-     "README.rdoc",
-     "Rakefile",
-     "TODO.txt",
-     "lib/ruote-amqp.rb",
-     "lib/ruote-amqp/launchitem_listener.rb",
-     "lib/ruote-amqp/participant.rb",
-     "lib/ruote-amqp/workitem_listener.rb",
-     "lib/spec/ruote.rb",
-     "lib/spec/ruote_example_group.rb",
-     "lib/spec/ruote_helpers.rb",
-     "lib/spec/ruote_matchers.rb",
-     "ruote-amqp.gemspec",
-     "script/console",
-     "script/destroy",
-     "script/generate",
-     "spec/launchitem_listener_spec.rb",
-     "spec/participant_spec.rb",
-     "spec/ruote_amqp_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb",
-     "spec/workitem_listener_spec.rb"
-  ]
-  s.homepage = %q{http://github.com/kennethkalmer/ruote-amqp}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{AMQP participant/listener pair for ruote 2.1}
-  s.test_files = [
-    "spec/launchitem_listener_spec.rb",
-     "spec/participant_spec.rb",
-     "spec/ruote_amqp_spec.rb",
-     "spec/spec_helper.rb",
-     "spec/workitem_listener_spec.rb"
+  s.name = 'ruote-amqp'
+  s.version = File.read('lib/ruote-amqp/version.rb').match(/VERSION = '([^']+)'/)[1]
+  s.platform = Gem::Platform::RUBY
+  s.authors = [ 'Kenneth Kalmer', 'John Mettraux' ]
+  s.email = [ 'kenneth.kalmer@gmail.com', 'jmettraux@gmail.com' ]
+  s.homepage = 'http://ruote.rubyforge.org'
+  s.rubyforge_project = 'ruote'
+  s.summary = 'AMQP participant/listener pair for ruote 2.1'
+  s.description = %{
+AMQP participant/listener pair for ruote 2.1
+  }
+
+  #s.files = `git ls-files`.split("\n")
+  s.files = Dir[
+    'Rakefile',
+    'lib/**/*.rb', 'spec/**/*.rb', 'test/**/*.rb',
+    '*.gemspec', '*.txt', '*.rdoc', '*.md'
   ]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.add_runtime_dependency 'amqp', '0.7.0'
+  s.add_runtime_dependency 'ruote', ">= #{s.version}"
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', ">= 2.2.1"
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rufus-json>, [">= 0.1.0"])
-      s.add_runtime_dependency(%q<amqp>, [">= 0.6.6"])
-      s.add_runtime_dependency(%q<ruote>, [">= 2.1.5"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-    else
-      s.add_dependency(%q<rufus-json>, [">= 0.1.0"])
-      s.add_dependency(%q<amqp>, [">= 0.6.6"])
-      s.add_dependency(%q<ruote>, [">= 2.1.5"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rufus-json>, [">= 0.1.0"])
-    s.add_dependency(%q<amqp>, [">= 0.6.6"])
-    s.add_dependency(%q<ruote>, [">= 2.1.5"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-  end
+  s.require_path = 'lib'
 end
 

data/spec/launchitem_listener_spec.rb

@@ -1,32 +1,70 @@
-require File.dirname(__FILE__) + '/spec_helper'
+
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+#
+# NOTE : RuoteAMQP::LaunchitemListener has been depreacted in favour of
+#        RuoteAMQP::Receiver
+#
 
 describe RuoteAMQP::LaunchitemListener do
 
-  it "should launch processes" do
+  after(:each) do
+    purge_engine
+  end
+
+  it 'launches processes' do
+
     json = {
-      "definition" => "
+      'definition' => %{
         Ruote.process_definition :name => 'test' do
           sequence do
             echo '${f:foo}'
           end
         end
-      ",
-      "fields" => {
-        "foo" => "bar"
-      }
+      },
+      'fields' => { 'foo' => 'bar' }
     }.to_json
 
-    RuoteAMQP::LaunchitemListener.new( @engine )
+    RuoteAMQP::LaunchitemListener.new(@engine)
 
-    MQ.queue( RuoteAMQP::LaunchitemListener.queue ).publish( json )
+    MQ.queue('ruote_launchitems', :durable => true).publish(json)
 
     sleep 0.5
 
     @engine.should_not have_errors
     @engine.should_not have_remaining_expressions
 
-    @tracer.to_s.should == "bar"
+    @tracer.to_s.should == 'bar'
+  end
 
-    purge_engine
+  it 'discards corrupt process definitions' do
+
+    json = {
+      'definition' => %{
+        I'm a broken process definition
+      },
+      'fields' => { 'foo' => 'bar' }
+    }.to_json
+
+    RuoteAMQP::LaunchitemListener.new(@engine, :unsubscribe => true)
+
+    serr = String.new
+    err = StringIO.new(serr, 'w+')
+    $stderr = err
+
+    MQ.queue('ruote_launchitems', :durable => true).publish(json)
+
+    sleep 0.5
+
+    err.close
+    $stderr = STDERR
+
+    @engine.should_not have_errors
+    @engine.should_not have_remaining_expressions
+
+    @tracer.to_s.should == ''
+
+    serr.should match(/^===/)
   end
 end
+

data/spec/participant_spec.rb

@@ -1,26 +1,28 @@
-require File.dirname(__FILE__) + '/spec_helper'
 
-describe RuoteAMQP::Participant, :type => :ruote do
+require File.join(File.dirname(__FILE__), 'spec_helper')
 
-  it "should support 'reply anyway' on expression parameter" do
+
+describe RuoteAMQP::ParticipantProxy, :type => :ruote do
+
+  it "supports 'forget' as participant attribute" do
 
     pdef = ::Ruote.process_definition :name => 'test' do
       sequence do
-        amqp :queue => 'test1', 'reply_anyway' => true
+        amqp :queue => 'test1', :forget => true
         echo 'done.'
       end
     end
 
-    @engine.register_participant( :amqp, RuoteAMQP::Participant )
+    @engine.register_participant(:amqp, RuoteAMQP::ParticipantProxy)
 
-    run_definition( pdef )
+    run_definition(pdef)
 
     @tracer.to_s.should == 'done.'
 
     begin
       Timeout::timeout(10) do
         @msg = nil
-        MQ.queue('test1').subscribe { |msg| @msg = msg }
+        MQ.queue('test1', :durable => true).subscribe { |msg| @msg = msg }
 
         loop do
           break unless @msg.nil?
@@ -34,7 +36,7 @@ describe RuoteAMQP::Participant, :type => :ruote do
     @msg.should match(/^\{.*\}$/) # JSON message by default
   end
 
-  it "should support 'reply anyway' as participant configuration" do
+  it "supports 'forget' as participant option" do
 
     pdef = ::Ruote.process_definition :name => 'test' do
       sequence do
@@ -43,17 +45,17 @@ describe RuoteAMQP::Participant, :type => :ruote do
       end
     end
 
-    p = RuoteAMQP::Participant.new( :reply_by_default => true )
-    @engine.register_participant( :amqp, p )
+    @engine.register_participant(
+      :amqp, RuoteAMQP::ParticipantProxy, 'forget' => true)
 
-    run_definition( pdef )
+    run_definition(pdef)
 
     @tracer.to_s.should == "done."
 
     begin
       Timeout::timeout(5) do
         @msg = nil
-        MQ.queue('test4').subscribe { |msg| @msg = msg }
+        MQ.queue('test4', :durable => true).subscribe { |msg| @msg = msg }
 
         loop do
           break unless @msg.nil?
@@ -64,28 +66,28 @@ describe RuoteAMQP::Participant, :type => :ruote do
       violated "Timeout waiting for message"
     end
 
-    @msg.should match( /^\{.*\}$/) # JSON message by default
+    @msg.should match(/^\{.*\}$/) # JSON message by default
   end
 
-  it "should support custom messages instead of workitems" do
+  it "supports custom messages instead of workitems" do
 
     pdef = ::Ruote.process_definition :name => 'test' do
       sequence do
-        amqp :queue => 'test2', :message => 'foo', 'reply_anyway' => true
+        amqp :queue => 'test2', :message => 'foo', :forget => true
         echo 'done.'
       end
     end
 
-    @engine.register_participant( :amqp, RuoteAMQP::Participant )
+    @engine.register_participant(:amqp, RuoteAMQP::ParticipantProxy)
 
-    run_definition( pdef )
+    run_definition(pdef)
 
     @tracer.to_s.should == "done."
 
     begin
       Timeout::timeout(5) do
         @msg = nil
-        MQ.queue('test2').subscribe { |msg| @msg = msg }
+        MQ.queue('test2', :durable => true).subscribe { |msg| @msg = msg }
 
         loop do
           break unless @msg.nil?
@@ -99,26 +101,26 @@ describe RuoteAMQP::Participant, :type => :ruote do
     @msg.should == 'foo'
   end
 
-  it "should support a default queue name" do
+  it "supports 'queue' as a participant option" do
 
     pdef = ::Ruote.process_definition :name => 'test' do
       sequence do
-        amqp 'reply_anyway' => true
+        amqp :forget => true
         echo 'done.'
       end
     end
 
-    amqp = RuoteAMQP::Participant.new( :default_queue => 'test5' )
-    @engine.register_participant( :amqp, amqp )
+    @engine.register_participant(
+      :amqp, RuoteAMQP::ParticipantProxy, 'queue' => 'test5')
 
-    run_definition( pdef )
+    run_definition(pdef)
 
     @tracer.to_s.should == 'done.'
 
     begin
       Timeout::timeout(5) do
         @msg = nil
-        MQ.queue('test5').subscribe { |msg| @msg = msg }
+        MQ.queue('test5', :durable => true).subscribe { |msg| @msg = msg }
 
         loop do
           break unless @msg.nil?
@@ -130,42 +132,61 @@ describe RuoteAMQP::Participant, :type => :ruote do
     end
   end
 
-  it "should support mapping participant names to queue names" do
+  it "passes 'participant_options' over amqp" do
 
     pdef = ::Ruote.process_definition :name => 'test' do
-      sequence do
-        q1
-        q2
-        amqp
-        echo 'done.'
-      end
+      amqp :queue => 'test6', :forget => true
     end
 
-    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 )
+    @engine.register_participant(:amqp, RuoteAMQP::ParticipantProxy)
 
-    run_definition( pdef )
+    run_definition(pdef)
 
-    @tracer.to_s.should == 'done.'
+    msg = nil
 
-    [ 'test6', 'test7', 'test8' ].each do |q|
-      begin
-        Timeout::timeout(5) do
-          @msg = nil
-          MQ.queue( q ).subscribe { |msg| @msg = msg }
+    begin
+      Timeout::timeout(10) do
 
-          loop do
-            break unless @msg.nil?
-            sleep 0.1
-          end
+        MQ.queue('test6', :durable => true).subscribe { |m| msg = m }
+
+        loop do
+          break unless msg.nil?
+          sleep 0.1
         end
-      rescue Timeout::Error
-        violated "Timeout waiting for message on #{q}"
       end
+    rescue Timeout::Error
+      violated "Timeout waiting for message"
     end
+
+    wi = Rufus::Json.decode(msg)
+    params = wi['fields']['params']
+
+    params['queue'].should == 'test6'
+    params['forget'].should == true
+    params['participant_options'].should == { 'forget' => false, 'queue' => nil }
+  end
+
+  it "doesn't create 1 queue instance per delivery" do
+
+    pdef = ::Ruote.process_definition do
+      amqp :queue => 'test7', :forget => true
+    end
+
+    mq_count = 0
+    ObjectSpace.each_object(MQ) { |o| mq_count += 1 }
+
+    @engine.register_participant(:amqp, RuoteAMQP::ParticipantProxy)
+
+    10.times do
+      run_definition(pdef)
+    end
+
+    sleep 1
+
+    count = 0
+    ObjectSpace.each_object(MQ) { |o| count += 1 }
+
+    count.should == mq_count + 1
   end
 end
+