Module: TINAMI::Configuration
- Included in:
- TINAMI
- Defined in:
- lib/tinami/configuration.rb
Overview
Defines constants and methods related to configuration
Constant Summary collapse
- OPTIONS_KEYS =
An array of keys in the options hash when configuring a API
[ :api_key, :auth_key, :endpoint, :user_agent ].freeze
- DEFAULT_API_KEY =
By default, don’t set an application api key
nil
- DEFAULT_AUTH_KEY =
By default, don’t set an user auth key
nil
- 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.tinami.com'.freeze
- DEFAULT_USER_AGENT =
The user agent that will be sent to the API endpoint if none is set
"TINAMI/#{VERSION} (https://github.com/mitukiii/tinami-for-ruby)".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
30 31 32 |
# File 'lib/tinami/configuration.rb', line 30 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
35 36 37 38 |
# File 'lib/tinami/configuration.rb', line 35 def configure yield self self end |
#options ⇒ Object
Create a hash of options and their values
41 42 43 44 45 |
# File 'lib/tinami/configuration.rb', line 41 def OPTIONS_KEYS.inject({}) do |, key| .merge!(key => send(key)) end end |
#reset ⇒ Object
Reset all configuration options to defaults
48 49 50 51 52 53 54 |
# File 'lib/tinami/configuration.rb', line 48 def reset self.api_key = DEFAULT_API_KEY self.auth_key = DEFAULT_AUTH_KEY self.endpoint = DEFAULT_ENDPOINT self.user_agent = DEFAULT_USER_AGENT self end |