chef-notifier 1.0.1 → 1.0.2

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+=== v1.0.2
+* Return self on setup
+
 === v1.0.1
 * Use pony over mail to avoid conflicts
 

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Chris Roberts <chrisroberts.code@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.rdoc

@@ -0,0 +1,45 @@
+== Chef Notifier
+
+Notifications from chef. Currently only notification via mail.
+
+=== Basic usage
+
+require 'chef-notifier/mail'
+
+Chef::Config.exception_handlers << ChefNotifier::Mailer.instance.setup(:recipients => ['some_email@example.com'])
+
+=== Extra fun
+
+The mailer has logger type methods available. This is to provide notifications from chef
+based on encountered states. The mailer is a singleton, which allows a recipe to determine
+what users should receive mail notifications (via user databags most likely). Once setup,
+other cookbook recipes can then include the recipe and use the methods for easy reporting.
+
+==== Example (using user databags):
+
+  include_recipe 'ssmtp'
+
+  notifier_gem = gem_package 'chef-notifier' do
+    action :nothing
+    version '~> 1.0'
+  end
+  notifier_gem.run_action(:install)
+  Gem.clear_paths
+  require 'rubygems'
+  require 'chef-notifier/mail'
+
+  if(File.exists?('/usr/sbin/sendmail'))
+    users = search(:users).find_all{|user| user['chef_notifications']}.map{|user| user[:email]}.compact
+    notifier = ChefNotifier::Mailer.instance.setup(
+      :recipients => users,
+      :delivery => {
+        :method => :sendmail,
+        :arguments => '-i'
+      }
+    )
+    Chef::Config.exception_handlers << ChefNotifier::Mailer.instance
+    Chef::Log.info "Emails added to notifications: #{users.join(', ')}"
+  else
+    Chef::Log.warn "No emails found for notifications"
+  end
+

data/lib/chef-notifier/mail.rb

@@ -10,6 +10,7 @@ module ChefNotifier
 
     def setup(args={})
       @args = {:delivery => {:method => :sendmail, :arguments => '-i'}}.merge(args)
+      self
     end
 
     def report

data/lib/chef-notifier/version.rb

@@ -13,5 +13,5 @@ module ChefNotifier
     end
   end
 
-  VERSION = Version.new('1.0.1')
+  VERSION = Version.new('1.0.2')
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: chef-notifier
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Chris Roberts
@@ -46,7 +46,6 @@ files:
 - README.rdoc
 - CHANGELOG.rdoc
 - chef-notifier.gemspec
-- chef-notifier-1.0.0.gem
 - lib/chef-notifier.rb
 - lib/chef-notifier/mail.rb
 - lib/chef-notifier/version.rb