ruote-stomp 2.2.0.b → 2.2.0.c

data/CHANGELOG.txt

@@ -8,3 +8,4 @@
 
 
 
+

data/CREDITS.txt

@@ -6,6 +6,7 @@
 == AUTHORS
 
 * Kit Plummer - http://kitplummer.github.com
+* Brian Sam-Bodden = http://bsbodden.github.com
 
 == AUTHORS (from ruote-amqp)
 

data/README.rdoc

@@ -17,7 +17,7 @@ http://ruote.rubyforge.org/part_implementations.html
 * Flexible participant for sending workitems
 * Flexible receiver for receiving replies
 * Flexible launch item listener for launching processes over Stomp
-* Fully evented (thanks to the stomp gem)
+* Fully evented (thanks to the onstomp gem)
 
 == SYNOPSIS:
 
@@ -26,7 +26,7 @@ Please review the code for information (rdocs to be updated soon.)
 == REQUIREMENTS:
 
 * ruote[http://ruote.rubyforge.org] 2.2.0 or later
-* stomp[https://gitorious.org/stomp] 1.1.8 or later
+* onstomp[https://github.com/meadvillerb/onstomp] 1.0.4 or later
 * a server that supports Stomp (stompserver, ActiveMQ, RabbitMQ)
 
 == INSTALL:
@@ -60,8 +60,13 @@ ruote-amqp, which this works is based on)
 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,
+<<<<<<< Updated upstream
+without limitation the rights to use, copy, modify, merge, send,
 distribute, sublicense, and/or sell copies of the Software, and to
+=======
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of tshe Software, and to
+>>>>>>> Stashed changes
 permit persons to whom the Software is furnished to do so, subject to
 the following conditions:
 

data/lib/ruote-stomp/launchitem_listener.rb

@@ -1,4 +1,3 @@
-
 module RuoteStomp
 
   #
@@ -14,7 +13,6 @@ module RuoteStomp
     # @param opts :queue / :unsubscribe
     #
     def initialize(engine_or_storage, opts={})
-
       super(engine_or_storage, opts.merge(:launchitems => :only))
     end
   end

data/lib/ruote-stomp/participant.rb

@@ -1,10 +1,7 @@
-
 require 'ruote/part/local_participant'
 require 'ruote-stomp'
 
-
 module RuoteStomp
-
   #
   # = Stomp Participants
   #
@@ -122,12 +119,12 @@ module RuoteStomp
       }.merge(options.inject({}) { |h, (k, v)|
         h[k.to_s] = v; h
       })
-        #
-        # the inject is here to make sure that all options have String keys
+      #
+      # the inject is here to make sure that all options have String keys
     end
 
     # Process the workitem at hand. By default the workitem will be
-    # published to the direct exchange specified in the +queue+
+    # sended to the direct exchange specified in the +queue+
     # workitem parameter. You can specify a +message+ workitem
     # parameter to have that sent instead of the workitem.
     #
@@ -138,7 +135,6 @@ module RuoteStomp
 
       raise 'no queue specified (outbound delivery)' unless target_queue
 
-      #q = MQ.queue(target_queue, :durable => true)
       forget = determine_forget(workitem)
 
       opts = {
@@ -148,12 +144,9 @@ module RuoteStomp
       if message = workitem.fields['message'] || workitem.params['message']
 
         forget = true # sending a message implies 'forget' => true
-        $stomp.publish target_queue, message, opts         
-        #q.publish(message, opts)
-
+        $stomp.send target_queue, message, opts         
       else
-        $stomp.publish target_queue, encode_workitem(workitem), opts
-        #q.publish(encode_workitem(workitem), opts)
+        $stomp.send target_queue, encode_workitem(workitem), opts
       end
 
       reply_to_engine(workitem) if forget
@@ -162,7 +155,6 @@ module RuoteStomp
     # (Stops the underlying queue subscription)
     #
     def stop
-
       RuoteStomp.stop!
     end
 
@@ -176,21 +168,18 @@ module RuoteStomp
     # [NOT sure about this behavior with Stomp yet.  Need to dive.]
     
     def do_not_thread
-
       true
     end
 
     private
 
     def determine_forget(workitem)
-
       return workitem.params['forget'] if workitem.params.has_key?('forget')
       return @options['forget'] if @options.has_key?('forget')
       false
     end
 
     def determine_queue(workitem)
-
       workitem.params['queue'] || @options['queue']
     end
 
@@ -199,9 +188,7 @@ module RuoteStomp
     # this participant.
     #
     def encode_workitem(wi)
-
       wi.params['participant_options'] = @options
-
       Rufus::Json.encode(wi.to_h)
     end
   end

data/lib/ruote-stomp/receiver.rb

@@ -1,7 +1,5 @@
-
 require 'ruote-stomp'
 
-
 module RuoteStomp
 
   #
@@ -56,6 +54,9 @@ module RuoteStomp
     # :queue for setting the queue on which to listen (defaults to
     # 'ruote_workitems').
     #
+    # :ignore_disconnect_on_process => true|false (defauts to false)
+    # processes the message even if the client has disconnected (use in testing only)
+    # 
     # The :launchitems option :
     #
     #   :launchitems => true
@@ -70,6 +71,7 @@ module RuoteStomp
       super(engine_or_storage)
 
       @launchitems = opts[:launchitems]
+      ignore_disconnect = opts[:ignore_disconnect_on_process]
 
       @queue =
         opts[:queue] ||
@@ -78,40 +80,31 @@ module RuoteStomp
       RuoteStomp.start!
 
       if opts[:unsubscribe]
-        #MQ.queue(@queue, :durable => true).unsubscribe
-        $stomp.unsubscribe(@queue)
-        sleep 0.300
+        begin
+          $stomp.unsubscribe(@queue)
+        rescue OnStomp::UnsupportedCommandError => e
+          $stderr.puts("Connection does support unsubscribe")
+        end
       end
-      
-      $stomp.subscribe(@queue, {}) do |message|
+
+      $stomp.subscribe(@queue) do |message|
         # Process your message here
         # Your submitted data is in msg.body
-        if $stomp.closed?
+        if $stomp.connected? && !ignore_disconnect
           # do nothing, we're going down
         else
           handle(message)
         end
       end
-      #$stomp.join # Wait until listening thread dies
-      
-      # 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
-
       RuoteStomp.stop!
     end
 
     # (feel free to overwrite me)
     #
     def decode_workitem(msg)
-
       (Rufus::Json.decode(msg) rescue nil)
     end
 
@@ -120,9 +113,7 @@ module RuoteStomp
     def handle(msg)
       item = decode_workitem(msg.body)
       return unless item.is_a?(Hash)
-
       not_li = ! item.has_key?('definition')
-
       return if @launchitems == :only && not_li
       return unless @launchitems || not_li
 
@@ -152,5 +143,4 @@ module RuoteStomp
       super(hash['definition'], hash['fields'] || {}, hash['variables'] || {})
     end
   end
-end
-
+end

data/lib/ruote-stomp/version.rb

@@ -1,6 +1,4 @@
-
 module RuoteStomp
-
-  VERSION = '2.2.0.b'
+  VERSION = '2.2.0.c'
 end
 

data/lib/ruote-stomp/workitem_listener.rb

@@ -1,4 +1,3 @@
-
 module RuoteStomp
 
   #

data/lib/ruote-stomp.rb

@@ -1,8 +1,7 @@
-require 'stomp'
+require 'onstomp'
 
 require 'ruote-stomp/version'
 
-
 #
 # Stomp participant and listener pair for ruote.
 #
@@ -21,7 +20,6 @@ require 'ruote-stomp/version'
 module RuoteStomp
 
   autoload 'ParticipantProxy',   'ruote-stomp/participant'
-
   autoload 'Receiver',           'ruote-stomp/receiver'
   autoload 'WorkitemListener',   'ruote-stomp/workitem_listener'
   autoload 'LaunchitemListener', 'ruote-stomp/launchitem_listener'
@@ -39,34 +37,26 @@ module RuoteStomp
     # Ensure the Stomp connection is started
     def start!
       return if started?
-
       mutex = Mutex.new
       cv = ConditionVariable.new
-
       Thread.main[:ruote_stomp_connection] = Thread.new do
         Thread.abort_on_exception = true
-        
+
         begin
-          $stomp = Stomp::Client.new STOMP.settings[:user], 
-                                     STOMP.settings[:passcode], 
-                                     STOMP.settings[:host], 
-                                     STOMP.settings[:port], 
-                                     STOMP.settings[:reliable]
-          if $stomp
-            
+          $stomp = OnStomp::Client.new create_connection_uri(STOMP.settings)
+          $stomp.connect
+
+          if $stomp && $stomp.connected?
             started!
             cv.signal
           end
-        rescue
-          raise RuntimeError, "Failed to connect to Stomp server."
+        rescue Exception => e
+          raise RuntimeError, "Failed to connect to Stomp server. (#{e.message})"
         end
       end
 
       mutex.synchronize { cv.wait(mutex) }
 
-      # Stomp equivalent?
-      #MQ.prefetch(1)
-
       yield if block_given?
     end
 
@@ -82,16 +72,35 @@ module RuoteStomp
     # Close down the Stomp connections
     def stop!
       return unless started?
-      $stomp.close
+      $stomp.disconnect
       Thread.main[:ruote_stomp_connection].join
       Thread.main[:ruote_stomp_started] = false
     end
+    
+    protected
+    
+    def create_connection_uri(config={})
+      config = config.map { |n,v| {n,v.to_s} }.reduce(:merge)
+      user = config[:user]
+      passcode = config[:passcode]
+      host = config[:host]
+      port = config[:port]
+      ssl = config[:ssl] ? "+ssl" : ""
+
+      # construct the connection URI
+      user_and_password = [user,passcode].reject{|e| e.nil? || e.empty?}.join(":")
+      host_and_port = [host,port].reject{|e| e.nil? || e.empty?}.join(":")
+      uri = [host_and_port, user_and_password].reject{|e| e.nil? || e.empty?}.reverse.join("@")
+      protocol = ['stomp', ssl, '://'].reject{|e| e.nil? || e.empty?}.join
+      
+      "#{protocol}#{uri}"
+    end
   end
 end
 
 module STOMP
   def self.settings
-    @settings ||= {:host => "localhost", :port => "61613", :reliable => false}
+    @settings ||= {:host => "localhost", :port => "61613"}
   end
 end
 

data/ruote-stomp.gemspec

@@ -5,26 +5,23 @@ Gem::Specification.new do |s|
   s.name = 'ruote-stomp'
   s.version = File.read('lib/ruote-stomp/version.rb').match(/VERSION = '([^']+)'/)[1]
   s.platform = Gem::Platform::RUBY
-  s.authors = [ 'Kit Plummer' ]
-  s.email = [ 'kplummer@maestrodev.com' ]
+  s.authors = [ 'Kit Plummer', 'Brian Sam-Bodden' ]
+  s.email = [ 'kplummer@maestrodev.com', 'bsbodden@integrallis.com' ]
   s.homepage = 'http://ruote.rubyforge.org'
   s.rubyforge_project = 'ruote'
   s.summary = 'Stomp participant/listener pair for ruote 2.2'
-  s.description = %{
-Stomp participant/listener pair for ruote 2.2 - ported from ruote-amqp.
-  }
+  s.description = 'Stomp participant/listener pair for ruote 2.2'
 
-  #s.files = `git ls-files`.split("\n")
   s.files = Dir[
     'Rakefile',
     'lib/**/*.rb', 'spec/**/*.rb', 'test/**/*.rb',
     '*.gemspec', '*.txt', '*.rdoc', '*.md'
   ]
 
-  #s.add_runtime_dependency 'stmop'
-  s.add_runtime_dependency 'stomp', '1.1.9'
-  s.add_runtime_dependency 'ruote', ">= #{s.version}"
+  s.add_runtime_dependency 'onstomp', "~> 1.0.4"
+  s.add_runtime_dependency 'ruote', "~> 2.2.0"
   s.add_runtime_dependency 'json'
+  s.add_runtime_dependency 'parslet'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', ">= 2.6.0"
   s.add_development_dependency 'stompserver', '~> 0.9.9'

data/spec/launchitem_listener_spec.rb

@@ -1,4 +1,3 @@
-
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe RuoteStomp::LaunchitemListener do
@@ -20,48 +19,59 @@ describe RuoteStomp::LaunchitemListener do
       'fields' => { 'foo' => 'bar' }
     }.to_json
 
-    RuoteStomp::LaunchitemListener.new(@engine)
+    RuoteStomp::LaunchitemListener.new(@engine, :ignore_disconnect_on_process => true)
 
-    $stomp.publish '/queue/ruote_launchitems', json, { :persistent => true }
-    #MQ.queue('ruote_launchitems', :durable => true).publish(json)
+    finished_processing = false
 
-    sleep 0.5
+    $stomp.send('/queue/ruote_launchitems', json) do |r|
+      finished_processing = true
+    end
+    
+    begin
+      Timeout::timeout(10) do
+        while @tracer.to_s.empty?
+          print "*"
+          sleep 1
+        end
+      end
+    rescue Timeout::Error
+      fail "Timeout waiting for message"
+    end
+    
+    Thread.pass until finished_processing
 
     @engine.should_not have_errors
     @engine.should_not have_remaining_expressions
-
     @tracer.to_s.should == 'bar'
   end
 
   it 'discards corrupt process definitions' do
-
+  
     json = {
       'definition' => %{
         I'm a broken process definition
       },
       'fields' => { 'foo' => 'bar' }
     }.to_json
-
-    RuoteStomp::LaunchitemListener.new(@engine, :unsubscribe => true)
-
+  
+    RuoteStomp::LaunchitemListener.new(@engine, {:unsubscribe => true, :ignore_disconnect_on_process => true})
+  
     serr = String.new
     err = StringIO.new(serr, 'w+')
     $stderr = err
-
-    $stomp.publish '/queue/ruote_launchitems', json, { :persistent => true }
-
-    #MQ.queue('ruote_launchitems', :durable => true).publish(json)
-
+  
+    $stomp.send '/queue/ruote_launchitems', 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

@@ -26,9 +26,7 @@ describe RuoteStomp::ParticipantProxy, :type => :ruote do
     begin
       Timeout::timeout(10) do
         @msg = nil
-        #MQ.queue('test1', :durable => true).subscribe { |msg| @msg = msg }
         $stomp.subscribe("/queue/test1") do |message|
-          
           @msg = message.body
         end
         
@@ -97,8 +95,7 @@ describe RuoteStomp::ParticipantProxy, :type => :ruote do
     begin
       Timeout::timeout(5) do
         @msg = nil
-        #MQ.queue('test2', :durable => true).subscribe { |msg| @msg = msg }
-        $stomp.subscribe("/queue/test2", {}) do |message|
+        $stomp.subscribe("/queue/test2") do |message|
           @msg = message.body
         end
         loop do
@@ -132,8 +129,7 @@ describe RuoteStomp::ParticipantProxy, :type => :ruote do
       begin
         Timeout::timeout(5) do
           @msg = nil
-          #MQ.queue('test5', :durable => true).subscribe { |msg| @msg = msg }
-          $stomp.subscribe("/queue/test5", {}) do |message|
+          $stomp.subscribe("/queue/test5") do |message|
             @msg = message.body
           end
           loop do
@@ -162,7 +158,7 @@ describe RuoteStomp::ParticipantProxy, :type => :ruote do
       Timeout::timeout(10) do
   
         #MQ.queue('test6', :durable => true).subscribe { |m| msg = m }
-        $stomp.subscribe("/queue/stomp", {}) do |message|
+        $stomp.subscribe("/queue/stomp") do |message|
           msg = message.body
         end
         loop do

data/spec/receiver_spec.rb

@@ -1,9 +1,7 @@
-
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
 require 'ruote/participant'
 
-
 describe RuoteStomp::Receiver do
 
   after(:each) do
@@ -11,7 +9,6 @@ describe RuoteStomp::Receiver do
   end
 
   it "handles replies" do
-
     pdef = Ruote.process_definition :name => 'test' do
       set :field => 'foo', :value => 'foo'
       sequence do
@@ -20,28 +17,23 @@ describe RuoteStomp::Receiver do
         echo '${f:foo}'
       end
     end
-
+  
     @engine.register_participant(:stomp, RuoteStomp::ParticipantProxy)
-
-    RuoteStomp::Receiver.new(@engine)
-
+  
+    receiver = RuoteStomp::Receiver.new(@engine, :ignore_disconnect_on_process => true)
+    
     wfid = @engine.launch(pdef)
-
+      
     workitem = nil
-
+      
     begin
       Timeout::timeout(5) do
-
-        # MQ.queue('test3', :durable => true).subscribe { |msg|
-        #   wi = Ruote::Workitem.new(Rufus::Json.decode(msg))
-        #   workitem = wi if wi.wfid == wfid
-        # }
-        
-        $stomp.subscribe("/queue/test3", {}) do |message|
+      
+        $stomp.subscribe("/queue/test3") do |message|
           wi = Ruote::Workitem.new(Rufus::Json.decode(message.body))
           workitem = wi if wi.wfid == wfid
         end
-
+      
         loop do
           break unless workitem.nil?
           sleep 0.1
@@ -50,19 +42,18 @@ describe RuoteStomp::Receiver do
     rescue Timeout::Error
       fail "Timeout waiting for message"
     end
-
+      
     workitem.fields['foo'] = "bar"
+      
+    $stomp.send '/queue/ruote_workitems', Rufus::Json.encode(workitem.to_h)
 
-    #MQ.queue('ruote_workitems', :durable => true).publish(Rufus::Json.encode(workitem.to_h), :persistent => true)
-    $stomp.publish '/queue/ruote_workitems', 
-      Rufus::Json.encode(workitem.to_h), 
-      { :persistent => true }
     @engine.wait_for(wfid)
-
+      
     @engine.should_not have_errors
     @engine.should_not have_remaining_expressions
-
+      
     @tracer.to_s.should == "foo\nbar"
+    receiver.stop
   end
 
   it "launches processes" do
@@ -77,64 +68,57 @@ describe RuoteStomp::Receiver do
       },
       'fields' => { 'foo' => 'bar' }
     }.to_json
+    
+    receiver = RuoteStomp::Receiver.new(@engine, {:launchitems => true, :unsubscribe => true, :ignore_disconnect_on_process => true})
 
-    RuoteStomp::Receiver.new(@engine, :launchitems => true, :unsubscribe => true)
+    finished_processing = false
 
-    # MQ.queue(
-    #   'ruote_workitems', :durable => true
-    # ).publish(
-    #   json, :persistent => true
-    # )
+    $stomp.send('/queue/ruote_workitems', json) do |r|
+      finished_processing = true
+    end
     
-    $stomp.publish '/queue/ruote_workitems', json, { :persistent => true }
+    begin
+      Timeout::timeout(20) do
+        while @tracer.to_s.empty?
+          print "*"
+          sleep 1
+        end
+      end
+    rescue Timeout::Error
+      fail "Timeout waiting for message"
+    end
     
-
-    sleep 0.5
+    Thread.pass until finished_processing
 
     @engine.should_not have_errors
     @engine.should_not have_remaining_expressions
 
     @tracer.to_s.should == 'bar'
+    receiver.stop
   end
 
   it 'accepts a custom :queue' do
-
+  
     RuoteStomp::Receiver.new(
-      @engine, :queue => '/queue/mario', :launchitems => true, :unsubscribe => true)
-
+      @engine, :queue => '/queue/mario', :launchitems => true, :unsubscribe => true, :ignore_disconnect_on_process => true)
+  
     @engine.register_participant 'alpha', Ruote::StorageParticipant
-
+  
     json = Rufus::Json.encode({
       'definition' => "Ruote.define { alpha }"
     })
-
-    # MQ.queue(
-    #   'ruote_workitems', :durable => true
-    # ).publish(
-    #   json, :persistent => true
-    # )
     
-    $stomp.publish '/queue/ruote_workitems', 
-      json, 
-      { :persistent => true }
-
+    $stomp.send '/queue/ruote_workitems', json
+  
     sleep 1
-
+  
     @engine.processes.size.should == 0
       # nothing happened
-
-    # MQ.queue(
-    #   'mario', :durable => true
-    # ).publish(
-    #   json, :persistent => true
-    # )
-    
-    $stomp.publish '/queue/mario', 
-      json, 
-      { :persistent => true }
-
+  
+    $stomp.send '/queue/mario', json
+  
     sleep 1
-
+  
     @engine.processes.size.should == 1
       # launch happened
   end