chef-handler-s3 0.1.0

data/LICENSE

@@ -0,0 +1,176 @@
+                              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

data/README.md

@@ -0,0 +1,60 @@
+Description
+===========
+
+A Chef Exception & Reporting Handler for storing reports at [S3](http://aws.amazon.com/s3).
+
+The gem install a exception/report handler for Chef that create a local simplified JSON report and then upload it to a S3 bucket.
+
+This Chef Exception & Reporting Handler gem is heavily based on the [Campfire's one](https://github.com/ampledata/chef-handler-campfire) and the Chef's JsonFile handler.
+
+Usage
+=====
+
+1. Create a [Amazon S3](http://aws.amazon.com/s3) account.
+2. Retrieve your **ACCESS_KEY_ID** and your **SECRET_ACCESS_KEY**.
+3. Create a bucket.
+4. Download the [chef_handler](http://community.opscode.com/cookbooks/chef_handler)
+Cookbook.
+5. Given you've retrieved your S3 **ACCESS_KEY_ID** as `:access_key_id`, your **SECRET_ACCESS_KEY** as `:secret_access_key` and the bucket name as `:bucket_name`, add a Recipe similar to the example below:
+
+```ruby
+include_recipe "chef_handler::default"
+
+%w{libxml2-dev libxslt1-dev}.each do |pkg|
+  package pkg do
+    action :nothing
+  end.run_action(:install)
+end
+
+chef_gem 'aws-sdk'
+chef_gem "chef-handler-s3"
+gem "chef-handler-s3"
+
+chef_handler 'Chef::Handler::S3' do
+  source 'chef/handler/s3'
+  arguments :access_key_id     => 'XXXXXXXXXXXXX',
+            :secret_access_key => 'XXXXXXXXXXXXX',
+            :bucket_name       => 'some_bucket_name',
+            :folder            => 'some_bucket_folder_name'
+  action :enable
+end
+```
+
+The argument `:folder` is optional. This will store the file inside of a folder with that name at the pointed bucket.
+
+See also: [Enable Chef Handler with LWRP](http://wiki.opscode.com/display/chef/Distributing+Chef+Handlers#DistributingChefHandlers-EnabletheChefHandlerwiththe%7B%7Bchefhandler%7D%7DLWRP)
+
+
+Authors
+============
+1. [Juanje Ojeda](https://github.com/juanje)
+
+
+Copyright
+=========
+Copyright 2012 Wantudu
+
+
+License
+=======
+Apache License 2.0

data/lib/chef/handler/s3.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# Chef Exception & Reporting Handler for storing reports at S3.
+#
+# Author:: Juanje Ojeda <juanje.ojeda@gmail.com>
+# Copyright:: Copyright 2012 Wantudu.
+# License:: Apache License 2.0
+#
+
+require 'rubygems'
+require 'chef/handler'
+require 'aws-sdk'
+
+class Chef
+  class Handler
+    class S3 < ::Chef::Handler
+      VERSION = '0.1.0'
+
+      attr_reader :config
+
+      def initialize(config={})
+        @config = config
+        @config[:path] ||= "/var/chef/reports"
+        @config
+      end
+
+      def upload_file(file_path)
+        bucket_name = config[:bucket_name]
+        file_name = File.basename(file_path)
+
+        AWS.config(
+          :access_key_id => config[:access_key_id],
+          :secret_access_key => config[:secret_access_key]
+        )
+
+        s3 = AWS::S3.new
+        if s3.buckets[bucket_name].exists?
+          bucket = s3.buckets[bucket_name]
+        else
+          bucket = s3.buckets.create(bucket_name)
+        end
+
+        if config.include? :folder
+          key = "#{config[:folder]}/#{file_name}"
+        else
+          key = file_name
+        end
+
+        bucket.objects[key].write(:file => file_path)
+        Chef::Log.info("Uploading file #{file_name} to bucket #{bucket_name}.")
+      end
+
+      def report
+        run_data = Hash.new
+        if run_status.failed?
+          Chef::Log.error("Creating JSON exception report")
+          run_data[:formatted_exception] = run_status.formatted_exception
+          run_data[:exception] = run_status.exception
+          run_data[:backtrace] = run_status.backtrace
+        else
+          Chef::Log.info("Creating JSON run report")
+        end
+
+        build_report_dir
+
+        savetime = Time.now.strftime("%Y%m%d%H%M%S")
+        run_data[:name] = node.name
+        run_data[:fqdn] = node.fqdn
+        run_data[:success] = run_status.success?
+        run_data[:start_time] = run_status.start_time
+        run_data[:end_time] = run_status.end_time
+        run_data[:duration] = run_status.elapsed_time
+        run_data[:updated_resources] = []
+        run_status.updated_resources.each do |resource|
+          run_data[:updated_resources] << {
+            :name     => resource.name,
+            :kind     => resource.resource_name,
+            :provider => resource.provider,
+            :action   => resource.action
+          }
+        end
+
+        if node.include? :cloud
+          run_data[:ipaddress] = node.cloud.public_ipv4
+        else
+          run_data[:ipaddress] = node.ipaddress
+        end
+
+        file_path = File.join(config[:path], "#{node.name}-#{savetime}.json")
+        File.open(file_path, "w") do |file|
+          file.puts Chef::JSONCompat.to_json_pretty(run_data)
+        end
+
+        upload_file(file_path)
+      end
+
+      def build_report_dir
+        unless File.exists?(config[:path])
+          FileUtils.mkdir_p(config[:path])
+          File.chmod(00700, config[:path])
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: chef-handler-s3
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Juanje Ojeda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: &87386120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *87386120
+description: Allows storing reports of Chef Exceptions to S3.
+email: juanje.ojeda@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/chef/handler/s3.rb
+homepage: https://github.com/juanje/chef-handler-s3
+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.10
+signing_key: 
+specification_version: 3
+summary: Chef Exception & Reporting Handler for storing reports at S3
+test_files: []