dogwatch 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3573cefa87a87733badaa188e4138bcf946598c1
-  data.tar.gz: 7f160b2d047845120932ad57be4e9f851c94df49
+  metadata.gz: 224be9842797fe4c2fc9c0cf3d88a9972759d54f
+  data.tar.gz: 5b14f7af6a5a64146640832cf53aa16fe350d0bc
 SHA512:
-  metadata.gz: 69453b6cbf2dc5dfc75be7d2a4e762a9d1d18a806a9b9a907e018bd01616602eb6a31dfb847c90f0dacb21ce70ce1db93b02a609e30a692ba6b727d1032bcd4e
-  data.tar.gz: 7a9e862dc1736e0a0147b721851492332c1ada38428882b9c6c393c1f94e0f00a799bb0e2ac4e3a4cc0898cddcfc52fcd238d44946ad80bf49f88ee304a214e3
+  metadata.gz: f98c42c081bbf044495be9c26272e03699a74d581e9653cf5b6a21c8a3103c45d3d06b27b2c7faf8714b8033a928e5bdee2bffa8c95cb7b14e82ba452b6981d8
+  data.tar.gz: 026bf75a19af2a701511e8d7222dc176bf856fc4bac7ddee1cda6458eb09de0a46ea357836749a0cc015e054a0a3a84ef0438e03aeb7d12fdf069e6378c379ae

data/bin/dogwatch

@@ -10,6 +10,7 @@ module DogWatch
     class_option :dogfile, :type => :string, :default => 'Dogfile'
     class_option :api_key, :type => :string, :default => nil
     class_option :app_key, :type => :string, :default => nil
+    class_option :timeout, :type => :numeric, :default => 5
     def initialize(*args)
       super
       @cwd = Dir.getwd
@@ -19,7 +20,8 @@ module DogWatch
     desc 'create', 'Create a monitor from a Dogfile'
     def create
       @dogfile.configure(File.absolute_path(options['dogfile'], @cwd),
-                         options['api_key'], options['app_key'])
+                         options['api_key'], options['app_key'],
+                         options['timeout'])
       @dogfile.create { |c| say_status(*c.to_thor) }
     end
   end

data/dogwatch.gemspec

@@ -20,6 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2'
 
-  spec.add_runtime_dependency 'dogapi', '~> 1.21'
+  spec.add_runtime_dependency 'dogapi', '~> 1.27'
   spec.add_runtime_dependency 'thor', '~> 0.19'
 end

data/example/Dogfile

@@ -4,6 +4,26 @@
 #
 DogWatch.monitor do
   monitor 'test_alert' do
+    type :metric_alert
+    query 'avg(last_1dm):avg:system.cpu.user{region:us-east-1} > 20'
+    message 'A message to include with notifications for this monitor.'\
+            'Email notifications can be sent to specific users by '\
+            'using the same \'@username\' notation as events.'
+
+    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
+
+  monitor 'test_alert2' do
     type :metric_alert
     query 'avg(last_1m):avg:system.cpu.user{region:us-east-1} > 20'
     message 'A message to include with notifications for this monitor.'\

data/lib/dogwatch.rb

@@ -3,6 +3,9 @@
 ##
 module DogWatch
   class << self
+    # @param [Hash] args
+    # @param [Proc] block
+    # @return [DogWatch::Monitor]
     def monitor(*args, &block)
       DogWatch::Monitor.new(*args, &block)
     end

data/lib/dogwatch/dogfile.rb

@@ -9,9 +9,10 @@ module DogWatch
     # @param [String] dogfile
     # @param [String|Object] api_key
     # @param [String|Object] app_key
-    def configure(dogfile, api_key = nil, app_key = nil)
+    # @param [Integer] timeout
+    def configure(dogfile, api_key, app_key, timeout)
       @dogfile = dogfile
-      @config = DogWatch::Model::Config.new(api_key, app_key)
+      @config = DogWatch::Model::Config.new(api_key, app_key, timeout)
     end
 
     # @param [Proc] block

data/lib/dogwatch/model/client.rb

@@ -15,11 +15,13 @@ module DogWatch
       # @param [DogWatch::Model::Config] config
       def initialize(config)
         @config = config
-        @client = Dogapi::Client.new(@config.api_key, @config.app_key)
+        @client = Dogapi::Client.new(@config.api_key, @config.app_key,
+                                     nil, nil, true, @config.timeout)
         @all_monitors = all_monitors
       end
 
       # @param [DogWatch::Model::Monitor] monitor
+      # @return [DogWatch::Model::Response]
       def execute(monitor)
         if monitor_exists?(monitor.name)
           update_monitor(monitor)
@@ -37,7 +39,7 @@ module DogWatch
                                           monitor.attributes.query,
                                           options)
         updated = %w(200 202).include?(response[0])
-        @response = DogWatch::Model::Response.new(response, updated)
+        DogWatch::Model::Response.new(response, options[:name], updated)
       end
 
       # @param [DogWatch::Model::Monitor] monitor
@@ -47,7 +49,17 @@ module DogWatch
         response = @client.monitor(monitor.attributes.type,
                                    monitor.attributes.query,
                                    options)
-        @response = DogWatch::Model::Response.new(response)
+        DogWatch::Model::Response.new(response, options[:name])
+      end
+
+      # @param [Dogwatch::Model::Monitor] monitor
+      # @return [Dogwatch::Model::Response]
+      def validate(monitor)
+        validation = monitor.validate
+        return validation if validation.status == :error
+
+        # If no validation errors return a valid Response
+        DogWatch::Model::Response.new(['200', {}], 'valid')
       end
 
       private

data/lib/dogwatch/model/config.rb

@@ -9,12 +9,15 @@ module DogWatch
     class Config
       attr_accessor :api_key
       attr_accessor :app_key
+      attr_accessor :timeout
 
       # @param [String] api_key
       # @param [String] app_key
-      def initialize(api_key = nil, app_key = nil)
+      # @param [Integer] timeout
+      def initialize(api_key = nil, app_key = nil, timeout = 5)
         @api_key = api_key unless api_key.nil?
         @app_key = app_key unless app_key.nil?
+        @timeout = timeout
         return unless app_key.nil? || api_key.nil?
 
         from_file

data/lib/dogwatch/model/mixin/colorize.rb

@@ -5,6 +5,9 @@ module DogWatch
       # Provides a colorize() mixin that handles shell output coloring
       ##
       module Colorize
+        # @param [Symbol] param
+        # @param [Hash] options
+        # @return [Symbol]
         def colorize(param, options = {})
           define_method(:color) do
             case instance_variable_get("@#{ param }")

data/lib/dogwatch/model/monitor.rb

@@ -56,13 +56,44 @@ module DogWatch
         @attributes.options = opts.render
       end
 
-      # @return [TrueClass|FalseClass]
+      # @return [DogWatch::Model::Response]
       def validate
-        return false unless TYPE_MAP.value?(@attributes.type)
-        return true unless @attributes.type.nil? || @attributes.type.empty? ||
-                           @attributes.query.nil? || @attributes.query.empty?
+        return DogWatch::Model::Response.new(invalid_type_response, 'invalid') \
+          unless TYPE_MAP.key?(@monitor_type)
 
-        false
+        errors = []
+        errors.push('Missing monitor type') if missing_type?
+        errors.push('Missing monitor query') if missing_query?
+
+        if errors.empty?
+          DogWatch::Model::Response.new(['200', { :message => 'valid' }], 'valid')
+        else
+          DogWatch::Model::Response.new(['400', { 'errors' => errors }], 'invalid')
+        end
+      end
+
+      private
+
+      def valid_types
+        TYPE_MAP.keys.map { |k| ":#{k}" }.join(', ')
+      end
+
+      def missing_type?
+        @attributes.type.nil? || @attributes.type.empty?
+      end
+
+      def missing_query?
+        @attributes.query.nil? || @attributes.query.empty?
+      end
+
+      def invalid_type_response
+        [
+          '400',
+          { 'errors' => [
+            "Monitor type '#{@monitor_type}' is not valid. " \
+            "Valid monitor types are: #{valid_types}"
+          ] }
+        ]
       end
     end
   end

data/lib/dogwatch/model/options.rb

@@ -21,6 +21,7 @@ module DogWatch
         @monitor_type = monitor_type
       end
 
+      # @return [Hash]
       def render
         @attributes.each_pair.to_h
       end

data/lib/dogwatch/model/response.rb

@@ -11,6 +11,7 @@ module DogWatch
       ERROR = '400'.freeze
       CREATED = '200'.freeze
       ACCEPTED = '202'.freeze
+
       colorize(:action,
                :green => [:created, :accepted, :updated],
                :yellow => [],
@@ -18,11 +19,21 @@ module DogWatch
 
       attr_accessor :response
 
-      def initialize(response, updated = false)
+      # @param [Array] response
+      # @param [String] name
+      # @param [Boolean] updated
+      # @return [DogWatch::Model::Response]
+      def initialize(response, name, updated = false)
         @response = response
         @updated = updated
+        @name = if response[1]['name'].nil?
+                  name
+                else
+                  response[1]['name']
+                end
       end
 
+      # @return [Symbol]
       def status
         return :updated if @updated == true
         return :created if created?
@@ -30,13 +41,12 @@ module DogWatch
         return :accepted if accepted?
       end
 
+      # @return [String]
       def message
-        attrs = @response[1]
-        return attrs['errors'] if attrs.key?('errors')
-        "#{status.to_s.capitalize} monitor #{attrs['name']}"\
-        " with message #{attrs['message']}"
+        send(status, @response[1])
       end
 
+      # @return [Array]
       def to_thor
         action = status
         text = message
@@ -45,16 +55,35 @@ module DogWatch
 
       private
 
+      def error(attrs)
+        err = attrs['errors'].join(', ')
+        "The following errors occurred when creating monitor #{@name}: #{err}"
+      end
+
+      def created(attrs)
+        "Created monitor #{@name} with message #{attrs['message']}"
+      end
+
+      def updated(attrs)
+        # TODO: Use some kind of statefile to determine diffs between
+        # previously saved model and new version
+        "Updated monitor #{@name} with message #{attrs['message']}"
+      end
+
+      def accepted(attrs)
+        "Accepted monitor #{@name} with message #{attrs['message']}"
+      end
+
       def accepted?
-        @response[0] == ACCEPTED ? true : false
+        @response[0] == ACCEPTED
       end
 
       def created?
-        @response[0] == CREATED ? true : false
+        @response[0] == CREATED
       end
 
       def failed?
-        @response[0] == ERROR ? true : false
+        @response[0] == ERROR
       end
     end
   end

data/lib/dogwatch/monitor.rb

@@ -32,20 +32,22 @@ module DogWatch
     # @return [Array]
     def get
       @responses = @monitors.map do |m|
-        if m.validate
-          @client.execute(m)
+        validate = @client.validate(m)
+        if validate.status == :error
+          validate
         else
-          # Need somewhere to inject local errors such as if the request
-          # was never sent because the type or query wasn't supplied.
-          res = ['400', { 'errors' => ['The DogWatch monitor is invalid.'] }]
-          DogWatch::Model::Response.new(res)
+          @client.execute(m)
         end
       end
     end
 
     # @return [DogWatch::Model::Client]
     def client(client = nil)
-      @client = client.nil? ? DogWatch::Model::Client.new(@config) : client
+      @client = if client.nil?
+                  DogWatch::Model::Client.new(@config)
+                else
+                  client
+                end
     end
   end
 end

data/test/dogwatch/test_client.rb

@@ -8,20 +8,20 @@ require 'json'
 class TestClient < Minitest::Test
   TEST_RESPONSE = [
     '200',
-    [
+    {
       name: 'test monitor',
       type: 'metric alert',
       query: 'test query'
-    ]
+    }
   ].freeze
 
   UPDATED_RESPONSE = [
     '200',
-    [
+    {
       name: 'Monitor name',
       type: :metric_alert,
       query: 'scheduled maintenance query'
-    ]
+    }
   ].freeze
 
   def setup
@@ -48,8 +48,8 @@ class TestClient < Minitest::Test
     new_monitor.query('test query')
 
     @client.client.stub :monitor, TEST_RESPONSE do
-      @client.execute(new_monitor)
-      assert_equal @client.response.status, :created
+      response = @client.execute(new_monitor)
+      assert_equal response.status, :created
     end
   end
 
@@ -59,8 +59,8 @@ class TestClient < Minitest::Test
     update_monitor.query('scheduled maintenance query')
 
     @client.client.stub :update_monitor, UPDATED_RESPONSE do
-      @client.execute(update_monitor)
-      assert_equal @client.response.status, :updated
+      response = @client.execute(update_monitor)
+      assert_equal response.status, :updated
     end
   end
 end

data/test/dogwatch/test_monitor_model.rb

@@ -45,9 +45,16 @@ class TestMonitorModel < Minitest::Test
   end
 
   def test_validate
-    assert_equal true, @monitor.validate
+    validation = @monitor.validate
+    assert_kind_of DogWatch::Model::Response, validation
+    assert_equal :created, validation.status
 
     @monitor.attributes.query = nil
-    assert_equal false, @monitor.validate
+
+    failed_validation = @monitor.validate
+    assert_kind_of DogWatch::Model::Response, failed_validation
+    assert_equal :error, failed_validation.status
+    assert_equal 'The following errors occurred when creating monitor ' \
+      'invalid: Missing monitor query', failed_validation.message
   end
 end

data/test/dogwatch/test_response.rb

@@ -3,9 +3,9 @@ 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)
+    @error_res = DogWatch::Model::Response.new(ERROR_RES, 'error')
+    @valid_res = DogWatch::Model::Response.new(VALID_RES, 'foobar')
+    @accepted_res = DogWatch::Model::Response.new(ACCEPTED_RES, 'foobar')
   end
 
   def test_status_is_error
@@ -17,7 +17,8 @@ class TestResponse < MiniTest::Test
   end
 
   def test_status_message
-    assert_equal ["The value provided for parameter 'query' is invalid"], \
+    assert_equal 'The following errors occurred when creating monitor error: ' \
+      "The value provided for parameter 'query' is invalid", \
                  @error_res.message
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogwatch
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - David Greene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-13 00:00:00.000000000 Z
+date: 2017-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogapi
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '1.27'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '1.27'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement