Class: OpencodeClient::Configuration

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|_self| ... } ⇒ Configuration

Returns a new instance of Configuration.

Yields:

  • (_self)

Yield Parameters:



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/opencode_client/configuration.rb', line 129

def initialize
  @scheme = 'http'
  @host = 'localhost'
  @base_path = ''
  @server_index = nil
  @server_operation_index = {}
  @server_variables = {}
  @server_operation_variables = {}
  @api_key = {}
  @api_key_prefix = {}
  @client_side_validation = true
  @ssl = nil
  @proxy = nil
  @timeout = 60
  @configure_session_blocks = []
  @debugging = false
  @ignore_operation_servers = false
  @inject_format = false
  @force_ending_format = false
  @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)

  yield(self) if block_given?
end

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



63
64
65
 
# File 'lib/opencode_client/configuration.rb', line 63

def access_token
  @access_token
end

#access_token_getter ⇒ Proc

Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2. Overrides the access_token if set

Returns:

  • (Proc) 


68
69
70
 
# File 'lib/opencode_client/configuration.rb', line 68

def access_token_getter
  @access_token_getter
end

#api_key ⇒ Hash

Defines API keys used with API Key authentications.

Examples:

parameter name is “api_key”, API key is “xxx” (e.g. “api_key=xxx” in query string)

config.api_key['api_key'] = 'xxx'

Returns:

  • (Hash) —

    key: parameter name, value: parameter value (API key)



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

def api_key
  @api_key
end

#api_key_prefix ⇒ Hash

Defines API key prefixes used with API Key authentications.

Examples:

parameter name is “Authorization”, API key prefix is “Token” (e.g. “Authorization: Token xxx” in headers)

config.api_key_prefix['api_key'] = 'Token'

Returns:

  • (Hash) —

    key: parameter name, value: API key prefix



50
51
52
 
# File 'lib/opencode_client/configuration.rb', line 50

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



22
23
24
 
# File 'lib/opencode_client/configuration.rb', line 22

def base_path
  @base_path
end

#client_side_validation ⇒ true, false

Set this to false to skip client side validation in the operation. Default to true.

Returns:

  • (true, false) 


110
111
112
 
# File 'lib/opencode_client/configuration.rb', line 110

def client_side_validation
  @client_side_validation
end

#debugging ⇒ true, false

Set this to enable/disable debugging. When enabled (set to true), HTTP request/response details will be logged with ‘logger.debug` (see the `logger` attribute). Default to false.

Returns:

  • (true, false) 


80
81
82
 
# File 'lib/opencode_client/configuration.rb', line 80

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



127
128
129
 
# File 'lib/opencode_client/configuration.rb', line 127

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



19
20
21
 
# File 'lib/opencode_client/configuration.rb', line 19

def host
  @host
end

#ignore_operation_servers ⇒ true, false

Set this to ignore operation servers for the API client. This is useful when you need to send requests to a different server than the one specified in the OpenAPI document. Will default to the base url defined in the spec but can be overridden by setting ‘scheme`, `host`, `base_path` directly. Default to false.

Returns:

  • (true, false) 


88
89
90
 
# File 'lib/opencode_client/configuration.rb', line 88

def ignore_operation_servers
  @ignore_operation_servers
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



125
126
127
 
# File 'lib/opencode_client/configuration.rb', line 125

def inject_format
  @inject_format
end

#logger ⇒ #debug

Defines the logger used for debugging. Default to ‘Rails.logger` (when in Rails) or logging to STDOUT.

Returns:

  • (#debug) 


94
95
96
 
# File 'lib/opencode_client/configuration.rb', line 94

def logger
  @logger
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


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

def password
  @password
end

#proxy ⇒ Hash{Symbol => Object}?

Proxy setting HTTP Proxy settings (see honeyryderchuck.gitlab.io/httpx/wiki/Proxy#options)

Returns:

  • (Hash{Symbol => Object}, nil) 


122
123
124
 
# File 'lib/opencode_client/configuration.rb', line 122

def proxy
  @proxy
end

#return_binary_data ⇒ Object

Set this to return data as binary instead of downloading a temp file. When enabled (set to true) HTTP responses with return type ‘File` will be returned as a stream of binary data. Default to false.



73
74
75
 
# File 'lib/opencode_client/configuration.rb', line 73

def return_binary_data
  @return_binary_data
end

#scheme ⇒ Object

Defines url scheme



16
17
18
 
# File 'lib/opencode_client/configuration.rb', line 16

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



25
26
27
 
# File 'lib/opencode_client/configuration.rb', line 25

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



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

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



34
35
36
 
# File 'lib/opencode_client/configuration.rb', line 34

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



31
32
33
 
# File 'lib/opencode_client/configuration.rb', line 31

def server_variables
  @server_variables
end

#ssl ⇒ Hash{Symbol => Object}, ...

TLS/SSL setting You can use this to customize SSL Context settings (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html to know which ones).

Returns:

  • (Hash{Symbol => Object}, OpenSSL::SSL::SSLContext, nil) 


117
118
119
 
# File 'lib/opencode_client/configuration.rb', line 117

def ssl
  @ssl
end

#temp_folder_path ⇒ String

Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use ‘Tempfile`.

Returns:

  • (String) 


101
102
103
 
# File 'lib/opencode_client/configuration.rb', line 101

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

The time limit for HTTP request in seconds. Default to 0 (never times out).



105
106
107
 
# File 'lib/opencode_client/configuration.rb', line 105

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


55
56
57
 
# File 'lib/opencode_client/configuration.rb', line 55

def username
  @username
end

Class Method Details

.default ⇒ Object

The default Configuration object.



154
155
156
 
# File 'lib/opencode_client/configuration.rb', line 154

def self.default
  @@default ||= Configuration.new
end

Instance Method Details

#access_token_with_refresh ⇒ Object

Gets access_token using access_token_getter or uses the static access_token



202
203
204
205
 
# File 'lib/opencode_client/configuration.rb', line 202

def access_token_with_refresh
  return access_token if access_token_getter.nil?
  access_token_getter.call
end

#api_key_with_prefix(param_name, param_alias = nil) ⇒ Object

Gets API key (with prefix if set).

Parameters:

  • param_name (String) —

    the parameter name of API key auth



191
192
193
194
195
196
197
198
199
 
# File 'lib/opencode_client/configuration.rb', line 191

def api_key_with_prefix(param_name, param_alias = nil)
  key = @api_key[param_name]
  key = @api_key.fetch(param_alias, key) unless param_alias.nil?
  if @api_key_prefix[param_name]
    "#{@api_key_prefix[param_name]} #{key}"
  else
    key
  end
end

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



213
214
215
216
 
# File 'lib/opencode_client/configuration.rb', line 213

def auth_settings
  {
  }
end

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings



179
180
181
182
183
184
185
186
187
 
# File 'lib/opencode_client/configuration.rb', line 179

def base_url(operation = nil)
  return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if ignore_operation_servers
  if operation_server_settings.key?(operation) then
    index = server_operation_index.fetch(operation, server_index)
    server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
  else
    server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
  end
end

#basic_auth_token ⇒ Object

Gets Basic Auth token string



208
209
210
 
# File 'lib/opencode_client/configuration.rb', line 208

def basic_auth_token
  'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
end

#configure(session) {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:



158
159
160
 
# File 'lib/opencode_client/configuration.rb', line 158

def configure
  yield(self) if block_given?
end

#configure_session(&block) ⇒ Object

Configure Httpx session directly.

“‘ c.configure_session do |http|

http.plugin(:follow_redirects).with(debug: STDOUT, debug_level: 1)

end “‘

Parameters:

  • block (Proc) —

    ‘#call`able object that takes one arg, the connection



277
278
279
 
# File 'lib/opencode_client/configuration.rb', line 277

def configure_session(&block)
  @configure_session_blocks << block
end

#operation_server_settings ⇒ Object 



228
229
230
231
 
# File 'lib/opencode_client/configuration.rb', line 228

def operation_server_settings
  {
  }
end

#server_settings ⇒ Object

Returns an array of Server setting



219
220
221
222
223
224
225
226
 
# File 'lib/opencode_client/configuration.rb', line 219

def server_settings
  [
    {
      url: "",
      description: "No description provided",
    }
  ]
end

#server_url(index, variables = {}, servers = nil) ⇒ Object

Returns URL based on server settings

Parameters:

  • index —

    array index of the server settings

  • variables (defaults to: {}) —

    hash of variable and the corresponding value



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/opencode_client/configuration.rb', line 237

def server_url(index, variables = {}, servers = nil)
  servers = server_settings if servers == nil

  # check array index out of bound
  if (index.nil? || index < 0 || index >= servers.size)
    fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
  end

  server = servers[index]
  url = server[:url]

  return url unless server.key? :variables

  # go through variable and assign a value
  server[:variables].each do |name, variable|
    if variables.key?(name)
      if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
        url.gsub! "{" + name.to_s + "}", variables[name]
      else
        fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
      end
    else
      # use default value
      url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
    end
  end

  url
end