Module: Kaseya::BMS::Configuration

Included in:
Kaseya::BMS
Defined in:
lib/kaseya/bms/configuration.rb

Constant Summary collapse

VALID_OPTIONS_KEYS = 
[
  :debug,
  :user_agent,
].freeze
DEFAULT_DEBUG = 
false
DEFAULT_USER_AGENT = 
"Kaseya BMS Ruby Gem #{Kaseya::VERSION}".freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object

When this module is extended, set all configuration options to their default values



21
22
23
 
# File 'lib/kaseya/bms/configuration.rb', line 21

def self.extended(base)
  base.reset
end

Instance Method Details

#configure {|_self| ... } ⇒ Object

Convenience method to allow configuration options to be set in a block

Yields:

  • (_self)

Yield Parameters:



16
17
18
 
# File 'lib/kaseya/bms/configuration.rb', line 16

def configure
  yield self
end

#options ⇒ Object

Create a hash of options and their values



26
27
28
29
30
 
# File 'lib/kaseya/bms/configuration.rb', line 26

def options
  VALID_OPTIONS_KEYS.inject({}) do |option, key|
    option.merge!(key => send(key))
  end
end

#reset ⇒ Object 



32
33
34
35
 
# File 'lib/kaseya/bms/configuration.rb', line 32

def reset
  self.debug = DEFAULT_DEBUG
  self.user_agent = DEFAULT_USER_AGENT
end