dogapi 1.37.1 → 1.42.0

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

@@ -0,0 +1,73 @@
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  SLO_ID = '42424242424242424242424242424242'.freeze
+  SLO_TYPE = 'metric'.freeze
+  SLO_NAME = 'test slo'.freeze
+  SLO_DESCRIPTION = 'test slo description'.freeze
+  SLO_QUERY_NUMERATOR = 'sum:test.metric.metric{type:good}.as_count()'.freeze
+  SLO_QUERY_DENOMINATOR = 'sum:test.metric.metric{*}.as_count()'.freeze
+  SLO_TAGS = ['type:test'].freeze
+  SLO_THRESHOLDS = [{ timeframe: '7d', target: 90 }, { timeframe: '30d', target: 95 }].freeze
+
+  describe '#create_service_level_objective' do
+    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',
+                    :update_service_level_objective, [SLO_ID, SLO_TYPE, { name: SLO_NAME }],
+                    :put, "/slo/#{SLO_ID}", 'type' => SLO_TYPE, 'name' => SLO_NAME
+  end
+
+  describe '#get_service_level_objective' do
+    it_behaves_like 'an api method',
+                    :get_service_level_objective, [SLO_ID],
+                    :get, "/slo/#{SLO_ID}"
+  end
+
+  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' => 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]
+  end
+
+  describe '#search_service_level_objective' do
+    it_behaves_like 'an api method with optional params',
+                    :search_service_level_objective, [[SLO_ID]],
+                    :get, '/slo/', 'ids' => SLO_ID
+  end
+
+  describe '#delete_service_level_objective' do
+    it_behaves_like 'an api method',
+                    :delete_service_level_objective, [SLO_ID],
+                    :delete, "/slo/#{SLO_ID}"
+  end
+
+  describe '#delete_many_service_level_objective' do
+    it_behaves_like 'an api method',
+                    :delete_many_service_level_objective, [[SLO_ID]],
+                    :delete, '/slo/', 'ids' => [SLO_ID]
+  end
+
+  describe '#delete_timeframes_service_level_objective' do
+    it_behaves_like 'an api method',
+                    :delete_timeframes_service_level_objective, [{ SLO_ID => ['7d'] }],
+                    :post, '/slo/bulk_delete', SLO_ID => ['7d']
+  end
+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

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'
@@ -73,6 +77,23 @@ module SpecDog
     end
   end
 
+  shared_examples 'an api method with params and body' do |command, args, request, endpoint, params, body|
+    it 'queries the api with params and body' do
+      url = api_url + endpoint
+      stub_request(request, /#{url}/).to_return(body: '{}').then.to_raise(StandardError)
+      expect(dog.send(command, *args)).to eq ['200', {}]
+      params.each { |k, v| params[k] = v.join(',') if v.is_a? Array }
+      params = params
+
+      body = MultiJson.dump(body) if body
+
+      expect(WebMock).to have_requested(request, url).with(
+        query: params,
+        body: body
+      )
+    end
+  end
+
   shared_examples 'an api method with optional params' do |command, args, request, endpoint, opt_params|
     include_examples 'an api method', command, args, request, endpoint
     it 'queries the api with optional params' do

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')
 
@@ -65,11 +106,12 @@ describe 'Common' do
               '/api/v1/screen']
 
       urls.each do |url|
-        params = service.set_api_and_app_keys_in_params(url, true)
-        expect(params).to have_key(:api_key)
-        expect(params[:api_key]).to eq service.api_key
-        expect(params).to have_key(:application_key)
-        expect(params[:application_key]).to eq service.application_key
+        expect(service.should_set_api_and_app_keys_in_params?(url)).to be true
+        params = service.prepare_params(nil, url, true)
+        expect(params).to eq("?api_key=#{service.api_key}&application_key=#{service.application_key}")
+        req = service.prepare_request(Net::HTTP::Get, url, params, nil, false, true)
+        expect(req.key?('DD-API-KEY')).to be false
+        expect(req.key?('DD-APPLICATION-KEY')).to be false
       end
     end
 
@@ -82,10 +124,25 @@ describe 'Common' do
               '/api/v2/users']
 
       urls.each do |url|
-        params = service.set_api_and_app_keys_in_params(url, true)
-        expect(params).to eq({})
+        expect(service.should_set_api_and_app_keys_in_params?(url)).to be false
+        params = service.prepare_params(nil, url, true)
+        expect(params).to eq('?')
+        req = service.prepare_request(Net::HTTP::Get, url, params, nil, false, true)
+        expect(req.key?('DD-API-KEY')).to be true
+        expect(req['DD-API-KEY']).to eq service.api_key
+        expect(req.key?('DD-APPLICATION-KEY')).to be true
+        expect(req['DD-APPLICATION-KEY']).to eq service.application_key
       end
     end
+
+    it 'properly sets User-Agent header' do
+      service = Dogapi::APIService.new('api_key', 'app_key', true, nil, 'https://app.example.com')
+      params = service.prepare_params(nil, '/api/v1/validate', true)
+      req = service.prepare_request(Net::HTTP::Get, '/api/v1/validate', params, nil, false, true)
+
+      expect(req.key?('User-Agent')).to be true
+      expect(req['User-Agent']).to match(%r{dogapi-rb\/[^\s]+ \(ruby [^\s]+; os [^\s]+; arch [^\s]+\)})
+    end
   end
 end
 

data/spec/unit/facade_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'
 
 describe Dogapi::Client do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogapi
 version: !ruby/object:Gem::Version
-  version: 1.37.1
+  version: 1.42.0
 platform: ruby
 authors:
 - Datadog, Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-05 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -75,16 +75,29 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - ".azure-pipelines/all.yml"
+- ".github/CODEOWNERS"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/labeler.yml"
+- ".github/workflows/labeler.yml"
+- ".github/workflows/stale.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".tailor"
 - CHANGELOG.md
+- CONTRIBUTING.md
+- DEVELOPMENT.md
 - Gemfile
+- Gemfile_1.9
 - LICENSE
+- LICENSE-3rdparty.csv
 - README.rdoc
+- RELEASING.md
 - Rakefile
+- SUPPORT.md
 - dogapi.gemspec
 - examples/Capfile
 - examples/custom_event.rb
@@ -100,12 +113,16 @@ files:
 - lib/dogapi/metric.rb
 - lib/dogapi/v1.rb
 - lib/dogapi/v1/alert.rb
+- lib/dogapi/v1/aws_integration.rb
+- lib/dogapi/v1/aws_logs.rb
+- lib/dogapi/v1/azure_integration.rb
 - lib/dogapi/v1/comment.rb
 - lib/dogapi/v1/dash.rb
 - lib/dogapi/v1/dashboard.rb
 - lib/dogapi/v1/dashboard_list.rb
 - lib/dogapi/v1/embed.rb
 - lib/dogapi/v1/event.rb
+- lib/dogapi/v1/gcp_integration.rb
 - lib/dogapi/v1/hosts.rb
 - lib/dogapi/v1/integration.rb
 - lib/dogapi/v1/metadata.rb
@@ -114,7 +131,9 @@ files:
 - lib/dogapi/v1/screenboard.rb
 - lib/dogapi/v1/search.rb
 - lib/dogapi/v1/service_check.rb
+- lib/dogapi/v1/service_level_objective.rb
 - lib/dogapi/v1/snapshot.rb
+- lib/dogapi/v1/synthetics.rb
 - lib/dogapi/v1/tag.rb
 - lib/dogapi/v1/usage.rb
 - lib/dogapi/v1/user.rb
@@ -122,6 +141,9 @@ files:
 - lib/dogapi/v2/dashboard_list.rb
 - lib/dogapi/version.rb
 - spec/integration/alert_spec.rb
+- spec/integration/aws_integration_spec.rb
+- spec/integration/aws_logs_spec.rb
+- spec/integration/azure_integration_spec.rb
 - spec/integration/comment_spec.rb
 - spec/integration/common_spec.rb
 - spec/integration/dash_spec.rb
@@ -129,6 +151,7 @@ files:
 - spec/integration/dashboard_spec.rb
 - spec/integration/embed_spec.rb
 - spec/integration/event_spec.rb
+- spec/integration/gcp_integration_spec.rb
 - spec/integration/integration_spec.rb
 - spec/integration/metadata_spec.rb
 - spec/integration/metric_spec.rb
@@ -136,7 +159,9 @@ files:
 - spec/integration/screenboard_spec.rb
 - spec/integration/search_spec.rb
 - spec/integration/service_check_spec.rb
+- spec/integration/service_level_objective_spec.rb
 - spec/integration/snapshot_spec.rb
+- spec/integration/synthetics_spec.rb
 - spec/integration/tag_spec.rb
 - spec/integration/usage_spec.rb
 - spec/integration/user_spec.rb
@@ -152,7 +177,7 @@ metadata:
   changelog_uri: https://github.com/DataDog/dogapi-rb/blob/master/CHANGELOG.md
   documentation_uri: https://docs.datadoghq.com/api/
   source_code_uri: https://github.com/DataDog/dogapi-rb
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--title"
 - DogAPI -- Datadog Client
@@ -173,13 +198,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Ruby bindings for Datadog's API
 test_files:
 - spec/integration/alert_spec.rb
+- spec/integration/aws_integration_spec.rb
+- spec/integration/aws_logs_spec.rb
+- spec/integration/azure_integration_spec.rb
 - spec/integration/comment_spec.rb
 - spec/integration/common_spec.rb
 - spec/integration/dash_spec.rb
@@ -187,6 +214,7 @@ test_files:
 - spec/integration/dashboard_spec.rb
 - spec/integration/embed_spec.rb
 - spec/integration/event_spec.rb
+- spec/integration/gcp_integration_spec.rb
 - spec/integration/integration_spec.rb
 - spec/integration/metadata_spec.rb
 - spec/integration/metric_spec.rb
@@ -194,7 +222,9 @@ test_files:
 - spec/integration/screenboard_spec.rb
 - spec/integration/search_spec.rb
 - spec/integration/service_check_spec.rb
+- spec/integration/service_level_objective_spec.rb
 - spec/integration/snapshot_spec.rb
+- spec/integration/synthetics_spec.rb
 - spec/integration/tag_spec.rb
 - spec/integration/usage_spec.rb
 - spec/integration/user_spec.rb