dogapi 1.22.0 → 1.23.0

data/lib/dogapi/v1/snapshot.rb

@@ -5,23 +5,18 @@ module Dogapi
 
     class SnapshotService < Dogapi::APIService
 
-      API_VERSION = "v1"
+      API_VERSION = 'v1'
 
       def snapshot(metric_query, start_ts, end_ts, event_query=nil)
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key,
-            :metric_query => metric_query,
-            :start => start_ts,
-            :end => end_ts,
-            :event_query => event_query
-          }
-
-          request(Net::HTTP::Get, "/api/#{API_VERSION}/graph/snapshot", params, nil, false)
-        rescue Exception => e
-          suppress_error_if_silent e
-        end
+        extra_params = {
+          :metric_query => metric_query,
+          :start => start_ts,
+          :end => end_ts,
+        }
+
+        extra_params[:event_query] = event_query if event_query
+
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/graph/snapshot", extra_params, nil, false)
       end
 
     end

data/lib/dogapi/v1/tag.rb

@@ -3,136 +3,76 @@ require 'dogapi'
 module Dogapi
   class V1 # for namespacing
 
-    # 
+    #
     class TagService < Dogapi::APIService
 
-      API_VERSION = "v1"
+      API_VERSION = 'v1'
 
       # Gets all tags in your org and the hosts tagged with them
       def get_all(source=nil)
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-          if source
-            params['source'] = source
-          end
-
-          request(Net::HTTP::Get, '/api/' + API_VERSION + '/tags/hosts', params, nil, false)
-        rescue Exception => e
-          if @silent
-            warn e
-            return -1, {}
-          else
-            raise e
-          end
+        extra_params = {}
+        if source
+          extra_params['source'] = source
         end
+
+        request(Net::HTTP::Get, '/api/' + API_VERSION + '/tags/hosts', extra_params, nil, false)
       end
 
       # Gets all tags for a given host
       def get(host_id, source=nil, by_source=false)
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-          if source
-            params['source'] = source
-          end
-          if by_source
-            params['by_source'] = 'true'
-          end
-
-          request(Net::HTTP::Get, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, params, nil, false)
-        rescue Exception => e
-          if @silent
-            warn e
-            return -1, {}
-          else
-            raise e
-          end
+        extra_params = {}
+        if source
+          extra_params['source'] = source
+        end
+        if by_source
+          extra_params['by_source'] = 'true'
         end
+
+        request(Net::HTTP::Get, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, extra_params, nil, false)
       end
 
       # Adds a list of tags to a host
       def add(host_id, tags, source=nil)
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-          if source
-            params['source'] = source
-          end
-
-          body = {
-            :tags => tags
-          }
-
-          request(Net::HTTP::Post, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, params, body, true)
-        rescue Exception => e
-          if @silent
-            warn e
-            return -1, {}
-          else
-            raise e
-          end
+        extra_params = {}
+        if source
+          extra_params['source'] = source
         end
+
+        body = {
+          :tags => tags
+        }
+
+        request(Net::HTTP::Post, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, extra_params, body, true)
       end
 
       # Remove all tags from a host and replace them with a new list
       def update(host_id, tags, source=nil)
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-          if source
-            params['source'] = source
-          end
-
-          body = {
-            :tags => tags
-          }
-
-          request(Net::HTTP::Put, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, params, body, true)
-        rescue Exception => e
-          if @silent
-            warn e
-            return -1, {}
-          else
-            raise e
-          end
+        extra_params = {}
+        if source
+          extra_params['source'] = source
         end
+
+        body = {
+          :tags => tags
+        }
+
+        request(Net::HTTP::Put, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, extra_params, body, true)
       end
 
       # <b>DEPRECATED:</b> Spelling mistake temporarily preserved as an alias.
       def detatch(host_id)
-        warn "[DEPRECATION] Dogapi::V1::TagService.detatch() is deprecated. Use `detach` instead."
+        warn '[DEPRECATION] Dogapi::V1::TagService.detatch() is deprecated. Use `detach` instead.'
         detach(host_id)
       end
 
       # Remove all tags from a host
       def detach(host_id, source=nil)
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-          if source
-            params['source'] = source
-          end
-
-          request(Net::HTTP::Delete, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, params, nil, false)
-        rescue Exception => e
-          if @silent
-            warn e
-            return -1, {}
-          else
-            raise e
-          end
+        extra_params = {}
+        if source
+          extra_params['source'] = source
         end
+
+        request(Net::HTTP::Delete, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, extra_params, nil, false)
       end
 
     end

data/lib/dogapi/v1/user.rb

@@ -5,72 +5,36 @@ module Dogapi
 
     class UserService < Dogapi::APIService
 
-      API_VERSION = "v1"
+      API_VERSION = 'v1'
 
       # <b>DEPRECATED:</b> Going forward, we're using a new and more restful API,
       # the new methods are get_user, create_user, update_user, disable_user
-      def invite(emails, options = {})
-        warn "[DEPRECATION] Dogapi::V1::UserService::invite has been deprecated in favor of Dogapi::V1::UserService::create_user"
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
+      def invite(emails, options= {})
+        warn '[DEPRECATION] Dogapi::V1::UserService::invite has been deprecated in favor of Dogapi::V1::UserService::create_user'
+        body = {
+          'emails' => emails,
+        }.merge options
 
-          body = {
-            'emails' => emails,
-          }.merge options
-
-          request(Net::HTTP::Post, "/api/#{API_VERSION}/invite_users", params, body, true)
-        rescue Exception => e
-          suppress_error_if_silent e
-        end
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/invite_users", nil, body, true)
       end
 
       # Create a user
       #
       # :description => Hash: user description containing 'handle' and 'name' properties
-      def create_user(description = {})
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-
-          request(Net::HTTP::Post, "/api/#{API_VERSION}/user", params, description, true)
-        rescue Exception => e
-          suppress_error_if_silent e
-        end
+      def create_user(description= {})
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/user", nil, description, true)
       end
 
       # Retrieve user information
       #
       # :handle => String: user handle
       def get_user(handle)
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-
-          request(Net::HTTP::Get, "/api/#{API_VERSION}/user/#{handle}", params, nil, false)
-        rescue Exception => e
-          suppress_error_if_silent e
-        end
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/user/#{handle}", nil, nil, false)
       end
 
       # Retrieve all users
-      def get_all_users()
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-
-          request(Net::HTTP::Get, "/api/#{API_VERSION}/user", params, nil, false)
-        rescue Exception => e
-          suppress_error_if_silent e
-        end
+      def get_all_users
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/user", nil, nil, false)
       end
 
       # Update a user
@@ -78,33 +42,15 @@ module Dogapi
       # :handle => String: user handle
       # :description => Hash: user description optionally containing 'name', 'email',
       # 'is_admin', 'disabled' properties
-      def update_user(handle, description = {})
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-
-          request(Net::HTTP::Put, "/api/#{API_VERSION}/user/#{handle}", params, description, true)
-        rescue Exception => e
-          suppress_error_if_silent e
-        end
+      def update_user(handle, description= {})
+        request(Net::HTTP::Put, "/api/#{API_VERSION}/user/#{handle}", nil, description, true)
       end
 
       # Disable a user
       #
       # :handle => String: user handle
       def disable_user(handle)
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-
-          request(Net::HTTP::Delete, "/api/#{API_VERSION}/user/#{handle}", params, nil, false)
-        rescue Exception => e
-          suppress_error_if_silent e
-        end
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/user/#{handle}", nil, nil, false)
       end
 
     end

data/lib/dogapi/version.rb

@@ -1,3 +1,3 @@
 module Dogapi
-  VERSION = "1.22.0"
+  VERSION = '1.23.0'
 end

data/spec/integration/alert_spec.rb

@@ -0,0 +1,48 @@
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  ALERT_ID = 42
+  QUERY = 'avg(last_10m):avg:test.metric.metric{host:test.metric.host} > 5'.freeze
+
+  describe '#alert' do
+    it_behaves_like 'an api method with options',
+                    :alert, [QUERY],
+                    :post, '/alert', 'query' => QUERY
+  end
+
+  describe '#update_alert' do
+    it_behaves_like 'an api method with options',
+                    :update_alert, [ALERT_ID, QUERY],
+                    :put, "/alert/#{ALERT_ID}", 'query' => QUERY
+  end
+
+  describe '#get_alert' do
+    it_behaves_like 'an api method',
+                    :get_alert, [ALERT_ID],
+                    :get, "/alert/#{ALERT_ID}"
+  end
+
+  describe '#delete_alert' do
+    it_behaves_like 'an api method',
+                    :delete_alert, [ALERT_ID],
+                    :delete, "/alert/#{ALERT_ID}"
+  end
+
+  describe '#get_all_alerts' do
+    it_behaves_like 'an api method',
+                    :get_all_alerts, [],
+                    :get, '/alert'
+  end
+
+  describe '#mute_alerts' do
+    it_behaves_like 'an api method',
+                    :mute_alerts, [], :post,
+                    '/mute_alerts'
+  end
+
+  describe '#unmute_alerts' do
+    it_behaves_like 'an api method',
+                    :unmute_alerts, [],
+                    :post, '/unmute_alerts'
+  end
+end

data/spec/integration/comment_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  COMMENT_ID = 4242
+  MESSAGE = 'this is an example message: éè'.freeze
+
+  describe '#comment' do
+    it_behaves_like 'an api method with options',
+                    :comment, [MESSAGE],
+                    :post, '/comments', 'message' => MESSAGE
+  end
+
+  describe '#update_comment' do
+    it 'queries the api with options' do
+      url = api_url + "/comments/#{COMMENT_ID}"
+      options = { 'zzz' => 'aaa' }
+      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
+      )
+    end
+  end
+
+  describe '#delete_comment' do
+    it_behaves_like 'an api method',
+                    :delete_comment, [COMMENT_ID],
+                    :delete, "/comments/#{COMMENT_ID}"
+  end
+end

data/spec/integration/common_spec.rb

@@ -0,0 +1,32 @@
+require_relative '../spec_helper'
+
+describe Dogapi::APIService do
+  describe '#connect' do
+    let(:url) { api_url + '/awesome' }
+    let(:second_url) { 'http://app.example.com/api/v1/awesome' }
+
+    context 'when only the default endpoint is used' do
+      let(:service) { Dogapi::APIService.new api_key, app_key }
+      context 'and it is up' do
+        it 'only queries one endpoint' 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
+          )
+        end
+      end
+      context 'and it is down' do
+        it 'only queries one endpoint' 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
+          )
+        end
+      end
+    end
+  end
+end