dogwatch 1.0.0

data/test/dogwatch/test_config.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+require_relative '../test_helper'
+require_relative '../../lib/dogwatch/model/config'
+
+class TestConfig < Minitest::Test
+  def setup
+    creds = "api_key: foo\napp_key: bar"
+
+    IO.stub :read, creds do
+      @fromfile = DogWatch::Model::Config.new
+    end
+  end
+
+  def test_valid_creds
+    assert_equal 'foo', @fromfile.api_key
+    assert_equal 'bar', @fromfile.app_key
+  end
+
+  def test_creds_provided_in_initialize
+    config = DogWatch::Model::Config.new('foo', 'bar')
+    assert_equal 'foo', config.api_key
+    assert_equal 'bar', config.app_key
+  end
+
+  def test_no_creds_provided
+    Dir.stub :home, '/dev/null' do
+      err = assert_raises(RuntimeError) { DogWatch::Model::Config.new }
+      assert_equal 'No credentials supplied', err.message
+    end
+  end
+end

data/test/dogwatch/test_dogwatch.rb

@@ -0,0 +1,15 @@
+require_relative '../test_helper'
+require_relative '../../lib/dogwatch'
+
+class TestDogWatch < Minitest::Test
+  def test_dogwatch_returns_monitor
+    IO.stub :read, "api_key: foo\napp_key: bar" do
+      monitor = DogWatch.monitor do
+        monitor 'foo' do
+          #
+        end
+      end
+      assert_instance_of(DogWatch::Monitor, monitor)
+    end
+  end
+end

data/test/dogwatch/test_monitor_model.rb

@@ -0,0 +1,53 @@
+require_relative '../test_helper'
+require_relative '../../lib/dogwatch/model/monitor'
+
+class TestMonitorModel < Minitest::Test
+  def setup
+    @monitor = DogWatch::Model::Monitor.new('foobar')
+    @monitor.type(:service_check)
+    @monitor.query('quiz baz')
+  end
+
+  def test_type
+    assert_equal 'service check', @monitor.attributes.type
+    assert_kind_of String, @monitor.attributes.type
+  end
+
+  def test_query
+    assert_equal 'quiz baz', @monitor.attributes.query
+    assert_kind_of String, @monitor.attributes.query
+  end
+
+  def test_message
+    @monitor.message('The quick brown fox')
+    assert_equal 'The quick brown fox', @monitor.attributes.message
+    assert_kind_of String, @monitor.attributes.message
+  end
+
+  def test_tags
+    @monitor.tags([1, 2, 3])
+    assert_equal [1, 2, 3], @monitor.attributes.tags
+    assert_kind_of Array, @monitor.attributes.tags
+  end
+
+  def test_options
+    @monitor.options do
+      notify_no_data false
+      no_data_timeframe 3
+    end
+    expected = {
+      notify_no_data: false,
+      no_data_timeframe: 3
+    }
+
+    assert_equal expected, @monitor.attributes.options
+    assert_kind_of Hash, @monitor.attributes.options
+  end
+
+  def test_validate
+    assert_equal true, @monitor.validate
+
+    @monitor.attributes.query = nil
+    assert_equal false, @monitor.validate
+  end
+end

data/test/dogwatch/test_options.rb

@@ -0,0 +1,81 @@
+require_relative '../test_helper'
+require_relative '../../lib/dogwatch/model/options'
+
+class TestOptions < Minitest::Test
+  OPTS = {
+    silenced: { '*': :foobar },
+    notify_no_data: true,
+    no_data_timeframe: 5,
+    timeout_h: 3,
+    renotify_interval: 5,
+    escalation_message: 'foobar',
+    notify_audit: true,
+    include_tags: false
+  }
+
+  # rubocop:disable Metrics/AbcSize
+  def setup
+    @options = DogWatch::Model::Options.new
+
+    @options.silenced(OPTS[:silenced])
+    @options.notify_no_data(OPTS[:notify_no_data])
+    @options.no_data_timeframe(OPTS[:no_data_timeframe])
+    @options.timeout_h(OPTS[:timeout_h])
+    @options.renotify_interval(OPTS[:renotify_interval])
+    @options.escalation_message(OPTS[:escalation_message])
+    @options.notify_audit(OPTS[:notify_audit])
+    @options.include_tags(OPTS[:include_tags])
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  def test_silenced
+    assert_equal @options.attributes.silenced, '*': :foobar
+    assert_instance_of Hash, @options.attributes.silenced
+  end
+
+  def test_notify_no_data
+    assert_equal @options.attributes.notify_no_data, true
+
+    @options.notify_no_data
+    assert_equal @options.attributes.notify_no_data, false
+  end
+
+  def test_no_data_timeframe
+    assert_equal @options.attributes.no_data_timeframe, 5
+    assert_kind_of Integer, @options.attributes.no_data_timeframe
+  end
+
+  def test_timeout_h
+    assert_equal @options.attributes.timeout_h, 3
+    assert_kind_of Integer, @options.attributes.timeout_h
+  end
+
+  def test_renotify_interval
+    assert_equal @options.attributes.renotify_interval, 5
+    assert_kind_of Integer, @options.attributes.renotify_interval
+  end
+
+  def test_escalation_message
+    assert_equal @options.attributes.escalation_message, 'foobar'
+    assert_instance_of String, @options.attributes.escalation_message
+  end
+
+  def test_notify_audit
+    assert_equal @options.attributes.notify_audit, true
+
+    @options.notify_audit
+    assert_equal @options.attributes.notify_audit, false
+  end
+
+  def test_include_tags
+    assert_equal @options.attributes.include_tags, false
+
+    @options.include_tags
+    assert_equal @options.attributes.include_tags, true
+  end
+
+  def test_render
+    assert_equal OPTS, @options.render
+    assert_kind_of Hash, @options.render
+  end
+end

data/test/dogwatch/test_response.rb

@@ -0,0 +1,32 @@
+require_relative '../test_helper'
+require_relative '../../lib/dogwatch/model/response'
+
+class TestResponse < MiniTest::Test
+  def setup
+    @error_res = DogWatch::Model::Response.new(ERROR_RES)
+    @valid_res = DogWatch::Model::Response.new(VALID_RES)
+    @accepted_res = DogWatch::Model::Response.new(ACCEPTED_RES)
+  end
+
+  def test_status_is_error
+    assert_equal :error, @error_res.status
+  end
+
+  def test_status_is_accepted
+    assert_equal :accepted, @accepted_res.status
+  end
+
+  def test_status_message
+    assert_equal ["The value provided for parameter 'query' is invalid"], \
+                 @error_res.message
+  end
+
+  def test_message_output
+    assert_equal 'Created monitor foobar with message foobar', @valid_res.message
+  end
+
+  def test_thor_output
+    assert_equal [:created, 'Created monitor foobar with message foobar', :green],
+                 @valid_res.to_thor
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/.bundle/'
+end
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+require_relative '../lib/dogwatch'
+require_relative 'data/responses'
+
+MiniTest::Reporters.use!
+
+module Minitest
+  module Assertions
+    def assert_nothing_raised(*)
+      yield
+    end
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: dogwatch
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dogapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+description: |-
+  # DogWatch
+
+  _A DSL to create DataDog monitors_
+
+  This gem is designed to provide a simple method for creating DataDog monitors in Ruby.
+
+  ## Installation
+  Add this line to your application's Gemfile:
+
+  ```ruby
+  gem 'dogwatch'
+  ```
+
+  And then execute:
+  ```shell
+  $ bundle exec dogwatch create [--dogfile=DOGFILE] [--api_key=API KEY] [--app_key=APP KEY]
+  ```
+  Or install it yourself as:
+  ```shell
+  $ gem install dogwatch
+  ```
+
+  ## Credentials
+  [DataDog API credentials](https://app.datadoghq.com/account/settings#api) are required.
+
+  Generate both an api key and an app key and either place them in a file named `~/.dogwatch/credentials` or pass them via the command line.
+
+  A sample credentials file is provided in the `example` directory.
+  ## Usage
+
+  DogWatch is a thin DSL over the [DataDog ruby client](https://github.com/DataDog/dogapi-rb) that handles generating DataDog monitors.
+
+  The following is an example of a `Dogfile`:
+  ```ruby
+  require 'dogwatch'
+
+  DogWatch.monitor do
+    ## Create a new monitor - monitor name is REQUIRED
+    monitor 'MONITOR NAME' do
+      type :metric_alert # REQUIRED: One of [:metric_alert | :service_check | :event_alert]
+      query 'QUERY' # REQUIRED
+      message 'MESSAGE'
+      tags %w(A list of tags to associate with your monitor)
+
+      options do
+        silenced '*': nil
+        notify_no_data false
+        no_data_timeframe 3
+        timeout_h 99
+        renotify_interval 60
+        escalation_message 'oh snap'
+        include_tags true
+      end
+    end
+  end
+  ```
+
+  Monitors that already exist are matched by name and updated accordingly. If the name isn't matched exactly, DogWatch assumes you want a new monitor.
+
+  A sample `Dogfile` is provided in the `example` directory.
+
+  For a full list of options and a description of each parameter, see [DataDog's API documentation](http://docs.datadoghq.com/api/#monitors).
+
+  ## TO DO
+  * More descriptive errors
+  * Better error handling if a monitor fails local validation
+email:
+- David_Greene@rapid7.com
+executables:
+- dogwatch
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- Thorfile
+- bin/dogwatch
+- dogwatch.gemspec
+- example/Dogfile
+- example/credentials.example
+- lib/dogwatch.rb
+- lib/dogwatch/dogfile.rb
+- lib/dogwatch/model/client.rb
+- lib/dogwatch/model/config.rb
+- lib/dogwatch/model/mixin/colorize.rb
+- lib/dogwatch/model/monitor.rb
+- lib/dogwatch/model/options.rb
+- lib/dogwatch/model/response.rb
+- lib/dogwatch/monitor.rb
+- lib/dogwatch/version.rb
+- test/data/monitors.json
+- test/data/responses.rb
+- test/dogwatch/test_client.rb
+- test/dogwatch/test_colorize.rb
+- test/dogwatch/test_config.rb
+- test/dogwatch/test_dogwatch.rb
+- test/dogwatch/test_monitor_model.rb
+- test/dogwatch/test_options.rb
+- test/dogwatch/test_response.rb
+- test/test_helper.rb
+homepage: https://github.com/rapid7/dogwatch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A DSL to create DataDog Monitors
+test_files:
+- test/data/monitors.json
+- test/data/responses.rb
+- test/dogwatch/test_client.rb
+- test/dogwatch/test_colorize.rb
+- test/dogwatch/test_config.rb
+- test/dogwatch/test_dogwatch.rb
+- test/dogwatch/test_monitor_model.rb
+- test/dogwatch/test_options.rb
+- test/dogwatch/test_response.rb
+- test/test_helper.rb