Module: Lvmama::Configuration
- Included in:
- Lvmama
- Defined in:
- lib/lvmama-api/configuration.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, :client_id, :client_secret, :connection_options, :endpoint, :format, :user_agent, ].freeze
- DEFAULT_ADAPTER =
Note:
The default faraday adapter is Net::HTTP.
The adapter that will be used to connect if none is set
Faraday.default_adapter
- DEFAULT_CLIENT_ID =
By default, don’t set an application ID
nil
- DEFAULT_CLIENT_SECRET =
By default, don’t set an application secret
nil
- DEFAULT_CONNECTION_OPTIONS =
By default, don’t set any connection options
{}
- DEFAULT_ENDPOINT =
Note:
There is no reason to use any other endpoint at this time
The endpoint that will be used to connect if none is set
'http://api.lvmama.com'.freeze
- DEFAULT_FORMAT =
Note:
JSON is the only available format at this time
The response format appended to the path and sent in the ‘Accept’ header if none is set
:json
- DEFAULT_USER_AGENT =
The user agent that will be sent to the API endpoint if none is set
"Lvmama Ruby Gem #{Lvmama::VERSION}".freeze
- VALID_FORMATS =
Note:
Not all methods support the XML format.
An array of valid request/response formats
[ :json].freeze
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
59 60 61 |
# File 'lib/lvmama-api/configuration.rb', line 59 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
64 65 66 |
# File 'lib/lvmama-api/configuration.rb', line 64 def configure yield self end |
#options ⇒ Object
Create a hash of options and their values
69 70 71 72 73 |
# File 'lib/lvmama-api/configuration.rb', line 69 def VALID_OPTIONS_KEYS.inject({}) do |option, key| option.merge!(key => send(key)) end end |
#reset ⇒ Object
Reset all configuration options to defaults
76 77 78 79 80 81 82 83 84 |
# File 'lib/lvmama-api/configuration.rb', line 76 def reset self.adapter = DEFAULT_ADAPTER self.client_id = DEFAULT_CLIENT_ID self.client_secret = DEFAULT_CLIENT_SECRET self. = DEFAULT_CONNECTION_OPTIONS self.endpoint = DEFAULT_ENDPOINT self.format = DEFAULT_FORMAT self.user_agent = DEFAULT_USER_AGENT end |