Class: DataPlaneApi::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/data_plane_api/configuration.rb

Overview

Stores configuration options for the HAProxy Data Plane API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url: nil, global: false, basic_user: nil, basic_password: nil, logger: nil, timeout: nil, parent: nil) ⇒ Configuration

Returns a new instance of Configuration.

Parameters:

  • url (String, nil) (defaults to: nil)
  • global (Boolean) (defaults to: false) —

    whether this object is used as a global store of settings

  • basic_user (String, nil) (defaults to: nil) —

    Basic Auth username.

  • basic_password (String, nil) (defaults to: nil) —

    Basic Auth password.

  • logger (Logger, nil) (defaults to: nil)
  • timeout (Integer, nil) (defaults to: nil)
  • parent (self, nil) (defaults to: nil) 


29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/data_plane_api/configuration.rb', line 29

def initialize(
  url: nil,
  global: false,
  basic_user: nil,
  basic_password: nil,
  logger: nil,
  timeout: nil,
  parent: nil
)

  @global = global
  @url = url
  @basic_user = basic_user
  @basic_password = basic_password
  @logger = logger
  @timeout = timeout
  @parent = parent

  return unless global

  @logger ||= ::Logger.new($stdout)
  @timeout ||= 10
end

Instance Attribute Details

#basic_password ⇒ String?

Returns Basic Auth password.

Returns:

  • (String, nil) —

    Basic Auth password.



79
80
81
82
83
 
# File 'lib/data_plane_api/configuration.rb', line 79

def basic_password
  return @basic_password if @global || @basic_password

  parent.basic_password
end

#basic_user ⇒ String?

Returns Basic Auth username.

Returns:

  • (String, nil) —

    Basic Auth username.



72
73
74
75
76
 
# File 'lib/data_plane_api/configuration.rb', line 72

def basic_user
  return @basic_user if @global || @basic_user

  parent.basic_user
end

#global ⇒ Boolean (readonly)

Returns whether this object is used as a global store of settings.

Returns:

  • (Boolean) —

    whether this object is used as a global store of settings



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

def global
  @global
end

#logger ⇒ Logger?

Returns:

  • (Logger, nil) 


86
87
88
89
90
 
# File 'lib/data_plane_api/configuration.rb', line 86

def logger
  return @logger if @global || @logger

  parent.logger
end

#timeout ⇒ Integer?

Returns:

  • (Integer, nil) 


93
94
95
96
97
 
# File 'lib/data_plane_api/configuration.rb', line 93

def timeout
  return @timeout if @global || @timeout

  parent.timeout
end

#url ⇒ String, ...

Returns:

  • (String, URI::Generic, nil) 


65
66
67
68
69
 
# File 'lib/data_plane_api/configuration.rb', line 65

def url
  return @url if @global || @url

  parent.url
end

Instance Method Details

#connection ⇒ Faraday::Connection

Returns:

  • (Faraday::Connection) 


54
55
56
 
# File 'lib/data_plane_api/configuration.rb', line 54

def connection
  @connection || build_connection
end

#freeze ⇒ void

This method returns an undefined value.



59
60
61
62
 
# File 'lib/data_plane_api/configuration.rb', line 59

def freeze
  @connection = build_connection
  super
end

#parent ⇒ self?

Returns:

  • (self, nil) 


100
101
102
103
104
 
# File 'lib/data_plane_api/configuration.rb', line 100

def parent
  return if @global

  @parent || CONFIG
end