datadog_api_client 1.9.0 → 2.0.0

data/lib/datadog_api_client/v2/api_error.rb

@@ -1,60 +0,0 @@
-=begin
-#Datadog API V2 Collection
-
-#Collection of all Datadog Public endpoints.
-
-The version of the OpenAPI document: 1.0
-Contact: support@datadoghq.com
-Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
-
- Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
- This product includes software developed at Datadog (https://www.datadoghq.com/).
- Copyright 2020-Present Datadog, Inc.
-
-=end
-
-module DatadogAPIClient::V2
-  class APIError < StandardError
-    attr_reader :code, :response_headers, :response_body
-
-    # Usage examples:
-    #   APIError.new
-    #   APIError.new("message")
-    #   APIError.new(:code => 500, :response_headers => {}, :response_body => "")
-    #   APIError.new(:code => 404, :message => "Not Found")
-    def initialize(arg = nil)
-      if arg.is_a? Hash
-        if arg.key?(:message) || arg.key?('message')
-          super(arg[:message] || arg['message'])
-        else
-          super arg
-        end
-
-        arg.each do |k, v|
-          instance_variable_set "@#{k}", v
-        end
-      else
-        super arg
-      end
-    end
-
-    # Override to_s to display a friendly error message
-    def to_s
-      message
-    end
-
-    def message
-      if @message.nil?
-        msg = "Error message: the server returns an error"
-      else
-        msg = @message
-      end
-
-      msg += "\nHTTP status code: #{code}" if code
-      msg += "\nResponse headers: #{response_headers}" if response_headers
-      msg += "\nResponse body: #{response_body}" if response_body
-
-      msg
-    end
-  end
-end

data/lib/datadog_api_client/v2/configuration.rb

@@ -1,427 +0,0 @@
-=begin
-#Datadog API V2 Collection
-
-#Collection of all Datadog Public endpoints.
-
-The version of the OpenAPI document: 1.0
-Contact: support@datadoghq.com
-Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
-
- Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
- This product includes software developed at Datadog (https://www.datadoghq.com/).
- Copyright 2020-Present Datadog, Inc.
-
-=end
-
-module DatadogAPIClient::V2
-  class Configuration
-    # Defines url scheme
-    attr_accessor :scheme
-
-    # Defines url host
-    attr_accessor :host
-
-    # Defines url base path
-    attr_accessor :base_path
-
-    # Define server configuration index
-    attr_accessor :server_index
-
-    # Define server operation configuration index
-    attr_accessor :server_operation_index
-
-    # Default server variables
-    attr_accessor :server_variables
-
-    # Default server operation variables
-    attr_accessor :server_operation_variables
-
-    # Defines API keys used with API Key authentications.
-    #
-    # @return [Hash] key: parameter name, value: parameter value (API key)
-    #
-    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
-    #   config.api_key['api_key'] = 'xxx'
-    attr_accessor :api_key
-
-    # Defines API key prefixes used with API Key authentications.
-    #
-    # @return [Hash] key: parameter name, value: API key prefix
-    #
-    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
-    #   config.api_key_prefix['api_key'] = 'Token'
-    attr_accessor :api_key_prefix
-
-    # Defines the username used with HTTP basic authentication.
-    #
-    # @return [String]
-    attr_accessor :username
-
-    # Defines the password used with HTTP basic authentication.
-    #
-    # @return [String]
-    attr_accessor :password
-
-    # Defines the access token (Bearer) used with OAuth2.
-    attr_accessor :access_token
-
-    # 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.
-    #
-    # @return [true, false]
-    attr_accessor :debugging
-
-    # Defines the logger used for debugging.
-    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
-    #
-    # @return [#debug]
-    attr_accessor :logger
-
-    # Defines the temporary folder to store downloaded files
-    # (for API endpoints that have file response).
-    # Default to use `Tempfile`.
-    #
-    # @return [String]
-    attr_accessor :temp_folder_path
-
-    # The time limit for HTTP request in seconds.
-    # Default to 0 (never times out).
-    attr_accessor :timeout
-
-    # Set this to false to skip client side validation in the operation.
-    # Default to true.
-    # @return [true, false]
-    attr_accessor :client_side_validation
-
-    # Keep track of the unstable operations, and if they have been enabled
-    attr_accessor :unstable_operations
-
-    ### TLS/SSL setting
-    # Set this to false to skip verifying SSL certificate when calling API from https server.
-    # Default to true.
-    #
-    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
-    #
-    # @return [true, false]
-    attr_accessor :verify_ssl
-
-    ### TLS/SSL setting
-    # Set this to false to skip verifying SSL host name
-    # Default to true.
-    #
-    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
-    #
-    # @return [true, false]
-    attr_accessor :verify_ssl_host
-
-    ### TLS/SSL setting
-    # Set this to customize the certificate file to verify the peer.
-    #
-    # @return [String] the path to the certificate file
-    attr_accessor :ssl_ca_cert
-
-    ### TLS/SSL setting
-    # Client certificate file (for client certificate)
-    attr_accessor :cert_file
-
-    ### TLS/SSL setting
-    # Client private key file (for client certificate)
-    attr_accessor :key_file
-
-    attr_accessor :inject_format
-
-    attr_accessor :force_ending_format
-
-    # Set this to add accept encoding header for compression
-    attr_accessor :compress
-
-    def initialize
-      @scheme = 'https'
-      @host = 'api.datadoghq.com'
-      @base_path = ''
-      @server_index = 0
-      @server_operation_index = {}
-      @server_variables = {}
-      @server_operation_variables = {}
-      @api_key = {}
-      @api_key_prefix = {}
-      @timeout = nil
-      @client_side_validation = true
-      @verify_ssl = true
-      @verify_ssl_host = true
-      @cert_file = nil
-      @key_file = nil
-      @debugging = false
-      @inject_format = false
-      @force_ending_format = false
-      @compress = true
-      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
-      @unstable_operations = {
-            list_incidents: false,
-            create_incident: false,
-            delete_incident: false,
-            get_incident: false,
-            update_incident: false,
-            list_tag_configurations: false,
-            delete_tag_configuration: false,
-            list_tag_configuration_by_name: false,
-            update_tag_configuration: false,
-            create_tag_configuration: false,
-            list_security_monitoring_signals: false,
-            search_security_monitoring_signals: false,
-            list_incident_services: false,
-            create_incident_service: false,
-            delete_incident_service: false,
-            get_incident_service: false,
-            update_incident_service: false,
-            list_incident_teams: false,
-            create_incident_team: false,
-            delete_incident_team: false,
-            get_incident_team: false,
-            update_incident_team: false,
-      }
-      @server_variables[:site] = ENV['DD_SITE'] if ENV.key? 'DD_SITE'
-      @api_key['apiKeyAuth'] = ENV['DD_API_KEY'] if ENV.key? 'DD_API_KEY'
-      @api_key['appKeyAuth'] = ENV['DD_APP_KEY'] if ENV.key? 'DD_APP_KEY'
-
-      yield(self) if block_given?
-    end
-
-    # The default Configuration object.
-    def self.default
-      @@default ||= Configuration.new
-    end
-
-    def configure
-      yield(self) if block_given?
-    end
-
-    def scheme=(scheme)
-      # remove :// from scheme
-      @scheme = scheme.sub(/:\/\//, '')
-    end
-
-    def host=(host)
-      # remove http(s):// and anything after a slash
-      @host = host.sub(/https?:\/\//, '').split('/').first
-    end
-
-    def base_path=(base_path)
-      # Add leading and trailing slashes to base_path
-      @base_path = "/#{base_path}".gsub(/\/+/, '/')
-      @base_path = '' if @base_path == '/'
-    end
-
-    # Returns base URL for specified operation based on server settings
-    def base_url(operation = nil)
-      index = server_operation_index.fetch(operation, server_index)
-      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil
-
-      server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
-    end
-
-    # Gets API key (with prefix if set).
-    # @param [String] param_name the parameter name of API key auth
-    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
-
-    # Gets Basic Auth token string
-    def basic_auth_token
-      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
-    end
-
-    # Returns Auth Settings hash for api client.
-    def auth_settings
-      {
-        AuthZ:
-          {
-            type: 'oauth2',
-            in: 'header',
-            key: 'Authorization',
-            value: "Bearer #{access_token}"
-          },
-        apiKeyAuth:
-          {
-            type: 'api_key',
-            in: 'header',
-            key: 'DD-API-KEY',
-            value: api_key_with_prefix('apiKeyAuth')
-          },
-        appKeyAuth:
-          {
-            type: 'api_key',
-            in: 'header',
-            key: 'DD-APPLICATION-KEY',
-            value: api_key_with_prefix('appKeyAuth')
-          },
-      }
-    end
-
-    # Returns an array of Server setting
-    def server_settings
-      [
-        {
-          url: "https://{subdomain}.{site}",
-          description: "No description provided",
-          variables: {
-            site: {
-              description: "The regional site for Datadog customers.",
-              default_value: "datadoghq.com",
-              enum_values: [
-                "datadoghq.com",
-                "us3.datadoghq.com",
-                "us5.datadoghq.com",
-                "datadoghq.eu",
-                "ddog-gov.com"
-              ]
-            },
-            subdomain: {
-              description: "The subdomain where the API is deployed.",
-              default_value: "api",
-            }
-          }
-        },
-        {
-          url: "{protocol}://{name}",
-          description: "No description provided",
-          variables: {
-            name: {
-              description: "Full site DNS name.",
-              default_value: "api.datadoghq.com",
-            },
-            protocol: {
-              description: "The protocol for accessing the API.",
-              default_value: "https",
-            }
-          }
-        },
-        {
-          url: "https://{subdomain}.{site}",
-          description: "No description provided",
-          variables: {
-            site: {
-              description: "Any Datadog deployment.",
-              default_value: "datadoghq.com",
-            },
-            subdomain: {
-              description: "The subdomain where the API is deployed.",
-              default_value: "api",
-            }
-          }
-        }
-      ]
-    end
-
-    def operation_server_settings
-      {
-        submit_log: [
-          {
-            url: "https://{subdomain}.{site}",
-            description: "No description provided",
-            variables: {
-              site: {
-                description: "The regional site for customers.",
-                default_value: "datadoghq.com",
-                enum_values: [
-                  "datadoghq.com",
-                  "us3.datadoghq.com",
-                  "us5.datadoghq.com",
-                  "datadoghq.eu",
-                  "ddog-gov.com"
-                ]
-              },
-              subdomain: {
-                description: "The subdomain where the API is deployed.",
-                default_value: "http-intake.logs",
-              }
-            }
-          },
-          {
-            url: "{protocol}://{name}",
-            description: "No description provided",
-            variables: {
-              name: {
-                description: "Full site DNS name.",
-                default_value: "http-intake.logs.datadoghq.com",
-              },
-              protocol: {
-                description: "The protocol for accessing the API.",
-                default_value: "https",
-              }
-            }
-          },
-          {
-            url: "https://{subdomain}.{site}",
-            description: "No description provided",
-            variables: {
-              site: {
-                description: "Any Datadog deployment.",
-                default_value: "datadoghq.com",
-              },
-              subdomain: {
-                description: "The subdomain where the API is deployed.",
-                default_value: "http-intake.logs",
-              }
-            }
-          }  
-        ],
-      }
-    end
-
-    # Returns URL based on server settings
-    #
-    # @param index array index of the server settings
-    # @param variables hash of variable and the corresponding value
-    def server_url(index, variables = {}, servers = nil)
-      servers = server_settings if servers == nil
-
-      # check array index out of bound
-      if (index < 0 || index >= servers.size)
-        fail ArgumentError, "Invalid index #{index} when selecting the server. 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
-  end
-
-  class UnparsedObject
-    # Defines unparsed object
-    attr_accessor :data
-
-    def initialize(data)
-      @data = data
-    end
-
-    def to_hash
-      self.data
-    end
-  end
-
-end

data/spec/v2/api_client_spec.rb

@@ -1,210 +0,0 @@
-=begin
-#Datadog API V2 Collection
-
-#Collection of all Datadog Public endpoints.
-
-The version of the OpenAPI document: 1.0
-Contact: support@datadoghq.com
-Generated by: https://openapi-generator.tech
-
- Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
- This product includes software developed at Datadog (https://www.datadoghq.com/).
- Copyright 2020-Present Datadog, Inc.
-
-=end
-
-require 'spec_helper'
-
-describe DatadogAPIClient::V2::APIClient do
-  context 'initialization' do
-    context 'URL stuff' do
-      context 'host' do
-        it 'removes http from host' do
-          DatadogAPIClient::V2.configure { |c| c.host = 'http://example.com' }
-          expect(DatadogAPIClient::V2::Configuration.default.host).to eq('example.com')
-        end
-
-        it 'removes https from host' do
-          DatadogAPIClient::V2.configure { |c| c.host = 'https://wookiee.com' }
-          expect(DatadogAPIClient::V2::APIClient.default.config.host).to eq('wookiee.com')
-        end
-
-        it 'removes trailing path from host' do
-          DatadogAPIClient::V2.configure { |c| c.host = 'hobo.com/v4' }
-          expect(DatadogAPIClient::V2::Configuration.default.host).to eq('hobo.com')
-        end
-      end
-
-      context 'base_path' do
-        it "prepends a slash to base_path" do
-          DatadogAPIClient::V2.configure { |c| c.base_path = 'v4/dog' }
-          expect(DatadogAPIClient::V2::Configuration.default.base_path).to eq('/v4/dog')
-        end
-
-        it "doesn't prepend a slash if one is already there" do
-          DatadogAPIClient::V2.configure { |c| c.base_path = '/v4/dog' }
-          expect(DatadogAPIClient::V2::Configuration.default.base_path).to eq('/v4/dog')
-        end
-
-        it "ends up as a blank string if nil" do
-          DatadogAPIClient::V2.configure { |c| c.base_path = nil }
-          expect(DatadogAPIClient::V2::Configuration.default.base_path).to eq('')
-        end
-      end
-    end
-  end
-
-  describe 'timeout in #build_request' do
-    let(:config) { DatadogAPIClient::V2::Configuration.new }
-    let(:api_client) { DatadogAPIClient::V2::APIClient.new(config) }
-
-    it 'defaults to nil' do
-      expect(DatadogAPIClient::V2::Configuration.default.timeout).to eq(nil)
-      expect(config.timeout).to eq(nil)
-
-      request = api_client.build_request(Net::HTTP::Get, '/test')
-      expect(request.options[:timeout]).to eq(nil)
-    end
-
-    it 'can be customized' do
-      config.timeout = 100
-      request = api_client.build_request(Net::HTTP::Get, '/test')
-      expect(request.options[:timeout]).to eq(100)
-    end
-  end
-
-  describe '#deserialize' do
-    it "handles Array<Integer>" do
-      api_client = DatadogAPIClient::V2::APIClient.new
-      headers = { 'Content-Type' => 'application/json' }
-      response = double('response', headers: headers, body: '[12, 34]')
-      data = api_client.deserialize(response, 'Array<Integer>')
-      expect(data).to be_instance_of(Array)
-      expect(data).to eq([12, 34])
-    end
-
-    it 'handles Array<Array<Integer>>' do
-      api_client = DatadogAPIClient::V2::APIClient.new
-      headers = { 'Content-Type' => 'application/json' }
-      response = double('response', headers: headers, body: '[[12, 34], [56]]')
-      data = api_client.deserialize(response, 'Array<Array<Integer>>')
-      expect(data).to be_instance_of(Array)
-      expect(data).to eq([[12, 34], [56]])
-    end
-
-    it 'handles Hash<String, String>' do
-      api_client = DatadogAPIClient::V2::APIClient.new
-      headers = { 'Content-Type' => 'application/json' }
-      response = double('response', headers: headers, body: '{"message": "Hello"}')
-      data = api_client.deserialize(response, 'Hash<String, String>')
-      expect(data).to be_instance_of(Hash)
-      expect(data).to eq(:message => 'Hello')
-    end
-  end
-
-  describe "#object_to_hash" do
-    it 'ignores nils and includes empty arrays' do
-      # uncomment below to test object_to_hash for model
-      # api_client = DatadogAPIClient::V2::APIClient.new
-      # _model = DatadogAPIClient::V2::ModelName.new
-      # update the model attribute below
-      # _model.id = 1
-      # update the expected value (hash) below
-      # expected = {id: 1, name: '', tags: []}
-      # expect(api_client.object_to_hash(_model)).to eq(expected)
-    end
-  end
-
-  describe '#build_collection_param' do
-    let(:param) { ['aa', 'bb', 'cc'] }
-    let(:api_client) { DatadogAPIClient::V2::APIClient.new }
-
-    it 'works for csv' do
-      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
-    end
-
-    it 'works for ssv' do
-      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
-    end
-
-    it 'works for tsv' do
-      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
-    end
-
-    it 'works for pipes' do
-      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
-    end
-
-    it 'works for multi' do
-      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
-    end
-
-    it 'fails for invalid collection format' do
-      expect { api_client.build_collection_param(param, :INVALID) }.to raise_error(RuntimeError, 'unknown collection format: :INVALID')
-    end
-  end
-
-  describe '#json_mime?' do
-    let(:api_client) { DatadogAPIClient::V2::APIClient.new }
-
-    it 'works' do
-      expect(api_client.json_mime?(nil)).to eq false
-      expect(api_client.json_mime?('')).to eq false
-
-      expect(api_client.json_mime?('application/json')).to eq true
-      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
-      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
-
-      expect(api_client.json_mime?('application/xml')).to eq false
-      expect(api_client.json_mime?('text/plain')).to eq false
-      expect(api_client.json_mime?('application/jsonp')).to eq false
-    end
-  end
-
-  describe '#select_header_accept' do
-    let(:api_client) { DatadogAPIClient::V2::APIClient.new }
-
-    it 'works' do
-      expect(api_client.select_header_accept(nil)).to be_nil
-      expect(api_client.select_header_accept([])).to be_nil
-
-      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
-      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
-      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
-
-      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
-      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
-    end
-  end
-
-  describe '#select_header_content_type' do
-    let(:api_client) { DatadogAPIClient::V2::APIClient.new }
-
-    it 'works' do
-      expect(api_client.select_header_content_type(nil)).to eq('application/json')
-      expect(api_client.select_header_content_type([])).to eq('application/json')
-
-      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
-      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
-      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
-      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
-      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
-    end
-  end
-
-  describe '#sanitize_filename' do
-    let(:api_client) { DatadogAPIClient::V2::APIClient.new }
-
-    it 'works' do
-      expect(api_client.sanitize_filename('sun')).to eq('sun')
-      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
-      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
-      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
-      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
-      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
-      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
-      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
-      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
-    end
-  end
-end