chef-handler-sns 0.1.1 → 0.2.0

data/README.md

@@ -1,18 +1,20 @@
-Description
-===========
+# Chef Handler SNS
 
 A simple Chef report handler that reports status of a Chef run through Amazon SNS.
 
+This Chef Handler is heavily based on [Joshua Timberman](https://github.com/jtimberman) examples.
+
 * http://wiki.opscode.com/display/chef/Exception+and+Report+Handlers
 
-Requirements
-============
+[![Gem Version](https://badge.fury.io/rb/chef-handler-sns.png)](http://badge.fury.io/rb/chef-handler-sns)
+[![Dependency Status](https://gemnasium.com/onddo/chef-handler-sns.png)](https://gemnasium.com/onddo/chef-handler-sns)
+
+## Requirements
 
 * Amazon AWS: uses Amazon SNS service.
 * Uses the `right_aws` library.
 
-Usage
-=====
+## Usage
 
 You can install this handler in two ways:
 
@@ -24,55 +26,102 @@ You can install the RubyGem and configure Chef to use it:
 
 Then add to the configuration (`/etc/chef/solo.rb` for chef-solo or `/etc/chef/client.rb` for chef-client):
 
-    require "chef/handler/sns"
-    
-    # Create the handler
-    sns_handler = Chef::Handler::Sns.new
-    
-    # Your Amazon AWS credentials
-    sns_handler.access_key = "***AMAZON-KEY***"
-    sns_handler.secret_key = "***AMAZON-SECRET***"
-    
-    # Some Amazon SNS configurations
-    sns_handler.topic_arn = "arn:aws:sns:***"
-    sns_handler.region = "us-east-1" # optional
-    
-    # Add your handler
-    exception_handlers << sns_handler
+```ruby
+require "chef/handler/sns"
+
+# Create the handler
+sns_handler = Chef::Handler::Sns.new
+
+# Your Amazon AWS credentials
+sns_handler.access_key = "***AMAZON-KEY***"
+sns_handler.secret_key = "***AMAZON-SECRET***"
+
+# Some Amazon SNS configurations
+sns_handler.topic_arn = "arn:aws:sns:***"
+sns_handler.region = "us-east-1" # optional
+
+# Add your handler
+exception_handlers << sns_handler
+```
 
 ### Method 2: In a recipe with the chef_handler LWRP
 
 Use the [chef_handler LWRP](http://community.opscode.com/cookbooks/chef_handler), creating a recipe with the following:
 
-    # Handler configuration options
-    argument_array = [
-      :access_key => "***AMAZON-KEY***",
-      :secret_key => "***AMAZON-SECRET***",
-
-      :topic_arn => "arn:aws:sns:***",
-      :region => "us-east-1" # optional
-    ]
-    
-    # Install the `chef-handler-sns` RubyGem during the compile phase
-    chef_gem "chef-handler-sns"
-    
-    # Then activate the handler with the `chef_handler` LWRP
-    chef_handler "Chef::Handler::Sns" do
-      source "#{Gem::Specification.find_by_name('chef-handler-sns').lib_dirs_glob}/chef/handler/sns"
-      arguments argument_array
-      supports :exception => true
-      action :enable
-    end
-
-Roadmap
-=======
+```ruby
+# Handler configuration options
+argument_array = [
+  :access_key => "***AMAZON-KEY***",
+  :secret_key => "***AMAZON-SECRET***",
+  :topic_arn => "arn:aws:sns:***",
+]
+
+# Install the `chef-handler-sns` RubyGem during the compile phase
+chef_gem "chef-handler-sns"
+
+# Then activate the handler with the `chef_handler` LWRP
+chef_handler "Chef::Handler::Sns" do
+  source "#{Gem::Specification.find_by_name("chef-handler-sns").lib_dirs_glob}/chef/handler/sns"
+  arguments argument_array
+  supports :exception => true
+  action :enable
+end
+```
+
+If you have an old version of gem package (< 1.8.6) without `find_by_name` or old chef-client (< 0.10.10) without `chef_gem`, you can try creating a recipe similar to the following:
+
+```ruby
+# Handler configuration options
+argument_array = [
+  :access_key => "***AMAZON-KEY***",
+  :secret_key => "***AMAZON-SECRET***",
+  :topic_arn => "arn:aws:sns:***",
+]
+
+# Install the `chef-handler-sns` RubyGem during the compile phase
+if defined?(Chef::Resource::ChefGem)
+  chef_gem "chef-handler-sns"
+else
+  gem_package("chef-handler-sns") do
+    action :nothing
+  end.run_action(:install)
+end
+
+# Get the installed `chef-handler-sns` gem path
+sns_handler_path = Gem::Specification.respond_to?("find_by_name") ?
+  Gem::Specification.find_by_name("chef-handler-sns").lib_dirs_glob :
+  Gem.all_load_paths.grep(/chef-handler-sns/).first
+
+# Then activate the handler with the `chef_handler` LWRP
+chef_handler "Chef::Handler::Sns" do
+  source "#{sns_handler_path}/chef/handler/sns"
+  arguments argument_array
+  supports :exception => true
+  action :enable
+end
+```
+
+## Handler Configuration Options
+
+The following options are available to configure the handler:
+
+* `access_key` - AWS access key (required).
+* `secret_key` - AWS secret key (required).
+* `topic_arn` - AWS topic ARN name (required).
+* `region` - AWS region (optional).
+* `subject` - Message subject string in erubis format (optional). Example:
+```
+sns_handler.subject: "Chef-run: <%= node.name %> - <%= run_status.success? ? 'ok' : 'error' %>"
+```
+* `body_template` - Full path of an erubis template file to use for the message body (optional).
+
+## Roadmap
 
 * rspec tests.
 
 Pull requests are welcome.
 
-License and Author
-==================
+## License and Author
 
 |                      |                                          |
 |:---------------------|:-----------------------------------------|

data/lib/chef/handler/sns.rb

@@ -18,11 +18,12 @@
 
 require 'chef/handler'
 require 'right_aws'
+require 'erubis'
 
 class Chef
   class Handler
     class Sns < ::Chef::Handler
-      attr_writer :access_key, :secret_key, :region, :token, :topic_arn
+      attr_writer :access_key, :secret_key, :region, :token, :topic_arn, :subject, :body_template
   
       def initialize(config={})
         Chef::Log.debug("#{self.class.to_s} initialized.")
@@ -31,6 +32,8 @@ class Chef
         @region = config[:region] if config.has_key?(:region)
         @token = config[:token] if config.has_key?(:token)
         @topic_arn = config[:topic_arn]
+        @subject = config[:subject] if config.has_key?(:subject)
+        @body_template = config[:body_template] if config.has_key?(:body_template)
       end
   
       def report
@@ -46,8 +49,13 @@ class Chef
         raise "access_key not properly set" unless @access_key.kind_of?(String)
         raise "secret_key not properly set" unless @secret_key.kind_of?(String)
         raise "region not properly set" unless @region.kind_of?(String) or @region.nil?
-        raise "topic_arn not properly set" unless @topic_arn.kind_of?(String)
         raise "token not properly set" unless @token.kind_of?(String) or @token.nil?
+        raise "topic_arn not properly set" unless @topic_arn.kind_of?(String)
+        raise "subject not properly set" unless @subject.kind_of?(String) or @subject.nil?
+        unless @body_template.nil?
+          raise "body_template not properly set" unless @body_template.kind_of?(String)
+          raise "body_template file not found: #{@body_template}" unless ::File.exists?(@body_template)
+        end
       end
 
       def sns
@@ -62,44 +70,22 @@ class Chef
       end
   
       def sns_subject
-        chef_client = Chef::Config[:solo] ? 'Chef Solo' : 'Chef Client'
-        status = run_status.success? ? 'success' : 'failure'
-        "#{chef_client} #{status} in #{node.name}"
+        if @subject
+          context = self
+          eruby = Erubis::Eruby.new(@subject)
+          eruby.evaluate(context)
+        else
+          chef_client = Chef::Config[:solo] ? 'Chef Solo' : 'Chef Client'
+          status = run_status.success? ? 'success' : 'failure'
+          "#{chef_client} #{status} in #{node.name}"
+        end
       end
   
       def sns_body
-        message = ''
-  
-        message << "Node Name: #{node.name}\n"
-        message << "Hostname: #{node.fqdn}\n"
-        message << "\n"
-
-        message << "Chef Run List: #{node.run_list.to_s}\n"
-        message << "Chef Environment: #{node.chef_environment}\n"
-        message << "\n"
-
-        if node.attribute?('ec2')
-          message << "Instance Id: #{node.ec2.instance_id}\n"
-          message << "Instance Public Hostname: #{node.ec2.public_hostname}\n"
-          message << "Instance Hostname: #{node.ec2.hostname}\n"
-          message << "Instance Public IPv4: #{node.ec2.public_ipv4}\n"
-          message << "Instance Local IPv4: #{node.ec2.local_ipv4}\n"
-        end
-        message << "\n"
-  
-        message << "Chef Client Elapsed Time: #{elapsed_time.to_s}\n"
-        message << "Chef Client Start Time: #{start_time.to_s}\n"
-        message << "Chef Client Start Time: #{end_time.to_s}\n"
-        message << "\n"
-  
-        if exception
-          message << "Exception: #{run_status.formatted_exception}\n"
-          message << "Stacktrace:\n"
-          message << Array(backtrace).join("\n")
-          message << "\n"
-        end
-
-        message
+        template = IO.read(@body_template || "#{File.dirname(__FILE__)}/sns/templates/body.erb")
+        context = self
+        eruby = Erubis::Eruby.new(template)
+        eruby.evaluate(context)
       end
   
     end

data/lib/chef/handler/sns/templates/body.erb

@@ -0,0 +1,36 @@
+Node Name: <%= node.name %>
+<% if node.attribute?('fqdn') -%>
+Hostname: <%= node.fqdn %>
+<% end -%>
+
+Chef Run List: <%= node.run_list.to_s %>
+Chef Environment: <%= node.chef_environment %>
+
+<% if node.attribute?('ec2') -%>
+<%   if node.ec2.attribute?('instance_id') -%>
+Instance Id: <%= node.ec2.instance_id %>
+<%   end -%>
+<%   if node.ec2.attribute?('public_hostname') -%>
+Instance Public Hostname: <%= node.ec2.public_hostname %>
+<%   end -%>
+<%   if node.ec2.attribute?('hostname') -%>
+Instance Hostname: <%= node.ec2.hostname %>
+<%   end -%>
+<%   if node.ec2.attribute?('public_ipv4') -%>
+Instance Public IPv4: <%= node.ec2.public_ipv4 %>
+<%   end -%>
+<%   if node.ec2.attribute?('local_ipv4') -%>
+Instance Local IPv4: <%= node.ec2.local_ipv4 %>
+<%   end -%>
+<% end -%>
+  
+Chef Client Elapsed Time: <%= elapsed_time.to_s %>
+Chef Client Start Time: <%= start_time.to_s %>
+Chef Client Start Time: <%= end_time.to_s %>
+
+<% if exception -%>
+Exception: <%= run_status.formatted_exception %>
+Stacktrace:
+<%= Array(backtrace).join("\n") %>
+
+<% end -%>

data/lib/chef/handler/sns/version.rb

@@ -1,7 +1,7 @@
 class Chef
   class Handler
     class Sns
-      VERSION = '0.1.1'
+      VERSION = '0.2.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef-handler-sns
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-14 00:00:00.000000000 Z
+date: 2013-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: right_aws
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Chef report handler to send SNS notifications on failures or changes
 email: team@onddo.com
 executables: []
@@ -35,6 +51,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/chef/handler/sns/templates/body.erb
 - lib/chef/handler/sns/version.rb
 - lib/chef/handler/sns.rb
 homepage: http://github.com/onddo/chef-handler-sns