dogapi 1.36.0 → 1.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5c534abc672555cbdf8ae3e4ad066a06bc6d066b
-  data.tar.gz: 349b0b8721a13b3bbe97d4f3183dc739a259a4d7
+SHA256:
+  metadata.gz: 762f1d3fe87b94278a55cca80da8824b0c2db3c420ea9e8192cd1f33d7a274ce
+  data.tar.gz: c60248ed8d4cc8e3d3f96662651878f42591bd336c4c6d58511489e504474607
 SHA512:
-  metadata.gz: b23eaa485025ad841b5a74683c85009fc3eca097b2681ae9045af8a146adc1f6b881c49d46919f40fe54ff691d671b162928b07eab83666ccad1f5c23fea593e
-  data.tar.gz: a8d31cf15e3f1d61e6fc0da448994b57fae3d5f6a6846b3713bbb95ced32890da0af5f05a281040cfccc75015adb68921679b7a1769ec8cefb9570b3c2696738
+  metadata.gz: '09565868bb18c71030b625b908a8783f83f135e237c6e6fe8600ecd745141c34cd3e2bc019fb24ad84d01fdb5b839d56cd4dc57db9fe751b37c13ec43f31593b'
+  data.tar.gz: d93617177693a86273716dd2ccc99bb3e79ef2aa77a44cd021a635a7181e34df9485592a2ed341c9cae50407007add7a9e30348a77212aea28ab7332da2b38bb

data/.azure-pipelines/all.yml

@@ -0,0 +1,44 @@
+trigger:
+  batch: false
+  branches:
+    include:
+    - master
+
+pr:
+  branches:
+    include:
+    - master
+
+jobs:
+- job: UnitTests
+  pool:
+    vmImage: "Ubuntu-16.04"
+  strategy:
+    matrix:
+      Rb23:
+        RUBY_VERSION: '2.3.7'
+        TASK: spec
+      Rb24:
+        RUBY_VERSION: '2.4.6'
+        TASK: spec
+      Rb25:
+        RUBY_VERSION: '2.5.5'
+        TASK: spec
+      Rb26:
+        RUBY_VERSION: '2.6.3'
+        TASK: spec
+      Lint:
+        RUBY_VERSION: '2.6.3'
+        TASK: rubocop
+  steps:
+    - task: UseRubyVersion@0
+      displayName: Use Ruby $(RUBY_VERSION)
+      inputs:
+        versionSpec: $(RUBY_VERSION)
+        addToPath: true
+    - script: |
+        gem install bundler
+        bundle install --retry=3 --jobs=4
+      displayName: 'bundle install'
+    - script: bundle exec rake $(TASK)
+      displayName: Run $(TASK) via bundle

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-10-23 14:52:35 -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: 78
 # 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:
@@ -85,10 +85,20 @@ Layout/ExtraSpacing:
 
 # Offense count: 2
 # Cop supports --auto-correct.
-# Configuration parameters: SupportedStyles, IndentationWidth.
+# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
+# SupportedStyles: consistent, special_for_inner_method_call, special_for_inner_method_call_in_parentheses
+Layout/FirstParameterIndentation:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
 # SupportedStyles: special_inside_parentheses, consistent, align_braces
 Layout/IndentHash:
-  EnforcedStyle: consistent
+  Exclude:
+    - 'lib/dogapi/v1/event.rb'
+    - 'lib/dogapi/v1/service_level_objective.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -120,7 +130,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
@@ -147,12 +157,29 @@ Layout/SpaceAroundOperators:
     - 'examples/custom_metric.rb'
     - 'lib/dogapi/event.rb'
 
-# Offense count: 1
+# Offense count: 8
+# Cop supports --auto-correct.
+Layout/SpaceBeforeComma:
+  Exclude:
+    - 'lib/dogapi/facade.rb'
+    - 'lib/dogapi/v1/service_level_objective.rb'
+
+# Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: AllowForAlignment.
 Layout/SpaceBeforeFirstArg:
   Exclude:
     - 'lib/capistrano/datadog/v2.rb'
+    - 'lib/dogapi/v1/service_level_objective.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SupportedStylesForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'spec/integration/service_level_objective_spec.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -201,44 +228,42 @@ Lint/UselessAssignment:
   Exclude:
     - 'lib/capistrano/datadog.rb'
 
-# Offense count: 11
+# Offense count: 13
 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: 102
 
-# Offense count: 2
+# Offense count: 5
 Metrics/CyclomaticComplexity:
-  Max: 8
+  Max: 11
 
-# Offense count: 15
+# Offense count: 18
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 34
 
-# Offense count: 2
+# Offense count: 7
 # Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
-  Max: 7
+  Max: 11
 
-# Offense count: 1
+# Offense count: 4
 Metrics/PerceivedComplexity:
-  Max: 9
+  Max: 12
 
-# 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 +308,7 @@ Style/ClassMethods:
   Exclude:
     - 'lib/dogapi/common.rb'
 
-# Offense count: 2
+# Offense count: 3
 Style/ClassVars:
   Exclude:
     - 'lib/dogapi/common.rb'
@@ -295,24 +320,24 @@ 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
+# Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, SingleLineConditionsOnly, IncludeTernaryExpressions.
 # SupportedStyles: assign_to_condition, assign_inside_condition
 Style/ConditionalAssignment:
   Exclude:
     - 'lib/capistrano/datadog.rb'
+    - 'lib/dogapi/v1/service_level_objective.rb'
 
-# Offense count: 20
+# Offense count: 21
 # Cop supports --auto-correct.
 Style/DefWithParentheses:
   Exclude:
@@ -322,28 +347,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 +357,7 @@ Style/EmptyLiteral:
   Exclude:
     - 'lib/dogapi/v1/metric.rb'
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
@@ -399,7 +405,7 @@ Style/LineEndConcatenation:
   Exclude:
     - 'dogapi.gemspec'
 
-# Offense count: 15
+# Offense count: 18
 # Cop supports --auto-correct.
 Style/MethodCallWithoutArgsParentheses:
   Exclude:
@@ -414,7 +420,7 @@ Style/MultilineIfThen:
   Exclude:
     - 'lib/capistrano/datadog.rb'
 
-# Offense count: 21
+# Offense count: 30
 # Cop supports --auto-correct.
 Style/MutableConstant:
   Enabled: false
@@ -434,12 +440,17 @@ Style/Not:
   Exclude:
     - 'lib/dogapi/v1/metric.rb'
 
-# Offense count: 5
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Strict.
+Style/NumericLiterals:
+  MinDigits: 8
+
+# 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,12 +463,11 @@ 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
@@ -497,7 +507,7 @@ Style/SpecialGlobalVars:
   Exclude:
     - 'dogapi.gemspec'
 
-# Offense count: 22
+# Offense count: 23
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes
@@ -509,6 +519,7 @@ Style/StringLiterals:
     - 'examples/Capfile'
     - 'examples/custom_event.rb'
     - 'lib/dogapi/event.rb'
+    - 'spec/integration/service_level_objective_spec.rb'
 
 # Offense count: 10
 # Cop supports --auto-correct.
@@ -526,11 +537,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,12 @@
 # Changes
 
+## 1.37.0 / 2019-11-04
+
+* [FEATURE] Add Service Level Objectives support. See [#188][], thanks [@platinummonkey][]
+* [IMPROVEMENTS] Don't fail if `hostname` binary is not installed. See [#179][], thanks [@pschipitsch][]
+* [IMPROVEMENTS] Use headers-only for api and app keys for endpoints that support this. See [#189][], thanks [@ssc3][]
+* [IMPROVEMENTS] Make `query` and `options` optional for `update_monitor` calls. See [#192][], thanks [@unclebconnor][]
+
 ## 1.36.0 / 2019-06-05
 
 * [BUGFIX] Pass the options as params to request, not body content. See [#157][], thanks [@wonko][]
@@ -246,6 +253,10 @@ This is the last release compatible with Ruby 1.8. ([EOL 2013-06-30](https://www
 [#172]: https://github.com/DataDog/dogapi-rb/issues/172
 [#173]: https://github.com/DataDog/dogapi-rb/issues/173
 [#174]: https://github.com/DataDog/dogapi-rb/issues/174
+[#179]: https://github.com/DataDog/dogapi-rb/issues/179
+[#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
 [@ArjenSchwarz]: https://github.com/ArjenSchwarz
 [@Kaixiang]: https://github.com/Kaixiang
 [@TaylURRE]: https://github.com/TaylURRE
@@ -265,8 +276,12 @@ This is the last release compatible with Ruby 1.8. ([EOL 2013-06-30](https://www
 [@miknight]: https://github.com/miknight
 [@nots]: https://github.com/nots
 [@orien]: https://github.com/orien
+[@platinummonkey]: https://github.com/platinummonkey
+[@pschipitsch]: https://github.com/pschipitsch
 [@rmoriz]: https://github.com/rmoriz
+[@ssc3]: https://github.com/ssc3
 [@treeder]: https://github.com/treeder
+[@unclebconnor]: https://github.com/unclebconnor
 [@winebarrel]: https://github.com/winebarrel
 [@wonko]: https://github.com/wonko
 [@yyuu]: https://github.com/yyuu

data/README.rdoc

@@ -1,8 +1,7 @@
 = Ruby Client for Datadog API
 
-{<img src="https://badge.fury.io/rb/dogapi.png" alt="Gem Version" />}[http://badge.fury.io/rb/dogapi]
-
-{<img src="https://travis-ci.org/DataDog/dogapi-rb.png?branch=master" alt="Build Status" />}[https://travis-ci.org/DataDog/dogapi-rb]
+{<img src="https://badge.fury.io/rb/dogapi.svg" alt="Gem Version" />}[http://badge.fury.io/rb/dogapi]
+{<img src="https://dev.azure.com/datadoghq/dogapi-rb/_apis/build/status/DataDog.dogapi-rb?branchName=master" alt="Build Status" />}[https://dev.azure.com/datadoghq/dogapi-rb/_build/latest?definitionId=16&branchName=master]
 
 The Ruby client is a library suitable for inclusion in existing Ruby projects or for development of standalone scripts. It provides an abstraction on top of Datadog's raw HTTP interface for reporting events and metrics.
 
@@ -166,6 +165,3 @@ data point you will need to pass a list of +Time+, +float+ pairs, instead of a s
     query = 'sum:metric.count{*}.as_count()'
 
     dog.get_points(query, from, to)
-
-
-

data/lib/capistrano/datadog.rb

@@ -90,7 +90,7 @@ module Capistrano
       end
 
       def report()
-        hostname = %x[hostname -f].strip
+        hostname = Dogapi.find_localhost
         user = Etc.getlogin
 
         # Lazy randomness

data/lib/dogapi/common.rb

@@ -2,9 +2,11 @@ require 'cgi'
 require 'net/https'
 require 'socket'
 require 'uri'
+require 'English'
 
 require 'rubygems'
 require 'multi_json'
+require 'set'
 
 module Dogapi
 
@@ -68,6 +70,7 @@ module Dogapi
 
   # Superclass that deals with the details of communicating with the DataDog API
   class APIService
+    attr_reader :api_key, :application_key
     def initialize(api_key, application_key, silent=true, timeout=nil, endpoint=nil)
       @api_key = api_key
       @application_key = application_key
@@ -115,8 +118,10 @@ module Dogapi
       resp = nil
       connect do |conn|
         begin
-          current_url = url + prepare_params(extra_params, with_app_key)
+          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'
@@ -131,15 +136,31 @@ module Dogapi
       end
     end
 
-    def prepare_params(extra_params, with_app_key)
-      params = { api_key: @api_key }
-      params[:application_key] = @application_key if with_app_key
+    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']
+
+      include_in_params = set_of_urls.include?(url)
+
+      if include_in_params
+        params = { api_key: @api_key }
+        params[:application_key] = @application_key if with_app_key
+      else
+        params = {}
+      end
+      return params
+    end
+
     def handle_response(resp)
       if resp.code == 204 || resp.body == '' || resp.body == 'null' || resp.body.nil?
         return resp.code, {}
@@ -163,11 +184,9 @@ module Dogapi
   @@hostname = nil
 
   def Dogapi.find_localhost
-    begin
-      # prefer hostname -f over Socket.gethostname
-      @@hostname ||= %x[hostname -f].strip
-    rescue
-      raise 'Cannot determine local hostname via hostname -f'
-    end
+    @@hostname ||= %x[hostname -f].strip
+  rescue SystemCallError
+    raise $ERROR_INFO unless $ERROR_INFO.class.name == 'Errno::ENOENT'
+    @@hostname = Addrinfo.getaddrinfo(Socket.gethostname, nil, nil, nil, nil, Socket::AI_CANONNAME).first.canonname
   end
 end

data/lib/dogapi/facade.rb

@@ -95,6 +95,8 @@ module Dogapi
       @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)
       @usage_svc = Dogapi::V1::UsageService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @service_level_objective_svc = Dogapi::V1::ServiceLevelObjectiveService.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)
@@ -616,6 +618,58 @@ module Dogapi
       @monitor_svc.unmute_host(hostname)
     end
 
+    #
+    # SERVICE LEVEL OBJECTIVES
+    #
+
+    def create_service_level_objective(type: , name: , description: nil, tags: nil, thresholds: nil, numerator: nil,
+                                       denominator: nil, monitor_ids: nil, monitor_search: nil, groups: nil)
+      @service_level_objective_svc.create_service_level_objective(type: type, name: name, description: description,
+                                                                  tags: tags, thresholds: thresholds,
+                                                                  numerator: numerator, denominator: denominator,
+                                                                  monitor_ids: monitor_ids,
+                                                                  monitor_search: monitor_search, groups: groups)
+    end
+
+    def update_service_level_objective(slo_id: , type: , name: nil, description: nil, tags: nil, thresholds: nil,
+                                       numerator: nil, denominator: nil, monitor_ids: nil, monitor_search: nil,
+                                       groups: nil)
+      @service_level_objective_svc.update_service_level_objective(slo_id: slo_id, type: type, name: name,
+                                                                  description: description, tags: tags,
+                                                                  thresholds: thresholds, numerator: numerator,
+                                                                  denominator: denominator, monitor_ids: monitor_ids,
+                                                                  monitor_search: monitor_search, groups: groups)
+    end
+
+    def get_service_level_objective(slo_id)
+      @service_level_objective_svc.get_service_level_objective(slo_id)
+    end
+
+    def get_service_level_objective_history(slo_id, from_ts, to_ts)
+      @service_level_objective_svc.get_service_level_objective_history(slo_id, from_ts, to_ts)
+    end
+
+    def search_service_level_objective(slo_ids: nil, query: nil, offset: nil, limit: nil)
+      @service_level_objective_svc.search_service_level_objective(slo_ids: slo_ids, query: query, offset: offset,
+                                                                  limit: limit)
+    end
+
+    def can_delete_service_level_objective(slo_ids)
+      @service_level_objective_svc.can_delete_service_level_objective(slo_ids)
+    end
+
+    def delete_service_level_objective(slo_id)
+      @service_level_objective_svc.delete_service_level_objective(slo_id)
+    end
+
+    def delete_many_service_level_objective(slo_ids)
+      @service_level_objective_svc.delete_many_service_level_objective(slo_ids)
+    end
+
+    def delete_timeframes_service_level_objective(ops)
+      @service_level_objective_svc.delete_timeframes_service_level_objective(ops)
+    end
+
     #
     # SERVICE CHECKS
     #

data/lib/dogapi/v1.rb

@@ -11,6 +11,7 @@ require 'dogapi/v1/monitor'
 require 'dogapi/v1/screenboard'
 require 'dogapi/v1/search'
 require 'dogapi/v1/service_check'
+require 'dogapi/v1/service_level_objective'
 require 'dogapi/v1/snapshot'
 require 'dogapi/v1/tag'
 require 'dogapi/v1/user'

data/lib/dogapi/v1/monitor.rb

@@ -16,10 +16,15 @@ module Dogapi
         request(Net::HTTP::Post, "/api/#{API_VERSION}/monitor", nil, body, true)
       end
 
-      def update_monitor(monitor_id, query, options)
-        body = {
-          'query' => query,
-        }.merge options
+      def update_monitor(monitor_id, query = nil, options = {})
+        body = {}.merge options
+        unless query.nil?
+          body = {
+            'query' => query
+          }.merge body
+          warn '[DEPRECATION] query param is not required anymore and should be set to nil.'\
+             ' To update the query, set it in the options parameter instead'
+        end
 
         request(Net::HTTP::Put, "/api/#{API_VERSION}/monitor/#{monitor_id}", nil, body, true)
       end

data/lib/dogapi/v1/service_level_objective.rb

@@ -0,0 +1,117 @@
+require 'dogapi'
+
+module Dogapi
+  class V1 # for namespacing
+
+    # Implements Service Level Objectives endpoints
+    class ServiceLevelObjectiveService < Dogapi::APIService
+
+      API_VERSION = 'v1'
+
+      def create_service_level_objective(type: , name: , description: nil, tags: nil, thresholds: nil,
+                                         numerator: nil, denominator: nil, monitor_ids: nil, monitor_search: nil,
+                                         groups: nil)
+        body = {
+          type: type,
+          name: name,
+          thresholds: thresholds
+        }
+        if type == 'metric'
+          body[:query] = {
+            numerator: numerator,
+            denominator: denominator
+          }
+        else
+          body[:monitor_search] = monitor_search unless monitor_search.nil?
+          body[:monitor_ids] = monitor_ids unless monitor_ids.nil?
+          body[:groups] = groups unless groups.nil?
+        end
+        body[:tags] = tags unless tags.nil?
+        body[:description] = description unless description.nil?
+
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/slo", nil, body, true)
+      end
+
+      def update_service_level_objective(slo_id: , type: , name: nil, description: nil, tags: nil,
+                                         thresholds: nil, numerator: nil, denominator: nil, monitor_ids: nil,
+                                         monitor_search: nil, groups: nil)
+        body = {
+          type: type
+        }
+
+        body[:name] = name unless name.nil?
+
+        body[:thresholds] = thresholds unless thresholds.nil?
+
+        if type == 'metric'
+          if !numerator.nil? && !denominator.nil?
+            body[:query] = {
+              numerator: numerator,
+              denominator: denominator
+            }
+          end
+        else
+          body[:monitor_search] = monitor_search unless monitor_search.nil?
+          body[:monitor_ids] = monitor_ids unless monitor_ids.nil?
+          body[:groups] = groups unless groups.nil?
+        end
+        body[:tags] = tags unless tags.nil?
+        body[:description] = description unless description.nil?
+
+        request(Net::HTTP::Put, "/api/#{API_VERSION}/slo/#{slo_id}", nil, body, true)
+      end
+
+      def get_service_level_objective(slo_id)
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/slo/#{slo_id}", nil, nil, false)
+      end
+
+      def search_service_level_objective(slo_ids: nil, query: nil, offset: nil, limit: nil)
+        params = {}
+        params[:offset] = offset unless offset.nil?
+        params[:limit] = limit unless limit.nil?
+        if !slo_ids.nil?
+          params[:ids] = slo_ids.join(',')
+        else
+          params[:query] = query
+        end
+
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/slo/", params, nil, false)
+      end
+
+      def delete_service_level_objective(slo_id)
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/slo/#{slo_id}", nil, nil, false)
+      end
+
+      def delete_many_service_level_objective(slo_ids)
+        body = {
+          ids: slo_ids
+        }
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/slo/", nil, body, true)
+      end
+
+      def delete_timeframes_service_level_objective(ops)
+        # ops is a hash of slo_id: [<timeframe>] to delete
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/slo/bulk_delete", nil, ops, true)
+      end
+
+      def get_service_level_objective_history(slo_id, from_ts, to_ts)
+        params = {
+            from_ts: from_ts,
+            to_ts: to_ts
+        }
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/slo/#{slo_id}/history", params, nil, false)
+      end
+
+      def can_delete_service_level_objective(slo_ids)
+        params = {}
+        if slo_ids.is_a?Array
+          params[:ids] = slo_ids.join(',')
+        else
+          params[:ids] = slo_ids
+        end
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/slo/can_delete", params, nil, false)
+      end
+
+    end
+  end
+end

data/lib/dogapi/version.rb

@@ -1,3 +1,3 @@
 module Dogapi
-  VERSION = '1.36.0'
+  VERSION = '1.37.0'
 end

data/spec/integration/comment_spec.rb

@@ -18,9 +18,7 @@ describe Dogapi::Client do
       stub_request(:put, /#{url}/).to_return(body: '{}').then.to_raise(StandardError)
       expect(dog.send(:update_comment, COMMENT_ID, options)).to eq ['200', {}]
 
-      expect(WebMock).to have_requested(:put, url).with(
-        query: default_query
-      )
+      expect(WebMock).to have_requested(:put, url)
     end
   end
 

data/spec/integration/common_spec.rb

@@ -12,9 +12,7 @@ describe Dogapi::APIService do
           stub_request(:get, /#{url}/).to_return(body: '{}').then.to_raise(StandardError)
           expect(service.request(Net::HTTP::Get, '/api/v1/awesome', nil, nil, true, true)).to eq(['200', {}])
 
-          expect(WebMock).to have_requested(:get, url).with(
-            query: default_query
-          )
+          expect(WebMock).to have_requested(:get, url)
         end
       end
       context 'and it is down' do
@@ -22,9 +20,7 @@ describe Dogapi::APIService do
           stub_request(:get, /#{url}/).to_timeout
           expect(service.request(Net::HTTP::Get, '/api/v1/awesome', nil, nil, true, true)).to eq([-1, {}])
 
-          expect(WebMock).to have_requested(:get, url).with(
-            query: default_query
-          )
+          expect(WebMock).to have_requested(:get, url)
         end
       end
     end

data/spec/integration/service_level_objective_spec.rb

@@ -0,0 +1,71 @@
+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 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},
+                    :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},
+                    :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' => 1000000
+  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 named args making params',
+                    :search_service_level_objective, {slo_ids: [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/spec_helper.rb

@@ -37,12 +37,27 @@ module SpecDog
       body = MultiJson.dump(body) if body
 
       expect(WebMock).to have_requested(request, /#{url}|#{old_url}/).with(
-        query: default_query,
         body: body
       )
     end
   end
 
+  shared_examples 'an api method with named args' do |command, args, request, endpoint, body|
+    it 'queries the api' do
+      url = api_url + endpoint
+      old_url = old_api_url + endpoint
+      stub_request(request, /#{url}|#{old_url}/).to_return(body: '{}').then.to_raise(StandardError)
+      expect(dog.send(command, **args)).to eq ['200', {}]
+
+      body = MultiJson.dump(body) if body
+
+      expect(WebMock).to have_requested(request, /#{url}|#{old_url}/).with(
+          # ignore query: default_query -- here as in the test it's never properly included
+          body: body
+      )
+    end
+  end
+
   shared_examples 'an api method with options' do |command, args, request, endpoint, body|
     include_examples 'an api method', command, args, request, endpoint, body
     it 'queries the api with options' do
@@ -55,7 +70,6 @@ module SpecDog
       body = MultiJson.dump(body ? (body.merge options) : options)
 
       expect(WebMock).to have_requested(request, /#{url}|#{old_url}/).with(
-        query: default_query,
         body: body
       )
     end
@@ -67,7 +81,7 @@ module SpecDog
       stub_request(request, /#{url}/).to_return(body: '{}').then.to_raise(StandardError)
       expect(dog.send(command, *args, *params.values)).to eq ['200', {}]
       params.each { |k, v| params[k] = v.join(',') if v.is_a? Array }
-      params = params.merge default_query
+      params = params
 
       expect(WebMock).to have_requested(request, url).with(
         query: params
@@ -75,6 +89,20 @@ module SpecDog
     end
   end
 
+  shared_examples 'an api method with named args making params' do |command, args, request, endpoint, params|
+    it 'queries the api with params' 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 }
+      # hack/note: do not merge with default_query for this test case
+
+      expect(WebMock).to have_requested(request, url).with(
+          query: params
+      )
+    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
@@ -83,7 +111,7 @@ module SpecDog
       expect(dog.send(command, *args, opt_params)).to eq ['200', {}]
 
       opt_params.each { |k, v| opt_params[k] = v.join(',') if v.is_a? Array }
-      params = opt_params.merge default_query
+      params = opt_params
 
       expect(WebMock).to have_requested(request, url).with(
         query: params
@@ -101,7 +129,6 @@ module SpecDog
       body = MultiJson.dump(body) if body
 
       expect(WebMock).to have_requested(request, url).with(
-        query: default_query,
         body: body
       )
     end
@@ -117,7 +144,6 @@ module SpecDog
       body = MultiJson.dump(body ? (body.merge options) : options)
 
       expect(WebMock).to have_requested(request, url).with(
-        query: default_query,
         body: body
       )
     end
@@ -129,7 +155,7 @@ module SpecDog
       stub_request(request, /#{url}/).to_return(body: '{}').then.to_raise(StandardError)
       expect(dog2.send(command, *args, *params.values)).to eq ['200', {}]
       params.each { |k, v| params[k] = v.join(',') if v.is_a? Array }
-      params = params.merge default_query
+      params = params
 
       expect(WebMock).to have_requested(request, url).with(
         query: params
@@ -144,7 +170,7 @@ module SpecDog
       stub_request(request, /#{url}/).to_return(body: '{}').then.to_raise(StandardError)
       expect(dog2.send(command, *args, opt_params)).to eq ['200', {}]
       opt_params.each { |k, v| opt_params[k] = v.join(',') if v.is_a? Array }
-      params = opt_params.merge default_query
+      params = opt_params
 
       expect(WebMock).to have_requested(request, url).with(
         query: params

data/spec/unit/common_spec.rb

@@ -48,6 +48,44 @@ describe 'Common' do
         expect(conn.port).to eq 443
       end
     end
+
+    it 'respects http headers' do
+      service = Dogapi::APIService.new('api_key', 'app_key', true, nil, 'https://app.example.com')
+
+      expect(service.api_key).to eq 'api_key'
+      expect(service.application_key).to eq 'app_key'
+    end
+
+    it 'sets api and app keys in params' do
+      service = Dogapi::APIService.new('api_key', 'app_key', true, nil, 'https://app.example.com')
+
+      urls = ['/api/v1/series',
+              '/api/v1/check_run',
+              '/api/v1/events',
+              '/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
+      end
+    end
+
+    it 'does not set api and app keys in params' do
+      service = Dogapi::APIService.new('api_key', 'app_key', true, nil, 'https://app.example.com')
+
+      urls = ['/api/v2/series',
+              '/api/v1/random_endpoint',
+              '/api/v1/dashboards',
+              '/api/v2/users']
+
+      urls.each do |url|
+        params = service.set_api_and_app_keys_in_params(url, true)
+        expect(params).to eq({})
+      end
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogapi
 version: !ruby/object:Gem::Version
-  version: 1.36.0
+  version: 1.37.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-05 00:00:00.000000000 Z
+date: 2019-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -74,12 +74,12 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
+- ".azure-pipelines/all.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".tailor"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -114,6 +114,7 @@ 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/tag.rb
 - lib/dogapi/v1/usage.rb
@@ -136,6 +137,7 @@ 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/tag_spec.rb
 - spec/integration/usage_spec.rb
@@ -174,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Datadog's API
@@ -194,6 +196,7 @@ 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/tag_spec.rb
 - spec/integration/usage_spec.rb

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-rvm:
-- 2.0
-- 2.1
-- 2.2
-- 2.3
-- 2.4
-- 2.5
-script: bundle exec rake $TASK
-env:
-  - TASK=spec
-matrix:
-  include:
-    env: TASK=rubocop
-    rvm: 2.5