flapjack 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b98530923891264cb55c429358ca9597f1ef4ca
-  data.tar.gz: c957beff3e8d6942157ac1e085cd912932f9e287
+  metadata.gz: 9aed6403dfdbf11787e5b39b0224f04c00294b8c
+  data.tar.gz: 2220ec7584002c684b8b6fdb26c843bb580486d4
 SHA512:
-  metadata.gz: dd3e6b3b9af05c5f40ea6f884f985d7b5d6765eb4493f40ee12a12f8a51360933c971227b0afab1f0dd6b57f8c851c5e39276300e319610598208c945288f7aa
-  data.tar.gz: 8ecf0255ef2f7e6cdac040f62a3b8468138bb74bca9e024fbf8111d8743bedba5d861791d2d17ace0cba27ee70c0befc12155195b79b60ae9e4e2ad4ae31f861
+  metadata.gz: 729f88348650bbcbf3f8eb7787a177d22dad350e17fc89333e166c057b57425062fecbe336754b0acb755b61946520900ecb21c003795b40097adbd0eaffe2b6
+  data.tar.gz: f9925153a749408ebd31304306835d821e9367df09cda4c5067b5bb5ff70b3b29d7cd4e5b07b4d4fde9abb4d3e93adc2f5d5c2667686174df75f9d756164a982

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Flapjack Changelog
 
+# 0.9.2 - 2014-07-17
+- Feature: Add ability to disable check via JSON API #529 (@ali-graham)
+- Feature: Jabber - Resource in JID should be supported in the config #557 (@jessereynolds)
+- Feature: Jabber - add an 'identifiers' list to the config #558 (@jessereynolds)
+- Feature: Jabber - handle HipChat style status updates as per XEP-0085 #559 (@jessereynolds)
+
 # 0.9.1 - 2014-06-27
 - Bug: PATCHing blackhole properties for notification rule changes other blackholes - further fixes #504 (@ali-graham)
 - Bug: JSONAPI get all entities/contacts with empty db e3725fc (@ali-graham)

data/etc/flapjack_config.yaml.example

@@ -87,6 +87,8 @@ production:
       jabberid: "flapjack@jabber.example.com"
       password: "good-password"
       alias: "flapjack"
+      identifiers:
+        - "@flapjack"
       rooms:
         - "gimp@conference.jabber.example.com"
         - "log@conference.jabber.example.com"

data/lib/flapjack/gateways/jabber.rb

@@ -50,9 +50,17 @@ module Flapjack
         @redis = Flapjack::RedisPool.new(:config => @redis_config, :size => 2)
 
         @logger = opts[:logger]
+        @logger.debug("Jabber Initializing")
 
         @buffer = []
         @hostname = Socket.gethostname
+
+        # FIXME: i suspect the following should be in #setup so a config reload updates @identifiers
+        # I moved it here so the rspec passes :-/
+        @alias = @config['alias'] || 'flapjack'
+        @identifiers = ((@config['identifiers'] || []) + [@alias]).uniq
+        @logger.debug("I will respond to the following identifiers: #{@identifiers.join(', ')}")
+
         super()
       end
 
@@ -65,7 +73,9 @@ module Flapjack
       end
 
       def setup
-        @flapjack_jid = Blather::JID.new((@config['jabberid'] || 'flapjack') + '/' + @hostname)
+        jid = @config['jabberid'] || 'flapjack'
+        jid += '/' + @hostname unless jid.include?('/')
+        @flapjack_jid = Blather::JID.new(jid)
 
         super(@flapjack_jid, @config['password'], @config['server'], @config['port'].to_i)
 
@@ -80,13 +90,19 @@ module Flapjack
           end
         end
 
-        register_handler :message, :groupchat?, :body => /^#{@config['alias']}:\s+/ do |stanza|
+        body_matchers = @identifiers.inject([]) do |memo, identifier|
+          @logger.debug("identifier: #{identifier}, memo: #{memo}")
+          memo << {:body => /^#{identifier}[:\s]/}
+          memo
+        end
+        @logger.debug("body_matchers: #{body_matchers}")
+        register_handler :message, :groupchat?, body_matchers do |stanza|
           EventMachine::Synchrony.next_tick do
             on_groupchat(stanza)
           end
         end
 
-        register_handler :message, :chat? do |stanza|
+        register_handler :message, :chat?, :body do |stanza|
           EventMachine::Synchrony.next_tick do
             on_chat(stanza)
           end
@@ -111,11 +127,11 @@ module Flapjack
             @logger.info("Joining room #{room}")
             presence = Blather::Stanza::Presence.new
             presence.from = @flapjack_jid
-            presence.to = Blather::JID.new("#{room}/#{@config['alias']}")
+            presence.to = Blather::JID.new("#{room}/#{@alias}")
             presence << "<x xmlns='http://jabber.org/protocol/muc'><history maxstanzas='0'></x>"
             EventMachine::Synchrony.next_tick do
               write presence
-              say(room, "flapjack jabber gateway started at #{Time.now}, hello!", :groupchat)
+              say(room, "flapjack jabber gateway started at #{Time.now}, hello! Try typing 'help'.", :groupchat)
             end
           end
         end
@@ -160,7 +176,7 @@ module Flapjack
         out
       end
 
-      def interpreter(command_raw,from)
+      def interpreter(command_raw, from)
         msg          = nil
         action       = nil
         entity_check = nil
@@ -239,7 +255,8 @@ module Flapjack
           t    = Process.times
           fqdn = `/bin/hostname -f`.chomp
           pid  = Process.pid
-          msg  = "Flapjack #{Flapjack::VERSION} process #{pid} on #{fqdn} \n" +
+          msg  = "Flapjack #{Flapjack::VERSION} process #{pid} on #{fqdn}\n" +
+                 "Identifiers: #{@identifiers.join(', ')}\n" +
                  "Boot time: #{@boot_time}\n" +
                  "User CPU Time: #{t.utime}\n" +
                  "System CPU Time: #{t.stime}\n" +
@@ -537,18 +554,23 @@ module Flapjack
         return if @should_quit
         @logger.debug("groupchat message received: #{stanza.inspect}")
 
-        if stanza.body =~ /^#{@config['alias']}:\s+(.*)/m
-          command  = $1
+        the_command = nil
+        @identifiers.each do |identifier|
+          if stanza.body =~ /^#{identifier}:?\s*(.*)/m
+            the_command  = $1
+            @logger.debug("matched identifier: #{identifier}, command: #{the_command.inspect}")
+            break
+          end
         end
 
         from = stanza.from
 
         begin
-          results = interpreter(command, from.resource.to_s)
+          results = interpreter(the_command, from.to_s)
           msg     = results[:msg]
           action  = results[:action]
         rescue => e
-          @logger.error("Exception when interpreting command '#{command}' - #{e.class}, #{e.message}")
+          @logger.debug("Exception when interpreting command '#{the_command}' - #{e.class}, #{e.message}")
           msg = "Oops, something went wrong processing that command (#{e.class}, #{e.message})"
         end
 
@@ -571,8 +593,10 @@ module Flapjack
           command = stanza.body
         end
 
+        from = stanza.from
+
         begin
-          results = interpreter(command)
+          results = interpreter(command, from.resource.to_s)
           msg     = results[:msg]
           action  = results[:action]
         rescue => e

data/lib/flapjack/gateways/jsonapi.rb

@@ -98,6 +98,8 @@ module Flapjack
 
       set :dump_errors, false
 
+      set :protection, :except => :path_traversal
+
       rescue_error = Proc.new {|status, exception, request_info, *msg|
         if !msg || msg.empty?
           trace = exception.backtrace.join("\n")

data/lib/flapjack/gateways/jsonapi/check_methods.rb

@@ -31,8 +31,24 @@ module Flapjack
           app.helpers Flapjack::Gateways::JSONAPI::Helpers
           app.helpers Flapjack::Gateways::JSONAPI::CheckMethods::Helpers
 
+          app.patch %r{^/checks/(.+)$} do
+            checks_for_check_names(params[:captures][0].split(',')).each do |check|
+              apply_json_patch('checks') do |op, property, linked, value|
+                case op
+                when 'replace'
+                  if ['enabled'].include?(property)
+                    # explicitly checking for false being passed in
+                    check.disable! if value.is_a?(FalseClass)
+                  end
+                end
+              end
+            end
+
+            status 204
+          end
+
           # create a scheduled maintenance period for a check on an entity
-          app.post %r{^/scheduled_maintenances/checks/([^/]+)$} do
+          app.post %r{^/scheduled_maintenances/checks/(.+)$} do
             scheduled_maintenances = wrapped_params('scheduled_maintenances')
             checks_for_check_names(params[:captures][0].split(',')).each do |check|
               scheduled_maintenances.each do |wp|
@@ -50,7 +66,7 @@ module Flapjack
           # create an acknowledgement for a service on an entity
           # NB currently, this does not acknowledge a specific failure event, just
           # the entity-check as a whole
-          app.post %r{^/unscheduled_maintenances/checks/([^/]+)$} do
+          app.post %r{^/unscheduled_maintenances/checks/(.+)$} do
             unscheduled_maintenances = wrapped_params('unscheduled_maintenances', false)
             checks_for_check_names(params[:captures][0].split(',')).each do |check|
               unscheduled_maintenances.each do |wp|
@@ -69,7 +85,7 @@ module Flapjack
             status 204
           end
 
-          app.patch %r{^/unscheduled_maintenances/checks/([^/]+)$} do
+          app.patch %r{^/unscheduled_maintenances/checks/(.+)$} do
             checks_for_check_names(params[:captures][0].split(',')).each do |check|
               apply_json_patch('unscheduled_maintenances') do |op, property, linked, value|
                 case op
@@ -84,7 +100,7 @@ module Flapjack
             status 204
           end
 
-          app.delete %r{^/scheduled_maintenances/checks/([^/]+)$} do
+          app.delete %r{^/scheduled_maintenances/checks/(.+)$} do
             start_time = validate_and_parsetime(params[:start_time])
             halt( err(403, "start time must be provided") ) unless start_time
 
@@ -94,7 +110,7 @@ module Flapjack
             status 204
           end
 
-          app.post %r{^/test_notifications/checks/([^/]+)$} do
+          app.post %r{^/test_notifications/checks/(.+)$} do
             test_notifications = wrapped_params('test_notifications', false)
             checks_for_check_names(params[:captures][0].split(',')).each do |check|
               test_notifications.each do |wp|

data/lib/flapjack/version.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
 module Flapjack
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 end
 

data/spec/lib/flapjack/gateways/jabber_spec.rb

@@ -3,13 +3,14 @@ require 'flapjack/gateways/jabber'
 
 describe Flapjack::Gateways::Jabber, :logger => true do
 
-  let(:config) { {'queue'    => 'jabber_notifications',
-                  'server'   => 'example.com',
-                  'port'     => '5222',
-                  'jabberid' => 'flapjack@example.com',
-                  'password' => 'password',
-                  'alias'    => 'flapjack',
-                  'rooms'    => ['flapjacktest@conference.example.com']
+  let(:config) { {'queue'       => 'jabber_notifications',
+                  'server'      => 'example.com',
+                  'port'        => '5222',
+                  'jabberid'    => 'flapjack@example.com',
+                  'password'    => 'password',
+                  'alias'       => 'flapjack',
+                  'identifiers' => ['@flapjack'],
+                  'rooms'       => ['flapjacktest@conference.example.com']
                  }
   }
 
@@ -26,10 +27,11 @@ describe Flapjack::Gateways::Jabber, :logger => true do
     expect(fj).to receive(:register_handler).with(:ready).and_yield(stanza)
     expect(fj).to receive(:on_ready).with(stanza)
 
-    expect(fj).to receive(:register_handler).with(:message, :groupchat?, :body => /^flapjack:\s+/).and_yield(stanza)
+    body_matchers = [{:body => /^@flapjack[:\s]/}, {:body => /^flapjack[:\s]/}]
+    expect(fj).to receive(:register_handler).with(:message, :groupchat?, body_matchers).and_yield(stanza)
     expect(fj).to receive(:on_groupchat).with(stanza)
 
-    expect(fj).to receive(:register_handler).with(:message, :chat?).and_yield(stanza)
+    expect(fj).to receive(:register_handler).with(:message, :chat?, :body).and_yield(stanza)
     expect(fj).to receive(:on_chat).with(stanza)
 
     expect(fj).to receive(:register_handler).with(:disconnected).and_yield(stanza)
@@ -52,9 +54,8 @@ describe Flapjack::Gateways::Jabber, :logger => true do
   end
 
   it "receives an acknowledgement message" do
-    expect(stanza).to receive(:body).and_return('flapjack: ACKID 1f8ac10f fixing now duration: 90m')
+    expect(stanza).to receive(:body).twice.and_return('flapjack: ACKID 1f8ac10f fixing now duration: 90m')
     from = double('from')
-    expect(from).to receive(:resource).and_return('sender')
     expect(from).to receive(:stripped).and_return('sender')
     expect(stanza).to receive(:from).and_return(from)
 
@@ -85,12 +86,11 @@ describe Flapjack::Gateways::Jabber, :logger => true do
   end
 
   it "strips XML tags from the received message" do
-    expect(stanza).to receive(:body).
+    expect(stanza).to receive(:body).twice.
       and_return('flapjack: tell me about <span style="text-decoration: underline;">' +
                  '<a href="http://example.org/">example.org</a></span>')
 
     from = double('from')
-    expect(from).to receive(:resource).and_return('sender')
     expect(from).to receive(:stripped).and_return('sender')
     expect(stanza).to receive(:from).and_return(from)
 
@@ -119,11 +119,10 @@ describe Flapjack::Gateways::Jabber, :logger => true do
   end
 
   it "handles a message with a newline in it" do
-    expect(stanza).to receive(:body).
+    expect(stanza).to receive(:body).twice.
       and_return("flapjack: tell me about \nexample.com")
 
     from = double('from')
-    expect(from).to receive(:resource).and_return('sender')
     expect(from).to receive(:stripped).and_return('sender')
     expect(stanza).to receive(:from).and_return(from)
 
@@ -152,9 +151,8 @@ describe Flapjack::Gateways::Jabber, :logger => true do
   end
 
   it "receives a message it doesn't understand" do
-    expect(stanza).to receive(:body).once.and_return('flapjack: hello!')
+    expect(stanza).to receive(:body).twice.and_return('flapjack: hello!')
     from = double('from')
-    expect(from).to receive(:resource).and_return('sender')
     expect(from).to receive(:stripped).and_return('sender')
     expect(stanza).to receive(:from).and_return(from)
 

data/spec/lib/flapjack/gateways/jsonapi/check_methods_spec.rb

@@ -9,11 +9,26 @@ describe 'Flapjack::Gateways::JSONAPI::CheckMethods', :sinatra => true, :logger
   let(:entity_check)    { double(Flapjack::Data::EntityCheck) }
 
   let(:entity_name)     { 'www.example.net'}
-  let(:entity_name_esc) { URI.escape(entity_name) }
   let(:check)           { 'ping' }
+  let(:check_esc)       { URI.escape(entity_name + ':' + check) }
 
   let(:check_presenter) { double(Flapjack::Gateways::JSONAPI::CheckPresenter) }
 
+  it 'disables a check' do
+    expect(Flapjack::Data::Entity).to receive(:find_by_name).
+      with(entity_name, :redis => redis).and_return(entity)
+    expect(Flapjack::Data::EntityCheck).to receive(:for_entity).
+      with(entity, check, :redis => redis).and_return(entity_check)
+
+    expect(entity_check).to receive(:disable!)
+
+    apatch "/checks/#{check_esc}",
+      [{:op => 'replace', :path => '/checks/0/enabled', :value => false}].to_json,
+      jsonapi_patch_env
+    expect(last_response.status).to eq(204)
+
+  end
+
   it "creates an acknowledgement for an entity check" do
     expect(Flapjack::Data::Entity).to receive(:find_by_name).
       with(entity_name, :redis => redis).and_return(entity)
@@ -26,7 +41,7 @@ describe 'Flapjack::Gateways::JSONAPI::CheckMethods', :sinatra => true, :logger
     expect(Flapjack::Data::Event).to receive(:create_acknowledgement).
       with(entity_name, check, :redis => redis, :duration => (4 * 60 * 60))
 
-    apost "/unscheduled_maintenances/checks/#{entity_name}:#{check}", {}, jsonapi_post_env
+    apost "/unscheduled_maintenances/checks/#{check_esc}", {}, jsonapi_post_env
     expect(last_response.status).to eq(204)
   end
 
@@ -40,7 +55,23 @@ describe 'Flapjack::Gateways::JSONAPI::CheckMethods', :sinatra => true, :logger
     expect(Flapjack::Data::Entity).to receive(:find_by_name).
       with(entity_name, :redis => redis).and_return(entity)
 
-    apatch "/unscheduled_maintenances/checks/#{entity_name}:#{check}",
+    apatch "/unscheduled_maintenances/checks/#{check_esc}",
+      [{:op => 'replace', :path => '/unscheduled_maintenances/0/end_time', :value => end_time.iso8601}].to_json,
+      jsonapi_patch_env
+    expect(last_response.status).to eq(204)
+  end
+
+  it "ends an unscheduled maintenance period for an entity check with a / in the check name" do
+    end_time = Time.now + (60 * 60) # an hour from now
+    expect(entity_check).to receive(:end_unscheduled_maintenance).with(end_time.to_i)
+
+    expect(Flapjack::Data::EntityCheck).to receive(:for_entity).
+      with(entity, 'Disk/Memory Usage', :redis => redis).and_return(entity_check)
+
+    expect(Flapjack::Data::Entity).to receive(:find_by_name).
+      with(entity_name, :redis => redis).and_return(entity)
+
+    apatch "/unscheduled_maintenances/checks/#{URI.escape(entity_name + ':Disk/Memory Usage')}",
       [{:op => 'replace', :path => '/unscheduled_maintenances/0/end_time', :value => end_time.iso8601}].to_json,
       jsonapi_patch_env
     expect(last_response.status).to eq(204)
@@ -57,7 +88,7 @@ describe 'Flapjack::Gateways::JSONAPI::CheckMethods', :sinatra => true, :logger
     expect(entity_check).to receive(:create_scheduled_maintenance).
       with(start.getutc.to_i, duration, :summary => 'test')
 
-    apost "/scheduled_maintenances/checks/#{entity_name}:#{check}",
+    apost "/scheduled_maintenances/checks/#{check_esc}",
       {:scheduled_maintenances => [{:start_time => start.iso8601, :summary => 'test', :duration => duration}]}.to_json,
       jsonapi_post_env
     expect(last_response.status).to eq(204)
@@ -66,7 +97,7 @@ describe 'Flapjack::Gateways::JSONAPI::CheckMethods', :sinatra => true, :logger
   it "doesn't create a scheduled maintenance period for an entity check if the start time isn't passed" do
     duration = (2 * 60 * 60)     # two hours
 
-    apost "/scheduled_maintenances/checks/#{entity_name}:#{check}",
+    apost "/scheduled_maintenances/checks/#{check_esc}",
       {:summary => 'test', :duration => duration}.to_json, jsonapi_post_env
     expect(last_response.status).to eq(403)
   end
@@ -81,7 +112,7 @@ describe 'Flapjack::Gateways::JSONAPI::CheckMethods', :sinatra => true, :logger
     expect(Flapjack::Data::Entity).to receive(:find_by_name).
       with(entity_name, :redis => redis).and_return(entity)
 
-    adelete "/scheduled_maintenances/checks/#{entity_name}:#{check}",
+    adelete "/scheduled_maintenances/checks/#{check_esc}",
       :start_time => start_time.iso8601
     expect(last_response.status).to eq(204)
   end
@@ -89,7 +120,7 @@ describe 'Flapjack::Gateways::JSONAPI::CheckMethods', :sinatra => true, :logger
   it "doesn't delete a scheduled maintenance period if the start time isn't passed" do
     expect(entity_check).not_to receive(:end_scheduled_maintenance)
 
-    adelete "/scheduled_maintenances/checks/#{entity_name}:#{check}"
+    adelete "/scheduled_maintenances/checks/#{check_esc}"
     expect(last_response.status).to eq(403)
   end
 
@@ -109,7 +140,7 @@ describe 'Flapjack::Gateways::JSONAPI::CheckMethods', :sinatra => true, :logger
     expect(Flapjack::Data::Entity).to receive(:find_by_name).
       with(entity_name, :redis => redis).and_return(entity)
 
-    adelete "/scheduled_maintenances/checks/#{entity_name}:#{check},#{entity_name}:foo",
+    adelete "/scheduled_maintenances/checks/#{check_esc},#{entity_name}:foo",
       :start_time => start_time.iso8601
     expect(last_response.status).to eq(204)
   end
@@ -127,7 +158,7 @@ describe 'Flapjack::Gateways::JSONAPI::CheckMethods', :sinatra => true, :logger
     expect(Flapjack::Data::Event).to receive(:test_notifications).
       with(entity_name, check, hash_including(:redis => redis))
 
-    apost "/test_notifications/checks/#{entity_name}:#{check}"
+    apost "/test_notifications/checks/#{check_esc}"
     expect(last_response.status).to eq(204)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flapjack
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Lindsay Holmwood
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-26 00:00:00.000000000 Z
+date: 2014-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dante