reidiculous-actionwebservice 3.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (195) hide show
  1. data/CHANGELOG +320 -0
  2. data/MIT-LICENSE +21 -0
  3. data/README +381 -0
  4. data/Rakefile +180 -0
  5. data/TODO +32 -0
  6. data/examples/googlesearch/autoloading/google_search_api.rb +50 -0
  7. data/examples/googlesearch/autoloading/google_search_controller.rb +57 -0
  8. data/examples/googlesearch/delegated/google_search_service.rb +108 -0
  9. data/examples/googlesearch/delegated/search_controller.rb +7 -0
  10. data/examples/googlesearch/direct/google_search_api.rb +50 -0
  11. data/examples/googlesearch/direct/search_controller.rb +58 -0
  12. data/examples/metaWeblog/apis/blogger_api.rb +60 -0
  13. data/examples/metaWeblog/apis/blogger_service.rb +34 -0
  14. data/examples/metaWeblog/apis/meta_weblog_api.rb +67 -0
  15. data/examples/metaWeblog/apis/meta_weblog_service.rb +48 -0
  16. data/examples/metaWeblog/controllers/xmlrpc_controller.rb +16 -0
  17. data/generators/web_service/USAGE +28 -0
  18. data/generators/web_service/templates/api_definition.rb +5 -0
  19. data/generators/web_service/templates/controller.rb +8 -0
  20. data/generators/web_service/templates/functional_test.rb +19 -0
  21. data/generators/web_service/web_service_generator.rb +29 -0
  22. data/lib/action_web_service.rb +71 -0
  23. data/lib/action_web_service/api.rb +297 -0
  24. data/lib/action_web_service/base.rb +38 -0
  25. data/lib/action_web_service/casting.rb +149 -0
  26. data/lib/action_web_service/client.rb +3 -0
  27. data/lib/action_web_service/client/base.rb +28 -0
  28. data/lib/action_web_service/client/soap_client.rb +113 -0
  29. data/lib/action_web_service/client/xmlrpc_client.rb +58 -0
  30. data/lib/action_web_service/container.rb +3 -0
  31. data/lib/action_web_service/container/action_controller_container.rb +93 -0
  32. data/lib/action_web_service/container/delegated_container.rb +86 -0
  33. data/lib/action_web_service/container/direct_container.rb +69 -0
  34. data/lib/action_web_service/dispatcher.rb +2 -0
  35. data/lib/action_web_service/dispatcher/abstract.rb +207 -0
  36. data/lib/action_web_service/dispatcher/action_controller_dispatcher.rb +379 -0
  37. data/lib/action_web_service/invocation.rb +202 -0
  38. data/lib/action_web_service/protocol.rb +4 -0
  39. data/lib/action_web_service/protocol/abstract.rb +115 -0
  40. data/lib/action_web_service/protocol/discovery.rb +37 -0
  41. data/lib/action_web_service/protocol/soap_protocol.rb +176 -0
  42. data/lib/action_web_service/protocol/soap_protocol/marshaler.rb +242 -0
  43. data/lib/action_web_service/protocol/xmlrpc_protocol.rb +122 -0
  44. data/lib/action_web_service/scaffolding.rb +281 -0
  45. data/lib/action_web_service/soap/attachment.rb +107 -0
  46. data/lib/action_web_service/soap/baseData.rb +942 -0
  47. data/lib/action_web_service/soap/element.rb +258 -0
  48. data/lib/action_web_service/soap/encodingstyle/aspDotNetHandler.rb +213 -0
  49. data/lib/action_web_service/soap/encodingstyle/handler.rb +100 -0
  50. data/lib/action_web_service/soap/encodingstyle/literalHandler.rb +226 -0
  51. data/lib/action_web_service/soap/encodingstyle/soapHandler.rb +582 -0
  52. data/lib/action_web_service/soap/generator.rb +268 -0
  53. data/lib/action_web_service/soap/header/handler.rb +57 -0
  54. data/lib/action_web_service/soap/header/handlerset.rb +70 -0
  55. data/lib/action_web_service/soap/header/simplehandler.rb +44 -0
  56. data/lib/action_web_service/soap/httpconfigloader.rb +119 -0
  57. data/lib/action_web_service/soap/mapping.rb +10 -0
  58. data/lib/action_web_service/soap/mapping/factory.rb +355 -0
  59. data/lib/action_web_service/soap/mapping/mapping.rb +381 -0
  60. data/lib/action_web_service/soap/mapping/registry.rb +541 -0
  61. data/lib/action_web_service/soap/mapping/rubytypeFactory.rb +475 -0
  62. data/lib/action_web_service/soap/mapping/typeMap.rb +50 -0
  63. data/lib/action_web_service/soap/mapping/wsdlencodedregistry.rb +280 -0
  64. data/lib/action_web_service/soap/mapping/wsdlliteralregistry.rb +418 -0
  65. data/lib/action_web_service/soap/marshal.rb +59 -0
  66. data/lib/action_web_service/soap/mimemessage.rb +240 -0
  67. data/lib/action_web_service/soap/netHttpClient.rb +190 -0
  68. data/lib/action_web_service/soap/parser.rb +251 -0
  69. data/lib/action_web_service/soap/processor.rb +66 -0
  70. data/lib/action_web_service/soap/property.rb +333 -0
  71. data/lib/action_web_service/soap/rpc/cgistub.rb +206 -0
  72. data/lib/action_web_service/soap/rpc/driver.rb +254 -0
  73. data/lib/action_web_service/soap/rpc/element.rb +325 -0
  74. data/lib/action_web_service/soap/rpc/httpserver.rb +129 -0
  75. data/lib/action_web_service/soap/rpc/proxy.rb +497 -0
  76. data/lib/action_web_service/soap/rpc/router.rb +594 -0
  77. data/lib/action_web_service/soap/rpc/rpc.rb +25 -0
  78. data/lib/action_web_service/soap/rpc/soaplet.rb +162 -0
  79. data/lib/action_web_service/soap/rpc/standaloneServer.rb +43 -0
  80. data/lib/action_web_service/soap/soap.rb +140 -0
  81. data/lib/action_web_service/soap/streamHandler.rb +229 -0
  82. data/lib/action_web_service/soap/wsdlDriver.rb +575 -0
  83. data/lib/action_web_service/struct.rb +64 -0
  84. data/lib/action_web_service/support/class_inheritable_options.rb +28 -0
  85. data/lib/action_web_service/support/signature_types.rb +227 -0
  86. data/lib/action_web_service/test_invoke.rb +110 -0
  87. data/lib/action_web_service/version.rb +9 -0
  88. data/lib/action_web_service/wsdl/binding.rb +65 -0
  89. data/lib/action_web_service/wsdl/data.rb +64 -0
  90. data/lib/action_web_service/wsdl/definitions.rb +250 -0
  91. data/lib/action_web_service/wsdl/documentation.rb +32 -0
  92. data/lib/action_web_service/wsdl/import.rb +80 -0
  93. data/lib/action_web_service/wsdl/importer.rb +38 -0
  94. data/lib/action_web_service/wsdl/info.rb +39 -0
  95. data/lib/action_web_service/wsdl/message.rb +54 -0
  96. data/lib/action_web_service/wsdl/operation.rb +130 -0
  97. data/lib/action_web_service/wsdl/operationBinding.rb +108 -0
  98. data/lib/action_web_service/wsdl/param.rb +85 -0
  99. data/lib/action_web_service/wsdl/parser.rb +163 -0
  100. data/lib/action_web_service/wsdl/part.rb +52 -0
  101. data/lib/action_web_service/wsdl/port.rb +84 -0
  102. data/lib/action_web_service/wsdl/portType.rb +73 -0
  103. data/lib/action_web_service/wsdl/service.rb +61 -0
  104. data/lib/action_web_service/wsdl/soap/address.rb +40 -0
  105. data/lib/action_web_service/wsdl/soap/binding.rb +49 -0
  106. data/lib/action_web_service/wsdl/soap/body.rb +56 -0
  107. data/lib/action_web_service/wsdl/soap/cgiStubCreator.rb +76 -0
  108. data/lib/action_web_service/wsdl/soap/classDefCreator.rb +314 -0
  109. data/lib/action_web_service/wsdl/soap/classDefCreatorSupport.rb +126 -0
  110. data/lib/action_web_service/wsdl/soap/clientSkeltonCreator.rb +78 -0
  111. data/lib/action_web_service/wsdl/soap/complexType.rb +161 -0
  112. data/lib/action_web_service/wsdl/soap/data.rb +42 -0
  113. data/lib/action_web_service/wsdl/soap/definitions.rb +149 -0
  114. data/lib/action_web_service/wsdl/soap/driverCreator.rb +95 -0
  115. data/lib/action_web_service/wsdl/soap/element.rb +28 -0
  116. data/lib/action_web_service/wsdl/soap/fault.rb +56 -0
  117. data/lib/action_web_service/wsdl/soap/header.rb +86 -0
  118. data/lib/action_web_service/wsdl/soap/headerfault.rb +56 -0
  119. data/lib/action_web_service/wsdl/soap/mappingRegistryCreator.rb +92 -0
  120. data/lib/action_web_service/wsdl/soap/methodDefCreator.rb +228 -0
  121. data/lib/action_web_service/wsdl/soap/operation.rb +122 -0
  122. data/lib/action_web_service/wsdl/soap/servantSkeltonCreator.rb +67 -0
  123. data/lib/action_web_service/wsdl/soap/standaloneServerStubCreator.rb +85 -0
  124. data/lib/action_web_service/wsdl/soap/wsdl2ruby.rb +176 -0
  125. data/lib/action_web_service/wsdl/types.rb +43 -0
  126. data/lib/action_web_service/wsdl/wsdl.rb +23 -0
  127. data/lib/action_web_service/wsdl/xmlSchema/all.rb +69 -0
  128. data/lib/action_web_service/wsdl/xmlSchema/annotation.rb +34 -0
  129. data/lib/action_web_service/wsdl/xmlSchema/any.rb +56 -0
  130. data/lib/action_web_service/wsdl/xmlSchema/attribute.rb +127 -0
  131. data/lib/action_web_service/wsdl/xmlSchema/choice.rb +69 -0
  132. data/lib/action_web_service/wsdl/xmlSchema/complexContent.rb +92 -0
  133. data/lib/action_web_service/wsdl/xmlSchema/complexType.rb +139 -0
  134. data/lib/action_web_service/wsdl/xmlSchema/content.rb +96 -0
  135. data/lib/action_web_service/wsdl/xmlSchema/data.rb +80 -0
  136. data/lib/action_web_service/wsdl/xmlSchema/element.rb +154 -0
  137. data/lib/action_web_service/wsdl/xmlSchema/enumeration.rb +36 -0
  138. data/lib/action_web_service/wsdl/xmlSchema/import.rb +65 -0
  139. data/lib/action_web_service/wsdl/xmlSchema/importer.rb +87 -0
  140. data/lib/action_web_service/wsdl/xmlSchema/include.rb +54 -0
  141. data/lib/action_web_service/wsdl/xmlSchema/length.rb +35 -0
  142. data/lib/action_web_service/wsdl/xmlSchema/parser.rb +166 -0
  143. data/lib/action_web_service/wsdl/xmlSchema/pattern.rb +36 -0
  144. data/lib/action_web_service/wsdl/xmlSchema/schema.rb +143 -0
  145. data/lib/action_web_service/wsdl/xmlSchema/sequence.rb +69 -0
  146. data/lib/action_web_service/wsdl/xmlSchema/simpleContent.rb +65 -0
  147. data/lib/action_web_service/wsdl/xmlSchema/simpleExtension.rb +54 -0
  148. data/lib/action_web_service/wsdl/xmlSchema/simpleRestriction.rb +73 -0
  149. data/lib/action_web_service/wsdl/xmlSchema/simpleType.rb +73 -0
  150. data/lib/action_web_service/wsdl/xmlSchema/unique.rb +34 -0
  151. data/lib/action_web_service/wsdl/xmlSchema/xsd2ruby.rb +107 -0
  152. data/lib/action_web_service/xsd/charset.rb +187 -0
  153. data/lib/action_web_service/xsd/codegen.rb +12 -0
  154. data/lib/action_web_service/xsd/codegen/classdef.rb +203 -0
  155. data/lib/action_web_service/xsd/codegen/commentdef.rb +34 -0
  156. data/lib/action_web_service/xsd/codegen/gensupport.rb +166 -0
  157. data/lib/action_web_service/xsd/codegen/methoddef.rb +63 -0
  158. data/lib/action_web_service/xsd/codegen/moduledef.rb +191 -0
  159. data/lib/action_web_service/xsd/datatypes.rb +1269 -0
  160. data/lib/action_web_service/xsd/datatypes1999.rb +20 -0
  161. data/lib/action_web_service/xsd/iconvcharset.rb +33 -0
  162. data/lib/action_web_service/xsd/mapping.rb +42 -0
  163. data/lib/action_web_service/xsd/namedelements.rb +95 -0
  164. data/lib/action_web_service/xsd/ns.rb +140 -0
  165. data/lib/action_web_service/xsd/qname.rb +78 -0
  166. data/lib/action_web_service/xsd/xmlparser.rb +61 -0
  167. data/lib/action_web_service/xsd/xmlparser/parser.rb +96 -0
  168. data/lib/action_web_service/xsd/xmlparser/rexmlparser.rb +54 -0
  169. data/lib/action_web_service/xsd/xmlparser/xmlparser.rb +50 -0
  170. data/lib/action_web_service/xsd/xmlparser/xmlscanner.rb +147 -0
  171. data/lib/actionwebservice.rb +1 -0
  172. data/setup.rb +1379 -0
  173. data/test/abstract_client.rb +183 -0
  174. data/test/abstract_dispatcher.rb +548 -0
  175. data/test/abstract_unit.rb +45 -0
  176. data/test/api_test.rb +103 -0
  177. data/test/apis/auto_load_api.rb +3 -0
  178. data/test/apis/broken_auto_load_api.rb +2 -0
  179. data/test/base_test.rb +42 -0
  180. data/test/casting_test.rb +95 -0
  181. data/test/client_soap_test.rb +156 -0
  182. data/test/client_xmlrpc_test.rb +153 -0
  183. data/test/container_test.rb +73 -0
  184. data/test/dispatcher_action_controller_soap_test.rb +139 -0
  185. data/test/dispatcher_action_controller_xmlrpc_test.rb +59 -0
  186. data/test/fixtures/db_definitions/mysql.sql +8 -0
  187. data/test/fixtures/db_definitions/sqlite3.sql +8 -0
  188. data/test/fixtures/users.yml +12 -0
  189. data/test/gencov +3 -0
  190. data/test/invocation_test.rb +185 -0
  191. data/test/run +6 -0
  192. data/test/scaffolded_controller_test.rb +146 -0
  193. data/test/struct_test.rb +52 -0
  194. data/test/test_invoke_test.rb +112 -0
  195. metadata +281 -0
@@ -0,0 +1,100 @@
1
+ # SOAP4R - EncodingStyle handler library
2
+ # Copyright (C) 2001, 2003 NAKAMURA, Hiroshi <nahi@ruby-lang.org>.
3
+
4
+ # This program is copyrighted free software by NAKAMURA, Hiroshi. You can
5
+ # redistribute it and/or modify it under the same terms of Ruby's license;
6
+ # either the dual license version in 2003, or any later version.
7
+
8
+
9
+ require 'action_web_service/soap/soap'
10
+ require 'action_web_service/soap/baseData'
11
+ require 'action_web_service/soap/element'
12
+
13
+
14
+ module SOAP
15
+ module EncodingStyle
16
+
17
+
18
+ class Handler
19
+ @@handlers = {}
20
+
21
+ class EncodingStyleError < Error; end
22
+
23
+ class << self
24
+ def uri
25
+ self::Namespace
26
+ end
27
+
28
+ def handler(uri)
29
+ @@handlers[uri]
30
+ end
31
+
32
+ def each
33
+ @@handlers.each do |key, value|
34
+ yield(value)
35
+ end
36
+ end
37
+
38
+ private
39
+
40
+ def add_handler
41
+ @@handlers[self.uri] = self
42
+ end
43
+ end
44
+
45
+ attr_reader :charset
46
+ attr_accessor :generate_explicit_type
47
+ def decode_typemap=(definedtypes)
48
+ @decode_typemap = definedtypes
49
+ end
50
+
51
+ def initialize(charset)
52
+ @charset = charset
53
+ @generate_explicit_type = true
54
+ @decode_typemap = nil
55
+ end
56
+
57
+ ###
58
+ ## encode interface.
59
+ #
60
+ # Returns a XML instance as a string.
61
+ def encode_data(generator, ns, data, parent)
62
+ raise NotImplementError
63
+ end
64
+
65
+ def encode_data_end(generator, ns, data, parent)
66
+ raise NotImplementError
67
+ end
68
+
69
+ def encode_prologue
70
+ end
71
+
72
+ def encode_epilogue
73
+ end
74
+
75
+ ###
76
+ ## decode interface.
77
+ #
78
+ # Returns SOAP/OM data.
79
+ def decode_tag(ns, name, attrs, parent)
80
+ raise NotImplementError.new('Method decode_tag must be defined in derived class.')
81
+ end
82
+
83
+ def decode_tag_end(ns, name)
84
+ raise NotImplementError.new('Method decode_tag_end must be defined in derived class.')
85
+ end
86
+
87
+ def decode_text(ns, text)
88
+ raise NotImplementError.new('Method decode_text must be defined in derived class.')
89
+ end
90
+
91
+ def decode_prologue
92
+ end
93
+
94
+ def decode_epilogue
95
+ end
96
+ end
97
+
98
+
99
+ end
100
+ end
@@ -0,0 +1,226 @@
1
+ # SOAP4R - XML Literal EncodingStyle handler library
2
+ # Copyright (C) 2001, 2003-2005 NAKAMURA, Hiroshi <nahi@ruby-lang.org>.
3
+
4
+ # This program is copyrighted free software by NAKAMURA, Hiroshi. You can
5
+ # redistribute it and/or modify it under the same terms of Ruby's license;
6
+ # either the dual license version in 2003, or any later version.
7
+
8
+
9
+ require 'action_web_service/soap/encodingstyle/handler'
10
+
11
+
12
+ module SOAP
13
+ module EncodingStyle
14
+
15
+
16
+ class LiteralHandler < Handler
17
+ Namespace = SOAP::LiteralNamespace
18
+ add_handler
19
+
20
+ def initialize(charset = nil)
21
+ super(charset)
22
+ @textbuf = ''
23
+ end
24
+
25
+
26
+ ###
27
+ ## encode interface.
28
+ #
29
+ def encode_data(generator, ns, data, parent)
30
+ attrs = {}
31
+ name = generator.encode_name(ns, data, attrs)
32
+ data.extraattr.each do |k, v|
33
+ # ToDo: check generator.attributeformdefault here
34
+ if k.is_a?(XSD::QName)
35
+ if k.namespace
36
+ SOAPGenerator.assign_ns(attrs, ns, k.namespace)
37
+ k = ns.name(k)
38
+ else
39
+ k = k.name
40
+ end
41
+ end
42
+ attrs[k] = v
43
+ end
44
+ case data
45
+ when SOAPRawString
46
+ generator.encode_tag(name, attrs)
47
+ generator.encode_rawstring(data.to_s)
48
+ when XSD::XSDString
49
+ generator.encode_tag(name, attrs)
50
+ str = data.to_s
51
+ str = XSD::Charset.encoding_to_xml(str, @charset) if @charset
52
+ generator.encode_string(str)
53
+ when XSD::XSDAnySimpleType
54
+ generator.encode_tag(name, attrs)
55
+ generator.encode_string(data.to_s)
56
+ when SOAPStruct
57
+ generator.encode_tag(name, attrs)
58
+ data.each do |key, value|
59
+ generator.encode_child(ns, value, data)
60
+ end
61
+ when SOAPArray
62
+ generator.encode_tag(name, attrs)
63
+ data.traverse do |child, *rank|
64
+ data.position = nil
65
+ generator.encode_child(ns, child, data)
66
+ end
67
+ when SOAPElement
68
+ # passes 2 times for simplifying namespace definition
69
+ data.each do |key, value|
70
+ if value.elename.namespace
71
+ SOAPGenerator.assign_ns(attrs, ns, value.elename.namespace)
72
+ end
73
+ end
74
+ generator.encode_tag(name, attrs)
75
+ generator.encode_rawstring(data.text) if data.text
76
+ data.each do |key, value|
77
+ generator.encode_child(ns, value, data)
78
+ end
79
+ else
80
+ raise EncodingStyleError.new(
81
+ "unknown object:#{data} in this encodingStyle")
82
+ end
83
+ end
84
+
85
+ def encode_data_end(generator, ns, data, parent)
86
+ name = generator.encode_name_end(ns, data)
87
+ cr = (data.is_a?(SOAPCompoundtype) or
88
+ (data.is_a?(SOAPElement) and !data.text))
89
+ generator.encode_tag_end(name, cr)
90
+ end
91
+
92
+
93
+ ###
94
+ ## decode interface.
95
+ #
96
+ class SOAPTemporalObject
97
+ attr_accessor :parent
98
+
99
+ def initialize
100
+ @parent = nil
101
+ end
102
+ end
103
+
104
+ class SOAPUnknown < SOAPTemporalObject
105
+ def initialize(handler, elename, extraattr)
106
+ super()
107
+ @handler = handler
108
+ @elename = elename
109
+ @extraattr = extraattr
110
+ end
111
+
112
+ def as_element
113
+ o = SOAPElement.decode(@elename)
114
+ o.parent = @parent
115
+ o.extraattr.update(@extraattr)
116
+ @handler.decode_parent(@parent, o)
117
+ o
118
+ end
119
+
120
+ def as_string
121
+ o = SOAPString.decode(@elename)
122
+ o.parent = @parent
123
+ o.extraattr.update(@extraattr)
124
+ @handler.decode_parent(@parent, o)
125
+ o
126
+ end
127
+
128
+ def as_nil
129
+ o = SOAPNil.decode(@elename)
130
+ o.parent = @parent
131
+ o.extraattr.update(@extraattr)
132
+ @handler.decode_parent(@parent, o)
133
+ o
134
+ end
135
+ end
136
+
137
+ def decode_tag(ns, elename, attrs, parent)
138
+ @textbuf = ''
139
+ o = SOAPUnknown.new(self, elename, decode_attrs(ns, attrs))
140
+ o.parent = parent
141
+ o
142
+ end
143
+
144
+ def decode_tag_end(ns, node)
145
+ o = node.node
146
+ if o.is_a?(SOAPUnknown)
147
+ newnode = if /\A\s*\z/ =~ @textbuf
148
+ o.as_element
149
+ else
150
+ o.as_string
151
+ end
152
+ node.replace_node(newnode)
153
+ o = node.node
154
+ end
155
+
156
+ decode_textbuf(o)
157
+ @textbuf = ''
158
+ end
159
+
160
+ def decode_text(ns, text)
161
+ # @textbuf is set at decode_tag_end.
162
+ @textbuf << text
163
+ end
164
+
165
+ def decode_attrs(ns, attrs)
166
+ extraattr = {}
167
+ attrs.each do |key, value|
168
+ qname = ns.parse_local(key)
169
+ extraattr[qname] = value
170
+ end
171
+ extraattr
172
+ end
173
+
174
+ def decode_prologue
175
+ end
176
+
177
+ def decode_epilogue
178
+ end
179
+
180
+ def decode_parent(parent, node)
181
+ return unless parent.node
182
+ case parent.node
183
+ when SOAPUnknown
184
+ newparent = parent.node.as_element
185
+ node.parent = newparent
186
+ parent.replace_node(newparent)
187
+ decode_parent(parent, node)
188
+ when SOAPElement
189
+ parent.node.add(node)
190
+ node.parent = parent.node
191
+ when SOAPStruct
192
+ parent.node.add(node.elename.name, node)
193
+ node.parent = parent.node
194
+ when SOAPArray
195
+ if node.position
196
+ parent.node[*(decode_arypos(node.position))] = node
197
+ parent.node.sparse = true
198
+ else
199
+ parent.node.add(node)
200
+ end
201
+ node.parent = parent.node
202
+ else
203
+ raise EncodingStyleError.new("illegal parent: #{parent.node}")
204
+ end
205
+ end
206
+
207
+ private
208
+
209
+ def decode_textbuf(node)
210
+ if node.is_a?(XSD::XSDString)
211
+ if @charset
212
+ node.set(XSD::Charset.encoding_from_xml(@textbuf, @charset))
213
+ else
214
+ node.set(@textbuf)
215
+ end
216
+ else
217
+ # Nothing to do...
218
+ end
219
+ end
220
+ end
221
+
222
+ LiteralHandler.new
223
+
224
+
225
+ end
226
+ end
@@ -0,0 +1,582 @@
1
+ # SOAP4R - SOAP EncodingStyle handler library
2
+ # Copyright (C) 2001, 2003, 2005 NAKAMURA, Hiroshi <nahi@ruby-lang.org>.
3
+
4
+ # This program is copyrighted free software by NAKAMURA, Hiroshi. You can
5
+ # redistribute it and/or modify it under the same terms of Ruby's license;
6
+ # either the dual license version in 2003, or any later version.
7
+
8
+
9
+ require 'action_web_service/soap/encodingstyle/handler'
10
+
11
+
12
+ module SOAP
13
+ module EncodingStyle
14
+
15
+
16
+ class SOAPHandler < Handler
17
+ Namespace = SOAP::EncodingNamespace
18
+ add_handler
19
+
20
+ def initialize(charset = nil)
21
+ super(charset)
22
+ @refpool = []
23
+ @idpool = []
24
+ @textbuf = ''
25
+ @is_first_top_ele = true
26
+ end
27
+
28
+
29
+ ###
30
+ ## encode interface.
31
+ #
32
+ def encode_data(generator, ns, data, parent)
33
+ attrs = encode_attrs(generator, ns, data, parent)
34
+ if parent && parent.is_a?(SOAPArray) && parent.position
35
+ attrs[ns.name(AttrPositionName)] = "[#{parent.position.join(',')}]"
36
+ end
37
+ name = generator.encode_name(ns, data, attrs)
38
+ case data
39
+ when SOAPReference
40
+ attrs['href'] = data.refidstr
41
+ generator.encode_tag(name, attrs)
42
+ when SOAPExternalReference
43
+ data.referred
44
+ attrs['href'] = data.refidstr
45
+ generator.encode_tag(name, attrs)
46
+ when SOAPRawString
47
+ generator.encode_tag(name, attrs)
48
+ generator.encode_rawstring(data.to_s)
49
+ when XSD::XSDString
50
+ generator.encode_tag(name, attrs)
51
+ generator.encode_string(@charset ?
52
+ XSD::Charset.encoding_to_xml(data.to_s, @charset) : data.to_s)
53
+ when XSD::XSDAnySimpleType
54
+ generator.encode_tag(name, attrs)
55
+ generator.encode_string(data.to_s)
56
+ when SOAPStruct
57
+ generator.encode_tag(name, attrs)
58
+ data.each do |key, value|
59
+ generator.encode_child(ns, value, data)
60
+ end
61
+ when SOAPArray
62
+ generator.encode_tag(name, attrs)
63
+ data.traverse do |child, *rank|
64
+ data.position = data.sparse ? rank : nil
65
+ generator.encode_child(ns, child, data)
66
+ end
67
+ else
68
+ raise EncodingStyleError.new(
69
+ "unknown object:#{data} in this encodingStyle")
70
+ end
71
+ end
72
+
73
+ def encode_data_end(generator, ns, data, parent)
74
+ name = generator.encode_name_end(ns, data)
75
+ cr = data.is_a?(SOAPCompoundtype)
76
+ generator.encode_tag_end(name, cr)
77
+ end
78
+
79
+
80
+ ###
81
+ ## decode interface.
82
+ #
83
+ class SOAPTemporalObject
84
+ attr_accessor :parent
85
+ attr_accessor :position
86
+ attr_accessor :id
87
+ attr_accessor :root
88
+
89
+ def initialize
90
+ @parent = nil
91
+ @position = nil
92
+ @id = nil
93
+ @root = nil
94
+ end
95
+ end
96
+
97
+ class SOAPUnknown < SOAPTemporalObject
98
+ attr_reader :type
99
+ attr_accessor :definedtype
100
+ attr_reader :extraattr
101
+
102
+ def initialize(handler, elename, type, extraattr)
103
+ super()
104
+ @handler = handler
105
+ @elename = elename
106
+ @type = type
107
+ @extraattr = extraattr
108
+ @definedtype = nil
109
+ end
110
+
111
+ def as_struct
112
+ o = SOAPStruct.decode(@elename, @type)
113
+ o.id = @id
114
+ o.root = @root
115
+ o.parent = @parent
116
+ o.position = @position
117
+ o.extraattr.update(@extraattr)
118
+ @handler.decode_parent(@parent, o)
119
+ o
120
+ end
121
+
122
+ def as_string
123
+ o = SOAPString.decode(@elename)
124
+ o.id = @id
125
+ o.root = @root
126
+ o.parent = @parent
127
+ o.position = @position
128
+ o.extraattr.update(@extraattr)
129
+ @handler.decode_parent(@parent, o)
130
+ o
131
+ end
132
+
133
+ def as_nil
134
+ o = SOAPNil.decode(@elename)
135
+ o.id = @id
136
+ o.root = @root
137
+ o.parent = @parent
138
+ o.position = @position
139
+ o.extraattr.update(@extraattr)
140
+ @handler.decode_parent(@parent, o)
141
+ o
142
+ end
143
+ end
144
+
145
+ def decode_tag(ns, elename, attrs, parent)
146
+ @textbuf = ''
147
+ is_nil, type, arytype, root, offset, position, href, id, extraattr =
148
+ decode_attrs(ns, attrs)
149
+ o = nil
150
+ if is_nil
151
+ o = SOAPNil.decode(elename)
152
+ elsif href
153
+ o = SOAPReference.decode(elename, href)
154
+ @refpool << o
155
+ elsif @decode_typemap
156
+ o = decode_tag_by_wsdl(ns, elename, type, parent.node, arytype, extraattr)
157
+ else
158
+ o = decode_tag_by_type(ns, elename, type, parent.node, arytype, extraattr)
159
+ end
160
+
161
+ if o.is_a?(SOAPArray)
162
+ if offset
163
+ o.offset = decode_arypos(offset)
164
+ o.sparse = true
165
+ else
166
+ o.sparse = false
167
+ end
168
+ end
169
+
170
+ o.parent = parent
171
+ o.id = id
172
+ o.root = root
173
+ o.position = position
174
+
175
+ unless o.is_a?(SOAPTemporalObject)
176
+ @idpool << o if o.id
177
+ decode_parent(parent, o)
178
+ end
179
+ o
180
+ end
181
+
182
+ def decode_tag_end(ns, node)
183
+ o = node.node
184
+ if o.is_a?(SOAPUnknown)
185
+ newnode = if /\A\s*\z/ =~ @textbuf
186
+ o.as_struct
187
+ else
188
+ o.as_string
189
+ end
190
+ if newnode.id
191
+ @idpool << newnode
192
+ end
193
+ node.replace_node(newnode)
194
+ o = node.node
195
+ end
196
+ decode_textbuf(o)
197
+ # unlink definedtype
198
+ o.definedtype = nil
199
+ end
200
+
201
+ def decode_text(ns, text)
202
+ @textbuf << text
203
+ end
204
+
205
+ def decode_prologue
206
+ @refpool.clear
207
+ @idpool.clear
208
+ @is_first_top_ele = true
209
+ end
210
+
211
+ def decode_epilogue
212
+ decode_resolve_id
213
+ end
214
+
215
+ def decode_parent(parent, node)
216
+ return unless parent.node
217
+ case parent.node
218
+ when SOAPUnknown
219
+ newparent = parent.node.as_struct
220
+ node.parent = newparent
221
+ if newparent.id
222
+ @idpool << newparent
223
+ end
224
+ parent.replace_node(newparent)
225
+ decode_parent(parent, node)
226
+ when SOAPStruct
227
+ parent.node.add(node.elename.name, node)
228
+ node.parent = parent.node
229
+ when SOAPArray
230
+ if node.position
231
+ parent.node[*(decode_arypos(node.position))] = node
232
+ parent.node.sparse = true
233
+ else
234
+ parent.node.add(node)
235
+ end
236
+ node.parent = parent.node
237
+ else
238
+ raise EncodingStyleError.new("illegal parent: #{parent.node}")
239
+ end
240
+ end
241
+
242
+ private
243
+
244
+ def content_ranksize(typename)
245
+ typename.scan(/\[[\d,]*\]$/)[0]
246
+ end
247
+
248
+ def content_typename(typename)
249
+ typename.sub(/\[,*\]$/, '')
250
+ end
251
+
252
+ def create_arytype(ns, data)
253
+ XSD::QName.new(data.arytype.namespace,
254
+ content_typename(data.arytype.name) + "[#{data.size.join(',')}]")
255
+ end
256
+
257
+ def encode_attrs(generator, ns, data, parent)
258
+ attrs = {}
259
+ return attrs if data.is_a?(SOAPReference)
260
+
261
+ if !parent || parent.encodingstyle != EncodingNamespace
262
+ if @generate_explicit_type
263
+ SOAPGenerator.assign_ns(attrs, ns, EnvelopeNamespace)
264
+ attrs[ns.name(AttrEncodingStyleName)] = EncodingNamespace
265
+ end
266
+ data.encodingstyle = EncodingNamespace
267
+ end
268
+
269
+ if data.is_a?(SOAPNil)
270
+ attrs[ns.name(XSD::AttrNilName)] = XSD::NilValue
271
+ elsif @generate_explicit_type
272
+ if data.type.namespace
273
+ SOAPGenerator.assign_ns(attrs, ns, data.type.namespace)
274
+ end
275
+ if data.is_a?(SOAPArray)
276
+ if data.arytype.namespace
277
+ SOAPGenerator.assign_ns(attrs, ns, data.arytype.namespace)
278
+ end
279
+ SOAPGenerator.assign_ns(attrs, ns, EncodingNamespace)
280
+ attrs[ns.name(AttrArrayTypeName)] = ns.name(create_arytype(ns, data))
281
+ if data.type.name
282
+ attrs[ns.name(XSD::AttrTypeName)] = ns.name(data.type)
283
+ end
284
+ elsif parent && parent.is_a?(SOAPArray) && (parent.arytype == data.type)
285
+ # No need to add.
286
+ elsif !data.type.namespace
287
+ # No need to add.
288
+ else
289
+ attrs[ns.name(XSD::AttrTypeName)] = ns.name(data.type)
290
+ end
291
+ end
292
+
293
+ data.extraattr.each do |key, value|
294
+ SOAPGenerator.assign_ns(attrs, ns, key.namespace)
295
+ attrs[ns.name(key)] = encode_attr_value(generator, ns, key, value)
296
+ end
297
+ if data.id
298
+ attrs['id'] = data.id
299
+ end
300
+ attrs
301
+ end
302
+
303
+ def encode_attr_value(generator, ns, qname, value)
304
+ if value.is_a?(SOAPType)
305
+ ref = SOAPReference.new(value)
306
+ generator.add_reftarget(qname.name, value)
307
+ ref.refidstr
308
+ else
309
+ value.to_s
310
+ end
311
+ end
312
+
313
+ def decode_tag_by_wsdl(ns, elename, typestr, parent, arytypestr, extraattr)
314
+ o = nil
315
+ if parent.class == SOAPBody
316
+ # root element: should branch by root attribute?
317
+ if @is_first_top_ele
318
+ # Unqualified name is allowed here.
319
+ @is_first_top_ele = false
320
+ type = @decode_typemap[elename] ||
321
+ @decode_typemap.find_name(elename.name)
322
+ if type
323
+ o = SOAPStruct.new(elename)
324
+ o.definedtype = type
325
+ return o
326
+ end
327
+ end
328
+ # multi-ref element.
329
+ if typestr
330
+ typename = ns.parse(typestr)
331
+ typedef = @decode_typemap[typename]
332
+ if typedef
333
+ return decode_definedtype(elename, typename, typedef, arytypestr)
334
+ end
335
+ end
336
+ return decode_tag_by_type(ns, elename, typestr, parent, arytypestr,
337
+ extraattr)
338
+ end
339
+
340
+ if parent.type == XSD::AnyTypeName
341
+ return decode_tag_by_type(ns, elename, typestr, parent, arytypestr,
342
+ extraattr)
343
+ end
344
+
345
+ # parent.definedtype == nil means the parent is SOAPUnknown. SOAPUnknown
346
+ # is generated by decode_tag_by_type when its type is anyType.
347
+ parenttype = parent.definedtype || @decode_typemap[parent.type]
348
+ unless parenttype
349
+ return decode_tag_by_type(ns, elename, typestr, parent, arytypestr,
350
+ extraattr)
351
+ end
352
+
353
+ definedtype_name = parenttype.child_type(elename)
354
+ if definedtype_name and (klass = TypeMap[definedtype_name])
355
+ return decode_basetype(klass, elename)
356
+ elsif definedtype_name == XSD::AnyTypeName
357
+ return decode_tag_by_type(ns, elename, typestr, parent, arytypestr,
358
+ extraattr)
359
+ end
360
+
361
+ if definedtype_name
362
+ typedef = @decode_typemap[definedtype_name]
363
+ else
364
+ typedef = parenttype.child_defined_complextype(elename)
365
+ end
366
+ decode_definedtype(elename, definedtype_name, typedef, arytypestr)
367
+ end
368
+
369
+ def decode_definedtype(elename, typename, typedef, arytypestr)
370
+ unless typedef
371
+ raise EncodingStyleError.new("unknown type '#{typename}'")
372
+ end
373
+ if typedef.is_a?(::WSDL::XMLSchema::SimpleType)
374
+ decode_defined_simpletype(elename, typename, typedef, arytypestr)
375
+ else
376
+ decode_defined_complextype(elename, typename, typedef, arytypestr)
377
+ end
378
+ end
379
+
380
+ def decode_basetype(klass, elename)
381
+ klass.decode(elename)
382
+ end
383
+
384
+ def decode_defined_simpletype(elename, typename, typedef, arytypestr)
385
+ o = decode_basetype(TypeMap[typedef.base], elename)
386
+ o.definedtype = typedef
387
+ o
388
+ end
389
+
390
+ def decode_defined_complextype(elename, typename, typedef, arytypestr)
391
+ case typedef.compoundtype
392
+ when :TYPE_STRUCT, :TYPE_MAP
393
+ o = SOAPStruct.decode(elename, typename)
394
+ o.definedtype = typedef
395
+ return o
396
+ when :TYPE_ARRAY
397
+ expected_arytype = typedef.find_arytype
398
+ if arytypestr
399
+ actual_arytype = XSD::QName.new(expected_arytype.namespace,
400
+ content_typename(expected_arytype.name) <<
401
+ content_ranksize(arytypestr))
402
+ o = SOAPArray.decode(elename, typename, actual_arytype)
403
+ else
404
+ o = SOAPArray.new(typename, 1, expected_arytype)
405
+ o.elename = elename
406
+ end
407
+ o.definedtype = typedef
408
+ return o
409
+ when :TYPE_EMPTY
410
+ o = SOAPNil.decode(elename)
411
+ o.definedtype = typedef
412
+ return o
413
+ else
414
+ raise RuntimeError.new(
415
+ "Unknown kind of complexType: #{typedef.compoundtype}")
416
+ end
417
+ nil
418
+ end
419
+
420
+ def decode_tag_by_type(ns, elename, typestr, parent, arytypestr, extraattr)
421
+ if arytypestr
422
+ type = typestr ? ns.parse(typestr) : ValueArrayName
423
+ node = SOAPArray.decode(elename, type, ns.parse(arytypestr))
424
+ node.extraattr.update(extraattr)
425
+ return node
426
+ end
427
+
428
+ type = nil
429
+ if typestr
430
+ type = ns.parse(typestr)
431
+ elsif parent.is_a?(SOAPArray)
432
+ type = parent.arytype
433
+ else
434
+ # Since it's in dynamic(without any type) encoding process,
435
+ # assumes entity as its type itself.
436
+ # <SOAP-ENC:Array ...> => type Array in SOAP-ENC.
437
+ # <Country xmlns="foo"> => type Country in foo.
438
+ type = elename
439
+ end
440
+
441
+ if (klass = TypeMap[type])
442
+ node = decode_basetype(klass, elename)
443
+ node.extraattr.update(extraattr)
444
+ return node
445
+ end
446
+
447
+ # Unknown type... Struct or String
448
+ SOAPUnknown.new(self, elename, type, extraattr)
449
+ end
450
+
451
+ def decode_textbuf(node)
452
+ case node
453
+ when XSD::XSDHexBinary, XSD::XSDBase64Binary
454
+ node.set_encoded(@textbuf)
455
+ when XSD::XSDString
456
+ if @charset
457
+ @textbuf = XSD::Charset.encoding_from_xml(@textbuf, @charset)
458
+ end
459
+ if node.definedtype
460
+ node.definedtype.check_lexical_format(@textbuf)
461
+ end
462
+ node.set(@textbuf)
463
+ when SOAPNil
464
+ # Nothing to do.
465
+ when SOAPBasetype
466
+ node.set(@textbuf)
467
+ else
468
+ # Nothing to do...
469
+ end
470
+ @textbuf = ''
471
+ end
472
+
473
+ NilLiteralMap = {
474
+ 'true' => true,
475
+ '1' => true,
476
+ 'false' => false,
477
+ '0' => false
478
+ }
479
+ RootLiteralMap = {
480
+ '1' => 1,
481
+ '0' => 0
482
+ }
483
+ def decode_attrs(ns, attrs)
484
+ is_nil = false
485
+ type = nil
486
+ arytype = nil
487
+ root = nil
488
+ offset = nil
489
+ position = nil
490
+ href = nil
491
+ id = nil
492
+ extraattr = {}
493
+
494
+ attrs.each do |key, value|
495
+ qname = ns.parse(key)
496
+ case qname.namespace
497
+ when XSD::InstanceNamespace
498
+ case qname.name
499
+ when XSD::NilLiteral
500
+ is_nil = NilLiteralMap[value] or
501
+ raise EncodingStyleError.new("cannot accept attribute value: #{value} as the value of xsi:#{XSD::NilLiteral} (expected 'true', 'false', '1', or '0')")
502
+ next
503
+ when XSD::AttrType
504
+ type = value
505
+ next
506
+ end
507
+ when EncodingNamespace
508
+ case qname.name
509
+ when AttrArrayType
510
+ arytype = value
511
+ next
512
+ when AttrRoot
513
+ root = RootLiteralMap[value] or
514
+ raise EncodingStyleError.new(
515
+ "illegal root attribute value: #{value}")
516
+ next
517
+ when AttrOffset
518
+ offset = value
519
+ next
520
+ when AttrPosition
521
+ position = value
522
+ next
523
+ end
524
+ end
525
+ if key == 'href'
526
+ href = value
527
+ next
528
+ elsif key == 'id'
529
+ id = value
530
+ next
531
+ end
532
+ qname = ns.parse_local(key)
533
+ extraattr[qname] = decode_attr_value(ns, qname, value)
534
+ end
535
+
536
+ return is_nil, type, arytype, root, offset, position, href, id, extraattr
537
+ end
538
+
539
+ def decode_attr_value(ns, qname, value)
540
+ if /\A#/ =~ value
541
+ o = SOAPReference.decode(nil, value)
542
+ @refpool << o
543
+ o
544
+ else
545
+ value
546
+ end
547
+ end
548
+
549
+ def decode_arypos(position)
550
+ /^\[(.+)\]$/ =~ position
551
+ $1.split(',').collect { |s| s.to_i }
552
+ end
553
+
554
+ def decode_resolve_id
555
+ count = @refpool.length # To avoid infinite loop
556
+ while !@refpool.empty? && count > 0
557
+ @refpool = @refpool.find_all { |ref|
558
+ o = @idpool.find { |item|
559
+ item.id == ref.refid
560
+ }
561
+ if o.is_a?(SOAPReference)
562
+ true # link of link.
563
+ elsif o
564
+ ref.__setobj__(o)
565
+ false
566
+ elsif o = ref.rootnode.external_content[ref.refid]
567
+ ref.__setobj__(o)
568
+ false
569
+ else
570
+ raise EncodingStyleError.new("unresolved reference: #{ref.refid}")
571
+ end
572
+ }
573
+ count -= 1
574
+ end
575
+ end
576
+ end
577
+
578
+ SOAPHandler.new
579
+
580
+
581
+ end
582
+ end