ruote 0.9.20 → 2.1.1

data/lib/openwfe/extras/participants/decision_participants.rb

@@ -1,113 +0,0 @@
-#--
-# 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 'rubygems'
-require 'rufus/decision' # gem 'rufus-decision'
-
-require 'openwfe/utils'
-require 'openwfe/util/dollar'
-require 'openwfe/participants/participant'
-
-
-module OpenWFE
-module Extras
-
-  #
-  # Using CSV files to transform workitems
-  # This concept is called "decision participant" in OpenWFEja, here
-  # it's simply called "csv participant".
-  #
-  # See CsvTable for an explanation of the core concept behind a
-  # CsvParticipant
-  #
-  # An example :
-  #
-  #   class TestDefinition0 < ProcessDefinition
-  #     sequence do
-  #       set :field => "weather", :value => "cloudy"
-  #       set :field => "month", :value => "may"
-  #       decision
-  #       _print "${f:take_umbrella?}"
-  #     end
-  #   end
-  #
-  #
-  #   csvParticipant = CsvParticipant.new(
-  #   """
-  #   in:weather, in:month, out:take_umbrella?
-  #   ,,
-  #   raining,  ,     yes
-  #   sunny,    ,     no
-  #   cloudy,   june,   yes
-  #   cloudy,   may,    yes
-  #   cloudy,   ,     no
-  #   """)
-  #
-  #   engine.register_participant("decision", csvParticipant)
-  #
-  #   # ...
-  #
-  #   engine.launch(new OpenWFE::LaunchItem(TestDefinition0)
-  #
-  # Note that the CsvParticipant constructor also accepts a block.
-  #
-  class CsvParticipant
-    include LocalParticipant
-
-    attr_accessor :csv_table
-
-    #
-    # Builds a new CsvParticipant instance, csv_data or the block
-    # may contain a File instance, a String or an Array of Array of
-    # String instances.
-    #
-    def initialize (csv_data=nil, &block)
-
-      super()
-
-      csv_data = block.call if block
-
-      @csv_table = Rufus::DecisionTable.new csv_data
-    end
-
-    #
-    # This is the method called by the engine (actually the
-    # ParticipantExpression) when handling a workitem to this participant.
-    #
-    def consume (workitem)
-
-      fe = get_flow_expression workitem
-
-      @csv_table.transform!(FlowDict.new(fe, workitem, 'f'))
-        #
-        # default_prefix set to 'f'
-
-      reply_to_engine workitem
-    end
-  end
-
-end
-end
-

data/lib/openwfe/extras/participants/jabber_participants.rb

@@ -1,147 +0,0 @@
-#--
-# 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 'yaml'
-
-require 'openwfe/util/xml'
-require 'openwfe/util/json'
-
-require 'openwfe/extras/misc/jabber_common'
-
-if defined?( ActiveSupport )
-  # Fix broken ActiveSupport Time#to_json notation
-  class Time
-    def to_json(*a)
-      if ActiveSupport.use_standard_json_time_format
-        xmlschema.inspect
-      else
-        %("#{strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)}")
-      end
-    end
-  end
-end
-
-module OpenWFE
-  module Extras
-
-    #
-    # Use Jabber (XMPP) during a workflow to communicate with people/processes
-    # outside the running engine in an asynchrous fashion.
-    #
-    # The JabberParticipant will send a JSON encoded InFlowWorkItem to a Jabber
-    # ID specified in the 'target_id' attribute of the workitem's attributes.
-    # To change the format sent, use the 'message_format' attribute of the
-    # workitem, and set it to either 'XML' or 'YAML' (defaults to 'JSON').
-    #
-    # You can specify the JID, password and JID resource names on class level
-    # or by passing the :jabber_id, :password, or :resource keys to the
-    # construct. By default the 'participant' resoure is used.
-    #
-    # The roster management is currently dynamic as well. It will clear the
-    # roster when it starts, except for a hard coded list of contacts. As
-    # messages are sent out the roster will be populated with those JID's,
-    # making sure that the listener will respond to replies.
-    #
-    # Configuration example:
-    #
-    #   engine.register_participant(
-    #     :jabber,
-    #     OpenWFE::Extras::JabberParticipant.new( :jabber_id => 'ruote@devbox', :password => 'secret', :contacts => ['kenneth@devbox'] )
-    #   )
-    #
-    # Process example:
-    #
-    #   class JabberProcess < OpenWFE::ProcessDefinition
-    #     sequence do
-    #       jabber :wait_for_reply => true
-    #     end
-    #
-    #     set :f => 'target_jid', :val => 'kenneth.kalmer@gmail.com'
-    #   end
-    #
-    # Passing the 'wait_for_reply' parameter to the participant
-    # prevents it from replying to the engine, and thus expects the
-    # JabberListener to pick up the reply and let the process
-    # continue. By default the JabberParticipant will send the message
-    # and reply to the engine, letting the workflow continue.
-    class JabberParticipant
-      include LocalParticipant
-      include OpenWFE::Extras::JabberCommon
-
-      def initialize( options = {} )
-        configure_jabber!( options )
-        connect!
-        setup_roster!
-      end
-
-      def consume( workitem )
-        ldebug { "consuming workitem" }
-
-        if target_jid = workitem.attributes['target_jid']
-
-          unless self.connection.subscribed_to?( target_jid )
-            self.connection.add( target_jid )
-            self.connection.roster.accept_subscription( target_jid )
-          end
-
-          # Message or workitem?
-          if message = ( workitem.attributes['message'] || workitem.params['message'] )
-            self.connection.deliver( target_jid, message )
-            
-          else
-            # Sensible defaults
-            workitem.attributes.reverse_merge!({ 'format' => 'JSON' })
-
-            ldebug { "sending workitem to jid: #{target_jid}" }
-            self.connection.deliver(
-              target_jid,
-              encode_workitem( workitem, workitem.attributes['format'] )
-            )
-          end
-        else
-          lerror { "no target_jid in workitem attributes!" }
-        end
-        
-        unless workitem.params['wait-for-reply'] == true
-          reply_to_engine( workitem )
-        end
-      end
-
-      protected
-
-      def encode_workitem( wi, format = 'JSON' )
-        if format.downcase == 'xml'
-           wi.to_xml
-        elsif format.downcase == 'yaml'
-          YAML.dump( wi )
-        else
-          wi.to_h.to_json
-        end
-
-      end
-
-    end
-  end
-end

data/lib/openwfe/extras/participants/jabberparticipants.rb

@@ -1,3 +0,0 @@
-
-require File.dirname(__FILE__) + '/jabber_participants'
-

data/lib/openwfe/extras/participants/sqs_participants.rb

@@ -1,108 +0,0 @@
-#--
-# 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 'rubygems'
-require 'rufus/sqs' # gem 'rufus-sqs'
-
-require 'openwfe/participants/participant'
-
-
-module OpenWFE
-module Extras
-
-  #
-  # This participant dispatches its workitem to an Amazon SQS queue.
-  #
-  # If the queue doesn't exist, the participant will create it.
-  #
-  # a small example :
-  #
-  #   # ...
-  #   engine.register_participant(:sqs0, SqsParticipant.new("workqueue0"))
-  #   # ...
-  #
-  # For more details about SQS :
-  # http://aws.amazon.com
-  #
-  class SqsParticipant
-    include LocalParticipant
-
-    attr_reader :queue, :queue_service
-
-    #
-    # Builds an SqsParticipant instance pointing to a given queue.
-    # (Refer to the SQS service on how to set up AWS key ids).
-    #
-    # By default the host_name is 'queue.amazonaws.com'
-    #
-    def initialize (queue_name, host_name=nil)
-
-      @queue_name = queue_name
-
-      @queue_service = Rufus::SQS::QueueService.new(host_name)
-
-      @queue_service.create_queue @queue_name
-        # make sure the queue exists
-
-      @queue = @queue_service.get_queue @queue_name
-    end
-
-    #
-    # The method called by the engine when it has a workitem for this
-    # participant.
-    #
-    def consume (workitem)
-
-      msg = encode_workitem(workitem)
-
-      msg_id = @queue_service.put_message(@queue, msg)
-
-      ldebug { "consume() msg sent to queue #{@queue.path} id is #{msg_id}" }
-    end
-
-    protected
-
-      #
-      # Turns the workitem into a Hash, pass it through YAML and
-      # encode64 the result.
-      #
-      # Override this method as needed.
-      #
-      # Something of 'text/plain' flavour should be returned.
-      #
-      def encode_workitem (wi)
-
-        msg = wi.to_h
-        msg = YAML.dump(msg)
-        msg = Base64.encode64(msg)
-        msg
-      end
-  end
-
-end
-end

data/lib/openwfe/extras/participants/twitter_participants.rb

@@ -1,162 +0,0 @@
-#--
-# 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.
-#++
-
-#--
-# this participant requires the twitter4r gem
-#
-# http://rubyforge.org/projects/twitter4r/
-#
-# atom-tools' license is X11/MIT
-#++
-
-
-#require 'rubygems'
-#gem 'twitter4r', '0.2.3'
-require 'twitter' # gem 'twitter4r'
-
-require 'openwfe/utils'
-require 'openwfe/participants/participant'
-
-
-module OpenWFE
-module Extras
-
-  #
-  # Sometimes email is a bit too heavy for notification, this participant
-  # emit messages via a twitter account.
-  #
-  # By default, the message emitted is the value of the field
-  # "twitter_message", but this behaviour can be changed by overriding
-  # the extract_message() method.
-  #
-  # If the extract_message doesn't find a message, the message will
-  # be the result of the default_message method call, of course this
-  # method is overridable as well.
-  #
-  class TwitterParticipant
-    include OpenWFE::LocalParticipant
-
-    #
-    # The actual twitter4r client instance.
-    #
-    attr_accessor :client
-
-    #
-    # Keeping the initialization params at hand (if any)
-    #
-    attr_accessor :params
-
-    #
-    # This participant expects a login (twitter user name) and a password.
-    #
-    # The only optional param for now is :no_ssl, which you can set to
-    # true if you want the connection to twitter to not use SSL.
-    # (seems like the Twitter SSL service is available less often
-    # than the plain http one).
-    #
-    def initialize (login, password, params={})
-
-      super()
-
-      Twitter::Client.configure do |conf|
-        conf.protocol = :http
-        conf.port = 80
-      end if params[:no_ssl] == true
-
-      @client = Twitter::Client.new(
-        :login => login,
-        :password => password)
-
-      @params = params
-    end
-
-    #
-    # The method called by the engine when a workitem for this
-    # participant is available.
-    #
-    def consume (workitem)
-
-      user, tmessage = extract_message workitem
-
-      tmessage = default_message(workitem) unless tmessage
-
-      begin
-
-        if user
-          #
-          # direct message
-          #
-          tuser = @client.user user.to_s
-          @client.message :post, tmessage, tuser
-        else
-          #
-          # just the classical status
-          #
-          @client.status :post, tmessage
-        end
-
-      rescue Exception => e
-
-        linfo do
-          "consume() not emitted twitter, because of " +
-          OpenWFE::exception_to_s(e)
-        end
-      end
-
-      reply_to_engine(workitem) if @application_context
-    end
-
-    protected
-
-      #
-      # Returns a pair : the target user (twitter login name)
-      # and the message (or status message if there is no target user) to
-      # send to Twitter.
-      #
-      # This default implementation returns a pair composed with the
-      # values of the field 'twitter_target' and of the field
-      # 'twitter_message'.
-      #
-      def extract_message (workitem)
-
-        [ workitem.attributes['twitter_target'],
-          workitem.attributes['twitter_message'] ]
-      end
-
-      #
-      # Returns the default message (called when the extract_message
-      # returned nil as the second element of its pair).
-      #
-      # This default implementation simply returns the workitem
-      # FlowExpressionId instance in its to_s() representation.
-      #
-      def default_message (workitem)
-
-        workitem.fei.to_s
-      end
-  end
-
-end
-end
-