Class: Savon::LocalOptions

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

Overview

Per-request options passed to client.call. Overrides or extends the matching GlobalOptions for a single SOAP operation.

Instance Attribute Summary

Attributes inherited from Options

#option_type

Instance Method Summary collapse

Methods included from SharedOptions

#wsse_auth, #wsse_signature, #wsse_timestamp

Methods inherited from Options

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

Constructor Details

#initialize(options = {}) ⇒ LocalOptions

Returns a new instance of LocalOptions.



485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/savon/options.rb', line 485

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

  defaults = {
    advanced_typecasting: true,
    response_parser: :nokogiri,
    multipart: false
  }

  super defaults.merge(options)
end

Dynamic Method Handling

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

Instance Method Details

#advanced_typecasting(advanced) ⇒ Object

Instruct Nori to use advanced typecasting.



570
571
572
 
# File 'lib/savon/options.rb', line 570

def advanced_typecasting(advanced)
  @options[:advanced_typecasting] = advanced
end

#attachments(attachments) ⇒ Object

Attachments for the SOAP message (https://www.w3.org/TR/SOAP-attachments)

should pass an Array or a Hash; items should be path strings or { filename: 'file.name', content: 'content' } objects The Content-ID in multipart message sections will be the filename or the key if Hash is given

usage examples:

response = client.call :operation1 do
 message param1: 'value'
 attachments [
   { filename: 'x1.xml', content: '<xml>abc</xml>'},
   { filename: 'x2.xml', content: '<xml>abc</xml>'}
 ]
end
# Content-ID will be x1.xml and x2.xml

response = client.call :operation1 do
 message param1: 'value'
 attachments 'x1.xml' => '/tmp/1281ab7d7d.xml', 'x2.xml' => '/tmp/4c5v8e833a.xml'
end
# Content-ID will be x1.xml and x2.xml

response = client.call :operation1 do
 message param1: 'value'
 attachments [ '/tmp/1281ab7d7d.xml', '/tmp/4c5v8e833a.xml']
end
# Content-ID will be 1281ab7d7d.xml and 4c5v8e833a.xml

The Content-ID is important if you want to refer to the attachments from the SOAP request



550
551
552
 
# File 'lib/savon/options.rb', line 550

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

#attributes(attributes) ⇒ Object

Attributes for the SOAP message tag.



516
517
518
 
# File 'lib/savon/options.rb', line 516

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

#cookies(cookies) ⇒ Object

Cookies to be used for the next request.



560
561
562
 
# File 'lib/savon/options.rb', line 560

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

#headers(headers) ⇒ Object

Per-request HTTP headers. Merged with global headers for each request.



585
586
587
 
# File 'lib/savon/options.rb', line 585

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

#message(message) ⇒ Object

The SOAP message to send. Expected to be a Hash or a String.



505
506
507
 
# File 'lib/savon/options.rb', line 505

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

#message_tag(message_tag) ⇒ Object

SOAP message tag (formerly known as SOAP input tag). If it's not set, Savon retrieves the name from the WSDL document (if available). Otherwise, Gyoku converts the operation name into an XML element.



511
512
513
 
# File 'lib/savon/options.rb', line 511

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

#multipart(multipart) ⇒ Object

Instruct Savon to create a multipart response if available.



580
581
582
 
# File 'lib/savon/options.rb', line 580

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

#response_parser(parser) ⇒ Object

Instruct Nori to use :rexml or :nokogiri to parse the response.



575
576
577
 
# File 'lib/savon/options.rb', line 575

def response_parser(parser)
  @options[:response_parser] = parser
end

#soap_action(soap_action) ⇒ Object

Value of the SOAPAction HTTP header.



555
556
557
 
# File 'lib/savon/options.rb', line 555

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

#soap_header(header) ⇒ Object

The local SOAP header. Expected to be a Hash or respond to #to_s. Will be merged with the global SOAP header if both are Hashes. Otherwise the local option will be preferred.



500
501
502
 
# File 'lib/savon/options.rb', line 500

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

#xml(xml) ⇒ Object

The SOAP request XML to send. Expected to be a String.



565
566
567
 
# File 'lib/savon/options.rb', line 565

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