chef-handler-sns 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d9a1e47581f47ece72146ac2f51a16943ca8f91
-  data.tar.gz: 488113a98280a1710c70a4cb00972684189f0da6
+  metadata.gz: c4942f7c8128f0db8c5fff746db6ce6c145633ec
+  data.tar.gz: 17e60816d695b726125920dfbed4dd8c2fdf4645
 SHA512:
-  metadata.gz: 4497bce34ede99785301cf8bdec0b56fcd650a5d29f031f2f1858ef9dddb5656b7135d9f05749aa3b488313292d34116dcc40194ebfa671bcd460ed8ea5d4a3e
-  data.tar.gz: 344b14df680e8b7595f11057267b8df3fc2e299e53e9e8f63b749437bc2806e2f9ee1eddf54279a972e348f92409ef9d1e88de6a53887de9e6dc0092d5b37bf9
+  metadata.gz: d8e752973f6478d533766d085c04a805ea805d9bcf06c7bba77450c6b3139517536021ead48e0d29904a9644f133d41b214a342139bb1292282768639ba36e97
+  data.tar.gz: bcc56c9011c521dc14f5fae3c92981cddf92c65da1021af89337d9c9f754ea5ef961cda784edbe17cae3d5acb16508c76e0fe45c7e80277f421a85b7ce654346

data/LICENSE

@@ -175,7 +175,7 @@ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
 END OF TERMS AND CONDITIONS
 
-Copyright 2014 Onddo Labs, SL. (www.onddo.com)
+Copyright 2014 Xabier de Zuazo
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,30 +1,29 @@
 # Chef Handler SNS
 [![Gem Version](http://img.shields.io/gem/v/chef-handler-sns.svg?style=flat)](http://badge.fury.io/rb/chef-handler-sns)
-[![Dependency Status](http://img.shields.io/gemnasium/onddo/chef-handler-sns.svg?style=flat)](https://gemnasium.com/onddo/chef-handler-sns)
-[![Code Climate](http://img.shields.io/codeclimate/github/onddo/chef-handler-sns.svg?style=flat)](https://codeclimate.com/github/onddo/chef-handler-sns)
-[![Build Status](http://img.shields.io/travis/onddo/chef-handler-sns.svg?style=flat)](https://travis-ci.org/onddo/chef-handler-sns)
-[![Coverage Status](http://img.shields.io/coveralls/onddo/chef-handler-sns.svg?style=flat)](https://coveralls.io/r/onddo/chef-handler-sns?branch=master)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg?style=flat)](http://www.rubydoc.info/gems/chef-handler-sns)
+[![GitHub](http://img.shields.io/badge/github-zuazo/chef--handler--sns-blue.svg?style=flat)](https://github.com/zuazo/chef-handler-sns)
+[![License](https://img.shields.io/github/license/zuazo/chef-handler-sns.svg?style=flat)](#license-and-author)
+
+[![Dependency Status](http://img.shields.io/gemnasium/zuazo/chef-handler-sns.svg?style=flat)](https://gemnasium.com/zuazo/chef-handler-sns)
+[![Code Climate](http://img.shields.io/codeclimate/github/zuazo/chef-handler-sns.svg?style=flat)](https://codeclimate.com/github/zuazo/chef-handler-sns)
+[![Build Status](http://img.shields.io/travis/zuazo/chef-handler-sns/2.0.0.svg?style=flat)](https://travis-ci.org/zuazo/chef-handler-sns)
+[![Coverage Status](http://img.shields.io/coveralls/zuazo/chef-handler-sns/2.0.0.svg?style=flat)](https://coveralls.io/r/zuazo/chef-handler-sns?branch=2.0.0)
+[![Inline docs](http://inch-ci.org/github/zuazo/chef-handler-sns.svg?branch=master&style=flat)](http://inch-ci.org/github/zuazo/chef-handler-sns)
 
 A simple Chef report handler that reports status of a Chef run through [Amazon SNS](http://aws.amazon.com/sns/), [including IAM roles support](#usage-with-amazon-iam-roles).
 
 [Amazon SNS](http://aws.amazon.com/sns/) can send notifications by SMS, email, [Amazon SQS](http://aws.amazon.com/sqs/) queues or to any HTTP endpoint.
 
-We recommend using the [chef_handler_sns cookbook](http://community.opscode.com/cookbooks/chef_handler_sns) for easy installation.
+We recommend using the [`chef_handler_sns` cookbook](https://supermarket.chef.io/cookbooks/chef_handler_sns) for easy installation.
 
 This Chef Handler is heavily based on [Joshua Timberman](https://github.com/jtimberman) examples.
 
-* http://wiki.opscode.com/display/chef/Exception+and+Report+Handlers
+* https://docs.chef.io/handlers.html#exception-report-handlers
 
 ## Requirements
 
 * Amazon AWS: uses Amazon SNS service.
-* Uses the `aws-sdk` library.
-  * `aws-sdk` requires `nokogiri`, which also has the following requirements:
-    * `libxml2-dev` and `libxslt-dev` installed (optional).
-    * `gcc` and `make` installed (this will compile and install libxml2 and libxslt internally if not found).
-* For `Ruby 1.8`, you need to install old versions of the following dependencies:
-  * `mime-types < 2.0`.
-  * `nokogiri < 1.6`.
+* Ruby `2` or higher (recommended `2.1` or higher).
 
 ## Usage
 
@@ -34,190 +33,131 @@ You can install this handler in two ways:
 
 You can install the RubyGem and configure Chef to use it:
 
-    gem install chef-handler-sns
+    $ gem install chef-handler-sns
 
 Then add to the configuration (`/etc/chef/solo.rb` for chef-solo or `/etc/chef/client.rb` for chef-client):
 
 ```ruby
-require "chef/handler/sns"
+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***"
+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
+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
+### Method 2: in a Recipe with the `chef_handler` LWRP
 
 **Note:** This method will not catch errors before the convergence phase. Use the previous method if you want to be able to report such errors.
 
-Use the [chef_handler LWRP](http://community.opscode.com/cookbooks/chef_handler), creating a recipe with the following:
+Use the [`chef_handler` LWRP](https://supermarket.chef.io/cookbooks/chef_handler), creating a recipe with the following:
 
 ```ruby
 # Handler configuration options
 argument_array = [
-  :access_key => "***AMAZON-KEY***",
-  :secret_key => "***AMAZON-SECRET***",
-  :topic_arn => "arn:aws:sns:***",
+  access_key: '***AMAZON-KEY***',
+  secret_key: '***AMAZON-SECRET***',
+  topic_arn: 'arn:aws:sns:***'
 ]
 
-# Depends on the `xml` cookbook to install nokogiri
-include_recipe "xml::ruby"
-
 # 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
+chef_gem 'chef-handler-sns' do
+  compile_time true # Only for Chef 12
 end
-```
-
-#### Method 2.1: in a Recipe with the chef_handler LWRP Using Gem < 1.8.6
-
-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:***",
-]
-
-# Depends on the `xml` cookbook to install nokogiri
-include_recipe "xml::ruby"
-
-# 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"
+chef_handler 'Chef::Handler::Sns' do
+  source 'chef/handler/sns'
   arguments argument_array
-  supports :exception => true
+  supports exception: true
   action :enable
 end
 ```
 
-#### Method 2.2: in a Recipe with the chef_handler LWRP Inside AWS OpsWorks
+See the [`chef_handler_sns` cookbook provider code](https://github.com/zuazo/chef_handler_sns-cookbook/blob/master/providers/default.rb) for a more complete working example.
 
-If you are inside [AWS OpsWorks](http://aws.amazon.com/opsworks/) or running Chef inside _Bundler_, you might receive the following error:
+### Method 3: Using the `chef-client` Cookbook
 
-    Gem::LoadError
-    --------------
-    Could not find 'chef-handler-sns' (>= 0) among XX total gem(s)
-
-To fix this error, you should get the handler installation path using a code similar to the following:
+You can also use the `node['chef_client']['config']` attribute of the [`chef-client`](https://github.com/chef-cookbooks/chef-client/tree/v4.3.2#start-report-exception-handlers) cookbook:
 
 ```ruby
-# Handler configuration options
-argument_array = [
-  :access_key => "***AMAZON-KEY***",
-  :secret_key => "***AMAZON-SECRET***",
-  :topic_arn => "arn:aws:sns:***",
-]
-
-# Depends on the `xml` cookbook to install nokogiri
-include_recipe "xml::ruby"
-
-# Install the `chef-handler-sns` RubyGem during the compile phase
-chef_gem "chef-handler-sns"
-
-# Get the installed `chef-handler-sns` gem path from Bundler
-sns_handler_path = nil
-bundle_path = ::File.join(Bundler.bundle_path.to_s, "specifications")
-Dir[::File.join(bundle_path, "*.gemspec")].each do |path|
-  spec = Gem::Specification.load(path.untaint)
-  if spec.name == "chef-handler-sns"
-    sns_handler_path = spec.lib_dirs_glob
-  end
-end
-if sns_handler_path.nil?
-  Chef::Application.fatal!("chef-handler-sns not found inside Bundler path: #{bundle_path}")
-end
-
-# 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
+node.default['chef_client']['config']['exception_handlers'] = [{
+  'class' => 'Chef::Handler::Sns',
+  'arguments' => {
+    access_key: '***AMAZON-KEY***',
+    secret_key: '***AMAZON-SECRET***',
+    topic_arn: 'arn:aws:sns:***'
+  }.map { |k, v| "#{k}: #{v.inspect}" }
+}]
 ```
 
-See the [`chef_handler_sns` cookbook provider code](https://github.com/onddo/chef_handler_sns-cookbook/blob/master/providers/default.rb) for a more complete working example.
-
 ### Usage with Amazon IAM Roles
 
 If you are using AWS [IAM roles](http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html) with your server, probably you only need to specify the `topic_arn` parameter. A few simple examples:
 
-#### Method 1: in the Chef Config File
+#### IAM Roles Method 1: in the Chef Config File
 
 You can install the RubyGem and configure Chef to use it:
 
-    gem install chef-handler-sns
+    $ gem install chef-handler-sns
 
 Then add to the configuration (`/etc/chef/solo.rb` for chef-solo or `/etc/chef/client.rb` for chef-client):
 
 ```ruby
-require "chef/handler/sns"
+require 'chef/handler/sns'
 
-exception_handlers << Chef::Handler::Sns.new({
-  :topic_arn => "arn:aws:sns:us-east-1:12341234:MyTopicName"
-})
+exception_handlers << Chef::Handler::Sns.new(
+  topic_arn: 'arn:aws:sns:us-east-1:12341234:MyTopicName'
+)
 ```
 
-#### Method 2: in a Recipe with the chef_handler LWRP
+#### IAM Roles 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:
+Use the [`chef_handler` LWRP](https://supermarket.chef.io/cookbooks/chef_handler), creating a recipe with the following:
 
 ```ruby
-# Depends on the `xml` cookbook to install nokogiri
-include_recipe "xml::ruby"
-
 # Install the `chef-handler-sns` RubyGem during the compile phase
-chef_gem "chef-handler-sns"
+chef_gem 'chef-handler-sns' do
+  compile_time true # Only for Chef 12
+end
 
 # 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 { :topic_arn => "arn:aws:sns:us-east-1:12341234:MyTopicName" }
-  supports :exception => true
+chef_handler 'Chef::Handler::Sns' do
+  source 'chef/handler/sns'
+  arguments topic_arn: 'arn:aws:sns:us-east-1:12341234:MyTopicName'
+  supports exception: true
   action :enable
 end
 ```
 
+### IAM Roles Method 3: Using the `chef-client` Cookbook
+
+You can also use the `node['chef_client']['config']` attribute of the [`chef-client`](https://github.com/chef-cookbooks/chef-client/tree/v4.3.2#start-report-exception-handlers) cookbook:
+
+```ruby
+node.default['chef_client']['config']['exception_handlers'] = [{
+  'class' => 'Chef::Handler::Sns',
+  'arguments' => ['topic_arn: "arn:aws:sns:***"']
+}]
+```
+
 #### OpsWorks: Filter Notifications by Activity
+
 An optional array of OpsWorks activities can be supplied. If the array is set, notifications will
 only be triggered for the activities in the array, everything else will be discarded.
 
 ```ruby
 argument_array = [
-  :filter_opsworks_activities => ["deploy","configure"]
+  filter_opsworks_activities: %w(deploy configure)
 ]
 ```
 
@@ -225,41 +165,46 @@ argument_array = [
 
 The following options are available to configure the handler:
 
-* `access_key` - AWS access key (required, but will try to read it from ohai with IAM roles).
-* `secret_key` - AWS secret key (required, but will try to read it from ohai with IAM roles).
-* `token` - AWS security token (optional, read from ohai with IAM roles). Set to `false` to disable the token detected by ohai.
+* `access_key` - AWS access key (required, but will try to read it from Ohai with IAM roles).
+* `secret_key` - AWS secret key (required, but will try to read it from Ohai with IAM roles).
+* `token` - AWS security token (optional, read from Ohai with IAM roles). Set to `false` to disable the token detected by Ohai.
 * `topic_arn` - AWS topic ARN name (required).
 * `region` - AWS region (optional).
 * `subject` - Message subject string in erubis format (optional).
 * `body_template` - Full path of an erubis template file to use for the message body (optional).
 * `filter_opsworks_activities` - An array of OpsWorks activities to be triggered with (optional). When set, everything else will be discarded.
 
-**Note:** When the machine has an IAM role, will try to read the credentials from ohai. So in the best case, you only need to specify the `topic_arn`.
+**Note:** When the machine has an IAM role, will try to read the credentials from Ohai. So in the best case, you only need to specify the `topic_arn`.
 
-### subject
+### `subject` Configuration Option
 
 Here is an example of the `subject` configuration option using the ruby configuration file (`solo.rb` or `client.rb`):
 
 ```ruby
-sns_handler.subject: "Chef-run: <%= node.name %> - <%= run_status.success? ? "ok" : "error" %>"
+sns_handler.subject(
+  "Chef-run: <%= node.name %> - <%= run_status.success? ? 'ok' : 'error' %>"
+)
 ```
 
-Using the [chef_handler LWRP](http://community.opscode.com/cookbooks/chef_handler):
+Using the [`chef_handler` LWRP](https://supermarket.chef.io/cookbooks/chef_handler):
+
 ```ruby
 argument_array = [
-  :access_key => "***AMAZON-KEY***",
-  :secret_key => "***AMAZON-SECRET***",
-  :topic_arn => "arn:aws:sns:***",
-  :subject => "Chef-run: <%= node.name %> - <%= run_status.success? ? "ok" : "error" %>",
+  access_key: '***AMAZON-KEY***',
+  secret_key: '***AMAZON-SECRET***',
+  topic_arn: 'arn:aws:sns:***',
+  subject:
+    "Chef-run: <%= node.name %> - <%= run_status.success? ? 'ok' : 'error' %>"
   # [...]
 ]
-chef_handler "Chef::Handler::Sns" do
+
+chef_handler 'Chef::Handler::Sns' do
   # [...]
   arguments argument_array
 end
 ```
 
-The following variables are accesible inside the template:
+The following variables are accessible inside the template:
 
 * `start_time` - The time the chef run started.
 * `end_time` - The time the chef run ended.
@@ -268,48 +213,49 @@ The following variables are accesible inside the template:
 * `exception` - The uncaught Exception that terminated the chef run, or nil if the run completed successfully.
 * `backtrace` - The backtrace captured by the uncaught exception that terminated the chef run, or nil if the run completed successfully.
 * `node` - The Chef::Node for this client run.
-* `all_resources` - An Array containing all resources in the chef run's resource_collection.
+* `all_resources` - An Array containing all resources in the chef-run resource collection.
 * `updated_resources` - An Array containing all resources that were updated during the chef run.
 * `success?` - Was the chef run successful? True if the chef run did not raise an uncaught exception.
 * `failed?` - Did the chef run fail? True if the chef run raised an uncaught exception.
 
-### body_template
+### `body_template` Configuration Option
 
-This configuration option needs to contain the full path of an erubis template. For example:
+This configuration option needs to contain the full path of an Erubis template. For example:
 
 ```ruby
-# recipe "myapp::sns_handler"
+# recipe 'myapp::sns_handler'
 
-cookbook_file "chef_handler_sns_body.erb" do
-  path "/tmp/chef_handler_sns_body.erb"
+cookbook_file 'chef_handler_sns_body.erb' do
+  path '/tmp/chef_handler_sns_body.erb'
   # [...]
 end
 
 argument_array = [
-  :access_key => "***AMAZON-KEY***",
-  :secret_key => "***AMAZON-SECRET***",
-  :topic_arn => "arn:aws:sns:***",
-  :body_template => "/tmp/chef_handler_sns_body.erb",
+  access_key: '***AMAZON-KEY***',
+  secret_key: '***AMAZON-SECRET***',
+  topic_arn: 'arn:aws:sns:***',
+  body_template: '/tmp/chef_handler_sns_body.erb'
   # [...]
 ]
-chef_handler "Chef::Handler::Sns" do
+
+chef_handler 'Chef::Handler::Sns' do
   # [...]
   arguments argument_array
 end
 ```
 
 ```erb
-<%# file "myapp/files/default/chef_handler_sns_body.erb" %>
+<%# file 'myapp/files/default/chef_handler_sns_body.erb' %>
 
 Node Name: <%= node.name %>
-<% if node.attribute?("fqdn") -%>
+<% 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.attribute?('ec2') -%>
 Instance Id: <%= node.ec2.instance_id %>
 Instance Public Hostname: <%= node.ec2.public_hostname %>
 Instance Hostname: <%= node.ec2.hostname %>
@@ -329,15 +275,15 @@ Stacktrace:
 <% end -%>
 ```
 
-See the [subject](#subject) documentation for more details on the variables accesible inside the template.
+See the [subject](#subject) documentation for more details on the variables accessible inside the template.
 
 ## IAM Role Credentials from Ohai
 
-IAM Role information and credentials are gathered from ohai by default if they exists.
+IAM Role information and credentials are gathered from Ohai by default if they exists.
 
-No aditional ohai plugin is required. This is natively supported by ohai since version `6.16.0` ([OHAI-400](https://tickets.opscode.com/browse/OHAI-400)).
+No aditional Ohai plugin is required. This is natively supported by Ohai since version `6.16.0` ([OHAI-400](https://tickets.opscode.com/browse/OHAI-400)).
 
-These are the used ohai attributes:
+These are the used Ohai attributes:
 
 ```
 ec2
@@ -350,29 +296,29 @@ ec2
             └── Token
 ```
 
-## Running the Tests
-
-Minitest tests can be run as usual:
+## Testing
 
-    rake test
+See [TESTING.md](https://github.com/zuazo/chef-handler-sns/blob/master/TESTING.md).
 
 ## Contributing
 
-1. Fork the repository on Github.
-2. Create a named feature branch (like `add_component_x`).
-3. Write tests for your change.
-4. Write your change.
-5. Run the tests, ensuring they all pass (try as much as possible not to reduce coverage).
-6. Submit a [Pull Request using Github])(http://github.com/onddo/chef-handler-sns/pulls).
+Please do not hesitate to [open an issue](https://github.com/zuazo/chef-handler-sns/issues/new) with any questions or problems.
+
+See [CONTRIBUTING.md](https://github.com/zuazo/chef-handler-sns/blob/master/CONTRIBUTING.md).
+
+## TODO
+
+See [TODO.md](https://github.com/zuazo/chef-handler-sns/blob/master/TODO.md).
 
 ## License and Author
 
 |                      |                                          |
 |:---------------------|:-----------------------------------------|
-| **Author:**          | [Xabier de Zuazo](https://github.com/zuazo) (<xabier@onddo.com>)
+| **Author:**          | [Xabier de Zuazo](https://github.com/zuazo) (<xabier@zuazo.org>)
 | **Contributor:**     | [Florian Holzhauer](https://github.com/fh)
 | **Contributor:**     | [Michael Hobbs](https://github.com/michaelshobbs)
-| **Copyright:**       | Copyright (c) 2013-2014 Onddo Labs, SL. (www.onddo.com)
+| **Copyright:**       | Copyright (c) 2015 Xabier de Zuazo
+| **Copyright:**       | Copyright (c) 2013-2014 Onddo Labs, SL.
 | **License:**         | Apache License, Version 2.0
 
     Licensed under the Apache License, Version 2.0 (the "License");