Module: Ivapi::Default

Defined in:
lib/ivapi/default.rb

Overview

Default configuration options for Client

Constant Summary collapse

API_ENDPOINT =

Default API endpoint

'https://api.iv.lt'
USER_AGENT =

Default User Agent header string

"Ivapi ruby gem v#{Ivapi::VERSION}"
MIDDLEWARE =

Default Faraday middleware stack

Faraday::RackBuilder.new do |builder|
  builder.request :json

  builder.use FaradayMiddleware::FollowRedirects
  builder.use FaradayMiddleware::Mashify, mash_class: Ivapi::Mash
  builder.use Ivapi::Response::RenameKeys
  builder.use FaradayMiddleware::ParseJson
  builder.use Ivapi::Response::RaiseError

  builder.adapter Faraday.default_adapter
end

Class Method Summary collapse

Class Method Details

.api_endpoint ⇒ String

Default API endpoint from ENV or API_ENDPOINT

Returns:

  • (String) 


81
82
83
 
# File 'lib/ivapi/default.rb', line 81

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

.connection_options ⇒ Object 



65
66
67
68
69
70
71
 
# File 'lib/ivapi/default.rb', line 65

def connection_options
  {
    headers: {
      user_agent: user_agent
    }
  }
end

.hosting_id ⇒ Object 



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

def hosting_id
  nil
end

.middleware ⇒ String

Default middleware stack for Faraday::Connection from MIDDLEWARE

Returns:

  • (String) 


55
56
57
 
# File 'lib/ivapi/default.rb', line 55

def middleware
  MIDDLEWARE
end

.options ⇒ Hash

Configuration options

Returns:

  • (Hash) 


34
35
36
 
# File 'lib/ivapi/default.rb', line 34

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

.password ⇒ String

Default Ivapi password for Basic Auth from ENV

Returns:

  • (String) 


61
62
63
 
# File 'lib/ivapi/default.rb', line 61

def password
  ENV['IVAPI_PASSWORD']
end

.server_id ⇒ Object 



44
45
46
 
# File 'lib/ivapi/default.rb', line 44

def server_id
  nil
end

.user_agent ⇒ String

Default User-Agent header string from ENV or USER_AGENT

Returns:

  • (String) 


75
76
77
 
# File 'lib/ivapi/default.rb', line 75

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

.username ⇒ String

Default Ivapi username for Basic Auth from ENV

Returns:

  • (String) 


40
41
42
 
# File 'lib/ivapi/default.rb', line 40

def username
  ENV['IVAPI_USERNAME']
end