dogapi 1.22.0 → 1.23.0

data/lib/dogapi/facade.rb

@@ -10,8 +10,7 @@ module Dogapi
   # Class methods return a tuple of (+response_code+, +response_body+). Unless otherwise noted, the response body is deserialized JSON. Up-to-date information about the JSON object structure is available in the HTTP API documentation, here[https://github.com/DataDog/dogapi/wiki].
   class Client
 
-    # Create a new Client optionally specifying a default host and device
-    def initialize(api_key, application_key=nil, host=nil, device=nil, silent=true, timeout=nil)
+    def initialize(api_key, application_key=nil, host=nil, device=nil, silent=true, timeout=nil, endpoint=nil)
 
       if api_key
         @api_key = api_key
@@ -20,27 +19,24 @@ module Dogapi
       end
 
       @application_key = application_key
-
-      @datadog_host = Dogapi.find_datadog_host()
-
-      @host = host ||= Dogapi.find_localhost()
-
+      @datadog_host = endpoint || Dogapi.find_datadog_host()
+      @host = host || Dogapi.find_localhost()
       @device = device
 
       # FIXME: refactor to avoid all this code duplication
-      @metric_svc = Dogapi::V1::MetricService.new(@api_key, @application_key, silent, timeout)
-      @event_svc = Dogapi::V1::EventService.new(@api_key, @application_key, silent, timeout)
-      @tag_svc = Dogapi::V1::TagService.new(@api_key, @application_key, silent, timeout)
-      @comment_svc = Dogapi::V1::CommentService.new(@api_key, @application_key, silent, timeout)
-      @search_svc = Dogapi::V1::SearchService.new(@api_key, @application_key, silent, timeout)
-      @dash_service = Dogapi::V1::DashService.new(@api_key, @application_key, silent, timeout)
-      @alert_svc = Dogapi::V1::AlertService.new(@api_key, @application_key, silent, timeout)
-      @user_svc = Dogapi::V1::UserService.new(@api_key, @application_key, silent, timeout)
-      @snapshot_svc = Dogapi::V1::SnapshotService.new(@api_key, @application_key, silent, timeout)
-      @embed_svc = Dogapi::V1::EmbedService.new(@api_key, @application_key, silent, timeout)
-      @screenboard_svc = Dogapi::V1::ScreenboardService.new(@api_key, @application_key, silent, timeout)
-      @monitor_svc = Dogapi::V1::MonitorService.new(@api_key, @application_key, silent, timeout)
-      @service_check_svc = Dogapi::V1::ServiceCheckService.new(@api_key, @application_key, silent, timeout)
+      @metric_svc = Dogapi::V1::MetricService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @event_svc = Dogapi::V1::EventService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @tag_svc = Dogapi::V1::TagService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @comment_svc = Dogapi::V1::CommentService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @search_svc = Dogapi::V1::SearchService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @dash_service = Dogapi::V1::DashService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @alert_svc = Dogapi::V1::AlertService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @user_svc = Dogapi::V1::UserService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @snapshot_svc = Dogapi::V1::SnapshotService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @embed_svc = Dogapi::V1::EmbedService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @screenboard_svc = Dogapi::V1::ScreenboardService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @monitor_svc = Dogapi::V1::MonitorService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @service_check_svc = Dogapi::V1::ServiceCheckService.new(@api_key, @application_key, silent, timeout, @datadog_host)
       @legacy_event_svc = Dogapi::EventService.new(@datadog_host)
     end
 
@@ -57,7 +53,7 @@ module Dogapi
     #
     # options[:type] = "counter" to specify a counter metric
     # options[:tags] = ["tag1", "tag2"] to tag the point
-    def emit_point(metric, value, options = {})
+    def emit_point(metric, value, options= {})
       defaults = { :timestamp => Time.now }
       options = defaults.merge(options)
 
@@ -79,11 +75,11 @@ module Dogapi
     #
     # options[:type] = "counter" to specify a counter metric
     # options[:tags] = ["tag1", "tag2"] to tag the point
-    def emit_points(metric, points, options = {})
+    def emit_points(metric, points, options= {})
       scope = override_scope options
 
       points.each do |p|
-        p[0].kind_of? Time or raise "Not a Time"
+        p[0].kind_of? Time or raise 'Not a Time'
         p[0] = p[0].to_i
         p[1] = p[1].to_f # TODO: stupid to_f will never raise an exception
       end
@@ -119,7 +115,7 @@ module Dogapi
     # Optional arguments:
     #  :host        => String
     #  :device      => String
-    def emit_event(event, options = {})
+    def emit_event(event, options= {})
       scope = override_scope options
 
       @event_svc.post(event, scope)
@@ -132,6 +128,13 @@ module Dogapi
       @event_svc.get(id)
     end
 
+    # Delete an event
+    #
+    # +id+ of the event to delete
+    def delete_event(id)
+      @event_svc.delete(id)
+    end
+
     # Get an optionally filtered event stream
     #
     # +start+ is a Time object for when to start the stream
@@ -142,14 +145,14 @@ module Dogapi
     #   :priority   => "normal" or "low"
     #   :sources    => String, see https://github.com/DataDog/dogapi/wiki/Event for a current list of sources
     #   :tags       => Array of Strings
-    def stream(start, stop, options = {})
+    def stream(start, stop, options= {})
       @event_svc.stream(start, stop, options)
     end
 
     # <b>DEPRECATED:</b> Recording events with a duration has been deprecated.
     # The functionality will be removed in a later release.
-    def start_event(event, options = {})
-      warn "[DEPRECATION] Dogapi::Client.start_event() is deprecated. Use `emit_event` instead."
+    def start_event(event, options= {})
+      warn '[DEPRECATION] Dogapi::Client.start_event() is deprecated. Use `emit_event` instead.'
       defaults = { :source_type => nil }
       options = defaults.merge(options)
 
@@ -165,12 +168,12 @@ module Dogapi
     #
 
     # Post a comment
-    def comment(message, options = {})
+    def comment(message, options= {})
       @comment_svc.comment(message, options)
     end
 
     # Post a comment
-    def update_comment(comment_id, options = {})
+    def update_comment(comment_id, options= {})
       @comment_svc.update_comment(comment_id, options)
     end
 
@@ -193,14 +196,14 @@ module Dogapi
     #
 
     # Get all tags and their associated hosts at your org
-    def all_tags(source = nil)
+    def all_tags(source=nil)
       @tag_svc.get_all(source)
     end
 
     # Get all tags for the given host
     #
     # +host_id+ can be the host's numeric id or string name
-    def host_tags(host_id, source = nil, by_source = false)
+    def host_tags(host_id, source=nil, by_source=false)
       @tag_svc.get(host_id, source, by_source)
     end
 
@@ -209,7 +212,7 @@ module Dogapi
     # +host_id+ can be the host's numeric id or string name
     #
     # +tags+ is and Array of Strings
-    def add_tags(host_id, tags, source = nil)
+    def add_tags(host_id, tags, source=nil)
       @tag_svc.add(host_id, tags, source)
     end
 
@@ -218,20 +221,20 @@ module Dogapi
     # +host_id+ can be the host's numeric id or string name
     #
     # +tags+ is and Array of Strings
-    def update_tags(host_id, tags, source = nil)
+    def update_tags(host_id, tags, source=nil)
       @tag_svc.update(host_id, tags, source)
     end
 
     # <b>DEPRECATED:</b> Spelling mistake temporarily preserved as an alias.
     def detatch_tags(host_id)
-      warn "[DEPRECATION] Dogapi::Client.detatch() is deprecated. Use `detach` instead."
+      warn '[DEPRECATION] Dogapi::Client.detatch() is deprecated. Use `detach` instead.'
       detach_tags(host_id)
     end
 
     # Remove all tags from the given host
     #
     # +host_id+ can be the host's numeric id or string name
-    def detach_tags(host_id, source = nil)
+    def detach_tags(host_id, source=nil)
       @tag_svc.detach(host_id, source)
     end
 
@@ -240,12 +243,12 @@ module Dogapi
     #
 
     # Create a dashboard.
-    def create_dashboard(title, description, graphs, template_variables = nil)
+    def create_dashboard(title, description, graphs, template_variables=nil)
       @dash_service.create_dashboard(title, description, graphs, template_variables)
     end
 
     # Update a dashboard.
-    def update_dashboard(dash_id, title, description, graphs, template_variables = nil)
+    def update_dashboard(dash_id, title, description, graphs, template_variables=nil)
       @dash_service.update_dashboard(dash_id, title, description, graphs, template_variables)
     end
 
@@ -268,11 +271,11 @@ module Dogapi
     # ALERTS
     #
 
-    def alert(query, options = {})
+    def alert(query, options= {})
       @alert_svc.alert(query, options)
     end
 
-    def update_alert(alert_id, query, options = {})
+    def update_alert(alert_id, query, options= {})
       @alert_svc.update_alert(alert_id, query, options)
     end
 
@@ -297,11 +300,11 @@ module Dogapi
     end
 
     # User invite
-    def invite(emails, options = {})
+    def invite(emails, options= {})
       @user_svc.invite(emails, options)
     end
 
-    def create_user(description = {})
+    def create_user(description= {})
       @user_svc.create_user(description)
     end
 
@@ -313,7 +316,7 @@ module Dogapi
       @user_svc.get_user(handle)
     end
 
-    def update_user(handle, description = {})
+    def update_user(handle, description= {})
       @user_svc.update_user(handle, description)
     end
 
@@ -322,7 +325,7 @@ module Dogapi
     end
 
     # Graph snapshot
-    def graph_snapshot(metric_query, start_ts, end_ts, event_query = nil)
+    def graph_snapshot(metric_query, start_ts, end_ts, event_query=nil)
       @snapshot_svc.snapshot(metric_query, start_ts, end_ts, event_query)
     end
 
@@ -384,15 +387,15 @@ module Dogapi
     # MONITORS
     #
 
-    def monitor(type, query, options = {})
+    def monitor(type, query, options= {})
       @monitor_svc.monitor(type, query, options)
     end
 
-    def update_monitor(monitor_id, query, options = {})
+    def update_monitor(monitor_id, query, options= {})
       @monitor_svc.update_monitor(monitor_id, query, options)
     end
 
-    def get_monitor(monitor_id, options = {})
+    def get_monitor(monitor_id, options= {})
       @monitor_svc.get_monitor(monitor_id, options)
     end
 
@@ -400,7 +403,7 @@ module Dogapi
       @monitor_svc.delete_monitor(monitor_id)
     end
 
-    def get_all_monitors(options = {})
+    def get_all_monitors(options= {})
       @monitor_svc.get_all_monitors(options)
     end
 
@@ -412,11 +415,11 @@ module Dogapi
       @monitor_svc.unmute_monitors()
     end
 
-    def mute_monitor(monitor_id, options = {})
+    def mute_monitor(monitor_id, options= {})
       @monitor_svc.mute_monitor(monitor_id, options)
     end
 
-    def unmute_monitor(monitor_id, options = {})
+    def unmute_monitor(monitor_id, options= {})
       @monitor_svc.unmute_monitor(monitor_id, options)
     end
 
@@ -424,11 +427,11 @@ module Dogapi
     # MONITOR DOWNTIME
     #
 
-    def schedule_downtime(scope, options = {})
+    def schedule_downtime(scope, options= {})
       @monitor_svc.schedule_downtime(scope, options)
     end
 
-    def update_downtime(downtime_id, options = {})
+    def update_downtime(downtime_id, options= {})
       @monitor_svc.update_downtime(downtime_id, options)
     end
 
@@ -440,7 +443,7 @@ module Dogapi
       @monitor_svc.cancel_downtime(downtime_id)
     end
 
-    def get_all_downtimes(options = {})
+    def get_all_downtimes(options= {})
       @monitor_svc.get_all_downtimes(options)
     end
 
@@ -448,7 +451,7 @@ module Dogapi
     # HOST MUTING
     #
 
-    def mute_host(hostname, options = {})
+    def mute_host(hostname, options= {})
       @monitor_svc.mute_host(hostname, options)
     end
 
@@ -460,7 +463,7 @@ module Dogapi
     # SERVICE CHECKS
     #
 
-    def service_check(check, host, status, options = {})
+    def service_check(check, host, status, options= {})
       @service_check_svc.service_check(check, host, status, options)
     end
 

data/lib/dogapi/metric.rb

@@ -9,12 +9,12 @@ module Dogapi
   # removed in an upcoming release.
   class MetricService < Dogapi::Service
 
-    API_VERSION = "1.0.0"
+    API_VERSION = '1.0.0'
 
     # <b>DEPRECATED:</b> Going forward, use the V1 services. This legacy service will be
     # removed in an upcoming release.
     def submit(api_key, scope, metric, points)
-      warn "[DEPRECATION] Dogapi::MetricService.submit() has been deprecated in favor of the newer V1 services"
+      warn '[DEPRECATION] Dogapi::MetricService.submit() has been deprecated in favor of the newer V1 services'
       series = [{
         :host    =>  scope.host,
         :device  =>  scope.device,

data/lib/dogapi/v1/alert.rb

@@ -5,105 +5,42 @@ module Dogapi
 
     class AlertService < Dogapi::APIService
 
-      API_VERSION = "v1"
+      API_VERSION = 'v1'
 
       def alert(query, options = {})
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
+        body = {
+          'query' => query,
+        }.merge options
 
-          body = {
-            'query' => query,
-          }.merge options
-
-          request(Net::HTTP::Post, "/api/#{API_VERSION}/alert", params, body, true)
-        rescue Exception => e
-          suppress_error_if_silent e
-        end
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/alert", nil, body, true)
       end
 
       def update_alert(alert_id, query, options)
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-
-          body = {
-            'query' => query,
-          }.merge options
+        body = {
+          'query' => query,
+        }.merge options
 
-          request(Net::HTTP::Put, "/api/#{API_VERSION}/alert/#{alert_id}", params, body, true)
-        rescue Exception => e
-          suppress_error_if_silent e
-        end
+        request(Net::HTTP::Put, "/api/#{API_VERSION}/alert/#{alert_id}", nil, body, true)
       end
 
       def get_alert(alert_id)
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-
-          request(Net::HTTP::Get, "/api/#{API_VERSION}/alert/#{alert_id}", params, nil, false)
-        rescue Exception => e
-          suppress_error_if_silent e
-        end
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/alert/#{alert_id}", nil, nil, false)
       end
 
       def delete_alert(alert_id)
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-
-          request(Net::HTTP::Delete, "/api/#{API_VERSION}/alert/#{alert_id}", params, nil, false)
-        rescue Exception => e
-          suppress_error_if_silent e
-        end
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/alert/#{alert_id}", nil, nil, false)
       end
 
-      def get_all_alerts()
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-
-          request(Net::HTTP::Get, "/api/#{API_VERSION}/alert", params, nil, false)
-        rescue Exception => e
-          suppress_error_if_silent e
-        end
+      def get_all_alerts
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/alert", nil, nil, false)
       end
 
-      def mute_alerts()
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-
-          request(Net::HTTP::Post, "/api/#{API_VERSION}/mute_alerts", params, nil, false)
-        rescue Exception => e
-          suppress_error_if_silent e
-        end
+      def mute_alerts
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/mute_alerts", nil, nil, false)
       end
 
-      def unmute_alerts()
-        begin
-          params = {
-            :api_key => @api_key,
-            :application_key => @application_key
-          }
-
-          request(Net::HTTP::Post, "/api/#{API_VERSION}/unmute_alerts", params, nil, false)
-        rescue Exception => e
-          suppress_error_if_silent e
-        end
+      def unmute_alerts
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/unmute_alerts", nil, nil, false)
       end
 
     end