dogapi 1.37.1 → 1.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0e225d4414b99557764e07500fa9d7526691cf6a0316645ec80bab21be47951
-  data.tar.gz: 3b95a96e0ea39720d6cf0ef0cc9970371a008a36af076f612c1ff3421048b13f
+  metadata.gz: 721a223d2c8a3013933fd51f060f7964e5891e439f1c4fa535193fa78d3ddfa2
+  data.tar.gz: f4b2178af09e54b4fca2d89a572d75743bc44b6d47ab4d49c2a35b0c2bc23928
 SHA512:
-  metadata.gz: 5523a7f0a3625c83049cd7d3cabd5435fcaaf6193962a2b60b3c7e0694ae4a4d83b28d7f630f983ab0c9f39d69886d0e7da7131b234f548314d22cbe14a0938a
-  data.tar.gz: e3a816e30b120f82732a785fad4afbc80d856b3729a7be365f76eb4e84b590ab198dc265784097531386a7b420d426561b9f07d703efcee5c68ca5c0ae83bf5c
+  metadata.gz: 565c7bdb5c8374ed4434ed8c1b052109e2fdbb984869bb6d7292c6e3d2e348bf24e808ad9ce8011d7678963bdeb4966229fb75d864c67c6a6f575676545c6599
+  data.tar.gz: 54e106b35aed8c276bbfef782a4f5d820823beaffdff2f4a9976d84ffa6e156ec208f2826c966e0679248fbad802f470fba7c1320aff6af1a9c534ecac0dc5ef

data/.azure-pipelines/all.yml

@@ -15,9 +15,6 @@ jobs:
     vmImage: "Ubuntu-16.04"
   strategy:
     matrix:
-      Rb23:
-        RUBY_VERSION: '2.3.7'
-        TASK: spec
       Rb24:
         RUBY_VERSION: '2.4.6'
         TASK: spec
@@ -42,3 +39,12 @@ jobs:
       displayName: 'bundle install'
     - script: bundle exec rake $(TASK)
       displayName: Run $(TASK) via bundle
+- job: TestRuby19
+  pool:
+    vmImage: "Ubuntu-16.04"
+  steps:
+    # Until the `container` AZP resource supports being root in a container https://github.com/microsoft/azure-pipelines-agent/issues/2619 we need this long single line approach
+    # By default AZP clones the repo into a folder called `s` - https://docs.microsoft.com/en-us/azure/devops/pipelines/repos/pipeline-options-for-git?view=azure-devops#checkout-path
+    # Mount this repo into the container, overwrite the Gemfile with the Ruby 1.9.3 supported depdencies, and run tests
+    - script: docker run -v $(Agent.BuildDirectory)/s:/cloned_repo corgibytes/ruby-1.9.3 bin/bash -c "cd cloned_repo; mv Gemfile_1.9 Gemfile; bundle install --retry=3 --jobs=4; bundle exec rake spec"
+      displayName: "Run tests with Ruby 1.9.3"

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-10-01 12:52:09 +0200 using RuboCop version 0.49.1.
+# on 2019-11-25 14:34:01 -0500 using RuboCop version 0.49.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -51,14 +51,14 @@ Layout/EmptyLines:
     - 'lib/capistrano/datadog/v2.rb'
     - 'lib/dogapi/facade.rb'
 
-# Offense count: 63
+# Offense count: 73
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
 Layout/EmptyLinesAroundClassBody:
   Enabled: false
 
-# Offense count: 1
+# Offense count: 4
 # Cop supports --auto-correct.
 Layout/EmptyLinesAroundMethodBody:
   Exclude:
@@ -120,7 +120,7 @@ Layout/SpaceAfterComma:
   Exclude:
     - 'examples/custom_metric.rb'
 
-# Offense count: 75
+# Offense count: 83
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: space, no_space
@@ -201,44 +201,47 @@ Lint/UselessAssignment:
   Exclude:
     - 'lib/capistrano/datadog.rb'
 
-# Offense count: 11
+# Offense count: 12
 Metrics/AbcSize:
   Max: 51
 
-# Offense count: 18
+# Offense count: 24
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
-  Max: 96
-  Exclude:
-    - 'spec/integration/monitor_spec.rb'
+  Max: 114
 
-# Offense count: 2
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 105
+
+# Offense count: 3
 Metrics/CyclomaticComplexity:
   Max: 8
 
-# Offense count: 15
+# Offense count: 17
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 34
 
-# Offense count: 2
+# Offense count: 4
 # Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
   Max: 7
 
-# Offense count: 1
+# Offense count: 2
 Metrics/PerceivedComplexity:
   Max: 9
 
-# Offense count: 11
+# Offense count: 13
 Style/AccessorMethodName:
   Exclude:
     - 'lib/dogapi/facade.rb'
     - 'lib/dogapi/v1/alert.rb'
     - 'lib/dogapi/v1/dash.rb'
+    - 'lib/dogapi/v1/dashboard.rb'
     - 'lib/dogapi/v1/embed.rb'
     - 'lib/dogapi/v1/screenboard.rb'
-    - 'lib/dogapi/v1/dashboard.rb'
     - 'lib/dogapi/v1/user.rb'
 
 # Offense count: 1
@@ -283,7 +286,7 @@ Style/ClassMethods:
   Exclude:
     - 'lib/dogapi/common.rb'
 
-# Offense count: 2
+# Offense count: 3
 Style/ClassVars:
   Exclude:
     - 'lib/dogapi/common.rb'
@@ -295,13 +298,12 @@ Style/ColonMethodCall:
     - 'lib/capistrano/datadog.rb'
     - 'lib/capistrano/datadog/v2.rb'
 
-# Offense count: 2
+# Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerBackticks.
 # SupportedStyles: backticks, percent_x, mixed
 Style/CommandLiteral:
   Exclude:
-    - 'lib/capistrano/datadog.rb'
     - 'lib/dogapi/common.rb'
 
 # Offense count: 1
@@ -312,7 +314,7 @@ Style/ConditionalAssignment:
   Exclude:
     - 'lib/capistrano/datadog.rb'
 
-# Offense count: 20
+# Offense count: 21
 # Cop supports --auto-correct.
 Style/DefWithParentheses:
   Exclude:
@@ -322,28 +324,9 @@ Style/DefWithParentheses:
     - 'lib/dogapi/v1/metric.rb'
     - 'lib/dogapi/v1/screenboard.rb'
 
-# Offense count: 21
+# Offense count: 23
 Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/capistrano/datadog.rb'
-    - 'lib/capistrano/datadog/v2.rb'
-    - 'lib/capistrano/datadog/v3.rb'
-    - 'lib/dogapi/common.rb'
-    - 'lib/dogapi/v1/alert.rb'
-    - 'lib/dogapi/v1/comment.rb'
-    - 'lib/dogapi/v1/dash.rb'
-    - 'lib/dogapi/v1/metadata.rb'
-    - 'lib/dogapi/v1/monitor.rb'
-    - 'lib/dogapi/v1/screenboard.rb'
-    - 'lib/dogapi/v1/search.rb'
-    - 'lib/dogapi/v1/service_check.rb'
-    - 'lib/dogapi/v1/snapshot.rb'
-    - 'lib/dogapi/v1/user.rb'
-    - 'lib/dogapi/v1/integration.rb'
-    - 'lib/dogapi/v1/usage.rb'
-    - 'lib/dogapi/v1/metric.rb'
+  Enabled: false
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -351,7 +334,7 @@ Style/EmptyLiteral:
   Exclude:
     - 'lib/dogapi/v1/metric.rb'
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
@@ -399,7 +382,7 @@ Style/LineEndConcatenation:
   Exclude:
     - 'dogapi.gemspec'
 
-# Offense count: 15
+# Offense count: 18
 # Cop supports --auto-correct.
 Style/MethodCallWithoutArgsParentheses:
   Exclude:
@@ -414,7 +397,7 @@ Style/MultilineIfThen:
   Exclude:
     - 'lib/capistrano/datadog.rb'
 
-# Offense count: 21
+# Offense count: 29
 # Cop supports --auto-correct.
 Style/MutableConstant:
   Enabled: false
@@ -434,12 +417,11 @@ Style/Not:
   Exclude:
     - 'lib/dogapi/v1/metric.rb'
 
-# Offense count: 5
+# Offense count: 4
 # Cop supports --auto-correct.
 # Configuration parameters: PreferredDelimiters.
 Style/PercentLiteralDelimiters:
   Exclude:
-    - 'lib/capistrano/datadog.rb'
     - 'lib/dogapi/common.rb'
     - 'spec/integration/event_spec.rb'
     - 'spec/integration/monitor_spec.rb'
@@ -452,15 +434,14 @@ Style/PreferredHashMethods:
   Exclude:
     - 'lib/dogapi/common.rb'
 
-# Offense count: 3
+# Offense count: 2
 # Cop supports --auto-correct.
 Style/RedundantBegin:
   Exclude:
     - 'lib/capistrano/datadog.rb'
-    - 'lib/dogapi/common.rb'
     - 'lib/dogapi/v1/metric.rb'
 
-# Offense count: 2
+# Offense count: 4
 # Cop supports --auto-correct.
 # Configuration parameters: AllowMultipleReturnValues.
 Style/RedundantReturn:
@@ -497,7 +478,7 @@ Style/SpecialGlobalVars:
   Exclude:
     - 'dogapi.gemspec'
 
-# Offense count: 22
+# Offense count: 25
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes
@@ -509,8 +490,9 @@ Style/StringLiterals:
     - 'examples/Capfile'
     - 'examples/custom_event.rb'
     - 'lib/dogapi/event.rb'
+    - 'lib/dogapi/v1/monitor.rb'
 
-# Offense count: 10
+# Offense count: 9
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyleForMultiline, SupportedStylesForMultiline.
 # SupportedStylesForMultiline: comma, consistent_comma, no_comma
@@ -526,11 +508,11 @@ Style/TrailingCommaInLiteral:
 
 # Offense count: 2
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, MinSize, WordRegex.
+# Configuration parameters: SupportedStyles, WordRegex.
 # SupportedStyles: percent, brackets
 Style/WordArray:
-  Exclude:
-    - 'examples/custom_event.rb'
+  EnforcedStyle: percent
+  MinSize: 3
 
 # Offense count: 1
 # Cop supports --auto-correct.

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changes
 
+## 1.38.0 / 2019-12-13
+
+* [BUGFIX] Fix setting keys in both query params and headers. See [#194][]
+* [BUGFIX] Fix `cancel_downtime_by_scope` method by setting `send_json` to `true`. See [#205][]
+* [FEATURE] Add Azure, GCP, AWS, and AWS Logs integration support. See [#201][]
+* [FEATURE] Add support for new `Monitor.can_delete` endpoint. See [#195][]
+* [FEATURE] Add `options` to the `get_downtime` endpoint. See [#206][]
+
 ## 1.37.1 / 2019-11-04
 
 * [BUGFIX] Revert the Service Level Objective feature to remove an issue with older versions of Ruby < 2.0. See [#198][]
@@ -261,7 +269,12 @@ This is the last release compatible with Ruby 1.8. ([EOL 2013-06-30](https://www
 [#188]: https://github.com/DataDog/dogapi-rb/issues/188
 [#189]: https://github.com/DataDog/dogapi-rb/issues/189
 [#192]: https://github.com/DataDog/dogapi-rb/issues/192
+[#194]: https://github.com/DataDog/dogapi-rb/issues/194
+[#195]: https://github.com/DataDog/dogapi-rb/issues/195
 [#198]: https://github.com/DataDog/dogapi-rb/issues/198
+[#201]: https://github.com/DataDog/dogapi-rb/issues/201
+[#205]: https://github.com/DataDog/dogapi-rb/issues/205
+[#206]: https://github.com/DataDog/dogapi-rb/issues/206
 [@ArjenSchwarz]: https://github.com/ArjenSchwarz
 [@Kaixiang]: https://github.com/Kaixiang
 [@TaylURRE]: https://github.com/TaylURRE

data/Gemfile_1.9

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rubocop', "~> 0.41.0"
+  gem 'rake', '>= 2.4.2'
+  gem 'rspec'
+  gem 'simplecov', "~> 0.11.2"
+  gem 'webmock'
+end

data/lib/dogapi/common.rb

@@ -118,16 +118,8 @@ module Dogapi
       resp = nil
       connect do |conn|
         begin
-          current_url = url + prepare_params(extra_params, url, with_app_key)
-          req = method.new(current_url)
-          req['DD-API-KEY'] = @api_key
-          req['DD-APPLICATION-KEY'] = @application_key if with_app_key
-
-          if send_json
-            req.content_type = 'application/json'
-            req.body = MultiJson.dump(body)
-          end
-
+          params = prepare_params(extra_params, url, with_app_key)
+          req = prepare_request(method, url, params, body, send_json, with_app_key)
           resp = conn.request(req)
           return handle_response(resp)
         rescue Exception => e
@@ -136,29 +128,37 @@ module Dogapi
       end
     end
 
-    def prepare_params(extra_params, url, with_app_key)
-      params = set_api_and_app_keys_in_params(url, with_app_key)
-      params = extra_params.merge params unless extra_params.nil?
-      qs_params = params.map { |k, v| CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s) }
-      qs = '?' + qs_params.join('&')
-      qs
-    end
-
-    def set_api_and_app_keys_in_params(url, with_app_key)
-      set_of_urls = Set.new ['/api/v1/series',
-                             '/api/v1/check_run',
-                             '/api/v1/events',
-                             '/api/v1/screen']
+    def prepare_request(method, url, params, body, send_json, with_app_key)
+      url_with_params = url + params
+      req = method.new(url_with_params)
+      unless should_set_api_and_app_keys_in_params?(url)
+        req['DD-API-KEY'] = @api_key
+        req['DD-APPLICATION-KEY'] = @application_key if with_app_key
+      end
 
-      include_in_params = set_of_urls.include?(url)
+      if send_json
+        req.content_type = 'application/json'
+        req.body = MultiJson.dump(body)
+      end
+      return req
+    end
 
-      if include_in_params
+    def prepare_params(extra_params, url, with_app_key)
+      if should_set_api_and_app_keys_in_params?(url)
         params = { api_key: @api_key }
         params[:application_key] = @application_key if with_app_key
       else
         params = {}
       end
-      return params
+      params = extra_params.merge params unless extra_params.nil?
+      qs_params = params.map { |k, v| CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s) }
+      qs = '?' + qs_params.join('&')
+      qs
+    end
+
+    def should_set_api_and_app_keys_in_params?(url)
+      set_of_urls = Set.new ['/api/v1/series', '/api/v1/check_run', '/api/v1/events', '/api/v1/screen']
+      return set_of_urls.include?(url)
     end
 
     def handle_response(resp)

data/lib/dogapi/facade.rb

@@ -59,6 +59,7 @@ module Dogapi
     attr_accessor :v2
     # Support for API version 2.
 
+    # rubocop:disable Metrics/MethodLength, Metrics/LineLength
     def initialize(api_key, application_key=nil, host=nil, device=nil, silent=true, timeout=nil, endpoint=nil)
 
       if api_key
@@ -94,12 +95,16 @@ module Dogapi
       @legacy_event_svc = Dogapi::EventService.new(@datadog_host)
       @hosts_svc = Dogapi::V1::HostsService.new(@api_key, @application_key, silent, timeout, @datadog_host)
       @integration_svc = Dogapi::V1::IntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @aws_integration_svc = Dogapi::V1::AwsIntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @aws_logs_svc = Dogapi::V1::AwsLogsService.new(@api_key, @application_key, silent, timeout, @datadog_host)
       @usage_svc = Dogapi::V1::UsageService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-
+      @azure_integration_svc = Dogapi::V1::AzureIntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @gcp_integration_svc = Dogapi::V1::GcpIntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host)
       # Support for Dashboard List API v2.
       @v2 = Dogapi::ClientV2.new(@api_key, @application_key, true, true, @datadog_host)
 
     end
+    # rubocop:enable Metrics/MethodLength, Metrics/LineLength
 
     #
     # METRICS
@@ -536,6 +541,10 @@ module Dogapi
       @monitor_svc.get_monitor(monitor_id, options)
     end
 
+    def can_delete_monitors(monitor_ids)
+      @monitor_svc.can_delete_monitors(monitor_ids)
+    end
+
     def delete_monitor(monitor_id)
       @monitor_svc.delete_monitor(monitor_id)
     end
@@ -588,8 +597,8 @@ module Dogapi
       @monitor_svc.update_downtime(downtime_id, options)
     end
 
-    def get_downtime(downtime_id)
-      @monitor_svc.get_downtime(downtime_id)
+    def get_downtime(downtime_id, options = {})
+      @monitor_svc.get_downtime(downtime_id, options)
     end
 
     def cancel_downtime(downtime_id)
@@ -682,6 +691,108 @@ module Dogapi
       @integration_svc.delete_integration(source_type_name)
     end
 
+    #
+    # AWS INTEGRATION
+    #
+    def aws_integration_list
+      @aws_integration_svc.aws_integration_list
+    end
+
+    def aws_integration_create(config)
+      @aws_integration_svc.aws_integration_create(config)
+    end
+
+    def aws_integration_delete(config)
+      @aws_integration_svc.aws_integration_delete(config)
+    end
+
+    def aws_integration_list_namespaces
+      @aws_integration_svc.aws_integration_list_namespaces
+    end
+
+    def aws_integration_generate_external_id(config)
+      @aws_integration_svc.aws_integration_generate_external_id(config)
+    end
+
+    def aws_integration_update(config, new_config)
+      @aws_integration_svc.aws_integration_update(config, new_config)
+    end
+
+    #
+    # AWS Logs Integration
+    #
+
+    def aws_logs_add_lambda(config)
+      @aws_logs_svc.aws_logs_add_lambda(config)
+    end
+
+    def aws_logs_list_services
+      @aws_logs_svc.aws_logs_list_services
+    end
+
+    def aws_logs_save_services(config)
+      @aws_logs_svc.aws_logs_save_services(config)
+    end
+
+    def aws_logs_integrations_list
+      @aws_logs_svc.aws_logs_integrations_list
+    end
+
+    def aws_logs_integration_delete(config)
+      @aws_logs_svc.aws_logs_integration_delete(config)
+    end
+
+    def aws_logs_check_lambda(config)
+      @aws_logs_svc.aws_logs_check_lambda(config)
+    end
+
+    def aws_logs_check_services(config)
+      @aws_logs_svc.aws_logs_check_services(config)
+    end
+
+    #
+    # AZURE INTEGRATION
+    #
+
+    def azure_integration_list
+      @azure_integration_svc.azure_integration_list
+    end
+
+    def azure_integration_create(config)
+      @azure_integration_svc.azure_integration_create(config)
+    end
+
+    def azure_integration_delete(config)
+      @azure_integration_svc.azure_integration_delete(config)
+    end
+
+    def azure_integration_update_host_filters(config)
+      @azure_integration_svc.azure_integration_update_host_filters(config)
+    end
+
+    def azure_integration_update(config)
+      @azure_integration_svc.azure_integration_update(config)
+    end
+
+    #
+    # GCP INTEGRATION
+    #
+    def gcp_integration_list
+      @gcp_integration_svc.gcp_integration_list
+    end
+
+    def gcp_integration_delete(config)
+      @gcp_integration_svc.gcp_integration_delete(config)
+    end
+
+    def gcp_integration_create(config)
+      @gcp_integration_svc.gcp_integration_create(config)
+    end
+
+    def gcp_integration_update(config)
+      @gcp_integration_svc.gcp_integration_update(config)
+    end
+
     #
     # USAGE
     #