Multiple Updates:

- improving error message in `check-stale-results` when api config is not present
- updating `rubocop` dep and appeasing the cops
- updating `yard` dep
- updating `sensu-plugin` dep

CVE's addressed:
- https://nvd.nist.gov/vuln/detail/CVE-2017-17042
- https://nvd.nist.gov/vuln/detail/CVE-2017-8418

Breaking Changes:
- removed ruby `< 2.3` support

Signed-off-by: Ben Abrams <[email protected]>

Author: majormoses

.rubocop.yml

@@ -36,4 +36,7 @@ Style/GuardClause:
   Enabled: false
 
 Style/Next:
-  Enabled: false
+  Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.3

.travis.yml

@@ -4,9 +4,6 @@ cache:
 install:
 - bundle install
 rvm:
-- 2.0
-- 2.1
-- 2.2
 - 2.3.0
 - 2.4.1
 notifications:
@@ -27,9 +24,6 @@ deploy:
   on:
     tags: true
     all_branches: true
-    rvm: 2.0
-    rvm: 2.1
-    rvm: 2.2
     rvm: 2.3.0
     rvm: 2.4.1
     repo: sensu-plugins/sensu-plugins-sensu

CHANGELOG.md

@@ -6,6 +6,20 @@ Which is based on [Keep A Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
 
+#### Security
+- updated `yard` dependency to `~> 0.9.11` per: https://nvd.nist.gov/vuln/detail/CVE-2017-17042 which closes attacks against a yard server loading arbitrary files (@majormoses)
+- updated rubocop dependency to `~> 0.51.0` per: https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2017-8418. (@majormoses)
+
+### Breaking Changes
+- removing ruby support for `< 2.3` versions as they are EOL (@majormoses)
+- metrics-aggregate.rb: removed support for `sensu` api versions lower than `0.24` you can read about it [here](https://github.com/sensu/sensu/issues/1218) (@majormoses)
+
+### Changed
+- check-stale-results.rb: improve error message when there is no api key in sensu settings (@majormoses)
+- bumped dependency of `sensu-plugin` to `~> 2.5`  (@majormoses)
+- appeasing the cops (@majormoses)
+
+## [3.0.0] - 2018-05-17
 ### Breaking Change
 - bumped dependency of `sensu-plugin` to 2.x you can read about it [here](https://github.com/sensu-plugins/sensu-plugin/blob/master/CHANGELOG.md#v200---2017-03-29)
 

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sensu-plugins-sensu.gemspec

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'github/markup'
 require 'redcarpet'
@@ -8,9 +10,9 @@ require 'yard/rake/yardoc_task'
 require 'English'
 
 YARD::Rake::YardocTask.new do |t|
-  OTHER_PATHS = %w().freeze
+  OTHER_PATHS = %w[].freeze
   t.files = ['lib/**/*.rb', 'bin/**/*.rb', OTHER_PATHS]
-  t.options = %w(--markup-provider=redcarpet --markup=markdown --main=README.md --files CHANGELOG.md)
+  t.options = %w[--markup-provider=redcarpet --markup=markdown --main=README.md --files CHANGELOG.md]
 end
 
 RuboCop::RakeTask.new
@@ -36,4 +38,4 @@ task :check_binstubs do
   end
 end
 
-task default: [:spec, :make_bin_executable, :yard, :rubocop, :check_binstubs]
+task default: %i[spec make_bin_executable yard rubocop check_binstubs]

bin/check-aggregate.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 # Check Aggregate
 # ===
@@ -171,7 +173,7 @@ def honor_stash(aggregate)
     aggregate[:results].delete_if do |entry|
       begin
         api_request("/stashes/silence/#{entry[:client]}/#{config[:check]}")
-        if entry[:status] == 0
+        if entry[:status].zero?
           aggregate[:ok] = aggregate[:ok] - 1
         elsif entry[:status] == 1
           aggregate[:warning] = aggregate[:warning] - 1
@@ -192,7 +194,7 @@ def honor_stash(aggregate)
   def collect_output(aggregate)
     output = ''
     aggregate[:results].each do |entry|
-      output << entry[:output] + "\n" unless entry[:status] == 0
+      output << entry[:output] + "\n" unless entry[:status].zero?
     end
     aggregate[:outputs] = [output]
   end
@@ -208,7 +210,7 @@ def acquire_aggregate
 
   def named_aggregate_results
     results = api_request("/aggregates/#{config[:check]}?max_age=#{config[:age]}")[:results]
-    warning "No aggregates found in last #{config[:age]} seconds" if %w(ok warning critical unknown).all? { |x| results[x.to_sym] == 0 }
+    warning "No aggregates found in last #{config[:age]} seconds" if %w[ok warning critical unknown].all? { |x| results[x.to_sym].zero? }
     results
   end
 
@@ -263,7 +265,7 @@ def compare_pattern(aggregate)
     if config[:debug]
       message += "\n" + aggregate.to_s
     end
-    aggregate[:outputs].each do |output, _count|
+    aggregate[:outputs].each_key do |output|
       matched = regex.match(output.to_s)
       unless matched.nil?
         key = matched[1]

bin/check-stale-results.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 # check-stale-results.rb
 #
@@ -54,7 +56,7 @@ def initialize
 
   def humanize(secs)
     [[60, :seconds], [60, :minutes], [24, :hours], [1000, :days]].map do |count, name|
-      if secs > 0
+      if secs.positive?
         secs, n = secs.divmod(count)
         "#{n.to_i} #{name}"
       end
@@ -69,7 +71,11 @@ def get_uri(path)
 
   def api_request(method, path)
     unless settings.key?('api')
-      raise 'api.json settings not found.'
+      unknown <<~HEREDOC
+        sensu does not have an api config stanza set, please configure it in
+        either /etc/sensu/config.json or in any config that is loaded by sensu
+        such as /etc/sensu/conf.d/api.json
+      HEREDOC
     end
     uri = get_uri(path)
     Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
@@ -85,7 +91,7 @@ def api_request(method, path)
   def results
     res = []
     req = api_request(:GET, '/results')
-    res = JSON.parse(req.body) if req && req.code == '200'
+    res = JSON.parse(req.body) if req&.code == '200'
     res
   end
 

bin/handler-purge-stale-results.rb

@@ -1,3 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 # handler-purge-stale-results.rb
 #
@@ -36,7 +39,7 @@ class HandlerPurgeStaleResults < Sensu::Handler
   def results
     res = []
     req = api_request(:GET, '/results')
-    res = JSON.parse(req.body) if req && req.code == '200'
+    res = JSON.parse(req.body) if req&.code == '200'
     res
   end
 
@@ -54,33 +57,33 @@ def handle
           else
             deleted << "#{result['client']} - #{result['check']['name']}"
           end
-        rescue
+        rescue StandardError
           failed << "#{result['client']} - #{result['check']['name']} (Caught exception: #{$ERROR_INFO})"
         end
       end
     end
 
     if !deleted.empty? || !failed.empty?
-      msg = <<EOF
-From: Sensu <#{config[:mail_sender]}>
-To: <#{config[:mail_recipient]}>
-Subject: Purge stale check results
+      msg = <<~MESSAGE
+        From: Sensu <#{config[:mail_sender]}>
+        To: <#{config[:mail_recipient]}>
+        Subject: Purge stale check results
 
-This is a notification concerning the #{self.class.name} sensu handler running at #{Socket.gethostname}
+        This is a notification concerning the #{self.class.name} sensu handler running at #{Socket.gethostname}
 
-* Summary
+        * Summary
 
-    Deleted: #{deleted.size}
-    Failed to delete: #{failed.size}
+            Deleted: #{deleted.size}
+            Failed to delete: #{failed.size}
 
-* Failed to delete check results:
+        * Failed to delete check results:
 
-#{failed.map { |m| "    #{m}" }.join("\n")}
+        #{failed.map { |m| "    #{m}" }.join("\n")}
 
-* Deleted check results:
+        * Deleted check results:
 
-#{deleted.map { |m| "    #{m}" }.join("\n")}
-EOF
+        #{deleted.map { |m| "    #{m}" }.join("\n")}
+      MESSAGE
 
       Net::SMTP.start(config[:mail_server]) do |smtp|
         smtp.send_message(msg, config[:mail_sender], config[:mail_recipient])

bin/handler-sensu-deregister.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
 
 require 'rubygems'
 require 'sensu-handler'
@@ -21,13 +22,13 @@ def handle
   end
 
   def delete_sensu_client!
-    if config[:invalidate] && config[:invalidate_expire]
-      response = api_request(:DELETE, '/clients/' + @event['client']['name'] + "?invalidate=#{config[:invalidate]}&#{config[:invalidate_expire]}").code
-    elsif config[:invalidate]
-      response = api_request(:DELETE, '/clients/' + @event['client']['name'] + "?invalidate=#{config[:invalidate]}").code
-    else
-      response = api_request(:DELETE, '/clients/' + @event['client']['name']).code
-    end
+    response = if config[:invalidate] && config[:invalidate_expire]
+                 api_request(:DELETE, '/clients/' + @event['client']['name'] + "?invalidate=#{config[:invalidate]}&#{config[:invalidate_expire]}").code
+               elsif config[:invalidate]
+                 api_request(:DELETE, '/clients/' + @event['client']['name'] + "?invalidate=#{config[:invalidate]}").code
+               else
+                 api_request(:DELETE, '/clients/' + @event['client']['name']).code
+               end
     deletion_status(response)
   end
 

bin/handler-sensu.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 ##################
 # Sensu Remediator

bin/metrics-aggregate.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 # Aggregate Metrics
 #
@@ -115,27 +117,12 @@ def run
     acquire_checks.each do |check|
       aggregate = get_aggregate(check['name'])
       puts "#{check['name']} aggregates: #{aggregate}" if config[:debug]
-      aggregate.each do |result, count|
-        # in 0.24 they changed the api results for aggregates this helps
-        # maintain backwards compatibility with 0.23 and newer versions.
-        if count.is_a?(Hash)
-          count.each do |x, y|
-            output metric_name: x,
-                   value: y,
-                   graphite_metric_path: "#{config[:scheme]}.#{check['name']}.#{x}",
-                   statsd_metric_name: "#{config[:scheme]}.#{check['name']}.#{x}",
-                   influxdb_measurement: config[:measurement],
-                   tags: {
-                     check: check['name'],
-                     host: Socket.gethostname
-                   },
-                   timestamp: timestamp
-          end
-        else
-          output metric_name: result,
-                 value: count,
-                 graphite_metric_path: "#{config[:scheme]}.#{check['name']}.#{result}",
-                 statsd_metric_name: "#{config[:scheme]}.#{check['name']}.#{result}",
+      aggregate.each_value do |count|
+        count.each do |x, y|
+          output metric_name: x,
+                 value: y,
+                 graphite_metric_path: "#{config[:scheme]}.#{check['name']}.#{x}",
+                 statsd_metric_name: "#{config[:scheme]}.#{check['name']}.#{x}",
                  influxdb_measurement: config[:measurement],
                  tags: {
                    check: check['name'],

bin/metrics-delete-expired-stashes.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 # Delete stashes when their 'expires' timestamp is exceeded
 # ===
@@ -14,12 +16,11 @@
 require 'json'
 require 'socket'
 
-include Sensu::Plugin::Utils
-
 class CheckSilenced < Sensu::Plugin::Metric::CLI::Generic
+  include Sensu::Plugin::Utils
   default_host = begin
                    settings['api']['host']
-                 rescue
+                 rescue StandardError
                    'localhost'
                  end
 
@@ -81,7 +82,7 @@ def acquire_stashes
     all_stashes.each do |stash|
       filtered_stashes << stash if stash['path'] =~ /^#{@config[:filter]}\/.*/
     end
-    return filtered_stashes
+    filtered_stashes
   rescue Errno::ECONNREFUSED
     warning 'Connection refused'
   rescue RestClient::RequestTimeout
@@ -99,9 +100,9 @@ def run
     stashes = acquire_stashes
     now = Time.now.to_i
     @count = 0
-    if stashes.count > 0
+    if stashes.count.positive?
       stashes.each do |stash|
-        if stash['content'].key?('expires') && now - stash['content']['expires'] > 0
+        if stash['content'].key?('expires') && now - stash['content']['expires'] .positive?
           delete_stash(stash) unless config[:noop]
           @count += 1
         end

bin/metrics-events.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 # Event Metrics
 #

lib/sensu-plugins-sensu.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'sensu-plugins-sensu/version'

lib/sensu-plugins-sensu/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SensuPluginsSensu
   # This defines the version of the gem
   module Version