Module: Dirigible::Configuration

Included in:
Dirigible
Defined in:
lib/dirigible/configuration.rb

Constant Summary collapse

VALID_OPTION_KEYS = 
[
  :app_key,
  :master_secret,
  :endpoint,
  :http_adapter,
  :proxy,
  :user_agent
]
DEFAULT_APP_KEY =

By default, don’t set app key.

nil.freeze
DEFAULT_MASTER_SECRET =

By default, don’t set the master secret.

nil.freeze
DEFAULT_ENDPOINT =

The endpoint that will be used to authorize a user if none is set.

'https://go.urbanairship.com/api'.freeze
DEFAULT_HTTP_ADAPTER =

The Faraday HTTP adapter to be used.

Faraday.default_adapter
DEFAULT_PROXY =

By default, don’t set a proxy server.

nil.freeze
DEFAULT_USER_AGENT =

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

"dirigible gem v#{Dirigible::VERSION}"

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.



35
36
37
 
# File 'lib/dirigible/configuration.rb', line 35

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:



41
42
43
 
# File 'lib/dirigible/configuration.rb', line 41

def configure
  yield self
end

#options ⇒ Object

Create a hash of options and their values.



46
47
48
49
50
 
# File 'lib/dirigible/configuration.rb', line 46

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

#reset ⇒ Object

Reset all configuration options to default.



53
54
55
56
57
58
59
60
 
# File 'lib/dirigible/configuration.rb', line 53

def reset
  self.app_key = DEFAULT_APP_KEY
  self.master_secret = DEFAULT_MASTER_SECRET
  self.endpoint = DEFAULT_ENDPOINT
  self.http_adapter = DEFAULT_HTTP_ADAPTER
  self.proxy = DEFAULT_PROXY
  self.user_agent = DEFAULT_USER_AGENT
end