datadog_api_client 1.8.0 → 1.9.0

data/lib/datadog_api_client/v2/api_client.rb

@@ -18,7 +18,7 @@ require 'json'
 require 'logger'
 require 'tempfile'
 require 'time'
-require 'typhoeus'
+require 'httparty'
 
 module DatadogAPIClient::V2
   class APIClient
@@ -52,14 +52,46 @@ module DatadogAPIClient::V2
     #   the data deserialized from response body (could be nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
       request = build_request(http_method, path, opts)
-      response = request.run
+      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 body ~BEGIN~\n#{response.body}\n~END~\n"
       end
 
       unless response.success?
-        if response.timed_out?
+        if response.request_timeout?
           fail APIError.new('Connection timed out')
         elsif response.code == 0
           # Errors from libcurl will be made visible here
@@ -75,7 +107,7 @@ module DatadogAPIClient::V2
           fail APIError.new(:code => response.code,
                             :response_headers => response.headers,
                             :response_body => body),
-               response.status_message
+               response.message
         end
       end
 
@@ -87,7 +119,7 @@ module DatadogAPIClient::V2
       return data, response.code, response.headers
     end
 
-    # Builds the HTTP request
+    # Build the HTTP request
     #
     # @param [String] http_method HTTP method/verb (e.g. POST)
     # @param [String] path URL path (e.g. /account/new)
@@ -95,11 +127,9 @@ module DatadogAPIClient::V2
     # @option opts [Hash] :query_params Query parameters
     # @option opts [Hash] :form_params Query parameters
     # @option opts [Object] :body HTTP body (JSON/XML)
-    # @return [Typhoeus::Request] A Typhoeus Request
+    # @return [HTTParty::Request] A httparty Request
     def build_request(http_method, path, opts = {})
       url = build_request_url(path, opts)
-      http_method = http_method.to_sym.downcase
-
       header_params = @default_headers.merge(opts[:header_params] || {})
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
@@ -112,20 +142,22 @@ module DatadogAPIClient::V2
       req_opts = {
         :method => http_method,
         :headers => header_params,
-        :params => query_params,
-        :params_encoding => @config.params_encoding,
+        :query => query_params,
         :timeout => @config.timeout,
-        :ssl_verifypeer => @config.verify_ssl,
-        :ssl_verifyhost => _verify_ssl_host,
-        :sslcert => @config.cert_file,
-        :sslkey => @config.key_file,
+        :verify_peer => @config.verify_ssl,
+        :verify => _verify_ssl_host,
         :verbose => @config.debugging
       }
 
+      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[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
+      req_opts[:ssl_ca_file] = File.read(@config.ssl_ca_cert) if @config.ssl_ca_cert
 
-      if [:post, :patch, :put, :delete].include?(http_method)
+      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
@@ -133,12 +165,10 @@ module DatadogAPIClient::V2
         end
       end
 
-      request = Typhoeus::Request.new(url, req_opts)
-      download_file(request) if opts[:return_type] == 'File'
-      request
+      HTTParty::Request.new(http_method, url, req_opts)
     end
 
-    # Builds the HTTP request body
+    # Build the HTTP request body
     #
     # @param [Hash] header_params Header parameters
     # @param [Hash] form_params Query parameters
@@ -152,7 +182,7 @@ module DatadogAPIClient::V2
         form_params.each do |key, value|
           case value
           when ::File, ::Array, nil
-            # let typhoeus handle File, Array and nil parameters
+            # let httparty handle File, Array and nil parameters
             data[key] = value
           else
             data[key] = value.to_s
@@ -173,44 +203,6 @@ module DatadogAPIClient::V2
       data
     end
 
-    # Save response body into a file in (the defined) temporary folder, using the filename
-    # from the "Content-Disposition" header if provided, otherwise a random filename.
-    # The response body is written to the file in chunks in order to handle files which
-    # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
-    # process can use.
-    #
-    # @see Configuration#temp_folder_path
-    def download_file(request)
-      tempfile = nil
-      encoding = nil
-      request.on_headers do |response|
-        content_disposition = response.headers['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?('-')
-        encoding = response.body.encoding
-        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-        @tempfile = tempfile
-      end
-      request.on_body do |chunk|
-        chunk.force_encoding(encoding)
-        tempfile.write(chunk)
-      end
-      request.on_complete do |response|
-        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
-      end
-    end
-
     # Check if the given MIME is a JSON MIME.
     # JSON MIME examples:
     #   application/json
@@ -403,11 +395,62 @@ module DatadogAPIClient::V2
       when :pipes
         param.join('|')
       when :multi
-        # return the array directly as typhoeus will handle it as expected
+        # return the array directly as httparty will handle it as expected
         param
       else
         fail "unknown collection format: #{collection_format.inspect}"
       end
     end
+
+
+    # Retrieve an attribute from a path specification.
+    #
+    # @param [Object] obj The source object
+    # @param [String] attribute_path The path spefication, separated by "."
+    # @param [Object] default The default value, if not found
+    # @return [Object] The value found, or default
+    # @!visibility private
+    def get_attribute_from_path(obj, attribute_path, default=nil)
+      for attr in attribute_path.split(".") do
+        case obj
+        when Hash
+          obj = !obj[attr.to_sym].nil? ? obj[attr.to_sym] : obj[attr]
+        else
+          obj = obj.send(attr)
+        end
+        return default if obj.nil?
+      end
+      obj
+    end
+
+    # Set an attribute at the given path
+    #
+    # @param [Object] obj The source object
+    # @param [String] attribute_path The path spefication, separated by "."
+    # @param [Object] builder The class matching the top level attribute
+    # @param [Object] value The value to set
+    # @!visibility private
+    def set_attribute_from_path(obj, attribute_path, builder, value)
+      attrs = attribute_path.split(".")
+      last = attrs.pop
+      i = 0
+      for attr in attrs do
+        case obj
+        when Hash
+          obj = !obj[attr.to_sym].nil? ? obj[attr.to_sym] : obj[attr]
+        else
+          obj = obj.send(attr)
+        end
+        builder = DatadogAPIClient::V2.const_get(builder.openapi_types[attr.to_sym]) if i > 0
+        obj = builder.new if obj.nil?
+        i += 1
+      end
+      case obj
+      when Hash
+        obj[last.to_sym] = value
+      else
+        obj.send(last + "=", value)
+      end
+    end
   end
 end

data/lib/datadog_api_client/v2/configuration.rb

@@ -119,9 +119,6 @@ module DatadogAPIClient::V2
     # Set this to customize the certificate file to verify the peer.
     #
     # @return [String] the path to the certificate file
-    #
-    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
-    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
     attr_accessor :ssl_ca_cert
 
     ### TLS/SSL setting
@@ -132,13 +129,6 @@ module DatadogAPIClient::V2
     # Client private key file (for client certificate)
     attr_accessor :key_file
 
-    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
-    # Default to nil.
-    #
-    # @see The params_encoding option of Ethon. Related source code:
-    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
-    attr_accessor :params_encoding
-
     attr_accessor :inject_format
 
     attr_accessor :force_ending_format
@@ -156,11 +146,10 @@ module DatadogAPIClient::V2
       @server_operation_variables = {}
       @api_key = {}
       @api_key_prefix = {}
-      @timeout = 0
+      @timeout = nil
       @client_side_validation = true
       @verify_ssl = true
       @verify_ssl_host = true
-      @params_encoding = nil
       @cert_file = nil
       @key_file = nil
       @debugging = false

data/lib/datadog_api_client/v2/model_base.rb

@@ -230,7 +230,7 @@ module DatadogAPIClient::V2
           return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
         end
       else # model
-        const = DatadogAPIClient::V1.const_get(klass)
+        const = DatadogAPIClient::V2.const_get(klass)
         if const
           if const.respond_to?(:openapi_one_of) # nested oneOf model
             model = const.build(data)

data/lib/datadog_api_client/v2/models/api_error_response.rb

@@ -80,17 +80,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      if @errors.nil?
-        invalid_properties.push('invalid value for "errors", errors cannot be nil.')
-      end
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/api_key_create_attributes.rb

@@ -78,17 +78,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
-      end
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/api_key_create_data.rb

@@ -89,20 +89,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      if @attributes.nil?
-        invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
-      end
-      if @type.nil?
-        invalid_properties.push('invalid value for "type", type cannot be nil.')
-      end
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/api_key_create_request.rb

@@ -78,17 +78,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      if @data.nil?
-        invalid_properties.push('invalid value for "data", data cannot be nil.')
-      end
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/api_key_relationships.rb

@@ -87,14 +87,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/api_key_response.rb

@@ -89,14 +89,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/api_key_update_attributes.rb

@@ -78,17 +78,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
-      end
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/api_key_update_data.rb

@@ -98,23 +98,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      if @attributes.nil?
-        invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
-      end
-      if @id.nil?
-        invalid_properties.push('invalid value for "id", id cannot be nil.')
-      end
-      if @type.nil?
-        invalid_properties.push('invalid value for "type", type cannot be nil.')
-      end
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/api_key_update_request.rb

@@ -78,17 +78,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      if @data.nil?
-        invalid_properties.push('invalid value for "data", data cannot be nil.')
-      end
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/api_keys_response.rb

@@ -91,14 +91,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/application_key_create_attributes.rb

@@ -90,17 +90,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
-      end
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/application_key_create_data.rb

@@ -89,20 +89,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      if @attributes.nil?
-        invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
-      end
-      if @type.nil?
-        invalid_properties.push('invalid value for "type", type cannot be nil.')
-      end
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/application_key_create_request.rb

@@ -78,17 +78,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      if @data.nil?
-        invalid_properties.push('invalid value for "data", data cannot be nil.')
-      end
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/application_key_relationships.rb

@@ -78,14 +78,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/application_key_response.rb

@@ -89,14 +89,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/application_key_update_attributes.rb

@@ -90,14 +90,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/application_key_update_data.rb

@@ -98,23 +98,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      if @attributes.nil?
-        invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
-      end
-      if @id.nil?
-        invalid_properties.push('invalid value for "id", id cannot be nil.')
-      end
-      if @type.nil?
-        invalid_properties.push('invalid value for "type", type cannot be nil.')
-      end
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/application_key_update_request.rb

@@ -78,17 +78,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      if @data.nil?
-        invalid_properties.push('invalid value for "data", data cannot be nil.')
-      end
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/audit_logs_event.rb

@@ -98,14 +98,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private

data/lib/datadog_api_client/v2/models/audit_logs_event_attributes.rb

@@ -109,14 +109,6 @@ module DatadogAPIClient::V2
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    # @!visibility private
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     # @!visibility private