module Rundeck::Configuration
Defines constants and methods related to configuration.
Constants
- DEFAULT_USER_AGENT
The user agent that will be sent to the
API
endpoint if none is set.- VALID_OPTIONS_KEYS
An array of valid keys in the options hash when configuring a
Rundeck::API
.
Public Class Methods
extended(base)
click to toggle source
Sets all configuration options to their default values when this module is extended.
# File lib/rundeck/configuration.rb, line 15 def self.extended(base) base.reset end
Public Instance Methods
api_version()
click to toggle source
# File lib/rundeck/configuration.rb, line 31 def api_version '12' end
configure() { |self| ... }
click to toggle source
Convenience method to allow configuration options to be set in a block.
# File lib/rundeck/configuration.rb, line 20 def configure yield self end
options()
click to toggle source
Creates a hash of options and their values.
# File lib/rundeck/configuration.rb, line 25 def options VALID_OPTIONS_KEYS.reduce({}) do |option, key| option.merge!(key => send(key)) end end
reset()
click to toggle source
Resets all configuration options to the defaults.
# File lib/rundeck/configuration.rb, line 36 def reset self.endpoint = ENV['RUNDECK_ENDPOINT'] self.api_token = ENV['RUNDECK_API_TOKEN'] self.user_agent = DEFAULT_USER_AGENT end