ruote 0.9.18 → 0.9.19

data/lib/openwfe/participants/soapparticipants.rb

@@ -2,31 +2,31 @@
 #--
 # Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
-# 
-# Redistribution and use in source and binary forms, with or without 
+#
+# 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 
+#   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 
+#
+# 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.
 #++
 #
@@ -44,92 +44,92 @@ require 'openwfe/participants/participant'
 
 module OpenWFE
 
+  #
+  # Wrapping a simple web service call within an OpenWFEru participant.
+  #
+  #   quote_service = OpenWFE::SoapParticipant.new(
+  #     "http://services.xmethods.net/soap",    # service URI
+  #     "urn:xmethods-delayed-quotes",        # namespace
+  #     "getQuote",                 # operation name
+  #     [ "symbol" ])                 # param arrays (workitem fields)
+  #
+  #   engine.register_participant("quote_service", quote_service)
+  #
+  # By default, call params for the SOAP operations are determined by
+  # iterating the parameters and fetching the values under the
+  # corresponding workitem fields.
+  # This behaviour can be changed by overriding the prepare_call_params()
+  # method.
+  #
+  # On the return side, you can override the method handle_call_result
+  # for better mappings between web service calls and the workitems.
+  #
+  class SoapParticipant
+    include LocalParticipant
+
+    def initialize \
+      (endpoint_url, namespace, method_name, params, param_prefix="")
+
+      super()
+
+      @driver = SOAP::RPC::Driver.new(endpoint_url, namespace)
+
+      @method_name = method_name
+      @params = params
+      @param_prefix = param_prefix
+
+      @driver.add_method(method_name, *params)
+    end
+
     #
-    # Wrapping a simple web service call within an OpenWFEru participant.
-    #
-    #     quote_service = OpenWFE::SoapParticipant.new(
-    #         "http://services.xmethods.net/soap",        # service URI
-    #         "urn:xmethods-delayed-quotes",              # namespace
-    #         "getQuote",                                 # operation name
-    #         [ "symbol" ])                               # param arrays (workitem fields)
-    #     
-    #     engine.register_participant("quote_service", quote_service)
-    #
-    # By default, call params for the SOAP operations are determined by
-    # iterating the parameters and fetching the values under the 
-    # corresponding workitem fields.
-    # This behaviour can be changed by overriding the prepare_call_params()
-    # method.
-    # 
-    # On the return side, you can override the method handle_call_result 
-    # for better mappings between web service calls and the workitems.
+    # The method called by the engine when the flow reaches an instance
+    # of this Participant class.
     #
-    class SoapParticipant 
-        include LocalParticipant
-
-        def initialize \
-            (endpoint_url, namespace, method_name, params, param_prefix="")
-
-            super()
-
-            @driver = SOAP::RPC::Driver.new(endpoint_url, namespace)
-
-            @method_name = method_name
-            @params = params
-            @param_prefix = param_prefix
+    def consume (workitem)
 
-            @driver.add_method(method_name, *params)
-        end
+      call_params = prepare_call_params(workitem)
 
-        #
-        # The method called by the engine when the flow reaches an instance
-        # of this Participant class.
-        #
-        def consume (workitem)
+      call_result = @driver.send(@method_name, *call_params)
 
-            call_params = prepare_call_params(workitem)
+      handle_call_result(call_result, workitem)
 
-            call_result = @driver.send(@method_name, *call_params)
-
-            handle_call_result(call_result, workitem)
-
-            reply_to_engine(workitem)
-        end
+      reply_to_engine(workitem)
+    end
 
-        #
-        # The base implementation : assumes that for each webservice operation
-        # param there is a workitem field with the same name.
-        #
-        # Feel free to override this method.
-        #
-        def prepare_call_params (workitem)
+    #
+    # The base implementation : assumes that for each webservice operation
+    # param there is a workitem field with the same name.
+    #
+    # Feel free to override this method.
+    #
+    def prepare_call_params (workitem)
 
-            @params.collect do |param|
-                get_param workitem, param
-            end
-        end
+      @params.collect do |param|
+        get_param workitem, param
+      end
+    end
 
-        #
-        # This implementation simply stuffs the result into the workitem
-        # as an attribute named "__result__".
-        #
-        # Feel free to override this method.
-        #
-        def handle_call_result (result, workitem)
+    #
+    # This implementation simply stuffs the result into the workitem
+    # as an attribute named "__result__".
+    #
+    # Feel free to override this method.
+    #
+    def handle_call_result (result, workitem)
 
-            workitem.attributes["__result__"] = result
-        end
+      workitem.attributes["__result__"] = result
+    end
 
-        protected
+    protected
 
-            def get_param (workitem, param_name)
+      def get_param (workitem, param_name)
 
-                param_name = @param_prefix + param_name if @param_prefix
+        param_name = @param_prefix + param_name if @param_prefix
 
-                workitem.attributes[param_name] || ""
-            end
+        workitem.attributes[param_name] || ""
+      end
 
-    end
+  end
 
 end
 

data/lib/openwfe/participants/socketparticipants.rb

@@ -2,31 +2,31 @@
 #--
 # Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
-# 
-# Redistribution and use in source and binary forms, with or without 
+#
+# 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 
+#   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 
+#
+# 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.
 #++
 #
@@ -47,156 +47,156 @@ require 'openwfe/participants/participant'
 
 module OpenWFE
 
+  #
+  # This participant implementation dispatches workitems over TCP sockets.
+  # By default the workitem are dumped as YAML strings, but you can override
+  # the encode_workitem(wi) method.
+  #
+  # A small example :
+  #
+  #   require 'openwfe/particpants/socketparticipants'
+  #
+  #   sp = OpenWFE::SocketParticipant.new("target.host.xx", 7007)
+  #
+  #   engine.register_participant("Alfred", sp)
+  #
+  class SocketParticipant
+
+    attr_accessor :host, :port
+
     #
-    # This participant implementation dispatches workitems over TCP sockets.
-    # By default the workitem are dumped as YAML strings, but you can override 
-    # the encode_workitem(wi) method.
-    #
-    # A small example :
-    #
-    #     require 'openwfe/particpants/socketparticipants'
-    #
-    #     sp = OpenWFE::SocketParticipant.new("target.host.xx", 7007)
-    #
-    #     engine.register_participant("Alfred", sp)
+    # The constructor
     #
-    class SocketParticipant
+    def initialize (host, port)
 
-        attr_accessor :host, :port
-
-        #
-        # The constructor
-        #
-        def initialize (host, port)
-
-            @host = host
-            @port = port
-        end
-
-        #
-        # The method called by the engine for each incoming workitem.
-        # Will dispatch the workitem over a TCP connection.
-        #
-        def consume (workitem)
+      @host = host
+      @port = port
+    end
 
-            dispatch(workitem)
-        end
+    #
+    # The method called by the engine for each incoming workitem.
+    # Will dispatch the workitem over a TCP connection.
+    #
+    def consume (workitem)
 
-        def dispatch (workitem)
+      dispatch(workitem)
+    end
 
-            socket = TCPSocket.new(@host, @port)
-            socket.puts encode_workitem(workitem)
-            socket.puts
-            socket.close_write
+    def dispatch (workitem)
 
-            #print "\n__socket.closed? #{socket.closed?}"
+      socket = TCPSocket.new(@host, @port)
+      socket.puts encode_workitem(workitem)
+      socket.puts
+      socket.close_write
 
-            reply = fetch_reply(socket)
+      #print "\n__socket.closed? #{socket.closed?}"
 
-            socket.close
+      reply = fetch_reply(socket)
 
-            decode_reply(reply)
-        end
+      socket.close
 
-        #
-        # A 'static' method for dispatching workitems, you can use it
-        # directly, without instantiating the SocketParticipant :
-        #
-        #     require 'openwfe/participants/socketparticipants'
-        #
-        #     SocketParticipant.dispatch("127.0.0.1", 7007, workitem)
-        #
-        def SocketParticipant.dispatch (host, port, workitem)
-
-            SocketParticipant.new(host, port).dispatch(workitem)
-        end
+      decode_reply(reply)
+    end
 
-        protected
+    #
+    # A 'static' method for dispatching workitems, you can use it
+    # directly, without instantiating the SocketParticipant :
+    #
+    #   require 'openwfe/participants/socketparticipants'
+    #
+    #   SocketParticipant.dispatch("127.0.0.1", 7007, workitem)
+    #
+    def SocketParticipant.dispatch (host, port, workitem)
 
-            #
-            # By default, uses YAML to serialize the workitem
-            # (of course you can override this method).
-            #
-            def encode_workitem (wi)
-                YAML.dump(wi)
-            end
+      SocketParticipant.new(host, port).dispatch(workitem)
+    end
 
-            #
-            # By default, will just return the reply without touching it
-            #
-            def decode_reply (r)
-                r
+    protected
+
+      #
+      # By default, uses YAML to serialize the workitem
+      # (of course you can override this method).
+      #
+      def encode_workitem (wi)
+        YAML.dump(wi)
+      end
+
+      #
+      # By default, will just return the reply without touching it
+      #
+      def decode_reply (r)
+        r
+      end
+
+      #
+      # The code that waits for the reply from the server, nicely
+      # wrapped inside a timeout and a rescue block.
+      #
+      def fetch_reply (socket)
+
+        reply = ""
+
+        begin
+
+          timeout(7) do
+            while true
+              r = socket.gets
+              break unless r
+              reply << r
             end
+          end
 
-            #
-            # The code that waits for the reply from the server, nicely
-            # wrapped inside a timeout and a rescue block.
-            #
-            def fetch_reply (socket)
-
-                reply = ""
-
-                begin
+        rescue Exception => e
+          puts e
+          raise "timeout while waiting for reply"
+        end
 
-                    timeout(7) do
-                        while true
-                            r = socket.gets
-                            break unless r
-                            reply << r
-                        end
-                    end
+        reply
+      end
+  end
 
-                rescue Exception => e
-                    puts e
-                    raise "timeout while waiting for reply"
-                end
+  #
+  # This extension of of SocketParticipant can be used to dispatch
+  # workitems towards an OpenWFEja instance, but OpenWFEru's SocketListener
+  # understands XML workitems as well.
+  #
+  class XmlSocketParticipant < SocketParticipant
 
-                reply
-            end
-    end
+    #def initialize (host, port)
+    #  super
+    #end
 
     #
-    # This extension of of SocketParticipant can be used to dispatch
-    # workitems towards an OpenWFEja instance, but OpenWFEru's SocketListener
-    # understands XML workitems as well.
+    # A 'static' method for dispatching workitems, you can use it
+    # directly, without instantiating the SocketParticipant :
     #
-    class XmlSocketParticipant < SocketParticipant
-
-        #def initialize (host, port)
-        #    super
-        #end
-
-        #
-        # A 'static' method for dispatching workitems, you can use it
-        # directly, without instantiating the SocketParticipant :
-        #
-        #     require 'openwfe/participants/socketparticipants'
-        #
-        #     SocketParticipant.dispatch("127.0.0.1", 7007, workitem)
-        #
-        def XmlSocketParticipant.dispatch (host, port, workitem)
-
-            XmlSocketParticipant.new(host, port).consume(workitem)
-        end
+    #   require 'openwfe/participants/socketparticipants'
+    #
+    #   SocketParticipant.dispatch("127.0.0.1", 7007, workitem)
+    #
+    def XmlSocketParticipant.dispatch (host, port, workitem)
 
-        protected
+      XmlSocketParticipant.new(host, port).consume(workitem)
+    end
 
-            #
-            # This implementation encodes the workitem as an XML document.
-            # This is compatible with OpenWFEja.
-            #
-            def encode_workitem (wi)
+    protected
 
-                sxml = OpenWFE::XmlCodec::encode(wi)
+      #
+      # This implementation encodes the workitem as an XML document.
+      # This is compatible with OpenWFEja.
+      #
+      def encode_workitem (wi)
 
-                s = "xmlCoder #{sxml.length}\n"
-                s << "\n"
-                s << sxml
-                s << "\n"
-                s << "\n"
-                s
-            end
-    end
+        sxml = OpenWFE::XmlCodec::encode(wi)
+
+        s = "xmlCoder #{sxml.length}\n"
+        s << "\n"
+        s << sxml
+        s << "\n"
+        s << "\n"
+        s
+      end
+  end
 
 end