ruote 0.9.18 → 0.9.19

data/lib/openwfe/orest/restclient.rb

@@ -1,176 +0,0 @@
-#
-#--
-# Copyright (c) 2005-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.
-#++
-#
-
-#
-# "hecho en Costa Rica"
-#
-
-require 'base64'
-require 'net/http'
-require 'rexml/document'
-
-require 'openwfe/version'
-
-
-module OpenWFE
-
-    #
-    # A basic REST client for OpenWFE services (control and worklist)
-    #
-    class RestClient
-
-        attr_reader \
-            :host, :port, :resource, :session_id
-
-        def initialize (url, username, password)
-
-            split_url(url)
-            @username = username
-
-            connect(password)
-        end
-
-        #
-        # Closes this REST client
-        #
-        def close
-            get('endWorkSession', nil, {})
-        end
-
-        protected
-
-            def decode (reply)
-
-                raise "Error : #{reply.code} - #{reply.body}" \
-                    if reply.code != "200"
-
-                begin
-                    xml = REXML::Document.new reply.body
-                    OpenWFE::XmlCodec::decode xml.root
-                rescue Exception => e
-                    if $DEBUG
-                        #puts
-                        #puts e.to_s
-                        puts
-                        puts "failed to decode reply :"
-                        puts
-                        puts reply.body
-                        puts
-                    end
-                    raise e
-                end
-            end
-
-            #
-            # GETs a REST operation
-            #
-            def get (action, subResourceName, params)
-
-                @httpclient.get(
-                    compute_resource(action, subResourceName, params))
-            end
-
-            #
-            # POSTs a REST operation
-            #
-            def post (action, subResourceName, params, data)
-
-                @httpclient.post(
-                    compute_resource(action, subResourceName, params), 
-                    data.to_s)
-            end
-
-        private
-
-            def split_url (url)
-
-                @host = nil
-                @port = nil
-                @resource = nil
-
-                url = url[7..-1] if url[0..6] == 'http://'
-
-                i = url.index('/')
-                unless i
-                    @resource = '/defaultrestresource'
-                else
-                    @resource = url[i..-1]
-                    url = url[0..i]
-                end
-
-                @host, @port = url.split(':')
-
-                if @port == nil
-                    @port = 5080
-                else
-                    @port = Integer(@port[0..-2])
-                end
-            end
-
-            def connect (password)
-
-                @httpclient = Net::HTTP.new(@host, @port)
-
-                hs = {}
-                hs['Authorization'] = \
-                    'Basic ' + Base64.encode64(@username+":"+password).strip
-                hs['RestClient'] = "openwfe-ruby #{OPENWFERU_VERSION}"
-                hs['User-Agent'] = "openwfe-ruby #{OPENWFERU_VERSION}"
-
-                #puts "@resource is '#{@resource}'"
-                #puts "hs is '#{hs.inspect}'"
-
-                r = @httpclient.get(@resource, hs)
-
-                #xml = REXML::Document.new(r.body)
-                #@session_id = Integer(xml.root.attributes["id"])
-
-                @session_id = decode r
-            end
-
-            def compute_resource (action, sub_resource_name, params)
-
-                reso = @resource.dup
-                reso += "/#{sub_resource_name}" if sub_resource_name
-
-                reso += "?session=#{@session_id.to_s}&action=#{action}"
-
-                params.each { |k, v| 
-                    reso += "&#{k.to_s}=#{v.to_s}" 
-                } if params
-
-                reso
-            end
-    end
-end
-

data/lib/openwfe/orest/workitem.rb

@@ -1,206 +0,0 @@
-#
-#--
-# Copyright (c) 2005-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.
-#++
-#
-
-#
-# "hecho en Costa Rica"
-#
-# john.mettraux@openwfe.org
-#
-
-require 'base64'
-
-require 'openwfe/utils'
-
-
-module OpenWFE
-
-    #--
-    # HISTORY ITEM
-    #
-    # (currently not used in OpenWFEru itself :( )
-    #++
-
-    #
-    # HistoryItem instances are used to keep track of what happened to
-    # a workitem.
-    #
-    class HistoryItem
-
-        attr_accessor \
-            :date,
-            :author,
-            :host,
-            :text,
-            :wfd_name,
-            :wfd_revision,
-            :wf_instance_id,
-            :expression_id
-        
-        def dup
-            OpenWFE::fulldup(self)
-        end
-    end
-
-
-    #--
-    # STORES
-    #++
-
-    #
-    # Models the information about a store as viewed by the current user 
-    # (upon calling the listStores or getStoreNames methods)
-    #
-    class Store
-
-        attr_accessor :name, :workitem_count, :permissions
-
-        def initialize ()
-            super()
-            #@name = nil
-            #@workitem_count = nil
-            #@permissions = nil
-        end
-
-        #
-        # Returns true if the current user may read headers and workitems
-        # from this store
-        #
-        def may_read? ()
-            return @permissions.index('r') > -1
-        end
-
-        #
-        # Returns true if the current user may modify workitems (and at least
-        # proceed/forward them) in this store
-        #
-        def may_write? ()
-            @permissions.index('w') > -1
-        end
-
-        #
-        # Returns true if the current user may browse the headers of this
-        # store
-        #
-        def may_browse? ()
-            @permissions.index('b') > -1
-        end
-
-        #
-        # Returns true if the current user may delegate workitems to this store
-        #
-        def may_delegate? ()
-            @permissions.index('d') > -1
-        end
-    end
-
-    #
-    # A header is a summary of a workitem, returned by the getHeader
-    # worklist method.
-    #
-    # (Only used when accessing an OpenWFEja engine)
-    #
-    class Header < InFlowWorkItem
-
-        attr_accessor :locked
-    end
-
-
-    #--
-    # MISC ATTRIBUTES
-    #
-    # in openwfe-ruby, OpenWFE attributes are immediately mapped to
-    # Ruby instances, but some attributes still deserve their own class
-    #
-    # (Only used when accessing an OpenWFEja engine)
-    #++
-
-    #
-    # a wrapper for some binary content
-    #
-    class Base64Attribute
-
-        attr_accessor :content
-
-        def initialize (base64content)
-
-            @content = base64content
-        end
-
-        #
-        # dewraps (decode) the current content and returns it
-        #
-        def dewrap ()
-
-            Base64.decode64(@content)
-        end
-
-        #
-        # wraps some binary content and stores it in this attribute
-        # (class method)
-        #
-        def Base64Attribute.wrap (binaryData)
-
-            Base64Attribute.new(Base64.encode64(binaryData))
-        end
-    end
-
-
-    #--
-    # LAUNCHABLE
-    #++
-
-    #
-    # A worklist will return list of Launchable instances indicating
-    # what processes (URL) a user may launch on which engine.
-    #
-    # (Only used when accessing an OpenWFEja engine)
-    #
-    class Launchable
-
-        attr_accessor :url, :engine_id
-    end
-
-
-    #
-    # Expression, somehow equivalent to FlowExpression, but only used 
-    # by the control interface.
-    #
-    # (Only used when accessing an OpenWFEja engine)
-    #
-    class Expression
-
-        attr_accessor :id, :apply_time, :state, :state_since
-    end
-
-end
-

data/lib/openwfe/orest/worklistclient.rb

@@ -1,272 +0,0 @@
-#
-#--
-# Copyright (c) 2005-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.
-#++
-#
-
-#
-# "hecho en Costa Rica"
-#
-
-require 'openwfe/workitem'
-require 'openwfe/orest/xmlcodec'
-require 'openwfe/orest/definitions'
-require 'openwfe/orest/restclient'
-
-
-module OpenWFE
-
-    #
-    # Reopening WorkItem to set the MAP_TYPE (as it's used by OpenWFEja...)
-    #
-    class WorkItem
-        def initialize
-            @last_modified = nil
-            @attributes = {}
-            @attributes[MAP_TYPE] = E_SMAP
-        end
-    end
-
-    #
-    # a client to an OpenWFE worklists.
-    #
-    class WorklistClient < RestClient
-
-        def initialize (url, username, password)
-            super
-        end
-
-        #
-        # Returns the list of stores the worklist hosts
-        #
-        def list_stores
-            r = get('listStores', nil, nil)
-            decode(r)
-        end
-
-        #
-        # An alias for list_stores()
-        #
-        alias :get_store_names :list_stores
-
-        #
-        # Returns the headers of a given store.
-        #
-        def get_headers (storeName, limit=1000)
-
-            params = {}
-            params["limit"] = limit
-
-            decode(get('getHeaders', storeName, params))
-        end
-
-        #
-        # TODO : rdoc me
-        #
-        def find_flow_instance (store_name, workflow_instance_id)
-
-            params = {}
-            params["id"] = workflow_instance_id
-
-            decode(get('findFlowInstance', store_name, params))
-        end
-
-        #
-        # Launches a flow (on a given engine and with a given launchitem).
-        # The 'engineId' corresponds to an engine's participant name
-        # (see etc/engine/participant-map.xml)
-        #
-        def launch_flow (engineId, launchitem)
-
-            eli = OpenWFE::XmlCodec::encode(launchitem)
-
-            params = {}
-            params[ENGINEID] = engineId
-
-            decode(post('launchFlow', nil, params, eli))
-        end
-
-        #
-        # Returns a workitem (but doesn't put a lock on it, thus modifications
-        # to it cannot be communicated with saveWorkitem() or forwardWorkitem()
-        # to the worklist)
-        #
-        def get_workitem (storeName, flowExpressionId)
-
-            get_item('getWorkitem', storeName, flowExpressionId)
-        end
-
-        #
-        # Returns a workitem and makes sure it's locked in the worklist. Thus,
-        # the usage of the methods saveWorkitem() and forwardWorkitem() is
-        # possible.
-        #
-        def get_and_lock_workitem (storeName, flowExpressionId)
-
-            #puts "...getAndLockWorkitem() for #{flowExpressionId}"
-
-            get_item('getAndLockWorkitem', storeName, flowExpressionId)
-        end
-
-        #
-        # Given a queryMap (a dict of keys and values), locks and returns 
-        # the first workitem matching.
-        #
-        def query_and_lock_workitem (storeName, queryMap)
-
-            hs = get_headers(storeName)
-            hs.each do |h|
-
-                #puts "...h.id  #{h.flowExpressionId}"
-                #h.attributes.each do |k, v|
-                #    puts "......h '#{k}' => '#{v}'"
-                #end
-
-                ok = true
-                id = nil
-
-                queryMap.each do |key, value|
-
-                    #puts "...'#{key}' => '#{h.attributes[key]}' ?= '#{value}'"
-                    ok = (ok and h.attributes[key] == value)
-                        #
-                        # the parenthesis are very important
-
-                    #puts "  .ok is #{ok}"
-                    #puts "  .id is #{h.flowExpressionId}"
-                    break unless ok
-                end
-
-                #puts "  .id is #{h.flowExpressionId}"
-
-                get_and_lock_workitem(storeName, h.flow_expression_id) if ok
-            end
-
-            nil
-        end
-
-        #
-        # Notifies the worklist that the given workitem has to be unlocked
-        # any local (client-side) modification to it are ignored.
-        #
-        def release_workitem (workitem)
-
-            post_item('releaseWorkitem', workitem)
-        end
-
-        #
-        # Saves back the workitem in the worklist (and releases it)
-        #
-        def save_workitem (workitem)
-
-            post_item('saveWorkitem', workitem)
-        end
-
-        #
-        # Returns the workitem to the worklist so that it can resume 
-        # its flow (changes to the workitem are saved).
-        #
-        def proceed_workitem (workitem)
-
-            post_item('forwardWorkitem', workitem)
-        end
-
-        alias :forward_workitem :proceed_workitem
-
-        #
-        # Returns the list of flow URLs the user owning this session may
-        # launch.
-        #
-        def list_launchables ()
-
-            params = {}
-
-            decode(get('listLaunchables', nil, params))
-        end
-
-        #
-        # Delegate the workitem (transfer it to another store).
-        #
-        def delegate (workitem, targetStoreName)
-
-            ewi = OpenWFE.encode(workitem)
-
-            params = {}
-            params[TARGETSTORE] = targetStoreName
-
-            decode(post('delegate', workitem.store, params, ewi))
-        end
-
-        #
-        # Delegate the workitem (ask the worklist to deliver it to 
-        # another participant).
-        #
-        def delegate_to_participant (workitem, targetParticipantName)
-
-            ewi = OpenWFE.encode(workitem)
-
-            params = {}
-            params[TARGETPARTICIPANT] = targetParticipantName
-
-            decode(post('delegate', workitem.store, params, ewi))
-        end
-
-        #def queryStore (storeName, query)
-        #end
-
-        protected
-
-            def get_item (rest_method_name, store_name, flow_expression_id)
-
-                fei = OpenWFE::XmlCodec::encode flow_expression_id
-                fei = OpenWFE::xmldoc_to_string fei, false
-
-                params = {}
-
-                wi = decode(post(rest_method_name, store_name, params, fei))
-
-                wi.store = store_name if wi
-
-                wi
-            end
-
-            def post_item (rest_method_name, workitem)
-
-                ewi = OpenWFE::XmlCodec::encode(workitem)
-
-                params = {}
-
-                decode(post(rest_method_name, workitem.store, params, ewi))
-            end
-
-    end
-
-end
-