RELEASE_en.html

Revision 461, 37.3 kB (checked in by nahi, 7 years ago)
for 1.4.3
Property svn:eol-style set to `native` Property svn:executable set to ``* Property svn:keywords set to `author date id revision`

Line
1	<?xml version="1.0"?>
2	<!DOCTYPE html
3	PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
4	"DTD/xhtml1-strict.dtd">
5	<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
6	<head>
7	<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
8	<meta http-equiv="Content-Style-Type" content="text/css" />
9	<link rev="MADE" href="mailto:nakahiro@sarion.co.jp" />
10	<link rel="StyleSheet" href="rubyStyle.css" type="text/css" media="screen" />
11	<title>Release Notes - SOAP4R</title>
12	</head>
13	<body>
14
15	<div class="header">
16	<h1>
17	Release Notes - SOAP4R
18	</h1>
19
20	<p class="status">
21	Last modified: April 11, 2002<br />
22	Created: July 17, 2000
23	</p>
24	</div>
25
26	<hr />
27
28	<div class="main">
29	<h2>0. In this document...</h2>
30
31	<p>
32	This is Release Notes of SOAP4R.
33	</p>
34
35	<p>
36	Target SOAP4R version: SOAP4R/1.4.3
37	</p>
38
39	<ol>
40	<li><a href="#changes">Changes</a></li>
41	<li><a href="#install">Install</a></li>
42	<li><a href="#uninstall">Uninstall</a></li>
43	<li><a href="#whats">What is SOAP4R?</a></li>
44	<li><a href="#dependencies">Dependencies</a></li>
45	<li><a href="#samples">Samples</a></li>
46	<li><a href="#restrictions">Restrictions</a></li>
47	<li><a href="#resources">Resources</a></li>
48	<li><a href="#history">History</a></li>
49	<li><a href="#author">Author</a></li>
50	<li><a href="#copyright">Copyright</a></li>
51	</ol>
52
53	<h2 id="changes" name="changes">1. Changes</h2>
54
55	<dl>
56	<dt>Attention to 1.4.2 or earlier users;</dt>
57	<dd>
58	<ul>
59	<li>Stopped redistributing packages in RAA from this release.
60	Please get <a href="#dependencies">required</a> packages from
61	<a href="http://www.ruby-lang.org/en/raa.html">RAA</a>
62	and install it.</li>
63	<li>It still does NOT support WSDL!</li>
64	</ul>
65	</dd>
66
67	<dt>New features</dt>
68	<dd>
69	<ul>
70	<li>Added REXML parser support.</li>
71	<li>Added uninstaller.</li>
72	<li>Re: samples
73	<ul>
74	<li>Added 3 new samples, Calc, Exchange, and SampleStruct.</li>
75	<li>Use environment variable HTTP_PROXY or http_proxy for http proxy.</li>
76	<li>Removed unreachable services.</li>
77	<li>RAA: Separate iRAA.rb into RAA.rb and iRAA.rb.</li>
78	<li>Added description about <a href="#samples">samples</a> to RELEASE_en.html.</li>
79	</ul>
80	<li>Changed String encoding handling among
81	Ruby object <-> SOAP Data Model <-> XML instance.
82	<ul>
83	<li>Ruby object: $KCODE.</li>
84	<li>SOAP Data Model: utf-8 if uconv module is installed, $KCODE if not.</li>
85	<li>XML instance: Client side use utf-8 if uconv module is installed,
86	$KCODE if not. Server side try to adjust the request encoding.</li>
87	<li>Use regexp instead of NKF.guess to check if the given String is EUC/SJIS or not.</li>
88	</ul>
89	</li>
90	<li>Added 'addServant' interface to server side. See sample/Calc/server.rb.</li>
91	<li>Added 'addMethodAs' interface to both server side and client side.
92	See sample/Calc/server2.rb.</li>
93	</ul>
94	</dd>
95
96	<dt>Changes</dt>
97	<dd>
98	<ul>
99	<li>Removed Japanese document.
100	I was tired of maintaining 2 separated documents.
101	Though my English is poor as you see, numbers of readers of my English document
102	should be more than one of my Japanese document.
103	Would you please tell me bug of my English composition and of course in the code?</li>
104	<li>Use
105	<a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=Devel%3A%3ALogger">[RAA:Devel::Logger]</a>
106	instead of
107	<a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=Application">[RAA:Application]</a>.
108	</li>
109	<li>Avoided using exception in soap2obj and reduced warnings in runtime.</li>
110	<li>XSDDateTime: Use date2 version 3 instead of date3.rb.
111	Date2 version 3 will be included in standard distribution of Ruby/1.8.</li>
112	<li>XSDDateTime: Added XSDDateTimeToTime module to extract a Time object from XSDDateTime, XSDDate and XSDTime.</li>
113	</ul>
114	</dd>
115
116	<dt>Bug fixes</dt>
117	<dd>
118	<ul>
119	<li>Set 'charset=' to content-type when sending back a SOAPFault.
120	It was not set.</li>
121	<li>XSDDateTime: Parsedate was not used. Removed.</li>
122	<li>Added constant Log as a canonical name of Devel::Logger for backward
123	compatibility of devel-logger.</li>
124	<li>Foo = Struct.new(:foo) and Foo = Struct.new("Foo", :foo) could not be
125	unmarshalled collectly. All members were unmarshalled as nil. Fixed.</li>
126	<li>Rescue ArgumentError(Unrecognized signal) in standaloneServer.rb for mswin32 ruby.</li>
127	</ul>
128	</dd>
129	</dl>
130
131	<h2 id="install" name="install">2. Install</h2>
132
133	<p>
134	At first, see <a href="#dependencies">Dependencies</a> section.
135	You may need to install some extra packages.
136	Next, get the archived file of SOAP4R and extract it, then simply try;
137	</p>
138	<pre class="path">
139	$ ruby install.rb
140	</pre>
141
142	<p>
143	Necessary files will be installed to suitable directory.
144	</p>
145
146	<p>
147	Files in lib/soap directory are SOAP4R library program itself.
148	Followings are redistributed files in redist/.
149	</p>
150
151	<dl>
152	<dt class="path">GServer</dt>
153	<dd>by John W. Small: <a href="http://fairfax2.laser.net/~jsmall/rubycorner.html">http://fairfax2.laser.net/~jsmall/rubycorner.html</a></dd>
154
155	<dt class="path">httpserver.rb</dt>
156	<dd>by Michael Neumann: httpserver.rb in <a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=XML-RPC">[RAA:XML-RPC]</a></dd>
157	</dl>
158
159	<p>
160	Files in archive:
161	</p>
162
163	<dl>
164	<dt class="path">lib/soap/</dt>
165	<dd>SOAP4R library program.</dd>
166
167	<dt class="path">sample/</dt>
168	<dd>SOAP4R samples.
169	See <a href="#samples">Samples</a> section.</dd>
170
171	<dt class="path">test/</dt>
172	<dd>Clients/Server for
173	<a href="http://www.xmethods.net/ilab/">`SOAPBuilders Interoperability Lab.'</a>
174	Followings are advanced examples to use complex type transmit,
175	sending base64 encoded string, multi-dimensional array, and so on.
176	<ul>
177	<li>test/interopR2/server.cgi is a RPC Server side implementation.</li>
178	<li>test/interopR2/client*.rb is a RPC Client side implementation.</li>
179	<li>test/interopR2/base.rb includes common definitions for client/server.</li>
180	</ul>
181	</dd>
182
183	<dt class="path">redist/</dt>
184	<dd>Redistributed modules which SOAP4R uses.
185	I would appriciate to authors of these programs.
186	</dd>
187
188	</dl>
189
190	<h2 id="uninstall" name="uninstall">3. Uninstall</h2>
191
192	<p>
193	To uninstall;
194	</p>
195
196	<pre class="path">
197	$ ruby uninstall.rb
198	</pre>
199
200	<p>
201	Of cource, modules listed at <a href="#dependencies">Dependencies</a>
202	which you may install are not uninstalled.
203	</p>
204
205	<h2 id="whats" name="whats">4. What is SOAP4R?</h2>
206
207	<p>
208	'SOAP4R' is an implementation of
209	<a href="http://www.w3.org/TR/SOAP/">Simple Object Access Protocol (SOAP) 1.1 (W3C Note)</a>.
210	</p>
211
212	<p>
213	Comments, information such as interoperability between SOAP4R and another implementation are welcomed.
214	Feel free sending mail to
215	<a href="mailto:nakahiro@sarion.co.jp" class="path">nakahiro@sarion.co.jp</a>.
216	</p>
217
218	<h2 id="dependencies" name="dependencies">5. Dependencies</h2>
219
220	<p>
221	SOAP4R is written in <a href="http://www.ruby-lang.org">Ruby</a> and
222	aims to use with Ruby application.
223	You have to install Ruby itself.
224	Ruby/1.6 series are required.
225	It does not works on 1.4 series because it does not have class variable.
226	</p>
227
228	<p>
229	SOAP4R depends on following Ruby modules in
230	<a href="http://www.ruby-lang.org/en/raa.html">RAA</a>.
231	You also have to install these modules to use SOAP4R.
232	</p>
233
234	<dl>
235	<dt class="path">XML processor</dt>
236	<dd>SOAP4R requires a XML processor package installed.
237	For now, one of following XML processor must be installed
238	(SOAP4R automatically detects it in runtime).
239	<ul>
240	<li><a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=NQXML">[RAA:NQXML]</a></li>
241	<li><a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=XMLParser">[RAA:XMLParser]</a></li>
242	<li><a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=REXML">[RAA:REXML]</a></li>
243	</ul></dd>
244
245	<dt class="path"><a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=date2">[RAA:date2]</a></dt>
246	<dd>Date and DateTime implementation by Todayoshi Funaba.
247	Note: This module is scheduled to be included in standard distribution instead of lib/date.rb. Ruby/1.7 or later.</dd>
248
249	<dt class="path"><a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=Devel%3A%3ALogger">[RAA:Devel::Logger]</a></dt>
250	<dd>Logging utility by NaHi.</dd>
251
252	<dt class="path"><a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=http-access2">[RAA:http-access2]</a></dt>
253	<dd>Yet another HTTP client implementation by NaHi.</dd>
254
255	<dt class="path"><a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=Uconv">[RAA:Uconv]</a> (optional)</dt>
256	<dd>by Yoshida Masato.
257	It is requred when you want automatic CES conversion between
258	SJIS <-> UTF8 and EUC <-> UTF8.
259	Note: SJIS <-> EUC uses NKF module which is in standard distribution.
260	I will support Iconv for more conversion set.
261	</dd>
262
263	</dl>
264
265	<h2 id="samples" name="samples">6. Samples</h2>
266
267	<p>
268	Samples are in sample/ directory of distribution.
269	Some samples try to connect to public servers.
270	Set environment variable HTTP_PROXY if you are in a firewall and you have
271	http proxy to the internet like;
272	</p>
273	<pre class="path">
274	$ export HTTP_PROXY=http://myproxyserver:8080
275	or
276	$ setenv HTTP_PROXY http://myproxyserver:8080
277	</pre>
278
279	<dl>
280	<dt class="path">babelfish.rb</dt>
281	<dd>A client for
282	<a href="http://www.xmethods.com/ve2/ViewListing.po?serviceid=14">BabelFish</a>
283	which namespace URI is 'urn:xmethodsBabelFish'.
284	<pre class="path">
285	$ ./babelfish.rb "Text to translate" [ translation pattern like 'en_fr' ]
286	</pre>
287	</dd>
288
289	<dt class="path">whois.rb</dt>
290	<dd>A client for
291	<a href="http://www.xmethods.com/ve2/ViewListing.po?serviceid=34">SQLData's WHOIS</a>
292	which namespace URI is 'http://www.SoapClient.com/xml/SQLDataSoap.xsd'.
293	<pre class="path">
294	$ ./whois.rb ruby-lang.org
295	</pre>
296	CAUTION: This WhoIs server does not handle non-ascii characters correctly.
297	Querying domain which entry contains Japanese or so will hang. Gee.
298	</dd>
299
300	<dt class="path">digraph.rb</dt>
301	<dd>A sample of SOAP marshalling/unmarshalling.
302	It creates a digraph that contains multi-ref-ed nodes at first
303	and marshals this object to get serialized XML instance.
304	Then reads and unmarshals this XML instance to recover a object
305	which has the same links among nodes in the digraph.
306	</dd>
307
308	<dt class="path">apacheClient.rb</dt>
309	<dd>SOAP-RPC client sample which connects with demonstration server;
310	stockquote and addressbook in Apache-SOAP.
311	You have to install Apache-SOAP and deploy demostration programs.<br />
312	To execute;
313	<pre class="path">
314	$ ./apacheClient.rb http://localhsot:2020/xml-soap/rpcrouter/rpcrouter.jsp
315	</pre>
316	</dd>
317
318	<dt class="path">Calc/</dt>
319	<dd>Calc service contains 2 servers and 2 clients.
320	calc.rb is hosted by server.rb, calc2.rb is hosted by server2.rb.
321	client.rb is for server.rb, client2.rb is for server2.rb.
322	<dl>
323	<dt>calc.rb</dt>
324	<dd>Calc server definition using module and module methods.
325	This module responds 'add', 'sub', 'multi' and 'div'.</dd>
326	<dt>server.rb</dt>
327	<dd>It requires calc.rb and serve module methods of this module.
328	To run this server;
329	<pre class="path">
330	$ ./server.rb
331	</pre>
332	</dd>
333	<dt>client.rb</dt>
334	<dd>It connects to server.rb and hit methods served by calc.rb.
335	To run the client;
336	<pre class="path">
337	$ ./client.rb
338	</pre>
339	Is it stacked? Did you run the server.rb?<br/>
340	Turn logger and wireDumpDev in its source on to see logs and wire dumps of
341	SOAP transport.</dd>
342
343	<dt>calc2.rb</dt>
344	<dd>Calc server definition using class and instance methods.
345	An instance of this class holds its value. Methods 'set' and 'get' is to
346	set/get the value.
347	It also responds to '+', '-', '*', and '/'.
348	</dd>
349	<dt>server2.rb</dt>
350	<dd>It requires calc2.rb and creates an instance of CalcService2
351	that responds all SOAP requests.
352	Since '+', '-' and so on of calc2.rb are not valid name as an element
353	in XML instance,
354	this sample register the method '+' as 'add', '-' as 'sub', and so on.
355	</dd>
356	<dt>client2.rb</dt>
357	<dd>It connects to server2.rb.
358	Set a value at first and call methods like 'puts objAtServer + 2'.</dd>
359	</dl>
360	</dd>
361
362	<dt class="path">Exchange/</dt>
363	<dd>A sample to retrieve the currency rate from public SOAP service.</dd>
364	<dl>
365	<dt>iExchange.rb</dt>
366	<dd>It includes common definitions for client and server of
367	Exchange service.
368	Including only a definition of namespace URI of this service.</dd>
369	<dt>exchange.rb</dt>
370	<dd>Definition of servant class ExchangeService which returns the currency rate
371	after connecting to another site by SOAP to get the real rate.
372	So that this class is the SOAP server for local client and
373	is also a SOAP client for public server.
374	An instance of this class is hosted by server.rb.
375	The instance responds to only 'getRate' which receives two country code
376	such as 'USA' and 'Japan'.</dd>
377	<dt>server.rb</dt>
378	<dd>It requires exchange.rb and creates an instance of ExchangeService
379	that responds all SOAP requests.
380	To run this server;
381	<pre class="path">
382	$ ./server.rb
383	</pre>
384	</dd>
385	<dt>client.rb</dt>
386	<dd>It connects to server.rb.
387	Turn logger and wireDumpDev in its source on to see logs and wire dumps of
388	SOAP transport.
389	To run the client;
390	<pre class="path">
391	$ ./client.rb
392	</pre>
393	</dd>
394	</dl>
395	</dd>
396
397	<dt class="path">SampleStruct/</dt>
398	<dd>A sample to transmit complex structured object which has recursive
399	object reference.
400	<dl>
401	<dt>iSampleStruct.rb</dt>
402	<dd>It includes common definitions for client and server of
403	SampleStruct service.
404	Definition of SampleStruct class and namespace URI of this service.</dd>
405	<dt>sampleStruct.rb</dt>
406	<dd>Definition of servant class SampleStructService.
407	An instance of this class is hosted by server.rb.
408	The instance responds to only 'hi' which receives a SampleStruct and wraps
409	it in the new instance of SampleStruct to return .</dd>
410	<dt>server.rb</dt>
411	<dd>It requires sampleStruct.rb and creates an instance of SampleStructService
412	that responds all SOAP requests.
413	To run this server;
414	<pre class="path">
415	$ ./server.rb
416	</pre>
417	</dd>
418	<dt>client.rb</dt>
419	<dd>It connects to server.rb.
420	Turn logger and wireDumpDev in its source on to see logs and wire dumps of
421	SOAP transport.
422	To run the client;
423	<pre class="path">
424	$ ./client.rb
425	</pre>
426	</dd>
427	</dl>
428	</dd>
429
430	<dt class="path">RAA/</dt>
431	<dd>SOAP-RPC client samples.
432	These programs connect to RAA SOAP Interface on www.ruby-lang.org.
433	<ul>
434	<li>soap4r.rb: Ruby program using SOAP4R</li>
435	<li>xmlrpc4r.rb: Ruby program using xmlrpc4r</li>
436	<li>pocketSOAP.js: JScript program using pocketSOAP</li>
437	<li>SOAP::Lite.pl: Perl program using SOAP::Lite for Perl</li>
438	</ul>
439	Since the server is (still) under testing phase so stable operation is not expected.</dd>
440
441	<dt class="path">webrick/</dt>
442	<dd>SOAP-RPC server samples which runs with WEBrick.
443	<ul>
444	<li>httpd.rb: HTTP server which soaplet.rb mounts to.
445	It is powered by WEBrick so you must install
446	<a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=WEBrick">[RAA:WEBrick]</a>
447	to run it.</li>
448	<li>soaplet.rb: A bricklet to add a SOAP function to WEBrick.
449	It hosts exchange.rb, sampleStruct.rb below, and it is mounted to httpd.rb
450	to serve ExchangeService and SampleStructService.</li>
451	<li>ExchangeService
452	<dl>
453	<dt>exchange.rb</dt>
454	<dd>A server class definition which returns the currency rate
455	after connecting to another site by SOAP to get the real rate.
456	An instance of this class is instanciated in httpd.rb and this instance
457	respond to each HTTP request.</dd>
458	<dt>exchangeClient.rb</dt>
459	<dd>A client to connect soaplet.rb via SOAP/HTTP to call exchange.rb.</dd>
460	<dt>iExchange.rb</dt>
461	<dd>Common class(type) definitions for server and client.</dd>
462	</dl>
463	</li>
464
465	<li>SampleStructService
466	<dl>
467	<dt>sampleStruct.rb</dt>
468	<dd>A server class definition which wraps a given struct
469	and returns it.
470	An instance of this class is instanciated in httpd.rb and this instance
471	respond to each HTTP request.</dd>
472	<dt>sampleStructClient.rb</dt>
473	<dd>A client to connect soaplet.rb via SOAP/HTTP to call sampleStruct.rb</dd>
474	<dt>iSampleStruct.rb</dt>
475	<dd>Common class(type) definitions for server and client.</dd>
476	</dl></li>
477	</ul>
478	Run the server;
479	<pre class="path">
480	$ ruby httpd.rb
481	</pre>
482	Then, run clients;
483	<pre class="path">
484	$ ruby sampleStruct.rb
485	$ ruby exchangeClient.rb
486	</pre>
487	Set 'logger' and 'wireDumpDev' in clients to see log and wiredumps of SOAP.
488	</dd>
489
490	<dt class="path">ICD</dt>
491	<dd>A client for
492	<a href="http://www.iwebmethod.net/">Insider's Computer Dictionary Web Service</a>.
493	This service is implemented with ASP.NET so that it's also a sample of
494	a client which connects to ASP.NET.
495	CAUTION: this sample contains non-ascii chars in its source and dumped results.
496	<dl>
497	<dt>IICD.rb</dt>
498	<dd>Class(type) definitions for this server.</dd>
499	<dt>icd.rb</dt>
500	<dd>Client implementation. To run the client;
501	<pre class="path">
502	$ ./icd.rb
503	</pre>
504	</dd>
505	</dl>
506	</dd>
507
508	<dt class="path">WSDemo</dt>
509	<dd>A sample of messaging client. Server side sample does not exist now...</dd>
510
511	<dt class="path">RWiki</dt>
512	<dd>A sample CGI server which receives a request via SOAP and dispatches it
513	to RWiki server via dRuby. Naive SOAP/dRuby bridge implementation.</dd>
514
515	</dl>
516
517	<h2 id="restrictions" name="restrictions">7. Restrictions</h2>
518
519	<p>
520	The following features of the
521	<a href="http://www.w3.org/TR/SOAP/">SOAP 1.1 (W3C Note)</a>
522	spec are <strong>NOT</strong> currently supported:
523	</p>
524
525	<ul>
526	<li style="margin-top: 2ex;">SOAP Envelope
527	<ul>
528	<li>SOAP actor attribute</li>
529	<li>SOAP mustUnderstand attribute</li>
530	<li>SOAP Fault Codes</li>
531	</ul></li>
532	<li style="margin-top: 2ex;">SOAP Encoding
533	<ul>
534	<li>encoding/decoding using XML Schema;
535	Only xsi:type in SOAP Encoding is checked</li>
536	</ul></li>
537	<li style="margin-top: 2ex;">Othres
538	<ul>
539	<li>Transport binding except HTTP server and client</li>
540	</ul></li>
541	</ul>
542
543	<h2 id="resources" name="resources">8. Resources</h2>
544
545	<dl>
546	<dt class="path"><a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=SOAP4R">[RAA:SOAP4R]</a></dt>
547	<dd>I will post a new release to RAA.
548	Check RAA to get a new stable (I hope) version.</dd>
549
550	<dt class="path"><a href="http://www.ruby-lang.org/~knu/cgi-bin/cvsweb.cgi/lib/soap4r/">CVS</a></dt>
551	<dd>There is the SOAP4R CVS repository in cvs.ruby-lang.org.
552	(Thanks to knu, the maintainer of cvs.ruby-lang.org.)
553	Check here to get most recent (but could be unstable) version.</dd>
554
555	<dt class="path"><a href="http://www.jin.gr.jp/~nahi/Ruby/SOAP4R/wiki.cgi">SOAP4R Wiki</a></dt>
556	<dd>There is a wiki for SOAP4R, running under
557	<a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=RWiki">[RAA:RWiki]</a>.
558	Feel free to add your comment there.
559	Any comments are welcomed. (as always)</dd>
560
561	<dt class="path"><a href="http://www.jin.gr.jp/~nahi/Ruby/SOAP4R/wiki.cgi?cmd=view;name=InteropResults">InteropResults</a></dt>
562	<dd>Test results of <a href="http://www.whitemesa.com/interop.htm">SOAPBuilders Interoperability Lab "Round 2"</a>.</dd>
563
564	</dl>
565
566	<h2 id="history" name="history">9. History</h2>
567
568	<dl>
569	<dt>1.4.3 - April 11, 2002</dt>
570
571	<dd>
572	<dl>
573	<dt>Attention to 1.4.2 or earlier users;</dt>
574	<dd>
575	<ul>
576	<li>Stopped redistributing packages in RAA from this release.
577	Please get <a href="#dependencies">required</a> packages from
578	<a href="http://www.ruby-lang.org/en/raa.html">RAA</a>
579	and install it.</li>
580	<li>It still does NOT support WSDL!</li>
581	</ul>
582	</dd>
583
584	<dt>New features</dt>
585	<dd>
586	<ul>
587	<li>Added REXML parser support.</li>
588	<li>Added uninstaller.</li>
589	<li>Re: samples
590	<ul>
591	<li>Added 3 new samples, Calc, Exchange, and SampleStruct.</li>
592	<li>Use environment variable HTTP_PROXY or http_proxy for http proxy.</li>
593	<li>Removed unreachable services.</li>
594	<li>RAA: Separate iRAA.rb into RAA.rb and iRAA.rb.</li>
595	<li>Added description about <a href="#samples">samples</a> to RELEASE_en.html.</li>
596	</ul>
597	<li>Changed String encoding handling among
598	Ruby object <-> SOAP Data Model <-> XML instance.
599	<ul>
600	<li>Ruby object: $KCODE.</li>
601	<li>SOAP Data Model: utf-8 if uconv module is installed, $KCODE if not.</li>
602	<li>XML instance: Client side use utf-8 if uconv module is installed,
603	$KCODE if not. Server side try to adjust the request encoding.</li>
604	<li>Use regexp instead of NKF.guess to check if the given String is EUC/SJIS or not.</li>
605	</ul>
606	</li>
607	<li>Added 'addServant' interface to server side. See sample/Calc/server.rb.</li>
608	<li>Added 'addMethodAs' interface to both server side and client side.
609	See sample/Calc/server2.rb.</li>
610	</ul>
611	</dd>
612
613	<dt>Changes</dt>
614	<dd>
615	<ul>
616	<li>Removed Japanese document.
617	I was tired of maintaining 2 separated documents.
618	Though my English is poor as you see, numbers of readers of my English document
619	should be more than one of my Japanese document.
620	Would you please tell me bug of my English composition and of course in the code?</li>
621	<li>Use
622	<a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=Devel%3A%3ALogger">[RAA:Devel::Logger]</a>
623	instead of
624	<a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=Application">[RAA:Application]</a>.
625	</li>
626	<li>Avoided using exception in soap2obj and reduced warnings in runtime.</li>
627	<li>XSDDateTime: Use date2 version 3 instead of date3.rb.
628	Date2 version 3 will be included in standard distribution of Ruby/1.8.</li>
629	<li>XSDDateTime: Added XSDDateTimeToTime module to extract a Time object from XSDDateTime, XSDDate and XSDTime.</li>
630	</ul>
631	</dd>
632
633	<dt>Bug fixes</dt>
634	<dd>
635	<ul>
636	<li>Set 'charset=' to content-type when sending back a SOAPFault.
637	It was not set.</li>
638	<li>XSDDateTime: Parsedate was not used. Removed.</li>
639	<li>Added constant Log as a canonical name of Devel::Logger for backward
640	compatibility of devel-logger.</li>
641	<li>Foo = Struct.new(:foo) and Foo = Struct.new("Foo", :foo) could not be
642	unmarshalled collectly. All members were unmarshalled as nil. Fixed.</li>
643	<li>Rescue ArgumentError(Unrecognized signal) in standaloneServer.rb for mswin32 ruby.</li>
644	</ul>
645	</dd>
646	</dl>
647	</dd>
648
649	<dt>1.4.2 - December 28, 2001</dt>
650	<dd>
651	Many changes around Ruby language mapping for SOAP.
652	I replaced DRb's marshalling format with SOAP marshalling and it passed
653	about all unit test packed in DRb package.
654	Only test failed was regards to packet size.
655	You might be able to use SOAP::Marshal.(un\|)marshal for serializing objects
656	instead of Marshal.(load\|dump).
657
658	<ul>
659	<li>Illegal decoding of a position-less element after position-ed element. Fixed.</li>
660	<li>Add Rubytype encoding/decoding support: Regexp, Class, Module and Symbol.</li>
661	<li>Added an option of MappingRegistry to raise an exception when unknown Struct.
662	The option is set 'false' by default so that same behaviour as before.</li>
663	</ul></dd>
664
665	<dt>1.4.1 - December 7, 2001</dt>
666	<dd>SOAP4R/1.4 contained many bugs (as usual...)
667	1.4.1 is a maintenance release. Some bugs are fixed.
668	Thanks to Michael Neumann.
669
670	<ul>
671	<li>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.</li>
672	<li>Fixed charset handling. Illegal charset was set when automatic XML processor detecting.</li>
673	<li>Removed unused code(self.decode) in element.rb.</li>
674	<li>Illegal constant access when SOAP format error. Fixed.</li>
675	<li>LiteralEncodingNamespace moved to SOAP module.</li>
676	</ul></dd>
677
678
679	<dt>1.4 - December 5, 2001</dt>
680	<dd><ul>
681	<li>Datatypes:
682	<ul>
683	<li>XSDFloat: Bug in rounding double float to single float. Fixed.</li>
684	<li>SOAPElement: Added for literal encoding.</li>
685	<li>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.)</li>
686	<li>SOAPHeaderItem: Changed interface for easy use.</li>
687	</ul></li>
688
689	<li>SOAP Encoding:
690	<ul>
691	<li>Encoding by itself, not using NQXML's tree object model.</li>
692	<li>At last, supported multi-ref encoding!</li>
693	<li>marshal.rb: Marshalling with Envelope and Body. To marshal multi-ref'd object, Body is needed. CAUTION: Not compatible between former implementation.</li>
694	<li>Add EncodingStyleHandlerLiteral and set it to default.</li>
695	<li>Renamed encoding.rb to encodingStyleHandler.rb.</li>
696	<li>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.</li>
697	<li>Changed element name escape.
698	<ul>
699	<li>:: <=> \.\.</li>
700	<li>[^a-zA-Z0-9_-] <=> \.[0-F][0-F]
701	</ul>
702	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.</li>
703	</ul></li>
704
705	<li>RPC related functions:
706	<ul>
707	<li>Driver: Added 'invoke' method for messaging.</li>
708	<li>Driver: Content of SOAPFault detail element is set in the exception which is thrown from SOAP Node to client application.</li>
709	<li>Processor: Changed Processor.(un\|)marshal interface. An instance of NS for parsing/generating XML instance is prepared in parser/generator.</li>
710	<li>mappingRegistry.rb is devided from rpcUtils.rb.</li>
711	</ul></li>
712	</ul></dd>
713
714
715	<dt>1.3.8 - October 4, 2001</dt>
716	<dd>Feedback from
717	<a href="http://www.whitemesa.com/interop.htm">SOAPBuilders Interoperability Lab "Round 2"</a>
718	and Michael Neumann. Thanks!
719
720	<ul>
721	<li>Datatypes:
722	<ul>
723	<li>XSDFloat: Creating float data from junk string such as "123.0junk" was
724	converted to 0.0. It should be avoided. Fixed.</li>
725	<li>XSDFloat: Fixed double -> single rounding code.</li>
726	</ul></li>
727
728	<li>RPC related functions:
729	<ul>
730	<li>Changed typename <=> NCName strategy. '::' <=> '.'</li>
731	<li>Added mappingRegistry argument to interfaces for SOAP object creation.</li>
732	</ul></li>
733
734	<li>Others:
735	<ul>
736	<li>Set faultstring '(No faultstring)' to SOAP Fault when empty faultstring element.</li>
737	<li>server.rb: Added mappingRegistry interface.</li>
738	<li>marshal.rb: Create NCName from typename.</li>
739	</ul></li>
740	</ul></dd>
741
742
743	<dt>1.3.7 - August 24, 2001</dt>
744	<dd>Feedback from
745	<a href="http://www.whitemesa.com/interop.htm">SOAPBuilders Interoperability Lab "Round 2"</a>
746	and Michael Neumann. Thanks!
747
748	<ul>
749	<li>Datatypes:
750	<ul>
751	<li>All datatypes try to keep nil correctly.</li>
752	<li>XSDInt/Integer/Long: to_i -> Integer() to detect format error.</li>
753	<li>XSDDateTime, XSDDate, XSDTime: Add trailing 'Z' to indicate UTC.</li>
754	<li>SOAPStruct: Accept untyped struct.</li>
755	<li>Map(Hash): Let <item> untyped.</li>
756	<li>Apache allows only 'item' in Map type.</li>
757	</ul></li>
758
759	<li>Stream handler:
760	<ul>
761	<li>Removed MPOST support.</li>
762	<li>ECONNRESET was not caught. Fixed.</li>
763	<li>Added timeout support.</li>
764	</ul></li>
765
766	<li>Others:
767	<ul>
768	<li>Changed using URI library: URb -> URI; following its name change.</li>
769	<li>Added NQXML/1.1.0 support. A XMLDecl now recognized as a XMLDecl, not a PI.</li>
770	</ul></li>
771	</ul></dd>
772
773	<dt>1.3.6 - July 27, 2001</dt>
774	<dd>Many feedbacks from Michael Neumann. Thanks!
775
776	<ul>
777	<li>hexBinary type: Added.</li>
778	<li>nil type: Should not be xsd:nil but xsi:nil.</li>
779	<li>Added StandaloneServer implementation. Thanks to Michael Neumann!</li>
780	<li>Illegal parsing of XMLDecl. Fixed.</li>
781	<li>RPC's 'inout' param was not supported. Fixed. Thanks to Michael Neumann!</li>
782	<li>URb::Generic#path returns '' when abs_path is empty (such as http://foo).
783	Added checking code.</li>
784	<li>Use http-access2 instead of original HTTP implementation. http-access2 supports HTTP/1.1's persistent connection.</li>
785	</ul></dd>
786
787	<dt>1.3.5 - July 14, 2001</dt>
788	<dd>Many feedbacks from Michael Neumann.
789	I much appreciate valuable comments to him.
790	Thanks!
791
792	<ul>
793	<li>Changed using URI library: uri -> URb.</li>
794	<li>Types changed:
795	<ul>
796	<li>All: Triming data except XSDString before parsing it.</li>
797	<li>String: Regexp for XML Char check did not work under $KCODE = 'UTF8' condition. Fixed.</li>
798	<li>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.</li>
799	</ul>
800	</li>
801
802	<li>Supported XML parser:
803	<ul>
804	<li>Added automatic CES conversion support for NQXMLParser.
805	(Depends on uconv module).
806	Set $KCODE for regexps used in NQXML parser.</li>
807	<li>Moved SOAPNQXML*Parser to nqxmlparser.rb.</li>
808	</ul>
809	</li>
810
811	<li>RPC related functions changed:</li>
812	<ul>
813	<li>Added marshalling/unmarshalling Ruby's object using SOAP Encoding.</li>
814	<li>Parallelize of signatures of 'addMethod': proxy.rb <-> rpcRouter.rb, driver.rb <-> cgistub.rb.</li>
815	<li>Void return if 'retval' is not defined.</li>
816	<li>Added SOAP's Long type to default mapping table.</li>
817	</ul>
818	</li>
819	</ul></dd>
820
821	<dt>1.3.4.2 - July 11, 2001</dt>
822	<dd>SOAP4R/1.3.4 was once packed in July 10, 2001.
823	But, thanks to MNeumann and knu,
824	I found I had forgotten to pack 'redist' directory with it.
825	I added some fix from developing version and repack it as 1.3.4.2.
826	Sorry for frequently release...
827	<br/><br/>
828
829	Feedback from
830	<a href="http://www.xmethods.net/ilab/">`SOAPBuilders Interoperability Lab.'</a>
831	and Michael Neumann. Thanks!
832
833	<ul>
834	<li>Added in 1.3.4.2:
835	<ul>
836	<li>Type Decimal: Silly bug fixed. 0.0001 was converted to 0.1</li>
837	<li>CGIStub returns HTTP status 500 when returning SOAP Fault.
838	Returned 200 because I don't like this spec., but SOAP/1.2 W3C WD
839	9 July 2001 have adopted it. Hmm...</li>
840	<li>RPC client(driver.rb): Exception#set_backtrace was omitted when transmitting exception by SOAP Fault.</li>
841	</ul>
842	</li>
843	<li>Types changed:
844	<ul>
845	<li>Array: Incomplete sparse array support. Fixed.</li>
846	<li>Date: Added.</li>
847	<li>Time: Added.</li>
848	<li>DateTime: Added precision of time support.</li>
849	<li>String: Default data should not be nil but ''.</li>
850	<li>Nil: Attribute value of xsi:nil might be '1' instead of 'true'. Fixed.</li>
851	</ul>
852	</li>
853
854	<li>Supported XML parser:
855	<ul>
856	<li>Added SOAPXMLParser and SOAPSAXDriver for XMLParser which uses expat.
857	You can get the module from RAA: <a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=XMLParser">XMLParser module</a>.<br/>
858	To use XMLParser -> add "require 'soap/xmlparser'".<br/>
859	To use SAX driver of XMLParser -> add "require 'soap/saxdriver'".<br/>
860	To use NQXMLParser -> nothing to do.<br/>
861	FYI:
862	<ul>
863	<li>XMLParser version is faster than others</li>
864	<li>SAXDriver version is extremely slow</li>
865	<li>NQXMLParser version is somewhat slower than XMLParser version</li>
866	<li>XMLParser is a Ruby extension module; To use it, you must compile and install it.</li>
867	<li>So far, automatic code conversion support is for XMLParser and SAXDriver. See below.</li>
868	</ul>
869	</li>
870	<li>Added automatic CES conversion support: UTF-8 <-> EUC, SJIS.
871	Requires Uconv module. Works with XMLParser module only now.</li>
872	<li>Added XMLDecl for CES.</li>
873	</ul>
874	</ul></dd>
875
876	<dt>1.3.3 - July 4, 2001</dt>
877	<dd>Feedback from
878	<a href="http://www.xmethods.net/ilab/">`SOAPBuilders Interoperability Lab.'</a>
879	and Michael Neumann. Thanks!
880	<ul>
881	<li>Added SOAP4R Installer by Michael Neumann. Thanks!</li>
882	<li>Types changed:
883	<ul>
884	<li>Boolean: Accepts 1 and 0 in addition to true and falue.</li>
885	<li>Float: handles single-precision 32-bit floating point.
886	Ruby's float is doule-precision.</li>
887	<li>Double: Added. Mapped to Ruby's Float.</li>
888	<li>DateTime: Added TZ support.</li>
889	<li>Long: Added.</li>
890	<li>Int: Changed class hierarchy; derived from Long now.</li>
891	<li>Array: Added 'position' and 'offset' support.</li>
892	<li>Array: Added M-D Array support.</li>
893	<li>Decimal: Added but it's incomplete now.</li>
894	</ul>
895	</li>
896	<li>Illegal error message when a type not found in SOAP-ENC.</li>
897	<li>Tries to transmit \r safely. To be checked...</li>
898	<li>Parse Fault items like 'faultcode' as same as Body ie. href/id.</li>
899	<li>rpcUtils.rb was completely re-written.
900	<ul>
901	<li>Added mappingRegistry interface.</li>
902	<li>Changed soap2obj and obj2soap's interface.</li>
903	<li>Bignum might be int or integer. It's dependent on platform.
904	Changed to check range -2147483648~+2147483647 itself.</li>
905	<li>ary2md: Added. Converting Array ((of Array)...) to M-D Array.</li>
906	<li>struct2obj: Illegal dependency on ordering of Struct#members. Fixed.</li>
907	<li>Ruby's Array should be converted to SOAP's Array of anyType. Fixed.</li>
908	</ul>
909	</li>
910	<li>Dump HTTP header even when an error was raised.</li>
911	</ul></dd>
912
913	<dt>1.3.2 - June 21, 2001</dt>
914	<dd>Feedback from
915	<a href="http://www.xmethods.net/ilab/">`SOAPBuilders Interoperability Lab.'</a>
916
917	<ul>
918	<li>"nil='1'" should be "nil='true'" in 2001 schema
919	whereas "null='1'" in 1999 schema. Fixed.</li>
920	<li>SOAP Array was not typed with xsi:type.</li>
921	<li>Fixed serialization root handling algorithm.</li>
922	<li>Supported kind of SOAP-ENC:String style typed element.</li>
923	<li>Default namespace was not derived to child element. Fixed.</li>
924	<li>Support default encodingStyle.</li>
925	<li>Added support for void type (SOAP::RPCUtils::SOAPVoid).</li>
926	</ul></dd>
927
928	<dt>1.3.1 - May 30, 2001</dt>
929	<dd>Feedback from
930	<a href="http://www.xmethods.net/ilab/">`SOAPBuilders Interoperability Lab.'</a>
931
932	<ul>
933	<li>Heading and trailing whtespaces in Base64 string could not be processed. Fixed.</li>
934	<li>Illegal typeNamespace of SOAP's base64 type. Fixed.</li>
935	<li>Added NaN, INF, -INF support of Float type.</li>
936	<li>Extracted xsd:1999 type support to XMLSchemaDatatypes1999.rb. Use it with 'require "soap/XMLSchemaDatatypes1999"'.</li>
937	<li>Added 'root' attribute support.</li>
938	<li>Return status 500 when Fault.</li>
939	</ul></dd>
940
941	<dt>1.3.0 - May 20, 2001</dt>
942	<dd><ul>
943	<li>Adopted
944	<a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=NQXML">NQXML module</a>
945	instead of XMLParser module extensively.
946	(You can implement your SOAP parser with XMLParser module.
947	See the last part of lib/soap/parser.rb)
948	<ul>
949	<li>Use NQXML's streamingParser or tokenizer instead of XMLParser's DOMParser for unmarshalling.</li>
950	<li>Use NQXML's document instead of XMLParser's DOM for marshalling.</li>
951	</ul></li>
952	<li>Passed major(?) part of inteoperability test in
953	<a href="http://www.xmethods.net/ilab/">`SOAPBuilders Interoperability Lab.'</a>
954	See test/interop/README.txt.</li>
955	<li>Changed module namespace. SOAPFoo -> SOAP::Foo.</li>
956	<li>Added float datatype support.</li>
957	<li>Changed dateTime marshalling format. No timezone was added to marshalled string because SOAP4R does not support timezone now.</li>
958	</ul></dd>
959
960	<dt>1.2.0 - March 30, 2001</dt>
961	<dd>Checked interoperability with
962	<a href="http://xml.apache.org/soap/">Apache-SOAP</a>,
963	<a href="http://www.pocketsoap.com">pocketSOAP/0.91</a>,
964	<a href="http://www.geocities.com/paulclinger/soap.html">SOAP::Lite for Perl</a>,
965	and <a href="http://www.develop.com/soap/">SOAP/Perl/0.28</a>.
966	It seems to work good except SOAP/Perl/0.28.
967
968	<ul>
969	<li>Added href/id unmarshalling support.
970	(href/id marshalling has not been supported yet)</li>
971	<li>Added SOAP's base64 type support.</li>
972	<li>SOAPTimeInstant -> SOAPDateTime. Following XML Schema PR.</li>
973	<li>SOAPStruct can have multiple accessor which have same name.
974	Should I separate it from original SOAPStruct?</li>
975	<li>Unknown attribute in Header Item raised an exception. Omitted.</li>
976	<li>Router can handle methods which belong to different namespace.</li>
977	<li>Added an option to allow unqualified SOAP element.</li>
978	<li>Added Apache's Map type support. Ruby's Hash are mapped to it now.
979	(Ruby's Hash marshalled by 1.1 processor in the old way can be unmarshalled,
980	but 1.2 processor marshals it in the new way and 1.1 processor does not
981	unmarshals it into Hash. Incompatibility between SOAP4R/1.2 and 1.1)</li>
982	<li>Unknown type 'unknown:SOAPStruct' was incorrectly unmarshalled into SOAPStruct. Fixed.</li>
983	<li>Added utility methods map! and members to SOAPArray and SOAPStruct.</li>
984	<li>Added methods request, response, and fault to SOAPBody.</li>
985	</ul></dd>
986
987	<dt>1.1.0 - March 23, 2001</dt>
988	<dd>Made many changes.
989	Since it is tested only for my limited use, please be careful to use.
990	Any comments especially "cannot connect to XXX implementation" are welcomed.
991	Feel free sending mail to
992	<a href="mailto:nakahiro@sarion.co.jp" class="path">nakahiro@sarion.co.jp</a>.
993
994	<ul>
995	<li>Added RPC server support.</li>
996	<li>Divided RPC client/server implementation from core.</li>
997	<li>Added Date, Hash type support. (Unknown type is converted to Struct as usual)</li>
998	<li>Adopted Date in date3.rb by Funaba-san instead of Time as TimeInstant.</li>
999	<li>Many encoding/decoding bugs around SOAPArray and SOAPStruct were fixed.</li>
1000	</ul></dd>
1001
1002	<dt>1.0.2 - November 11, 2000</dt>
1003	<dd>Since the previous package dated, refreshes some points.
1004	<ul>
1005	<li>Ruby: ruby 1.6.x</li>
1006	<li>uri.rb: 4.22</li>
1007	<li>sample: xml-soap/2.0</li>
1008	</ul></dd>
1009
1010	<dt>1.0.1 - July 27, 2000</dt>
1011	<dd>Handles SOAP/1.1 arrays.
1012	1.0.0 cannot handles SOAP/1.1 arrays...
1013	Bare in mind there still be many
1014	<a href="#restrictions">restrictions</a>
1015	around SOAP arrays.</dd>
1016
1017	<dt>1.0.0 - July 17, 2000</dt>
1018	<dd>It is the initial released version of SOAP4R. :-)</dd>
1019	</dl>
1020
1021	<h2 id="author" name="author">10. Author</h2>
1022
1023	<dl>
1024	<dt>Name</dt>
1025	<dd>NAKAMURA, Hiroshi (aka NaHi or nakahiro)</dd>
1026
1027	<dt>E-mail</dt>
1028	<dd><a href="mailto:nakahiro@sarion.co.jp" class="path">nakahiro@sarion.co.jp</a></dd>
1029
1030	<dt>URL</dt>
1031	<dd><a href="http://www.jin.gr.jp/~nahi/" class="path">http://www.jin.gr.jp/~nahi/</a> (Japanese)</dd>
1032	</dl>
1033
1034	<h2 id="copyright" name="copyright">11. Copyright</h2>
1035
1036	<p style="text-align: center;">
1037	SOAP4R<br />
1038	Copyright © 2000, 2001, 2002 NAKAMURA, Hiroshi.
1039	</p>
1040
1041	<p>
1042	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.
1043	</p>
1044
1045	<p>
1046	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.
1047	See the GNU General Public License(the file named `COPYING') for more details.
1048	</p>
1049
1050	<p>
1051	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.
1052	</p>
1053
1054	</div>
1055
1056	<hr />
1057
1058	<div class="footer">
1059	<address>
1060	<a href="http://www.jin.gr.jp/~nahi/Ruby/SOAP4R/">SOAP4R</a>.<br />
1061	Copyright © 2000, 2001, 2002
1062	<a href="http://www.jin.gr.jp/~nahi/">NAKAMURA, Hiroshi</a>.
1063	</address>
1064	</div>
1065	</body>
1066	</html>

Note: See TracBrowser for help on using the browser.

root/tags/RELEASE_1_4_3/RELEASE_en.html

Download in other formats: