ruote-extras 0.9.18

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

@@ -0,0 +1,127 @@
+#
+#--
+# 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:
+# 
+# . 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 '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/sqsparticipants.rb

@@ -0,0 +1,125 @@
+#
+#--
+# 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:
+# 
+# . 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 '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 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

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

@@ -0,0 +1,176 @@
+#
+#--
+# 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:
+# 
+# . 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
+#
+
+#
+# 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
+

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: ruote-extras
+version: !ruby/object:Gem::Version 
+  version: 0.9.18
+platform: ruby
+authors: 
+- John Mettraux
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-22 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: 
+email: john at openwfe dot org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/openwfe/extras/engine
+- lib/openwfe/extras/engine/db_persisted_engine.rb
+- lib/openwfe/extras/expool
+- lib/openwfe/extras/expool/dberrorjournal.rb
+- lib/openwfe/extras/expool/dbexpstorage.rb
+- lib/openwfe/extras/listeners
+- lib/openwfe/extras/listeners/sqslisteners.rb
+- lib/openwfe/extras/misc
+- lib/openwfe/extras/misc/activityfeed.rb
+- lib/openwfe/extras/misc/basecamp.rb
+- lib/openwfe/extras/participants
+- lib/openwfe/extras/participants/activeparticipants.rb
+- lib/openwfe/extras/participants/atomfeed_participants.rb
+- lib/openwfe/extras/participants/atompub_participants.rb
+- lib/openwfe/extras/participants/basecamp_participants.rb
+- lib/openwfe/extras/participants/csvparticipants.rb
+- lib/openwfe/extras/participants/sqsparticipants.rb
+- lib/openwfe/extras/participants/twitterparticipants.rb
+has_rdoc: false
+homepage: http://openwferu.rubyforge.org/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: openwferu
+rubygems_version: 1.1.0
+signing_key: 
+specification_version: 2
+summary: OpenWFEru extras (sqs, csv, ...)
+test_files: []
+