Release Notes - SOAP4R

Last modified: Sep 24, 2007
Created: July 17, 2000

0. In this document...

This is Release Notes of SOAP4R.

Target SOAP4R version: SOAP4R/1.5.8

  1. Changes
  2. Install
  3. Uninstall
  4. What is SOAP4R?
  5. Dependencies
  6. Samples
  7. Resources
  8. History
  9. Author
  10. Copyright

1. Changes

Version 1.5.8 has improved its XML Schema support, such as class generation of XML Schema anonymous complexType, full built-in datatypes support of XML Schema Datatypes, and more. Here are changes in 1.5.8 from 1.5.7.

Thanks to all of soap4r-ml members and soap4r users for their support. And special thanks to following contributors; 

'Aaron Pfeifer' for contributing a patch for safemethodname.
'Andi Wundsam' for contributing a patch for net/http + no_proxy.
'anonymous contributor from Wall St.' for contributing a MSSOAP + Excel sample.
'Emil Marceta' for contributing a patch for one-way service support and many test cases that points a bug of soap4r.
'Ernie' for contributing a helloworld WSDL sample and WSDL service feature of HTTPServer.
'Felipe Contreras' for contributing an union + memberType sample, patches for missing 'require', and a patch to allow to customize default ns definition of SOAP Envelope.
'Greg Lappen' for contributing an eBaySvc sample.
'Ger Apeldoorn' for contributing a sample of complex type + MIME attachment.
'Jamie Herre' for contributing a SwA implementation.
'John Anderson' for contributing a patch for handling gzipped HTTP content.
'Junichi Uekawa' for contributing a HTTP redirection patch for net/http.
'Kent Sibilev' for contributing a patch for correct extraattr handling of SOAPHeaderItem.
'KR, Vesa Varimo' for contributing a patch for correct handling of XML Schema's choice element.
'Leoš Bitto' for contributing a patch for XML pretty print.
'Michael Neumann' for contributing an original implementation of standaloneServer.
'Oliver M. Bolzer' for contributing a patch for net/http + SSL.
'Owen Fraser-Green' for contributing a patch for MIME CRLF handling.
'Patrick Chanezon' for contributing a patch for wsdl2ruby classdef name option.
'Peter Gardfjäll' for contributing a patch for wsdl:fault handling.
'Sandi Metz' for contributing a patch for SwA in document/literal service.
'SHINAGAWA, Norihide' for contributing a patch for emx platform.
'Tadayoshi Funaba' for contributing a patch for date/time XMLSchema datatypes.
'UENO Katsuhiro' for xmlscan implementation.
'Walter Korman' for contributing soap4r.gemspec and a workaround patch for gem's require problem.
'wrex' for contributing a patch for soap4r to work with SalesForce service.

2. Install

At first, see Dependencies section. You may need to install some extra packages. Next, get the archived file of SOAP4R and extract it, then simply try; 

$ ruby install.rb

Necessary files will be installed to suitable directory.

Files and directories in lib directory are SOAP4R library program itself.

lib/
Libraries.
sample/
SOAP4R samples. See Samples section.
test/
Tests. It also contains useful sample scripts for servers and clients.
test/interopR2/ directory includes Clients/Server for `SOAPBuilders Interoperability Lab.' Followings are advanced examples to use complex type transmit, sending base64 encoded string, multi-dimensional array, and so on.
  • test/interopR2/server.rb is a RPC Server side implementation.
  • test/interopR2/client.rb is a RPC Client side implementation.
  • test/interopR2/base.rb includes common definitions for client/server.

3. Uninstall

Simply delete installed files.

4. What is SOAP4R?

'SOAP4R' is an implementation of SOAP 1.1 (W3C Note).

Comments, information such as interoperability between SOAP4R and another implementation are welcomed. Feel free sending mail to nahi@ruby-lang.org.

5. Dependencies

SOAP4R is written in Ruby and aims to use with Ruby application. You have to install ruby itself. Tested against the following ruby versions.

SOAP4R depends on following Ruby modules in RAA. You also have to install these modules to use SOAP4R.

[RAA:httpclient] (2.1.0 or later) (required)
Yet another HTTP client implementation by NaHi. httpclient is formerly known as http-access2.
[RAA:uconv] (0.4.10) (not required but needed if your Ruby doesn't have iconv module and you need UTF-8 encoded Japanese chars)
by Yoshida Masato. It is requred when you want automatic CES conversion between SJIS <-> UTF8 and EUC <-> UTF8. Note: SJIS <-> EUC uses NKF module which is in standard distribution.

6. Samples

Samples are in sample/ directory of distribution. Some samples try to connect to public servers. Set environment variable HTTP_PROXY if you are in a firewall and you have http proxy to the internet like; 

$ export HTTP_PROXY=http://myproxyserver:8080
  or
$ setenv HTTP_PROXY http://myproxyserver:8080

basic/ ... basic samples

babelfish.rb
a SOAP client sample to connect to a babelfish server.
whois.rb
a SOAP client sample to connect to a whois server.
flickr.rb
a SOAP client sample to connect to the flickr SOAP server and extract data from XML response.
yahooNewsSearch.rb
a HTTP client sample to connect to the Yahoo news search REST service and extract data from XML response.
helloworld/
a SOAP server and client sample of 'Hello World'. To run the server; 
$ ./server.rb
And to connect to the server, run the client; 
$ ./client.rb
calc/
Calc service contains 2 servers and 2 clients. calc.rb is hosted by server.rb, calc2.rb is hosted by server2.rb. client.rb is for server.rb, client2.rb is for server2.rb.
calc.rb
Calc server definition using module and module methods. This module responds 'add', 'sub', 'multi' and 'div'.
server.rb
Standalone server. It requires calc.rb and serve module methods of this module. To run this server; 
$ ./server.rb
server.cgi
CGI version. To run this server, copy server.cgi and calc.rb to suitable directory of your WWW server.
client.rb
It connects to server.rb or server.cgi, and hit methods served by calc.rb. To run the client; 
$ ./client.rb
Is it stacked? Did you run the server.rb?
Turn logger and wireDumpDev in its source on to see logs and wire dumps of SOAP transport.
calc2.rb
Calc server definition using class and instance methods. An instance of this class holds its value. Methods 'set' and 'get' is to set/get the value. It also responds to '+', '-', '*', and '/'.
server2.rb
It requires calc2.rb and creates an instance of CalcService2 that responds all SOAP requests. Since '+', '-' and so on of calc2.rb are not valid name as an element in XML instance, this sample register the method '+' as 'add', '-' as 'sub', and so on.
server2.cgi
CGI version. To run this server, copy server2.cgi and calc2.rb to suitable directory of your WWW server.
client2.rb
It connects to server2.rb or server2.cgi. Set a value at first and call methods like 'puts objAtServer + 2'.
exchange/
A sample to retrieve the currency rate from public SOAP service.
iExchange.rb
It includes common definitions for client and server of Exchange service. Including only a definition of namespace URI of this service.
exchange.rb
Definition of servant class ExchangeService which returns the currency rate after connecting to another site by SOAP to get the real rate. So that this class is the SOAP server for local client and is also a SOAP client for public server. An instance of this class is hosted by server.rb. The instance responds to only 'getRate' which receives two country code such as 'USA' and 'Japan'.
server.rb
It requires exchange.rb and creates an instance of ExchangeService that responds all SOAP requests. To run this server; 
$ ./server.rb
server.cgi
CGI version. To run this server, copy server.cgi and exchange.rb to suitable directory of your WWW server.
client.rb
It connects to server.rb. Turn logger and wireDumpDev in its source on to see logs and wire dumps of SOAP transport. To run the client; 
$ ./client.rb
sampleStruct/
A sample to transmit complex structured object which has recursive object reference.
iSampleStruct.rb
It includes common definitions for client and server of SampleStruct service. Definition of SampleStruct class and namespace URI of this service.
sampleStruct.rb
Definition of servant class SampleStructService. An instance of this class is hosted by server.rb. The instance responds to only 'hi' which receives a SampleStruct and wraps it in the new instance of SampleStruct to return .
server.rb
It requires sampleStruct.rb and creates an instance of SampleStructService that responds all SOAP requests. To run this server; 
$ ./server.rb
server.cgi
CGI version. To run this server, copy server.cgi and sampleStruct.rb to suitable directory of your WWW server.
client.rb
It connects to server.rb. Turn logger and wireDumpDev in its source on to see logs and wire dumps of SOAP transport. To run the client; 
$ ./client.rb
wsdl_helloworld/
A sample 'Hello World' SOAP client and server which utilize WSDL. See wsdl_helloworld/README for more detail

payload/ ... various payload configuration

basicauth/
BasicAuth server and client sample.
cookies/
HTTP-Cookies server and client sample.
ssl/
SSL SOAP server and client samples.
sslserver.rb
SSL server sample which hosts "hello world" service. This server uses SSL server certificate in files/ directory (SSL client should check this certificate for SSL server authentication).
sslserver_noauth.rb
This server generates SSL server certificate at runtime. No security.
sslserver_require_clientauth.rb
This server users SSL server certificate in files/ directory and requires SSL client authentication (clients must have SSL client certificate and send it to the server).
sslclient.rb
SSL client sample which calls "hello world" service via HTTPS. This client checks SSL server certificate sent from SSL server.
sslclient_require_noserverauth.rb
This client does not check SSL server certificate. No security.
sslclient_with_clientauth.rb
This client sends SSL client certificate in files/ directory and checks SSL server certificate.
gzipped/
gzipped content negotiation server and client sample.

soapheader/ ... SOAPHeader configuration

authheader/
It contains a sample to utilize SOAP Header handler. Send userid/passwd and receive sessionid via SOAP Header
soapext_basicauth/
It contains a sample to do BasicAuth in SOAPHeader. (http://soap-authentication.org/basic/2001/10/)

attachment/ ... SOAP with Attachment (SwA)

swa/
SOAP server and client sample of SwA (SOAP with Attachments).
complexmime/
SOAP server and client sample of Complex Type + SwA

howto/ ... various other configuration

as_xml/
Sample client to send a request with XML, and receive a response as XML.
base64/
Sample client to send/receive base64 data.
documentliteral/
Sample client and server of document/literal service. See README.txt in this directory to run this sample.
filter/
Sample client and server of filtering request/response before sending/receiving.
scopesample/
SOAP server sample which shows a different behavior of SOAP server scope settings; Request scope vs Application scope. sample/soap/scopesample/servant.rb is a servant which holds push-ed object that can be pop-ed afterward. See sample/soap/scopesample/server.rb how to define a servant as a Request scope servant or an Application scope servant. Application scope servant works as we expected because the servant object is living from beginning to the time server terminated. In contrast, request scope servant(s) does not work because a servant object is created for each request.
styleuse/
Sample client and server of SOAP style and use combination, especially rpc/literal and document/encoded.
wsdl_fault/
Sample client and server of handling SOAP fault specified in a WSDL. See wsdl_fault/README.txt for more detail.
wsdl_hash/
Sample client and server of sending/receiving Hash struct defined in a WSDL.

marshal/ ... object <-> XML marshalling

digraph.rb
A sample of SOAP marshalling/unmarshalling. It creates a digraph that contains multi-ref-ed nodes at first and marshals this object to get serialized XML instance. Then reads and unmarshals this XML instance to recover a object which has the same links among nodes in the digraph.
customfactory.rb
Sample program for customizing mapping registry.
enum/
Sample program to demonstrate how xsd2ruby.rb works.

showcase/ ... showcase sample to demonstrate

raa2.4/
sample/soap/raa2.4/sample.rb is a sample client to retrieve project information on RAA. It uses raaDriver.rb which is generated by wsdl2ruby.rb from WSDL at http://www.ruby-lang.org/xmlns/soap/interface/RAA/0.0.4/. You'll find wsdlDriver.rb in sample/wsdl/raa2.4/wsdlDriver.rb which loads the WSDL at runtime to connect.
icd/
A client for Insider's Computer Dictionary Web Service. This service is implemented with ASP.NET so that it's also a sample of a client which connects to ASP.NET. CAUTION: this sample contains non-ascii chars in its source and dumped results.
IICD.rb
Class(type) definitions for this server.
icd.rb
Client implementation. To run the client; 
$ ./icd.rb
googleSearch/
Sample client to search with Google Web API using WSDL. You need to get a developer's key to use it. See wsdlDriver.rb.
amazon/
Sample client to connect with AmazonWebServices using WSDL. See wsdlDriver.rb.
noaa/
Sample client of National Weather Service digital weather forecast data service at http://weather.gov/
raa2.4/
sample/wsdl/raa2.4/wsdlDriver.rb is a sample client to retrieve project information on RAA. It loads WSDL file http://www.ruby-lang.org/xmlns/soap/interface/RAA/0.0.4/ at runtime. You'll find a sample client at sample/soap/raa2.4/sample.rb which connects RAA using pre-generated service definitions (not loads WSDL at runtime).
googleAdwords/
Sample client of Google AdWords service. CAUTION: I don't have an account of AdWords so the sample code is NOT tested. Please tell me (nahi@ruby-lang.org) if you will get good/bad result in communicating with AdWords Server.
amazonEC/
Sample client of AWSECommerce service. CAUTION: I don't have an account of AWSECommerce so the sample code is NOT tested. Please tell me (nahi@ruby-lang.org) if you will get good/bad result in communicating with AWSECommerce Server.

There are more samples in this directory.

7. Resources

soap4r project page
You can get the latest information and the latest development version of soap4r here.
[RAA:soap4r]
RAA meta information
soap4r-ml on Google Groups
Feel free to join the list to ask any question and comment about soap4r. You can browse messages archive. Bear in mind that Google Groups is still in [beta] stage.
Subversion repository
Soap4r's svn repository is here: http://dev.ctor.org/svn/soap4r/ . To checkout the latest soap4r module, try 
svn checkout http://dev.ctor.org/svn/soap4r/trunk soap4r
CVS repository of soap4r which was located at cvs.ruby-lang.org is pending since 2004-05-27.

8. History

1.5.7 - Jul 16, 2007
Version 1.5.7 mainly intends to fix regression problems introduced in 1.5.6. Here are changes in 1.5.7 from 1.5.6.
  • Environment
    • soap4r gem depends on httpclient >= 2.1.0. (#379)
    • let soap4r http clients (SOAP::RPC::Driver and WSDL/XSD importers) do not check soap_use_proxy environment variable and use only http_proxy/HTTP_PROXY and no_proxy/NO_PROXY envvars for proxy configuration. no need to set 'soap_use_proxy=on' envvar anymore. But to avoid proxy injection problem, when a library is used on CGI environment (with checking REQUEST_METHOD envvar existence), soap4r http clients use cgi_http_proxy/CGI_HTTP_PROXY envvar instead of http_proxy/HTTP_PROXY. (#378)
  • SOAP/Ruby mapping
    • try to call klass.soap_marshallable before mapping an XML element to the klass while unmarshalling. to avoid auto-mapping from element name, define klass.soap_marshallable method let it return false. (#223)
    • let xsd2ruby.rb generate a mapping registry and a mapper from XML Schema definition. the mapper has obj2xml and xml2obj which uses the generated mapping registry. you can use this instead of XSD::Mapping.obj2xml and XSD::Mapping.xml2obj which does not know anything about mapping. (#362, #363)
    • [BUG] Array or Struct was not properly marshalled when literal service + generated stub combination. (#360)
    • [BUG] derived class was marshalled without xsi:type for literal service. (#361)
    • [BUG] passing nil as a basetype through generated mapping registry was broken in 1.5.6. (#369)
    • [BUG] an rpc/encoded parameter could be wrongly typed when the parameter is typed as a derived type from a base type of XML Schema datatypes. (#371)
    • [BUG] under the earlier versions, we could use [] instead of CountryTargets[]. from 1.5.6-GA it doesn't work. let LiteralRegistry decide how the class should be mapped to according to the defined class in the parent complexType. (#373)
  • SOAP
    • allow xsi:nil="true" element as an RPC request though I don't think it's SOAP spec compliant. (#374)
    • allow to customize default ns definition of SOAP Envelope. SOAPGenerator.new gets option hash as 'opt' and treats opt[:default_ns] as a XSD::NS which stores default ns definition of SOAP Envelope. See how it works in test/soap/test_custom_ns.rb. (#380)
  • Payload
    • added an API for filtering streamhandler to capture/generate HTTP header. (#276)
    • added 'protocol.http.auth' option to set authentication information for both BasicAuth and DigestAuth. with the latest httpclient (formerly known as http-access2), now soap4r client can connect to DigestAuth server. (#345)
  • WSDL
    • importer should not import http://schemas.xmlsoap.org/soap/encoding/. (#366)
    • [BUG] error when simpleType element usage as "part" definition directly. (#367)
    • [BUG] wsdl2ruby.rb did not generate a classdef entry for empty element definition such as <element name="foo"/>. let wsdl2ruby.rb generate 'class Foo < String'. (#370)
1.5.6 - Jun 14, 2007
Here are changes in 1.5.6 from 1.5.5.
  • SOAP/Ruby mapping
    • specify sending XML document over SOAP by REXML::Element or to_xmlproc -able object. (#21)
    • encode or decode of single basetype parameter according to type definition in rpc/encoded service. (#14, #98)
    • determining rpc method paramaters and outputs at runtime with MethodDefCreator" rel="nofollow">MethodDefCreator#{collect_rpcparameter|collect_documentparameter} (#142)
    • support an array element name other than 'item' in document/literal service. (#150)
    • let document/literal service proxy generated by WSDLDriverFactory accept key-value pair array of array ([['k1', 'v1'], ...]) as same as a hash ({'k1' => 'v1', ...}). (#156)
    • allow an XSD::QName as a value of extraattr such as <elename xmlns:n1="urn:valuenamespace">n1:value</elename>. (#157)
    • SwA and doc/lit service. (#165)
    • allow to define an empty SOAP Body service. Thanks, emil. (#174)
    • method overloading support. allow to define methods which have same name and different signatures, and let Router invoke a method according to SOAPAction. you need to define methods with different SOAPAction. (#233)
    • let Driver#generate_explicit_type work for ltieral service, too. (#234)
    • get the raw XML from the response. you get a result as an XML string when you set Driver#return_response_as_xml = true. (#250)
    • do not validate CES of String by default to avoid consuming memory. let XML processor check it instead. (you can turn it on by XSD::XSDString.strict_ces_check = true) (#265)
    • allow SOAP::Mapping::Object to dump/load with marshal_dump/marshal_load. (#266)
    • handle CDATA correctly with xmlscan and rexml (only xmlparser worked). (#332)
    • defined omit element / xsi:nil="true" elemet control. nil means xsi:nil="true" for encoded service and nil means element omission for literal service. pass SOAPNil.new to pass xsi:nil="true" for literal service. (#343)
    • one-way service support. (#200, #346, #347)
    • offer clearly defined message interceptor API. see test/soap/filter for more detail. (#350)
    • SOAPElement.from_obj(obj): allow to set XML attribute. this method is called when you pass a Hash or [['key1', 'value1'], ...] to literal service so you can easily add XML attribute to a request. see #331 for more detail. (#331)
  • Payload
    • merged a patch from Ernie that enables httpserver to serve WSDL. (#161)
    • allow user to set own streamhandler of a SOAP::RPC::Driver. (#180)
    • let Driver#test_loopback_response work under soap4r + net/http. (#181)
    • allow to define basic_auth parameters with property file. (#198)
    • follow HTTP redirection even with net/http. (#280)
    • [ruby-Bugs-7532] make SOAP::HTTPStreamHandler handle gzipped content. Thanks, John Anderson. (#310)
  • SOAP format
    • SOAP actor name can be set through HeaderHandler. (#19)
    • support xsd:token and xsd:language. Thanks, Jirka Pech. (#252)
    • let XSD::QName immutable. (#274)
    • allow Header::Handler to access SOAPHeader from inside of on_outbound. (#354)
  • WSDL
    • support <xsd:list> of <xsd:simpleType>. (#3, #248)
    • support <xsd:union> of memberTypes. (#6)
    • support <xsd:extension> for <xsd:complexContent>. (#72)
    • support <any>. (#148, #155)
    • support <xsd:restriction> for <xsd:complexContent>. (#167)
    • support <choice>. (#168, #205)
    • support simpleContent + attribute extension. (#176)
    • generate Array classdef for maxOccurs="unbounded" element. (#182)
    • support minLength and maxLength attributes. (#185)
    • support abstract attribute of complexTypes. (#195)
    • moved @@schema_* things in classdef definition generated by wsdl2ruby.rb to mapping registry. Mapping registries for each classdef are defined in independent file and required from driver and server. NOTE: old classdef files should still work but it should be re-generated by new wsdl2ruby.rb. (#175, #267, #270)
    • support wsdl:fault definitions. Thanks, Peter Gardfjall. (#319)
  • Samples
    • add a demo how to call from Excel a simple soap service running in apache (sample/soap/mssoap/) Thanks, an 'anonymous contributor from Wall St.' (#143, #154)
    • a sample to send an integer as Long type. (#160)
    • an eBaySvc sample by Greg. Thanks! (#183)
    • basicauth client + server sample. (#249)
    • cookie client + server sample. (#321)
  • misc
    • add a --prefix option in install.rb. (#255)
    • warn misusage of lib/wsdl/soap/wsdl2ruby.rb. (#339)
    • wsdl2ruby --classdef could have an optional classname argument. Thanks, P@. (#173)
    • putting the classes that support a web service into a service-specific module. check --module_path (#279)
1.5.5 - Sep 15, 2005
Here are changes in 1.5.5 from 1.5.4.
  • SOAP
    • allow to configure an envelope namespace of SOAP request. (#124) 
      TemporaryNamespace = 'http://www.w3.org/2003/05/soap-envelope'
@client.options["soap.envelope.requestnamespace"] = TemporaryNamespace
@client.options["soap.envelope.responsenamespace"] = TemporaryNamespace
@client.do_proc(...)
    • let SOAP request XML indent space configuable. see "soap.envelope.no_indent" option. (#130)
    • let external CES configuable. ex. client["soap.mapping.external_ces"] = 'SJIS'. $KCODE is used by default. (#133) 
      external CES ::= CES used in Ruby object of client and server
internal CES ::= CES used in SOAP/OM
    • add iso-8859-1 external CES support. (#106)
    • fixed illegal 'qualified' handling of elements. it caused ASP.NET inteoperability problem. (#144)
    • added 'soap.envelope.use_numeric_character_reference' (boolean) option to let query XML use numeric character reference in XML, not plain UTF-8 character. GoogleSearch server seems to not allow plain UTF-8 character since 2005-08-15 update. (#147)
    • SOAP::Header::SimpleHeader (de)serialization throws an exception on SimpleHeader.on_(in|out)bound when header is a String. so we could not use a simple single element headerItem. fixed. thanks to emil. (#129)
    • out parameter of rpc operation did not work. (#132)
    • follow HTTP redirect only if using http-access2. (#125) (#145)
    • add a workaround for importing an WSDL whose path begins with drive letter. (#115)
  • WSDL
    • SOAP Data which is defined as a simpletype was not mapped correctly to Ruby obj when using wsdl2ruby.rb generated classdef file. (#123)
    • rpc/literal support. (#118)
    • re-implemented local element qualify/unqualify control. handles elementFormDefault and form in WSDL. (#119)
    • Array of an element which has simpleType causes a crash. (#128)
    • prarmeterOrder may not contain return part so it can be shorter than parts size. Thanks to Hugh. (#139)
  • Samples
    • added BasicAuth client sample. (#117)
    • added Base64 client/server sample.
    • added Flickr SOAP interface client sample. (#122)
    • added SalesForce client sample. (#135)
    • updated Thawte CA certificate for GoogleAdWords sample.
    • updated a client script with the newer version made by Johan. thanks!
    • shortened long file names. (#120)
    • fixed typo in authheader sample. (#129)
    • updated deprecated method usage. (#138)
1.5.4 - May 13, 2005
This is version 1.5.4. Version 1.5.3 is the module which is included in ruby-1.8.2, and not released independently. Following changes consist from 2 parts; Changes from 1.5.3 to 1.5.4, and from 1.5.2 to 1.5.3.

Changes in 1.5.4 from 1.5.3

  • SOAP client and server
    • for both client side and server side
      • improved document/literal service support. style(rpc, document)/use(encoding, literal) combination are all supported. for the detail about combination, see test/soap/test_style.rb.
      • let WSDLEncodedRegistry#soap2obj map SOAP/OM to Ruby according to WSDL as well as obj2soap.
      • let SOAP::Mapping::Object handle XML attribute for doc/lit service. you can set/get XML attribute via accessor methods which as a name 'xmlattr_' prefixed (<foo name="bar"/> -> Foo#xmlattr_name).
    • client side
      • WSDLDriver capitalized name operation bug fixed. from 1.5.3-ruby1.8.2, operation which has capitalized name (such as KeywordSearchRequest in AWS) is defined as a method having uncapitalized name. (converted with GenSupport.safemethodname to handle operation name 'foo-bar'). it introduced serious incompatibility; in the past, it was defined as a capitalized. define capitalized method as well under that circumstance.
      • added new factory interface 'WSDLDriverFactory#create_rpc_driver' to create RPC::Driver, not WSDLDriver (RPC::Driver and WSDLDriver are merged). 'WSDLDriverFactory#create_driver' still creates WSDLDriver for compatibility but it warns that the method is deprecated. please use create_rpc_driver instead of create_driver.
      • allow to use an URI object as an endpoint_url even with net/http, not http-access2.
    • server side
      • added mod_ruby support to SOAP::CGIStub. rename a CGI script server.cgi to server.rb and let mod_ruby's RubyHandler handles the script. CGIStub detects if it's running under mod_ruby environment or not.
      • added fcgi support to SOAP::CGIStub. see the sample at sample/soap/calc/server.fcgi. (almost same as server.cgi but has fcgi handler at the bottom.)
      • allow to return a SOAPFault object to respond customized SOAP fault.
      • added the interface 'generate_explicit_type' for server side (CGIStub, HTTPServer). call 'self.generate_explicit_type = true' if you want to return simplified XML even if it's rpc/encoded service.
  • WSDL
    • WSDL definition
      • improved XML Schema support such as extension, restriction, simpleType, complexType + simpleContent, ref, length, import, include.
      • reduced "unknown element/attribute" warnings (warn only 1 time for each QName).
      • importing XSD file at schemaLocation with xsd:import.
    • code generation from WSDL
      • generator crashed when there's '-' in defined element/attribute name.
      • added ApacheMap WSDL definition.
  • Samples
    • added XML <-> Ruby mapping utility. XSD::Mapping#xml2obj maps an XML to a tree of SOAP::Mapping::Object. XSD::Mapping#obj2xml is for reverse direction conversion. see a sample in sample/wsdl/noaa/client.rb
    • added a sample for weather.gov's NDFD services.
    • add a sample of googleAdWords. CAUTION: I don't have an account of AdWords so the sample code is NOT tested. Please tell me (nahi@ruby-lang.org) if you will get good/bad result in communicating with AdWords Server.
    • add a sample of AWSECommerce. CAUTION: I don't have an account of AWSECommerce so the sample code is NOT tested. Please tell me (nahi@ruby-lang.org) if you will get good/bad result in communicating with AWSECommerce Server.
  • Redists
    • include xmlscan as a redistributed module. xmlscan now is a first class XML processor. still soap4r should run with REXML and XMLParser.

Changes in 1.5.3 from 1.5.2

  • SOAP client and server
    • for both client side and server side
      • added a header handler class for simple SOAPHeader handling. see samples in sample/soap/authheader/*.
      • SSL support (both client side and server side). check sample/soap/ssl/*
      • gzipped content encoding support. see sample/soap/helloworld/hw_{c,s}_gzip.rb.
    • client side
      • HTTP-Cookies support under soap4r + http-access2. not supported under soap4r + net/http.
      • added a method (SOAP::RPC::Driver#test_loopback_response) for loopback test with the specified response.
      • added SOAP::RPC::Driver#loadproperty interface to load property file.
      • let SOAP::RPC::Driver#add_method returns Method object. you can invoke a service like; drv.add_method("hello").call("world")
      • added http options to get/set timeout seconds.
        • for http-access2:
          • driver.options["protocol.http.connect_timeout"]
          • driver.options["protocol.http.send_timeout"]
          • driver.options["protocol.http.receive_timeout"]
        • for net/http:
          • driver.options["protocol.http.connect_timeout"]
          • driver.options["protocol.http.receive_timeout"]
      • raise NotImplementedError when net/http + basic_auth.
    • server side
      • introduced the new server class SOAP::RPC::HTTPServer which takes WEBrick's HTTPServer compatible config parameter.
      • added a debug log of SOAP request/response.
  • SOAP core part
    • added XMLSchema derived type support; byte, nonPositiveInteger, negativeInteger, nonNegativeInteger, positiveInteger, unsignedLong, unsignedInt, unsignedShort, unsignedByte.
    • 'eval' cleanup. I hope it allows soap4r to work under mod_ruby environment.
    • SOAPProperty raise RuntimeError under ruby-1.9 when accessing locked property. still raises TypeError under ruby-1.8 or earlier. the change is from ruby's behaviour change about an exception when accessing a frozen object.
    • make SOAPHeader a child of SOAPStruct, not SOAPArray.
    • SOAPProperty does not eval whole string. \\, \t, \r, \n, \f escaping chars are supported like Java's Properties.
    • URI object was not mapped correctly so that URI object was not interoperable under some situation. fixed.
    • SOAP::Mapping::Object: handle multiple value as an array. 
      <foo>
  <bar>1</bar>
  <bar>2</bar>
  <bar>3</bar>
  <baz>4</baz>
</foo>
  ->
foo.bar => [1, 2, 3]
foo.baz => 4
    • raise an exception while dumping singleton class. [ruby-dev:22588] 
      e.g. c = class << Object.new
       class C; self; end
     end
     SOAPMarshal.dump(c)
  • WSDL
    • WSDL definition
      • added <xsd:simpleContent> support.
      • initial (means "far from complete") simpleType support.
      • support parts attribute of soap:body element.
      • xmlSchema's 'any' element support; for parsing, just treat the element as an element which has a name 'any'.
      • add mustUnderstand attribute support.
      • a special well-known type: ApacheMap support.
    • code generation from WSDL
      • added simple code generation utils (lib/xsd/codegen)
      • dump attribute definition in XMLSchema as 'attr_*' attribute. [experimental]
      • wsdl2ruby.rb: add document/literal service support. see sample/wsdl/documentliteral/*
      • untyped element should be treated as xsd:anyType.
      • added a tool xsd2ruby.rb for generating classdef from xsd file.
  • Samples
    • added RAA/2.4 sample client
    • added sample for Application/Request scope use. Session scope (with Cookies) feature is not yet exists.
1.5.2 - December 25, 2003
  • License;
    • Changed license from GPL2 to Ruby's.
  • Features;
    • Add SOAP Messages with Attachments (SwA) support. Patched by Jamie Herre. "SOAP Messages with Attachments" is the W3C Note which defines a binding for a SOAP 1.1 message to be carried within a MIME multipart/related message. http://www.w3.org/TR/SOAP-attachments This feature is still experimental. Interop testing is going on.
    • HTTPS support even when you use net/http (not http-access2). Patched by Oliver M. Bolzer.
    • Property file support. SOAP and WSDL client reads "soap/property" file located at somewhere in $: (ruby libray locations). For example, save these lines to "$rubylibdir/site_ruby/1.8/soap/property". 
      client.protocol.http.proxy = http://myproxy:8080
client.protocol.http.no_proxy = 192.168.71.71,192.168.71.72
      Then all HTTP connections should use these proxy and no_proxy definition.
    • Do not trust "HTTP_PROXY" environment variable by default to avoid security problem. cf. To use HTTP_PROXY and NO_PROXY environment variable, you must set SOAP_USE_PROXY environment variable 'on', too. 
      bash$ soap_use_proxy=on http_proxy=http://myproxy:8080 ruby ...
csh$  env soap_use_proxy=on http_proxy=http://myproxy:8080 ruby ...
    • Add SOAP::RPC::Driver#mandatorycharset= and SOAP::WSDLDriver#mandatorycharset= interface to force using charset when parsing response from buggy server such as AWS.
    • Support a halfway-typed multi-ref array that Axis dumps.
    • Added a interface XSD::Charset.encoding= to control internal encoding scheme. Internal encoding scheme was fixed to 'utf-8' when iconv or uconv was installed. You can set 'euc-jp', etc. to avoid encoding scheme conversion if you know what encoding scheme the server uses.
  • Bug fixes;
    • SOAP::Marshal.unmarshal: raise an exception if parse fails. (returned nil)
    • SOAP::WSDLDriver: decode unknown element according to self-defined type even if WSDL was given.
    • SOAP::Mapping::Factory#create_empty_object: fix Class#allocate emulation code for ruby/1.6. no effective change under ruby/1.8.
    • SOAP::RPC::SOAPMethodResponse: element name of response message could have the name other than 'return'.
    • SOAP::RPC::StandaloneServer: add methods 'shutdown' and 'status' as delegates to WEBrick.
    • WSDL::SOAP::ClassDefCreator: WSDL/1.1 allows plural fault definition in a operation.
    • XSD::Charset.init: use cp932 under emx. Patched by Siena. / SHINAGAWA, Norihide.
1.5.1 - November 2, 2003
  • Features;
    • Sample updates; Update Amazon Web Service WSDL (v2 -> v3), and update RAA WSDL(0.0.1 -> 0.0.2).
    • Supports ivars of basetype and extending modules marshalling with XML attribute. Using XML attribute to support ruby object dependent information, marshalled object keeps compatibility with SOAP spec. It shows the power of XML, extensibility.
      Now I think SOAP marshaller supports all kind of object graph which is supported by Ruby's original marshaller.
    • Better XML pretty printing. 
      puts SOAPMarshal.dump(Person.new("NaHi", 33))

=>

<?xml version="1.0" encoding="utf-8" ?>
<env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <env:Body>
    <Person xmlns:n1="http://www.ruby-lang.org/xmlns/ruby/type/custom"
        xsi:type="n1:Person"
        env:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <age xsi:type="xsd:int">33</age>
      <name xsi:type="xsd:string">NaHi</name>
    </Person>
  </env:Body>
</env:Envelope>
  • Installation;
    • The previous version soap4r/1.5.0 required http-access2 to be installed to build CGI server, but no longer needed fot this purpose now. You can use almost all features of soap4r without http-access2, but for actual usage, consider installing http-access2 for speed and thread-safe SOAP client.
    • Under ruby/1.8, installer installs lib files to rubylibdir(e.g. /usr/local/lib/ruby/1.8) instead of sitelibdir(e.g. /usr/local/lib/ruby/site_ruby/1.8)
  • Bug fixes;
    • Do not introduce XSD constants to toplevel.
    • 'NO_PROXY'/'no_proxy' env var was not supported under net/http. Fixed.
    • Remove some ruby/1.8 dependent codes. Should work fine under 1.6, too.
    • XSD::XSDString did not check its value space under $KCODE = 'NONE' env for example where iconv module is not installed.
    • XSD::XSDFloat, XSD::XSDDouble: add +/- sign explicitly when stringified and embedded into XML instance. Ruby's sprintf may format -0.0 as "0.0" (no minus sign) depending on underlying C sprintf implementation.
1.5.0 - September 13, 2003
Thousands of lines are changed in this release (*.rb in current SOAP4R distribution has 30kloc or over). But the biggest change is coding convention, camelCase to non_camel_case. Though I tried to keep compatibility between 1.5.0 and 1.4.8, but there's no way to keep it at a few point. If you'll find your code which was developed for 1.4.8 does not run under 1.5.0, feel free to ask me to solve the problem.
  • Dependency libraries;
    • Add net/http support. Users can try sample SOAP clients without installing http-access2. For actual usage, consider installing http-access2 for speed and thread-safe SOAP client. CAUTION: Building SOAP CGI server needs http-access2 to be installed.
    • Soap4r standalone server requires webrick module to be installed instead of GServer.rb and httpserver.rb.
    • Supports iconv. To use utf-8, you need to install iconv(included in ruby/1.8) or uconv.
    • Suspend NQXML XML parser support.
    • Remove REXML processor version check. No longer needed.
    • Rewrite tests with test/unit.
  • Features;
    • Efforts to support messaging with document/literal and ASP.NET interoperability.
    • Add document/literal messaging interface to wsdlDriver.rb. See a very brief example in sample/soapbox/wsdlDriver.rb though I still didn't try to login to Jabber server.. Jabber folks?
    • XML pretty printing.
    • Better Ruby object mapping. Rewrote RubytypeFactory to support more Ruby objects. Tests in AMarshal(http://cvs.m17n.org/~akr/amarshal/) much helped it. Thanks very much to Tanaka Akira-san.
    • SOAPMarshal accepts IO as an output device like Marshal#dump.
    • SOAPElement: constructor signature change. Added extraattrs attribute.
    • XSDDateTimeImpl: to_time did not set usec.
    • StreamHandler: add reset method to shutdown a connection to a site.
  • Others;
    • Simplify installer and remove uninstaller. Saving inventory file in src dir could be the problem.
    • Class/Module architecture relocation.
    • Changing coding convention to fit with Ruby's. Added lib/soap/compat.rb which defines compatibility definitions for 1.4.8. lib/soap/compat.rb warns when the library is loaded.
    • Many warnings raised under 1.8, caused by illegal references like XSD::XSDInt in typeMap.rb. Soap4r defined toplevel::XSDInt. Define XSD* classes in XSD module and introduce it to toplevel.
1.4.8 - January 17, 2003
This version has these enhancements and bug fixes;
  • Avoid warnings;
    • Use Object#class instead of Object#type.
    • Avoid implicit use a String as a regexp source.
  • Add wsdlDriver which reads WSDL file and allow client to call procedures. Here is an example to search Google. 
        require 'soap/wsdlDriver'
    searchWord = ARGV.shift
    # You must get key from http://www.google.com/apis/ to use Google Web APIs.
    key = File.open(File.expand_path("~/.google_key")).read.chomp
    GOOGLE_WSDL = 'http://api.google.com/GoogleSearch.wsdl'
    # Load WSDL and create driver.
    google = SOAP::WSDLDriverFactory.new(GOOGLE_WSDL).createDriver
    # Just invoke!
    result = google.doGoogleSearch(key, searchWord, 0, 10, false, "", false, "", 'utf-8', 'utf-8')
    result.resultElements.each do |ele|
      puts "== #{ele.title}: #{ele.URL}"
      puts ele.snippet
      puts
    end
  • WSDLDriver client examples of AmazonWebServices, RAA and RNN (Japanese Ruby blog site) are also included in sample/ dir.
  • Support xmlscan XML processor.
  • Changed XML processor detection scheme. Search xmlscan, REXML, XMLParser and NQXML in this order.
  • Rewrite charset handling of XML processor.
    • If you only use us-ascii and utf-8, all XML processors should work without uconv module.
    • With xmlscan/0.2 or later, you can handle euc-jp or shift_jis encoded XML instance WITHOUT uconv module.
    • With other XML processors includes xmlscan/0.1, you need to install uconv module to handle euc-jp or shift_jis encoded XML instance.
  • cgistub.rb: Overridable response mediatype. There exists a http client which does not accept the mediatype text/xml which is specified in SOAP spec. For example, an i-Mode (smart phone) client does not accept it... You can set response mediatype to 'text/plain' for such client though it violates SOAP spec...
  • wsdl2ruby: Add --force option to override existing file.
  • Fixed many bugs.
1.4.7 - September 20, 2002
This version has these enhancements and bug fixes;
  • Includes WSDL4R initial release.
    • Bear in mind this is an alpha level code. I wrote it halfway at half and a year ago, and wrote the rest part in half and a day. No comprehensive test, no strict syntax check, unfriendly error message, etc. Try it if you want, and find bugs in it.
    • WSDL4R can run under XMLParser for now. You might be able to let it run under NQXML/REXML if you know SAX programming well. How XML processor is used under WSDL4R is as same as under SOAP4R.
  • Added xsd:short support.
  • ::Float(double precision float in Ruby) is mapped to xsd:double now. It was mapped to xsd:float.
  • Fixed a bug of year < 0 handling. B.C. 1 => -0001 in XMLSchema.
  • Fixed a bug of exception serialization. Custam mappingRegistry was not used.
  • Fixed a bug of regex for MediaType parsing.
1.4.5 - May 25, 2002
This version has these enhancements;
  • Supports all primitive datatypes of XML Schema Part2 Datatypes except NOTATION. Added types are Duration, gYearMonth, anyURI, QName and so on.
  • Runs much faster than earlier versions. Some performance check and tuning has been done.
  • Supports all Ruby objects marshalling/unmarshalling except some special objects. See below for more detail.
CAUTION: This version requires [RAA:date2] version 3.2 or later and [RAA:http-access2] version F. Please make sure the versions you use.

Here is detail of change.
Datatypes (XMLSchemaDatatypes.rb and baseData.rb)
  • Added duration, gYearMonth, gYear, gMonthDay, gDay, gMonth, anyURI and QName datetypes. All primitive datatypes in XML Schema Part 2 section 3.2 except NOTAION are supported now.
  • Modified XSDDataTime, XSDDate and XSDTime implementation. These use a DataTime as a data holder.
  • Follow date/3.2: date2.rb -> date.rb.
  • Changed to_s representations of single float and double float. Thanks to gotoken.
  • XSDFloat: Add '0' if given str ends with 'E'. Float( "-1.4E" ) might fail on some system.
  • Added SOAPRawString class. Given string is embedded into XML instance directly. You can use this class to embed (numeric) character references manually.
  • Fixed UTF8 regexp bug. XSDString uses this regexp to check a given string.
  • Added UT for XMLSchemaDatatypes.rb. See test/xsd_ut.rb and test/baseData_ut.rb.
SOAP <-> Ruby object mapping (mappingRegistry.rb and rpcUtils.rb)
  • Exception raised from server side could not be mapped to specific exception. Fixed.
  • Refactoring to avoid *_eval. Reduced warnings.
  • Added Range marshalling support.
  • Regexp#options support under ruby/1.6.
  • Supports cyclic Range such as; 
      class Foo
    attr_accessor :foo
    def succ; end
    def <=>( rhs ); end
  end

  o1 = Foo.new
  o2 = Foo.new
  r = o1..o2
  o1.foo = r

  p SOAPMarshal.load( SOAPMarshal.dump( r ))
  • Supports some instance variable of ruby standard class. But instance variable of Array, Hash, String, Float and Bignum are not supported because of restriction of SOAP encoding format...
  • Alias ::SOAPMarshal to ::SOAP::Marshal.
  • Added Marshal.load and Marshal.dump as aliases to Marshal.unmarshal and Marshal.unmarshal.
misc
  • Dumps what parser is used when $DEBUG. Try 'ruby -d -rsoap/processor -e 0'
  • Added CGI samples in sample/.
  • Some performance check and tuning has been done on both client and server side. One bottle neck is Kernel.methods which SOAP4R use(d) while mapping SOAP Data Model <-> Ruby object. I replaced it with Object.respond_to? . Another bottle neck of client side is delegate.rb which is used by http-access2. Get [RAA:http-access2] version F.
1.4.4 - May 6, 2002
This is a bug fix release. Following users should update.
  • Users who use DateTime datatype.
  • Developers of SOAP client/server which works under multi-thread condition.
  • REXML users.
Fixed bugs.
  • XSDDataTime: Changed variable name usec to sec_frac. It's not a micro sec so name usec is misleading.
  • XSDTime: Fixed bugs in usec part.
  • date.rb in standard library and date2 version 3 conflicts because date2.rb is a successor of date.rb and not designed for dual use. (ex. using a module which requires date.rb like DBI and another module which requires date2.rb). Added a workaround for this.
  • SOAP::Processor was not MT-safe. Fixed. Projected feature regards to MT are follows. At least I hope so. Tell me if you find these wrong.
    • Driver: safe
    • Proxy: safe
    • Server: safe
    • CGIStub: safe
    • StandaloneServer: safe
    • RPCRouter: safe
    • StreamHandler: safe
    • Processor: safe
    • SOAPParser: unsafe
    • SOAPGenerator: unsafe
    • EncodingStyleHandler: unsafe
  • SOAP4R/1.4.3 supports REXML/2.1.3 but it did not detect REXML processor automatically.
1.4.3 - April 11, 2002
Attention to 1.4.2 or earlier users;
  • Stopped redistributing packages in RAA from this release. Please get required packages from RAA and install it.
  • It still does NOT support WSDL!
New features
  • Added REXML parser support.
  • Added uninstaller.
  • Re: samples
    • Added 3 new samples, Calc, Exchange, and SampleStruct.
    • Use environment variable HTTP_PROXY or http_proxy for http proxy.
    • Removed unreachable services.
    • RAA: Separate iRAA.rb into RAA.rb and iRAA.rb.
    • Added description about samples to RELEASE_en.html.
  • Changed String encoding handling among Ruby object <-> SOAP Data Model <-> XML instance.
    • Ruby object: $KCODE.
    • SOAP Data Model: utf-8 if uconv module is installed, $KCODE if not.
    • XML instance: Client side use utf-8 if uconv module is installed, $KCODE if not. Server side try to adjust the request encoding.
    • Use regexp instead of NKF.guess to check if the given String is EUC/SJIS or not.
  • Added 'addServant' interface to server side. See sample/Calc/server.rb.
  • Added 'addMethodAs' interface to both server side and client side. See sample/Calc/server2.rb.
Changes
  • Removed Japanese document. I was tired of maintaining 2 separated documents. Though my English is poor as you see, numbers of readers of my English document should be more than one of my Japanese document. Would you please tell me bug of my English composition and of course in the code?
  • Use [RAA:devel-logger] instead of [RAA:application].
  • Avoided using exception in soap2obj and reduced warnings in runtime.
  • XSDDateTime: Use date2 version 3 instead of date3.rb. Date2 version 3 will be included in standard distribution of Ruby/1.8.
  • XSDDateTime: Added XSDDateTimeToTime module to extract a Time object from XSDDateTime, XSDDate and XSDTime.
Bug fixes
  • Set 'charset=' to content-type when sending back a SOAPFault. It was not set.
  • XSDDateTime: Parsedate was not used. Removed.
  • Added constant Log as a canonical name of Devel::Logger for backward compatibility of devel-logger.
  • Foo = Struct.new(:foo) and Foo = Struct.new("Foo", :foo) could not be unmarshalled collectly. All members were unmarshalled as nil. Fixed.
  • Rescue ArgumentError(Unrecognized signal) in standaloneServer.rb for mswin32 ruby.
1.4.2 - December 28, 2001
Many changes around Ruby language mapping for SOAP. I replaced DRb's marshalling format with SOAP marshalling and it passed about all unit test packed in DRb package. Only test failed was regards to packet size. You might be able to use SOAP::Marshal.(un|)marshal for serializing objects instead of Marshal.(load|dump).
  • Illegal decoding of a position-less element after position-ed element. Fixed.
  • Add Rubytype encoding/decoding support: Regexp, Class, Module and Symbol.
  • Added an option of MappingRegistry to raise an exception when unknown Struct. The option is set 'false' by default so that same behaviour as before.
1.4.1 - December 7, 2001
SOAP4R/1.4 contained many bugs (as usual...) 1.4.1 is a maintenance release. Some bugs are fixed. Thanks to Michael Neumann.
  • instance_eval in SOAPStruct#add for adding accessor illegaly overrode important methods for SOAP4R such as name, name= and so on. Removed this instance_eval and rewrote other codes which did depend the code. Thanks to MNeumann for reporting it and giving a suggestion to fix it.
  • Fixed charset handling. Illegal charset was set when automatic XML processor detecting.
  • Removed unused code(self.decode) in element.rb.
  • Illegal constant access when SOAP format error. Fixed.
  • LiteralEncodingNamespace moved to SOAP module.
1.4 - December 5, 2001
  • Datatypes:
    • XSDFloat: Bug in rounding double float to single float. Fixed.
    • SOAPElement: Added for literal encoding.
    • Removed SOAP encoding functions from baseData. EncondingStyleHandler should decide how to encode SOAP data model. (ie. ASP.NET seems to have its own encoding style.)
    • SOAPHeaderItem: Changed interface for easy use.
  • SOAP Encoding:
    • Encoding by itself, not using NQXML's tree object model.
    • At last, supported multi-ref encoding!
    • marshal.rb: Marshalling with Envelope and Body. To marshal multi-ref'd object, Body is needed. CAUTION: Not compatible between former implementation.
    • Add EncodingStyleHandlerLiteral and set it to default.
    • Renamed encoding.rb to encodingStyleHandler.rb.
    • Added ASP.NET encoding handler. ASP.NET seems to use literal encoding (by default) but it is easier with this encodingStyleHandler to access the service which is built with ASP.NET.
    • Changed element name escape.
      • :: <=> \.\.
      • [^a-zA-Z0-9_-] <=> \.[0-F][0-F]
      Limitation: Using SOAP4R's RPC function, you cannot use the name which contains '.' for method name, class/struct name, and accessor name. In Ruby world, it should not be a problem I believe.
  • RPC related functions:
    • Driver: Added 'invoke' method for messaging.
    • Driver: Content of SOAPFault detail element is set in the exception which is thrown from SOAP Node to client application.
    • Processor: Changed Processor.(un|)marshal interface. An instance of NS for parsing/generating XML instance is prepared in parser/generator.
    • mappingRegistry.rb is devided from rpcUtils.rb.
1.3.8 - October 4, 2001
Feedback from SOAPBuilders Interoperability Lab "Round 2" and Michael Neumann. Thanks!
  • Datatypes:
    • XSDFloat: Creating float data from junk string such as "123.0junk" was converted to 0.0. It should be avoided. Fixed.
    • XSDFloat: Fixed double -> single rounding code.
  • RPC related functions:
    • Changed typename <=> NCName strategy. '::' <=> '.'
    • Added mappingRegistry argument to interfaces for SOAP object creation.
  • Others:
    • Set faultstring '(No faultstring)' to SOAP Fault when empty faultstring element.
    • server.rb: Added mappingRegistry interface.
    • marshal.rb: Create NCName from typename.
1.3.7 - August 24, 2001
Feedback from SOAPBuilders Interoperability Lab "Round 2" and Michael Neumann. Thanks!
  • Datatypes:
    • All datatypes try to keep nil correctly.
    • XSDInt/Integer/Long: to_i -> Integer() to detect format error.
    • XSDDateTime, XSDDate, XSDTime: Add trailing 'Z' to indicate UTC.
    • SOAPStruct: Accept untyped struct.
    • Map(Hash): Let <item> untyped.
    • Apache allows only 'item' in Map type.
  • Stream handler:
    • Removed MPOST support.
    • ECONNRESET was not caught. Fixed.
    • Added timeout support.
  • Others:
    • Changed using URI library: URb -> URI; following its name change.
    • Added NQXML/1.1.0 support. A XMLDecl now recognized as a XMLDecl, not a PI.
1.3.6 - July 27, 2001
Many feedbacks from Michael Neumann. Thanks!
  • hexBinary type: Added.
  • nil type: Should not be xsd:nil but xsi:nil.
  • Added StandaloneServer implementation. Thanks to Michael Neumann!
  • Illegal parsing of XMLDecl. Fixed.
  • RPC's 'inout' param was not supported. Fixed. Thanks to Michael Neumann!
  • URb::Generic#path returns '' when abs_path is empty (such as http://foo). Added checking code.
  • Use http-access2 instead of original HTTP implementation. http-access2 supports HTTP/1.1's persistent connection.
1.3.5 - July 14, 2001
Many feedbacks from Michael Neumann. I much appreciate valuable comments to him. Thanks!
  • Changed using URI library: uri -> URb.
  • Types changed:
    • All: Triming data except XSDString before parsing it.
    • String: Regexp for XML Char check did not work under $KCODE = 'UTF8' condition. Fixed.
    • Nil: 2001xsd:nil must not accept a value '1'. 1999xsd:null must not accept a value 'true' because these are not a boolean but only a flag for nil. Fixed.
  • Supported XML parser:
    • Added automatic CES conversion support for NQXMLParser. (Depends on uconv module). Set $KCODE for regexps used in NQXML parser.
    • Moved SOAPNQXML*Parser to nqxmlparser.rb.
  • RPC related functions changed:
    • Added marshalling/unmarshalling Ruby's object using SOAP Encoding.
    • Parallelize of signatures of 'addMethod': proxy.rb <-> rpcRouter.rb, driver.rb <-> cgistub.rb.
    • Void return if 'retval' is not defined.
    • Added SOAP's Long type to default mapping table.
1.3.4.2 - July 11, 2001
SOAP4R/1.3.4 was once packed in July 10, 2001. But, thanks to MNeumann and knu, I found I had forgotten to pack 'redist' directory with it. I added some fix from developing version and repack it as 1.3.4.2. Sorry for frequently release...

Feedback from `SOAPBuilders Interoperability Lab.' and Michael Neumann. Thanks!
  • Added in 1.3.4.2:
    • Type Decimal: Silly bug fixed. 0.0001 was converted to 0.1
    • CGIStub returns HTTP status 500 when returning SOAP Fault. Returned 200 because I don't like this spec., but SOAP/1.2 W3C WD 9 July 2001 have adopted it. Hmm...
    • RPC client(driver.rb): Exception#set_backtrace was omitted when transmitting exception by SOAP Fault.
  • Types changed:
    • Array: Incomplete sparse array support. Fixed.
    • Date: Added.
    • Time: Added.
    • DateTime: Added precision of time support.
    • String: Default data should not be nil but ''.
    • Nil: Attribute value of xsi:nil might be '1' instead of 'true'. Fixed.
  • Supported XML parser:
    • Added SOAPXMLParser and SOAPSAXDriver for XMLParser which uses expat. You can get the module from RAA: XMLParser module.
      To use XMLParser -> add "require 'soap/xmlparser'".
      To use SAX driver of XMLParser -> add "require 'soap/saxdriver'".
      To use NQXMLParser -> nothing to do.
      FYI:
      • XMLParser version is faster than others
      • SAXDriver version is extremely slow
      • NQXMLParser version is somewhat slower than XMLParser version
      • XMLParser is a Ruby extension module; To use it, you must compile and install it.
      • So far, automatic code conversion support is for XMLParser and SAXDriver. See below.
    • Added automatic CES conversion support: UTF-8 <-> EUC, SJIS. Requires Uconv module. Works with XMLParser module only now.
    • Added XMLDecl for CES.
1.3.3 - July 4, 2001
Feedback from `SOAPBuilders Interoperability Lab.' and Michael Neumann. Thanks!
  • Added SOAP4R Installer by Michael Neumann. Thanks!
  • Types changed:
    • Boolean: Accepts 1 and 0 in addition to true and falue.
    • Float: handles single-precision 32-bit floating point. Ruby's float is doule-precision.
    • Double: Added. Mapped to Ruby's Float.
    • DateTime: Added TZ support.
    • Long: Added.
    • Int: Changed class hierarchy; derived from Long now.
    • Array: Added 'position' and 'offset' support.
    • Array: Added M-D Array support.
    • Decimal: Added but it's incomplete now.
  • Illegal error message when a type not found in SOAP-ENC.
  • Tries to transmit \r safely. To be checked...
  • Parse Fault items like 'faultcode' as same as Body ie. href/id.
  • rpcUtils.rb was completely re-written.
    • Added mappingRegistry interface.
    • Changed soap2obj and obj2soap's interface.
    • Bignum might be int or integer. It's dependent on platform. Changed to check range -2147483648~+2147483647 itself.
    • ary2md: Added. Converting Array ((of Array)...) to M-D Array.
    • struct2obj: Illegal dependency on ordering of Struct#members. Fixed.
    • Ruby's Array should be converted to SOAP's Array of anyType. Fixed.
  • Dump HTTP header even when an error was raised.
1.3.2 - June 21, 2001
Feedback from `SOAPBuilders Interoperability Lab.'
  • "nil='1'" should be "nil='true'" in 2001 schema whereas "null='1'" in 1999 schema. Fixed.
  • SOAP Array was not typed with xsi:type.
  • Fixed serialization root handling algorithm.
  • Supported kind of SOAP-ENC:String style typed element.
  • Default namespace was not derived to child element. Fixed.
  • Support default encodingStyle.
  • Added support for void type (SOAP::RPCUtils::SOAPVoid).
1.3.1 - May 30, 2001
Feedback from `SOAPBuilders Interoperability Lab.'
  • Heading and trailing whtespaces in Base64 string could not be processed. Fixed.
  • Illegal typeNamespace of SOAP's base64 type. Fixed.
  • Added NaN, INF, -INF support of Float type.
  • Extracted xsd:1999 type support to XMLSchemaDatatypes1999.rb. Use it with 'require "soap/XMLSchemaDatatypes1999"'.
  • Added 'root' attribute support.
  • Return status 500 when Fault.
1.3.0 - May 20, 2001
  • Adopted NQXML module instead of XMLParser module extensively. (You can implement your SOAP parser with XMLParser module. See the last part of lib/soap/parser.rb)
    • Use NQXML's streamingParser or tokenizer instead of XMLParser's DOMParser for unmarshalling.
    • Use NQXML's document instead of XMLParser's DOM for marshalling.
  • Passed major(?) part of inteoperability test in `SOAPBuilders Interoperability Lab.' See test/interop/README.txt.
  • Changed module namespace. SOAPFoo -> SOAP::Foo.
  • Added float datatype support.
  • Changed dateTime marshalling format. No timezone was added to marshalled string because SOAP4R does not support timezone now.
1.2.0 - March 30, 2001
Checked interoperability with Apache-SOAP, pocketSOAP/0.91, SOAP::Lite for Perl, and SOAP/Perl/0.28. It seems to work good except SOAP/Perl/0.28.
  • Added href/id unmarshalling support. (href/id marshalling has not been supported yet)
  • Added SOAP's base64 type support.
  • SOAPTimeInstant -> SOAPDateTime. Following XML Schema PR.
  • SOAPStruct can have multiple accessor which have same name. Should I separate it from original SOAPStruct?
  • Unknown attribute in Header Item raised an exception. Omitted.
  • Router can handle methods which belong to different namespace.
  • Added an option to allow unqualified SOAP element.
  • Added Apache's Map type support. Ruby's Hash are mapped to it now. (Ruby's Hash marshalled by 1.1 processor in the old way can be unmarshalled, but 1.2 processor marshals it in the new way and 1.1 processor does not unmarshals it into Hash. Incompatibility between SOAP4R/1.2 and 1.1)
  • Unknown type 'unknown:SOAPStruct' was incorrectly unmarshalled into SOAPStruct. Fixed.
  • Added utility methods map! and members to SOAPArray and SOAPStruct.
  • Added methods request, response, and fault to SOAPBody.
1.1.0 - March 23, 2001
Made many changes. Since it is tested only for my limited use, please be careful to use. Any comments especially "cannot connect to XXX implementation" are welcomed. Feel free sending mail to nahi@ruby-lang.org.
  • Added RPC server support.
  • Divided RPC client/server implementation from core.
  • Added Date, Hash type support. (Unknown type is converted to Struct as usual)
  • Adopted Date in date3.rb by Funaba-san instead of Time as TimeInstant.
  • Many encoding/decoding bugs around SOAPArray and SOAPStruct were fixed.
1.0.2 - November 11, 2000
Since the previous package dated, refreshes some points.
  • Ruby: ruby 1.6.x
  • uri.rb: 4.22
  • sample: xml-soap/2.0
1.0.1 - July 27, 2000
Handles SOAP/1.1 arrays. 1.0.0 cannot handles SOAP/1.1 arrays... Bear in mind there still be many restrictions around SOAP arrays.
1.0.0 - July 17, 2000
It is the initial released version of SOAP4R. :-)

9. Author

Name
NAKAMURA, Hiroshi (aka NaHi or nakahiro)
E-mail
nahi@ruby-lang.org

SOAP4R
Copyright © 2000-2007 NAKAMURA, Hiroshi <nahi@ruby-lang.org>.

This program is copyrighted free software by NAKAMURA, Hiroshi. You can redistribute it and/or modify it under the same terms of Ruby's license; either the dual license version in 2003 (see the file RUBYS), or any later version.

SOAP4R.
Copyright © 2000-2007 NAKAMURA, Hiroshi.