module Lvmama::Configuration
Defines constants and methods related to configuration
Constants
- DEFAULT_ADAPTER
The adapter that will be used to connect if none is set
@note The default faraday adapter is Net::HTTP.
- DEFAULT_CLIENT_ID
By default, don't set an application ID
- DEFAULT_CLIENT_SECRET
By default, don't set an application secret
- DEFAULT_CONNECTION_OPTIONS
By default, don't set any connection options
- DEFAULT_ENDPOINT
The endpoint that will be used to connect if none is set
@note There is no reason to use any other endpoint at this time
- DEFAULT_FORMAT
The response format appended to the path and sent in the 'Accept' header if none is set
@note JSON is the only available format at this time
- DEFAULT_USER_AGENT
The user agent that will be sent to the
API
endpoint if none is set- VALID_FORMATS
An array of valid request/response formats
@note Not all methods support the XML format.
- VALID_OPTIONS_KEYS
An array of valid keys in the options hash when configuring a {Lvmama::API}
Public Class Methods
When this module is extended, set all configuration options to their default values
# File lib/lvmama-api/configuration.rb, line 59 def self.extended(base) base.reset end
Public Instance Methods
Convenience method to allow configuration options to be set in a block
# File lib/lvmama-api/configuration.rb, line 64 def configure yield self end
Create a hash of options and their values
# File lib/lvmama-api/configuration.rb, line 69 def options VALID_OPTIONS_KEYS.inject({}) do |option, key| option.merge!(key => send(key)) end end
Reset all configuration options to defaults
# 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.connection_options = DEFAULT_CONNECTION_OPTIONS self.endpoint = DEFAULT_ENDPOINT self.format = DEFAULT_FORMAT self.user_agent = DEFAULT_USER_AGENT end