bq-chef-handler-sns 4.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97fe10733493f0533ffbf2fcbe075baa737286ab6b550249dc8b033fce5be73d
+  data.tar.gz: fec354d7e472c987c6ae244a6c20d356cc3693153fcb208abbe8798c097655a1
+SHA512:
+  metadata.gz: 6f84e6935790b6f200144069fa375945129290c65edb73c124dbe39a44a9ab461b3efa1714c16d489ae2e5691982381a23e45758a233522d22291b3a65382173
+  data.tar.gz: 4ad13830db3694708ba1b6f09deab53db1dff8181c9381fe9dd9f4b758aec8e42b706b54c600d5c52028f77df02654eb14fe401064a8642a466b38d73993bfef

data/LICENSE

@@ -0,0 +1,190 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+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.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,354 @@
+# 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)
+[![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.svg?style=flat)](https://travis-ci.org/zuazo/chef-handler-sns)
+[![Coverage Status](http://img.shields.io/coveralls/zuazo/chef-handler-sns.svg?style=flat)](https://coveralls.io/r/zuazo/chef-handler-sns?branch=master)
+[![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](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.
+
+* https://docs.chef.io/handlers.html#exception-report-handlers
+
+## Requirements
+
+* Amazon AWS: uses Amazon SNS service.
+* Ruby `2` or higher (recommended `2.1` or higher).
+
+## Usage
+
+You can install this handler in two ways:
+
+### Method 1: in the Chef Config File
+
+You can install the RubyGem and configure Chef to use it:
+
+    $ 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'
+
+# 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
+
+**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](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:***'
+]
+
+# Install the `chef-handler-sns` RubyGem during the compile phase
+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 'chef/handler/sns'
+  arguments argument_array
+  supports exception: true
+  action :enable
+end
+```
+
+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.
+
+### 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' => {
+    access_key: '***AMAZON-KEY***',
+    secret_key: '***AMAZON-SECRET***',
+    topic_arn: 'arn:aws:sns:***'
+  }.map { |k, v| "#{k}: #{v.inspect}" }
+}]
+```
+
+### 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:
+
+#### 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
+
+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'
+
+exception_handlers << Chef::Handler::Sns.new(
+  topic_arn: 'arn:aws:sns:us-east-1:12341234:MyTopicName'
+)
+```
+
+#### IAM Roles Method 2: in a Recipe with the `chef_handler` LWRP
+
+Use the [`chef_handler` LWRP](https://supermarket.chef.io/cookbooks/chef_handler), creating a recipe with the following:
+
+```ruby
+# Install the `chef-handler-sns` RubyGem during the compile phase
+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 '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: %w(deploy configure)
+]
+```
+
+## Handler Configuration Options
+
+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.
+* `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).
+* `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`.
+
+### `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' %>"
+)
+```
+
+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' %>"
+  # [...]
+]
+
+chef_handler 'Chef::Handler::Sns' do
+  # [...]
+  arguments argument_array
+end
+```
+
+The following variables are accessible inside the template:
+
+* `start_time` - The time the chef run started.
+* `end_time` - The time the chef run ended.
+* `elapsed_time` - The time elapsed between the start and finish of the chef run.
+* `run_context` - The Chef::RunContext object used by the chef run.
+* `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 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` Configuration Option
+
+This configuration option needs to contain the full path of an Erubis template. For example:
+
+```ruby
+# recipe 'myapp::sns_handler'
+
+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'
+  # [...]
+]
+
+chef_handler 'Chef::Handler::Sns' do
+  # [...]
+  arguments argument_array
+end
+```
+
+```erb
+<%# file 'myapp/files/default/chef_handler_sns_body.erb' %>
+
+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') -%>
+Instance Id: <%= node.ec2.instance_id %>
+Instance Public Hostname: <%= node.ec2.public_hostname %>
+Instance Hostname: <%= node.ec2.hostname %>
+Instance Public IPv4: <%= node.ec2.public_ipv4 %>
+Instance Local IPv4: <%= node.ec2.local_ipv4 %>
+<% 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 -%>
+```
+
+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.
+
+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
+```
+
+## Testing
+
+See [TESTING.md](https://github.com/zuazo/chef-handler-sns/blob/master/TESTING.md).
+
+## Contributing
+
+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@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
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+    
+        http://www.apache.org/licenses/LICENSE-2.0
+    
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+    

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

@@ -0,0 +1,130 @@
+#
+# Author:: Xabier de Zuazo (<xabier@zuazo.org>)
+# Copyright:: Copyright (c) 2015 Xabier de Zuazo
+# Copyright:: Copyright (c) 2014 Onddo Labs, SL.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+class Chef
+  class Handler
+    class Sns < ::Chef::Handler
+      module Config
+        #
+        # Gets Chef Handler SNS default configuration from
+        # [Ohai](https://docs.chef.io/ohai.html) information.
+        #
+        class Ohai
+          #
+          # AWS region name.
+          #
+          # Not used, read from the topic ARN.
+          #
+          # @return [String] Region.
+          #
+          attr_reader :region
+
+          #
+          # AWS access key.
+          #
+          # @return [String] Access key.
+          #
+          attr_reader :access_key
+
+          #
+          # AWS secret key.
+          #
+          # @return [String] Secret key.
+          #
+          attr_reader :secret_key
+
+          #
+          # AWS token.
+          #
+          # @return [String] token.
+          #
+          attr_reader :token
+
+          #
+          # Constructs a {Chef::Handler::Sns::Config::Ohai} object.
+          #
+          # @param node [Chef::Node] Node object to read Ohai information from.
+          #
+          # @api public
+          #
+          def initialize(node)
+            read_config(node)
+          end
+
+          protected
+
+          #
+          # Reads AWS region information from Ohai.
+          #
+          # Old code. This is currently not used. We are reading region
+          # information from Topic ARN.
+          #
+          # @param ec2 [Hash] These are attributes below `node['ec2']`.
+          #
+          # @return void
+          #
+          # @api private
+          #
+          def read_region_config(ec2)
+            return unless ec2.attribute?('placement_availability_zone') &&
+                          ec2['placement_availability_zone'].is_a?(String)
+            @region = ec2['placement_availability_zone'].chop
+          end
+
+          #
+          # Reads the IAM credentials from Ohai.
+          #
+          # @param ec2 [Hash] These are attributes below `node['ec2']`.
+          #
+          # @return void
+          #
+          # @api private
+          #
+          def read_iam_config(ec2)
+            return unless ec2.attribute?('iam') &&
+                          ec2['iam'].attribute?('security-credentials')
+            _iam_role, credentials =
+              ec2['iam']['security-credentials'].to_hash.first
+            return if credentials.nil?
+            @access_key = credentials['AccessKeyId']
+            @secret_key = credentials['SecretAccessKey']
+            @token = credentials['Token']
+          end
+
+          #
+          # Reads configuration information from Ohai.
+          #
+          # Reads both region information and IAM credentials.
+          #
+          # @param node [Chef::Node] Node object to read information from.
+          #
+          # @return void
+          #
+          # @api private
+          #
+          def read_config(node)
+            return unless node.attribute?('ec2')
+            read_region_config(node['ec2'])
+            read_iam_config(node['ec2'])
+          end
+        end
+      end
+    end
+  end
+end