Module: Carriots::Default

Defined in:
lib/carriots/default.rb

Overview

Default configuration options for Client

Constant Summary collapse

API_ENDPOINT =

Default API endpoint

'https://api.carriots.com'.freeze
USER_AGENT =

Default User Agent header string

"Carriots Ruby Gem #{Carriots::VERSION}".freeze
MEDIA_TYPE =

Default media type

'application/vnd.carriots.v2+json'.freeze
WEB_ENDPOINT =

Default WEB endpoint

'https://carriots.com'.freeze

Class Method Summary collapse

Class Method Details

.api_endpoint ⇒ String

Default API endpoint from ENV or API_ENDPOINT

Returns:

  • (String) 


31
32
33
 
# File 'lib/carriots/default.rb', line 31

def api_endpoint
  ENV['CARRIOTS_API_ENDPOINT'] || API_ENDPOINT
end

.connection_options ⇒ Hash

Default options for Faraday::Connection

Returns:

  • (Hash) 


37
38
39
40
41
42
43
44
 
# File 'lib/carriots/default.rb', line 37

def connection_options
  {
    headers: {
      accept: default_media_type,
      user_agent: user_agent
    }
  }
end

.default_media_type ⇒ String

Default media type from ENV or MEDIA_TYPE

Returns:

  • (String) 


48
49
50
 
# File 'lib/carriots/default.rb', line 48

def default_media_type
  ENV['CARRIOTS_DEFAULT_MEDIA_TYPE'] || MEDIA_TYPE
end

.login ⇒ String

Default login from ENV

Returns:

  • (String) 


72
73
74
 
# File 'lib/carriots/default.rb', line 72

def 
  ENV['CARRIOTS_LOGIN']
end

.options ⇒ Hash

Configuration options

Returns:

  • (Hash) 


25
26
27
 
# File 'lib/carriots/default.rb', line 25

def options
  Hash[Carriots::Configurable.keys.map { |key| [key, send(key)] }]
end

.user_agent ⇒ String

Default User-Agent header string from ENV or USER_AGENT

Returns:

  • (String) 


54
55
56
 
# File 'lib/carriots/default.rb', line 54

def user_agent
  ENV['CARRIOTS_USER_AGENT'] || USER_AGENT
end

.web_endpoint ⇒ String

Default web endpoint from ENV or WEB_ENDPOINT

Returns:

  • (String) 


60
61
62
 
# File 'lib/carriots/default.rb', line 60

def web_endpoint
  ENV['CARRIOTS_WEB_ENDPOINT'] || WEB_ENDPOINT
end

.write_api_key ⇒ String

Default write api key from ENV

Returns:

  • (String) 


66
67
68
 
# File 'lib/carriots/default.rb', line 66

def write_api_key
  ENV['CARRIOTS_WRITE_API_KEY']
end