chef-handler-status_notifier 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3149f18b65e07619bad10f7b36ce33d0ac29fc42
-  data.tar.gz: 3c3d034ad1bfac27d916a3cc8f3f2d91bd03bc91
+  metadata.gz: 9670852bd3a1ce613f503a1fd9af77f9207930b9
+  data.tar.gz: 928ae559401567ddda68fd9c967ab90f8510a36e
 SHA512:
-  metadata.gz: 88e108cd32ecd04df1b2f441ee75cd9cfe71a0de5a0eeae6ddb15f37a4f006c6a7c1f587dac2179fe06037d0430308de8c9415e8941a4e3564f1e0f3a8da35ec
-  data.tar.gz: 5b0ede03e06aa9d39b8490b096157e4a3b4c00de5cc73807fcb129c993993c022758d69a9dbb5b22dc7a67180b147c2618f6651d5aa4e4bd3e7cee496149bb8d
+  metadata.gz: c3695b1f6a72527354b6d8dd9790f4cbf2a22581704397fe3dc1492995bbd1e2959a52f5a451a8dc9e8ce5ca19f9dfc57095c070aea87a19525ab0232198af50
+  data.tar.gz: f507dcb17b76396e5115a71b63508e5420583dea846e6db7a1b4b7eacaa0f0f01f0a26c3d4f02184656240f8a1d799450ad0f66ba71d84644141b44c10b1cfc7

data/README.md

@@ -1,10 +1,23 @@
 # Chef::Handler::StatusNotifier
 
-Chef Handler for Status Notifier
+Chef Handler for Status Notifier. This is being used here, https://github.com/faizalzakaria/chef-run-notifier .
 
 ## Usage
 
-TODO:
+In your Chef recipe,
+
+```ruby
+chef_gem 'chef-handler-status_notifier' do
+  compile_time true if respond_to?(:compile_time)
+  action :upgrade
+end
+
+chef_handler 'StatusNotifierHandler' do
+  source 'chef/handler/status_notifier'
+  arguments [node['run_notifier']['slack'], node['run_notifier']['hipchat']]
+  action :nothing
+end.run_action(:enable)
+```
 
 ## Contributing
 

data/chef-handler-status_notifier.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "chef-handler-status_notifier"
-  spec.version       = "0.4.4"
+  spec.version       = "0.5.0"
   spec.authors       = ["Faizal Zakaria"]
   spec.email         = ["phaibusiness@gmail.com"]
   spec.summary       = %q{Chef status notifier handler}

data/lib/chef/handler/status_notifier.rb

@@ -9,26 +9,22 @@ require 'slack-notifier'
 
 class StatusNotifierHandler < Chef::Handler
 
-  def initialize(slack_params, hipchat_params)
-    initialize_hipchat(hipchat_params)
-    initialize_slack(slack_params)
-  end
-
-  def initialize_hipchat(params)
-    @hipchat_params = params
-  end
+  DEFAULT_FAILED_MESSAGE  = '"Failure on #{node.name}: #{run_status.formatted_exception}"'.freeze
+  DEFAULT_SUCCESS_MESSAGE = '"Chef run succesfully on #{node.name}"'.freeze
 
-  def initialize_slack(params)
-    @slack_params = params
+  def initialize(slack_params, hipchat_params, custom_message_params = {})
+    @slack_params   = slack_params
+    @hipchat_params = hipchat_params
+    @custom_message_params = custom_message_params
   end
 
   def report
     if run_status.failed?
-      msg = "Failure on #{node.name}: #{run_status.formatted_exception}"
+      msg = failed_message
       status = :failed
       send_to_hipchat(msg)
     else
-      msg = "Chef run succesfully on #{node.name}"
+      msg = success_message
       status = :success
     end
 
@@ -38,6 +34,19 @@ class StatusNotifierHandler < Chef::Handler
 
   private
 
+  def eval_message_for(message)
+    return nil if message.nil?
+    eval(message)
+  end
+
+  def failed_message
+    eval_message_for(@custom_message_params[:failed_message] || DEFAULT_FAILED_MESSAGE)
+  end
+
+  def success_message
+    eval_message_for(@custom_message_params[:success_message] || DEFAULT_SUCCESS_MESSAGE)
+  end
+
   def send_to_hipchat(msg)
     return unless @hipchat_params[:enabled]
     hipchat[@hipchat_params[:room_name]].send(@hipchat_params[:username], msg, :notify => @hipchat_params[:notify])

data/spec/status_notifier_spec.rb

@@ -17,10 +17,26 @@ describe StatusNotifierHandler do
     }
   end
 
-  it 'should run without error' do
-    allow_any_instance_of(StatusNotifierHandler).to receive(:send_to_slack).and_return(true)
-    allow_any_instance_of(StatusNotifierHandler).to receive(:send_to_hipchat).and_return(true)
-    expect{StatusNotifierHandler.new(slack_params, hipchat_params).report}.to_not raise_error
+  context 'without custom message' do
+    it 'should run without error' do
+      allow_any_instance_of(StatusNotifierHandler).to receive(:send_to_slack).and_return(true)
+      allow_any_instance_of(StatusNotifierHandler).to receive(:send_to_hipchat).and_return(true)
+      expect{StatusNotifierHandler.new(slack_params, hipchat_params).report}.to_not raise_error
+    end
   end
 
+  context 'with custom message' do
+    let(:custom_message_params) do
+      {
+        success_message: '"Success on #{node.name}"',
+        failed_message: '"Failed on #{node.name}"'
+      }
+    end
+
+    it 'should run without error' do
+      allow_any_instance_of(StatusNotifierHandler).to receive(:send_to_slack).and_return(true)
+      allow_any_instance_of(StatusNotifierHandler).to receive(:send_to_hipchat).and_return(true)
+      expect{StatusNotifierHandler.new(slack_params, hipchat_params, custom_message_params).report}.to_not raise_error
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-handler-status_notifier
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Faizal Zakaria
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-05 00:00:00.000000000 Z
+date: 2017-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hipchat
@@ -91,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Chef status notifier handler