Module: RandomApi::Configuration
- Included in:
- RandomApi
- Defined in:
- lib/randomapi/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 API
[ :api_key, :api_id, :adapter, :connection_options, :endpoint, :format, :proxy, :user_agent ].freeze
- DEFAULT_API_KEY =
By default, don’t set api key
nil
- DEFAULT_API_ID =
By default, don’t set api id
nil
- 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_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
'https://randomapi.com/api/'.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_PROXY =
By default, don’t use a proxy server
nil
- DEFAULT_USER_AGENT =
""
- VALID_FORMATS =
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
56 57 58 |
# File 'lib/randomapi/configuration.rb', line 56 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
61 62 63 |
# File 'lib/randomapi/configuration.rb', line 61 def configure yield self end |
#options ⇒ Object
Create a hash of options and their values
66 67 68 69 70 |
# File 'lib/randomapi/configuration.rb', line 66 def VALID_OPTIONS_KEYS.inject({}) do |option, key| option.merge!(key => send(key)) end end |
#reset ⇒ Object
Reset all configuration options to defaults
73 74 75 76 77 78 79 80 81 82 |
# File 'lib/randomapi/configuration.rb', line 73 def reset self.api_key = DEFAULT_API_KEY self.api_id = DEFAULT_API_ID self.adapter = DEFAULT_ADAPTER self. = DEFAULT_CONNECTION_OPTIONS self.endpoint = DEFAULT_ENDPOINT self.format = DEFAULT_FORMAT self.proxy = DEFAULT_PROXY self.user_agent = DEFAULT_USER_AGENT end |