Class: Savon::GlobalOptions

Inherits:
Options
  • Object
show all
Defined in:
lib/savon/options.rb

Instance Attribute Summary

Attributes inherited from Options

#option_type

Instance Method Summary collapse

Methods inherited from Options

#[], #[]=, #include?

Constructor Details

#initialize(options = {}) ⇒ GlobalOptions

Returns a new instance of GlobalOptions.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/savon/options.rb', line 43

def initialize(options = {})
  @option_type = :global

  defaults = {
    :encoding                  => "UTF-8",
    :soap_version              => 1,
    :namespaces                => {},
    :logger                    => Logger.new($stdout),
    :log                       => false,
    :filters                   => [],
    :pretty_print_xml          => false,
    :raise_errors              => true,
    :strip_namespaces          => true,
    :convert_response_tags_to  => lambda { |tag| tag.snakecase.to_sym},
    :multipart                 => false,
    :adapter                   => nil,
  }

  options = defaults.merge(options)

  # this option is a shortcut on the logger which needs to be set
  # before it can be modified to set the option.
  delayed_level = options.delete(:log_level)

  super(options)

  log_level(delayed_level) unless delayed_level.nil?
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Savon::Options

Instance Method Details

#adapter(adapter) ⇒ Object

Instruct Savon what HTTPI adapter it should use instead of default



263
264
265
 
# File 'lib/savon/options.rb', line 263

def adapter(adapter)
  @options[:adapter] = adapter
end

#basic_auth(*credentials) ⇒ Object

HTTP basic auth credentials.



215
216
217
 
# File 'lib/savon/options.rb', line 215

def basic_auth(*credentials)
  @options[:basic_auth] = credentials.flatten
end

#convert_request_keys_to(converter) ⇒ Object

Tell Gyoku how to convert Hash key Symbols to XML tags. Accepts one of :lower_camelcase, :camelcase, :upcase, or :none.



246
247
248
 
# File 'lib/savon/options.rb', line 246

def convert_request_keys_to(converter)
  @options[:convert_request_keys_to] = converter
end

#convert_response_tags_to(converter = nil, &block) ⇒ Object

Tell Nori how to convert XML tags from the SOAP response into Hash keys. Accepts a lambda or a block which receives an XML tag and returns a Hash key. Defaults to convert tags to snakecase Symbols.



253
254
255
 
# File 'lib/savon/options.rb', line 253

def convert_response_tags_to(converter = nil, &block)
  @options[:convert_response_tags_to] = block || converter
end

#digest_auth(*credentials) ⇒ Object

HTTP digest auth credentials.



220
221
222
 
# File 'lib/savon/options.rb', line 220

def digest_auth(*credentials)
  @options[:digest_auth] = credentials.flatten
end

#element_form_default(element_form_default) ⇒ Object

Sets whether elements should be :qualified or unqualified. If you need to use this option, please open an issue and make sure to add your WSDL document for debugging.



130
131
132
 
# File 'lib/savon/options.rb', line 130

def element_form_default(element_form_default)
  @options[:element_form_default] = element_form_default
end

#encoding(encoding) ⇒ Object

The encoding to use. Defaults to "UTF-8".



118
119
120
 
# File 'lib/savon/options.rb', line 118

def encoding(encoding)
  @options[:encoding] = encoding
end

#endpoint(endpoint) ⇒ Object

SOAP endpoint.



78
79
80
 
# File 'lib/savon/options.rb', line 78

def endpoint(endpoint)
  @options[:endpoint] = endpoint
end

#env_namespace(env_namespace) ⇒ Object

Can be used to change the SOAP envelope namespace identifier. If you need to use this option, please open an issue and make sure to add your WSDL document for debugging.



137
138
139
 
# File 'lib/savon/options.rb', line 137

def env_namespace(env_namespace)
  @options[:env_namespace] = env_namespace
end

#filters(*filters) ⇒ Object

A list of XML tags to filter from logged SOAP messages.



175
176
177
 
# File 'lib/savon/options.rb', line 175

def filters(*filters)
  @options[:filters] = filters.flatten
end

#headers(headers) ⇒ Object

A Hash of HTTP headers.



103
104
105
 
# File 'lib/savon/options.rb', line 103

def headers(headers)
  @options[:headers] = headers
end

#log(log) ⇒ Object

Whether or not to log.



152
153
154
155
 
# File 'lib/savon/options.rb', line 152

def log(log)
  HTTPI.log = log
  @options[:log] = log
end

#log_level(level) ⇒ Object

Changes the Logger's log level.



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/savon/options.rb', line 163

def log_level(level)
  levels = { :debug => 0, :info => 1, :warn => 2, :error => 3, :fatal => 4 }

  unless levels.include? level
    raise ArgumentError, "Invalid log level: #{level.inspect}\n" \
                         "Expected one of: #{levels.keys.inspect}"
  end

  @options[:logger].level = levels[level]
end

#logger(logger) ⇒ Object

The logger to use. Defaults to a Savon::Logger instance.



158
159
160
 
# File 'lib/savon/options.rb', line 158

def logger(logger)
  @options[:logger] = logger
end

#multipart(multipart) ⇒ Object

Instruct Savon to create a multipart response if available.



258
259
260
 
# File 'lib/savon/options.rb', line 258

def multipart(multipart)
  @options[:multipart] = multipart
end

#namespace(namespace) ⇒ Object

Target namespace.



83
84
85
 
# File 'lib/savon/options.rb', line 83

def namespace(namespace)
  @options[:namespace] = namespace
end

#namespace_identifier(identifier) ⇒ Object

The namespace identifer.



88
89
90
 
# File 'lib/savon/options.rb', line 88

def namespace_identifier(identifier)
  @options[:namespace_identifier] = identifier
end

#namespaces(namespaces) ⇒ Object

Namespaces for the SOAP envelope.



93
94
95
 
# File 'lib/savon/options.rb', line 93

def namespaces(namespaces)
  @options[:namespaces] = namespaces
end

#ntlm(*credentials) ⇒ Object

NTLM auth credentials.



225
226
227
 
# File 'lib/savon/options.rb', line 225

def ntlm(*credentials)
  @options[:ntlm] = credentials.flatten
end

#open_timeout(open_timeout) ⇒ Object

Open timeout in seconds.



108
109
110
 
# File 'lib/savon/options.rb', line 108

def open_timeout(open_timeout)
  @options[:open_timeout] = open_timeout
end

#pretty_print_xml(pretty_print_xml) ⇒ Object

Whether to pretty print request and response XML log messages.



180
181
182
 
# File 'lib/savon/options.rb', line 180

def pretty_print_xml(pretty_print_xml)
  @options[:pretty_print_xml] = pretty_print_xml
end

#proxy(proxy) ⇒ Object

Proxy server to use for all requests.



98
99
100
 
# File 'lib/savon/options.rb', line 98

def proxy(proxy)
  @options[:proxy] = proxy
end

#raise_errors(raise_errors) ⇒ Object

Whether or not to raise SOAP fault and HTTP errors.



147
148
149
 
# File 'lib/savon/options.rb', line 147

def raise_errors(raise_errors)
  @options[:raise_errors] = raise_errors
end

#read_timeout(read_timeout) ⇒ Object

Read timeout in seconds.



113
114
115
 
# File 'lib/savon/options.rb', line 113

def read_timeout(read_timeout)
  @options[:read_timeout] = read_timeout
end

#soap_header(header) ⇒ Object

The global SOAP header. Expected to be a Hash or responding to #to_s.



123
124
125
 
# File 'lib/savon/options.rb', line 123

def soap_header(header)
  @options[:soap_header] = header
end

#soap_version(soap_version) ⇒ Object

Changes the SOAP version to 1 or 2.



142
143
144
 
# File 'lib/savon/options.rb', line 142

def soap_version(soap_version)
  @options[:soap_version] = soap_version
end

#ssl_ca_cert_file(file) ⇒ Object

Sets the ca cert file to use.



210
211
212
 
# File 'lib/savon/options.rb', line 210

def ssl_ca_cert_file(file)
  @options[:ssl_ca_cert_file] = file
end

#ssl_cert_file(file) ⇒ Object

Sets the cert file to use.



205
206
207
 
# File 'lib/savon/options.rb', line 205

def ssl_cert_file(file)
  @options[:ssl_cert_file] = file
end

#ssl_cert_key_file(file) ⇒ Object

Sets the cert key file to use.



195
196
197
 
# File 'lib/savon/options.rb', line 195

def ssl_cert_key_file(file)
  @options[:ssl_cert_key_file] = file
end

#ssl_cert_key_password(password) ⇒ Object

Sets the cert key password to use.



200
201
202
 
# File 'lib/savon/options.rb', line 200

def ssl_cert_key_password(password)
  @options[:ssl_cert_key_password] = password
end

#ssl_verify_mode(verify_mode) ⇒ Object

Whether and how to to verify the connection.



190
191
192
 
# File 'lib/savon/options.rb', line 190

def ssl_verify_mode(verify_mode)
  @options[:ssl_verify_mode] = verify_mode
end

#ssl_version(version) ⇒ Object

Specifies the SSL version to use.



185
186
187
 
# File 'lib/savon/options.rb', line 185

def ssl_version(version)
  @options[:ssl_version] = version
end

#strip_namespaces(strip_namespaces) ⇒ Object

Instruct Nori whether to strip namespaces from XML nodes.



240
241
242
 
# File 'lib/savon/options.rb', line 240

def strip_namespaces(strip_namespaces)
  @options[:strip_namespaces] = strip_namespaces
end

#wsdl(wsdl_address) ⇒ Object

Location of the local or remote WSDL document.



73
74
75
 
# File 'lib/savon/options.rb', line 73

def wsdl(wsdl_address)
  @options[:wsdl] = wsdl_address
end

#wsse_auth(*credentials) ⇒ Object

WSSE auth credentials for Akami.



230
231
232
 
# File 'lib/savon/options.rb', line 230

def wsse_auth(*credentials)
  @options[:wsse_auth] = credentials.flatten
end

#wsse_timestamp(*timestamp) ⇒ Object

Instruct Akami to enable wsu:Timestamp headers.



235
236
237
 
# File 'lib/savon/options.rb', line 235

def wsse_timestamp(*timestamp)
  @options[:wsse_timestamp] = timestamp.flatten
end