chef-handler-sns 1.1.0 → 1.2.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc3b47ba35513e1fa3c1d7df3ac62d95feaa396d
-  data.tar.gz: c3936aaa918435c64cd476f51f05c8c78e1ba4d2
+  metadata.gz: 75a18e73a5d271e121792cb61dd8ceffa4b9a71f
+  data.tar.gz: d6a1e0119112e417d988b18ef27e1fa4d07782f2
 SHA512:
-  metadata.gz: a36d6e4ff9da8f1a5d502e4d02510ac78793d7c7863c3acd9587bd7a991c7ecb123e3522f2dcae236f7df1a46fadf140205bb632664d26ad70ed5d3bf5971b7d
-  data.tar.gz: f1a242ae00a139aea03b43432143e0dcbf5c052d086d040f1c8e8d9e48bddb49b818c244848ff5e796085e4e666f6ded83f2561cd1ca2f005ba9a60ad33939d9
+  metadata.gz: 37f868ea988256a0a84dac96a480bb90d33bc37f031b07d3589285fc1a53ce4d94791801fa50726a7191976c1ac2073053f78d31f4d9bbae9bb569c9789e46ac
+  data.tar.gz: bdfc6b843d17ce232b9eb1bb45aafc3235f70f2e11359c082b596b352136592a8f3bd98ebeb83aa788d34ce56e5ff8aaefd071a9323a436146c6ea223e1fb8f4

data/README.md

@@ -31,7 +31,7 @@ This Chef Handler is heavily based on [Joshua Timberman](https://github.com/jtim
 
 You can install this handler in two ways:
 
-### Method 1: In the Chef config file
+### Method 1: in the Chef Config File
 
 You can install the RubyGem and configure Chef to use it:
 
@@ -57,7 +57,9 @@ sns_handler.region "us-east-1" # optional
 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:
 
@@ -84,6 +86,8 @@ chef_handler "Chef::Handler::Sns" do
 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
@@ -120,11 +124,59 @@ chef_handler "Chef::Handler::Sns" do
 end
 ```
 
-### Usage with Amazon IAM roles
+#### Method 2.2: in a Recipe with the chef_handler LWRP Inside AWS OpsWorks
+
+If you are inside [AWS OpsWorks](http://aws.amazon.com/opsworks/) or running Chef inside _Bundler_, you might receive the following error:
+
+    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:
+
+```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
+```
+
+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
+#### Method 1: in the Chef Config File
 
 You can install the RubyGem and configure Chef to use it:
 
@@ -140,7 +192,7 @@ exception_handlers << Chef::Handler::Sns.new({
 })
 ```
 
-#### Method 2: In a recipe with the chef_handler LWRP
+#### 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:
 
@@ -160,13 +212,13 @@ chef_handler "Chef::Handler::Sns" do
 end
 ```
 
-##### Opsworks: Filter Notifications by Activity
-An optional array of opsworks activities can be supplied. If the array is set, notifications will
+#### 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 => ["deploy","configure"]
 ]
 ```
 
@@ -176,11 +228,12 @@ 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).
+* `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`.
 
@@ -189,7 +242,7 @@ The following options are available to configure the handler:
 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):
@@ -198,7 +251,7 @@ 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' %>",
+  :subject => "Chef-run: <%= node.name %> - <%= run_status.success? ? "ok" : "error" %>",
   # [...]
 ]
 chef_handler "Chef::Handler::Sns" do
@@ -279,7 +332,26 @@ Stacktrace:
 
 See the [subject](#subject) documentation for more details on the variables accesible inside the template.
 
-## Running the tests
+## IAM Role Credentials from Ohai
+
+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)).
+
+These are the used ohai attributes:
+
+```
+ec2
+├── placement_availability_zone: region is set from here.
+└── iam
+    └── security-credentials
+        └── IAMRoleName
+            ├── AccessKeyId
+            ├── SecretAccessKey
+            └── Token
+```
+
+## Running the Tests
 
 Minitest tests can be run as usual:
 

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

@@ -94,7 +94,7 @@ class Chef
           set_or_return(
             :token,
             arg,
-            :kind_of => String
+            :kind_of => [ String, FalseClass ]
           )
         end
 

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

@@ -2,7 +2,7 @@
 class Chef
   class Handler
     class Sns < ::Chef::Handler
-      VERSION = '1.1.0'
+      VERSION = '1.2.0.beta.1'
     end
   end
 end

data/test/test_chef_handler_sns_config.rb

@@ -17,6 +17,7 @@ describe Chef::Handler::Sns::Config do
     @config_params = {
       :access_key => '***AMAZON-KEY***',
       :secret_key => '***AMAZON-SECRET***',
+      :token => '***AMAZON-TOKEN***',
       :topic_arn => 'arn:aws:sns:***',
     }
     @node = Chef::Node.new
@@ -54,13 +55,24 @@ describe Chef::Handler::Sns::Config do
       @sns_config.send(option, "test")
     end
 
-    [ true, false, 25, Object.new ].each do |bad_value|
+    it "should set '#{option}' option correctly" do
+      @sns_config.send(option, "test")
+
+      assert_equal @sns_config.send(option), "test"
+    end
+
+    [ true, 25, Object.new ].each do |bad_value|
       it "should throw and exception wen '#{option}' option is set to #{bad_value.to_s}" do
         assert_raises(Chef::Exceptions::ValidationFailed) { @sns_config.send(option, bad_value) }
       end
     end
   end
 
+  it 'should accept false value to reset the token' do
+    @sns_config.token(false)
+    assert_equal @sns_config.token, false
+  end
+
   it 'should throw an exception when the body template file does not exist' do
     @sns_config.body_template('/tmp/nonexistent-template.erb')
     ::File.stubs(:exists?).with(@sns_config.body_template).returns(false)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-handler-sns
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0.beta.1
 platform: ruby
 authors:
 - Onddo Labs, SL.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -155,9 +155,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.6