Module: Stn::Config

Included in:
Stn
Defined in:
lib/stn/config.rb

Overview

Provides methods to read and write global configuration settings.

A typical usage is to set the Security Token for the API calls.

Examples:

Set the Security Token for the API client:

Stn.configure do |config|
  config.security_token = 'ABCDEFGHIJ1234567890'
end

Instance Method Summary collapse

Instance Method Details

#configuration ⇒ Stn::Models::Configuration

Returns the global Models::Configuration object.

While this method can be used to read and write configuration settings, it is easier to use #configure Stn.configure}.

Examples:

Stn.configuration.security_token = 'ABCDEFGHIJ1234567890'

Returns:

  • (Stn::Models::Configuration) —

    The global configuration.



37
38
39
 
# File 'lib/stn/config.rb', line 37

def configuration
  @configuration ||= Stn::Configuration.new
end

#configure {|Stn::Models::Configuration| ... } ⇒ Object

Yields the global configuration to the given block.

Examples:

Stn.configure do |config|
  config.security_token = 'ABCDEFGHIJ1234567890'
end

Yields:

  • (Stn::Models::Configuration) —

    The global configuration.



24
25
26
 
# File 'lib/stn/config.rb', line 24

def configure
  yield configuration if block_given?
end