dogapi 1.37.0 → 1.41.0

data/spec/integration/azure_integration_spec.rb

@@ -0,0 +1,63 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  CONFIG = {
+    tenant_name: 'testc44-1234-5678-9101-cc00736ftest',
+    client_id: 'testc7f6-1234-5678-9101-3fcbf464test'
+  }.freeze
+
+  CREATE_CONFIG = {
+    tenant_name: 'testc44-1234-5678-9101-cc00736ftest',
+    host_filters: 'api:test',
+    client_id: 'testc7f6-1234-5678-9101-3fcbf464test',
+    client_secret: 'testingx./Sw*g/Y33t..R1cH+hScMDt'
+  }.freeze
+
+  UPDATE_HF_CONFIG = {
+    tenant_name: 'testc44-1234-5678-9101-cc00736ftest',
+    host_filters: 'api:test1,api:test2',
+    client_id: 'testc7f6-1234-5678-9101-3fcbf464test'
+  }.freeze
+
+  UPDATE_CONFIG = {
+    tenant_name: 'testc44-1234-5678-9101-cc00736ftest',
+    new_tenant_name: '1234abcd-1234-5678-9101-abcd1234abcd',
+    host_filters: 'api:test3',
+    client_id: 'testc7f6-1234-5678-9101-3fcbf464test',
+    new_client_id: 'abcd1234-5678-1234-5678-1234abcd5678'
+  }.freeze
+
+  describe '#azure_integration_list' do
+    it_behaves_like 'an api method',
+                    :azure_integration_list, nil,
+                    :get, '/integration/azure'
+  end
+
+  describe '#azure_integration_create' do
+    it_behaves_like 'an api method',
+                    :azure_integration_create, [CREATE_CONFIG],
+                    :post, '/integration/azure', CREATE_CONFIG
+  end
+
+  describe '#azure_integration_update_host_filters' do
+    it_behaves_like 'an api method',
+                    :azure_integration_update_host_filters, [UPDATE_HF_CONFIG],
+                    :post, '/integration/azure/host_filters', UPDATE_HF_CONFIG
+  end
+
+  describe '#azure_integration_update' do
+    it_behaves_like 'an api method',
+                    :azure_integration_update, [UPDATE_CONFIG],
+                    :put, '/integration/azure', UPDATE_CONFIG
+  end
+
+  describe '#azure_integration_delete' do
+    it_behaves_like 'an api method',
+                    :azure_integration_delete, [CONFIG],
+                    :delete, '/integration/azure', CONFIG
+  end
+end

data/spec/integration/comment_spec.rb

@@ -1,4 +1,9 @@
 # encoding: utf-8
+
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require_relative '../spec_helper'
 
 describe Dogapi::Client do

data/spec/integration/common_spec.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require_relative '../spec_helper'
 
 describe Dogapi::APIService do

data/spec/integration/dash_spec.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require_relative '../spec_helper'
 
 describe Dogapi::Client do
@@ -19,12 +23,14 @@ describe Dogapi::Client do
     'prefix' => 'host',
     'default' => 'host:my-host'
   }].freeze
+  READ_ONLY = false
 
   DASH_BODY = {
     title: TITLE,
     description: DESCRIPTION,
     graphs: GRAPHS,
-    template_variables: TEMPLATE_VARIABLES
+    template_variables: TEMPLATE_VARIABLES,
+    read_only: READ_ONLY
   }.freeze
   DASH_ARGS = DASH_BODY.values
 

data/spec/integration/dashboard_list_spec.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require_relative '../spec_helper'
 
 describe Dogapi::Client do

data/spec/integration/dashboard_spec.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require_relative '../spec_helper'
 
 describe Dogapi::Client do

data/spec/integration/embed_spec.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require_relative '../spec_helper'
 
 describe Dogapi::Client do

data/spec/integration/event_spec.rb

@@ -1,4 +1,9 @@
 # encoding: utf-8
+
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require_relative '../spec_helper'
 
 describe Dogapi::Client do

data/spec/integration/gcp_integration_spec.rb

@@ -0,0 +1,57 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  CONFIG = {
+    project_id: 'datadog-apitest',
+    client_email: 'email@example.com'
+  }.freeze
+
+  CREATE_CONFIG = {
+    type: 'service_account',
+    project_id: 'datadog-apitest',
+    private_key_id: '123456789abcdefghi123456789abcdefghijklm',
+    private_key: 'fake_key',
+    client_email: 'email@example.com',
+    client_id: '123456712345671234567',
+    auth_uri: 'fake_uri',
+    token_uri: 'fake_uri',
+    auth_provider_x509_cert_url: 'fake_url',
+    client_x509_cert_url: 'fake_url',
+    host_filters: 'api:test'
+  }.freeze
+
+  UPDATE_CONFIG = {
+    project_id: 'datadog-apitest',
+    client_email: 'email@example.com',
+    host_filters: 'api:test1,api:test2',
+    automute: false
+  }.freeze
+
+  describe '#gcp_integration_list' do
+    it_behaves_like 'an api method',
+                    :gcp_integration_list, nil,
+                    :get, '/integration/gcp'
+  end
+
+  describe '#gcp_integration_create' do
+    it_behaves_like 'an api method',
+                    :gcp_integration_create, [CREATE_CONFIG],
+                    :post, '/integration/gcp', CREATE_CONFIG
+  end
+
+  describe '#gcp_integration_update' do
+    it_behaves_like 'an api method',
+                    :gcp_integration_update, [UPDATE_CONFIG],
+                    :put, '/integration/gcp', UPDATE_CONFIG
+  end
+
+  describe '#gcp_integration_delete' do
+    it_behaves_like 'an api method',
+                    :gcp_integration_delete, [CONFIG],
+                    :delete, '/integration/gcp', CONFIG
+  end
+end

data/spec/integration/integration_spec.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require_relative '../spec_helper'
 
 describe Dogapi::Client do

data/spec/integration/metadata_spec.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require_relative '../spec_helper'
 
 describe Dogapi::Client do

data/spec/integration/metric_spec.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require_relative '../spec_helper'
 
 describe Dogapi::Client do

data/spec/integration/monitor_spec.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require_relative '../spec_helper'
 
 describe Dogapi::Client do
@@ -27,12 +31,37 @@ describe Dogapi::Client do
                     :get, "/monitor/#{MONITOR_ID}", group_states: %w(custom all)
   end
 
+  describe '#can_delete_monitors' do
+    context 'with one id' do
+      it_behaves_like 'an api method',
+                      :can_delete_monitors, [MONITOR_ID],
+                      :get, '/monitor/can_delete'
+    end
+
+    context 'with multiple ids' do
+      it_behaves_like 'an api method',
+                      :can_delete_monitors, [[MONITOR_ID, MONITOR_ID + 1, MONITOR_ID + 2]],
+                      :get, '/monitor/can_delete'
+    end
+  end
+
   describe '#delete_monitor' do
     it_behaves_like 'an api method',
                     :delete_monitor, [MONITOR_ID],
                     :delete, "/monitor/#{MONITOR_ID}"
   end
 
+  describe '#delete_monitor with options' do
+    it 'queries the api with options' do
+      url = api_url + "/monitor/#{MONITOR_ID}?force=true"
+      options = { 'force' => true }
+      stub_request(:delete, url).to_return(body: '{}').then.to_raise(StandardError)
+      expect(dog.send(:delete_monitor, MONITOR_ID, options)).to eq ['200', {}]
+
+      expect(WebMock).to have_requested(:delete, url)
+    end
+  end
+
   describe '#get_all_monitors' do
     it_behaves_like 'an api method with optional params',
                     :get_all_monitors, [],
@@ -102,7 +131,7 @@ describe Dogapi::Client do
   describe '#cancel_downtime_by_scope' do
     it_behaves_like 'an api method',
                     :cancel_downtime_by_scope, [DOWNTIME_SCOPE],
-                    :post, '/downtime/cancel/by_scope'
+                    :post, '/downtime/cancel/by_scope', 'scope' => DOWNTIME_SCOPE
   end
 
   describe '#get_all_downtimes' do

data/spec/integration/screenboard_spec.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require_relative '../spec_helper'
 
 describe Dogapi::Client do

data/spec/integration/search_spec.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require_relative '../spec_helper'
 
 describe Dogapi::Client do

data/spec/integration/service_check_spec.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require_relative '../spec_helper'
 
 describe Dogapi::Client do

data/spec/integration/service_level_objective_spec.rb

@@ -11,19 +11,21 @@ describe Dogapi::Client do
   SLO_THRESHOLDS = [{ timeframe: '7d', target: 90 }, { timeframe: '30d', target: 95 }].freeze
 
   describe '#create_service_level_objective' do
-    it_behaves_like 'an api method with named args',
-                    :create_service_level_objective, {type: SLO_TYPE, name: SLO_NAME, description: SLO_DESCRIPTION,
-                                                      tags: SLO_TAGS, thresholds: SLO_THRESHOLDS,
-                                                      numerator: SLO_QUERY_NUMERATOR,
-                                                      denominator: SLO_QUERY_DENOMINATOR},
+    it_behaves_like 'an api method',
+                    :create_service_level_objective, [SLO_TYPE, SLO_NAME, SLO_THRESHOLDS, {
+                      description: SLO_DESCRIPTION,
+                      tags: SLO_TAGS,
+                      numerator: SLO_QUERY_NUMERATOR,
+                      denominator: SLO_QUERY_DENOMINATOR
+                    }],
                     :post, '/slo', 'type' => SLO_TYPE, 'name' => SLO_NAME, 'thresholds' => SLO_THRESHOLDS,
                                    'query' => { numerator: SLO_QUERY_NUMERATOR, denominator: SLO_QUERY_DENOMINATOR },
                                    'tags' => SLO_TAGS, 'description' => SLO_DESCRIPTION
   end
 
   describe '#update_service_level_objective' do
-    it_behaves_like 'an api method with named args',
-                    :update_service_level_objective, {slo_id: SLO_ID, type: SLO_TYPE, name: SLO_NAME},
+    it_behaves_like 'an api method',
+                    :update_service_level_objective, [SLO_ID, SLO_TYPE, { name: SLO_NAME }],
                     :put, "/slo/#{SLO_ID}", 'type' => SLO_TYPE, 'name' => SLO_NAME
   end
 
@@ -36,18 +38,18 @@ describe Dogapi::Client do
   describe '#get_service_level_objective_history' do
     it_behaves_like 'an api method with params',
                     :get_service_level_objective_history, [SLO_ID],
-                    :get, "/slo/#{SLO_ID}/history", 'from_ts' => 0, 'to_ts' => 1000000
+                    :get, "/slo/#{SLO_ID}/history", 'from_ts' => 0, 'to_ts' => 1_000_000
   end
 
   describe '#can_delete_service_level_objective' do
     it_behaves_like 'an api method with params',
                     :can_delete_service_level_objective, [],
-                    :get, "/slo/can_delete", 'ids' => [SLO_ID]
+                    :get, '/slo/can_delete', 'ids' => [SLO_ID]
   end
 
   describe '#search_service_level_objective' do
-    it_behaves_like 'an api method with named args making params',
-                    :search_service_level_objective, {slo_ids: [SLO_ID]},
+    it_behaves_like 'an api method with optional params',
+                    :search_service_level_objective, [[SLO_ID]],
                     :get, '/slo/', 'ids' => SLO_ID
   end
 

data/spec/integration/snapshot_spec.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require_relative '../spec_helper'
 
 describe Dogapi::Client do

data/spec/integration/synthetics_spec.rb

@@ -0,0 +1,131 @@
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  SYNTHETICS_TEST_PUBLIC_ID = '84r-szk-xpt'
+  SYNTHETICS_TESTS_PUBLIC_IDS = ['84r-szk-xpt', 'sti-s2m-ciz']
+  NEW_STATUS = 'paused'
+  SYNTHETICS_RESULT_ID = 123_456
+
+  SYNTHETICS_TEST_TYPE = 'api'.freeze
+  SYNTHETICS_TEST_CONFIG = {
+    'assertions' => [
+      {
+        'operator' => 'is',
+        'type' => 'statusCode',
+        'target' => 403
+      },
+      {
+        'operator' => 'is',
+        'property' => 'content-type',
+        'type' => 'header',
+        'target' => 'text/html'
+      },
+      {
+        'operator' => 'lessThan',
+        'type' => 'responseTime',
+        'target' => 2000
+      }
+    ],
+    'request' => {
+      'method' => 'GET',
+      'url' => 'https://datadoghq.com',
+      'timeout' => 30,
+      'headers' => {
+        'header1' => 'value1',
+        'header2' => 'value2'
+      },
+      'body' => 'body to send with the request'
+    }
+  }.freeze
+
+  SYNTHETICS_TEST_OPTIONS = {
+    'locations' => [
+      'aws:us-east-2',
+      'aws:eu-central-1',
+      'aws:ca-central-1'
+    ],
+    'options' => {
+      'tick_every' => 60,
+      'min_failure_duration' => 0,
+      'min_location_failed' => 1,
+      'follow_redirects' => true
+    },
+    'message' => 'Test with API',
+    'name' => 'Test with API',
+    'tags' => ['key1:value1', 'key2:value2']
+  }.freeze
+
+  describe '#create_synthetics_test' do
+    it 'queries the api' do
+      url = api_url + '/synthetics/tests'
+      stub_request(:post, /#{url}/).to_return(body: '{}').then.to_raise(StandardError)
+      expect(dog.send(:create_synthetics_test, SYNTHETICS_TEST_TYPE, SYNTHETICS_TEST_CONFIG,
+                      SYNTHETICS_TEST_OPTIONS)).to eq ['200', {}]
+
+      expect(WebMock).to have_requested(:post, url)
+    end
+  end
+
+  describe '#update_synthetics_test' do
+    it 'queries the api' do
+      url = api_url + "/synthetics/tests/#{SYNTHETICS_TEST_PUBLIC_ID}"
+      stub_request(:put, /#{url}/).to_return(body: '{}').then.to_raise(StandardError)
+      expect(dog.send(:update_synthetics_test, SYNTHETICS_TEST_PUBLIC_ID, SYNTHETICS_TEST_TYPE,
+                      SYNTHETICS_TEST_CONFIG, SYNTHETICS_TEST_OPTIONS)).to eq ['200', {}]
+
+      expect(WebMock).to have_requested(:put, url)
+    end
+  end
+
+  describe '#delete_synthetics_tests' do
+    it_behaves_like 'an api method',
+                    :delete_synthetics_tests, [SYNTHETICS_TESTS_PUBLIC_IDS],
+                    :post, '/synthetics/tests/delete', 'public_ids' => SYNTHETICS_TESTS_PUBLIC_IDS
+  end
+
+  describe '#start_pause_synthetics_test' do
+    it_behaves_like 'an api method',
+                    :start_pause_synthetics_test, [SYNTHETICS_TEST_PUBLIC_ID, NEW_STATUS],
+                    :put, "/synthetics/tests/#{SYNTHETICS_TEST_PUBLIC_ID}/status", 'new_status' => NEW_STATUS
+  end
+
+  describe '#get_all_synthetics_tests' do
+    it_behaves_like 'an api method',
+                    :get_all_synthetics_tests, [],
+                    :get, '/synthetics/tests'
+  end
+
+  describe '#get_synthetics_test' do
+    it_behaves_like 'an api method',
+                    :get_synthetics_test, [SYNTHETICS_TEST_PUBLIC_ID],
+                    :get, "/synthetics/tests/#{SYNTHETICS_TEST_PUBLIC_ID}"
+  end
+
+  describe '#get_synthetics_results' do
+    it_behaves_like 'an api method',
+                    :get_synthetics_results, [SYNTHETICS_TEST_PUBLIC_ID],
+                    :get, "/synthetics/tests/#{SYNTHETICS_TEST_PUBLIC_ID}/results"
+  end
+
+  describe '#get_synthetics_result' do
+    it 'queries the api' do
+      url = api_url + "/synthetics/tests/#{SYNTHETICS_TEST_PUBLIC_ID}/results/#{SYNTHETICS_RESULT_ID}"
+      stub_request(:get, /#{url}/).to_return(body: '{}').then.to_raise(StandardError)
+      expect(dog.send(:get_synthetics_result, SYNTHETICS_TEST_PUBLIC_ID, SYNTHETICS_RESULT_ID)).to eq ['200', {}]
+
+      expect(WebMock).to have_requested(:get, url)
+    end
+  end
+
+  describe '#get_synthetics_devices' do
+    it_behaves_like 'an api method',
+                    :get_synthetics_devices, [],
+                    :get, '/synthetics/browser/devices'
+  end
+
+  describe '#get_synthetics_locations' do
+    it_behaves_like 'an api method',
+                    :get_synthetics_locations, [],
+                    :get, '/synthetics/locations'
+  end
+end