Module: Wwo::Configuration

Included in:
Wwo
Defined in:
lib/wwo/configuration.rb

Constant Summary collapse

DEFAULT_FREE_ENDPOINT =

Default API endpoint

'https://api.worldweatheronline.com/free/v2'
DEFAULT_PREMIUM_ENDPOINT = 
'https://api.worldweatheronline.com/premium/v1'

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#api_cache_store ⇒ Object

API Cache Object



47
48
49
 
# File 'lib/wwo/configuration.rb', line 47

def api_cache_store
  @api_cache_store
end

#api_endpoint ⇒ Object

API endpoint



33
34
35
 
# 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 ⇒ Object

API key



38
39
40
 
# File 'lib/wwo/configuration.rb', line 38

def api_key
  @api_key
end

#default_params ⇒ Object

Default parameters



20
21
22
 
# File 'lib/wwo/configuration.rb', line 20

def default_params
  @default_params
end

#use_premium_api ⇒ Object 



42
43
44
 
# File 'lib/wwo/configuration.rb', line 42

def use_premium_api
  @use_premium_api
end

Instance Method Details

#configure {|_self| ... } ⇒ Object

Example:

Wwo.configure do |configuration|
  configuration.use_peremium_api = true
  configuration.api_key = 'this-is-your-api-key'
end

Yields:

  • (_self)

Yield Parameters:



28
29
30
 
# File 'lib/wwo/configuration.rb', line 28

def configure
  yield self
end