Google

PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">

Release Notes - SOAP4R

Last modified: January 17, 2003
Created: July 17, 2000

0. In this document...

This is Release Notes of SOAP4R.

Target SOAP4R version: SOAP4R/1.4.8

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

1. Changes

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.
  • Rewrite charset handling of XML processor.
    • If you only use us-ascii and utf-8, all XML processors should work without uconv module.
  • wsdl2ruby: Add --force option to override existing file.
  • Fixed many bugs.

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 in lib/soap directory are SOAP4R library program itself. Followings are redistributed files in redist/.

GServer
by John W. Small: http://fairfax2.laser.net/~jsmall/rubycorner.html
httpserver.rb

Files in archive:

lib/soap/
SOAP4R library.
lib/wsdl/
WSDL4R library.
sample/
SOAP4R samples. See Samples section.
test/
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.cgi 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.
redist/
Redistributed modules which SOAP4R uses. I would appriciate to authors of these programs.

3. Uninstall

To uninstall; 

$ ruby uninstall.rb

Of cource, modules listed at Dependencies which you may install are not uninstalled.

4. What is SOAP4R?

'SOAP4R' is an implementation of Simple Object Access Protocol (SOAP) 1.1 (W3C Note).

Comments, information such as interoperability between SOAP4R and another implementation are welcomed. Feel free sending mail to nakahiro@sarion.co.jp.

5. Dependencies

SOAP4R is written in Ruby and aims to use with Ruby application. You have to install Ruby itself. Ruby/1.6 series are required. It does not works on 1.4 series because it does not have class variable.

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

XML processor
SOAP4R requires a XML processor package installed. For now, one of following XML processor must be installed (SOAP4R automatically detects it in runtime). distribution. Version following each project is the version tested with soap4r.
[RAA:date2] (3.2)
Date and DateTime implementation by Todayoshi Funaba. Note: From ruby/1.8, this module is included in standard distribution. You don't have to install it if you are using ruby/1.8 or later.
[RAA:devel-logger] (1.0.1)
Logging utility by NaHi.
[RAA:http-access2] (version j)
Yet another HTTP client implementation by NaHi.
[RAA:Uconv] (optional) (0.4.10)
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. I will support Iconv for more conversion set.

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
babelfish.rb
A client for BabelFish which namespace URI is 'urn:xmethodsBabelFish'. 
$ ./babelfish.rb "Text to translate" [ translation pattern like 'en_fr' ]
whois.rb
A client for SQLData's WHOIS 
$ ./whois.rb ruby-lang.org
CAUTION: This WhoIs server does not handle non-ascii characters correctly. Querying domain which entry contains Japanese or so will hang. Gee.
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.
apacheClient.rb
SOAP-RPC client sample which connects with demonstration server; stockquote and addressbook in Apache-SOAP. You have to install Apache-SOAP and deploy demostration programs.
To execute; 





GoogleSearch/


A 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/


A sample client to connect with AmazonWebServices using WSDL.
You need to get a developer's token to use it.
See wsdlDriver.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










RAA/


SOAP-RPC client samples.
These programs connect to RAA SOAP Interface on www.ruby-lang.org.

    

  • soap4r.rb: Ruby program using SOAP4R
    • 

  • pocketSOAP.js: JScript program using pocketSOAP
    • 

  • SOAP::Lite.pl: Perl program using SOAP::Lite for Perl
    • 


Since the server is (still) under testing phase so stable operation is not expected.



webrick/


SOAP-RPC server samples which runs with WEBrick.

    

  • httpd.rb: HTTP server which soaplet.rb mounts to.
It is powered by WEBrick so you must install
[RAA:WEBrick]
to run it.
    • 

  • soaplet.rb: A bricklet to add a SOAP function to WEBrick.
It hosts exchange.rb, sampleStruct.rb below, and it is mounted to httpd.rb
to serve ExchangeService and SampleStructService.
    • 

  • ExchangeService

    

    exchange.rb
    

    A server class definition which returns the currency rate
after connecting to another site by SOAP to get the real rate.
An instance of this class is instanciated in httpd.rb and this instance
respond to each HTTP request.
    

    exchangeClient.rb
    

    A client to connect soaplet.rb via SOAP/HTTP to call exchange.rb.
    

    iExchange.rb
    

    Common class(type) definitions for server and client.
    

    

    • 


  • SampleStructService

    

    sampleStruct.rb
    

    A server class definition which wraps a given struct
and returns it.
An instance of this class is instanciated in httpd.rb and this instance
respond to each HTTP request.
    

    sampleStructClient.rb
    

    A client to connect soaplet.rb via SOAP/HTTP to call sampleStruct.rb
    

    iSampleStruct.rb
    

    Common class(type) definitions for server and client.
    

    • 


Run the server;

$ ruby httpd.rb


Then, run clients;

$ ruby sampleStruct.rb
$ ruby exchangeClient.rb


Set 'logger' and 'wireDumpDev' in clients to see log and wiredumps of SOAP.




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










WSDemo


A sample of messaging client.  Server side sample does not exist now...



RWiki


A sample CGI server which receives a request via SOAP and dispatches it
to RWiki server via dRuby.  Naive SOAP/dRuby bridge implementation.






7. Restrictions




The following features of the
SOAP 1.1 (W3C Note)
spec are NOT currently supported:




    

  • SOAP Envelope

      

    • SOAP actor attribute
      • 

    • SOAP mustUnderstand attribute
      • 

    • SOAP Fault Codes
      • 

    • 

  • SOAP Encoding

      

    • Decoding using XML Schema
      • 

    • 

  • Othres

      

    • Transport binding except HTTP server and client
      • 

    • 




8. Resources





[RAA:soap4r]


I will post a new release to RAA.
Check RAA to get a new stable (I hope) version.



CVS


There is the SOAP4R CVS repository in cvs.ruby-lang.org.
(Thanks to knu, the maintainer of cvs.ruby-lang.org.)
Check here to get most recent (but could be unstable) version.



SOAP4R Wiki


There is a wiki for SOAP4R, running under
[RAA:RWiki].
Feel free to add your comment there.
Any comments are welcomed. (as always)



InteropResults


Test results of SOAPBuilders Interoperability Lab "Round 2".






9. History





1.4.8 - January 17, 2002



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.
    • 
  
  • Rewrite charset handling of XML processor.
  
      
    
    • If you only use us-ascii and utf-8, all XML processors should work without uconv module.
      • 
  
    • 
  
  • 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.

      

    • Bare 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.
      • 
  
    

    • 


  • 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.
        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
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
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
nakahiro@sarion.co.jp.


    

  • 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
    • 




1.0.1 - July 27, 2000


Handles SOAP/1.1 arrays.
1.0.0 cannot handles SOAP/1.1 arrays...
Bare in mind there still be many
restrictions
around SOAP arrays.



1.0.0 - July 17, 2000


It is the initial released version of SOAP4R. :-)





10. Author





Name


NAKAMURA, Hiroshi (aka NaHi or nakahiro)



E-mail


nakahiro@sarion.co.jp



URL


http://www.jin.gr.jp/~nahi/ (Japanese)








SOAP4R

Copyright © 2000, 2001, 2002, 2003 NAKAMURA, Hiroshi.





This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.





This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License(the file named `COPYING') for more details.





You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.













SOAP4R.

Copyright © 2000, 2001, 2002, 2003
NAKAMURA, Hiroshi.