Class: Regentanz::Configuration

Inherits:

Object

• Object
• Regentanz::Configuration

Defined in:

lib/regentanz/configuration.rb

Constant Summary

DEFAULT_OPTIONS =

[
  :base_url,
  :cache_backend,
  :cache_dir,
  :cache_prefix,
  :cache_ttl,
  :retry_marker,
  :retry_ttl
]

OPTIONS =

DEFAULT_OPTIONS + [
  :do_not_get_weather,
  :suppress_stderr_output
]

@@default_base_url =

Define default values

"http://www.google.com/ig/api"

@@default_cache_backend =

Regentanz::Cache::File

@@default_cache_dir =

Dir.tmpdir

@@default_cache_prefix =

"regentanz"

@@default_cache_ttl =

4 hours

14400

@@default_retry_ttl =

1 hour

3600

@@default_retry_marker =

File.join(@@default_cache_dir, "#{@@default_cache_prefix}_api_retry.txt")

Instance Method Summary

• #initialize(*args) ⇒ Configuration constructor

  Stores global configuration information for Regentanz.

Constructor Details

#initialize(*args) ⇒ Configuration

Stores global configuration information for Regentanz.

Default Options

• base_url: HTTP API, request-specific calls will be appended (default: http://www.google.com/ig/api)

• cache_backend: defaults to Regentanz::Cache::File

• cache_dir: defaults to Dir.tmpdir

• cache_prefix: String to prefix both cache file and retry_marker (if not specified otherwise) with

• cache_ttl: time in seconds for which cache data is considered valid. Default: 14400 (4 hours).

• retry_ttl: time in seconds Regentanz should wait until it tries to call the API again when it failed before. Default: 3600 (1 hour).

• retry_marker: persist a marker-file here to indicate a failed API state. Supply a full pathname.

Options

• do_not_get_weather: don’t try to retrieve weather data, neither from cache nor remote API. Intended for testing.

• suppress_stderr_output: called from GoogleWeather#error_output, silences Regentanz’ output. Intended for testing.

# File 'lib/regentanz/configuration.rb', line 47

def initialize(*args)
  DEFAULT_OPTIONS.each do |option|
    self.send(:"#{option}=", self.class.send(:class_variable_get, :"@@default_#{option}") )
  end
end