ruote 0.9.20 → 2.1.1

data/lib/openwfe/listeners/listener.rb

@@ -1,86 +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 'openwfe/logging'
-require 'openwfe/workitem'
-require 'openwfe/contextual'
-
-
-module OpenWFE
-
-  #
-  # this mixin module provides two protected methods, handle_item() and
-  # filter_item(). They can be easily overriden to add some special
-  # behaviours.
-  #
-  module WorkItemListener
-
-    include Contextual
-    include Logging
-    include OwfeServiceLocator
-
-    protected
-
-    #
-    # Simply considers the object as a workitem and feeds it to the
-    # engine.
-    #
-    def handle_item (item)
-
-      filter_items(item)
-
-      get_engine.reply(item)
-    end
-
-    #
-    # The base implementation is just empty, feel free to override it
-    # if you need to filter workitems.
-    #
-    # One example :
-    #
-    #   class MyListener
-    #     include WorkItemListener
-    #
-    #     protected
-    #
-    #       #
-    #       # MyListener doesn't accept launchitems
-    #       #
-    #       def filter_items (item)
-    #         raise "launchitems not allowed" \
-    #           if item.is_a?(OpenWFE::LaunchItem)
-    #       end
-    #   end
-    #
-    def filter_items (item)
-
-      #raise(
-      #  "listener of class '#{self.class.name}' "+
-      #  "doesn't accept launchitems")
-    end
-  end
-
-end
-

data/lib/openwfe/listeners/listeners.rb

@@ -1,135 +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 'fileutils'
-
-require 'rufus/scheduler'
-
-require 'openwfe/service'
-require 'openwfe/rudefinitions'
-require 'openwfe/listeners/listener'
-
-
-#
-# some base listener implementations
-#
-module OpenWFE
-
-  #
-  # Polls a directory for incoming workitems (as files).
-  #
-  # Workitems can be instances of InFlowWorkItem or LaunchItem.
-  #
-  #   require 'openwfe/listeners/listeners'
-  #
-  #   engine.add_workitem_listener(
-  #     OpenWFE::FileListener,
-  #     :frequency => '500',
-  #     :folder => '/var/in')
-  #
-  # In this example, the directory /var/in/ will be polled every 500
-  # milliseconds for incoming workitems (or launchitems).
-  #
-  # The default folder is ./work/in/
-  # The listener will make sure to create the folder if not present.
-  #
-  # You can override the load_object(path) method to manage other formats
-  # then YAML.
-  #
-  class FileListener < Service
-
-    include WorkItemListener
-    include Rufus::Schedulable
-
-    attr_reader :workdir
-
-    def initialize (service_name, options)
-
-      super
-
-      @workdir = options[:folder] || 'in/'
-
-      @workdir = "#{get_work_directory}/#{@workdir}" \
-        unless @workdir.match(/^\//)
-
-      FileUtils.mkdir_p(@workdir) \
-        unless File.exist?(@workdir)
-
-      raise("workdir #{@workdir} is not a directory, cannot setup listener") \
-        unless File.directory?(@workdir)
-
-      linfo { "new() workdir is '#{@workdir}'" }
-    end
-
-    #
-    # Will 'find' files in the work directory (by default ./work/in/),
-    # extract the workitem in them and feed it back to the engine.
-    #
-    def trigger (params)
-
-      #ldebug { "trigger()" }
-
-      FileUtils.mkdir_p(@workdir) unless File.exist?(@workdir)
-
-      Dir["#{@workdir}/*.yaml"].each do |path|
-
-        #ldebug { "trigger() considering file '#{path}'" }
-
-        begin
-
-          object = load_object(path)
-
-          handle_item(object) if object
-
-        rescue Exception => e
-
-          linfo do
-            "trigger() failure while loading from '#{path}'. " +
-            "Resuming... \n" +
-            OpenWFE::exception_to_s(e)
-          end
-        end
-      end
-    end
-
-    protected
-
-    #
-    # Turns a file into a Ruby instance.
-    # This base implementation does it via YAML.
-    #
-    # (override at will)
-    #
-    def load_object (path)
-
-      o = YAML.load_file(path)
-      File.delete(path)
-      o
-    end
-  end
-
-end
-

data/lib/openwfe/logging.rb

@@ -1,108 +0,0 @@
-#--
-# Copyright (c) 2006-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 'logger'
-require 'openwfe/utils'
-
-
-module OpenWFE
-
-  #
-  # A Mixin for adding logging method to any class
-  #
-  module Logging
-
-    def ldebug (message=nil, &block)
-      do_log(:debug, message, &block)
-    end
-
-    def linfo (message=nil, &block)
-      do_log(:info, message, &block)
-    end
-
-    def lwarn (message=nil, &block)
-      do_log(:warn, message, &block)
-    end
-
-    def lerror (message=nil, &block)
-      do_log(:error, message, &block)
-    end
-
-    def lfatal (message=nil, &block)
-      do_log(:fatal, message, &block)
-    end
-
-    def lunknown (message=nil, &block)
-      do_log(:unknown, message, &block)
-    end
-
-    def llog (level, message=nil, &block)
-      do_log(level, message, &block)
-    end
-
-    #
-    # A simplification of caller_to_s for direct usage when debugging
-    #
-    def ldebug_callstack (msg, max_lines=nil)
-
-      ldebug { "#{msg}\n" + OpenWFE::caller_to_s(9, max_lines) }
-    end
-
-    private
-
-      def do_log (level, message, &block)
-
-        return unless $OWFE_LOG
-
-        logblock = lambda do
-          if block
-            "#{log_prepare(message)} - #{block.call}"
-          else
-            "#{log_prepare(message)}"
-          end
-        end
-
-        $OWFE_LOG.send level, &logblock
-      end
-
-      def log_prepare (message)
-
-        return log_author() unless message
-        "#{log_author} - #{message}"
-      end
-
-      def log_author
-
-        if respond_to?(:service_name)
-          "#{self.class} '#{self.service_name}'"
-        else
-          "#{self.class}"
-        end
-      end
-
-  end
-
-end
-

data/lib/openwfe/participants.rb

@@ -1,5 +0,0 @@
-
-# just for nicer looking examples
-
-require 'openwfe/participants/store_participants'
-

data/lib/openwfe/participants/mail_participants.rb

@@ -1,216 +0,0 @@
-#--
-# Copyright (c) 2007-2009, Alain Hoang and John Mettraux, OpenWFE.org
-#
-# 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 'net/smtp'
-
-require 'openwfe/participants/participant'
-require 'openwfe/participants/participants'
-
-
-module OpenWFE
-
-  #
-  # MailParticipant is a simplification of EmailNotificationParticipant.
-  #
-  # It's initialized in this way :
-  #
-  #   require 'openwfe/participants/mail_participants'
-  #
-  #   p = OpenWFE::MailParticipant.new(
-  #     :smtp_server => "mailhost.ourcompany.co.jp",
-  #     :from_address => "bpms@our.ourcompany.co.jp",
-  #     :template => "Dear ${f:name}, you've got mail")
-  #
-  # or
-  #
-  #   p = OpenWFE::MailParticipant.new(
-  #     :smtp_server => "mailhost.ourcompany.co.jp",
-  #     :smtp_port => 25,
-  #     :from_address => "bpms@our.ourcompany.co.jp"
-  #   ) do |workitem|
-  #     s = ""
-  #     s << "Dear #{workitem.name},\n"
-  #     s << "\n"
-  #     s << "it's #{Time.new.to_s} and you've got mail"
-  #     s
-  #   end
-  #
-  # As with EmailNotificationParticipant, the "to" address for your email
-  # is taken from the workitem's <tt>email_target</tt> field. So, to have
-  # the email sent to "foo@nowhere.com", set your workitem's
-  # <tt>email_target</tt> field to "foo@nowhere.com" prior to feeding it
-  # to the mail participant.
-  #
-  # Likewise, you can also override the :from_address value by setting the
-  # workitems <tt>email_from</tt> field.
-  #
-  # When passing the mail template as a block, you have
-  # four possible arities :
-  #   { |workitem| ... }
-  #   { |participant_expression, workitem| ... }
-  #   { |participant_expression, participant_instance, workitem| ... }
-  #   { ... }
-  #
-  # The smtp server and host default to "127.0.0.1" / 25.
-  #
-  class MailParticipant
-
-    include LocalParticipant
-    include TemplateMixin
-
-    def initialize (params, &block)
-
-      @smtp_server = params[:smtp_server]
-      @smtp_port = params[:smtp_port]
-      @from_address = params[:from_address]
-      @template = params[:template]
-
-      @block_template = block
-
-      # some defaults
-
-      @smtp_server = "127.0.0.1" unless @smtp_server
-      @smtp_port = 25 unless @smtp_port
-    end
-
-    #
-    # The method called each time a workitem reaches this participant
-    #
-    def consume (workitem)
-
-      fe = get_flow_expression(workitem)
-      to_address = workitem.email_target
-
-      #
-      # 1. Expand variables
-
-      msg  = eval_template workitem
-
-      from_address = workitem.email_from rescue @from_address
-
-      #puts "msg >>>\n#{msg}<<<"
-
-      #
-      # 2. Send message
-
-      Net::SMTP.start(@smtp_server, @smtp_port) do |smtp|
-        smtp.send_message(msg, from_address, to_address)
-      end
-
-      #
-      # 3. Reply to engine
-
-      reply_to_engine(workitem)
-    end
-  end
-
-  #
-  # This participant is used to send an email notification.
-  #
-  # It's perhaps better to use MailParticipant which is simpler to
-  # initialize. This class is anyway an extension of MailParticipant.
-  #
-  #   require 'openwfe/participants/mail_participants'
-  #
-  #   @engine.register_participant(
-  #     'eno',
-  #     OpenWFE::EmailNotificationParticipant.new(
-  #       "googlemail.l.google.com",
-  #       25,
-  #       "eno@outoftheblue.co.jp",
-  #       """Subject: test 0
-  #
-  #   0 : ${r:Time.new}
-  #   1 : ${f:customer_name}
-  #       """))
-  #
-  # And then, from the process definition :
-  #
-  #   class TestDefinition0 < OpenWFE::ProcessDefinition
-  #     sequence do
-  #       set :field => 'email_target' do
-  #         "whatever56x56@gmail.com"
-  #       end
-  #       set :field => 'customer_name' do
-  #         "Monsieur Toto"
-  #       end
-  #       participant :ref => 'eno'
-  #     end
-  #   end
-  #
-  # The 'template' parameter may contain an instance of File instead of
-  # an instance of String.
-  #
-  #   @engine.register_participant(
-  #     'eno',
-  #     OpenWFE::EmailNotificationParticipant.new(
-  #       "googlemail.l.google.com",
-  #       25,
-  #       "eno@outoftheblue.co.jp",
-  #       File.new("path/to/my/mail/template.txt")))
-  #
-  # You can also define the email template as a Ruby block :
-  #
-  #   p = EmailNotificationParticipant.new("googlemail.l.google.com", 25, "eno@co.co.jp") do | flowexpression, participant, workitem |
-  #
-  #     # generally, only the workitem is used within a template
-  #
-  #     s = ""
-  #
-  #     # the header of the message
-  #
-  #     s << "Subject: #{workitem.subject}\n\n"
-  #
-  #     # then, the body
-  #
-  #     workitem.attributes.each do |key, value|
-  #       s << "- '#{k}' => '#{value}'\n"
-  #     end
-  #     s << "\ndone.\n"
-  #   end
-  #
-  # Note that the template integrates the subject and requires then a double
-  # newline before the message body.
-  #
-  class EmailNotificationParticipant < MailParticipant
-
-    #
-    # Create a new email notification participant.  Requires
-    # a mail server, port, a from address, and a mail message template
-    #
-    def initialize (
-      smtp_server, smtp_port, from_address, template=nil, &block)
-
-      params = {}
-      params[:smtp_server] = smtp_server
-      params[:smtp_port] = smtp_port
-      params[:from_address] = from_address
-
-      params[:template] = template if template
-
-      super(params, &block)
-    end
-  end
-end