dogapi 1.29.0 → 1.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f0f9e8378ef6450f007c59b5e410d59360bb2bd809becc6d4ebcd15060df07d
-  data.tar.gz: 29364635da8174b284769e719a436b7346bb675879fc7425a60ee1d412b0f944
+  metadata.gz: ebee611bd7522efe9456a959522706572585e27cd7a7c702749584318bfc291b
+  data.tar.gz: 8d3fedc656c9443618b164fdcb0a9dd601f88dee81d000fc210f7338aacb3a34
 SHA512:
-  metadata.gz: ee6435510b755900b09b2fd718d31a349b22a8022534cd47569f36be300a40df5513b9b3310a76faa766bbedf098952fcf4fbe39d1ee347faac8e90a9348699f
-  data.tar.gz: d717fa7164731b77a7105f98dda7f5ad41581daa3c0e05389073bf4636f1328e60aeecdee6d1738843b1027a6567c1a5cd72bc8bda3a76c754d72dadd9a14f51
+  metadata.gz: c4be6b9543da77c590ba0e155f2b92bb9c52befa16825d835d81721a3792cc7fd58e4a1a888a46a0856d7f099c124fd49eafa2674133660b3bda2ce0e6ab5bbf
+  data.tar.gz: 32e79e62b507f2c2d514bcd28449f1eb5d1c4856c8a8ebcb6b7a2204299f552b4e83fe0ff0b90be30fd21882ffdebed775a4806015681986d52866b0dd45038e

data/CHANGELOG.md

@@ -1,162 +1,167 @@
-Changes
-=======
+# Changes
 
-# 1.29.0 / 2018-03-23
+## 1.30 / 2018-06-05
+
+* [FIX] Change API endpoint. See [#147][].
+* [FIX] Show more friendly error message with non JSON responses. See [#151][], thanks [@edwardkenfox][].
+* [FEATURE] Add hosts endpoints. See [#152][].
+
+## 1.29.0 / 2018-03-23
 
 * [FEATURE] Add new endpoints for dashboard lists.
 * [IMPROVEMENT] change http-method GET to POST on api.Screenboard#share. See [#136][] (thanks [@haohcraft][])
 
-# 1.28.0 / 2017-08-16
+## 1.28.0 / 2017-08-16
 
 * [FEATURE] Accept `group_states` strings for `get_monitor` function. See [#132][] (thanks [@acroos][])
 * [FEATURE] Add cancel\_by\_scope endpoint. See [#133][] (thanks [@martinisoft][])
 
-# 1.27.0 / 2017-05-01
+## 1.27.0 / 2017-05-01
 
 * [FEATURE] Add monitor validation endpoint. See [#127][]
 
-# 1.26.0 / 2017-04-10
+## 1.26.0 / 2017-04-10
 
 * [IMPROVEMENT] Allow additional options to be passed to monitor API calls. See [#125][] (thanks [@jimmyngo][])
 
-# 1.25.0 / 2017-02-14
+## 1.25.0 / 2017-02-14
 
 * [FEATURE] Add Datadog endpoint for metrics metadata. See [#120][]
 
-# 1.24.0 / 2017-01-12
+## 1.24.0 / 2017-01-12
 
 * [FEATURE] Add the ability to record events per host and to filter events. See [#115][] (thanks [@hnovikov][])
 * [BUGFIX] Encode extra\_params to handle spaces. See [#113][] (thanks [@miknight][])
 * [BUGFIX] Fix CaptureIO delegation and output with Capistrano >= 3.5. See [#114][] (thanks [@casperisfine][])
 
-# 1.23.0 / 2016-08-24
+## 1.23.0 / 2016-08-24
 
 * [FEATURE] Add Datadog endpoint to configuration. See [#108][]
 * [FEATURE] Add delete method for events. See [#99][], [#109][]
 * [IMPROVEMENT] Add Capistrano 3.5+ compatibility. See [#96][]
 * [OTHER] Code style fixes. See [#106][] (thanks [@nots][])
 
-# 1.22.0 / 2016-04-14
+## 1.22.0 / 2016-04-14
 This release breaks compatibility with Ruby 1.8.
 * [FEATURE] Metric query API. See [#88][], [#90][] (thanks [@blakehilscher][])
 
-# 1.21.0 / 2015-10-30
+## 1.21.0 / 2015-10-30
 This is the last release compatible with Ruby 1.8. ([EOL 2013-06-30](https://www.ruby-lang.org/en/news/2013/06/30/we-retire-1-8-7/))
 * [FEATURE] User CRUD API. See [#82][]
 * [IMPROVEMENT] Support capistrano SimpleTextFormatter (thanks [@rmoriz][] [#81][])
 
-# 1.20.0 / 2015-07-29
+## 1.20.0 / 2015-07-29
 * [FEATURE] Embeddable graphs API. See [#73][]
 
-# 1.19.0 / 2015-06-22
+## 1.19.0 / 2015-06-22
 * [FEATURE] Revoke a shared a Screenboard. See [#69][]
 
-# 1.18.0 / 2015-06-01
+## 1.18.0 / 2015-06-01
 * [FEATURE] Add support for host muting.
 
-# 1.17.0 / 2015-03-26
+## 1.17.0 / 2015-03-26
 * [IMPROVEMENT] Use MultiJSON for JSON handling. (thanks [@winebarrel][] [#64][])
 
-# 1.16.0 / 2015-03-06
+## 1.16.0 / 2015-03-06
 * [IMPROVEMENT] Return response from API when metrics are sent as a batch. (thanks [@yyuu][] [#62](https://github.com/DataDog/dogapi-rb/pull/62))
 
-# 1.15.0 / 2015-02-03
+## 1.15.0 / 2015-02-03
 * [BUGFIX] Add open_timeout to avoid stuck HTTP calls (thanks [@Kaixiang][] [#55](https://github.com/DataDog/dogapi-rb/pull/55))
 * [BUGFIX] Encode capistrano output messages to UTF-8 before manipulating them. (thanks [@byroot][] [#52](https://github.com/DataDog/dogapi-rb/pull/52))
 
-# 1.14.0 / 2015-01-09
+## 1.14.0 / 2015-01-09
 * [FEATURE] Add get_all_screenboards [#61](https://github.com/DataDog/dogapi-rb/pull/61)
 * [IMPROVEMENT] Remove required start argument from schedule_downtime [#60](https://github.com/DataDog/dogapi-rb/pull/60)
 
-# 1.13.0 / 2014-12-10
+## 1.13.0 / 2014-12-10
 * [FEATURE] Add tag filter to get_all_monitors [#58](https://github.com/DataDog/dogapi-rb/pull/58)
 * [FEATURE] Add update downtime method [#59](https://github.com/DataDog/dogapi-rb/pull/59)
 
-# 1.12.0 / 2014-11-17
+## 1.12.0 / 2014-11-17
 * [FEATURE] Add support for the Monitor API [#51](https://github.com/DataDog/dogapi-rb/pull/51)
 * [IMPROVEMENT] Truncate event title and text before submission [#53](https://github.com/DataDog/dogapi-rb/pull/53)
 
-# 1.11.0 / 2014-07-03
+## 1.11.0 / 2014-07-03
 * [IMPROVEMENT] Add support for HTTP proxy defined by the environment variables
 * [IMPROVEMENT] Allow to send several metrics in the same HTTP request
 
-# 1.10.0 / 2014-05-13
+## 1.10.0 / 2014-05-13
 * [IMPROVEMENT] Make HTTP timeout configurable ([#29](https://github.com/DataDog/dogapi-rb/issues/29))
 * [IMPROVEMENT] Re-enable SSL verification ([#37](https://github.com/DataDog/dogapi-rb/issues/37))
 * [IMPROVEMENT] Report application name when deploy with Capistrano (thanks [@ArjenSchwarz][] [#46](https://github.com/DataDog/dogapi-rb/pull/46))
 
-# 1.9.2 / 2014-02-13
+## 1.9.2 / 2014-02-13
 * [IMPROVEMENT] Fully support for capistrano v3 ([#43](https://github.com/DataDog/dogapi-rb/pull/43))
 * [IMPROVEMENT] Strip control characters from capistrano messages ([#36](https://github.com/DataDog/dogapi-rb/issues/36))
 * [IMPROVEMENT] Tag capistrano events by stage (thanks [@arielo][] [#25](https://github.com/DataDog/dogapi-rb/pull/25))
 
-# 1.9.1 / 2014-01-06
+## 1.9.1 / 2014-01-06
 * [IMPROVEMENT] Log a warning instead of crashing when trying to integration with capistrano v3
 
-# 1.9.0 / 2013-09-06
+## 1.9.0 / 2013-09-06
 * [IMPROVEMENT] When emitting a metric without an explicit host, default to local hostname.
 
-# 1.8.1 / 2013-08-22
+## 1.8.1 / 2013-08-22
 * [FEATURE] Update Dash API to support template variables.
 
-# 1.8.0 / 2013-07-16
+## 1.8.0 / 2013-07-16
 * [FEATURE] Add an API for interacting with Screenboards
 
-# 1.7.1 / 2013-06-23
+## 1.7.1 / 2013-06-23
 * [BUGFIX] Fix bug in capistrano integration with logging of nil (thanks [@arielo][])
 * [FEATURE] Add an API for inviting users
 * [FEATURE] Add an API for taking graph snapshots
 
-# 1.7.0
+## 1.7.0
 * Not released.
 
-# 1.6.0 / 2013-02-19
+## 1.6.0 / 2013-02-19
 * [FEATURE] Support for setting `source` type when submitting host tags
 
-# 1.5.2 / 2013-02-13
+## 1.5.2 / 2013-02-13
 * [BUGFIX] Fix a bug in hashing the Event object when the instance variables are symbols.
 
-# 1.5.0 / 2012-11-06
+## 1.5.0 / 2012-11-06
 * [FEATURE] Alerting API
 
-# 1.4.3
+## 1.4.3
 * [BUGFIX] Fix bug with capistrano integration for capistrano 2.13.5 (thanks [@ansel1][])
 
-# 1.4.2
+## 1.4.2
 * [BUGFIX] Added missing dashboards endpoint.
 
-# 1.4.1
+## 1.4.1
 * [BUGFIX] Fixed searching for events with tags.
 
-# 1.4.0
+## 1.4.0
 * [FEATURE] Added support for the dashboard, search and comment API endpoints.
 
-# 1.3.6
+## 1.3.6
 * [BUGFIX] Small fix for capistrano integration
 
-# 1.3.4
+## 1.3.4
 * [BUGFIX] Various bug fixes (event.to_hash, md5 import, capistrano lambda roles)
 
-# 1.3.3
+## 1.3.3
 * [BUGFIX] Bug fix for submitting counters
 
-# 1.3.2
+## 1.3.2
 * [IMPROVEMENT] Support an aggregation key to aggregate events together
 
-# 1.3.1
+## 1.3.1
 * [FEATURE] Metrics can be counters, rather than just gauges (thanks to [@treeder][])
 * [FEATURE] Metrics can be tagged.
 
-# 1.3.0
+## 1.3.0
 * [FEATURE] Capistrano integration. See https://github.com/DataDog/dogapi-rb/tree/master/lib/capistrano
 
-# 1.2.x
+## 1.2.x
 * [FEATURE] You can now manage host tags
 * [IMPROVEMENT] Functionality relating to events with a duration has been deprecated
 * [IMPROVEMENT] The underlying clients have been updated to use Datadog's new public HTTP API[https://github.com/DataDog/dogapi/wiki]
 * [IMPROVEMENT] You can now get event details and query the stream in addition to posting events
 
-# 1.1.x
+## 1.1.x
 * [IMPROVEMENT] You do not need to use environment variables anymore to use the client.
 
 <!--- The following link definition list is generated by PimpMyChangelog --->
@@ -196,6 +201,9 @@ This is the last release compatible with Ruby 1.8. ([EOL 2013-06-30](https://www
 [#132]: https://github.com/DataDog/dogapi-rb/issues/132
 [#133]: https://github.com/DataDog/dogapi-rb/issues/133
 [#136]: https://github.com/DataDog/dogapi-rb/issues/136
+[#147]: https://github.com/DataDog/dogapi-rb/issues/147
+[#151]: https://github.com/DataDog/dogapi-rb/issues/151
+[#152]: https://github.com/DataDog/dogapi-rb/issues/152
 [@ArjenSchwarz]: https://github.com/ArjenSchwarz
 [@Kaixiang]: https://github.com/Kaixiang
 [@acroos]: https://github.com/acroos
@@ -204,6 +212,7 @@ This is the last release compatible with Ruby 1.8. ([EOL 2013-06-30](https://www
 [@blakehilscher]: https://github.com/blakehilscher
 [@byroot]: https://github.com/byroot
 [@casperisfine]: https://github.com/casperisfine
+[@edwardkenfox]: https://github.com/edwardkenfox
 [@haohcraft]: https://github.com/haohcraft
 [@hnovikov]: https://github.com/hnovikov
 [@jimmyngo]: https://github.com/jimmyngo

data/lib/dogapi/common.rb

@@ -148,6 +148,8 @@ module Dogapi
       begin
         return resp.code, MultiJson.load(resp.body)
       rescue
+        is_json = resp.content_type == 'application/json'
+        raise "Response Content-Type is not application/json but is #{resp.content_type}: " + resp.body unless is_json
         raise 'Invalid JSON Response: ' + resp.body
       end
     end
@@ -155,7 +157,7 @@ module Dogapi
 
   def Dogapi.find_datadog_host
     # allow env-based overriding, useful for tests
-    ENV['DATADOG_HOST'] || 'https://app.datadoghq.com'
+    ENV['DATADOG_HOST'] || 'https://api.datadoghq.com'
   end
 
   # Memoize the hostname as a module variable

data/lib/dogapi/facade.rb

@@ -45,6 +45,7 @@ module Dogapi
       @service_check_svc = Dogapi::V1::ServiceCheckService.new(@api_key, @application_key, silent, timeout, @datadog_host)
       @metadata_svc = Dogapi::V1::MetadataService.new(@api_key, @application_key, silent, timeout, @datadog_host)
       @legacy_event_svc = Dogapi::EventService.new(@datadog_host)
+      @hosts_svc = Dogapi::V1::HostsService.new(@api_key, @application_key, silent, timeout, @datadog_host)
     end
 
     #
@@ -548,6 +549,18 @@ module Dogapi
       @metadata_svc.update(metric, options)
     end
 
+    #
+    # HOSTS
+    #
+
+    def search_hosts(options = {})
+      @hosts_svc.search(options)
+    end
+
+    def host_totals()
+      @hosts_svc.totals()
+    end
+
     private
 
     def override_scope(options= {})

data/lib/dogapi/v1.rb

@@ -13,3 +13,4 @@ require 'dogapi/v1/service_check'
 require 'dogapi/v1/snapshot'
 require 'dogapi/v1/tag'
 require 'dogapi/v1/user'
+require 'dogapi/v1/hosts'

data/lib/dogapi/v1/hosts.rb

@@ -0,0 +1,21 @@
+require 'dogapi'
+
+module Dogapi
+  class V1 # for namespacing
+
+    # Hosts API
+    class HostsService < Dogapi::APIService
+
+      API_VERSION = 'v1'
+
+      def search(options = {})
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/hosts", nil, options, true)
+      end
+
+      def totals
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/hosts/totals", nil, nil, true)
+      end
+    end
+
+  end
+end

data/lib/dogapi/v1/search.rb

@@ -8,6 +8,13 @@ module Dogapi
       API_VERSION = 'v1'
 
       def search(query)
+        # Deprecating search for hosts
+        split_query = query.split(':')
+        if split_query.length > 1 && split_query[0] == 'hosts'
+          warn '[DEPRECATION] Dogapi::V1::SearchService::search has been '\
+            'deprecated for hosts in favor of Dogapi::V1::HostsService::search'
+        end
+
         extra_params = {
           :q => query
         }

data/lib/dogapi/version.rb

@@ -1,3 +1,3 @@
 module Dogapi
-  VERSION = '1.29.0'
+  VERSION = '1.30'
 end

data/spec/spec_helper.rb

@@ -11,7 +11,7 @@ WebMock.disable_net_connect!(allow_localhost: false)
 # include our code and methods
 require 'dogapi'
 
-DATADOG_HOST = 'app.datadoghq.com'.freeze
+DATADOG_HOST = 'api.datadoghq.com'.freeze
 ENV['DATADOG_HOST'] = 'http://' + DATADOG_HOST
 
 module SpecDog

data/spec/unit/common_spec.rb

@@ -41,11 +41,12 @@ describe 'Common' do
 end
 
 class FakeResponse
-  attr_accessor :code, :body
-  def initialize(code, body)
+  attr_accessor :code, :body, :content_type
+  def initialize(code, body, content_type = 'application/json')
     # Instance variables
     @code = code
     @body = body
+    @content_type = content_type
   end
 end
 
@@ -86,6 +87,14 @@ describe Dogapi::APIService do
         expect { dog.handle_response(resp) }.to raise_error(RuntimeError, "Invalid JSON Response: {'test2': }")
       end
     end
+    context 'when receiving a non json response' do
+      it 'raises an error indicating the response Content-Type' do
+        dog = dogapi_service
+        resp = FakeResponse.new 202, '<html><body><h1>403 Forbidden</h1>', 'text/html'
+        msg = 'Response Content-Type is not application/json but is text/html: <html><body><h1>403 Forbidden</h1>'
+        expect { dog.handle_response(resp) }.to raise_error(RuntimeError, msg)
+      end
+    end
     context 'when receiving a bad response' do
       it 'returns the error code and an empty body' do
         dog = dogapi_service

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogapi
 version: !ruby/object:Gem::Version
-  version: 1.29.0
+  version: '1.30'
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -105,6 +105,7 @@ files:
 - lib/dogapi/v1/dashboard_list.rb
 - lib/dogapi/v1/embed.rb
 - lib/dogapi/v1/event.rb
+- lib/dogapi/v1/hosts.rb
 - lib/dogapi/v1/metadata.rb
 - lib/dogapi/v1/metric.rb
 - lib/dogapi/v1/monitor.rb