Implements SOAP client support (using RPC encoding for the messages).
Example Usage
class PersonAPI < ActionWebService::API::Base
api_method :find_all, :returns => [[Person]]
end
soap_client = ActionWebService::Client::Soap.new(PersonAPI, "http://...")
persons = soap_client.find_all
Methods
Attributes
| [R] | driver | provides access to the underlying soap driver |
Public Class methods
Creates a new web service client using the SOAP RPC protocol.
api must be an ActionWebService::API::Base derivative, and endpoint_uri must point at the relevant URL to which protocol requests will be sent with HTTP POST.
Valid options:
- :namespace
- If the remote server has used a custom namespace to declare its custom types, you can specify it here. This would be the namespace declared with a [WebService(Namespace = "namespace")] attribute in .NET, for example.
- :driver_options
- If you want to supply any custom SOAP RPC driver options, you can provide them as a Hash here
The :driver_options option can be used to configure the backend SOAP RPC driver. An example of configuring the SOAP backend to do client-certificate authenticated SSL connections to the server:
opts = {}
opts['protocol.http.ssl_config.verify_mode'] = 'OpenSSL::SSL::VERIFY_PEER'
opts['protocol.http.ssl_config.client_cert'] = client_cert_file_path
opts['protocol.http.ssl_config.client_key'] = client_key_file_path
opts['protocol.http.ssl_config.ca_file'] = ca_cert_file_path
client = ActionWebService::Client::Soap.new(api, 'https://some/service', :driver_options => opts)
[ show source ]
# File vendor/rails/actionwebservice/lib/action_web_service/client/soap_client.rb, line 46
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
Protected Instance methods
[ show source ]
# File vendor/rails/actionwebservice/lib/action_web_service/client/soap_client.rb, line 60
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
[ show source ]
# File vendor/rails/actionwebservice/lib/action_web_service/client/soap_client.rb, line 67
67: def soap_action(method_name)
68: "#{@soap_action_base}/#{method_name}"
69: end