Class: ActionWebService::Protocol::Soap::SoapProtocol
- Inherits:
-
AbstractProtocol
- Object
- AbstractProtocol
- ActionWebService::Protocol::Soap::SoapProtocol
- Defined in:
- lib/action_web_service/protocol/soap_protocol.rb
Overview
:nodoc:
Constant Summary collapse
- AWSEncoding =
'UTF-8'
- XSDEncoding =
'UTF8'
Instance Attribute Summary collapse
-
#marshaler ⇒ Object
readonly
Returns the value of attribute marshaler.
Class Method Summary collapse
Instance Method Summary collapse
- #decode_action_pack_request(action_pack_request) ⇒ Object
- #decode_request(raw_request, service_name, protocol_options = {}) ⇒ Object
- #decode_response(raw_response) ⇒ Object
- #encode_action_pack_request(service_name, public_method_name, raw_body, options = {}) ⇒ Object
- #encode_request(method_name, params, param_types) ⇒ Object
- #encode_response(method_name, return_value, return_type, protocol_options = {}) ⇒ Object
-
#initialize(namespace = nil) ⇒ SoapProtocol
constructor
A new instance of SoapProtocol.
- #protocol_client(api, protocol_name, endpoint_uri, options = {}) ⇒ Object
- #register_api(api) ⇒ Object
Methods inherited from AbstractProtocol
Constructor Details
#initialize(namespace = nil) ⇒ SoapProtocol
Returns a new instance of SoapProtocol.
28 29 30 31 |
# File 'lib/action_web_service/protocol/soap_protocol.rb', line 28 def initialize(namespace=nil) namespace ||= 'urn:ActionWebService' @marshaler = SoapMarshaler.new namespace end |
Instance Attribute Details
#marshaler ⇒ Object (readonly)
Returns the value of attribute marshaler.
26 27 28 |
# File 'lib/action_web_service/protocol/soap_protocol.rb', line 26 def marshaler @marshaler end |
Class Method Details
.create(controller) ⇒ Object
33 34 35 |
# File 'lib/action_web_service/protocol/soap_protocol.rb', line 33 def self.create(controller) SoapProtocol.new(controller.wsdl_namespace) end |
Instance Method Details
#decode_action_pack_request(action_pack_request) ⇒ Object
37 38 39 40 41 42 43 44 45 46 |
# File 'lib/action_web_service/protocol/soap_protocol.rb', line 37 def decode_action_pack_request(action_pack_request) return nil unless soap_action = has_valid_soap_action?(action_pack_request) service_name = action_pack_request.parameters['action'] input_encoding = parse_charset(action_pack_request.env['HTTP_CONTENT_TYPE']) = { :soap_action => soap_action, :charset => input_encoding } decode_request(action_pack_request.raw_post, service_name, ) end |
#decode_request(raw_request, service_name, protocol_options = {}) ⇒ Object
54 55 56 57 58 59 60 61 62 63 |
# File 'lib/action_web_service/protocol/soap_protocol.rb', line 54 def decode_request(raw_request, service_name, ={}) envelope = SOAP::Processor.unmarshal(raw_request, :charset => [:charset]) unless envelope raise ProtocolError, "Failed to parse SOAP request message" end request = envelope.body.request method_name = request.elename.name params = request.collect{ |k, v| marshaler.soap_to_ruby(request[k]) } Request.new(self, method_name, params, service_name, nil, nil, ) end |
#decode_response(raw_response) ⇒ Object
83 84 85 86 87 88 89 90 91 92 |
# File 'lib/action_web_service/protocol/soap_protocol.rb', line 83 def decode_response(raw_response) envelope = SOAP::Processor.unmarshal(raw_response) unless envelope raise ProtocolError, "Failed to parse SOAP request message" end method_name = envelope.body.request.elename.name return_value = envelope.body.response return_value = marshaler.soap_to_ruby(return_value) unless return_value.nil? [method_name, return_value] end |
#encode_action_pack_request(service_name, public_method_name, raw_body, options = {}) ⇒ Object
48 49 50 51 52 |
# File 'lib/action_web_service/protocol/soap_protocol.rb', line 48 def encode_action_pack_request(service_name, public_method_name, raw_body, ={}) request = super request.env['HTTP_SOAPACTION'] = '/soap/%s/%s' % [service_name, public_method_name] request end |
#encode_request(method_name, params, param_types) ⇒ Object
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/action_web_service/protocol/soap_protocol.rb', line 65 def encode_request(method_name, params, param_types) param_types.each{ |type| marshaler.register_type(type) } if param_types qname = XSD::QName.new(marshaler.namespace, method_name) param_def = [] if param_types params = param_types.zip(params).map do |type, param| param_def << ['in', type.name, marshaler.lookup_type(type).mapping] [type.name, marshaler.ruby_to_soap(param)] end else params = [] end request = SOAP::RPC::SOAPMethodRequest.new(qname, param_def) request.set_param(params) envelope = create_soap_envelope(request) SOAP::Processor.marshal(envelope) end |
#encode_response(method_name, return_value, return_type, protocol_options = {}) ⇒ Object
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'lib/action_web_service/protocol/soap_protocol.rb', line 94 def encode_response(method_name, return_value, return_type, ={}) if return_type return_binding = marshaler.register_type(return_type) marshaler.annotate_arrays(return_binding, return_value) end qname = XSD::QName.new(marshaler.namespace, method_name) if return_value.nil? response = SOAP::RPC::SOAPMethodResponse.new(qname, nil) else if return_value.is_a?(Exception) detail = SOAP::Mapping::SOAPException.new(return_value) response = SOAP::SOAPFault.new( SOAP::SOAPQName.new('%s:%s' % [SOAP::SOAPNamespaceTag, 'Server']), SOAP::SOAPString.new(return_value.to_s), SOAP::SOAPString.new(self.class.name), marshaler.ruby_to_soap(detail)) else if return_type param_def = [['retval', 'return', marshaler.lookup_type(return_type).mapping]] response = SOAP::RPC::SOAPMethodResponse.new(qname, param_def) response.retval = marshaler.ruby_to_soap(return_value) else response = SOAP::RPC::SOAPMethodResponse.new(qname, nil) end end end envelope = create_soap_envelope(response) # FIXME: This is not thread-safe, but StringFactory_ in SOAP4R only # reads target encoding from the XSD::Charset.encoding variable. # This is required to ensure $KCODE strings are converted # correctly to UTF-8 for any values of $KCODE. previous_encoding = XSD::Charset.encoding XSD::Charset.encoding = XSDEncoding response_body = SOAP::Processor.marshal(envelope, :charset => AWSEncoding) XSD::Charset.encoding = previous_encoding Response.new(response_body, "text/xml; charset=#{AWSEncoding}", return_value) end |
#protocol_client(api, protocol_name, endpoint_uri, options = {}) ⇒ Object
134 135 136 137 |
# File 'lib/action_web_service/protocol/soap_protocol.rb', line 134 def protocol_client(api, protocol_name, endpoint_uri, ={}) return nil unless protocol_name == :soap ActionWebService::Client::Soap.new(api, endpoint_uri, ) end |
#register_api(api) ⇒ Object
139 140 141 142 143 144 |
# File 'lib/action_web_service/protocol/soap_protocol.rb', line 139 def register_api(api) api.api_methods.each do |name, method| method.expects.each{ |type| marshaler.register_type(type) } if method.expects method.returns.each{ |type| marshaler.register_type(type) } if method.returns end end |