soap5r 2.0.0

data/sample/howto/documentliteral/servant.rb

@@ -0,0 +1,12 @@
+# encoding: ASCII-8BIT
+require 'default.rb'
+
+class EchoPortType
+  def echo(parameters)
+    response = EchoResponse.new
+    response << parameters.xmlattr_sampleAttr
+    response << parameters.sampleElement
+    response
+  end
+end
+

data/sample/howto/filter/client.rb

@@ -0,0 +1,43 @@
+# encoding: ASCII-8BIT
+require 'soap/rpc/driver'
+
+
+class ClientFilter1 < SOAP::Filter::Handler
+  # 1 -> 2
+  def on_outbound(envelope, opt)
+    param = envelope.body.root_node.inparam
+    param["amt"] = SOAP::SOAPInt.new(param["amt"].data + 1)
+    param["amt"].elename = XSD::QName.new(nil, 'amt')
+    envelope
+  end
+
+  # 31 -> 32
+  def on_inbound(xml, opt)
+    xml = xml.sub(/31/, '32')
+    xml
+  end
+end
+
+class ClientFilter2 < SOAP::Filter::Handler
+  # 2 -> 4
+  def on_outbound(envelope, opt)
+    param = envelope.body.root_node.inparam
+    param["amt"] = SOAP::SOAPInt.new(param["amt"].data * 2)
+    param["amt"].elename = XSD::QName.new(nil, 'amt')
+    envelope
+  end
+
+  # 30 -> 31
+  def on_inbound(xml, opt)
+    xml = xml.sub(/30/, '31')
+    xml
+  end
+end
+
+
+client = SOAP::RPC::Driver.new("http://localhost:7171", "urn:filter")
+client.add_method('echo', 'amt')
+client.filterchain << ClientFilter1.new
+client.filterchain << ClientFilter2.new
+
+p client.echo(1)

data/sample/howto/filter/server.rb

@@ -0,0 +1,68 @@
+# encoding: ASCII-8BIT
+require 'soap/rpc/standaloneServer'
+require 'soap/filter'
+
+
+class FilterTestServer < SOAP::RPC::StandaloneServer
+  class Servant
+    def self.create
+      new
+    end
+
+    def echo(amt)
+      amt
+    end
+  end
+
+  class ServerFilter1 < SOAP::Filter::Handler
+    # 15 -> 30
+    def on_outbound(envelope, opt)
+      unless envelope.body.is_fault
+        node = envelope.body.root_node
+        node.retval = SOAP::SOAPInt.new(node.retval.data * 2)
+        node.elename = XSD::QName.new(nil, 'return')
+      end
+      envelope
+    end
+
+    # 4 -> 5
+    def on_inbound(xml, opt)
+      xml = xml.sub(/4/, '5')
+      xml
+    end
+  end
+
+  class ServerFilter2 < SOAP::Filter::Handler
+    # 5 -> 15
+    def on_outbound(envelope, opt)
+      unless envelope.body.is_fault
+        node = envelope.body.root_node
+        node.retval = SOAP::SOAPInt.new(node.retval.data + 10)
+        node.elename = XSD::QName.new(nil, 'return')
+      end
+      envelope
+    end
+
+    # 5 -> 6
+    def on_inbound(xml, opt)
+      xml = xml.sub(/5/, '6')
+      xml
+    end
+  end
+
+  def initialize(*arg)
+    super
+    add_rpc_servant(Servant.new, "urn:filter")
+    self.filterchain << ServerFilter1.new
+    self.filterchain << ServerFilter2.new
+  end
+end
+
+
+if __FILE__ == $0
+  server = FilterTestServer.new(self.class.name, nil, '0.0.0.0', 7171)
+  trap("INT") do
+    server.shutdown
+  end
+  server.start
+end

data/sample/howto/scopesample/client.rb

@@ -0,0 +1,35 @@
+# encoding: ASCII-8BIT
+require 'soap/rpc/driver'
+
+server = ARGV.shift || 'http://localhost:7000/'
+# server = 'http://localhost:8808/server.cgi'
+
+# client which accesses application scope servant.
+app = SOAP::RPC::Driver.new(server,
+  'http://tempuri.org/applicationScopeService')
+app.add_method('push', 'value')
+app.add_method('pop')
+
+# client which accesses request scope servant must send SOAPAction to identify
+# the service.
+req = SOAP::RPC::Driver.new(server,
+  'http://tempuri.org/requestScopeService')
+req.add_method_with_soapaction('push',
+  'http://tempuri.org/requestScopeService', 'value')
+req.add_method_with_soapaction('pop',
+  'http://tempuri.org/requestScopeService')
+
+# exec
+app.push(1)
+app.push(2)
+app.push(3)
+p app.pop
+p app.pop
+p app.pop
+
+req.push(1)
+req.push(2)
+req.push(3)
+p req.pop
+p req.pop
+p req.pop

data/sample/howto/scopesample/httpd.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# encoding: ASCII-8BIT
+
+require 'webrick'
+require 'soap/property'
+
+docroot = "."
+port = 8808
+if opt = SOAP::Property.loadproperty("samplehttpd.conf")
+  docroot = opt["docroot"]
+  port = Integer(opt["port"])
+end
+
+s = WEBrick::HTTPServer.new(
+  :BindAddress => "0.0.0.0",
+  :Port => port,
+  :DocumentRoot => docroot,
+  :CGIPathEnv => ENV['PATH']
+)
+trap(:INT) do
+  s.shutdown
+end
+s.start

data/sample/howto/scopesample/samplehttpd.conf

@@ -0,0 +1,2 @@
+docroot = .
+port = 8808

data/sample/howto/scopesample/servant.rb

@@ -0,0 +1,19 @@
+# encoding: ASCII-8BIT
+class Servant
+  def self.create
+    new
+  end
+
+  def initialize
+    STDERR.puts "Servant created."
+    @task = []
+  end
+
+  def push(value)
+    @task.push(value)
+  end
+
+  def pop
+    @task.pop
+  end
+end

data/sample/howto/scopesample/server.cgi

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# encoding: ASCII-8BIT
+
+require 'soap/rpc/cgistub'
+require 'servant'
+
+class Server < SOAP::RPC::CGIStub
+  class DummyServant
+    def push(value)
+      "Not supported"
+    end
+
+    def pop
+      "Not supported"
+    end
+  end
+
+  def initialize(*arg)
+    super
+    add_rpc_servant(Servant.new, 'http://tempuri.org/requestScopeService')
+
+    # Application scope servant is not supported in CGI environment.
+    # See server.rb to support application scope servant.
+    dummy = DummyServant.new
+    add_method_with_namespace('http://tempuri.org/applicationScopeService', dummy, 'push', 'value')
+    add_method_with_namespace('http://tempuri.org/applicationScopeService', dummy, 'pop')
+  end
+end
+
+status = Server.new('Server', nil).start

data/sample/howto/scopesample/server.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# encoding: ASCII-8BIT
+
+require 'soap/rpc/standaloneServer'
+require 'servant'
+
+class Server < SOAP::RPC::StandaloneServer
+  def initialize(*arg)
+    super
+    add_rpc_servant(Servant.new, 'http://tempuri.org/applicationScopeService')
+    add_rpc_request_servant(Servant, 'http://tempuri.org/requestScopeService')
+  end
+end
+
+if $0 == __FILE__
+  server = Server.new('Server', nil, '0.0.0.0', 7000)
+  trap(:INT) do
+    server.shutdown
+  end
+  server.start
+end

data/sample/howto/styleuse/client.rb

@@ -0,0 +1,22 @@
+# encoding: ASCII-8BIT
+require 'soap/rpc/driver'
+
+server = 'http://localhost:7000/'
+
+app = SOAP::RPC::Driver.new(server, 'urn:styleuse')
+app.wiredump_dev = STDOUT
+app.add_rpc_method('rpc_serv', 'obj1', 'obj2')
+app.add_document_method('doc_serv', 'urn:doc_serv#doc_serv',
+  [XSD::QName.new('urn:styleuse', 'req')],
+  [XSD::QName.new('urn:styleuse', 'res')])
+app.add_document_method('doc_serv2', 'urn:doc_serv#doc_serv2',
+  [XSD::QName.new('urn:styleuse', 'req')],
+  [XSD::QName.new('urn:styleuse', 'res')])
+  #app.wiredump_dev = STDOUT
+
+p app.rpc_serv(true, false)
+p app.rpc_serv("foo", "bar")
+p app.doc_serv({"a" => "2"})
+p app.doc_serv({"a" => {"b" => "2"}})
+p app.doc_serv2({"a" => "2"})
+p app.doc_serv2({"a" => {"b" => "2", :e => 5}, "c" => "d"})

data/sample/howto/styleuse/server.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# encoding: ASCII-8BIT
+
+require 'soap/rpc/standaloneServer'
+
+class Server < SOAP::RPC::StandaloneServer
+  class RpcServant
+    def rpc_serv(obj1, obj2)
+      [obj1, obj2]
+    end
+  end
+
+  class DocumentServant
+    def doc_serv(hash)
+      hash
+    end
+
+    def doc_serv2(hash)
+      { 'newroot' => hash }
+    end
+  end
+
+  class GenericServant
+
+    # method name style: requeststyle_requestuse_responsestyle_responseuse
+
+    def rpc_enc_rpc_enc(obj1, obj2)
+      [obj1, obj2]
+    end
+
+    alias rpc_enc_rpc_lit rpc_enc_rpc_enc
+
+    def rpc_enc_doc_enc(obj1, obj2)
+      obj1
+    end
+
+    alias rpc_enc_doc_lit rpc_enc_doc_enc
+
+    def doc_enc_rpc_enc(obj)
+      [obj, obj]
+    end
+
+    alias doc_enc_rpc_lit doc_enc_rpc_enc
+
+    def doc_enc_doc_enc(obj)
+      obj
+    end
+
+    alias doc_enc_doc_lit doc_enc_doc_enc
+  end
+
+  def initialize(*arg)
+    super
+    rpcservant = RpcServant.new
+    docservant = DocumentServant.new
+    add_rpc_servant(rpcservant)
+    add_document_method(docservant, 'urn:doc_serv#doc_serv', 'doc_serv',
+      [XSD::QName.new('urn:styleuse', 'req')],
+      [XSD::QName.new('urn:styleuse', 'res')])
+    add_document_method(docservant, 'urn:doc_serv#doc_serv2', 'doc_serv2',
+      [XSD::QName.new('urn:styleuse', 'req')],
+      [XSD::QName.new('urn:styleuse', 'res')])
+
+    #servant = Servant.new
+    # ToDo: too plain: should add bare test case
+    #qname ||= XSD::QName.new(@default_namespace, name)
+    #add_operation(qname, nil, servant, "rpc_enc_rpc_enc", param_def,
+    #  opt(:rpc, :rpc, :encoded, :encoded))
+  end
+
+  def opt(request_style, request_use, response_style, response_use)
+    {
+      :request_style => request_style,
+      :request_use => request_use,
+      :response_style => response_style,
+      :response_use => response_use
+    }
+  end
+end
+
+if $0 == __FILE__
+  server = Server.new('Server', 'urn:styleuse', '0.0.0.0', 7000)
+  trap(:INT) do
+    server.shutdown
+  end
+  server.start
+end

data/sample/howto/wsdl_fault/README.txt

@@ -0,0 +1,11 @@
+These samples are created by Peter Gardfjäl.  Thanks!
+
+1) Generate the stubs
+    ruby wsdl2ruby.rb --wsdl fault.wsdl --type client --type server --force --quiet
+2) Start the server:
+    ruby AddServer.rb 12345
+3) Run the (add) client:
+    ruby -d AddClient.rb  http://localhost:12345 101
+
+The "fault" directory contains a service that raises a fault whenever the added number is greater than 100.
+The "multifault" sample behaves the same way, but in addition to the AddFault it also raises a NegativeValueFault if the received value is negative.

data/sample/howto/wsdl_fault/fault/AddClient.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# encoding: ASCII-8BIT
+require 'AddDriver.rb'
+
+endpoint_url = ARGV.shift
+value = ARGV.shift
+if ((endpoint_url == nil) or (value == nil)) then
+  puts "Usage: ${0} <service-url> <value>"
+  exit -1
+end
+
+obj = AddPortType.new(endpoint_url)
+# run ruby with -d to see SOAP wiredumps.
+obj.wiredump_dev = STDERR if $DEBUG
+
+
+begin
+  request = Add.new(value)
+  response = obj.add(request)
+  puts "Result: #{response.sum}"
+rescue SOAP::FaultError => e
+  puts "Fault caught! Reason: '#{e.detail.addFault.reason}' Severity: '#{e.detail.addFault.severity}'"
+end
+
+

data/sample/howto/wsdl_fault/fault/AddServer.rb

@@ -0,0 +1,16 @@
+# encoding: ASCII-8BIT
+require 'AddService.rb'
+require 'AddServiceImpl.rb'
+
+port = ARGV.shift
+if (port == nil) then
+  puts "Usage: ${0} <port>"
+  exit -1
+end
+
+server = AddPortTypeApp.new('app', nil, '0.0.0.0', port.to_i)
+trap(:INT) do
+  server.shutdown
+end
+puts "Starting fault service endpoint"
+server.start

data/sample/howto/wsdl_fault/fault/AddServiceImpl.rb

@@ -0,0 +1,19 @@
+# encoding: ASCII-8BIT
+require 'AddMappingRegistry.rb'
+require 'AddServant.rb'
+
+class AddPortType
+  def initialize()
+    @sum = 0
+  end
+
+  def add(request)
+    if (request.value > 100)
+      fault = AddFault.new("Value #{request.value} is too large", "Critical")
+      raise fault
+    end
+    @sum += request.value
+    return AddResponse.new(@sum)
+  end
+end
+

data/sample/howto/wsdl_fault/fault/fault.wsdl

@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<definitions name="Add"
+  targetNamespace="http://fault.test/Faulttest"
+  xmlns:tns="http://fault.test/Faulttest"
+  xmlns="http://schemas.xmlsoap.org/wsdl/"
+  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/">
+
+<types>
+  <schema targetNamespace="http://fault.test/Faulttest"
+          xmlns="http://www.w3.org/2001/XMLSchema">
+
+    <element name="Add">
+      <complexType>
+        <sequence>
+          <element name="value" type="int"/>
+        </sequence>
+      </complexType>
+    </element>
+    <element name="AddResponse">
+      <complexType>
+        <sequence>
+          <element name="sum" type="int"/>
+        </sequence>
+      </complexType>
+    </element>
+
+    <element name="AddFault">
+      <complexType>
+        <sequence>
+          <element name="Reason" type="string"/>
+          <element name="Severity" type="string"/>
+        </sequence>
+      </complexType>
+    </element>
+
+  </schema>
+</types>
+
+<message name="AddMessage">
+  <part name="request" element="tns:Add"/>
+</message>
+<message name="AddResponseMessage">
+  <part name="response" element="tns:AddResponse"/>
+</message>
+<message name="AddFaultMessage">
+  <part name="fault" element="tns:AddFault"/>
+</message>
+
+<portType name="AddPortType">
+  <operation name="Add">
+    <input  name="Add" message="tns:AddMessage"/>
+    <output name="AddResponse" message="tns:AddResponseMessage"/>
+    <fault  name="AddFault" message="tns:AddFaultMessage"/>
+  </operation>
+</portType>
+
+  <binding name="AddSOAPBinding" type="tns:AddPortType">
+    <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
+    <operation name="Add">
+      <soap:operation soapAction="Add"/>
+      <input>
+        <soap:body use="literal"/>
+      </input>
+      <output>
+        <soap:body use="literal"/>
+      </output>
+      <fault name="AddFault">
+        <soap:fault name="AddFault"/>
+      </fault>
+    </operation>
+  </binding>
+
+  <service name="AddService">
+    <port name="AddPort" binding="tns:AddSOAPBinding">
+      <soap:address location="http://localhost:8080/"/>
+    </port>
+  </service>
+
+</definitions>

data/sample/howto/wsdl_fault/multifault/AddClient.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# encoding: ASCII-8BIT
+require 'AddDriver.rb'
+
+endpoint_url = ARGV.shift
+value = ARGV.shift
+if ((endpoint_url == nil) or (value == nil)) then
+  puts "Usage: #{$0} <service-url> <value>"
+  exit -1
+end
+
+obj = AddPortType.new(endpoint_url)
+# run ruby with -d to see SOAP wiredumps.
+obj.wiredump_dev = STDERR if $DEBUG
+
+
+begin
+  request = Add.new(value)
+  response = obj.add(request)
+  puts "Result: #{response.sum}"
+rescue SOAP::FaultError => e
+  if (e.faultstring.to_s == "AddFault")
+    puts "Fault caught! Reason: '#{e.detail.addFault.reason}' Severity: '#{e.detail.addFault.severity}'"
+  else
+    puts "Fault caught! Reason: '#{e.detail.negativeValueFault.reason}' Severity: '#{e.detail.negativeValueFault.severity}'"
+  end
+end
+
+

data/sample/howto/wsdl_fault/multifault/AddServer.rb

@@ -0,0 +1,16 @@
+# encoding: ASCII-8BIT
+require 'AddService.rb'
+require 'AddServiceImpl.rb'
+
+port = ARGV.shift
+if (port == nil) then
+  puts "Usage: ${0} <port>"
+  exit -1
+end
+
+server = AddPortTypeApp.new('app', nil, '0.0.0.0', port.to_i)
+trap(:INT) do
+  server.shutdown
+end
+puts "Starting fault service endpoint"
+server.start

data/sample/howto/wsdl_fault/multifault/AddServiceImpl.rb

@@ -0,0 +1,25 @@
+# encoding: ASCII-8BIT
+require 'AddMappingRegistry.rb'
+require 'AddServant.rb'
+
+class AddPortType
+  def initialize()
+    @sum = 0
+  end
+
+  def add(request)
+    if (request.value > 100)
+      fault = AddFault.new("Value #{request.value} is too large", "Critical")
+      raise fault
+    end
+
+    if (request.value < 0)
+      fault = NegativeValueFault.new("Value #{request.value} is negative", "Fatal")
+      raise fault
+    end
+
+    @sum += request.value
+    return AddResponse.new(@sum)
+  end
+end
+