minicron 0.7.7 → 0.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f28365c7bfec3d1aee7154ca2c0d92c71c9606b3
-  data.tar.gz: 0764cab857b36939ca2a24482549a48fd2e5f0e8
+  metadata.gz: 70d5c6fda70a68b9ecfa2a36e281149e13698d24
+  data.tar.gz: 218a1309dac82cea4a52b68b9b439a828282c71d
 SHA512:
-  metadata.gz: 68942a54bad7846305ce191398a84def24ba9ecad774edd83ab9195a148363ab4b22faa51bc1ae1eb1d198a2aa31afd6f5c4f401c997dd7be8978d7534ff9247
-  data.tar.gz: 11736bb3645b87ed55ae95744a61022f0044f7706c1d51071cd5aaf211929b2b6056edbd17b53059488747cc37f1b6f54faa21c339e88d44e4077d406123b235
+  metadata.gz: ddea0612497a763de534ba45b673e88f3323a5d0073a8b9dbf157e1d017dba51aeefb03f11f546e0b2cbcd49cacdc5a6af5cf01d4c3755b46ee796dac3d95920
+  data.tar.gz: 1191ed1757310c295be9c4febe73e9de77e0808e5bb6e29f40affa6cd80a9ad94bf20f94dfde76baaefaf7cfaad7055beaad9c192d328b3bc992638cd7418d14

data/README.md

@@ -3,7 +3,7 @@ minicron
 
 [![Gem Version](http://img.shields.io/gem/v/minicron.svg)](https://rubygems.org/gems/minicron)
 [![Build Status](http://img.shields.io/travis/jamesrwhite/minicron.svg)](http://travis-ci.org/jamesrwhite/minicron)
-[![Coverage Status](http://img.shields.io/coveralls/jamesrwhite/minicron.svg)](https://coveralls.io/r/jamesrwhite/minicron?branch=master)
+[![Coverage Status](https://coveralls.io/repos/jamesrwhite/minicron/badge.svg?branch=develop)](https://coveralls.io/r/jamesrwhite/minicron?branch=develop)
 [![Code Climate](http://img.shields.io/codeclimate/github/jamesrwhite/minicron.svg)](https://codeclimate.com/github/jamesrwhite/minicron)
 [![Dependency Status](http://img.shields.io/gemnasium/jamesrwhite/minicron.svg)](https://gemnasium.com/jamesrwhite/minicron)
 [![Inline docs](http://inch-ci.org/github/jamesrwhite/minicron.png)](http://inch-ci.org/github/jamesrwhite/minicron)
@@ -107,7 +107,7 @@ but I encourage you to give it a try in a non critical environment and help me t
 
 2. On some distributions you may need to install the ````ruby-dev```` and ````build-essential```` packages
 
-3. To install the latest release (currently 0.7.7) you can ````gem install minicron````, depending on your ruby setup
+3. To install the latest release (currently 0.7.8) you can ````gem install minicron````, depending on your ruby setup
    you may need to run this with ````sudo````
 
 4. Set your database configuration options in ````/etc/minicron.toml````, you can use the [minicron.toml](https://github.com/jamesrwhite/minicron/blob/master/config/minicron.toml) as a guide on what options are configurable

data/lib/minicron.rb

@@ -52,6 +52,9 @@ module Minicron
       },
       'pagerduty' => {
         'enabled' => false
+      },
+      'aws_sns' => {
+        'enabled' => false
       }
     }
   }

data/lib/minicron/alert.rb

@@ -2,6 +2,7 @@ module Minicron
   autoload :Email,      'minicron/alert/email'
   autoload :SMS,        'minicron/alert/sms'
   autoload :PagerDuty,  'minicron/alert/pagerduty'
+  autoload :AwsSns,     'minicron/alert/aws_sns'
 
   module Hub
     autoload :Alert,    'minicron/hub/models/alert'
@@ -19,6 +20,10 @@ module Minicron
     # @option options [Time] expected_at only applies to 'miss' alerts
     def send_all(options = {})
       Minicron.config['alerts'].each do |medium, value|
+
+        # Add the alert medium into the options hash so that it can be passed to sent?
+        options[:medium] = medium
+
         # Check if the medium is enabled and alert hasn't already been sent
         if value['enabled'] && !sent?(options)
           send(
@@ -27,7 +32,7 @@ module Minicron
             :execution_id => options[:execution_id],
             :job_id => options[:job_id],
             :expected_at => options[:expected_at],
-            :medium => medium
+            :medium => options[:medium]
           )
         end
       end
@@ -53,6 +58,8 @@ module Minicron
         send_sms(options)
       when 'pagerduty'
         send_pagerduty(options)
+      when 'aws_sns'
+        send_aws_sns(options)
       else
         fail Exception, "The medium '#{options[:medium]}' is not supported!"
       end
@@ -99,6 +106,15 @@ module Minicron
       )
     end
 
+    # Send an aws sns alert, this has the same options as #send
+    def send_aws_sns(options = {})
+      sns = Minicron::AwsSns.new
+      sns.send(
+        "minicron alert for job '#{options[:job].name}'!",
+        sns.get_message(options)
+      )
+    end
+
     # Queries the database to determine if an alert for this kind has already
     # been sent
     #

data/lib/minicron/alert/aws_sns.rb

@@ -0,0 +1,49 @@
+require 'aws-sdk-core'
+
+module Minicron
+   # Allows the sending of AWS SNS alerts
+  class AwsSns
+    # Used to set up on the AWS::SNS::Topic
+    def initialize
+      # Get an instance of the sns client
+      @client = Aws::SNS::Client.new({
+        :access_key_id =>  Minicron.config['alerts']['aws_sns']['access_key_id'],
+        :secret_access_key =>  Minicron.config['alerts']['aws_sns']['secret_access_key'],
+        :region => Minicron.config['alerts']['aws_sns']['region']
+      })
+    end
+
+    # Return the message for an alert
+    #
+    # @option options [Minicron::Hub::Job] job a job instance
+    # @option options [String] kind 'fail' or 'miss'
+    # @option options [Integer, nil] schedule_id only applies to 'miss' alerts
+    # @option options [Integer, nil] execution_id only used by 'fail' alerts
+    # @option options [Integer] job_id used to look up the job name for the alert message
+    # @option options [Time] expected_at when the schedule was expected to execute
+    # @option options [String] medium the medium to send the alert via
+    def get_message(options = {})
+      case options[:kind]
+      when 'miss'
+        "minicron alert - job missed!\nJob ##{options[:job_id]} failed to execute at its expected time: #{options[:expected_at]}"
+      when 'fail'
+        "minicron alert - job failed!\nExecution ##{options[:execution_id]} of Job ##{options[:job_id]} failed"
+      else
+        fail Exception, "The kind '#{options[:kind]} is not supported!"
+      end
+    end
+
+    # Send an sns alert
+    #
+    # @param from [String]
+    # @param to [String]
+    # @param message [String]
+    def send(subject, message)
+      @client.publish(
+        :topic_arn => Minicron.config['alerts']['aws_sns']['topic_arn'],
+        :subject => subject,
+        :message => message
+      )
+    end
+  end
+end

data/lib/minicron/constants.rb

@@ -1,6 +1,6 @@
 # The minicron module
 module Minicron
-  VERSION = '0.7.7'
+  VERSION = '0.7.8'
   DEFAULT_CONFIG_FILE = '/etc/minicron.toml'
   BASE_PATH = File.expand_path('../../../', __FILE__)
   LIB_PATH = File.expand_path('../../', __FILE__)

data/lib/minicron/hub/assets/app/controllers/hosts.js

@@ -31,7 +31,7 @@
         // TODO: make this use a bootstrap model as a component
         var results = 'Test Results\n\n';
             results += 'connect:                     ' + data.connect + '\n';
-            results += '/etc writeable:            ' + data.etc.write + '\n';
+            results += '/etc writeable:           ' + data.etc.write + '\n';
             results += '/etc executable:         ' + data.etc.execute + '\n';
             results += 'crontab readable:       ' + data.crontab.read + '\n';
             results += 'crontab writeable:      ' + data.crontab.write;

data/lib/minicron/monitor.rb

@@ -108,8 +108,10 @@ module Minicron
       expected_by = expected_at + 60
 
       # We only need to check jobs that are expected to under the monitor start time
-      # and jobs that have passed their expected by time
-      if expected_at > @start_time && Time.now > expected_by
+      # and jobs that have passed their expected by time and the time the schedule
+      # was last updated isn't before when it was expected, i.e we aren't checking for something
+      # that should have happened earlier in the day.
+      if expected_at > @start_time && Time.now > expected_by && expected_by > schedule.updated_at
         # Check if this execution was created inside a minute window
         # starting when it was expected to run
         check = Minicron::Hub::Execution.exists?(

data/spec/minicron/alert/aws_sns_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+require 'minicron/alert/aws_sns'
+
+describe Minicron::AwsSns do
+  before (:each) do
+    Minicron.parse_config_hash({
+      'alerts' => {
+        'aws_sns' => {
+          'secret_access_key' => 'fd;sflksk;lfsdlfksdfsd',
+          'access_key_id' => 'fdsfsdfsdfsd',
+          'region' => 'us-west-2',
+          'topic_arn' => 'arn:aws:sns:us-west-2:2342423423:yo'
+        }
+      }
+    })
+  end
+
+  describe '#intiailize' do
+    it 'should create an instance of the SNS gem' do
+      sns = Minicron::AwsSns.new
+
+      expect(sns.instance_variable_get(:@client)).to be_a Aws::SNS::Client
+    end
+  end
+
+  describe '#get_message' do
+    context 'when kind is miss' do
+      it 'should return the correct message' do
+        sns = Minicron::AwsSns.new
+        time = Time.now.utc
+        options = {
+          :job_id => 1,
+          :expected_at => time,
+          :execution_id => 2,
+          :kind => 'miss'
+        }
+        message = "minicron alert - job missed!\nJob #1 failed to execute at its expected time: #{time}"
+
+        expect(sns.get_message(options)).to eq message
+      end
+    end
+
+    context 'when kind is fail' do
+      it 'should return the correct message' do
+        sns = Minicron::AwsSns.new
+        options = {
+          :job_id => 1,
+          :execution_id => 2,
+          :kind => 'fail'
+        }
+        message = "minicron alert - job failed!\nExecution #2 of Job #1 failed"
+
+        expect(sns.get_message(options)).to eq message
+      end
+    end
+
+    context 'when kind is not supported' do
+      it 'should raise an Exception' do
+        sns = Minicron::AwsSns.new
+        options = {
+          :kind => 'derp'
+        }
+
+        expect do
+          sns.get_message(options)
+        end.to raise_error Exception
+      end
+    end
+  end
+
+  describe '#send' do
+    it 'sends message to the topic_arn' do
+      sns = Minicron::AwsSns.new
+      subject = 'subject'
+      message = 'message'
+      expect_any_instance_of(Aws::SNS::Client).to receive(:publish).with(
+        topic_arn: Minicron.config['alerts']['aws_sns']['topic_arn'],
+        subject: subject,
+        message: message
+      )
+
+      sns.send(subject, message)
+    end
+  end
+end

data/spec/minicron/alert_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'minicron/alert'
+require 'minicron/alert/aws_sns'
+
+describe Minicron::Alert do
+  describe '#send' do
+    context 'when medium is AWS SNS' do
+      it 'sends message' do
+        alert = Minicron::Alert.new
+        allow(Minicron::Hub::Job).to receive(:find).and_return(nil)
+        allow(Minicron::Hub::Alert).to receive(:create).and_return(nil)
+        expect_any_instance_of(Minicron::Alert).to receive(:send_aws_sns)
+
+        alert.send({
+          :medium => 'aws_sns',
+          :job_id => 1
+        })
+      end
+    end
+  end
+end

data/spec/minicron_spec.rb

@@ -101,6 +101,9 @@ describe Minicron do
             },
             'pagerduty' => {
               'enabled' => false
+            },
+            'aws_sns' => {
+              'enabled' => false
             }
           }
         }

data/spec/valid_config.toml

@@ -49,3 +49,6 @@ dry_run = false
 
   [alerts.pagerduty]
   enabled = false
+
+  [alerts.aws_sns]
+  enabled = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minicron
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.7.8
 platform: ruby
 authors:
 - James White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-20 00:00:00.000000000 Z
+date: 2015-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -416,6 +416,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -472,6 +486,66 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.6
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.5.2
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 description: 
 email:
 - dev.jameswhite+minicron@gmail.com
@@ -486,6 +560,7 @@ files:
 - bin/minicron
 - lib/minicron.rb
 - lib/minicron/alert.rb
+- lib/minicron/alert/aws_sns.rb
 - lib/minicron/alert/email.rb
 - lib/minicron/alert/pagerduty.rb
 - lib/minicron/alert/sms.rb
@@ -573,8 +648,10 @@ files:
 - lib/minicron/transport/server.rb
 - lib/minicron/transport/ssh.rb
 - spec/invalid_config.toml
+- spec/minicron/alert/aws_sns_spec.rb
 - spec/minicron/alert/pagerduty_spec.rb
 - spec/minicron/alert/sms_spec.rb
+- spec/minicron/alert_spec.rb
 - spec/minicron/cli_spec.rb
 - spec/minicron/transport/client_spec.rb
 - spec/minicron/transport/faye/client_spec.rb
@@ -613,8 +690,10 @@ specification_version: 4
 summary: A system to make it easier to manage and monitor cron jobs
 test_files:
 - spec/invalid_config.toml
+- spec/minicron/alert/aws_sns_spec.rb
 - spec/minicron/alert/pagerduty_spec.rb
 - spec/minicron/alert/sms_spec.rb
+- spec/minicron/alert_spec.rb
 - spec/minicron/cli_spec.rb
 - spec/minicron/transport/client_spec.rb
 - spec/minicron/transport/faye/client_spec.rb