module Wwo::Configuration

Constants

DEFAULT_FREE_ENDPOINT

Default API endpoint

DEFAULT_PREMIUM_ENDPOINT

Attributes

api_cache_store[W]

Cache Object

api_endpoint[W]

Forecast API endpoint

api_key[W]

API key

default_params[RW]

Default parameters

use_premium_api[W]

Cache Object

Public Instance Methods

api_cache_store() click to toggle source

API Cache Object

# File lib/wwo/configuration.rb, line 47
def api_cache_store
  @api_cache_store
end
api_endpoint() click to toggle source

API endpoint

# File lib/wwo/configuration.rb, line 33
def api_endpoint
  @api_endpoint.nil? ? ( use_premium_api? ? DEFAULT_PREMIUM_ENDPOINT : DEFAULT_FREE_ENDPOINT ) : @api_endpoint
end
api_key() click to toggle source

API key

# File lib/wwo/configuration.rb, line 38
def api_key
  @api_key
end
configure() { |self| ... } click to toggle source

Example:

Wwo.configure do |configuration|
  configuration.use_peremium_api = true
  configuration.api_key = 'this-is-your-api-key'
end
# File lib/wwo/configuration.rb, line 28
def configure
  yield self
end
use_premium_api() click to toggle source
# File lib/wwo/configuration.rb, line 42
def use_premium_api
  @use_premium_api
end

Private Instance Methods

use_premium_api?() click to toggle source
# File lib/wwo/configuration.rb, line 53
def use_premium_api?
  use_premium_api == true
end