Class: DatadogAPIClient::APIClient
- Inherits:
-
Object
- Object
- DatadogAPIClient::APIClient
- Defined in:
- lib/datadog_api_client/api_client.rb
Instance Attribute Summary collapse
-
#config ⇒ Object
The Configuration object holding settings to be used in the API client.
-
#default_headers ⇒ Hash
Defines the headers to be used in HTTP requests of all API calls by default.
Class Method Summary collapse
Instance Method Summary collapse
-
#build_collection_param(param, collection_format) ⇒ Object
Build parameter value according to the given collection format.
-
#build_request(http_method, path, opts = {}) ⇒ HTTParty::Request
Build the HTTP request.
-
#build_request_body(header_params, form_params, body) ⇒ String
Build the HTTP request body.
- #build_request_url(path, opts = {}) ⇒ Object
-
#calculate_retry_interval(response, backoff_base, backoff_multiplier, attempt, timeout) ⇒ Object
Calculate the sleep interval between 2 retry attempts.
-
#call_api(http_method, path, opts = {}) ⇒ Array<(Object, Integer, Hash)>
Call an API with given options.
-
#convert_to_type(data, return_type, api_version) ⇒ Mixed
Convert data to the given return type.
-
#deserialize(api_version, response, return_type) ⇒ Object
Deserialize the response to the given return type.
-
#initialize(config = Configuration.default) ⇒ APIClient
constructor
Initializes the APIClient.
-
#json_mime?(mime) ⇒ Boolean
Check if the given MIME is a JSON MIME.
-
#object_to_hash(obj) ⇒ String
Convert object(non-array) to hash.
-
#object_to_http_body(model) ⇒ String
Convert object (array, hash, object, etc) to JSON string.
-
#sanitize_filename(filename) ⇒ String
Sanitize filename by removing path.
-
#sanitize_request_header(request_header) ⇒ Object
Redact api and app key in the request header.
-
#select_header_accept(accepts) ⇒ String
Return Accept header based on an array of accepts provided.
-
#select_header_content_type(content_types) ⇒ String
Return Content-Type header based on an array of content types provided.
-
#should_retry(attempt, max_retries, http_code, enable_retry) ⇒ Object
Check if an http request should be retried.
-
#transform_hash(obj) ⇒ Object
Transform object (array, hash, object, etc) to serializable object.
-
#update_params_for_auth!(header_params, query_params, auth_names) ⇒ Object
Update header and query params based on authentication settings.
-
#user_agent=(user_agent) ⇒ Object
Sets user agent in HTTP header.
Constructor Details
#initialize(config = Configuration.default) ⇒ APIClient
Initializes the APIClient
39 40 41 42 43 44 45 46 |
# File 'lib/datadog_api_client/api_client.rb', line 39 def initialize(config = Configuration.default) @config = config @user_agent = "#{DatadogAPIClient::USER_AGENT}" @default_headers = { 'User-Agent' => @user_agent } @default_headers['Accept-Encoding'] = 'gzip' if @config.compress end |
Instance Attribute Details
#config ⇒ Object
The Configuration object holding settings to be used in the API client.
30 31 32 |
# File 'lib/datadog_api_client/api_client.rb', line 30 def config @config end |
#default_headers ⇒ Hash
Defines the headers to be used in HTTP requests of all API calls by default.
35 36 37 |
# File 'lib/datadog_api_client/api_client.rb', line 35 def default_headers @default_headers end |
Class Method Details
Instance Method Details
#build_collection_param(param, collection_format) ⇒ Object
Build parameter value according to the given collection format.
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 |
# File 'lib/datadog_api_client/api_client.rb', line 469 def build_collection_param(param, collection_format) case collection_format when :csv param.join(',') when :ssv param.join(' ') when :tsv param.join("\t") when :pipes param.join('|') when :multi # return the array directly as httparty will handle it as expected param else fail "unknown collection format: #{collection_format.inspect}" end end |
#build_request(http_method, path, opts = {}) ⇒ HTTParty::Request
Build the HTTP request
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/datadog_api_client/api_client.rb', line 175 def build_request(http_method, path, opts = {}) url = build_request_url(path, opts) header_params = @default_headers.merge(opts[:header_params] || {}) query_params = opts[:query_params] || {} form_params = opts[:form_params] || {} update_params_for_auth! header_params, query_params, opts[:auth_names] # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false) _verify_ssl_host = @config.verify_ssl_host ? 2 : 0 req_opts = { :method => http_method, :headers => header_params, :query => transform_hash(query_params), :timeout => @config.timeout, :verify_peer => @config.verify_ssl, :verify => _verify_ssl_host, :verbose => @config.debugging, :http_proxyaddr => @config.http_proxyaddr, :http_proxyport => @config.http_proxyport, :http_proxyuser => @config.http_proxyuser, :http_proxypass => @config.http_proxypass } req_opts[:pem] = File.read(@config.cert_file) if @config.cert_file req_opts[:pem_password] = File.read(@config.key_file) if @config.key_file opts[:stream_body] = true if opts[:return_type] == 'File' # set custom cert, if provided req_opts[:ssl_ca_file] = File.read(@config.ssl_ca_cert) if @config.ssl_ca_cert if @config.debugging @config.logger.debug "HTTP request url\n#{url}\n" @config.logger.debug "HTTP request header\n#{sanitize_request_header(header_params)}\n" end if ["POST", "PATCH", "PUT", "DELETE"].include?(http_method.const_get(:METHOD)) req_body = build_request_body(header_params, form_params, opts[:body]) req_opts.update :body => req_body if @config.debugging @config.logger.debug "HTTP request body ~BEGIN~\n#{req_body}\n~END~\n" end end HTTParty::Request.new(http_method, url, req_opts) end |
#build_request_body(header_params, form_params, body) ⇒ String
Build the HTTP request body
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'lib/datadog_api_client/api_client.rb', line 230 def build_request_body(header_params, form_params, body) # http form if header_params['Content-Type'] == 'application/x-www-form-urlencoded' || header_params['Content-Type'] == 'multipart/form-data' data = {} form_params.each do |key, value| case value when ::File, ::Array, nil # let httparty handle File, Array and nil parameters data[key] = value else data[key] = value.to_s end end elsif body data = body.is_a?(String) ? body : body.to_json else data = nil end if header_params['Content-Encoding'] == 'gzip' gzip = Zlib::Deflate.new(nil, Zlib::MAX_WBITS + 16) data = gzip.deflate(data, Zlib::FINISH) gzip.close elsif header_params['Content-Encoding'] == 'deflate' data = Zlib::deflate(data) elsif header_params['Content-Encoding'] == 'zstd1' data = Zstandard.deflate(data) end data end |
#build_request_url(path, opts = {}) ⇒ Object
367 368 369 370 371 |
# File 'lib/datadog_api_client/api_client.rb', line 367 def build_request_url(path, opts = {}) # Add leading and trailing slashes to path path = "/#{path}".gsub(/\/+/, '/') @config.base_url("#{opts[:api_version].respond_to?(:downcase) ? opts[:api_version].downcase : opts[:api_version]}.#{opts[:operation]}") + path end |
#calculate_retry_interval(response, backoff_base, backoff_multiplier, attempt, timeout) ⇒ Object
Calculate the sleep interval between 2 retry attempts
141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/datadog_api_client/api_client.rb', line 141 def calculate_retry_interval(response, backoff_base, backoff_multiplier, attempt, timeout) reset_header = response.headers['X-Ratelimit-Reset'] if !reset_header.nil? && !reset_header.empty? sleep_time = reset_header.to_i else sleep_time = (backoff_multiplier**attempt) * backoff_base if timeout && timeout > 0 sleep_time = [timeout, sleep_time].min end end sleep_time end |
#call_api(http_method, path, opts = {}) ⇒ Array<(Object, Integer, Hash)>
Call an API with given options.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/datadog_api_client/api_client.rb', line 56 def call_api(http_method, path, opts = {}) request = build_request(http_method, path, opts) attempt = 0 loop do if opts[:stream_body] tempfile = nil encoding = nil response = request.perform do | chunk | unless tempfile content_disposition = chunk.http_response.header['Content-Disposition'] if content_disposition && content_disposition =~ /filename=/i filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1] prefix = sanitize_filename(filename) else prefix = 'download-' end prefix = prefix + '-' unless prefix.end_with?('-') unless encoding encoding = chunk.encoding end tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) @tempfile = tempfile end chunk.force_encoding(encoding) tempfile.write(chunk) end if tempfile tempfile.close @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\ "will be deleted automatically with GC. It's also recommended to delete the temp file "\ "explicitly with `tempfile.delete`" end else response = request.perform end if @config.debugging @config.logger.debug "HTTP response header\n#{response.headers}\n" @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n" end unless response.success? if response.request_timeout? fail APIError.new('Connection timed out') elsif response.code == 0 # Errors from libcurl will be made visible here fail APIError.new(:code => 0, :message => response.) else body = response.body if response.headers['Content-Encoding'].eql?('gzip') && !(body.nil? || body.empty?) then gzip = Zlib::Inflate.new(Zlib::MAX_WBITS + 16) body = gzip.inflate(body) gzip.close end if should_retry(attempt, @config.max_retries, response.code, @config.enable_retry) sleep calculate_retry_interval(response, @config.backoff_base, @config.backoff_multiplier, attempt, @config.timeout) attempt = attempt + 1 next else fail APIError.new(:code => response.code, :response_headers => response.headers, :response_body => body), response. end end end if opts[:return_type] data = deserialize(opts[:api_version], response, opts[:return_type]) else data = nil end return data, response.code, response.headers end end |
#convert_to_type(data, return_type, api_version) ⇒ Mixed
Convert data to the given return type.
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 |
# File 'lib/datadog_api_client/api_client.rb', line 318 def convert_to_type(data, return_type, api_version) return nil if data.nil? case return_type when 'String' data.to_s when 'Integer' data.to_i when 'Float' data.to_f when 'Boolean' data == true when 'Time' # parse date time (expecting ISO 8601 format) Time.parse data when 'Date' # parse date time (expecting ISO 8601 format) Date.parse data when 'Object' # generic object (usually a Hash), return directly data when 'UUID' # parse uuid object data.to_s when /\AArray<(.+)>\z/ # e.g. Array<Pet> sub_type = $1 data.map { |item| convert_to_type(item, sub_type, api_version) } when /\AHash\<String, (.+)\>\z/ # e.g. Hash<String, Integer> sub_type = $1 {}.tap do |hash| data.each { |k, v| hash[k] = convert_to_type(v, sub_type, api_version) } end else # models (e.g. Pet) or oneOf klass = DatadogAPIClient.const_get(api_version).const_get(return_type) klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data) end end |
#deserialize(api_version, response, return_type) ⇒ Object
Deserialize the response to the given return type.
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 |
# File 'lib/datadog_api_client/api_client.rb', line 278 def deserialize(api_version, response, return_type) body = response.body # handle file downloading - return the File instance processed in request callbacks # note that response body is empty when the file is written in chunks in request on_body callback return @tempfile if return_type == 'File' return nil if body.nil? || body.empty? if response.headers['Content-Encoding'].eql?('gzip') then gzip = Zlib::Inflate.new(Zlib::MAX_WBITS + 16) body = gzip.inflate(body) gzip.close end # return response body directly for String return type return body if return_type == 'String' # ensuring a default content type content_type = response.headers['Content-Type'] || 'application/json' fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type) begin data = JSON.parse("[#{body}]", :symbolize_names => true)[0] rescue JSON::ParserError => e if %w(String Date Time).include?(return_type) data = body else raise e end end convert_to_type data, return_type, api_version end |
#json_mime?(mime) ⇒ Boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON /
269 270 271 |
# File 'lib/datadog_api_client/api_client.rb', line 269 def json_mime?(mime) (mime && mime.downcase.include?('json')) || mime == '*/*' end |
#object_to_hash(obj) ⇒ String
Convert object(non-array) to hash.
459 460 461 462 463 464 465 |
# File 'lib/datadog_api_client/api_client.rb', line 459 def object_to_hash(obj) if obj.respond_to?(:to_hash) obj.to_hash else obj end end |
#object_to_http_body(model) ⇒ String
Convert object (array, hash, object, etc) to JSON string.
420 421 422 423 424 425 426 427 428 429 |
# File 'lib/datadog_api_client/api_client.rb', line 420 def object_to_http_body(model) return model if model.nil? || model.is_a?(String) local_body = nil if model.is_a?(Array) local_body = model.map { |m| object_to_hash(m) } else local_body = object_to_hash(model) end transform_hash(local_body).to_json end |
#sanitize_filename(filename) ⇒ String
Sanitize filename by removing path. e.g. ../../sun.gif becomes sun.gif
363 364 365 |
# File 'lib/datadog_api_client/api_client.rb', line 363 def sanitize_filename(filename) filename.split(/\\|\//)[-1] end |
#sanitize_request_header(request_header) ⇒ Object
Redact api and app key in the request header
155 156 157 158 159 160 161 162 163 164 |
# File 'lib/datadog_api_client/api_client.rb', line 155 def sanitize_request_header(request_header) sanitized_headers= request_header.dup keys_to_redact = ["DD-API-KEY", "DD-APPLICATION-KEY"] keys_to_redact.each do |key_to_redact| if sanitized_headers.key?(key_to_redact) sanitized_headers[key_to_redact] = "REDACTED" end end return sanitized_headers end |
#select_header_accept(accepts) ⇒ String
Return Accept header based on an array of accepts provided.
401 402 403 404 |
# File 'lib/datadog_api_client/api_client.rb', line 401 def select_header_accept(accepts) return nil if accepts.nil? || accepts.empty? accepts.join(', ') end |
#select_header_content_type(content_types) ⇒ String
Return Content-Type header based on an array of content types provided.
409 410 411 412 413 414 415 |
# File 'lib/datadog_api_client/api_client.rb', line 409 def select_header_content_type(content_types) # use application/json by default return 'application/json' if content_types.nil? || content_types.empty? # use JSON when present, otherwise use the first one json_content_type = content_types.find { |s| json_mime?(s) } json_content_type || content_types.first end |
#should_retry(attempt, max_retries, http_code, enable_retry) ⇒ Object
Check if an http request should be retried
136 137 138 |
# File 'lib/datadog_api_client/api_client.rb', line 136 def should_retry(attempt, max_retries, http_code, enable_retry) (http_code == 429 || http_code >= 500) && max_retries > attempt && enable_retry end |
#transform_hash(obj) ⇒ Object
Transform object (array, hash, object, etc) to serializable object.
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 |
# File 'lib/datadog_api_client/api_client.rb', line 434 def transform_hash(obj) if obj.is_a?(Array) obj.map { |m| transform_hash(m) } elsif obj.is_a?(Hash) obj.each do | k, v | if v.class == Time t = v.strftime("%FT%T") if v.nsec > 0 t << v.strftime(".%3N") end t << (v.utc? ? 'Z' : v.strftime("%:z")) obj[k] = t else obj[k] = transform_hash(v) end end end obj end |
#update_params_for_auth!(header_params, query_params, auth_names) ⇒ Object
Update header and query params based on authentication settings.
378 379 380 381 382 383 384 385 386 387 388 |
# File 'lib/datadog_api_client/api_client.rb', line 378 def update_params_for_auth!(header_params, query_params, auth_names) Array(auth_names).each do |auth_name| auth_setting = @config.auth_settings[auth_name] next unless auth_setting case auth_setting[:in] when 'header' then header_params[auth_setting[:key]] = auth_setting[:value] when 'query' then query_params[auth_setting[:key]] = auth_setting[:value] else fail ArgumentError, 'Authentication token must be in `query` or `header`' end end end |
#user_agent=(user_agent) ⇒ Object
Sets user agent in HTTP header
393 394 395 396 |
# File 'lib/datadog_api_client/api_client.rb', line 393 def user_agent=(user_agent) @user_agent = user_agent @default_headers['User-Agent'] = @user_agent end |