dkron-rb 0.9.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (65) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +3 -0
  3. data/Gemfile.lock +65 -0
  4. data/LICENSE +201 -0
  5. data/README.md +98 -0
  6. data/Rakefile +6 -0
  7. data/bin/console +14 -0
  8. data/bin/setup +8 -0
  9. data/config.json +5 -0
  10. data/dkron-rb-0.0.1.gem +0 -0
  11. data/dkron-rb-0.0.2.gem +0 -0
  12. data/dkron-rb.gemspec +55 -0
  13. data/docs/Agent.md +7 -0
  14. data/docs/DefaultApi.md +131 -0
  15. data/docs/Execution.md +13 -0
  16. data/docs/ExecutionsApi.md +55 -0
  17. data/docs/InlineResponse200.md +10 -0
  18. data/docs/Job.md +24 -0
  19. data/docs/JobsApi.md +237 -0
  20. data/docs/MainApi.md +90 -0
  21. data/docs/Member.md +18 -0
  22. data/docs/MembersApi.md +49 -0
  23. data/docs/Serf.md +7 -0
  24. data/docs/Status.md +7 -0
  25. data/docs/Tags.md +7 -0
  26. data/git_push.sh +67 -0
  27. data/lib/dkron-rb.rb +47 -0
  28. data/lib/dkron-rb/api/default_api.rb +193 -0
  29. data/lib/dkron-rb/api/executions_api.rb +91 -0
  30. data/lib/dkron-rb/api/jobs_api.rb +315 -0
  31. data/lib/dkron-rb/api/members_api.rb +87 -0
  32. data/lib/dkron-rb/api_client.rb +378 -0
  33. data/lib/dkron-rb/api_error.rb +47 -0
  34. data/lib/dkron-rb/configuration.rb +207 -0
  35. data/lib/dkron-rb/cron.rb +152 -0
  36. data/lib/dkron-rb/models/agent.rb +152 -0
  37. data/lib/dkron-rb/models/execution.rb +250 -0
  38. data/lib/dkron-rb/models/inline_response_200.rb +181 -0
  39. data/lib/dkron-rb/models/job.rb +369 -0
  40. data/lib/dkron-rb/models/member.rb +301 -0
  41. data/lib/dkron-rb/models/serf.rb +152 -0
  42. data/lib/dkron-rb/models/status.rb +190 -0
  43. data/lib/dkron-rb/models/tags.rb +152 -0
  44. data/lib/dkron-rb/numeric_seconds.rb +48 -0
  45. data/lib/dkron-rb/version.rb +26 -0
  46. data/lib/dkron.rb +9 -0
  47. data/pkg/dkron-rb-0.9.2.gem +0 -0
  48. data/seeds.rb +18 -0
  49. data/spec/api/default_api_spec.rb +80 -0
  50. data/spec/api/executions_api_spec.rb +51 -0
  51. data/spec/api/jobs_api_spec.rb +114 -0
  52. data/spec/api/main_api_spec.rb +65 -0
  53. data/spec/api/members_api_spec.rb +50 -0
  54. data/spec/api_client_spec.rb +237 -0
  55. data/spec/configuration_spec.rb +53 -0
  56. data/spec/models/agent_spec.rb +36 -0
  57. data/spec/models/execution_spec.rb +96 -0
  58. data/spec/models/inline_response_200_spec.rb +66 -0
  59. data/spec/models/job_spec.rb +186 -0
  60. data/spec/models/member_spec.rb +146 -0
  61. data/spec/models/serf_spec.rb +36 -0
  62. data/spec/models/status_spec.rb +36 -0
  63. data/spec/models/tags_spec.rb +36 -0
  64. data/spec/spec_helper.rb +122 -0
  65. metadata +309 -0
@@ -0,0 +1,378 @@
1
+ =begin
2
+ #Dkron REST API
3
+
4
+ #You can communicate with Dkron using a RESTful JSON API over HTTP. Dkron nodes usually listen on port `8080` for API requests. All examples in this section assume that you've found a running leader at `localhost:8080`. Dkron implements a RESTful JSON API over HTTP to communicate with software clients. Dkron listens in port `8080` by default. All examples in this section assume that you're using the default port. Default API responses are unformatted JSON add the `pretty=true` param to format the response.
5
+
6
+ OpenAPI spec version: 0.9.2
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ Licensed under the Apache License, Version 2.0 (the "License");
11
+ you may not use this file except in compliance with the License.
12
+ You may obtain a copy of the License at
13
+
14
+ http://www.apache.org/licenses/LICENSE-2.0
15
+
16
+ Unless required by applicable law or agreed to in writing, software
17
+ distributed under the License is distributed on an "AS IS" BASIS,
18
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ See the License for the specific language governing permissions and
20
+ limitations under the License.
21
+
22
+ =end
23
+
24
+ require 'date'
25
+ require 'json'
26
+ require 'logger'
27
+ require 'tempfile'
28
+ require 'typhoeus'
29
+ require 'uri'
30
+
31
+ module Dkron
32
+ class ApiClient
33
+ # The Configuration object holding settings to be used in the API client.
34
+ attr_accessor :config
35
+
36
+ # Defines the headers to be used in HTTP requests of all API calls by default.
37
+ #
38
+ # @return [Hash]
39
+ attr_accessor :default_headers
40
+
41
+ # Initializes the ApiClient
42
+ # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
43
+ def initialize(config = Configuration.default)
44
+ @config = config
45
+ @user_agent = "Swagger-Codegen/#{VERSION}/ruby"
46
+ @default_headers = {
47
+ 'Content-Type' => "application/json",
48
+ 'User-Agent' => @user_agent
49
+ }
50
+ end
51
+
52
+ def self.default
53
+ @@default ||= ApiClient.new
54
+ end
55
+
56
+ # Call an API with given options.
57
+ #
58
+ # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
59
+ # the data deserialized from response body (could be nil), response status code and response headers.
60
+ def call_api(http_method, path, opts = {})
61
+ request = build_request(http_method, path, opts)
62
+ response = request.run
63
+
64
+ if @config.debugging
65
+ @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
66
+ end
67
+
68
+ unless response.success?
69
+ fail ApiError.new(:code => response.code,
70
+ :response_headers => response.headers,
71
+ :response_body => response.body),
72
+ response.status_message
73
+ end
74
+
75
+ if opts[:return_type]
76
+ data = deserialize(response, opts[:return_type])
77
+ else
78
+ data = nil
79
+ end
80
+ return data, response.code, response.headers
81
+ end
82
+
83
+ # Builds the HTTP request
84
+ #
85
+ # @param [String] http_method HTTP method/verb (e.g. POST)
86
+ # @param [String] path URL path (e.g. /account/new)
87
+ # @option opts [Hash] :header_params Header parameters
88
+ # @option opts [Hash] :query_params Query parameters
89
+ # @option opts [Hash] :form_params Query parameters
90
+ # @option opts [Object] :body HTTP body (JSON/XML)
91
+ # @return [Typhoeus::Request] A Typhoeus Request
92
+ def build_request(http_method, path, opts = {})
93
+ url = build_request_url(path)
94
+ http_method = http_method.to_sym.downcase
95
+
96
+ header_params = @default_headers.merge(opts[:header_params] || {})
97
+ query_params = opts[:query_params] || {}
98
+ form_params = opts[:form_params] || {}
99
+
100
+
101
+ # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
102
+ _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
103
+
104
+ req_opts = {
105
+ :method => http_method,
106
+ :headers => header_params,
107
+ :params => query_params,
108
+ :params_encoding => @config.params_encoding,
109
+ :timeout => @config.timeout,
110
+ :ssl_verifypeer => @config.verify_ssl,
111
+ :ssl_verifyhost => _verify_ssl_host,
112
+ :sslcert => @config.cert_file,
113
+ :sslkey => @config.key_file,
114
+ :verbose => @config.debugging
115
+ }
116
+
117
+ # set custom cert, if provided
118
+ req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
119
+
120
+ if [:post, :patch, :put, :delete].include?(http_method)
121
+ req_body = build_request_body(header_params, form_params, opts[:body])
122
+ req_opts.update :body => req_body
123
+ if @config.debugging
124
+ @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
125
+ end
126
+ end
127
+
128
+ Typhoeus::Request.new(url, req_opts)
129
+ end
130
+
131
+ # Check if the given MIME is a JSON MIME.
132
+ # JSON MIME examples:
133
+ # application/json
134
+ # application/json; charset=UTF8
135
+ # APPLICATION/JSON
136
+ # @param [String] mime MIME
137
+ # @return [Boolean] True if the MIME is applicaton/json
138
+ def json_mime?(mime)
139
+ !(mime =~ /\Aapplication\/json(;.*)?\z/i).nil?
140
+ end
141
+
142
+ # Deserialize the response to the given return type.
143
+ #
144
+ # @param [Response] response HTTP response
145
+ # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
146
+ def deserialize(response, return_type)
147
+ body = response.body
148
+ return nil if body.nil? || body.empty?
149
+
150
+ # return response body directly for String return type
151
+ return body if return_type == 'String'
152
+
153
+ # handle file downloading - save response body into a tmp file and return the File instance
154
+ return download_file(response) if return_type == 'File'
155
+
156
+ # ensuring a default content type
157
+ content_type = response.headers['Content-Type'] || 'application/json'
158
+
159
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
160
+
161
+ begin
162
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
163
+ rescue JSON::ParserError => e
164
+ if %w(String Date DateTime).include?(return_type)
165
+ data = body
166
+ else
167
+ raise e
168
+ end
169
+ end
170
+
171
+ convert_to_type data, return_type
172
+ end
173
+
174
+ # Convert data to the given return type.
175
+ # @param [Object] data Data to be converted
176
+ # @param [String] return_type Return type
177
+ # @return [Mixed] Data in a particular type
178
+ def convert_to_type(data, return_type)
179
+ return nil if data.nil?
180
+ case return_type
181
+ when 'String'
182
+ data.to_s
183
+ when 'Integer'
184
+ data.to_i
185
+ when 'Float'
186
+ data.to_f
187
+ when 'BOOLEAN'
188
+ data == true
189
+ when 'DateTime'
190
+ # parse date time (expecting ISO 8601 format)
191
+ DateTime.parse data
192
+ when 'Date'
193
+ # parse date time (expecting ISO 8601 format)
194
+ Date.parse data
195
+ when 'Object'
196
+ # generic object (usually a Hash), return directly
197
+ data
198
+ when /\AArray<(.+)>\z/
199
+ # e.g. Array<Pet>
200
+ sub_type = $1
201
+ data.map {|item| convert_to_type(item, sub_type) }
202
+ when /\AHash\<String, (.+)\>\z/
203
+ # e.g. Hash<String, Integer>
204
+ sub_type = $1
205
+ {}.tap do |hash|
206
+ data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
207
+ end
208
+ else
209
+ # models, e.g. Pet
210
+ Dkron.const_get(return_type).new.tap do |model|
211
+ model.build_from_hash data
212
+ end
213
+ end
214
+ end
215
+
216
+ # Save response body into a file in (the defined) temporary folder, using the filename
217
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
218
+ #
219
+ # @see Configuration#temp_folder_path
220
+ # @return [Tempfile] the file downloaded
221
+ def download_file(response)
222
+ content_disposition = response.headers['Content-Disposition']
223
+ if content_disposition and content_disposition =~ /filename=/i
224
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
225
+ prefix = sanitize_filename(filename)
226
+ else
227
+ prefix = 'download-'
228
+ end
229
+ prefix = prefix + '-' unless prefix.end_with?('-')
230
+
231
+ tempfile = nil
232
+ encoding = response.body.encoding
233
+ Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) do |file|
234
+ file.write(response.body)
235
+ tempfile = file
236
+ end
237
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
238
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
239
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
240
+ "explicitly with `tempfile.delete`"
241
+ tempfile
242
+ end
243
+
244
+ # Sanitize filename by removing path.
245
+ # e.g. ../../sun.gif becomes sun.gif
246
+ #
247
+ # @param [String] filename the filename to be sanitized
248
+ # @return [String] the sanitized filename
249
+ def sanitize_filename(filename)
250
+ filename.gsub(/.*[\/\\]/, '')
251
+ end
252
+
253
+ def build_request_url(path)
254
+ # Add leading and trailing slashes to path
255
+ path = "/#{path}".gsub(/\/+/, '/')
256
+ URI.encode(@config.base_url + path)
257
+ end
258
+
259
+ # Builds the HTTP request body
260
+ #
261
+ # @param [Hash] header_params Header parameters
262
+ # @param [Hash] form_params Query parameters
263
+ # @param [Object] body HTTP body (JSON/XML)
264
+ # @return [String] HTTP body data in the form of string
265
+ def build_request_body(header_params, form_params, body)
266
+ # http form
267
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
268
+ header_params['Content-Type'] == 'multipart/form-data'
269
+ data = {}
270
+ form_params.each do |key, value|
271
+ case value
272
+ when File, Array, nil
273
+ # let typhoeus handle File, Array and nil parameters
274
+ data[key] = value
275
+ else
276
+ data[key] = value.to_s
277
+ end
278
+ end
279
+ elsif body
280
+ data = body.is_a?(String) ? body : body.to_json
281
+ else
282
+ data = nil
283
+ end
284
+ data
285
+ end
286
+
287
+ # Update hearder and query params based on authentication settings.
288
+ #
289
+ # @param [Hash] header_params Header parameters
290
+ # @param [Hash] form_params Query parameters
291
+ # @param [String] auth_names Authentication scheme name
292
+ def update_params_for_auth!(header_params, query_params, auth_names)
293
+ Array(auth_names).each do |auth_name|
294
+ auth_setting = @config.auth_settings[auth_name]
295
+ next unless auth_setting
296
+ case auth_setting[:in]
297
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
298
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
299
+ else fail ArgumentError, 'Authentication token must be in `query` of `header`'
300
+ end
301
+ end
302
+ end
303
+
304
+ # Sets user agent in HTTP header
305
+ #
306
+ # @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
307
+ def user_agent=(user_agent)
308
+ @user_agent = user_agent
309
+ @default_headers['User-Agent'] = @user_agent
310
+ end
311
+
312
+ # Return Accept header based on an array of accepts provided.
313
+ # @param [Array] accepts array for Accept
314
+ # @return [String] the Accept header (e.g. application/json)
315
+ def select_header_accept(accepts)
316
+ return nil if accepts.nil? || accepts.empty?
317
+ # use JSON when present, otherwise use all of the provided
318
+ json_accept = accepts.find { |s| json_mime?(s) }
319
+ return json_accept || accepts.join(',')
320
+ end
321
+
322
+ # Return Content-Type header based on an array of content types provided.
323
+ # @param [Array] content_types array for Content-Type
324
+ # @return [String] the Content-Type header (e.g. application/json)
325
+ def select_header_content_type(content_types)
326
+ # use application/json by default
327
+ return 'application/json' if content_types.nil? || content_types.empty?
328
+ # use JSON when present, otherwise use the first one
329
+ json_content_type = content_types.find { |s| json_mime?(s) }
330
+ return json_content_type || content_types.first
331
+ end
332
+
333
+ # Convert object (array, hash, object, etc) to JSON string.
334
+ # @param [Object] model object to be converted into JSON string
335
+ # @return [String] JSON string representation of the object
336
+ def object_to_http_body(model)
337
+ return model if model.nil? || model.is_a?(String)
338
+ local_body = nil
339
+ if model.is_a?(Array)
340
+ local_body = model.map{|m| object_to_hash(m) }
341
+ else
342
+ local_body = object_to_hash(model)
343
+ end
344
+ local_body.to_json
345
+ end
346
+
347
+ # Convert object(non-array) to hash.
348
+ # @param [Object] obj object to be converted into JSON string
349
+ # @return [String] JSON string representation of the object
350
+ def object_to_hash(obj)
351
+ if obj.respond_to?(:to_hash)
352
+ obj.to_hash
353
+ else
354
+ obj
355
+ end
356
+ end
357
+
358
+ # Build parameter value according to the given collection format.
359
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
360
+ def build_collection_param(param, collection_format)
361
+ case collection_format
362
+ when :csv
363
+ param.join(',')
364
+ when :ssv
365
+ param.join(' ')
366
+ when :tsv
367
+ param.join("\t")
368
+ when :pipes
369
+ param.join('|')
370
+ when :multi
371
+ # return the array directly as typhoeus will handle it as expected
372
+ param
373
+ else
374
+ fail "unknown collection format: #{collection_format.inspect}"
375
+ end
376
+ end
377
+ end
378
+ end
@@ -0,0 +1,47 @@
1
+ =begin
2
+ #Dkron REST API
3
+
4
+ #You can communicate with Dkron using a RESTful JSON API over HTTP. Dkron nodes usually listen on port `8080` for API requests. All examples in this section assume that you've found a running leader at `localhost:8080`. Dkron implements a RESTful JSON API over HTTP to communicate with software clients. Dkron listens in port `8080` by default. All examples in this section assume that you're using the default port. Default API responses are unformatted JSON add the `pretty=true` param to format the response.
5
+
6
+ OpenAPI spec version: 0.9.2
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ Licensed under the Apache License, Version 2.0 (the "License");
11
+ you may not use this file except in compliance with the License.
12
+ You may obtain a copy of the License at
13
+
14
+ http://www.apache.org/licenses/LICENSE-2.0
15
+
16
+ Unless required by applicable law or agreed to in writing, software
17
+ distributed under the License is distributed on an "AS IS" BASIS,
18
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ See the License for the specific language governing permissions and
20
+ limitations under the License.
21
+
22
+ =end
23
+
24
+ module Dkron
25
+ class ApiError < StandardError
26
+ attr_reader :code, :response_headers, :response_body
27
+
28
+ # Usage examples:
29
+ # ApiError.new
30
+ # ApiError.new("message")
31
+ # ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
32
+ # ApiError.new(:code => 404, :message => "Not Found")
33
+ def initialize(arg = nil)
34
+ if arg.is_a? Hash
35
+ arg.each do |k, v|
36
+ if k.to_s == 'message'
37
+ super v
38
+ else
39
+ instance_variable_set "@#{k}", v
40
+ end
41
+ end
42
+ else
43
+ super arg
44
+ end
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,207 @@
1
+ =begin
2
+ #Dkron REST API
3
+
4
+ #You can communicate with Dkron using a RESTful JSON API over HTTP. Dkron nodes usually listen on port `8080` for API requests. All examples in this section assume that you've found a running leader at `localhost:8080`. Dkron implements a RESTful JSON API over HTTP to communicate with software clients. Dkron listens in port `8080` by default. All examples in this section assume that you're using the default port. Default API responses are unformatted JSON add the `pretty=true` param to format the response.
5
+
6
+ OpenAPI spec version: 0.9.2
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ Licensed under the Apache License, Version 2.0 (the "License");
11
+ you may not use this file except in compliance with the License.
12
+ You may obtain a copy of the License at
13
+
14
+ http://www.apache.org/licenses/LICENSE-2.0
15
+
16
+ Unless required by applicable law or agreed to in writing, software
17
+ distributed under the License is distributed on an "AS IS" BASIS,
18
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ See the License for the specific language governing permissions and
20
+ limitations under the License.
21
+
22
+ =end
23
+
24
+ require 'uri'
25
+
26
+ module Dkron
27
+ class Configuration
28
+ # Defines url scheme
29
+ attr_accessor :scheme
30
+
31
+ # Defines url host
32
+ attr_accessor :host
33
+
34
+ # Defines url base path
35
+ attr_accessor :base_path
36
+
37
+ # Defines API keys used with API Key authentications.
38
+ #
39
+ # @return [Hash] key: parameter name, value: parameter value (API key)
40
+ #
41
+ # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
42
+ # config.api_key['api_key'] = 'xxx'
43
+ attr_accessor :api_key
44
+
45
+ # Defines API key prefixes used with API Key authentications.
46
+ #
47
+ # @return [Hash] key: parameter name, value: API key prefix
48
+ #
49
+ # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
50
+ # config.api_key_prefix['api_key'] = 'Token'
51
+ attr_accessor :api_key_prefix
52
+
53
+ # Defines the username used with HTTP basic authentication.
54
+ #
55
+ # @return [String]
56
+ attr_accessor :username
57
+
58
+ # Defines the password used with HTTP basic authentication.
59
+ #
60
+ # @return [String]
61
+ attr_accessor :password
62
+
63
+ # Defines the access token (Bearer) used with OAuth2.
64
+ attr_accessor :access_token
65
+
66
+ # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
67
+ # details will be logged with `logger.debug` (see the `logger` attribute).
68
+ # Default to false.
69
+ #
70
+ # @return [true, false]
71
+ attr_accessor :debugging
72
+
73
+ # Defines the logger used for debugging.
74
+ # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
75
+ #
76
+ # @return [#debug]
77
+ attr_accessor :logger
78
+
79
+ # Defines the temporary folder to store downloaded files
80
+ # (for API endpoints that have file response).
81
+ # Default to use `Tempfile`.
82
+ #
83
+ # @return [String]
84
+ attr_accessor :temp_folder_path
85
+
86
+ # The time limit for HTTP request in seconds.
87
+ # Default to 0 (never times out).
88
+ attr_accessor :timeout
89
+
90
+ ### TLS/SSL setting
91
+ # Set this to false to skip verifying SSL certificate when calling API from https server.
92
+ # Default to true.
93
+ #
94
+ # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
95
+ #
96
+ # @return [true, false]
97
+ attr_accessor :verify_ssl
98
+
99
+ ### TLS/SSL setting
100
+ # Set this to false to skip verifying SSL host name
101
+ # Default to true.
102
+ #
103
+ # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
104
+ #
105
+ # @return [true, false]
106
+ attr_accessor :verify_ssl_host
107
+
108
+ ### TLS/SSL setting
109
+ # Set this to customize the certificate file to verify the peer.
110
+ #
111
+ # @return [String] the path to the certificate file
112
+ #
113
+ # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
114
+ # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
115
+ attr_accessor :ssl_ca_cert
116
+
117
+ ### TLS/SSL setting
118
+ # Client certificate file (for client certificate)
119
+ attr_accessor :cert_file
120
+
121
+ ### TLS/SSL setting
122
+ # Client private key file (for client certificate)
123
+ attr_accessor :key_file
124
+
125
+ # Set this to customize parameters encoding of array parameter with multi collectionFormat.
126
+ # Default to nil.
127
+ #
128
+ # @see The params_encoding option of Ethon. Related source code:
129
+ # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
130
+ attr_accessor :params_encoding
131
+
132
+ attr_accessor :inject_format
133
+
134
+ attr_accessor :force_ending_format
135
+
136
+ def initialize
137
+ @scheme = 'http'
138
+ @host = 'localhost:8080'
139
+ @base_path = '/v1'
140
+ @api_key = {}
141
+ @api_key_prefix = {}
142
+ @timeout = 0
143
+ @verify_ssl = true
144
+ @verify_ssl_host = true
145
+ @params_encoding = nil
146
+ @cert_file = nil
147
+ @key_file = nil
148
+ @debugging = false
149
+ @inject_format = false
150
+ @force_ending_format = false
151
+ @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
152
+
153
+ yield(self) if block_given?
154
+ end
155
+
156
+ # The default Configuration object.
157
+ def self.default
158
+ @@default ||= Configuration.new
159
+ end
160
+
161
+ def configure
162
+ yield(self) if block_given?
163
+ end
164
+
165
+ def scheme=(scheme)
166
+ # remove :// from scheme
167
+ @scheme = scheme.sub(/:\/\//, '')
168
+ end
169
+
170
+ def host=(host)
171
+ # remove http(s):// and anything after a slash
172
+ @host = host.sub(/https?:\/\//, '').split('/').first
173
+ end
174
+
175
+ def base_path=(base_path)
176
+ # Add leading and trailing slashes to base_path
177
+ @base_path = "/#{base_path}".gsub(/\/+/, '/')
178
+ @base_path = "" if @base_path == "/"
179
+ end
180
+
181
+ def base_url
182
+ url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
183
+ URI.encode(url)
184
+ end
185
+
186
+ # Gets API key (with prefix if set).
187
+ # @param [String] param_name the parameter name of API key auth
188
+ def api_key_with_prefix(param_name)
189
+ if @api_key_prefix[param_name]
190
+ "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
191
+ else
192
+ @api_key[param_name]
193
+ end
194
+ end
195
+
196
+ # Gets Basic Auth token string
197
+ def basic_auth_token
198
+ 'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
199
+ end
200
+
201
+ # Returns Auth Settings hash for api client.
202
+ def auth_settings
203
+ {
204
+ }
205
+ end
206
+ end
207
+ end