Module: Instagram::Configuration

Included in:
Instagram
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

[
  :access_token,
  :adapter,
  :client_id,
  :client_secret,
  :client_ips,
  :connection_options,
  :scope,
  :redirect_uri,
  :endpoint,
  :format,
  :proxy,
  :user_agent,
  :no_response_wrapper
].freeze
DEFAULT_ACCESS_TOKEN =

By default, don't set a user access token

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_CLIENT_ID =

By default, don't set an application ID

nil
DEFAULT_CLIENT_SECRET =

By default, don't set an application secret

nil
DEFAULT_CLIENT_IPS =

By default, don't set application IPs

nil
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://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_REDIRECT_URI =

By default, don't set an application redirect uri

nil
DEFAULT_SCOPE =

By default, don't set a user scope

nil
DEFAULT_NO_RESPONSE_WRAPPER =

By default, don't wrap responses with meta data (i.e. pagination)

false
DEFAULT_USER_AGENT =

The user agent that will be sent to the API endpoint if none is set

"Instagram Ruby Gem #{Instagram::VERSION}".freeze
VALID_FORMATS =
Note:

Not all methods support the XML format.

An array of valid request/response formats

[
:json].freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object

When this module is extended, set all configuration options to their default values


79
80
81
# File 'lib/instagram/configuration.rb', line 79

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

Yields:

  • (_self)

Yield Parameters:


84
85
86
# File 'lib/instagram/configuration.rb', line 84

def configure
  yield self
end

#optionsObject

Create a hash of options and their values


89
90
91
92
93
# File 'lib/instagram/configuration.rb', line 89

def options
  VALID_OPTIONS_KEYS.inject({}) do |option, key|
    option.merge!(key => send(key))
  end
end

#resetObject

Reset all configuration options to defaults


96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/instagram/configuration.rb', line 96

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
end