ruote 0.9.18

data/lib/openwfe/orest/osocket.rb

@@ -0,0 +1,148 @@
+#
+#--
+# Copyright (c) 2006-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.
+#++
+#
+
+require 'socket'
+
+require 'openwfe/orest/xmlcodec'
+
+
+module OpenWFE
+
+    #
+    # This code was blogged about at
+    # http://jmettraux.wordpress.com/2006/06/01/openwfe-ruby/
+    #
+    class OldSocketListener < TCPServer
+
+        #
+        # starts to listen on a given interface (IP) and port
+        #
+        def initialize (iface, port)
+            super(iface, port)
+        end
+
+        def listen ()
+            while (session = accept())
+                #
+                # how does it scale ?
+
+                s = session.gets
+
+                if s[0..8] != 'xmlCoder '
+                    session.close
+                    break
+                end
+
+                l = s[9..-1].to_i
+
+                s = session.gets
+                    #
+                    # skipping the empty line between the
+                    # header and the actual workitem
+
+                sXml = ''
+
+                while sXml.length < l
+                    s = session.gets
+                    sXml = "#{sXml}#{s}"
+                end
+
+                session.print "<ok-reply/>"
+                session.close
+
+                yield OpenWFE.xml_decode(xml.root)
+            end
+        end
+    end
+
+    #
+    # Dispatches a workitem over TCP, the workitem will be
+    # encoded with XML
+    # The default encode_method is
+    #
+    def OpenWFE.dispatch_workitem (host, port, workitem)
+
+        #sXml = OpenWFE.xml_encode(workitem)
+        sXml = OpenWFE::XmlCodec::encode workitem
+
+        socket = TCPSocket.new(host, port)
+        socket.puts "xmlCoder #{sXml.length}"
+        socket.puts
+        socket.puts sXml
+        socket.puts
+        socket.close_write
+
+        reply = socket.gets
+
+        #reply = reply + socket.gets
+            #
+            # a bit ridiculous, but it works
+            # socket.close_write fixed it
+
+        socket.close
+
+        #puts "dispatch() reply is >#{reply}<"
+    end
+
+end
+
+
+#
+# some test code
+
+#sl = OpenWFE::OldSocketListener.new('127.0.0.1', 7010)
+#
+#puts "..ready.."
+#
+#sl.listen do |workitem|
+#
+#    #puts workitem
+#    #next
+#
+#    puts workitem.flow_expression_id
+#    puts "...history length : #{workitem.history.length}"
+#
+#    #puts workitem.history
+#    workitem.history.each do |hi|
+#        puts ".....hi = '#{hi.text}' #{hi.date}"
+#    end
+#
+#    #hi = OpenWFE::HistoryItem.new
+#    #hi.author = 'osocket.rb'
+#    #workitem.history.push(hi)
+#
+#    workitem.attributes['ruby?'] = 'yes'
+#
+#    OpenWFE.dispatch_workitem('127.0.0.1', 7007, workitem)
+#end
+

data/lib/openwfe/orest/restclient.rb

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

@@ -0,0 +1,206 @@
+#
+#--
+# 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
+