aforward-actionwebservice 2.3.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (94) hide show
  1. data/.gitignore +3 -0
  2. data/Gemfile +5 -0
  3. data/History.txt +325 -0
  4. data/Manifest.txt +12 -0
  5. data/PostInstall.txt +2 -0
  6. data/README.rdoc +410 -0
  7. data/Rakefile +2 -0
  8. data/actionwebservice.gemspec +19 -0
  9. data/autotest/discover.rb +2 -0
  10. data/examples/googlesearch/README +143 -0
  11. data/examples/googlesearch/autoloading/google_search_api.rb +50 -0
  12. data/examples/googlesearch/autoloading/google_search_controller.rb +57 -0
  13. data/examples/googlesearch/delegated/google_search_service.rb +108 -0
  14. data/examples/googlesearch/delegated/search_controller.rb +7 -0
  15. data/examples/googlesearch/direct/google_search_api.rb +50 -0
  16. data/examples/googlesearch/direct/search_controller.rb +58 -0
  17. data/examples/metaWeblog/README +17 -0
  18. data/examples/metaWeblog/apis/blogger_api.rb +60 -0
  19. data/examples/metaWeblog/apis/blogger_service.rb +34 -0
  20. data/examples/metaWeblog/apis/meta_weblog_api.rb +67 -0
  21. data/examples/metaWeblog/apis/meta_weblog_service.rb +48 -0
  22. data/examples/metaWeblog/controllers/xmlrpc_controller.rb +16 -0
  23. data/generators/web_service/USAGE +28 -0
  24. data/generators/web_service/templates/api_definition.rb +5 -0
  25. data/generators/web_service/templates/controller.rb +8 -0
  26. data/generators/web_service/templates/functional_test.rb +19 -0
  27. data/generators/web_service/web_service_generator.rb +29 -0
  28. data/lib/action_web_service/api.rb +297 -0
  29. data/lib/action_web_service/base.rb +38 -0
  30. data/lib/action_web_service/casting.rb +149 -0
  31. data/lib/action_web_service/client/base.rb +28 -0
  32. data/lib/action_web_service/client/soap_client.rb +113 -0
  33. data/lib/action_web_service/client/xmlrpc_client.rb +58 -0
  34. data/lib/action_web_service/client.rb +3 -0
  35. data/lib/action_web_service/container/action_controller_container.rb +93 -0
  36. data/lib/action_web_service/container/delegated_container.rb +86 -0
  37. data/lib/action_web_service/container/direct_container.rb +69 -0
  38. data/lib/action_web_service/container.rb +3 -0
  39. data/lib/action_web_service/dispatcher/abstract.rb +207 -0
  40. data/lib/action_web_service/dispatcher/action_controller_dispatcher.rb +379 -0
  41. data/lib/action_web_service/dispatcher.rb +2 -0
  42. data/lib/action_web_service/invocation.rb +202 -0
  43. data/lib/action_web_service/protocol/abstract.rb +112 -0
  44. data/lib/action_web_service/protocol/discovery.rb +37 -0
  45. data/lib/action_web_service/protocol/soap_protocol/marshaler.rb +242 -0
  46. data/lib/action_web_service/protocol/soap_protocol.rb +176 -0
  47. data/lib/action_web_service/protocol/xmlrpc_protocol.rb +122 -0
  48. data/lib/action_web_service/protocol.rb +4 -0
  49. data/lib/action_web_service/scaffolding.rb +281 -0
  50. data/lib/action_web_service/struct.rb +64 -0
  51. data/lib/action_web_service/support/class_inheritable_options.rb +26 -0
  52. data/lib/action_web_service/support/signature_types.rb +226 -0
  53. data/lib/action_web_service/templates/scaffolds/layout.html.erb +65 -0
  54. data/lib/action_web_service/templates/scaffolds/methods.html.erb +6 -0
  55. data/lib/action_web_service/templates/scaffolds/parameters.html.erb +29 -0
  56. data/lib/action_web_service/templates/scaffolds/result.html.erb +30 -0
  57. data/lib/action_web_service/test_invoke.rb +110 -0
  58. data/lib/action_web_service/version.rb +10 -0
  59. data/lib/action_web_service.rb +50 -0
  60. data/lib/actionwebservice.rb +1 -0
  61. data/old/Rakefile +173 -0
  62. data/old/Rakefile2 +25 -0
  63. data/old/TODO +32 -0
  64. data/old/actionwebservice.gemspec +37 -0
  65. data/old/install.rb +30 -0
  66. data/old/setup.rb +1379 -0
  67. data/script/console +10 -0
  68. data/script/destroy +14 -0
  69. data/script/generate +14 -0
  70. data/test/abstract_client.rb +183 -0
  71. data/test/abstract_dispatcher.rb +548 -0
  72. data/test/abstract_unit.rb +39 -0
  73. data/test/api_test.rb +102 -0
  74. data/test/apis/auto_load_api.rb +3 -0
  75. data/test/apis/broken_auto_load_api.rb +2 -0
  76. data/test/base_test.rb +42 -0
  77. data/test/casting_test.rb +94 -0
  78. data/test/client_soap_test.rb +155 -0
  79. data/test/client_xmlrpc_test.rb +153 -0
  80. data/test/container_test.rb +73 -0
  81. data/test/dispatcher_action_controller_soap_test.rb +138 -0
  82. data/test/dispatcher_action_controller_xmlrpc_test.rb +59 -0
  83. data/test/fixtures/db_definitions/mysql.sql +8 -0
  84. data/test/fixtures/users.yml +12 -0
  85. data/test/gencov +3 -0
  86. data/test/invocation_test.rb +185 -0
  87. data/test/run +6 -0
  88. data/test/scaffolded_controller_test.rb +146 -0
  89. data/test/struct_test.rb +52 -0
  90. data/test/test_action_web_service.rb +11 -0
  91. data/test/test_actionwebservice.rb +11 -0
  92. data/test/test_helper.rb +3 -0
  93. data/test/test_invoke_test.rb +112 -0
  94. metadata +184 -0
@@ -0,0 +1,297 @@
1
+ module ActionWebService # :nodoc:
2
+ module API # :nodoc:
3
+ # A web service API class specifies the methods that will be available for
4
+ # invocation for an API. It also contains metadata such as the method type
5
+ # signature hints.
6
+ #
7
+ # It is not intended to be instantiated.
8
+ #
9
+ # It is attached to web service implementation classes like
10
+ # ActionWebService::Base and ActionController::Base derivatives by using
11
+ # <tt>container.web_service_api</tt>, where <tt>container</tt> is an
12
+ # ActionController::Base or a ActionWebService::Base.
13
+ #
14
+ # See ActionWebService::Container::Direct::ClassMethods for an example
15
+ # of use.
16
+ class Base
17
+ # Whether to transform the public API method names into camel-cased names
18
+ class_inheritable_option :inflect_names, true
19
+
20
+ # By default only HTTP POST requests are processed
21
+ class_inheritable_option :allowed_http_methods, [ :post ]
22
+
23
+ # Whether to allow ActiveRecord::Base models in <tt>:expects</tt>.
24
+ # The default is +false+; you should be aware of the security implications
25
+ # of allowing this, and ensure that you don't allow remote callers to
26
+ # easily overwrite data they should not have access to.
27
+ class_inheritable_option :allow_active_record_expects, false
28
+
29
+ # If present, the name of a method to call when the remote caller
30
+ # tried to call a nonexistent method. Semantically equivalent to
31
+ # +method_missing+.
32
+ class_inheritable_option :default_api_method
33
+
34
+ # Disallow instantiation
35
+ private_class_method :new, :allocate
36
+
37
+ class << self
38
+ include ActionWebService::SignatureTypes
39
+
40
+ # API methods have a +name+, which must be the Ruby method name to use when
41
+ # performing the invocation on the web service object.
42
+ #
43
+ # The signatures for the method input parameters and return value can
44
+ # by specified in +options+.
45
+ #
46
+ # A signature is an array of one or more parameter specifiers.
47
+ # A parameter specifier can be one of the following:
48
+ #
49
+ # * A symbol or string representing one of the Action Web Service base types.
50
+ # See ActionWebService::SignatureTypes for a canonical list of the base types.
51
+ # * The Class object of the parameter type
52
+ # * A single-element Array containing one of the two preceding items. This
53
+ # will cause Action Web Service to treat the parameter at that position
54
+ # as an array containing only values of the given type.
55
+ # * A Hash containing as key the name of the parameter, and as value
56
+ # one of the three preceding items
57
+ #
58
+ # If no method input parameter or method return value signatures are given,
59
+ # the method is assumed to take no parameters and/or return no values of
60
+ # interest, and any values that are received by the server will be
61
+ # discarded and ignored.
62
+ #
63
+ # Valid options:
64
+ # [<tt>:expects</tt>] Signature for the method input parameters
65
+ # [<tt>:returns</tt>] Signature for the method return value
66
+ # [<tt>:expects_and_returns</tt>] Signature for both input parameters and return value
67
+ def api_method(name, options={})
68
+ unless options.is_a?(Hash)
69
+ raise(ActionWebServiceError, "Expected a Hash for options")
70
+ end
71
+ validate_options([:expects, :returns, :expects_and_returns], options.keys)
72
+ if options[:expects_and_returns]
73
+ expects = options[:expects_and_returns]
74
+ returns = options[:expects_and_returns]
75
+ else
76
+ expects = options[:expects]
77
+ returns = options[:returns]
78
+ end
79
+ expects = canonical_signature(expects)
80
+ returns = canonical_signature(returns)
81
+ if expects
82
+ expects.each do |type|
83
+ type = type.element_type if type.is_a?(ArrayType)
84
+ if type.type_class.ancestors.include?(ActiveRecord::Base) && !allow_active_record_expects
85
+ raise(ActionWebServiceError, "ActiveRecord model classes not allowed in :expects")
86
+ end
87
+ end
88
+ end
89
+ name = name.to_sym
90
+ public_name = public_api_method_name(name)
91
+ method = Method.new(name, public_name, expects, returns)
92
+ write_inheritable_hash("api_methods", name => method)
93
+ write_inheritable_hash("api_public_method_names", public_name => name)
94
+ end
95
+
96
+ # Whether the given method name is a service method on this API
97
+ #
98
+ # class ProjectsApi < ActionWebService::API::Base
99
+ # api_method :getCount, :returns => [:int]
100
+ # end
101
+ #
102
+ # ProjectsApi.has_api_method?('GetCount') #=> false
103
+ # ProjectsApi.has_api_method?(:getCount) #=> true
104
+ def has_api_method?(name)
105
+ api_methods.has_key?(name)
106
+ end
107
+
108
+ # Whether the given public method name has a corresponding service method
109
+ # on this API
110
+ #
111
+ # class ProjectsApi < ActionWebService::API::Base
112
+ # api_method :getCount, :returns => [:int]
113
+ # end
114
+ #
115
+ # ProjectsApi.has_api_method?(:getCount) #=> false
116
+ # ProjectsApi.has_api_method?('GetCount') #=> true
117
+ def has_public_api_method?(public_name)
118
+ api_public_method_names.has_key?(public_name)
119
+ end
120
+
121
+ # The corresponding public method name for the given service method name
122
+ #
123
+ # ProjectsApi.public_api_method_name('GetCount') #=> "GetCount"
124
+ # ProjectsApi.public_api_method_name(:getCount) #=> "GetCount"
125
+ def public_api_method_name(name)
126
+ if inflect_names
127
+ name.to_s.camelize
128
+ else
129
+ name.to_s
130
+ end
131
+ end
132
+
133
+ # The corresponding service method name for the given public method name
134
+ #
135
+ # class ProjectsApi < ActionWebService::API::Base
136
+ # api_method :getCount, :returns => [:int]
137
+ # end
138
+ #
139
+ # ProjectsApi.api_method_name('GetCount') #=> :getCount
140
+ def api_method_name(public_name)
141
+ api_public_method_names[public_name]
142
+ end
143
+
144
+ # A Hash containing all service methods on this API, and their
145
+ # associated metadata.
146
+ #
147
+ # class ProjectsApi < ActionWebService::API::Base
148
+ # api_method :getCount, :returns => [:int]
149
+ # api_method :getCompletedCount, :returns => [:int]
150
+ # end
151
+ #
152
+ # ProjectsApi.api_methods #=>
153
+ # {:getCount=>#<ActionWebService::API::Method:0x24379d8 ...>,
154
+ # :getCompletedCount=>#<ActionWebService::API::Method:0x2437794 ...>}
155
+ # ProjectsApi.api_methods[:getCount].public_name #=> "GetCount"
156
+ def api_methods
157
+ read_inheritable_attribute("api_methods") || {}
158
+ end
159
+
160
+ # The Method instance for the given public API method name, if any
161
+ #
162
+ # class ProjectsApi < ActionWebService::API::Base
163
+ # api_method :getCount, :returns => [:int]
164
+ # api_method :getCompletedCount, :returns => [:int]
165
+ # end
166
+ #
167
+ # ProjectsApi.public_api_method_instance('GetCount') #=> <#<ActionWebService::API::Method:0x24379d8 ...>
168
+ # ProjectsApi.public_api_method_instance(:getCount) #=> nil
169
+ def public_api_method_instance(public_method_name)
170
+ api_method_instance(api_method_name(public_method_name))
171
+ end
172
+
173
+ # The Method instance for the given API method name, if any
174
+ #
175
+ # class ProjectsApi < ActionWebService::API::Base
176
+ # api_method :getCount, :returns => [:int]
177
+ # api_method :getCompletedCount, :returns => [:int]
178
+ # end
179
+ #
180
+ # ProjectsApi.api_method_instance(:getCount) #=> <ActionWebService::API::Method:0x24379d8 ...>
181
+ # ProjectsApi.api_method_instance('GetCount') #=> <ActionWebService::API::Method:0x24379d8 ...>
182
+ def api_method_instance(method_name)
183
+ api_methods[method_name]
184
+ end
185
+
186
+ # The Method instance for the default API method, if any
187
+ def default_api_method_instance
188
+ return nil unless name = default_api_method
189
+ instance = read_inheritable_attribute("default_api_method_instance")
190
+ if instance && instance.name == name
191
+ return instance
192
+ end
193
+ instance = Method.new(name, public_api_method_name(name), nil, nil)
194
+ write_inheritable_attribute("default_api_method_instance", instance)
195
+ instance
196
+ end
197
+
198
+ private
199
+ def api_public_method_names
200
+ read_inheritable_attribute("api_public_method_names") || {}
201
+ end
202
+
203
+ def validate_options(valid_option_keys, supplied_option_keys)
204
+ unknown_option_keys = supplied_option_keys - valid_option_keys
205
+ unless unknown_option_keys.empty?
206
+ raise(ActionWebServiceError, "Unknown options: #{unknown_option_keys}")
207
+ end
208
+ end
209
+ end
210
+ end
211
+
212
+ # Represents an API method and its associated metadata, and provides functionality
213
+ # to assist in commonly performed API method tasks.
214
+ class Method
215
+ attr :name
216
+ attr :public_name
217
+ attr :expects
218
+ attr :returns
219
+
220
+ def initialize(name, public_name, expects, returns)
221
+ @name = name
222
+ @public_name = public_name
223
+ @expects = expects
224
+ @returns = returns
225
+ @caster = ActionWebService::Casting::BaseCaster.new(self)
226
+ end
227
+
228
+ # The list of parameter names for this method
229
+ def param_names
230
+ return [] unless @expects
231
+ @expects.map{ |type| type.name }
232
+ end
233
+
234
+ # Casts a set of Ruby values into the expected Ruby values
235
+ def cast_expects(params)
236
+ @caster.cast_expects(params)
237
+ end
238
+
239
+ # Cast a Ruby return value into the expected Ruby value
240
+ def cast_returns(return_value)
241
+ @caster.cast_returns(return_value)
242
+ end
243
+
244
+ # Returns the index of the first expected parameter
245
+ # with the given name
246
+ def expects_index_of(param_name)
247
+ return -1 if @expects.nil?
248
+ (0..(@expects.length-1)).each do |i|
249
+ return i if @expects[i].name.to_s == param_name.to_s
250
+ end
251
+ -1
252
+ end
253
+
254
+ # Returns a hash keyed by parameter name for the given
255
+ # parameter list
256
+ def expects_to_hash(params)
257
+ return {} if @expects.nil?
258
+ h = {}
259
+ @expects.zip(params){ |type, param| h[type.name] = param }
260
+ h
261
+ end
262
+
263
+ # Backwards compatibility with previous API
264
+ def [](sig_type)
265
+ case sig_type
266
+ when :expects
267
+ @expects.map{|x| compat_signature_entry(x)}
268
+ when :returns
269
+ @returns.map{|x| compat_signature_entry(x)}
270
+ end
271
+ end
272
+
273
+ # String representation of this method
274
+ def to_s
275
+ fqn = ""
276
+ fqn << (@returns ? (@returns[0].human_name(false) + " ") : "void ")
277
+ fqn << "#{@public_name}("
278
+ fqn << @expects.map{ |p| p.human_name }.join(", ") if @expects
279
+ fqn << ")"
280
+ fqn
281
+ end
282
+
283
+ private
284
+ def compat_signature_entry(entry)
285
+ if entry.array?
286
+ [compat_signature_entry(entry.element_type)]
287
+ else
288
+ if entry.spec.is_a?(Hash)
289
+ {entry.spec.keys.first => entry.type_class}
290
+ else
291
+ entry.type_class
292
+ end
293
+ end
294
+ end
295
+ end
296
+ end
297
+ end
@@ -0,0 +1,38 @@
1
+ module ActionWebService # :nodoc:
2
+ class ActionWebServiceError < StandardError # :nodoc:
3
+ end
4
+
5
+ # An Action Web Service object implements a specified API.
6
+ #
7
+ # Used by controllers operating in _Delegated_ dispatching mode.
8
+ #
9
+ # ==== Example
10
+ #
11
+ # class PersonService < ActionWebService::Base
12
+ # web_service_api PersonAPI
13
+ #
14
+ # def find_person(criteria)
15
+ # Person.find(:all) [...]
16
+ # end
17
+ #
18
+ # def delete_person(id)
19
+ # Person.find_by_id(id).destroy
20
+ # end
21
+ # end
22
+ #
23
+ # class PersonAPI < ActionWebService::API::Base
24
+ # api_method :find_person, :expects => [SearchCriteria], :returns => [[Person]]
25
+ # api_method :delete_person, :expects => [:int]
26
+ # end
27
+ #
28
+ # class SearchCriteria < ActionWebService::Struct
29
+ # member :firstname, :string
30
+ # member :lastname, :string
31
+ # member :email, :string
32
+ # end
33
+ class Base
34
+ # Whether to report exceptions back to the caller in the protocol's exception
35
+ # format
36
+ class_inheritable_option :web_service_exception_reporting, true
37
+ end
38
+ end
@@ -0,0 +1,149 @@
1
+ require 'time'
2
+ require 'date'
3
+ require 'xmlrpc/datetime'
4
+
5
+ module ActionWebService # :nodoc:
6
+ module Casting # :nodoc:
7
+ class CastingError < ActionWebServiceError # :nodoc:
8
+ end
9
+
10
+ # Performs casting of arbitrary values into the correct types for the signature
11
+ class BaseCaster # :nodoc:
12
+ def initialize(api_method)
13
+ @api_method = api_method
14
+ end
15
+
16
+ # Coerces the parameters in +params+ (an Enumerable) into the types
17
+ # this method expects
18
+ def cast_expects(params)
19
+ self.class.cast_expects(@api_method, params)
20
+ end
21
+
22
+ # Coerces the given +return_value+ into the type returned by this
23
+ # method
24
+ def cast_returns(return_value)
25
+ self.class.cast_returns(@api_method, return_value)
26
+ end
27
+
28
+ class << self
29
+ include ActionWebService::SignatureTypes
30
+
31
+ def cast_expects(api_method, params) # :nodoc:
32
+ return [] if api_method.expects.nil?
33
+ api_method.expects.zip(params).map{ |type, param| cast(param, type) }
34
+ end
35
+
36
+ def cast_returns(api_method, return_value) # :nodoc:
37
+ return nil if api_method.returns.nil?
38
+ cast(return_value, api_method.returns[0])
39
+ end
40
+
41
+ def cast(value, signature_type) # :nodoc:
42
+ return value if signature_type.nil? # signature.length != params.length
43
+ return nil if value.nil?
44
+ # XMLRPC protocol doesn't support nil values. It uses false instead.
45
+ # It should never happen for SOAP.
46
+ if signature_type.structured? && value.equal?(false)
47
+ return nil
48
+ end
49
+ unless signature_type.array? || signature_type.structured?
50
+ return value if canonical_type(value.class) == signature_type.type
51
+ end
52
+ if signature_type.array?
53
+ unless value.respond_to?(:entries) && !value.is_a?(String)
54
+ raise CastingError, "Don't know how to cast #{value.class} into #{signature_type.type.inspect}"
55
+ end
56
+ value.entries.map do |entry|
57
+ cast(entry, signature_type.element_type)
58
+ end
59
+ elsif signature_type.structured?
60
+ cast_to_structured_type(value, signature_type)
61
+ elsif !signature_type.custom?
62
+ cast_base_type(value, signature_type)
63
+ end
64
+ end
65
+
66
+ def cast_base_type(value, signature_type) # :nodoc:
67
+ # This is a work-around for the fact that XML-RPC special-cases DateTime values into its own DateTime type
68
+ # in order to support iso8601 dates. This doesn't work too well for us, so we'll convert it into a Time,
69
+ # with the caveat that we won't be able to handle pre-1970 dates that are sent to us.
70
+ #
71
+ # See http://dev.rubyonrails.com/ticket/2516
72
+ value = value.to_time if value.is_a?(XMLRPC::DateTime)
73
+
74
+ case signature_type.type
75
+ when :int
76
+ Integer(value)
77
+ when :string
78
+ value.to_s
79
+ when :base64
80
+ if value.is_a?(ActionWebService::Base64)
81
+ value
82
+ else
83
+ ActionWebService::Base64.new(value.to_s)
84
+ end
85
+ when :bool
86
+ return false if value.nil?
87
+ return value if value == true || value == false
88
+ case value.to_s.downcase
89
+ when '1', 'true', 'y', 'yes'
90
+ true
91
+ when '0', 'false', 'n', 'no'
92
+ false
93
+ else
94
+ raise CastingError, "Don't know how to cast #{value.class} into Boolean"
95
+ end
96
+ when :float
97
+ Float(value)
98
+ when :decimal
99
+ BigDecimal(value.to_s)
100
+ when :time
101
+ value = "%s/%s/%s %s:%s:%s" % value.values_at(*%w[2 3 1 4 5 6]) if value.kind_of?(Hash)
102
+ if value.kind_of?(Time)
103
+ value
104
+ elsif value.kind_of?(DateTime)
105
+ value.to_time
106
+ else
107
+ Time.parse(value.to_s)
108
+ end
109
+ when :date
110
+ value = "%s/%s/%s" % value.values_at(*%w[2 3 1]) if value.kind_of?(Hash)
111
+ value.kind_of?(Date) ? value : Date.parse(value.to_s)
112
+ when :datetime
113
+ value = "%s/%s/%s %s:%s:%s" % value.values_at(*%w[2 3 1 4 5 6]) if value.kind_of?(Hash)
114
+ value.kind_of?(DateTime) ? value : DateTime.parse(value.to_s)
115
+ end
116
+ end
117
+
118
+ def cast_to_structured_type(value, signature_type) # :nodoc:
119
+ obj = nil
120
+ # if the canonical classes are the same or if the given value is of
121
+ # a type that is derived from the signature_type do not attempt to
122
+ # "cast" the value into the signature_type as it's already good to go
123
+ obj = (
124
+ canonical_type(value.class) == canonical_type(signature_type.type) or
125
+ derived_from?(signature_type.type, value.class)
126
+ ) ? value : signature_type.type_class.new
127
+ if value.respond_to?(:each_pair)
128
+ klass = signature_type.type_class
129
+ value.each_pair do |name, val|
130
+ type = klass.respond_to?(:member_type) ? klass.member_type(name) : nil
131
+ val = cast(val, type) if type
132
+ # See http://dev.rubyonrails.com/ticket/3567
133
+ val = val.to_time if val.is_a?(XMLRPC::DateTime)
134
+ obj.__send__("#{name}=", val) if obj.respond_to?(name)
135
+ end
136
+ elsif value.respond_to?(:attributes)
137
+ signature_type.each_member do |name, type|
138
+ val = value.__send__(name)
139
+ obj.__send__("#{name}=", cast(val, type)) if obj.respond_to?(name)
140
+ end
141
+ else
142
+ raise CastingError, "Don't know how to cast #{value.class} to #{signature_type.type_class}"
143
+ end
144
+ obj
145
+ end
146
+ end
147
+ end
148
+ end
149
+ end
@@ -0,0 +1,28 @@
1
+ module ActionWebService # :nodoc:
2
+ module Client # :nodoc:
3
+ class ClientError < StandardError # :nodoc:
4
+ end
5
+
6
+ class Base # :nodoc:
7
+ def initialize(api, endpoint_uri)
8
+ @api = api
9
+ @endpoint_uri = endpoint_uri
10
+ end
11
+
12
+ def method_missing(name, *args) # :nodoc:
13
+ call_name = method_name(name)
14
+ return super(name, *args) if call_name.nil?
15
+ self.perform_invocation(call_name, args)
16
+ end
17
+
18
+ private
19
+ def method_name(name)
20
+ if @api.has_api_method?(name.to_sym)
21
+ name.to_s
22
+ elsif @api.has_public_api_method?(name.to_s)
23
+ @api.api_method_name(name.to_s).to_s
24
+ end
25
+ end
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,113 @@
1
+ require 'soap/rpc/driver'
2
+ require 'uri'
3
+
4
+ module ActionWebService # :nodoc:
5
+ module Client # :nodoc:
6
+
7
+ # Implements SOAP client support (using RPC encoding for the messages).
8
+ #
9
+ # ==== Example Usage
10
+ #
11
+ # class PersonAPI < ActionWebService::API::Base
12
+ # api_method :find_all, :returns => [[Person]]
13
+ # end
14
+ #
15
+ # soap_client = ActionWebService::Client::Soap.new(PersonAPI, "http://...")
16
+ # persons = soap_client.find_all
17
+ #
18
+ class Soap < Base
19
+ # provides access to the underlying soap driver
20
+ attr_reader :driver
21
+
22
+ # Creates a new web service client using the SOAP RPC protocol.
23
+ #
24
+ # +api+ must be an ActionWebService::API::Base derivative, and
25
+ # +endpoint_uri+ must point at the relevant URL to which protocol requests
26
+ # will be sent with HTTP POST.
27
+ #
28
+ # Valid options:
29
+ # [<tt>:namespace</tt>] If the remote server has used a custom namespace to
30
+ # declare its custom types, you can specify it here. This would
31
+ # be the namespace declared with a [WebService(Namespace = "http://namespace")] attribute
32
+ # in .NET, for example.
33
+ # [<tt>:driver_options</tt>] If you want to supply any custom SOAP RPC driver
34
+ # options, you can provide them as a Hash here
35
+ #
36
+ # The <tt>:driver_options</tt> option can be used to configure the backend SOAP
37
+ # RPC driver. An example of configuring the SOAP backend to do
38
+ # client-certificate authenticated SSL connections to the server:
39
+ #
40
+ # opts = {}
41
+ # opts['protocol.http.ssl_config.verify_mode'] = 'OpenSSL::SSL::VERIFY_PEER'
42
+ # opts['protocol.http.ssl_config.client_cert'] = client_cert_file_path
43
+ # opts['protocol.http.ssl_config.client_key'] = client_key_file_path
44
+ # opts['protocol.http.ssl_config.ca_file'] = ca_cert_file_path
45
+ # client = ActionWebService::Client::Soap.new(api, 'https://some/service', :driver_options => opts)
46
+ def initialize(api, endpoint_uri, options={})
47
+ super(api, endpoint_uri)
48
+ @namespace = options[:namespace] || 'urn:ActionWebService'
49
+ @driver_options = options[:driver_options] || {}
50
+ @protocol = ActionWebService::Protocol::Soap::SoapProtocol.new @namespace
51
+ @soap_action_base = options[:soap_action_base]
52
+ @soap_action_base ||= URI.parse(endpoint_uri).path
53
+ @driver = create_soap_rpc_driver(api, endpoint_uri)
54
+ @driver_options.each do |name, value|
55
+ @driver.options[name.to_s] = value
56
+ end
57
+ end
58
+
59
+ protected
60
+ def perform_invocation(method_name, args)
61
+ method = @api.api_methods[method_name.to_sym]
62
+ args = method.cast_expects(args.dup) rescue args
63
+ return_value = @driver.send(method_name, *args)
64
+ method.cast_returns(return_value.dup) rescue return_value
65
+ end
66
+
67
+ def soap_action(method_name)
68
+ "#{@soap_action_base}/#{method_name}"
69
+ end
70
+
71
+ private
72
+ def create_soap_rpc_driver(api, endpoint_uri)
73
+ @protocol.register_api(api)
74
+ driver = SoapDriver.new(endpoint_uri, nil)
75
+ driver.mapping_registry = @protocol.marshaler.registry
76
+ api.api_methods.each do |name, method|
77
+ qname = XSD::QName.new(@namespace, method.public_name)
78
+ action = soap_action(method.public_name)
79
+ expects = method.expects
80
+ returns = method.returns
81
+ param_def = []
82
+ if expects
83
+ expects.each do |type|
84
+ type_binding = @protocol.marshaler.lookup_type(type)
85
+ if SOAP::Version >= "1.5.5"
86
+ param_def << ['in', type.name.to_s, [type_binding.type.type_class.to_s]]
87
+ else
88
+ param_def << ['in', type.name, type_binding.mapping]
89
+ end
90
+ end
91
+ end
92
+ if returns
93
+ type_binding = @protocol.marshaler.lookup_type(returns[0])
94
+ if SOAP::Version >= "1.5.5"
95
+ param_def << ['retval', 'return', [type_binding.type.type_class.to_s]]
96
+ else
97
+ param_def << ['retval', 'return', type_binding.mapping]
98
+ end
99
+ end
100
+ driver.add_method(qname, action, method.name.to_s, param_def)
101
+ end
102
+ driver
103
+ end
104
+
105
+ class SoapDriver < SOAP::RPC::Driver # :nodoc:
106
+ def add_method(qname, soapaction, name, param_def)
107
+ @proxy.add_rpc_method(qname, soapaction, name, param_def)
108
+ add_rpc_method_interface(name, param_def)
109
+ end
110
+ end
111
+ end
112
+ end
113
+ end
@@ -0,0 +1,58 @@
1
+ require 'uri'
2
+ require 'xmlrpc/client'
3
+
4
+ module ActionWebService # :nodoc:
5
+ module Client # :nodoc:
6
+
7
+ # Implements XML-RPC client support
8
+ #
9
+ # ==== Example Usage
10
+ #
11
+ # class BloggerAPI < ActionWebService::API::Base
12
+ # inflect_names false
13
+ # api_method :getRecentPosts, :returns => [[Blog::Post]]
14
+ # end
15
+ #
16
+ # blog = ActionWebService::Client::XmlRpc.new(BloggerAPI, "http://.../RPC", :handler_name => "blogger")
17
+ # posts = blog.getRecentPosts
18
+ class XmlRpc < Base
19
+
20
+ # Creates a new web service client using the XML-RPC protocol.
21
+ #
22
+ # +api+ must be an ActionWebService::API::Base derivative, and
23
+ # +endpoint_uri+ must point at the relevant URL to which protocol requests
24
+ # will be sent with HTTP POST.
25
+ #
26
+ # Valid options:
27
+ # [<tt>:handler_name</tt>] If the remote server defines its services inside special
28
+ # handler (the Blogger API uses a <tt>"blogger"</tt> handler name for example),
29
+ # provide it here, or your method calls will fail
30
+ def initialize(api, endpoint_uri, options={})
31
+ @api = api
32
+ @handler_name = options[:handler_name]
33
+ @protocol = ActionWebService::Protocol::XmlRpc::XmlRpcProtocol.new
34
+ @client = XMLRPC::Client.new2(endpoint_uri, options[:proxy], options[:timeout])
35
+ end
36
+
37
+ protected
38
+ def perform_invocation(method_name, args)
39
+ method = @api.api_methods[method_name.to_sym]
40
+ if method.expects && method.expects.length != args.length
41
+ raise(ArgumentError, "#{method.public_name}: wrong number of arguments (#{args.length} for #{method.expects.length})")
42
+ end
43
+ args = method.cast_expects(args.dup) rescue args
44
+ if method.expects
45
+ method.expects.each_with_index{ |type, i| args[i] = @protocol.value_to_xmlrpc_wire_format(args[i], type) }
46
+ end
47
+ ok, return_value = @client.call2(public_name(method_name), *args)
48
+ return (method.cast_returns(return_value.dup) rescue return_value) if ok
49
+ raise(ClientError, "#{return_value.faultCode}: #{return_value.faultString}")
50
+ end
51
+
52
+ def public_name(method_name)
53
+ public_name = @api.public_api_method_name(method_name)
54
+ @handler_name ? "#{@handler_name}.#{public_name}" : public_name
55
+ end
56
+ end
57
+ end
58
+ end
@@ -0,0 +1,3 @@
1
+ require 'action_web_service/client/base'
2
+ require 'action_web_service/client/soap_client'
3
+ require 'action_web_service/client/xmlrpc_client'