openwferu-extras 0.9.12.863

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

@@ -0,0 +1,198 @@
+#
+#--
+# Copyright (c) 2007, 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:
+# 
+# . Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.  
+# 
+# . 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.
+# 
+# . 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.
+# 
+# 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.
+#++
+#
+# $Id$
+#
+
+#
+# "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'
+
+require 'rubygems'
+
+begin
+    require 'atom/collection'
+rescue LoadError
+    #
+    # soft dependency on 'atom-tools'
+    #
+    puts
+    puts
+    puts "'atom/collection' is missing. You can install with :"
+    puts
+    puts "    [sudo] gem install atom-tools"
+    puts
+    puts
+    exit 1
+end
+
+require 'openwfe/participants/participant'
+
+
+module OpenWFE
+module Extras
+
+    #
+    # Stores the incoming workitem into an 'atom feed'
+    #
+    # An example :
+    #
+    #     feed0 = AtomParticipant.new(
+    #         20,                          # no more than 20 entries are kept
+    #         """
+    #         <p>
+    #             <h1>${f:colour}</h1>
+    #         </p>
+    #         """)                         # the template for each entry
+    #
+    # The 'template' parameter may contain an instance of File instead of
+    # an instance of String.
+    #
+    #     feed0 = AtomParticipant.new(
+    #         20, File.new("path/to/my/atom/template.txt")
+    #
+    # The template can be passed as the second parameter (after the max entry
+    # count) or as a block :
+    #
+    #     feed1 = AtomParticipant.new(20) do |flow_expression, atom_participant, workitem|
+    #         #
+    #         # usually only the workitem parameter is used
+    #         # but the other two allow for advanced tricks...
+    #
+    #         atom_participant.content_type = "xml"
+    #             # by default, it's "xhtml"
+    #
+    #         s = "<task>"
+    #         s << "<name>#{workitem.task_name}</name>"
+    #         s << "<assignee>#{workitem.task_assignee}</assignee>"
+    #         s << "<duedate>#{workitem.task_duedate}</duedate>"
+    #         s << "</task>"
+    #
+    #         # the block is supposed to 'return' a string which is the
+    #         # effective template
+    #     end
+    #
+    # This participant uses 
+    # "atom-tools" from http://code.necronomicorp.com/trac/atom-tools
+    #
+    #
+    class AtomParticipant
+        include LocalParticipant, MonitorMixin
+
+        attr_accessor \
+            :content_type       # blocks may manipulate them
+
+        def initialize (max_item_count, template=nil, &block)
+
+            super()
+
+            @template = template
+            @max_item_count = max_item_count
+            @block_template = block
+
+            @feed = Atom::Collection.new("http://localhost")
+            @content_type = "xhtml"
+        end
+
+        def consume (workitem)
+
+            e = Atom::Entry.new
+
+            e.id = \
+                "#{workitem.fei.workflow_instance_id}--" +
+                "#{workitem.fei.expression_id}"
+
+            e.title = workitem.atom_entry_title
+            e.content = render(workitem)
+
+            e.content["type"] = @content_type
+
+            @feed << e
+
+            @feed = @feed[0, @max_item_count] \
+                if @feed.length > @max_item_count
+
+            publish workitem
+
+            reply_to_engine workitem
+        end
+
+        protected
+
+            def render (workitem)
+
+                fe = get_flow_expression(workitem)
+
+                template = if @block_template
+                    #@block_template.call(fe, self, workitem)
+                    call_block @block_template, workitem
+                elsif @template
+                    if @template.kind_of? File
+                        @template.readlines
+                    else
+                        @template.to_s
+                    end
+                else
+                    "(no template given)"
+                end
+
+                OpenWFE::dosub(template, fe, workitem)
+            end
+
+            #
+            # For the moment, just dumps the feed into a file.
+            #
+            def publish (workitem)
+                synchronize do
+                    filename = "work/atom_#{workitem.participant_name}.xml"
+                    f = File.open(filename, "w")
+                    f << @feed.to_s
+                    f.close()
+                end
+            end
+    end
+
+end
+end
+

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

@@ -0,0 +1,129 @@
+#
+#--
+# Copyright (c) 2007, 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:
+# 
+# . Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.  
+# 
+# . 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.
+# 
+# . 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.
+# 
+# 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.
+#++
+#
+# $Id$
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+require 'openwfe/utils'
+require 'openwfe/util/dollar'
+require 'openwfe/participants/participant'
+require 'openwfe/extras/util/csvtable'
+
+include OpenWFE
+
+
+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
+    #         def make
+    #             process_definition :name => "test0", :revision => "0" do
+    #                 sequence do
+    #                     set :field => "weather", :value => "cloudy"
+    #                     set :field => "month", :value => "may"
+    #                     decision
+    #                     _print "${f:take_umbrella?}"
+    #                 end
+    #             end
+    #         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 = CsvTable.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)
+            workitem = @csv_table.transform_wi(fe, workitem)
+            reply_to_engine(workitem)
+        end
+    end
+
+end
+end
+

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

@@ -0,0 +1,124 @@
+#
+#--
+# Copyright (c) 2007, 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:
+# 
+# . Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.  
+# 
+# . 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.
+# 
+# . 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.
+# 
+# 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"
+#
+# John Mettraux at openwfe.org
+#
+
+require 'yaml'
+require 'base64'
+
+#require 'openwfe/utils'
+#require 'openwfe/rudefinitions'
+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 = 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 do 
+                "consume() msg sent to queue #{@queue.path} id is #{msg_id}"
+            end
+        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