Module: Evrythng::Config
- Included in:
- Evrythng
- Defined in:
- lib/evrythng/config.rb
Overview
Defines constants and methods related to configuration
Constant Summary collapse
- VALID_OPTIONS_KEYS =
An array of valid keys in the options hash when configuring a API
[ :adapter, :connection_options, :token, :endpoint, :gateway, :proxy, :user_agent]
- DEFAULT_ADAPTER =
The adapter that will be used to connect if none is set
:net_http
- DEFAULT_CONNECTION_OPTIONS =
The Faraday connection options if none is set
{}
- DEFAULT_TOKEN =
By default, don’t set a token
nil
- DEFAULT_ENDPOINT =
The endpoint that will be used to connect if none is set
'http://evrythng.com'
- DEFAULT_PROXY =
By default, don’t use a proxy server
nil
- DEFAULT_USER_AGENT =
The user agent that will be sent to the API endpoint if none is set
"Evrythng Ruby Gem #{Evrythng::VERSION}"
- DEFAULT_GATEWAY =
By default, don’t use a gateway server
nil
Class Method Summary collapse
-
.extended(base) ⇒ Object
When this module is extended, set all configuration options to their default values.
Instance Method Summary collapse
-
#configure {|_self| ... } ⇒ Object
Convenience method to allow configuration options to be set in a block.
-
#options ⇒ Object
Create a hash of options and their values.
-
#reset ⇒ Object
Reset all configuration options to defaults.
Class Method Details
.extended(base) ⇒ Object
When this module is extended, set all configuration options to their default values
41 42 43 |
# File 'lib/evrythng/config.rb', line 41 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
46 47 48 |
# File 'lib/evrythng/config.rb', line 46 def configure yield self end |
#options ⇒ Object
Create a hash of options and their values
51 52 53 54 55 |
# File 'lib/evrythng/config.rb', line 51 def = {} VALID_OPTIONS_KEYS.each { |k| [k] = send(k) } end |
#reset ⇒ Object
Reset all configuration options to defaults
58 59 60 61 62 63 64 65 66 67 |
# File 'lib/evrythng/config.rb', line 58 def reset self.adapter = DEFAULT_ADAPTER self. = DEFAULT_CONNECTION_OPTIONS self.token = DEFAULT_TOKEN self.endpoint = DEFAULT_ENDPOINT self.proxy = DEFAULT_PROXY self.user_agent = DEFAULT_USER_AGENT self.gateway = DEFAULT_GATEWAY self end |