dogapi 1.22.0 → 1.23.0

data/spec/integration/dash_spec.rb

@@ -0,0 +1,60 @@
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  DASH_ID = 424_242
+  TITLE = 'My awesome dashboard'.freeze
+  DESCRIPTION = 'Lorem ipsum'.freeze
+  GRAPHS = [{
+    'definition' => {
+      'events' => [],
+      'requests ' => [
+        { 'q' => 'avg:system.mem.free{*}' }
+      ],
+      'viz' => 'timeseries'
+    },
+    'title' => 'Average Memory Free'
+  }].freeze
+  TEMPLATE_VARIABLES = [{
+    'name' => 'host1',
+    'prefix' => 'host',
+    'default' => 'host:my-host'
+  }].freeze
+
+  DASH_BODY = {
+    title: TITLE,
+    description: DESCRIPTION,
+    graphs: GRAPHS,
+    template_variables: TEMPLATE_VARIABLES
+  }.freeze
+  DASH_ARGS = DASH_BODY.values
+
+  describe '#create_dashboard' do
+    it_behaves_like 'an api method',
+                    :create_dashboard, DASH_ARGS,
+                    :post, '/dash', DASH_BODY
+  end
+
+  describe '#update_dashboard' do
+    it_behaves_like 'an api method',
+                    :update_dashboard, [DASH_ID] + DASH_ARGS,
+                    :put, "/dash/#{DASH_ID}", DASH_BODY
+  end
+
+  describe '#get_dashboard' do
+    it_behaves_like 'an api method',
+                    :get_dashboard, [DASH_ID],
+                    :get, "/dash/#{DASH_ID}"
+  end
+
+  describe '#get_dashboards' do
+    it_behaves_like 'an api method',
+                    :get_dashboards, [],
+                    :get, '/dash'
+  end
+
+  describe '#delete_dashboard' do
+    it_behaves_like 'an api method',
+                    :delete_dashboard, [DASH_ID],
+                    :delete, "/dash/#{DASH_ID}"
+  end
+end

data/spec/integration/embed_spec.rb

@@ -0,0 +1,43 @@
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  EMBED_ID = 42_424_242
+  GRAPH_JSON = '{
+  "requests": [{
+    "q": "avg:system.load.1{*}"
+  }],
+  "viz": "timeseries",
+  "events": []
+}'.freeze
+
+  describe '#get_all_embeds' do
+    it_behaves_like 'an api method',
+                    :get_all_embeds, [],
+                    :get, '/graph/embed'
+  end
+
+  describe '#get_embed' do
+    it_behaves_like 'an api method with optional params',
+                    :get_embed, [EMBED_ID],
+                    :get, "/graph/embed/#{EMBED_ID}",
+                    embed_size: 'medium', timeframe: '1_hour', legend: 'no', title: 'fsafasfdas'
+  end
+
+  describe '#create_embed' do
+    it_behaves_like 'an api method with options',
+                    :create_embed, [GRAPH_JSON],
+                    :post, '/graph/embed', graph_json: GRAPH_JSON
+  end
+
+  describe '#enable_embed' do
+    it_behaves_like 'an api method',
+                    :enable_embed, [EMBED_ID],
+                    :get, "/graph/embed/#{EMBED_ID}/enable"
+  end
+
+  describe '#revoke_embed' do
+    it_behaves_like 'an api method',
+                    :revoke_embed, [EMBED_ID],
+                    :get, "/graph/embed/#{EMBED_ID}/revoke"
+  end
+end

data/spec/integration/event_spec.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  EVENT_ID = 123_456
+  EVENT_START = Time.now.to_i - 10
+  EVENT_END = EVENT_START + 5
+  EVENT_OPTIONS = {
+    msg_text: 'My event text',
+    date_happened: EVENT_START,
+    msg_title: 'My event title',
+    priority: 'normal',
+    parent: nil,
+    tags: ['test:test'],
+    aggregation_key: 'fasdfasffergeqgqe',
+    alert_type: nil,
+    event_type: nil,
+    source_type_name: nil,
+    title: 'My event title',
+    text: 'My event text',
+    host: 'data.dog',
+    device: nil
+  }.freeze
+  EVENT = Dogapi::Event.new 'My event text', EVENT_OPTIONS
+  STREAM_PARAMS = {
+    priority: 'normal',
+    sources: 'chef',
+    tags: %w(fds fdsfsa)
+  }.freeze
+
+  describe '#emit_event' do
+    it 'queries the api' do
+      url = api_url + '/events'
+      stub_request(:post, /#{url}/).to_return(body: '{}').then.to_raise(StandardError)
+      expect(dog.send(:emit_event, EVENT)).to eq ['200', {}]
+
+      body = MultiJson.dump(EVENT_OPTIONS)
+
+      expect(WebMock).to have_requested(:post, url).with(
+        query: { 'api_key' => api_key },
+        body: body
+      )
+    end
+  end
+
+  describe '#get_event' do
+    it_behaves_like 'an api method',
+                    :get_event, [EVENT_ID],
+                    :get, "/events/#{EVENT_ID}"
+  end
+
+  describe '#delete_event' do
+    it_behaves_like 'an api method',
+                    :delete_event, [EVENT_ID],
+                    :delete, "/events/#{EVENT_ID}"
+  end
+
+  describe '#stream' do
+    it 'queries the api with params' do
+      url = api_url + '/events'
+      stub_request(:get, /#{url}/).to_return(body: '{}').then.to_raise(StandardError)
+      expect(dog.send(:stream, EVENT_START, EVENT_END, STREAM_PARAMS)).to eq ['200', {}]
+
+      params = STREAM_PARAMS.merge(start: EVENT_START, end: EVENT_END)
+      params.each { |k, v| params[k] = v.join(',') if v.is_a? Array }
+      params.merge! default_query
+
+      expect(WebMock).to have_requested(:get, url).with(
+        query: params
+      )
+    end
+  end
+end

data/spec/integration/metric_spec.rb

@@ -0,0 +1,96 @@
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  METRIC_QUERY = 'avg(last_10m):avg:test.metric.metric{host:test.metric.host} > 5'.freeze
+  FROM = Time.now
+  TO = FROM + 10
+  METRIC = 'test.metric'.freeze
+  POINTS = [[FROM, 10], [TO, 20.0]].freeze
+
+  EMIT_BODY = {
+    'series' => [{
+      'metric' => 'test.metric',
+      'points' => [[FROM.to_i, 10.0], [TO.to_i, 20.0]],
+      'type' => 'gauge',
+      'host' => 'data.dog',
+      'device' => nil
+    }]
+  }.freeze
+
+  BATCH_BODY = {
+    'series' => [{
+      'metric' => 'test.metric',
+      'points' => [[FROM.to_i, 10.0]],
+      'type' => 'gauge',
+      'host' => 'data.dog',
+      'device' => nil
+    }, {
+      'metric' => 'test.metric',
+      'points' => [[TO.to_i, 20.0]],
+      'type' => 'gauge',
+      'host' => 'data.dog',
+      'device' => nil
+    }]
+  }.freeze
+
+  METRIC_PARAMS = { query: METRIC_QUERY, from: FROM.to_i, to: TO.to_i }.freeze
+
+  describe '#emit_point' do
+    it 'queries the api' do
+      url = api_url + '/series'
+      stub_request(:post, /#{url}/).to_return(body: '{}').then.to_raise(StandardError)
+      points = Marshal.load(Marshal.dump(POINTS[0]))
+      expect(dog.send(:emit_points, METRIC, [points])).to eq ['200', {}]
+
+      body = Marshal.load(Marshal.dump(EMIT_BODY))
+      body['series'][0]['points'] = [body['series'][0]['points'][0]]
+      body = MultiJson.dump(body)
+
+      expect(WebMock).to have_requested(:post, url).with(
+        query: { 'api_key' => api_key },
+        body: body
+      )
+    end
+  end
+
+  describe '#emit_points' do
+    it 'queries the api' do
+      url = api_url + '/series'
+      stub_request(:post, /#{url}/).to_return(body: '{}').then.to_raise(StandardError)
+      points = Marshal.load(Marshal.dump(POINTS))
+      expect(dog.send(:emit_points, METRIC, points)).to eq ['200', {}]
+
+      body = MultiJson.dump(EMIT_BODY)
+
+      expect(WebMock).to have_requested(:post, url).with(
+        query: { 'api_key' => api_key },
+        body: body
+      )
+    end
+  end
+
+  describe '#get_points' do
+    it_behaves_like 'an api method with params',
+                    :get_points, [],
+                    :get, '/query', METRIC_PARAMS
+  end
+
+  describe '#batch_metrics' do
+    it 'queries the api' do
+      url = api_url + '/series'
+      stub_request(:post, /#{url}/).to_return(body: '{}').then.to_raise(StandardError)
+      points = Marshal.load(Marshal.dump(POINTS))
+      dog.batch_metrics do
+        dog.emit_points(METRIC, points[0, 1].clone)
+        dog.emit_points(METRIC, points[1, 1].clone)
+      end
+
+      body = MultiJson.dump(BATCH_BODY)
+
+      expect(WebMock).to have_requested(:post, url).with(
+        query: { 'api_key' => api_key },
+        body: body
+      )
+    end
+  end
+end

data/spec/integration/monitor_spec.rb

@@ -0,0 +1,106 @@
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  MONITOR_ID = 42
+  MONITOR_TYPE = 'custom type'.freeze
+  MONITOR_QUERY = 'avg(last_10m):avg:test.metric.metric{host:test.metric.host} > 5'.freeze
+  DOWNTIME_SCOPE = 'host:vagrant-ubuntu-trusty-64'.freeze
+  DOWNTIME_ID = 424_242_424_242
+  MUTE_HOSTNAME = 'vagrant-ubuntu-trusty-32'.freeze
+
+  describe '#monitor' do
+    it_behaves_like 'an api method with options',
+                    :monitor, [MONITOR_TYPE, MONITOR_QUERY],
+                    :post, '/monitor', 'type' => MONITOR_TYPE, 'query' => MONITOR_QUERY
+  end
+
+  describe '#update_monitor' do
+    it_behaves_like 'an api method with options',
+                    :update_monitor, [MONITOR_ID, MONITOR_QUERY],
+                    :put, "/monitor/#{MONITOR_ID}", 'query' => MONITOR_QUERY
+  end
+
+  describe '#get_monitor' do
+    it_behaves_like 'an api method with optional params',
+                    :get_monitor, [MONITOR_ID],
+                    :get, "/monitor/#{MONITOR_ID}", group_states: %w(custom all)
+  end
+
+  describe '#delete_monitor' do
+    it_behaves_like 'an api method',
+                    :delete_monitor, [MONITOR_ID],
+                    :delete, "/monitor/#{MONITOR_ID}"
+  end
+
+  describe '#get_all_monitors' do
+    it_behaves_like 'an api method with optional params',
+                    :get_all_monitors, [],
+                    :get, '/monitor', group_states: %w(custom all), tags: ['test', 'key:value']
+  end
+
+  describe '#mute_monitors' do
+    it_behaves_like 'an api method',
+                    :mute_monitors, [],
+                    :post, '/monitor/mute_all'
+  end
+
+  describe '#unmute_monitors' do
+    it_behaves_like 'an api method',
+                    :unmute_monitors, [],
+                    :post, '/monitor/unmute_all'
+  end
+
+  describe '#mute_monitor' do
+    it_behaves_like 'an api method',
+                    :mute_monitor, [MONITOR_ID],
+                    :post, "/monitor/#{MONITOR_ID}/mute", {}
+  end
+
+  describe '#unmute_monitor' do
+    it_behaves_like 'an api method',
+                    :unmute_monitor, [MONITOR_ID],
+                    :post, "/monitor/#{MONITOR_ID}/unmute", {}
+  end
+
+  describe '#schedule_downtime' do
+    it_behaves_like 'an api method with options',
+                    :schedule_downtime, [DOWNTIME_SCOPE],
+                    :post, '/downtime', 'scope' => DOWNTIME_SCOPE
+  end
+
+  describe '#update_downtime' do
+    it_behaves_like 'an api method with options',
+                    :update_downtime, [DOWNTIME_ID],
+                    :put, "/downtime/#{DOWNTIME_ID}", {}
+  end
+
+  describe '#get_downtime' do
+    it_behaves_like 'an api method',
+                    :get_downtime, [DOWNTIME_ID],
+                    :get, "/downtime/#{DOWNTIME_ID}"
+  end
+
+  describe '#cancel_downtime' do
+    it_behaves_like 'an api method',
+                    :cancel_downtime, [DOWNTIME_ID],
+                    :delete, "/downtime/#{DOWNTIME_ID}"
+  end
+
+  describe '#get_all_downtimes' do
+    it_behaves_like 'an api method',
+                    :get_all_downtimes, [],
+                    :get, '/downtime'
+  end
+
+  describe '#mute_host' do
+    it_behaves_like 'an api method with options',
+                    :mute_host, [MUTE_HOSTNAME],
+                    :post, "/host/#{MUTE_HOSTNAME}/mute", {}
+  end
+
+  describe '#unmute_host' do
+    it_behaves_like 'an api method',
+                    :unmute_host, [MUTE_HOSTNAME],
+                    :post, "/host/#{MUTE_HOSTNAME}/unmute", {}
+  end
+end

data/spec/integration/screenboard_spec.rb

@@ -0,0 +1,61 @@
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  BOARD_ID = 4_242_424_242
+  SCREEN_DESCRIPTION = {
+    'width' => 1024,
+    'height' => 768,
+    'board_title' => 'dogapi test',
+    'widgets' => [
+      {
+        'type' => 'image',
+        'height' => 20,
+        'width' => 32,
+        'y' => 7,
+        'x' => 32,
+        'url' => 'https://path/to/image.jpg'
+      }
+    ]
+  }.freeze
+  describe '#create_screenboard' do
+    it_behaves_like 'an api method',
+                    :create_screenboard, [SCREEN_DESCRIPTION],
+                    :post, '/screen', SCREEN_DESCRIPTION
+  end
+
+  describe '#update_screenboard' do
+    it_behaves_like 'an api method',
+                    :update_screenboard, [BOARD_ID] + [SCREEN_DESCRIPTION],
+                    :put, "/screen/#{BOARD_ID}", SCREEN_DESCRIPTION
+  end
+
+  describe '#get_screenboard' do
+    it_behaves_like 'an api method',
+                    :get_screenboard, [BOARD_ID],
+                    :get, "/screen/#{BOARD_ID}"
+  end
+
+  describe '#get_all_screenboards' do
+    it_behaves_like 'an api method',
+                    :get_all_screenboards, [],
+                    :get, '/screen'
+  end
+
+  describe '#delete_screenboard' do
+    it_behaves_like 'an api method',
+                    :delete_screenboard, [BOARD_ID],
+                    :delete, "/screen/#{BOARD_ID}"
+  end
+
+  describe '#share_screenboard' do
+    it_behaves_like 'an api method',
+                    :share_screenboard, [BOARD_ID],
+                    :get, "/screen/share/#{BOARD_ID}"
+  end
+
+  describe '#revoke_screenboard' do
+    it_behaves_like 'an api method',
+                    :revoke_screenboard, [BOARD_ID],
+                    :delete, "/screen/share/#{BOARD_ID}"
+  end
+end

data/spec/integration/search_spec.rb

@@ -0,0 +1,11 @@
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  SEARCH_QUERY = 'hosts:database'.freeze
+
+  describe '#search' do
+    it_behaves_like 'an api method with params',
+                    :search, [],
+                    :get, '/search', q: SEARCH_QUERY
+  end
+end