soap4r-ruby1.9 1.0.0

data/sample/basic/wsdl_helloworld/server/hws.wsdl

@@ -0,0 +1,46 @@
+<?xml version="1.0"?>
+<definitions xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
+xmlns:tns="http://localhost:2000/wsdl/hws.wsdl"
+xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
+xmlns:si="http://soapinterop.org/xsd" 
+xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" 
+xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" 
+xmlns="http://schemas.xmlsoap.org/wsdl/" 
+targetNamespace="http://localhost:2000/wsdl/hws.wsdl">
+<message name="getTermRequest">
+   <part name="from" type="xsd:string"/>
+</message>
+
+<message name="hello_worldResponse">
+   <part name="from" type="xsd:string"/>
+</message>
+
+<portType name="hwsPort">
+  <operation name="hello_world">
+      <input message="getTermRequest"/>
+      <output message="hello_worldResponse"/>
+  </operation>
+</portType>
+<binding name="hwsBinding" type="tns:hwsPort">
+   <soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>
+   <operation name="hello_world">
+       <soap:operation soapAction="http://localhost:2000/wsdl/hws.wsdl#hello_world" style="rpc"/>
+      <input>
+         <soap:body use="encoded" namespace="http://localhost:2000/wsdl/hws.wsdl" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
+      </input>
+      <output>
+         <soap:body use="encoded" namespace="http://localhost:2000/wsdl/hws.wsdl" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
+      </output>
+   </operation>
+ </binding>
+ <service name="hws">
+    <documentation>The service simply says hello world from something supplied</documentation>
+ 
+    <port name="hwsPort" binding="tns:hwsBinding">
+       <soap:address location="http://localhost:2000/"/>
+    </port>
+</service>
+
+</definitions>

data/sample/basic/yahooNewsSearch.rb

@@ -0,0 +1,36 @@
+query = ARGV.shift or raise ArgumentError
+
+require 'soap/marshal'
+class MyXMLHandler < SOAP::EncodingStyle::SOAPHandler
+  Namespace = 'urn:myxmlhandler'
+  add_handler
+  def decode_parent(parent, node)
+    super if parent.node
+  end
+end
+
+require 'httpclient'
+appid = 'soap4r-dev'
+url = 'http://api.search.yahoo.com/NewsSearchService/V1/newsSearch'
+type = 'all'    # any, phrase
+results = 3
+language = 'en'
+results_sort = 'rank'     # date
+
+param = {
+  'appid' => appid,
+  'query' => query,
+  'results' => results,
+  'language' => language,
+  'results_sort' => results_sort
+}
+proxy = ENV['http_proxy'] || ENV['HTTP_PROXY']
+result = HTTPClient.new(proxy).get_content(url, param)
+
+opt = {:default_encodingstyle => 'urn:myxmlhandler'}
+soap = SOAP::Processor.unmarshal(result, opt)
+
+SOAP::Mapping.soap2obj(soap).result.each do |result|
+  puts "== " + result.title + " =="
+  puts result.summary
+end

data/sample/howto/as_xml/client.rb

@@ -0,0 +1,22 @@
+require 'soap/rpc/driver'
+
+Namespace = 'urn:echo'
+drv = SOAP::RPC::Driver.new('http://localhost:7171/', Namespace)
+drv.add_document_method('echo', 'echo_soapaction',
+  XSD::QName.new(Namespace, 'echoRequest'),
+  XSD::QName.new(Namespace, 'echoResponse'))
+
+drv.return_response_as_xml = true
+drv.wiredump_dev = STDOUT
+
+require 'rexml/document'
+request = REXML::Document.new(<<__XML__)
+<echoRequest xmlns="urn:echo">
+  <foo bar="baz">
+    <qux>quxx</qux>
+  </foo>
+</echoRequest>
+__XML__
+
+response = drv.echo(request)
+p REXML::XPath.match(REXML::Document.new(response), "//*[name()='n1:foo']")

data/sample/howto/as_xml/server.rb

@@ -0,0 +1,22 @@
+require 'soap/rpc/standaloneServer'
+
+class EchoServer < SOAP::RPC::StandaloneServer
+  Namespace = 'urn:echo'
+  def on_init
+    add_document_method(self, 'echo_soapaction', 'echo', 
+      XSD::QName.new(Namespace, 'echoRequest'),
+      XSD::QName.new(Namespace, 'echoResponse'))
+  end
+
+  def echo(var)
+    var
+  end
+end
+
+if $0 == __FILE__
+  server = EchoServer.new('app', EchoServer::Namespace, '0.0.0.0', 7171)
+  trap(:INT) do 
+    server.shutdown
+  end
+  server.start
+end

data/sample/howto/base64/client.rb

@@ -0,0 +1,17 @@
+require 'soap/rpc/driver'
+
+server = ARGV.shift || 'http://localhost:7000/'
+
+drv = SOAP::RPC::Driver.new(server, 'http://tempuri.org/base64Service')
+drv.wiredump_dev = STDERR if $DEBUG
+
+drv.add_method('echo', 'arg')
+drv.add_method('echo_base64', 'arg')
+
+binary = "\0\0\0"
+text = "000"
+
+drv.echo(binary)        # => binary is automatically converted to Base64
+
+drv.echo(text)                              # => send as String
+drv.echo_base64(SOAP::SOAPBase64.new(text)) # => send as Base64 explicitly

data/sample/howto/base64/server.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'soap/rpc/standaloneServer'
+
+class Server < SOAP::RPC::StandaloneServer
+  def initialize(*arg)
+    super
+    add_rpc_method(self, 'echo', 'arg')
+    add_rpc_method(self, 'echo_base64', 'arg')
+  end
+
+  def echo(arg)
+    p arg
+    arg
+  end
+
+  def echo_base64(arg)
+    p arg
+    SOAP::SOAPBase64.new(arg)
+  end
+end
+
+if $0 == __FILE__
+  server = Server.new('Server', 'http://tempuri.org/base64Service',
+    '0.0.0.0', 7000)
+  trap(:INT) do
+    server.shutdown
+  end
+  server.start
+end

data/sample/howto/custom_ns/client.rb

@@ -0,0 +1,37 @@
+require 'soap/rpc/driver'
+require 'soap/header/simplehandler'
+
+
+class DefaultNSFilter < SOAP::Filter::Handler
+  def on_outbound(envelope, opt)
+    opt[:default_ns] = @default_ns
+    envelope
+  end
+
+  def initialize
+    @default_ns = SOAP::NS.new
+    @default_ns.assign('urn:custom_ns', 'myns')
+  end
+end
+
+
+class MyHeaderHandler < SOAP::Header::SimpleHandler
+  MyHeaderName = XSD::QName.new('urn:custom_ns', 'myheader')
+
+  def initialize
+    super(MyHeaderName)
+  end
+
+  def on_simple_outbound
+    { "hello" => "world" }
+  end
+end
+
+
+client = SOAP::RPC::Driver.new("http://localhost:7171", "urn:custom_ns")
+client.add_method('echo', 'amt')
+client.filterchain << DefaultNSFilter.new
+client.headerhandler << MyHeaderHandler.new
+client.wiredump_dev = STDOUT
+
+p client.echo(1)

data/sample/howto/custom_ns/server.rb

@@ -0,0 +1,42 @@
+require 'soap/rpc/standaloneServer'
+require 'soap/filter'
+
+
+class CustomNSTestServer < SOAP::RPC::StandaloneServer
+  class Servant
+    def self.create
+      new
+    end
+
+    def echo(amt)
+      amt
+    end
+  end
+
+  class DefaultNSFilter < SOAP::Filter::Handler
+    def on_outbound(envelope, opt)
+      opt[:default_ns] = @default_ns
+      envelope
+    end
+
+    def initialize
+      @default_ns = SOAP::NS.new
+      @default_ns.assign('urn:custom_ns', 'myns')
+    end
+  end
+
+  def initialize(*arg)
+    super
+    add_rpc_servant(Servant.new, "urn:custom_ns")
+    self.filterchain << DefaultNSFilter.new
+  end
+end
+
+
+if __FILE__ == $0
+  server = CustomNSTestServer.new(self.class.name, nil, '0.0.0.0', 7171)
+  trap("INT") do
+    server.shutdown
+  end
+  server.start
+end

data/sample/howto/documentliteral/README.txt

@@ -0,0 +1,19 @@
+To use the sample service in this directory;
+
+1. run ../../../bin/wsdl2ruby.rb:
+  $ wsdl2ruby.rb --wsdl echo.wsdl --type server --type client --force
+
+2. replace the file defaultServant.rb with the file servant.rb in this
+  directory.  the file defaultServant.rb is generated by wsdl2ruby.rb in the
+  previous step.
+
+3. replace the file echoServiceClient.rb with the file client.rb in this
+  directory.  the file echoServiceClient.rb is generated by wsdl2ruby.rb, too.
+
+4. run echoService.rb:
+  $ ruby echoService.rb
+
+  echoService.rb is the server program.  hit Ctrl-C to stop the server.
+
+5. run echoServiceClient.rb in another terminal:
+  $ ruby echoServiceClient.rb http://localhost:10080

data/sample/howto/documentliteral/client.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+require 'defaultDriver.rb'
+
+endpoint_url = ARGV.shift
+obj = EchoPortType.new(endpoint_url)
+obj.wiredump_dev = STDOUT if $DEBUG
+
+request = EchoRequest.new
+request.xmlattr_sampleAttr = 5
+request.sampleElement = 3.14
+p obj.echo(request)

data/sample/howto/documentliteral/echo.wsdl

@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="utf-8"?>
+<definitions targetNamespace="urn:com.example:echo"
+    xmlns:http="http://schemas.xmlsoap.org/wsdl/http/"
+    xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    xmlns:tns="urn:com.example:echo"
+    xmlns="http://schemas.xmlsoap.org/wsdl/">
+  <types>
+    <xsd:schema targetNamespace="urn:com.example:echo"
+        elementFormDefault="qualified">
+      <xsd:complexType name="TestType">
+        <xsd:sequence>
+          <xsd:any minOccurs="0" maxOccurs="unbounded" />
+        </xsd:sequence>
+      </xsd:complexType>
+      <xsd:element name="echoRequest">
+        <xsd:complexType>
+          <xsd:sequence>
+            <xsd:element name="sampleElement"
+              minOccurs="0" maxOccurs="1" type="xsd:float" />
+          </xsd:sequence>
+          <xsd:attribute name="sampleAttr" type="xsd:int" />
+        </xsd:complexType>
+      </xsd:element>
+      <xsd:element name="echoResponse">
+        <xsd:complexType>
+          <xsd:sequence>
+            <xsd:element name="sampleMultiValue"
+              minOccurs="0" maxOccurs="unbounded" type="xsd:string" />
+          </xsd:sequence>
+        </xsd:complexType>
+      </xsd:element>
+    </xsd:schema>
+  </types>
+
+  <message name="echoIn">
+    <part name="parameters" element="tns:echoRequest" />
+  </message>
+  <message name="echoOut">
+    <part name="parameters" element="tns:echoResponse" />
+  </message>
+
+  <portType name="echoPortType">
+    <operation name="echo">
+      <input message="tns:echoIn" />
+      <output message="tns:echoOut" />
+    </operation>
+  </portType>
+
+  <binding name="echoBinding" type="tns:echoPortType">
+    <soap:binding
+      transport="http://schemas.xmlsoap.org/soap/http"
+      style="document" />
+    <operation name="echo">
+      <soap:operation soapAction="urn:com.example:echo" style="document" />
+      <input><soap:body use="literal" /></input>
+      <output><soap:body use="literal" /></output>
+    </operation>
+  </binding>
+
+  <service name="echoService">
+    <port name="echoService" binding="tns:echoBinding">
+      <soap:address location='http://localhost:8080/' />
+    </port>
+  </service>
+</definitions>

data/sample/howto/documentliteral/servant.rb

@@ -0,0 +1,11 @@
+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,42 @@
+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,67 @@
+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