2004-07-03 09:33:20 -04:00
|
|
|
# WSDL4R - Creating class code support from WSDL.
|
|
|
|
# Copyright (C) 2004 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, or any later version.
|
|
|
|
|
|
|
|
|
|
|
|
require 'wsdl/info'
|
|
|
|
require 'soap/mapping'
|
|
|
|
require 'soap/mapping/typeMap'
|
|
|
|
require 'xsd/codegen/gensupport'
|
|
|
|
|
|
|
|
|
|
|
|
module WSDL
|
|
|
|
module SOAP
|
|
|
|
|
|
|
|
|
|
|
|
module ClassDefCreatorSupport
|
|
|
|
include XSD::CodeGen::GenSupport
|
|
|
|
|
|
|
|
def create_class_name(qname)
|
|
|
|
if klass = basetype_mapped_class(qname)
|
* lib/{soap,wsdl,xsd}, test/{soap,wsdl,xsd}: imported soap4r/1.5.4.
== 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. closes #70.
* 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.
* sample/{soap,wsdl}: removed.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@8500 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-05-22 09:03:38 -04:00
|
|
|
::SOAP::Mapping::DefaultRegistry.find_mapped_obj_class(klass).name
|
2004-07-03 09:33:20 -04:00
|
|
|
else
|
|
|
|
safeconstname(qname.name)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def basetype_mapped_class(name)
|
|
|
|
::SOAP::TypeMap[name]
|
|
|
|
end
|
|
|
|
|
|
|
|
def dump_method_signature(operation)
|
|
|
|
name = operation.name.name
|
|
|
|
input = operation.input
|
|
|
|
output = operation.output
|
|
|
|
fault = operation.fault
|
|
|
|
signature = "#{ name }#{ dump_inputparam(input) }"
|
|
|
|
str = <<__EOD__
|
|
|
|
# SYNOPSIS
|
|
|
|
# #{name}#{dump_inputparam(input)}
|
|
|
|
#
|
|
|
|
# ARGS
|
|
|
|
#{dump_inout_type(input).chomp}
|
|
|
|
#
|
|
|
|
# RETURNS
|
|
|
|
#{dump_inout_type(output).chomp}
|
|
|
|
#
|
|
|
|
__EOD__
|
|
|
|
unless fault.empty?
|
|
|
|
faultstr = (fault.collect { |f| dump_inout_type(f).chomp }).join(', ')
|
|
|
|
str <<<<__EOD__
|
|
|
|
# RAISES
|
|
|
|
# #{faultstr}
|
|
|
|
#
|
|
|
|
__EOD__
|
|
|
|
end
|
|
|
|
str
|
|
|
|
end
|
|
|
|
|
2004-12-20 08:50:15 -05:00
|
|
|
def dq(ele)
|
|
|
|
ele.dump
|
|
|
|
end
|
|
|
|
|
|
|
|
def ndq(ele)
|
|
|
|
ele.nil? ? 'nil' : dq(ele)
|
|
|
|
end
|
|
|
|
|
|
|
|
def sym(ele)
|
|
|
|
':' + ele
|
|
|
|
end
|
|
|
|
|
* lib/{soap,wsdl,xsd}, test/{soap,wsdl,xsd}: imported soap4r/1.5.4.
== 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. closes #70.
* 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.
* sample/{soap,wsdl}: removed.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@8500 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-05-22 09:03:38 -04:00
|
|
|
def dqname(qname)
|
|
|
|
qname.dump
|
|
|
|
end
|
|
|
|
|
2004-07-03 09:33:20 -04:00
|
|
|
private
|
|
|
|
|
|
|
|
def dump_inout_type(param)
|
|
|
|
if param
|
|
|
|
message = param.find_message
|
|
|
|
params = ""
|
|
|
|
message.parts.each do |part|
|
|
|
|
name = safevarname(part.name)
|
2004-12-20 08:50:15 -05:00
|
|
|
if part.type
|
|
|
|
typename = safeconstname(part.type.name)
|
|
|
|
params << add_at("# #{name}", "#{typename} - #{part.type}\n", 20)
|
|
|
|
elsif part.element
|
|
|
|
typename = safeconstname(part.element.name)
|
|
|
|
params << add_at("# #{name}", "#{typename} - #{part.element}\n", 20)
|
|
|
|
end
|
2004-07-03 09:33:20 -04:00
|
|
|
end
|
|
|
|
unless params.empty?
|
|
|
|
return params
|
|
|
|
end
|
|
|
|
end
|
|
|
|
"# N/A\n"
|
|
|
|
end
|
|
|
|
|
|
|
|
def dump_inputparam(input)
|
|
|
|
message = input.find_message
|
|
|
|
params = ""
|
|
|
|
message.parts.each do |part|
|
|
|
|
params << ", " unless params.empty?
|
|
|
|
params << safevarname(part.name)
|
|
|
|
end
|
|
|
|
if params.empty?
|
|
|
|
""
|
|
|
|
else
|
|
|
|
"(#{ params })"
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def add_at(base, str, pos)
|
|
|
|
if base.size >= pos
|
|
|
|
base + ' ' + str
|
|
|
|
else
|
|
|
|
base + ' ' * (pos - base.size) + str
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
|
|
end
|
|
|
|
end
|