module Tumblife::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_CONSUMER_KEY
By default, don't set a consumer key
- DEFAULT_CONSUMER_SECRET
By default, don't set a consumer secret
- 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_OAUTH_TOKEN
By default, don't set an oauth token
- DEFAULT_OAUTH_TOKEN_SECRET
By default, don't set an oauth token secret
- DEFAULT_PROXY
By default, don't use a proxy server
- DEFAULT_USER_AGENT
The user agent that will be sent to the API endpoint if none is set
- VALID_OPTIONS_KEYS
An array of keys in the options hash when configuring a {Tumblife::Client}
Public Class Methods
When this module is extended, set all configuration options to their default values
# File lib/tumblife/configuration.rb, line 50 def self.extended(base) base.reset end
Public Instance Methods
Convenience method to allow configuration options to be set in a block
# File lib/tumblife/configuration.rb, line 55 def configure yield self self end
Create a hash of options and their values
# File lib/tumblife/configuration.rb, line 61 def options VALID_OPTIONS_KEYS.inject({}) do |options, key| options.merge!(key => send(key)) end end
Reset all configuration options to defaults
# File lib/tumblife/configuration.rb, line 68 def reset self.adapter = DEFAULT_ADAPTER self.consumer_key = DEFAULT_CONSUMER_KEY self.consumer_secret = DEFAULT_CONSUMER_SECRET self.oauth_token = DEFAULT_OAUTH_TOKEN self.oauth_token_secret = DEFAULT_OAUTH_TOKEN_SECRET self.endpoint = DEFAULT_ENDPOINT self.proxy = DEFAULT_PROXY self.user_agent = DEFAULT_USER_AGENT self end