module Instagram::Configuration
Defines constants and methods related to configuration
Constants
- DEFAULT_ACCESS_TOKEN
By default, don't set a user access token
- DEFAULT_ADAPTER
The adapter that will be used to connect if none is set
@note The default faraday adapter is Net::HTTP.
- DEFAULT_CLIENT_ID
By default, don't set an application ID
- DEFAULT_CLIENT_IPS
By default, don't set application IPs
- DEFAULT_CLIENT_SECRET
By default, don't set an application secret
- DEFAULT_CONNECTION_OPTIONS
By default, don't set any connection options
- 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_FORMAT
The response format appended to the path and sent in the 'Accept' header if none is set
@note JSON is the only available format at this time
- DEFAULT_LOUD_LOGGER
By default, don't turn on loud logging
- DEFAULT_NO_RESPONSE_WRAPPER
By default, don't wrap responses with meta data (i.e. pagination)
- DEFAULT_PROXY
By default, don't use a proxy server
- DEFAULT_REDIRECT_URI
By default, don't set an application redirect uri
- DEFAULT_SCOPE
By default, don't set a user scope
- DEFAULT_SIGN_REQUESTS
By default, requests are not signed
- DEFAULT_USER_AGENT
The user agent that will be sent to the
API
endpoint if none is set- VALID_FORMATS
An array of valid request/response formats
@note Not all methods support the XML format.
- VALID_OPTIONS_KEYS
An array of valid keys in the options hash when configuring a {Instagram::API}
Public Class Methods
When this module is extended, set all configuration options to their default values
# File lib/instagram/configuration.rb, line 90 def self.extended(base) base.reset end
Public Instance Methods
Convenience method to allow configuration options to be set in a block
# File lib/instagram/configuration.rb, line 95 def configure yield self end
Create a hash of options and their values
# File lib/instagram/configuration.rb, line 100 def options VALID_OPTIONS_KEYS.inject({}) do |option, key| option.merge!(key => send(key)) end end
Reset all configuration options to defaults
# File lib/instagram/configuration.rb, line 107 def reset self.access_token = DEFAULT_ACCESS_TOKEN self.adapter = DEFAULT_ADAPTER self.client_id = DEFAULT_CLIENT_ID self.client_secret = DEFAULT_CLIENT_SECRET self.client_ips = DEFAULT_CLIENT_IPS self.connection_options = DEFAULT_CONNECTION_OPTIONS self.scope = DEFAULT_SCOPE self.redirect_uri = DEFAULT_REDIRECT_URI self.endpoint = DEFAULT_ENDPOINT self.format = DEFAULT_FORMAT self.proxy = DEFAULT_PROXY self.user_agent = DEFAULT_USER_AGENT self.no_response_wrapper= DEFAULT_NO_RESPONSE_WRAPPER self.loud_logger = DEFAULT_LOUD_LOGGER self.sign_requests = DEFAULT_SIGN_REQUESTS end