Module: Savon::Global

Included in:
Savon
Defined in:
lib/savon/global.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#env_namespace ⇒ Object

Returns the global env_namespace.



69
70
71
 
# File 'lib/savon/global.rb', line 69

def env_namespace
  @env_namespace
end

#log(message) ⇒ Object

Logs a given message.



32
33
34
 
# File 'lib/savon/global.rb', line 32

def log(message)
  logger.send log_level, message if log?
end

#log_level ⇒ Object

Returns the log level. Defaults to :debug.



27
28
29
 
# File 'lib/savon/global.rb', line 27

def log_level
  @log_level ||= :debug
end

#logger ⇒ Object

Returns the logger. Defaults to an instance of Logger writing to STDOUT.



19
20
21
 
# File 'lib/savon/global.rb', line 19

def logger
  @logger ||= ::Logger.new STDOUT
end

#raise_errors=(value) ⇒ Object (writeonly)

Sets whether to raise HTTP errors and SOAP faults.



37
38
39
 
# File 'lib/savon/global.rb', line 37

def raise_errors=(value)
  @raise_errors = value
end

#soap_header ⇒ Object

Returns the global soap_header.



75
76
77
 
# File 'lib/savon/global.rb', line 75

def soap_header
  @soap_header
end

Instance Method Details

#deprecate(message) ⇒ Object

Expects a message and raises a warning if configured.



81
82
83
 
# File 'lib/savon/global.rb', line 81

def deprecate(message)
  warn("Deprecation: #{message}") if deprecate?
end

#deprecate=(deprecate) ⇒ Object

Sets whether to warn about deprecations.



86
87
88
 
# File 'lib/savon/global.rb', line 86

def deprecate=(deprecate)
  @deprecate = deprecate
end

#deprecate? ⇒ Boolean

Returns whether to warn about deprecation.

Returns:

  • (Boolean) 


91
92
93
 
# File 'lib/savon/global.rb', line 91

def deprecate?
  @deprecate != false
end

#log? ⇒ Boolean

Returns whether to log HTTP requests. Defaults to true.

Returns:

  • (Boolean) 


11
12
13
 
# File 'lib/savon/global.rb', line 11

def log?
  @log != false
end

#raise_errors? ⇒ Boolean

Returns whether to raise errors. Defaults to true.

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/savon/global.rb', line 40

def raise_errors?
  @raise_errors != false
end

#reset_config! ⇒ Object

Reset to default configuration.



96
97
98
99
100
101
102
103
104
105
 
# File 'lib/savon/global.rb', line 96

def reset_config!
  self.log = true
  self.logger = ::Logger.new STDOUT
  self.log_level = :debug
  self.raise_errors = true
  self.soap_version = SOAP::DefaultVersion
  self.strip_namespaces = true
  self.env_namespace = nil
  self.soap_header = {}
end

#soap_version ⇒ Object

Returns SOAP version. Defaults to DefaultVersion.



51
52
53
 
# File 'lib/savon/global.rb', line 51

def soap_version
  @version ||= SOAP::DefaultVersion
end

#soap_version=(version) ⇒ Object

Sets the global SOAP version.

Raises:

  • (ArgumentError) 


45
46
47
48
 
# File 'lib/savon/global.rb', line 45

def soap_version=(version)
  raise ArgumentError, "Invalid SOAP version: #{version}" unless SOAP::Versions.include? version
  @version = version
end

#strip_namespaces=(strip) ⇒ Object

Sets whether to strip namespaces in a SOAP response Hash.



63
64
65
66
 
# File 'lib/savon/global.rb', line 63

def strip_namespaces=(strip)
  Savon.deprecate("use Nori.strip_namespaces= instead of Savon.strip_namespaces=")
  Nori.strip_namespaces = strip
end

#strip_namespaces? ⇒ Boolean

Returns whether to strip namespaces in a SOAP response Hash. Defaults to true.

Returns:

  • (Boolean) 


57
58
59
60
 
# File 'lib/savon/global.rb', line 57

def strip_namespaces?
  Savon.deprecate("use Nori.strip_namespaces? instead of Savon.strip_namespaces?")
  Nori.strip_namespaces?
end