dogapi 1.38.0 → 1.39.0

data/lib/dogapi/v1/usage.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 'dogapi'
 
 module Dogapi

data/lib/dogapi/v1/user.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 'dogapi'
 
 module Dogapi

data/lib/dogapi/v2.rb

@@ -1 +1,5 @@
+# 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 'dogapi/v2/dashboard_list'

data/lib/dogapi/v2/dashboard_list.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 'dogapi'
 
 module Dogapi

data/lib/dogapi/version.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.
+
 module Dogapi
-  VERSION = '1.38.0'
+  VERSION = '1.39.0'
 end

data/spec/integration/alert_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/aws_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/aws_logs_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/azure_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/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

@@ -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/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
@@ -47,6 +51,17 @@ describe Dogapi::Client do
                     :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, [],

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/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

data/spec/integration/tag_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/usage_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/user_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/spec_helper.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 'rspec'
 require 'simplecov'
 require 'webmock/rspec'

data/spec/unit/capistrano_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 'spec_helper'
 require 'capistrano/datadog'
 require 'benchmark'

data/spec/unit/common_spec.rb

@@ -1,6 +1,27 @@
+# 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 'Common' do
+  describe 'validate_tags' do
+    it 'raises if tags is not an array' do
+      tags = 'foo:bar'
+      expect { Dogapi.validate_tags(tags) }.to raise_error(ArgumentError)
+      tags = nil
+      expect { Dogapi.validate_tags(tags) }.to raise_error(ArgumentError)
+    end
+    it 'raises if elements of tags are not strings' do
+      tags = ['toto:tata', { foo: 'bar' }]
+      expect { Dogapi.validate_tags(tags) }.to raise_error(ArgumentError)
+    end
+    it 'passes if tags are correct' do
+      tags = ['foo:bar', 'baz']
+      Dogapi.validate_tags(tags)
+    end
+  end
+
   describe Dogapi.find_datadog_host do
     it 'gives precedence to DATADOG_HOST env var' do
       allow(ENV).to receive(:[]).with('DATADOG_HOST').and_return('example.com')
@@ -40,6 +61,26 @@ describe 'Common' do
       ENV['http_proxy'] = nil
     end
 
+    it 'uses-the dogapi specific proxy if set' do
+      service = Dogapi::APIService.new('api_key', 'app_key')
+
+      service.connect do |conn|
+        expect(conn.proxy_address).to be(nil)
+        expect(conn.proxy_port).to be(nil)
+      end
+
+      ENV['https_proxy'] = 'https://www.proxy.com:443'
+      ENV['dd_proxy_https'] = 'https://www.otherproxy.com:443'
+
+      service.connect do |conn|
+        expect(conn.proxy_address).to eq 'www.otherproxy.com'
+        expect(conn.proxy_port).to eq 443
+      end
+
+      ENV['https_proxy'] = nil
+      ENV['dd_proxy_https'] = nil
+    end
+
     it 'respects the endpoint configuration' do
       service = Dogapi::APIService.new('api_key', 'app_key', true, nil, 'https://app.example.com')