ruote 0.9.19 → 0.9.20

data/lib/openwfe/extras/listeners/jabber_listeners.rb

@@ -0,0 +1,102 @@
+#--
+# Copyright (c) 2008-2009, Kenneth Kalmer, opensourcery.co.za
+#
+# 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.
+#
+# Made in Africa. Kenneth Kalmer of opensourcery.co.za
+#++
+
+
+require 'thread'
+require 'yaml'
+
+require 'openwfe/util/xml'
+require 'openwfe/util/json'
+require 'openwfe/service'
+require 'openwfe/listeners/listener'
+require 'openwfe/extras/misc/jabber_common'
+
+module OpenWFE
+  module Extras
+
+    #
+    # Use Jabber (XMPP) during a workflow to communicate with people/processes
+    # outside the running engine in an asynchrous fashion.
+    #
+    class JabberListener < Service
+      include WorkItemListener
+      include Rufus::Schedulable
+      include OpenWFE::Extras::JabberCommon
+
+      def initialize( service_name, options )
+
+        @mutex = Mutex.new
+
+        configure_jabber!( options )
+
+        service_name = "#{self.class}::#{self.class.jabber_id}"
+        super( service_name, options )
+
+        connect!
+        setup_roster!
+      end
+
+      def trigger( params )
+        @mutex.synchronize do
+
+          ldebug { "trigger()" }
+
+          self.connection.received_messages do |message|
+            busy do
+              ldebug { "processing message: #{message.inspect}" }
+              # the sender must be on our roster
+
+              workitem = decode_workitem( message.body )
+              ldebug { "workitem: #{workitem.inspect}" }
+              handle_item( workitem )
+            end
+          end
+        end
+      end
+
+      def stop
+        self.connection.disconnect rescue nil
+      end
+
+      protected
+
+      # Complicated guesswork that needs to happen here to detect the format
+      def decode_workitem( msg )
+        ldebug { "decoding workitem from: #{msg}" }
+
+        # YAML?
+        if msg.index('ruby/object:OpenWFE::InFlowWorkItem')
+          YAML.load( msg )
+        # XML?
+        elsif msg =~ /^<.*>$/m
+          OpenWFE::Xml.workitem_from_xml( msg )
+        # Assume JSON encoded Hash
+        else
+          hash = defined?(ActiveSupport::JSON) ? ActiveSupport::JSON.decode(msg) : JSON.parse(msg)
+          OpenWFE.workitem_from_h( hash )
+        end
+      end
+    end
+  end
+end

data/lib/openwfe/extras/listeners/jabberlisteners.rb

@@ -0,0 +1,26 @@
+#--
+# Copyright (c) 2009, John Mettraux, jmettraux@gmail.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.
+#
+# Made in Japan.
+#++
+
+require File.dirname(__FILE__) + '/jabber_listeners'
+

data/lib/openwfe/extras/listeners/sqs_listeners.rb

@@ -0,0 +1,128 @@
+#--
+# Copyright (c) 2007-2009, John Mettraux, jmettraux@gmail.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.
+#
+# Made in Japan.
+#++
+
+
+require 'yaml'
+require 'base64'
+require 'thread'
+
+require 'openwfe/service'
+require 'openwfe/listeners/listener'
+
+require 'rufus/sqs' # gem 'rufus-sqs'
+
+
+module OpenWFE
+module Extras
+
+  #
+  # Polls an Amazon SQS queue for workitems
+  #
+  # Workitems can be instances of InFlowWorkItem or LaunchItem.
+  #
+  #   require 'openwfe/extras/listeners/sqslisteners'
+  #
+  #   ql = OpenWFE::SqsListener("workqueue1", engine.application_context)
+  #
+  #   engine.add_workitem_listener(ql, "2m30s")
+  #     #
+  #     # thus, the engine will poll our "workqueue1" SQS queue
+  #     # every 2 minutes and 30 seconds
+  #
+  class SqsListener < Service
+
+    include WorkItemListener
+    include Rufus::Schedulable
+
+    #
+    # The name of the Amazon SQS whom this listener cares for
+    #
+    attr_reader :queue_name
+
+    def initialize (service_name, opts)
+
+      @mutex = Mutex.new
+
+      @queue_name = opts[:queue_name] || service_name
+
+      super(service_name, opts)
+
+      linfo { "new() queue is '#{@queue_name}'" }
+    end
+
+    #
+    # polls the SQS for incoming messages
+    #
+    def trigger (params)
+
+      @mutex.synchronize do
+        # making sure executions do not overlap
+
+        ldebug { "trigger()" }
+
+        qs = Rufus::SQS::QueueService.new
+
+        qs.create_queue(@queue_name)
+          # just to be sure it is there
+
+        loop do
+
+          l = qs.get_messages(@queue_name, :timeout => 0, :count => 255)
+
+          break if l.length < 1
+
+          l.each do |msg|
+
+            o = decode_object(msg)
+
+            handle_item(o)
+
+            msg.delete
+
+            ldebug { "trigger() handled successfully msg #{msg.message_id}" }
+          end
+        end
+      end
+    end
+
+    #
+    # Extracts a workitem from the message's body.
+    #
+    # By default, this listeners assumes the workitem is stored in
+    # its "hash form" (not directly as a Ruby InFlowWorkItem instance).
+    #
+    # LaunchItem instances (as hash as well) are also accepted.
+    #
+    def decode_object (message)
+
+      o = Base64.decode64(message.message_body)
+      o = YAML.load(o)
+      o = OpenWFE::workitem_from_h(o)
+      o
+    end
+  end
+
+end
+end
+

data/lib/openwfe/extras/misc/activityfeed.rb

@@ -1,49 +1,34 @@
-#
 #--
-# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# Copyright (c) 2007-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# 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:
 #
-# . Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . Neither the name of the "OpenWFE" nor the names of its contributors may be
-#   used to endorse or promote products derived from this software without
-#   specific prior written permission.
+# 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.
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# Made in Japan.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
-
-#
+#--
 # this participant requires atom-tools from
 #
 # http://code.necronomicorp.com/trac/atom-tools
 #
 # atom-tools' license is X11/MIT
-#
+#++
 
 #require 'monitor'
 

data/lib/openwfe/extras/misc/jabber_common.rb

@@ -0,0 +1,122 @@
+#--
+# Copyright (c) 2008-2009, Kenneth Kalmer, opensourcery.co.za
+#
+# 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.
+#
+# Made in Africa. Kenneth Kalmer of opensourcery.co.za
+#++
+
+
+require 'activesupport'
+require 'xmpp4r-simple'
+
+
+module OpenWFE
+  module Extras
+
+    # Common functionality shared by the JabberListener and
+    # JabberParticipant implementations in ruote.
+    module JabberCommon
+
+      def self.included( base )
+
+        base.instance_eval do
+          # JabberID to use
+          @@jabber_id = nil
+          cattr_accessor :jabber_id
+
+          # Jabber password
+          @@password = nil
+          cattr_accessor :password
+
+          # Jabber resource
+          @@resource = nil
+          cattr_accessor :resource
+
+          # Contacts that are always included in the participants roster
+          @@contacts = []
+          cattr_accessor :contacts
+        end
+        
+      end
+      
+      # Configures this class from the provided options hash. Looking
+      # for (and removes) the following keys from the hash:
+      #
+      #   * :connection => Already configured xmpp4r-simple instance
+      #   * :jabber_id  => Jabber ID to use
+      #   * :password   => Password for the JID
+      #   * :resource   => (Optional) Name of the resource
+      #   * :contacts   => (Array) List of contacts to use
+      #
+      # If a connection is provided, the :jabber_id, :password,
+      # :resource and :contact keys are ignored
+      def configure_jabber!( options )
+        unless @connection = options.delete(:connection)
+          self.class.jabber_id = options.delete(:jabber_id)
+          self.class.password  = options.delete(:password)
+          self.class.resource  = options.delete(:resource) || 'ruote'
+          self.class.contacts  = options.delete(:contacts) || []
+        end
+      end
+
+      def connection
+        @connection.reconnect unless @connection.connected?
+        @connection
+      end
+
+      protected
+
+      def connect!
+        if @connection.nil?
+          jid = self.class.jabber_id + '/' + self.class.resource
+          @connection = Jabber::Simple.new( jid, self.class.password )
+          @connection.status( :chat, "#{self.class} waiting for instructions" )
+        end
+      end
+
+      # Clear all contacts from the roster, and build up the roster again
+      def setup_roster!
+        # Clean the roster
+        self.connection.roster.items.each_pair do |jid, roster_item|
+          jid = jid.strip.to_s
+          unless self.class.contacts.include?( jid )
+            self.connection.remove( jid )
+          end
+        end
+        
+        # Add missing contacts
+        self.class.contacts.each do |contact|
+          unless self.connection.subscribed_to?( contact )
+            self.connection.add( contact )
+            self.connection.roster.accept_subscription( contact )
+          end
+        end
+      end
+
+      # Change status to 'busy' while performing a command, and back to 'chat'
+      # afterwards
+      def busy( &block )
+        self.connection.status( :dnd, "Working..." )
+        yield
+        self.connection.status( :chat, "JabberListener waiting for instructions" )
+      end
+    end
+  end
+end