openwferu 0.9.0

data/lib/test.rb

@@ -0,0 +1,220 @@
+#
+# Copyright (c) 2005-2006, 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: test.rb 3454 2006-10-08 16:51:00Z jmettraux $
+#
+
+#
+# "hecho en Costa Rica"
+#
+
+require 'optparse'
+
+require 'worklistclient'
+require 'controlclient'
+
+
+#
+# PARSING OPTS
+#
+
+@has_options = false
+@test_worklist = true
+@test_control = true
+
+def flush_options ()
+    if not @has_options
+        @test_worklist = false
+        @test_control = false
+    end
+    @has_options = true
+end
+
+opts = OptionParser.new()
+
+opts.banner = "Usage: test.sh [options]"
+opts.separator("")
+opts.separator("options:")
+
+opts.on("-w", "--worklist", "tests the ruby lib to the worklist iface") do
+    flush_options()
+    @test_worklist = true
+end
+
+opts.on("-c", "--control", "tests the ruby lib to the control iface") do
+    flush_options()
+    @test_control = true
+end
+
+opts.on("-h", "--help", "displays this help/usage message") do
+    puts
+    puts opts.to_s()
+    puts
+    exit 0
+end
+
+#opts_rest = opts.parse(ARGV)
+#questions = Integer(opts_rest[0]) if opts_rest.length > 0
+
+opts.parse(ARGV)
+
+
+puts
+puts "  testing worklist : #{@test_worklist}"
+puts "  testing control  : #{@test_control}"
+puts
+
+
+#
+# TESTING THE WORKLIST IFACE
+#
+
+if @test_worklist
+
+    client = OpenWFE::WorklistClient\
+       .new("http://127.0.0.1:5080/worklist", "alice", "alice")
+
+    puts "sessionId : #{client.sessionId}"
+
+    #puts client.get('getstorenames', nil, nil)
+
+    puts "Stores :"
+    l = client.listStores()
+    l.each do |s|
+        puts " - store  name : '#{s.name}'  wi count : #{s.workitemCount}  permissions : #{s.permissions}"
+    end
+
+    puts
+
+    puts "launching a flow"
+    li = OpenWFE::LaunchItem.new()
+    li.workflowDefinitionUrl = "http://localhost:7079/flow__1.0.xml"
+    li.attributes["__subject__"] = "openwfe-ruby"
+
+    fei = client.launchFlow("mainEngine", li)
+    puts fei
+
+    puts
+
+    feiToFetch = nil
+
+    puts "Store.alpha's headers :"
+    l = client.getHeaders("Store.alpha")
+    l.each do |h|
+        puts " - header  lastModified : #{h.lastModified}  locked : #{h.locked}  ac : #{h.attributes.length}"
+        puts "           fei : #{h.flowExpressionId}"
+
+        feiToFetch = h.flowExpressionId
+    end
+
+    puts "Fetching the first workitem :"
+    wi = client.getWorkitem("Store.alpha", feiToFetch)
+
+    #puts wi.inspect()
+    puts
+
+    puts "Fetching (and locking) the first workitem :"
+    wi = client.getAndLockWorkitem("Store.alpha", feiToFetch)
+
+    puts wi.inspect()
+
+    puts
+
+    puts "Releasing the workitem :"
+    puts "ok" if client.releaseWorkitem(wi)
+
+    puts
+
+    puts "Listing launchables :"
+    client.listLaunchables().each do |l|
+        puts " - launchable  #{l.engineId} :: #{l.url}"
+    end
+
+    puts
+
+    puts "Closing worklist worksession"
+    puts client.close()
+
+end
+
+
+#
+# TESTING THE CONTROL IFACE
+#
+
+if @test_control
+
+    def display_expressions (exps)
+        i = 0
+        exps.each do |exp|
+            print " - exp #{i} : #{exp.id}"
+            print " / #{exp.applyTime}" if exp.applyTime
+            print "\n"
+            i = i+1
+        end
+    end
+
+    puts "Testing the control interface..."
+
+    #
+    # launching a test flow
+
+    #TEST_NAME = '-- testing ruby control (0) --'
+
+    #client = OpenWFE::WorklistClient\
+    #   .new("http://127.0.0.1:5080/worklist", "alice", "alice")
+
+    #li = OpenWFE::LaunchItem.new()
+    #li.workflowDefinitionUrl = "http://localhost:7079/flow__1.0.xml"
+    #li.attributes["__subject__"] = TEST_NAME
+
+    #fei = client.launchFlow("mainEngine", li)
+    #puts "launched :  #{fei}"
+
+    #client.close()
+
+    #
+    # controlling the test flow
+
+    client = OpenWFE::ControlClient\
+       .new("http://127.0.0.1:6080/engine", "admin", "admin")
+
+    puts "sessionId : #{client.sessionId}"
+
+    puts
+
+    puts "listing expressions :"
+    exps = client.listExpressions()
+    display_expressions(exps)
+
+    client.close()
+
+end
+

data/lib/utils.rb

@@ -0,0 +1,94 @@
+#
+# Copyright (c) 2005-2006, 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: utils.rb 3454 2006-10-08 16:51:00Z jmettraux $
+#
+
+#
+# "hecho en Costa Rica"
+#
+# john.mettraux@openwfe.org
+#
+
+module OpenWFE
+
+    #
+    # Returns the first subelt of xmlElt that matches the given xpath.
+    # If xpath is null, the first elt will be returned.
+    #
+    def OpenWFE.firstElement (xmlElt, elementName=nil)
+
+        return nil if not xmlElt
+
+        return xmlElt.elements[1] if not elementName
+
+        xmlElt.elements.each do |elt|
+            return elt if elt.name == elementName
+        end
+
+        return nil
+    end
+
+    #
+    # Used in tests, is equivalent to Perl's die() method.
+    #
+    def OpenWFE.die (text)
+        puts text
+        exit 1
+    end
+
+    #
+    # Attempts a deep cloning of the object
+    #
+    def OpenWFE.copy (object)
+
+        return nil if object == nil
+
+        if object.kind_of?(Array)
+            result = []
+            object.each do |i|
+                result << copy(i)
+            end
+            return result
+        end
+
+        if object.kind_of?(Hash)
+            result = {}
+            object.each do |k, v|
+                result[copy(k)] = copy(v)
+            end
+            return result
+        end
+
+        return object.dup
+    end
+
+end
+

data/lib/workitem.rb

@@ -0,0 +1,250 @@
+#
+# Copyright (c) 2005-2006, 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: workitem.rb 3556 2006-11-13 04:15:52Z jmettraux $
+#
+
+#
+# "hecho en Costa Rica"
+#
+# john.mettraux@openwfe.org
+#
+
+require 'base64'
+
+require 'definitions'
+require 'utils'
+
+
+module OpenWFE
+
+    #
+    # WORKITEMS
+    #
+
+    class WorkItem
+
+        attr_accessor :lastModified, :attributes
+
+        def initialize ()
+
+            @lastModified = nil
+
+            @attributes = {}
+            @attributes[MAP_TYPE] = E_SMAP
+        end
+
+        def copy ()
+            raise "not implemented"
+        end
+    end
+
+    class InFlowItem < WorkItem
+
+        attr_accessor :flowExpressionId, :participantName
+
+        def lastExpressionId
+            return @flowExpressionId
+        end
+
+        def lastExpressionId= (fei)
+            @flowExpressionId = fei
+        end
+    end
+
+    class InFlowWorkItem < InFlowItem
+
+        attr_accessor :dispatchTime, :filter, :history
+
+        attr_accessor :store
+            #
+            # special : added by the ruby lib, not given by the worklist
+
+        def dup
+            c = InFlowWorkItem.new
+            c.lastModified = OpenWFE::copy(@lastModified)
+            c.attributes = OpenWFE::copy(@attributes)
+            c.flowExpressionId = OpenWFE::copy(@flowExpressionId)
+            c.participantName = OpenWFE::copy(@participantName)
+            c.dispatchTime = OpenWFE::copy(@dispatchTime)
+            c.filter = OpenWFE::copy(@filter)
+            c.history = OpenWFE::copy(@history)
+            c.store = OpenWFE::copy(@store)
+            return c
+        end
+    end
+
+    class CancelItem < InFlowItem
+    end
+
+    class LaunchItem < WorkItem
+
+        attr_accessor :workflowDefinitionUrl
+            #, :descriptionMap
+    end
+
+
+    #
+    # HISTORY ITEM
+    #
+
+    class HistoryItem
+
+        attr_accessor \
+            :date, \
+            :author, \
+            :host, \
+            :text, \
+            :wfdName, \
+            :wfdRevision, \
+            :wfInstanceId, \
+            :expressionId
+    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, :workitemCount, :permissions
+
+        def initialize ()
+            @name = nil
+            @workitemCount = nil
+            @permissions = nil
+        end
+
+        #
+        # Returns true if the current user may read headers and workitems
+        # from this store
+        #
+        def mayRead? ()
+            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 mayWrite? ()
+            return @permissions.index('w') > -1
+        end
+
+        #
+        # Returns true if the current user may browse the headers of this
+        # store
+        #
+        def mayBrowse? ()
+            return @permissions.index('b') > -1
+        end
+
+        #
+        # Returns true if the current user may delegate workitems to this store
+        #
+        def mayDelegate? ()
+            return @permissions.index('d') > -1
+        end
+    end
+
+    #
+    # A header is a summary of a workitem, returned by the getHeader
+    # worklist method
+    #
+    class Header
+
+        attr_accessor :lastModified, :locked, :flowExpressionId, :attributes
+    end
+
+
+    #
+    # MISC ATTRIBUTES
+    #
+    # in openwfe-ruby, OpenWFE attributes are immediately mapped to
+    # Ruby instances, but some attributes still deserve their own class
+    #
+
+    #
+    # 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 ()
+
+            return Base64.decode64(@content)
+        end
+
+        #
+        # wraps some binary content and stores it in this attribute
+        # (class method)
+        #
+        def Base64Attribute.wrap (binaryData)
+
+            return Base64Attribute.new(Base64.encode64(binaryData))
+        end
+    end
+
+
+    #
+    # LAUNCHABLE
+    # 
+
+    class Launchable
+
+        attr_accessor :url, :engineId
+    end
+
+
+    #
+    # EXPRESSION (for the control iface)
+    #
+
+    class Expression
+
+        attr_accessor :id, :applyTime, :state, :stateSince
+    end
+
+end
+