dogapi 1.8.1 → 1.9.0

data/lib/dogapi/v1/alert.rb

@@ -7,7 +7,7 @@ module Dogapi
 
       API_VERSION = "v1"
 
-      def alert(query, options={})
+      def alert(query, options = {})
         begin
           params = {
             :api_key => @api_key,

data/lib/dogapi/v1/comment.rb

@@ -8,7 +8,7 @@ module Dogapi
       API_VERSION = "v1"
 
       # Submit a comment.
-      def comment(message, options={})
+      def comment(message, options = {})
         begin
           params = {
             :api_key => @api_key,
@@ -16,7 +16,7 @@ module Dogapi
           }
 
           body = {
-           'message' => message,
+            'message' => message,
           }.merge options
 
           request(Net::HTTP::Post, "/api/#{API_VERSION}/comments", params, body, true)
@@ -26,7 +26,7 @@ module Dogapi
       end
 
       # Update a comment.
-      def update_comment(comment_id, options={})
+      def update_comment(comment_id, options = {})
         begin
           params = {
             :api_key => @api_key,

data/lib/dogapi/v1/dash.rb

@@ -7,7 +7,7 @@ module Dogapi
 
       API_VERSION = "v1"
 
-      def create_dashboard(title, description, graphs, template_variables=nil)
+      def create_dashboard(title, description, graphs, template_variables = nil)
 
         begin
           params = {
@@ -75,7 +75,6 @@ module Dogapi
         end
       end
 
-
       def delete_dashboard(dash_id)
         begin
           params = {

data/lib/dogapi/v1/event.rb

@@ -54,7 +54,7 @@ module Dogapi
         end
       end
 
-      def stream(start, stop, options={})
+      def stream(start, stop, options = {})
         begin
           defaults = {
             :priority => nil,

data/lib/dogapi/v1/metric.rb

@@ -9,7 +9,7 @@ module Dogapi
       API_VERSION = "v1"
 
       # Records an Event with no duration
-      def submit(metric, points, scope, options={})
+      def submit(metric, points, scope, options = {})
         begin
           params = {
             :api_key => @api_key
@@ -20,7 +20,8 @@ module Dogapi
             raise ArgumentError, "metric type must be gauge or counter"
           end
 
-          body = { :series => [
+          body = {
+            :series => [
               {
                 :metric => metric,
                 :points => points,
@@ -31,7 +32,6 @@ module Dogapi
             ]
           }
 
-
           # Add tags if there are any
           if not options[:tags].nil?
             body[:series][0][:tags] = options[:tags]

data/lib/dogapi/v1/user.rb

@@ -7,7 +7,7 @@ module Dogapi
 
       API_VERSION = "v1"
 
-      def invite(emails, options={})
+      def invite(emails, options = {})
         begin
           params = {
             :api_key => @api_key,

data/lib/dogapi/version.rb

@@ -1,3 +1,3 @@
 module Dogapi
-  VERSION = "1.8.1"
+  VERSION = "1.9.0"
 end

data/spec/alerts_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe "Alerts", :vcr => true do
+
+  before(:all) do
+    @api_key = ENV["DATADOG_API_KEY"]
+    @app_key = ENV["DATADOG_APP_KEY"]
+    @dog = Dogapi::Client.new(@api_key, @app_key)
+    @query = 'avg(last_10m):avg:test.metric.metric{host:test.metric.host} > 5'
+  end
+
+  context "create" do
+    before(:each) do
+      @new_alert = @dog.alert(@query)
+    end
+    after(:each) do
+      @dog.delete_alert(@new_alert[1]['id'])
+    end
+
+    it "returns HTTP code 201" do
+      expect(@new_alert[0]).to eq '201'
+    end
+
+    it "returns a valid event ID" do
+      expect(@new_alert[1]['id']).to be_a(Fixnum)
+    end
+
+    it "returns the same query as sent" do
+      expect(@new_alert[1]['query']).to eq @query
+    end
+  end
+
+end

data/spec/common_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe "Common" do
+
+  context "Scope" do
+
+    it "validates the Scope class" do
+      obj = Dogapi::Scope.new("somehost", "somedevice")
+
+      expect(obj.host).to eq "somehost"
+      expect(obj.device).to eq "somedevice"
+    end
+
+  end # end Scope
+
+end # end Common

data/spec/facade_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe "Facade", :vcr => true do
+
+  before(:all) do
+    @api_key = ENV["DATADOG_API_KEY"]
+    @app_key = ENV["DATADOG_APP_KEY"]
+    @job_number = ENV['TRAVIS_JOB_NUMBER'] || '1'
+    @dog = Dogapi::Client.new(@api_key, @app_key)
+  end
+
+  context "Client" do
+
+    before(:each) do
+      @dogmock = Dogapi::Client.new(@api_key, @app_key)
+      @metric_svc = double
+      @dogmock.instance_variable_set("@metric_svc", @metric_svc)
+    end
+
+    it "emit_point passes data" do
+      expect(@metric_svc).to receive(:submit) do |metric, points, scope, options|
+        expect(metric).to eq "metric.name"
+        expect(points[0][1]).to eq 0
+        expect(scope.host).to eq "myhost"
+      end
+      @dogmock.emit_point("metric.name", 0, :host => "myhost")
+    end
+
+    it "emit_point uses localhost default" do
+      expect(@metric_svc).to receive(:submit) do |metric, points, scope, options|
+        expect(scope.host).to eq Dogapi.find_localhost
+      end
+      @dogmock.emit_point("metric.name", 0)
+    end
+
+    it "emit_point can pass nil host" do
+      expect(@metric_svc).to receive(:submit) do |metric, points, scope, options|
+        expect(scope.host).to be_nil
+      end
+      @dogmock.emit_point("metric.name", 0, :host => nil)
+    end
+
+  end
+
+  context "Events" do
+
+    it "emits events and retrieves them" do
+      now = Time.now()
+
+      # Tag the events with the build number, because Travis parallel testing
+      # can cause problems with the event stream
+      tags = ["test-run:#{@job_number}"]
+
+      now_ts = now
+      now_title = 'dogapi-rb end test title ' + now_ts.to_i.to_s
+      now_message = 'test message'
+
+
+      event = Dogapi::Event.new(now_message, :msg_title => now_title,
+        :date_happened => now_ts, :tags => tags)
+
+      code, resp = @dog.emit_event(event)
+      now_event_id = resp["event"]["id"]
+
+      code, resp = @dog.get_event(now_event_id)
+      expect(resp['event']).not_to be_nil
+      expect(resp['event']['text']).to eq(now_message)
+    end
+
+    it "emits events with specified priority" do
+      event = Dogapi::Event.new('test message', :msg_title => 'title', :date_happened => Time.now(), :priority => "low")
+      code, resp = @dog.emit_event(event)
+      low_event_id = resp["event"]["id"]
+
+      code, resp = @dog.get_event(low_event_id)
+      expect(resp['event']).not_to be_nil
+      low_event = resp['event']
+      expect(low_event['priority']).to eq("low")
+    end
+
+    it "emits aggregate events" do
+      now = Time.now()
+      code, resp = @dog.emit_event(Dogapi::Event.new("Testing Aggregation (first)", :aggregation_key => now.to_i))
+      first = resp["event"]["id"]
+      code, resp = @dog.emit_event(Dogapi::Event.new("Testing Aggregation (second)", :aggregation_key => now.to_i))
+      second = resp["event"]["id"]
+
+      code, resp = @dog.get_event(first)
+      expect(resp["event"]).not_to be_nil
+      code, resp = @dog.get_event(second)
+      expect(resp["event"]).not_to be_nil
+    end
+
+  end
+
+  context "Tags" do
+    it "adds, updates and detaches tags" do
+      hostname = "test.tag.host"
+
+      @dog.emit_point('test.tag.metric', 1, :host => hostname)
+
+      @dog.detach_tags(hostname)
+      code, resp = @dog.host_tags(hostname)
+      expect(resp["tags"]).to be_empty
+
+      @dog.add_tags(hostname, ['test.tag.1', 'test.tag.2'])
+      code, resp = @dog.host_tags(hostname)
+      new_tags = resp["tags"]
+      expect(new_tags).to match_array(['test.tag.1', 'test.tag.2'])
+
+      @dog.add_tags(hostname, ['test.tag.3'])
+      code, resp = @dog.host_tags(hostname)
+      new_tags = resp["tags"]
+      expect(new_tags).to match_array(['test.tag.1', 'test.tag.2', 'test.tag.3'])
+
+      @dog.detach_tags(hostname)
+      code, resp = @dog.host_tags(hostname)
+      expect(resp["tags"]).to be_empty
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'rspec'
+require 'vcr'
+
+# include our code and methods
+require 'dogapi'
+
+# Load any custom matchers
+Dir[File.join(File.dirname(__FILE__), "/support/**/*.rb")].each { |f| require f }
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/support/cassettes'
+  c.configure_rspec_metadata!
+  c.default_cassette_options = { :record => :new_episodes, :re_record_interval => 2592000 } # 30 days, in seconds
+  c.hook_into :webmock
+end

data/spec/support/cassettes/Alerts/create/returns_HTTP_code_201.yml

@@ -0,0 +1,90 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://app.datadoghq.com/api/v1/alert?api_key=9775a026f1ca7d1c6c5af9d94d9595a4&application_key=87ce4a24b5553d2e482ea8a8500e71b8ad4554ff
+    body:
+      encoding: UTF-8
+      string: ! '{"query":"avg(last_10m):avg:test.metric.metric{host:test.metric.host}
+        > 5"}'
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json
+      Date:
+      - Tue, 27 Aug 2013 16:13:42 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - gunicorn/0.17.4
+      Set-Cookie:
+      - user={"org":{"id":1499},"_type":"User","id":3658}; Path=/
+      X-Dd-Version:
+      - 31.153-293-3859d5c
+      Content-Length:
+      - '328'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"notify_no_data": false, "event_object": "6bc5a22ffc9d267c3cd6eb3ad79623e0",
+        "state": "OK", "name": "avg(last_10m):avg:test.metric.metric{host:test.metric.host}
+        > 5", "silenced": false, "query": "avg(last_10m):avg:test.metric.metric{host:test.metric.host}
+        > 5", "message": null, "creator": 3658, "id": 37498, "timeout_h": null}'
+    http_version: 
+  recorded_at: Tue, 27 Aug 2013 16:13:42 GMT
+- request:
+    method: delete
+    uri: https://app.datadoghq.com/api/v1/alert/37498?api_key=9775a026f1ca7d1c6c5af9d94d9595a4&application_key=87ce4a24b5553d2e482ea8a8500e71b8ad4554ff
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json
+      Date:
+      - Tue, 27 Aug 2013 16:13:42 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - gunicorn/0.17.4
+      Set-Cookie:
+      - user={"org":{"id":1499},"_type":"User","id":3658}; Path=/
+      X-Dd-Version:
+      - 31.153-293-3859d5c
+      Content-Length:
+      - '315'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"notify_no_data": false, "event_object": "6bc5a22ffc9d267c3cd6eb3ad79623e0",
+        "state": "OK", "name": "avg(last_10m):avg:test.metric.metric{host:test.metric.host}
+        > 5", "silenced": false, "query": "avg(last_10m):avg:test.metric.metric{host:test.metric.host}
+        > 5", "message": null, "creator": 3658, "timeout_h": null}'
+    http_version: 
+  recorded_at: Tue, 27 Aug 2013 16:13:42 GMT
+recorded_with: VCR 2.5.0

data/spec/support/cassettes/Alerts/create/returns_a_valid_event_ID.yml

@@ -0,0 +1,90 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://app.datadoghq.com/api/v1/alert?api_key=9775a026f1ca7d1c6c5af9d94d9595a4&application_key=87ce4a24b5553d2e482ea8a8500e71b8ad4554ff
+    body:
+      encoding: UTF-8
+      string: ! '{"query":"avg(last_10m):avg:test.metric.metric{host:test.metric.host}
+        > 5"}'
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json
+      Date:
+      - Tue, 27 Aug 2013 16:13:42 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - gunicorn/0.17.4
+      Set-Cookie:
+      - user={"org":{"id":1499},"_type":"User","id":3658}; Path=/
+      X-Dd-Version:
+      - 31.153-293-3859d5c
+      Content-Length:
+      - '328'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"notify_no_data": false, "event_object": "6bc5a22ffc9d267c3cd6eb3ad79623e0",
+        "state": "OK", "name": "avg(last_10m):avg:test.metric.metric{host:test.metric.host}
+        > 5", "silenced": false, "query": "avg(last_10m):avg:test.metric.metric{host:test.metric.host}
+        > 5", "message": null, "creator": 3658, "id": 37497, "timeout_h": null}'
+    http_version: 
+  recorded_at: Tue, 27 Aug 2013 16:13:41 GMT
+- request:
+    method: delete
+    uri: https://app.datadoghq.com/api/v1/alert/37497?api_key=9775a026f1ca7d1c6c5af9d94d9595a4&application_key=87ce4a24b5553d2e482ea8a8500e71b8ad4554ff
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json
+      Date:
+      - Tue, 27 Aug 2013 16:13:42 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - gunicorn/0.17.4
+      Set-Cookie:
+      - user={"org":{"id":1499},"_type":"User","id":3658}; Path=/
+      X-Dd-Version:
+      - 31.153-293-3859d5c
+      Content-Length:
+      - '315'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"notify_no_data": false, "event_object": "6bc5a22ffc9d267c3cd6eb3ad79623e0",
+        "state": "OK", "name": "avg(last_10m):avg:test.metric.metric{host:test.metric.host}
+        > 5", "silenced": false, "query": "avg(last_10m):avg:test.metric.metric{host:test.metric.host}
+        > 5", "message": null, "creator": 3658, "timeout_h": null}'
+    http_version: 
+  recorded_at: Tue, 27 Aug 2013 16:13:42 GMT
+recorded_with: VCR 2.5.0