ruote-extras 0.9.18

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

@@ -0,0 +1,174 @@
+#
+#--
+# 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 atom-tools from
+#
+# http://code.necronomicorp.com/trac/atom-tools 
+#
+# atom-tools' license is X11/MIT
+#
+
+require 'monitor'
+
+#require 'rubygems'
+require 'atom/collection' # gem 'atom-tools'
+
+require 'openwfe/participants/participant'
+
+
+module OpenWFE::Extras
+
+    #
+    # Stores the incoming workitem into an 'atom feed'
+    #
+    # An example :
+    #
+    #     feed0 = AtomFeedParticipant.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 = AtomFeedParticipant.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 = AtomFeedParticipant.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 AtomFeedParticipant
+        include MonitorMixin
+        include OpenWFE::LocalParticipant
+        include OpenWFE::TemplateMixin
+
+        #
+        # Made accessible so that blocks may set it.
+        #
+        attr_accessor :content_type
+
+        def initialize (max_item_count, template=nil, &block)
+
+            super() # very important as this class includes MonitorMixin
+
+            @template = template
+            @max_item_count = max_item_count
+            @block_template = block
+
+            @feed = Atom::Feed.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.entries.size > @max_item_count
+
+            publish workitem
+
+            reply_to_engine workitem
+        end
+
+        protected
+
+            #
+            # This base implementation simply calls the eval_template()
+            # method of the TemplateMixin.
+            # Feel free to override this render() method for custom 
+            # representations.
+            #
+            def render (workitem)
+
+                eval_template 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
+

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

@@ -0,0 +1,268 @@
+#
+#--
+# 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 atom-tools from
+#
+# http://code.necronomicorp.com/trac/atom-tools 
+#
+# atom-tools' license is X11/MIT
+#
+
+require 'yaml'
+require 'rexml/document'
+
+require 'openwfe/participants/participants'
+
+#require 'rubygems'
+require 'atom/entry' # gem 'atom-tools'
+require 'atom/collection'
+
+
+module OpenWFE::Extras
+
+    #
+    # This participants posts (as in HTTP POST) a workitem 
+    # to an AtomPub enabled resource.
+    #
+    #     target_uri = "https://openwferu.wordpress.com/wp-app.php/posts"
+    #
+    #     params = {}
+    #     params[:username] = 'jmettraux'
+    #     params[:password] = ENV['WORDPRESS_PASSWORD']
+    #     params[:categories] = 'openwferu, test'
+    #     
+    #     engine.register_participant(
+    #         "app", OpenWFE::Extras::AtomPubParticipant.new target_uri, params)
+    #
+    # This base implementation dumps workitem as YAML in the entry content.
+    #
+    # See BlogParticipant for a human-oriented blog posting participant.
+    #
+    class AtomPubParticipant
+        include OpenWFE::LocalParticipant
+
+        #
+        # The URI to post to
+        #
+        attr_accessor :target_uri
+
+        attr_accessor :author_name, :author_uri
+
+
+        def initialize (target_uri, params)
+
+            @target_uri = target_uri
+
+            @username = params[:username]
+            @password = params[:password]
+
+            @author_name = \
+                params[:author_name] || self.class.name
+            @author_uri = \
+                params[:author_uri] || "http://openwferu.rubyforge.org"
+
+
+            @categories = params[:categories] || []
+            @categories = @categories.split(",") if @categories.is_a?(String)
+            @categories = Array(@categories)
+        end
+
+        #
+        # The incoming workitem will generate an atom entry that will
+        # get posted to the target URI.
+        #
+        # This consume() method returns the URI (as a String) where the
+        # just uploaded post can be edited.
+        #
+        def consume (workitem)
+
+            entry = Atom::Entry.new
+            entry.updated! # set updated time to now
+
+            render_author entry, workitem
+            render_categories entry, workitem
+            render_content entry, workitem
+
+            h = Atom::HTTP.new
+            h.user = @username
+            h.pass = @password
+            h.always_auth = :basic
+            
+            res = Atom::Collection.new(@target_uri, h).post!(entry)
+
+            # initial implementation
+            # don't catch an error, let the process fail
+
+            #res.read_body
+            extract_new_link res
+        end
+
+        protected
+
+            #
+            # This base implementation simply uses a YAML dump of the workitem
+            # as the post content (with a content type of 'html').
+            #
+            def render_content (entry, workitem)
+
+                entry.title = \
+                    workitem.participant_name + " " +
+                    workitem.fei.expression_id + " " +
+                    workitem.fei.workflow_instance_id
+
+                entry.content = workitem.to_yaml
+                entry.content["type"] = "html"
+            end
+
+            #
+            # This default implementation simply builds a single author
+            # out of the :author_name, :author_uri passed as initialization
+            # params.
+            #
+            def render_author (entry, workitem)
+
+                author = Atom::Author.new
+                author.name = author_name
+                author.uri = author_uri
+
+                entry.authors << author
+            end
+
+            #
+            # This base implementations simply adds the categories listed
+            # in the :categories initialization parameter.
+            # The target_uri is used as the scheme for the categories.
+            #
+            # You can override this method to add extra categories or to
+            # have completely different categories.
+            #
+            def render_categories (entry, workitem)
+
+                @categories.each do |s|
+
+                    c = Atom::Category.new
+
+                    c["scheme"] = @target_uri
+                    c["term"] = s.strip
+
+                    entry.categories << c
+                end
+            end
+
+            #
+            # Extracts the link of the newly created resource (newly posted blog
+            # entry), and returns it as a String.
+            #
+            def extract_new_link (response)
+
+                doc = REXML::Document.new response.read_body
+
+                #REXML::XPath.first(doc.root, "//link[@rel='edit']")
+                    #
+                    # doesn't work :(
+
+                REXML::XPath.first(doc.root, "//link[2]").attribute('href')
+                    #
+                    # will break if the order changes :(
+            end
+    end
+
+    #
+    # A participant that blogs.
+    #
+    #    require 'openwfe/extras/participants/atompub_participants'
+    #    include OpenWFE::Extras
+    #
+    #    target_uri = "https://openwferu.wordpress.com/wp-app.php/posts"
+    #
+    #    params = {}
+    #    params[:username] = 'jeff'
+    #    params[:password] = 'whatever'
+    #    
+    #    params[:categories] = 'openwferu, test'
+    #
+    #    #params[:title_field] = "title"
+    #        #
+    #        # which workitem field will hold the post title ?
+    #        # by default, it's "title"
+    #    
+    #    engine.register_participant "blogger", BlogParticipant.new(target_uri, params) do
+    #        """
+    #            paragraph 0
+    #
+    #            paragraph 1 : ${f:message}
+    #
+    #            paragraph 2
+    #        """
+    #    end
+    #
+    # This participant takes its template and the workitem it receives to
+    # publish a blog entry.
+    #
+    # The template can be specified as a block (as in the previous example)
+    # or via the :template parameter.
+    #
+    class BlogParticipant < AtomPubParticipant
+        include OpenWFE::TemplateMixin
+
+        def initialize (target_uri, params, &block)
+
+            super
+
+            @template = params[:template]
+            @block_template = block
+
+            @content_type = params[:content_type] || "html"
+
+            @title_field = params[:title_field] || "title"
+        end
+
+        protected
+
+            def render_content (entry, workitem)
+
+                entry.title = workitem.attributes[@title_field].to_s
+
+                entry.content = eval_template workitem
+                entry.content["type"] = @content_type
+            end
+    end
+end
+

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

@@ -0,0 +1,87 @@
+#
+#--
+# Copyright (c) 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 'openwfe/participants/participants'
+require 'openwfe/extras/misc/basecamp'
+
+
+module OpenWFE
+module Extras
+
+    class BasecampParticipant
+        include OpenWFE::LocalParticipant
+        include OpenWFE::TemplateMixin
+
+        def initialize (params, &block)
+
+            super()
+
+            @template = params[:template]
+            @block_template = block
+
+            @company_id = params[:company_id]
+            #@project_id = params[:project_id]
+
+            @responsible_party_id = params[:responsible_party_id]
+            @todo_list_id = params[:todo_list_id]
+
+            ssl = params[:ssl]
+            ssl = true if ssl == nil
+
+            @camp = Basecamp.new(
+                params[:host], params[:username], params[:password], ssl)
+        end
+
+        def consume (workitem)
+
+            text = workitem['todo_text'] || eval_template(wi)
+
+            resp = workitem['todo_responsible_party'] || @responsible_party_id
+            list = workitem['toto_list_id'] || @todo_list_id
+
+            todo = @camp.create_item list, text, resp
+
+            workitem['todo_id'] = todo.id
+
+            reply_to_engine workitem
+        end
+    end
+end
+end
+