chef-email-reporter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecd2e1f89e9c4a81506e32e576ece2e5bdd24e43
+  data.tar.gz: facbf38e40d4c6e6eef044b55bbc92f25d61b917
+SHA512:
+  metadata.gz: 61bd53976a9dd62e4d7ee3866d11ea5badfda55c0cdcc986c441ded19f3ccfb32b8f5658582e68570b7c897065745f01b3d202cc69d87a116ce791285cfef540
+  data.tar.gz: 472fdefc7fc829bb6f5ae4f1fc269bd3e16dffa6d3bcfc13b74bd998f2977c277dde7d7c172b606e6c38c2d58da3887982c2f1055688297b25cedbad32801661

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chef-email-reporter.gemspec
+gemspec

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,193 @@
+# chef-email-reporter
+
+This gem extends the Chef client, allowing notifications to be sent via email
+to a pre-determined address when a chef-client run fails on a node.  This gives
+administrators the confidence that errors on Chef nodes won't go unnoticed.
+
+While it is possible to do this with a simple handler (see
+http://docs.getchef.com/handlers.html), one typically only receives the text of
+the exception with a handler.  `chef-email-reporter` provides information
+identical to what one would receive when running chef-client at the terminal:
+the exception, the resource declaration, and the compiled resource.  See below
+for a sample email sent by `chef-email-reporter`.
+
+insert image here.
+
+Having this additional information can ease troubleshooting for administrators.
+
+## Installation
+
+Install the `chef-email-reporter` gem on the node:
+
+```
+/opt/chef/embedded/bin/gem install chef-email-reporter
+```
+
+Add something like the following to your `/etc/chef/client.rb` file (see the
+**Usage** section below for more details):
+
+```
+gem     "chef-email-reporter"
+require "chef-email-reporter"
+
+Mail.defaults do
+  delivery_method :smtp, address: 'smtp.example.com'
+end
+
+email_sender    "no.reply@example.com"
+email_recipient "chef-notifications@example.com"
+```
+
+Profit.
+
+## Usage
+
+Assuming you have already installed `chef-email-reporter` on your node, you must
+activate it by adding the following to your `/etc/chef/client.rb` file:
+
+```
+gem     "chef-email-reporter"
+require "chef-email-reporter"
+```
+
+You should also specify the sender and recipient email addresses for
+notifications sent by `chef-email-reporter`:
+
+```
+email_sender    "no.reply@example.com"
+email_recipient "chef-notifications@example.com"
+```
+
+Finally, depending on how you want your mail delivered, you may need to specify
+some settings for `Mail.defaults`.  See the examples below for an idea of what
+is possible.
+
+### Examples
+
+`chef-email-reporter` uses the `mail` gem to deliver email, so any delivery
+methods supported by `mail` are supported.  For full details, see the 
+documentation at https://github.com/mikel/mail.  Since the documentation is
+lacking slightly, you are advised to have a look in the comments in the files at
+https://github.com/mikel/mail/tree/master/lib/mail/network/delivery_methods.
+
+#### Sending email via SMTP
+
+Add the following to `/etc/chef/client.rb`:
+
+```ruby
+gem     "chef-email-reporter"
+require "chef-email-reporter"
+
+Mail.defaults do
+  delivery_method :smtp, {
+    :address              => "smtp.example.com",
+    :port                 => 25,
+    :domain               => "example.com",
+    :user_name            => "jeff",
+    :password             => "secret",
+    :authentication       => "plain",
+    :enable_starttls_auto => true
+  }
+end
+
+email_sender    "no.reply@example.com"
+email_recipient "chef-notifications@example.com"
+```
+
+Examples for sending email via Gmail and Amazon SES are provided in the wiki
+for the `mail` gem:
+
+* Gmail: https://github.com/mikel/mail/wiki/Sending-email-via-Gmail-SMTP
+* Amazon SES: https://github.com/mikel/mail/wiki/Sending-email-via-Amazon-SES
+
+#### Sending email via `sendmail`
+
+```ruby
+gem     "chef-email-reporter"
+require "chef-email-reporter"
+
+Mail.defaults do
+  delivery_method :sendmail
+end
+
+email_sender    "no.reply@example.com"
+email_recipient "chef-notifications@example.com"
+```
+
+If your `sendmail` binary is not located at `/usr/sbin/sendmail`, you can
+specify its location as an argument:
+
+```ruby
+Mail.defaults do
+  delivery_method :sendmail, :location => '/absolute/path/to/your/sendmail'
+end
+```
+
+#### Sending email via `exim`
+
+```ruby
+gem     "chef-email-reporter"
+require "chef-email-reporter"
+
+Mail.defaults do
+  delivery_method :exim
+end
+
+email_sender 'no.reply@example.com'
+email_recipient 'chef-notifications@example.com'
+```
+
+If your `exim` binary is not located at `/usr/sbin/exim`, you can specify its
+location as an argument:
+
+```ruby
+Mail.defaults do
+  delivery_method :exim, :location => '/absolute/path/to/your/exim'
+end
+```
+
+## Integrating the gem into your workflow
+
+One might wonder how to integrate into one's workflow.  While the method of
+integration will vary from deployment to deployment, I will briefly discuss how
+I've integrated it into mine.
+
+In my organization, I've configured bare-metal deployment via Razor Server
+(https://github.com/puppetlabs/razor-server).  After Razor deploys the operating
+system, it runs a script on the node which:
+
+* Installs Chef
+* Installs the `chef-email-reporter` gem
+* Writes a basic `/etc/chef/config.rb`
+* Runs `chef-client` to register and configure the node
+
+Of course, you don't need to be running Razor Server to use this gem.  Simply
+have whichever bare-metal deployment solution you're running install the gem and
+configure `/etc/chef/config.rb`.  If you're not running a bare-metal deployment
+solution, then you'll simply have to perform these steps manually.
+
+## Contributing
+
+1. Fork it (https://github.com/jeffshantz/chef-email-reporter/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+```
+Copyright 2014, Jeff Shantz
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/chef-email-reporter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chef-email-reporter/version'
+
+Gem::Specification.new do |spec|
+  spec.name             = "chef-email-reporter"
+  spec.version          = ChefEmailReporter::VERSION
+  spec.authors          = ["Jeff Shantz"]
+  spec.email            = ["jeff@csd.uwo.ca"]
+  spec.summary          = %q{Sends chef-client errors via email.}
+  spec.description      = %q{Sends chef-client errors via email.  More detailed than a simple chef_handler.}
+  spec.homepage         = "http://jeffshantz.github.io/chef-email-reporter"
+  spec.license          = "Apache 2.0"
+
+  spec.files            = `git ls-files -z`.split("\x0")
+  spec.executables      = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files       = spec.files.grep(%r{^(test|spec|features)/})
+  spec.extra_rdoc_files = ["README.md", "LICENSE"]
+  spec.require_paths    = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 0"
+
+  spec.add_dependency "chef", "~> 11.14"
+  spec.add_dependency "mail", "~> 2.6"
+end

data/lib/chef-email-reporter/formatters/multipart_output_stream.rb

@@ -0,0 +1,200 @@
+# Copyright 2014, Jeff Shantz
+# 
+# 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.
+
+# Based on Chef::Formatters::IndentableOutputStream, which is packaged with the
+# chef gem.
+
+require 'stringio'
+require 'cgi'
+
+module ChefEmailReporter
+
+  module Formatters
+    
+    # Handles basic indentation and colorization tasks
+    class MultipartOutputStream
+
+      attr_accessor :indent
+      attr_reader :line_started
+      attr_accessor :current_stream
+      attr_reader :semaphore
+
+      def initialize
+        @text_stream = StringIO.new
+        @html_stream = StringIO.new
+        @indent = 0
+        @line_started = false
+        @semaphore = Mutex.new
+      end
+
+      def text_part
+        @text_stream.rewind
+        @text_stream.read
+      end
+
+      def html_part
+        @html_stream.rewind
+        @html_stream.read
+      end
+
+      # Print text.  This will start a new line and indent if necessary
+      # but will not terminate the line (future print and puts statements
+      # will start off where this print left off).
+      def color(string, *args)
+        print(string, from_args(args))
+      end
+
+      # Print the start of a new line.  This will terminate any existing lines and
+      # cause indentation but will not move to the next line yet (future 'print'
+      # and 'puts' statements will stay on this line).
+      def start_line(string, *args)
+        print(string, from_args(args, :start_line => true))
+      end
+
+      # Print a line.  This will continue from the last start_line or print,
+      # or start a new line and indent if necessary.
+      def puts(string, *args)
+        print(string, from_args(args, :end_line => true))
+      end
+
+      # Print an entire line from start to end.  This will terminate any existing
+      # lines and cause indentation.
+      def puts_line(string, *args)
+        print(string, from_args(args, :start_line => true, :end_line => true))
+      end
+
+      # Print a string.
+      #
+      # == Arguments
+      # string: string to print.
+      # options: a hash with these possible options:
+      # - :stream => OBJ: unique identifier for a stream. If two prints have
+      #           different streams, they will print on separate lines.
+      #           Otherwise, they will stay together.
+      # - :start_line => BOOLEAN: if true, print will begin on a blank (indented) line.
+      # - :end_line => BOOLEAN: if true, current line will be ended.
+      # - :name => STRING: a name to prefix in front of a stream. It will be printed
+      #           once (with the first line of the stream) and subsequent lines
+      #           will be indented to match.
+      #
+      # == Alternative
+      #
+      # You may also call print('string', :red) (a list of colors a la Highline.color)
+
+      def print(string, *args)
+        options = from_args(args)
+
+        # Make sure each line stays a unit even with threads sending output
+        semaphore.synchronize do
+          if should_start_line?(options)
+            move_to_next_line
+          end
+
+          print_string(string, options)
+
+          if should_end_line?(options)
+            move_to_next_line
+          end
+        end
+      end
+
+      private
+
+      def should_start_line?(options)
+        options[:start_line] || @current_stream != options[:stream]
+      end
+
+      def should_end_line?(options)
+        options[:end_line] && @line_started
+      end
+
+      def from_args(colors, merge_options = {})
+        if colors.size == 1 && colors[0].kind_of?(Hash)
+          merge_options.merge(colors[0])
+        else
+          merge_options.merge({ :colors => colors })
+        end
+      end
+
+      def print_string(string, options)
+        if string.empty?
+          if options[:end_line]
+            print_line('', options)
+          end
+        else
+          string.lines.each do |line|
+            print_line(line, options)
+          end
+        end
+      end
+
+      def escape(line)
+        CGI::escapeHTML(line)
+      end
+
+      def print_line(line, options)
+        indent_line(options)
+
+        # Note that the next line will need to be started
+        if line[-1..-1] == "\n"
+          @line_started = false
+        end
+
+        if ::Chef::Config[:color] && options[:colors] && ! options[:colors].empty?
+          @html_stream.print %{<span style="color: #{options[:colors].first}">#{escape(line)}</span>}
+          @text_stream.print line
+        else
+          @html_stream.print escape(line)
+          @text_stream.print line
+        end
+      end
+
+      def move_to_next_line
+        if @line_started
+          @html_stream.puts ''
+          @text_stream.puts ''
+          @line_started = false
+        end
+      end
+
+      def indent_line(options)
+        if !@line_started
+
+          # Print indents.  If there is a stream name, either print it (if we're
+          # switching streams) or print enough blanks to match
+          # the indents.
+          if options[:name]
+            if @current_stream != options[:stream]
+              msg = "#{(' ' * indent)}[#{options[:name]}] "
+            else
+              msg = ' ' * (indent + 3 + options[:name].size)
+            end
+            @html_stream.print msg
+            @text_stream.print msg
+          else
+            # Otherwise, just print indents.
+            @html_stream.print ' ' * indent
+            @text_stream.print ' ' * indent
+          end
+
+          if @current_stream != options[:stream]
+            @current_stream = options[:stream]
+          end
+
+          @line_started = true
+        end
+      end
+    end
+  end
+end

data/lib/chef-email-reporter/handlers/email_handler.rb

@@ -0,0 +1,32 @@
+# Copyright 2014, Jeff Shantz
+# 
+# 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'
+
+module ChefEmailReporter
+
+  module Handlers
+
+    class EmailHandler < ::Chef::Handler
+
+      def report
+        email_reporter = ChefEmailReporter::Reporters::EmailReporter.new
+        @run_status.events.register(email_reporter)
+      end
+
+    end
+
+  end
+
+end

data/lib/chef-email-reporter/reporters/email_reporter.rb

@@ -0,0 +1,102 @@
+# Copyright 2014, Jeff Shantz
+# 
+# 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/event_dispatch/base'
+require 'chef/formatters/error_mapper'
+require 'erb'
+require 'mail'
+require 'ostruct'
+
+module ChefEmailReporter
+
+  module Reporters
+
+    class EmailReporter < ::Chef::EventDispatch::Base
+
+      def initialize
+        @errors = []
+      end
+
+      def run_started(run_status)
+        @run_status = run_status
+      end
+
+      def run_failed(exception)
+
+        error_description = ::ChefEmailReporter::Formatters::MultipartOutputStream.new
+
+        @errors.each do |desc|
+          desc.display(error_description)
+        end
+
+        namespace = OpenStruct.new({
+          node_name: @run_status.node[:name],
+          node_fqdn: @run_status.node[:fqdn],
+          run_id: @run_status.run_id,
+          start_time: @run_status.start_time
+        })
+
+        namespace.error = error_description.text_part
+        text_template = File.read(File.expand_path("../../templates/email.text.erb", __FILE__))
+        text_body = ERB.new(text_template).result(namespace.instance_eval { binding })
+
+        namespace.error = error_description.html_part
+        html_template = File.read(File.expand_path("../../templates/email.html.erb", __FILE__))
+        html_body = ERB.new(html_template).result(namespace.instance_eval { binding })
+
+        subject_line = "chef-client run failed (#{@run_status.node[:fqdn]})"
+
+        Mail.deliver do
+
+          from    ::Chef::Config[:email_sender]
+          to      ::Chef::Config[:email_recipient]
+          subject subject_line
+
+          text_part do
+            body text_body
+          end
+
+          html_part do
+            body html_body
+          end
+
+        end
+
+      end
+
+      def resource_failed(new_resource, action, exception)
+        description = ::Chef::Formatters::ErrorMapper.resource_failed(new_resource, action, exception)
+        @errors << description
+      end
+
+      def run_list_expand_failed(node, exception)
+        description = ::Chef::Formatters::ErrorMapper.run_list_expand_failed(node, exception)
+        @errors << description
+      end
+
+      def cookbook_resolution_failed(expanded_run_list, exception)
+        description = ::Chef::Formatters::ErrorMapper.cookbook_resolution_failed(expanded_run_list, exception)
+        @errors << description
+      end
+
+      def cookbook_sync_failed(cookbooks, exception)
+        description = ::Chef::Formatters::ErrorMapper.cookbook_sync_failed(cookbooks, exception)
+        @errors << description
+      end
+
+    end
+
+  end
+
+end

data/lib/chef-email-reporter/templates/email.html.erb

@@ -0,0 +1,71 @@
+<%#
+  # Copyright 2014, Jeff Shantz
+  # 
+  # 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.
+%>
+<html>
+  <head>
+    <style>
+      @import url(http://fonts.googleapis.com/css?family=Droid+Sans+Mono:400|Droid+Sans:400,700);
+      h1 {
+        font-family: 'Droid Sans', sans-serif;
+        color: #444;
+        font-size: 24px;
+        padding-bottom: 5px;
+        border-bottom: 1px solid black;
+        margin-bottom: 5px;
+      }
+
+      h2 {
+        font-family: 'Droid Sans', sans-serif;
+        color: #444;
+        font-size: 18px;
+        padding-bottom: 5px;
+        margin-bottom: 5px;
+      }
+
+      pre {
+        background: #001e27;
+        color: #708284;
+      }
+
+      pre code {
+        font-family: 'Droid Sans Mono', monospace;
+      }
+
+      tr td:first-child {
+        text-align: right
+      }
+
+      tr td:nth-child(2) {
+        padding-left: 5px;
+      }
+    </style>
+    <body>
+      <h1>An error occurred during a chef-client run.</h1>
+      <h2>Metadata</h2>
+      <table>
+        <tr>
+          <td>Hostname:</td>
+          <td><%= node_fqdn %></td>
+        </tr>
+        <tr>
+          <td>Run Start:</td>
+          <td><%= start_time %></td>
+        </tr>
+      </table>
+      <h2>Error</h2>
+      <pre><code><%= error %></code></pre>
+    </body>
+  </head>
+</html>

data/lib/chef-email-reporter/templates/email.text.erb

@@ -0,0 +1,27 @@
+<%#
+  # Copyright 2014, Jeff Shantz
+  # 
+  # 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.
+%>
+An error occurred during a chef-client run.
+
+Metadata
+========
+
+  Hostname: <%= node_fqdn %>
+  Run Start: <%= start_time %>
+
+Error
+=====
+
+<%= error %>

data/lib/chef-email-reporter/version.rb

@@ -0,0 +1,17 @@
+# Copyright 2014, Jeff Shantz
+# 
+# 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.
+
+module ChefEmailReporter
+  VERSION = "0.0.1"
+end

data/lib/chef-email-reporter.rb

@@ -0,0 +1,31 @@
+# Copyright 2014, Jeff Shantz
+# 
+# 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-email-reporter/formatters/multipart_output_stream'
+require 'chef-email-reporter/handlers/email_handler'
+require 'chef-email-reporter/reporters/email_reporter'
+require 'chef-email-reporter/version'
+
+module ChefEmailReporter
+end
+
+class Chef
+  class Config
+    default :email_sender, 'no.reply@example.com'
+    default :email_recipient, nil
+  end
+end
+
+::Chef::Config.start_handlers << ChefEmailReporter::Handlers::EmailHandler.new
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: chef-email-reporter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeff Shantz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.14'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Sends chef-client errors via email.  More detailed than a simple chef_handler.
+email:
+- jeff@csd.uwo.ca
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- chef-email-reporter.gemspec
+- lib/chef-email-reporter.rb
+- lib/chef-email-reporter/formatters/multipart_output_stream.rb
+- lib/chef-email-reporter/handlers/email_handler.rb
+- lib/chef-email-reporter/reporters/email_reporter.rb
+- lib/chef-email-reporter/templates/email.html.erb
+- lib/chef-email-reporter/templates/email.text.erb
+- lib/chef-email-reporter/version.rb
+homepage: http://jeffshantz.github.io/chef-email-reporter
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Sends chef-client errors via email.
+test_files: []