ruote 0.9.20 → 2.1.1

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

@@ -1,213 +0,0 @@
-#--
-# Copyright (c) 2008-2009, Torsten Schönebaum, 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 Europe and Japan.
-#++
-
-
-require 'activeresource' # gem activeresource
-
-require 'openwfe/participants/participants'
-
-
-module OpenWFE
-  module Extras
-
-    #
-    # Ruote participant which does a REST call. It's using ActiveResource to do
-    # the actual magic. You can call every class and instance method
-    # ActiveResource::Base and its mixins provide. You can also process the
-    # response of the REST request and save some of its data into the workitem
-    # for example.
-    #
-    # Before using this participant you *really* should make yourself familiar
-    # with ActiveResource and its usage.
-    #
-    # ==Using it
-    #
-    # The participant should be registered in the engine in a way like this:
-    #
-    #   engine.register_participant(
-    #     'reminder',
-    #     ActiveResourceParticipant.new(
-    #       {
-    #         :site => 'http://localhost:7000',
-    #         :resource_name => 'story',
-    #         :method => 'put', # we will use ActiveResource::CustomMethods::InstanceMethods#put
-    #         :argument => 'send_reminder', # put is happy with just one
-    #                                       # parameter: The action to be
-    #                                       # called. So we won't have to use a
-    #                                       # block to set the arguments of the
-    #                                       # ActiveResource method to call.
-    #       }
-    #     )
-    #   )
-    #
-    # Let's try a more complex example:
-    #
-    #   engine.register_participant(
-    #     'complex_ares',
-    #     ActiveResourceParticipant.new(
-    #       {
-    #         :site => 'http://localhost:7000',
-    #         :resource_name => 'story',
-    #         :method => 'find', # yes, even ActiveResource::Base#find method
-    #                            # may be used...
-    #         :response_handling => proc do |response, workitem| # define response
-    #                                                            # handling block
-    #           workitem.set_attribute('title', response.attributes['title'])
-    #                            # The type of the response object depends on
-    #                            # the method you use!
-    #         end
-    #       }
-    #     ) do |workitem| # define arguments to use with the find method
-    #       # each argument is an entry in an array the block has to return
-    #       [
-    #          workitem.attributes['story_id'], # the first argument
-    #          {:prefix => 'foo'} # the second one is an hash
-    #       ]
-    #     end
-    #   )
-    #
-    # You can now use the participant in your workflow definitions. An example
-    # using XML:
-    #
-    #     <concurrence count="1">
-    #       <participant ref="qa" />
-    #       <cron every="1m">
-    #         <participant
-    #           ref="reminder"
-    #           site="http://localhost:7000"
-    #           resource_name="story"
-    #           method="put"
-    #           action="send_reminder"
-    #           resource_id="${field:story_id}" />
-    #       </cron>
-    #     </concurrence>
-    #
-    # Here, the ActiveResourceParticipant is used to send a reminder.
-    #
-    # *Note:* prefer configuration of the participant at registration time,
-    # information like 'method', 'site' and 'resource_name' may clutter the
-    # process definition.
-    #
-    class ActiveResourceParticipant
-      include OpenWFE::LocalParticipant
-
-      #
-      # == options hash
-      #
-      # You have to set some default options by passing an options hash to the
-      # new method. It should contain the following keys:
-      #
-      # <tt>:site</tt>:: The URI (as string) of the site where your REST
-      #   interface sits. See <tt>site</tt> parameter in ActiveResource::Base.
-      # <tt>:resource_name</tt>:: The name of the resource you like to access.
-      #   See <tt>element_name</tt> parameter in ActiveResource::Base.
-      # <tt>:method</tt>:: The ActiveResource method to call. In most cases
-      #   should be "get", "put", "post" or "delete".
-      # <tt>:argument</tt>:: The first parameter which should be used as
-      #   argument to the ActiveResource method which will be called. This value
-      #   is ignored if a block is given (see below)
-      # <tt>:resource_id</tt>:: The ID of the resource on which the action
-      #   should be called on default. If negative, nil or false, the action
-      #   will be called on the complete set of resources instead of on a single
-      #   resource determined by its ID.
-      # <tt>:response_handling</tt>:: A proc object / block which gets called
-      #   after the request is done. It gets called with to arguments: The
-      #   response of the ActiveResource method called and the workitem.
-      #
-      # The new method also takes a block. It may be used to set the arguments
-      # of the ActiveResource method to call. The block must return an array of
-      # arguments. The array will be splitted and each entry will be used as
-      # argument to the ActiveResource method called. See
-      # OpenWFE::LocalParticipant#call_block for the arguments the block itself
-      # takes.
-      #
-      # All parameters except response_handling and the block set default values
-      # -- you can always override them in the process definition. Just use the
-      # corresponding symbol name (without ":") as attribute.
-      #
-      def initialize (options, &block)
-
-        @options = options
-
-        # some defaults
-        @options[:site] ||= 'http://127.0.0.1:3000'
-        @options[:method] ||= :get
-
-        @block = block
-      end
-
-      #
-      # This method is called each time the participant receives a workitem. It
-      # calls the requested ActiveResource method, calls the response handling
-      # code if present and then immediatly replies to the engine.
-      #
-      def consume (workitem)
-
-        # use block to determine the method's arguments if given
-        args = if @block
-          call_block(@block, workitem)
-        elsif a = param(workitem, :arg) || param(workitem, :argument)
-          Array(a)
-        else
-          [] # no arguments
-        end
-
-        # create new subclass of ActiveResource::Base
-        active_resource_class = Class.new(ActiveResource::Base)
-        active_resource_class.site = param(workitem, :site) # set site parameter
-        active_resource_class.element_name = param(workitem, :resource_name) # set element name
-
-        # Do we work on a single or on a set of resources? If resource_id is nil
-        # or negative, it's a set of resources.
-
-        resource_id = param(workitem, :resource_id)
-
-        active_resource = if (!resource_id) || (resource_id.to_i < 0)
-          # set of resources
-          active_resource_class
-        else
-          # specific resource
-          active_resource_class.new(:id => resource_id)
-        end
-
-        response = active_resource.send(param(workitem, :method), args)
-
-        # we got our response, but what to do with it?
-        if (h = param(workitem, :response_handling)).is_a?(Proc)
-          h.call(response, workitem)
-        end
-
-        # reply to the engine
-        reply_to_engine(workitem)
-      end
-
-      protected
-
-      def param (workitem, key)
-        workitem.params[key] || @options[key]
-      end
-    end
-
-  end
-end

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

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

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

@@ -1,285 +0,0 @@
-#--
-# Copyright (c) 2007-2009, John Mettraux, Tomaso Tosolini 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 and Italy.
-#++
-
-
-require 'openwfe/workitem'
-require 'openwfe/flowexpressionid'
-require 'openwfe/engine/engine'
-require 'openwfe/participants/participant'
-require 'openwfe/extras/singlecon'
-
-
-module OpenWFE::Extras
-
-  class ArWorkitemTables < ActiveRecord::Migration
-
-    def self.up
-
-      create_table :ar_workitems do |t|
-
-        t.column :fei, :string
-        t.column :wfid, :string
-        t.column :expid, :string
-        t.column :wfname, :string
-        t.column :wfrevision, :string
-
-        t.column :participant_name, :string
-        t.column :store_name, :string
-
-        t.column :dispatch_time, :timestamp
-        t.column :last_modified, :timestamp
-
-        t.column :wi_fields, :text
-
-        t.column :activity, :string
-        t.column :keywords, :text
-      end
-
-      add_index :ar_workitems, :fei, :unique => true
-        # with sqlite3, comment out this :unique => true on :fei :(
-
-      add_index :ar_workitems, :wfid
-      add_index :ar_workitems, :expid
-      add_index :ar_workitems, :wfname
-      add_index :ar_workitems, :wfrevision
-      add_index :ar_workitems, :participant_name
-      add_index :ar_workitems, :store_name
-    end
-
-    def self.down
-
-      drop_table :ar_workitems
-    end
-  end
-
-  class ArWorkitem < ActiveRecord::Base
-    include SingleConnectionMixin
-
-    #
-    # Returns the flow expression id of this work (its unique OpenWFEru (Ruote)
-    # identifier) as a FlowExpressionId instance.
-    # (within the Workitem it's just stored as a String).
-    #
-    def full_fei
-
-      @full_fei ||= OpenWFE::FlowExpressionId.from_s(fei)
-    end
-
-    #
-    # Making sure last_modified is set to Time.now before each save.
-    #
-    def before_save
-
-      touch
-    end
-
-    def self.from_owfe_workitem (wi, store_name=nil)
-
-      arwi = ArWorkitem.new
-      arwi.fei = wi.fei.to_s
-      arwi.wfid = wi.fei.wfid
-      arwi.expid = wi.fei.expid
-      arwi.wfname = wi.fei.workflow_definition_name
-      arwi.wfrevision = wi.fei.workflow_definition_revision
-
-      arwi.participant_name = wi.participant_name
-      arwi.store_name = store_name
-
-      arwi.dispatch_time = wi.dispatch_time
-      arwi.last_modified = nil
-
-      arwi.wi_fields = YAML.dump(wi.fields)
-        # using YAML as it's more future proof
-
-      arwi.keywords = flatten_keywords(wi.fields, wi.participant_name)
-
-      #arwi.save! # making sure to throw an exception in case of trouble
-      arwi.save_without_transactions!
-
-      arwi
-    end
-
-    #
-    # The default implementation fetches the value for the 'activity' in
-    # the hash field named 'params'.
-    #
-    def extract_activity (wi)
-
-      wi.fields['params']['activity']
-    end
-
-    #
-    # Turns the 'active' Workitem into a ruote InFlowWorkItem.
-    #
-    def to_owfe_workitem
-
-      wi = OpenWFE::InFlowWorkItem.new
-
-      wi.fei = full_fei
-      wi.participant_name = participant_name
-      wi.fields = YAML.load(self.wi_fields)
-
-      wi.dispatch_time = dispatch_time
-      wi.last_modified = last_modified
-
-      wi
-    end
-
-    alias :as_owfe_workitem :to_owfe_workitem
-
-    def replace_fields (fields)
-
-      self.wi_fields = YAML.dump(fields)
-
-      self.keywords = self.class.flatten_keywords(fields, self.participant_name)
-
-      #self.save!
-      self.save_without_transactions!
-    end
-
-    def field_hash
-
-      YAML.load(self.wi_fields)
-    end
-
-    def field (k)
-
-      field_hash[k]
-    end
-
-    #
-    # Simply sets the 'last_modified' field to now.
-    # (Doesn't save the workitem though).
-    #
-    def touch
-
-      self.last_modified = Time.now
-    end
-
-    #
-    # Returns all the workitems belonging to the stores listed
-    # in the parameter storename_list.
-    # The result is a Hash whose keys are the store names and whose
-    # values are list of workitems.
-    #
-    def self.find_in_stores (storename_list)
-
-      workitems = find_all_by_store_name(storename_list)
-      workitems.inject({}) { |h, wi| (h[wi.store_name] ||= []) << wi }
-    end
-
-    #
-    # Not really about 'just launched', but rather about finding the first
-    # workitem for a given process instance (wfid) and a participant.
-    # It deserves its own method because the workitem could be in a
-    # subprocess, thus escaping the vanilla find_by_wfid_and_participant()
-    #
-    def self.find_just_launched (wfid, participant_name)
-
-      find(
-        :first,
-        :conditions => [
-          'wfid LIKE ? AND participant_name = ?',
-          "#{wfid}%",
-          participant_name ])
-    end
-
-    #
-    # a very naive search functionality
-    #
-    def self.search (query, store_names)
-
-      query = query.split(' ').first
-
-      i = query.index(':')
-
-      query = if i == query.length - 1
-        "%|#{query}%"
-      elsif i != nil and i != 0
-        "%|#{query}|%"
-      else
-        "%#{query}|%"
-      end
-
-      conditions = [ 'keywords LIKE ?', query ]
-
-      if store_names and not (store_names.empty?)
-        conditions[0] = "#{conditions[0]} AND store_name IN (?)"
-        conditions << store_names
-      end
-
-      #p conditions
-
-      find(:all, :conditions => conditions)
-    end
-
-    protected
-
-    def self.flatten_keywords (h, participant_name)
-
-      h = h.merge('participant' => participant_name) if participant_name
-
-      fk(h).gsub(/\|+/, '|')
-    end
-
-    def self.fk (o)
-
-      if o.is_a?(Hash)
-        "|#{o.collect { |k, v| "#{fk(k)}:#{fk(v)}" }.join('|')}|"
-      elsif o.is_a?(Array)
-        "|#{o.collect { |e| fk(e)}.join('|')}|"
-      else
-        o.to_s.gsub('|', '').gsub(':', '')
-      end
-    end
-  end
-
-  class ArParticipant
-    include OpenWFE::LocalParticipant
-
-    attr_reader :store_name
-
-    def initialize (store_name=nil)
-      super()
-      @store_name = store_name
-    end
-
-    ##
-    ## Forces ruote to not spawn a thread when dispatching to this participant.
-    ##
-    #def do_not_thread
-    #  true
-    #end
-
-    def consume (workitem)
-      ArWorkitem.from_owfe_workitem(workitem, @store_name)
-    end
-
-    def cancel (cancelitem)
-      ArWorkitem.destroy_all([ 'fei = ?', cancelitem.fei.to_s ])
-    end
-  end
-
-end
-