chef-handler-sns 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4942f7c8128f0db8c5fff746db6ce6c145633ec
-  data.tar.gz: 17e60816d695b726125920dfbed4dd8c2fdf4645
+  metadata.gz: c45d44aa08b39e5ac355ffacc4f745c6596324a6
+  data.tar.gz: 7018588d12c83e43d5b49b7e10940ec3e3613259
 SHA512:
-  metadata.gz: d8e752973f6478d533766d085c04a805ea805d9bcf06c7bba77450c6b3139517536021ead48e0d29904a9644f133d41b214a342139bb1292282768639ba36e97
-  data.tar.gz: bcc56c9011c521dc14f5fae3c92981cddf92c65da1021af89337d9c9f754ea5ef961cda784edbe17cae3d5acb16508c76e0fe45c7e80277f421a85b7ce654346
+  metadata.gz: 6a68e3d7ef8fbac4594d831e6b82d2cc22d2b2977e2bd828f790d2809ec2e431cb6f06db8ae9f4eb6bd7579867dc68cd326a62e2258d683905fbc5948410328c
+  data.tar.gz: 25206122277c328f22ce06f274e2df7293120711e13de5da0446386f9e11d472ed8361e876a4cc7e676bd3b922513adbd53f8f5123162a0195e6508ad7278f6c

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+jN�8���I��;J�Cl[�d�}��8�

data.tar.gz.sig

@@ -0,0 +1,3 @@
+R/
�^KA�F=a�\��G���ƭ�l����g3���yl(��/;�tJ釹��ݱ�)������K��J�QY���~xTy�$J/ak*���w�Xʍ�d�̾��
+P�n)�+N(�>��C�F�-[)��� d-j�7���z��`"<���Va��m�2�Q�7.\톉�A��j�
+l��;:b��q�(�P0��Y���-�š��׹����9�Qxu����

data/README.md

@@ -6,8 +6,8 @@
 
 [![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)
+[![Build Status](http://img.shields.io/travis/onddo/chef-handler-sns/2.1.0.svg?style=flat)](https://travis-ci.org/onddo/chef-handler-sns)
+[![Coverage Status](http://img.shields.io/coveralls/onddo/chef-handler-sns/2.1.0.svg?style=flat)](https://coveralls.io/r/onddo/chef-handler-sns?branch=2.1.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).
@@ -169,6 +169,7 @@ The following options are available to configure the handler:
 * `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).
+* `message_structure` - Set this option to `json` if you want to send a different message for each protocol. You must set your [message body template](#body_template-configuration-option) properly. Valid value: `json`. (optional)
 * `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).
@@ -277,6 +278,21 @@ Stacktrace:
 
 See the [subject](#subject) documentation for more details on the variables accessible inside the template.
 
+If you set `message_structure` to `json`, the body template must:
+
+* be a syntactically valid JSON; and
+* contain at least a top-level JSON key of `default` with a value that is a string.
+You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
+```erb
+<%# file 'myapp/files/default/chef_handler_sns_body.erb' %>
+{
+"default": "Message body text here.", 
+"email": "Message body text here.", 
+"http": "Message body text here."
+}
+```
+See the [AWS SNS](http://docs.aws.amazon.com/sns/latest/api/API_Publish.html#API_Publish_RequestParameters) documentation for more details on SNS message format.
+
 ## IAM Role Credentials from Ohai
 
 IAM Role information and credentials are gathered from Ohai by default if they exists.
@@ -317,6 +333,8 @@ See [TODO.md](https://github.com/zuazo/chef-handler-sns/blob/master/TODO.md).
 | **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)
+| **Contributor:**     | [Hugo Lopes Tavares](https://github.com/hltbra)
+| **Contributor:**     | [Dmitry Averkiev](https://github.com/d-averkiev)
 | **Copyright:**       | Copyright (c) 2015 Xabier de Zuazo
 | **Copyright:**       | Copyright (c) 2013-2014 Onddo Labs, SL.
 | **License:**         | Apache License, Version 2.0

data/lib/chef/handler/sns.rb

@@ -136,7 +136,8 @@ class Chef
         sns.publish(
           topic_arn: topic_arn,
           message: sns_body,
-          subject: sns_subject
+          subject: sns_subject,
+          message_structure: message_structure
         )
       end
 
@@ -250,7 +251,7 @@ class Chef
       # ruby-limiting-a-utf-8-string-by-byte-length
       #
       # @param str [String] The string to limit.
-      # @param size [Fixnum] The string size in bytes.
+      # @param size [Integer] The string size in bytes.
       #
       # @return [String] The final string.
       #

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

@@ -42,7 +42,7 @@ class Chef
         #
         # Required configuration options.
         #
-        REQUIRED = %w(access_key secret_key topic_arn)
+        REQUIRED = %w(access_key secret_key topic_arn).freeze
 
         #
         # Reads some configuration options from Ohai information.
@@ -58,9 +58,7 @@ class Chef
         def config_from_ohai(node)
           config_ohai = Config::Ohai.new(node)
           [
-            :access_key,
-            :secret_key,
-            :token
+            :access_key, :secret_key, :token
           ].each do |attr|
             send(attr, config_ohai.send(attr)) if send(attr).nil?
           end
@@ -108,13 +106,13 @@ class Chef
           config_from_ohai(node) if node
           REQUIRED.each do |key|
             next unless send(key).nil?
-            fail Exceptions::ValidationFailed,
-                 "Required argument #{key} is missing!"
+            raise Exceptions::ValidationFailed,
+                  "Required argument #{key} is missing!"
           end
 
           return unless body_template && !::File.exist?(body_template)
-          fail Exceptions::ValidationFailed,
-               "Template file not found: #{body_template}."
+          raise Exceptions::ValidationFailed,
+                "Template file not found: #{body_template}."
         end
 
         #
@@ -127,11 +125,7 @@ class Chef
         # @api public
         #
         def access_key(arg = nil)
-          set_or_return(
-            :access_key,
-            arg,
-            kind_of: String
-          )
+          set_or_return(:access_key, arg, kind_of: String)
         end
 
         #
@@ -144,11 +138,7 @@ class Chef
         # @api public
         #
         def secret_key(arg = nil)
-          set_or_return(
-            :secret_key,
-            arg,
-            kind_of: String
-          )
+          set_or_return(:secret_key, arg, kind_of: String)
         end
 
         #
@@ -161,11 +151,7 @@ class Chef
         # @api public
         #
         def region(arg = nil)
-          set_or_return(
-            :region,
-            arg,
-            kind_of: String
-          )
+          set_or_return(:region, arg, kind_of: String)
         end
 
         #
@@ -178,11 +164,7 @@ class Chef
         # @api public
         #
         def token(arg = nil)
-          set_or_return(
-            :token,
-            arg,
-            kind_of: [String, FalseClass]
-          )
+          set_or_return(:token, arg, kind_of: [String, FalseClass])
         end
 
         #
@@ -198,9 +180,7 @@ class Chef
         #
         def topic_arn(arg = nil)
           set_or_return(
-            :topic_arn,
-            arg,
-            kind_of: String
+            :topic_arn, arg, kind_of: String
           ).tap do |arn|
             # Get the region from the ARN:
             next if arn.nil? || !region.nil?
@@ -208,6 +188,19 @@ class Chef
           end
         end
 
+        #
+        # Gets or sets MessageStructure SNS request parameter.
+        #
+        # @param arg [String] MessageStructure.
+        #
+        # @return [String] MessageStructure.
+        #
+        # @api public
+        #
+        def message_structure(arg = nil)
+          set_or_return(:message_structure, arg, kind_of: String)
+        end
+
         #
         # Gets or sets SNS message subject.
         #
@@ -218,11 +211,7 @@ class Chef
         # @api public
         #
         def subject(arg = nil)
-          set_or_return(
-            :subject,
-            arg,
-            kind_of: String
-          )
+          set_or_return(:subject, arg, kind_of: String)
         end
 
         #
@@ -235,11 +224,7 @@ class Chef
         # @api public
         #
         def body_template(arg = nil)
-          set_or_return(
-            :body_template,
-            arg,
-            kind_of: String
-          )
+          set_or_return(:body_template, arg, kind_of: String)
         end
 
         #
@@ -256,11 +241,7 @@ class Chef
         #
         def filter_opsworks_activity(arg = nil)
           arg = Array(arg) if arg.is_a? String
-          set_or_return(
-            :filter_opsworks_activity,
-            arg,
-            kind_of: Array
-          )
+          set_or_return(:filter_opsworks_activity, arg, kind_of: Array)
         end
       end
     end

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

@@ -29,7 +29,7 @@ Instance Local IPv4: <%= node.ec2.local_ipv4 %>
 
 Chef Client Elapsed Time: <%= elapsed_time.to_s %>
 Chef Client Start Time: <%= start_time.to_s %>
-Chef Client Start Time: <%= end_time.to_s %>
+Chef Client End Time: <%= end_time.to_s %>
 
 <% if exception -%>
 Exception: <%= run_status.formatted_exception %>

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

@@ -30,7 +30,7 @@ class Chef
       #
       # chef-handler-sns Ruby Gem version.
       #
-      VERSION = '2.0.0'
+      VERSION = '2.1.0'.freeze
     end
   end
 end

data/test/test_chef_handler_sns.rb

@@ -40,6 +40,7 @@ module Aws
   end
 end
 
+# rubocop:disable Metrics/BlockLength
 describe Chef::Handler::Sns do
   let(:data_dir) { ::File.join(::File.dirname(__FILE__), 'data') }
   let(:node) do
@@ -277,7 +278,7 @@ describe Chef::Handler::Sns do
 
   it 'publishes messages if node["opsworks"]["activity"] matches allowed '\
      'acvities' do
-    node.set['opsworks']['activity'] = 'deploy'
+    node.override['opsworks']['activity'] = 'deploy'
     config[:filter_opsworks_activity] = %w(deploy setup)
 
     fake_sns.expects(:publish).once
@@ -286,7 +287,7 @@ describe Chef::Handler::Sns do
 
   it 'does not publish messages if node["opsworks"]["activity"] differs '\
      'from allowed acvities' do
-    node.set['opsworks']['activity'] = 'configure'
+    node.override['opsworks']['activity'] = 'configure'
     config[:filter_opsworks_activity] = %w(deploy setup)
 
     fake_sns.expects(:publish).never
@@ -301,3 +302,4 @@ describe Chef::Handler::Sns do
     sns_handler.run_report_safely(run_status)
   end
 end
+# rubocop:enable Metrics/BlockLength

data/test/test_chef_handler_sns_config.rb

@@ -25,10 +25,10 @@ class SnsConfig
 end
 
 class ChefFakeOhai < Chef::Handler::Sns::Config::Ohai
-  def intialize
-  end
+  def intialize; end
 end
 
+# rubocop:disable Metrics/BlockLength
 describe Chef::Handler::Sns::Config do
   let(:node) do
     node = Chef::Node.new
@@ -71,7 +71,9 @@ describe Chef::Handler::Sns::Config do
     end
   end
 
-  [:access_key, :secret_key, :region, :token, :topic_arn].each do |option|
+  [
+    :access_key, :secret_key, :region, :token, :topic_arn, :message_structure
+  ].each do |option|
     it "accepts string values in '#{option}' option" do
       sns_config.send(option, 'test')
     end
@@ -166,3 +168,4 @@ describe Chef::Handler::Sns::Config do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

data/test/test_chef_handler_sns_config_ohai.rb

@@ -19,11 +19,12 @@
 
 require 'helper'
 
+# rubocop:disable Metrics/BlockLength
 describe Chef::Handler::Sns::Config::Ohai do
   let(:node) do
     Chef::Node.new.tap do |node|
       node.name('test')
-      node.set['ec2'] = {
+      node.override['ec2'] = {
         'placement_availability_zone' => 'region1a',
         'iam' => {
           'security-credentials' => {
@@ -38,7 +39,9 @@ describe Chef::Handler::Sns::Config::Ohai do
     end
   end
   let(:config) { Chef::Handler::Sns::Config::Ohai.new(node) }
-  let(:node_set_iam_roles) { node.set['ec2']['iam']['security-credentials'] }
+  let(:node_override_iam_roles) do
+    node.override['ec2']['iam']['security-credentials']
+  end
 
   describe 'read_config' do
     it 'reads the region' do
@@ -46,13 +49,13 @@ describe Chef::Handler::Sns::Config::Ohai do
     end
 
     it 'does not read the region when not set' do
-      node.set['ec2']['placement_availability_zone'] = nil
-      assert_equal nil, config.region
+      node.override['ec2']['placement_availability_zone'] = nil
+      assert_nil config.region
     end
 
     it 'does not read the credentials when has not IAM role' do
-      node.set['ec2'] = {}
-      assert_equal nil, config.access_key
+      node.override['ec2'] = {}
+      assert_nil config.access_key
     end
 
     it 'reads the access_key' do
@@ -60,8 +63,8 @@ describe Chef::Handler::Sns::Config::Ohai do
     end
 
     it 'does not read the access_key when not set' do
-      node_set_iam_roles['iam-role1']['AccessKeyId'] = nil
-      assert_equal nil, config.access_key
+      node_override_iam_roles['iam-role1']['AccessKeyId'] = nil
+      assert_nil config.access_key
     end
 
     it 'reads the secret_key' do
@@ -69,8 +72,8 @@ describe Chef::Handler::Sns::Config::Ohai do
     end
 
     it 'does not read the secret_key when not set' do
-      node_set_iam_roles['iam-role1']['SecretAccessKey'] = nil
-      assert_equal nil, config.secret_key
+      node_override_iam_roles['iam-role1']['SecretAccessKey'] = nil
+      assert_nil config.secret_key
     end
 
     it 'reads the security token' do
@@ -78,8 +81,9 @@ describe Chef::Handler::Sns::Config::Ohai do
     end
 
     it 'does not read the security token when not set' do
-      node_set_iam_roles['iam-role1']['Token'] = nil
-      assert_equal nil, config.token
+      node_override_iam_roles['iam-role1']['Token'] = nil
+      assert_nil config.token
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: chef-handler-sns
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Xabier de Zuazo
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2015-12-28 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDaDCCAlCgAwIBAgIBATANBgkqhkiG9w0BAQUFADA9MQ8wDQYDVQQDDAZ4YWJp
+  ZXIxFTATBgoJkiaJk/IsZAEZFgV6dWF6bzETMBEGCgmSJomT8ixkARkWA29yZzAe
+  Fw0xNjA5MTUxNzIzMTlaFw0xNzA5MTUxNzIzMTlaMD0xDzANBgNVBAMMBnhhYmll
+  cjEVMBMGCgmSJomT8ixkARkWBXp1YXpvMRMwEQYKCZImiZPyLGQBGRYDb3JnMIIB
+  IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsdGpaOki5vixi6PplYTO/6nT
+  e989el4XtVnQlVWQ/cvLdiTwcjqeaVHJfvkqkgrnpFSdQZogEM6dAdOdX3U0x66L
+  JCdyr5D9d1l8p9/UpnCVmvZleFbjO/xU60nq/6ILNxHScEBLFOF/oL7YRU3qgiNH
+  0Xx87C1N6Ap98aIVemOlD7iSVi56PN/2NvJJb3x9hk6sB/Yfekk5WeRTrJkYPeFx
+  y36jFQEVvwgB5DBizRqeIo/CXYSEhrSoDM9B9P5/9j3PJQalYD2bJ9mniATEhgEO
+  M7oFge+vUrkFmKuiTRg+yshc5Ep8OcqE8yP0XtkC+/V0oDTp4f+QrScPjLaWpQID
+  AQABo3MwcTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUW2JTg6p6
+  NcAJO7zVxIDiGkssqPkwGwYDVR0RBBQwEoEQeGFiaWVyQHp1YXpvLm9yZzAbBgNV
+  HRIEFDASgRB4YWJpZXJAenVhem8ub3JnMA0GCSqGSIb3DQEBBQUAA4IBAQAgHehn
+  hmKfhEuuC+MragsxzjDwtHVUWUr53PWRIxScBplLK2jGGsKvdH2MwPCaKg7LJxg8
+  bT/UEop2tjYm4I/GTSgRzS7El6hAmhVRYxdCf/cAvIhVsvuXPARfDLaY5AFuxrGo
+  ZHu04LKaeOC8GWAdE0V+qRoW4JRQXwijki1FO99895yOwDrHW4DE5JGxVmnVd5u5
+  nGm+irqWVm/eheMHoYSnnSoUv/wR7I3PaGKjQAvx+Fb34T2e57IZk0tmGtoLXD/1
+  GlrtLc9kPO2xfj3e8Xuc1ksF21rlydki4ruAOZLg4gQX1IEFIpC8xNBfG1JuICzE
+  9n62GAx6ZNMluPmN
+  -----END CERTIFICATE-----
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -42,30 +64,30 @@ dependencies:
   name: chef
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +108,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +164,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.0
+        version: 0.47.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.0
+        version: 0.47.0
 - !ruby/object:Gem::Dependency
   name: should_not
   requirement: !ruby/object:Gem::Requirement
@@ -216,13 +238,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.9
 signing_key: 
 specification_version: 4
 summary: Chef SNS reports
 test_files:
-- test/test_chef_handler_sns.rb
+- test/test_chef_handler_sns_config.rb
 - test/helper.rb
 - test/test_chef_handler_sns_config_ohai.rb
-- test/test_chef_handler_sns_config.rb
-has_rdoc: 
+- test/test_chef_handler_sns.rb