Module: Dnsimple::Default

Defined in:
lib/dnsimple/default.rb

Overview

Default configuration options for Client

Constant Summary collapse

BASE_URL =

Default API endpoint

"https://api.dnsimple.com/"
USER_AGENT =

Default User Agent header

"dnsimple-ruby/#{VERSION}".freeze

Class Method Summary collapse

Class Method Details

.access_token ⇒ String

Default DNSimple access token for OAuth authentication from ENV

Returns:

  • (String) 


53
54
55
 
# File 'lib/dnsimple/default.rb', line 53

def access_token
  ENV.fetch("DNSIMPLE_ACCESS_TOKEN", nil)
end

.base_url ⇒ String

Default API endpoint from ENV or BASE_URL

Returns:

  • (String) 


35
36
37
 
# File 'lib/dnsimple/default.rb', line 35

def base_url
  ENV.fetch("DNSIMPLE_BASE_URL", BASE_URL)
end

.domain_api_token ⇒ String

Default DNSimple Domain API Token for Token Auth from ENV

Returns:

  • (String) 


59
60
61
 
# File 'lib/dnsimple/default.rb', line 59

def domain_api_token
  ENV.fetch("DNSIMPLE_API_DOMAIN_TOKEN", nil)
end

.keys ⇒ Array

List of configurable keys for Client

Returns:

  • (Array) —

    of option keys



15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/dnsimple/default.rb', line 15

def keys
  @keys ||= [
    :base_url,
    :username,
    :password,
    :access_token,
    :domain_api_token,
    :user_agent,
    :proxy,
  ]
end

.options ⇒ Hash

Configuration options

Returns:

  • (Hash) 


29
30
31
 
# File 'lib/dnsimple/default.rb', line 29

def options
  keys.to_h { |key| [key, send(key)] }
end

.password ⇒ String

Default DNSimple password for Basic Auth from ENV

Returns:

  • (String) 


47
48
49
 
# File 'lib/dnsimple/default.rb', line 47

def password
  ENV.fetch("DNSIMPLE_PASSWORD", nil)
end

.proxy ⇒ String

Default Proxy address:port from ENV

Returns:

  • (String) 


71
72
73
 
# File 'lib/dnsimple/default.rb', line 71

def proxy
  ENV.fetch("DNSIMPLE_PROXY", nil)
end

.user_agent ⇒ String

Default User-Agent header string from ENV

Returns:

  • (String) 


65
66
67
 
# File 'lib/dnsimple/default.rb', line 65

def user_agent
  ENV.fetch("DNSIMPLE_USER_AGENT", nil)
end

.username ⇒ String

Default DNSimple username for Basic Auth from ENV

Returns:

  • (String) 


41
42
43
 
# File 'lib/dnsimple/default.rb', line 41

def username
  ENV.fetch("DNSIMPLE_USERNAME", nil)
end