Module: Whitehouse::Configurable
- Included in:
- Whitehouse, Client
- Defined in:
- lib/whitehouse/configurable.rb
Instance Attribute Summary collapse
-
#access_token ⇒ String
Client access token.
-
#api_endpoint ⇒ String
Base URL for API requests.
-
#connection_options ⇒ Hash
Configure connection options for Faraday.
-
#consumer_key ⇒ String
Configure OAuth app key.
-
#consumer_secret ⇒ Object
Returns the value of attribute consumer_secret.
-
#default_media_type ⇒ String
Configure preferred media type.
-
#user_agent ⇒ String
Configure User-Agent header for requests.
Class Method Summary collapse
-
.keys ⇒ Array
List of configurable keys for Client.
Instance Method Summary collapse
-
#configure {|_self| ... } ⇒ Object
Set configuration options using a block.
-
#reset! ⇒ Object
(also: #setup)
Reset configuration options to default values.
Instance Attribute Details
#access_token ⇒ String
Returns Client access token.
19 20 21 |
# File 'lib/whitehouse/configurable.rb', line 19 def access_token @access_token end |
#api_endpoint ⇒ String
Returns Base URL for API requests. default: apps.whcc.com/api.
19 20 |
# File 'lib/whitehouse/configurable.rb', line 19 attr_accessor :access_token, :api_endpoint, :connection_options, :consumer_key, :consumer_secret, :default_media_type, :user_agent |
#connection_options ⇒ Hash
Returns Configure connection options for Faraday.
19 20 |
# File 'lib/whitehouse/configurable.rb', line 19 attr_accessor :access_token, :api_endpoint, :connection_options, :consumer_key, :consumer_secret, :default_media_type, :user_agent |
#consumer_key ⇒ String
Returns Configure OAuth app key.
19 20 |
# File 'lib/whitehouse/configurable.rb', line 19 attr_accessor :access_token, :api_endpoint, :connection_options, :consumer_key, :consumer_secret, :default_media_type, :user_agent |
#consumer_secret ⇒ Object
Returns the value of attribute consumer_secret.
19 20 21 |
# File 'lib/whitehouse/configurable.rb', line 19 def consumer_secret @consumer_secret end |
#default_media_type ⇒ String
Returns Configure preferred media type.
19 20 |
# File 'lib/whitehouse/configurable.rb', line 19 attr_accessor :access_token, :api_endpoint, :connection_options, :consumer_key, :consumer_secret, :default_media_type, :user_agent |
#user_agent ⇒ String
Returns Configure User-Agent header for requests.
19 20 |
# File 'lib/whitehouse/configurable.rb', line 19 attr_accessor :access_token, :api_endpoint, :connection_options, :consumer_key, :consumer_secret, :default_media_type, :user_agent |
Class Method Details
.keys ⇒ Array
List of configurable keys for Whitehouse::Client
26 27 28 29 30 31 32 33 34 35 36 |
# File 'lib/whitehouse/configurable.rb', line 26 def keys @keys ||= [ :access_token, :api_endpoint, :connection_options, :consumer_key, :consumer_secret, :default_media_type, :user_agent ] end |
Instance Method Details
#configure {|_self| ... } ⇒ Object
Set configuration options using a block
40 41 42 |
# File 'lib/whitehouse/configurable.rb', line 40 def configure yield self end |
#reset! ⇒ Object Also known as: setup
Reset configuration options to default values
45 46 47 48 49 50 |
# File 'lib/whitehouse/configurable.rb', line 45 def reset! Whitehouse::Configurable.keys.each do |key| instance_variable_set(:"@#{key}", Whitehouse::Default.[key]) end self end |