Module: Instagram::Configuration
- Included in:
- Defined in:
- lib/instagram/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 a API
[ :adapter, :client_id, :client_secret, :access_token, :endpoint, :format, :user_agent, :proxy ].freeze
- VALID_FORMATS =
Note:
Not all methods support the XML format.
An array of valid request/response formats
[ :json].freeze
- 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_CLIENT_ID =
By default, don’t set an application ID
nil
- DEFAULT_CLIENT_SECRET =
By default, don’t set an application secret
nil
- DEFAULT_REDIRECT_URI =
By default, don’t set an application redirect uri
nil
- DEFAULT_ACCESS_TOKEN =
By default, don’t set a user access token
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
'https://api.instagram.com/v1/'.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 =
The user agent that will be sent to the API endpoint if none is set
"Instagram Ruby Gem #{Instagram::VERSION}".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
62 63 64 |
# File 'lib/instagram/configuration.rb', line 62 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
67 68 69 |
# File 'lib/instagram/configuration.rb', line 67 def configure yield self end |
#options ⇒ Object
Create a hash of options and their values
72 73 74 75 76 |
# File 'lib/instagram/configuration.rb', line 72 def VALID_OPTIONS_KEYS.inject({}) do |option, key| option.merge!(key => send(key)) end end |
#reset ⇒ Object
Reset all configuration options to defaults
79 80 81 82 83 84 85 86 87 88 |
# File 'lib/instagram/configuration.rb', line 79 def reset self.adapter = DEFAULT_ADAPTER self.client_id = DEFAULT_CLIENT_ID self.client_secret = DEFAULT_CLIENT_SECRET self.access_token = DEFAULT_ACCESS_TOKEN self.endpoint = DEFAULT_ENDPOINT self.format = DEFAULT_FORMAT self.user_agent = DEFAULT_USER_AGENT self.proxy = DEFAULT_PROXY end |