chef-handler-sns 0.1.0

data/LICENSE

@@ -0,0 +1,201 @@
+                              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
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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,94 @@
+Description
+===========
+
+A simple Chef report handler that reports status of a Chef run through Amazon SNS.
+
+* http://wiki.opscode.com/display/chef/Exception+and+Report+Handlers
+
+Requirements
+============
+
+* Amazon AWS: uses Amazon SNS service.
+* Uses the `right_aws` library.
+
+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):
+
+    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
+=======
+
+* rspec tests.
+
+Pull requests are welcome.
+
+License and Author
+==================
+
+|                      |                                          |
+|:---------------------|:-----------------------------------------|
+| **Author:**          | Xabier de Zuazo (<xabier@onddo.com>)
+| **Copyright:**       | Copyright (c) 2013 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.rb

@@ -0,0 +1,105 @@
+#
+# Author:: Xabier de Zuazo (<xabier@onddo.com>)
+# Copyright:: Copyright (c) 2013 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.
+#
+
+require 'chef/handler'
+require 'chef/resource/directory'
+
+require 'right_aws'
+
+class Chef
+  class Handler
+    class Sns < ::Chef::Handler
+      attr_writer :access_key, :secret_key, :region, :token, :topic_arn
+  
+      def initialize(config={})
+        Chef::Log.debug("#{self.class.to_s} initialized.")
+        @access_key = config[:access_key]
+        @secret_key = config[:secret_key]
+        @region = config[:region] if config.has_key?(:region)
+        @token = config[:token] if config.has_key?(:token)
+        @topic_arn = config[:topic_arn]
+      end
+  
+      def report
+        check_config
+        Chef::Log.debug("#{self.class.to_s} reporting.")
+        sns.publish(@topic_arn, sns_body, sns_subject)
+      end
+  
+      protected
+  
+      def check_config
+        Chef::Log.debug("#{self.class.to_s} checking handler configuration.")
+        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?
+      end
+
+      def sns
+        params = {
+          :logger => Chef::Log,
+          :region => @region || node.ec2.placement_availability_zone.chop
+        }
+        params[:token] = @token if @token
+        @@sns ||= RightAws::SnsInterface.new(@access_key, @secret_key, params)
+      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}"
+      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
+      end
+  
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+class Chef
+  class Handler
+    class Sns
+      VERSION = '0.1.0'
+    end
+  end
+end
+

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: chef-handler-sns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Onddo Labs, SL.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: right_aws
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Chef report handler to send SNS notifications on failures or changes
+email: team@onddo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/chef/handler/sns/version.rb
+- lib/chef/handler/sns.rb
+homepage: http://github.com/onddo/chef-handler-sns
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Chef SNS reports
+test_files: []