exception_mailer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a946a173c95b3e0838cf08501f8718a9169d981d
+  data.tar.gz: 7b95885a16e8d102855cbbfe272cfb1b76b30b08
+SHA512:
+  metadata.gz: 7030cd4c58cc19749824fca4dd7148af7b16b2e3e613eb60dbd35f1ad9710b6b4be2b6833853029da48910606c91b4b7a841808f549fc36286742674e97f551e
+  data.tar.gz: 23c79a72ba78511e96bdc3fd48b4d51dd4b88923174aa3750377386bb6ffa5925baadc7381cb63f6044de75cfae59ac76f647fa1c315caaf590558731da0b5e2

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tyler Hartland
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# Exception Mailer
+
+Send an email in response to uncaught exceptions
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'exception_mailer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exception_mailer
+
+## Usage
+Uses http://www.ruby-doc.org/stdlib-2.1.1/libdoc/net/smtp/rdoc/Net/SMTP.html
+```
+ExceptionMailer.mail_exceptions do
+  # code that may raise an exception
+end
+```
+```
+include ExceptionMailer
+
+mail_exceptions do
+  # code that may raise an exception
+end
+```
+Oops, don't forget config!
+```
+ExceptionMailer.configure do |c|
+  c.server = 'your.smtp.server' # defaults to 'localhost'
+  c.port = 25 # defaults to this value
+  c.host = 'your.hostname'
+  c.account = 'your@smtp.account'
+  c.password = ENV['SMTP_PASSWORD'] # or load it from a file -- hardcoded passwords are bad, mmkay?
+  c.auth_method = :plain # or :login or :cram_md5
+
+  c.from = 'from' # defaults to 'ExceptionMailer'
+  c.to = [ 'one@destination.address', 'another@to.address' ] # or a single string
+  c.subject = 'your subject line' # defaults to 'Exception Occurred'
+end
+```
+All of the above options can be overridden for a specific block
+```
+mail_exceptions(to: 'mom@msn.net', subject: 'Hi Mom!') do
+  # code that raises exceptions your mom wants to see
+end
+```
+The message body will look kind of like this:
+```
+RuntimeError: hi
+(irb):6:in `block in irb_binding'
+/Users/tyler.hartland/dev/exception_mailer/lib/exception_mailer.rb:12:in `mail_exceptions'
+(irb):6:in `irb_binding'
+/Users/tyler.hartland/.rvm/rubies/ruby-2.1.1/lib/ruby/2.1.0/irb/workspace.rb:86:in `eval'
+...
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/exception_mailer/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 new Pull Request

data/Rakefile

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

data/exception_mailer.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "exception_mailer"
+  spec.version       = `cat version`.chomp
+  spec.authors       = ["Tyler Hartland"]
+  spec.email         = ["tylerhartland7@gmail.com"]
+  spec.summary       = 'Simple email notification of uncaught exceptions'
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/exception_mailer.rb

@@ -0,0 +1,27 @@
+require 'exception_mailer/mailer'
+
+module ExceptionMailer
+  class << self
+    attr_accessor :host, :server, :port, :account, :password, :to, :from, :subject, :auth_method
+
+    def configure
+      yield self
+    end
+
+    def mail_exceptions(opts={})
+      yield
+    rescue Exception => e
+      Mailer.new(opts).send_notification(e)
+      raise e
+    end
+  end
+
+  self.server  = 'localhost'
+  self.port    = 25
+  self.from    = 'ExceptionMailer'
+  self.subject = 'Exception Occurred'
+
+  def mail_exceptions(opts={}, &block)
+    ExceptionMailer.mail_exceptions(opts, &block)
+  end
+end

data/lib/exception_mailer/mailer.rb

@@ -0,0 +1,63 @@
+require 'net/smtp'
+
+module ExceptionMailer
+  class Mailer
+    attr_reader :host, :server, :port, :account, :password, :to, :from, :subject
+
+    def initialize(opts)
+      @host        = opts[:host]        || ExceptionMailer.host
+      @server      = opts[:server]      || ExceptionMailer.server
+      @port        = opts[:port]        || ExceptionMailer.port
+      @account     = opts[:account]     || ExceptionMailer.account
+      @password    = opts[:password]    || ExceptionMailer.password
+      @auth_method = opts[:auth_method] || ExceptionMailer.auth_method
+      @to          = opts[:to]          || ExceptionMailer.to
+      @from        = opts[:from]        || ExceptionMailer.from
+      @subject     = opts[:subject]     || ExceptionMailer.subject
+
+      @to = [ @to ] unless @to.kind_of? Array
+    end
+
+    def send_notification(exception)
+      Net::SMTP.start(*start_args) do |smtp|
+        smtp.send_message(build_msg(exception), from, *to)
+      end
+    end
+
+    private
+
+    def start_args
+      [ :server, :port, :host, :account, :password, :auth_method ].inject([]) do |args, arg|
+        return args if send(arg).nil?
+        args << send(arg)
+      end
+    end
+
+    def build_msg(exception)
+      <<-END_OF_MESSAGE
+From: <#{from}>
+#{to.map { |t| "To: <#{t}>" }.join("\n") }
+Subject: #{subject}
+Date: #{now}
+Message-Id: <#{msg_id}>
+
+#{body(exception)}
+      END_OF_MESSAGE
+    end
+
+    def body(exception)
+      [
+        "#{exception.class}: #{exception.message}",
+        "#{exception.backtrace.join("\n")}"
+      ].join("\n")
+    end
+
+    def msg_id
+      rand(1_000_000_000)
+    end
+
+    def now
+      Time.now
+    end
+  end
+end

data/spec/lib/exception_mailer/mailer_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'exception_mailer/mailer'
+include ExceptionMailer
+
+describe Mailer do
+  let(:mailer) { Mailer.new(
+    host: 'test host',
+    server: 'test server',
+    port: 'test port',
+    to: 'test to',
+    from: 'test from',
+    subject: 'test subject'
+    )
+  }
+
+  describe '#send_notification' do
+    let(:exception) { Exception.new 'a test exception' }
+    let(:smtp) { double(send_message: nil) }
+    let(:expected_host) { 'test host' }
+    let(:expected_server) { 'test server' }
+    let(:expected_port) { 'test port' }
+    let(:expected_message) { "From: <test from>\nTo: <test to>\nSubject: test subject\nDate: 2014-04-29 12:44:59 -0500\nMessage-Id: <1>\n\nException: a test exception\ntest\nbacktrace\n" }
+    let(:expected_from) { 'test from' }
+    let(:expected_to) { 'test to' }
+
+    before do
+      exception.set_backtrace([ 'test', 'backtrace' ])
+      mailer.stub(:now).and_return(Time.new(2014, 4, 29, 12, 44, 59, '-05:00'))
+      mailer.stub(:msg_id).and_return(1)
+    end
+
+    it 'passes server and port to Net::SMTP.start' do
+      expect(Net::SMTP).to receive(:start).with(expected_server, expected_port, expected_host)
+      mailer.send_notification(exception)
+    end
+
+    it 'builds the expected message' do
+      expect(Net::SMTP).to receive(:start).and_yield(smtp)
+      expect(smtp).to receive(:send_message) do |msg, from, to|
+        expect(msg).to eq expected_message
+        expect(from).to eq expected_from
+        expect(to).to eq expected_to
+      end
+      mailer.send_notification(exception)
+    end
+  end
+end

data/spec/lib/exception_mailer_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'exception_mailer'
+
+describe ExceptionMailer do
+  describe '.mail_exceptions' do
+    let(:exception) { Exception.new 'a test exception' }
+    let(:mailer) { double(send_notification: nil) }
+    it 'rescues exceptions and passes them to ExceptionMailer::Mailer' do
+      expect(ExceptionMailer::Mailer).to receive(:new).and_return(mailer)
+      expect(mailer).to receive(:send_notification).with(exception)
+      expect {
+        ExceptionMailer.mail_exceptions { raise exception }
+      }.to raise_error exception
+    end
+  end
+
+  describe '#mail_exceptions' do
+    before do
+      class ExceptionMailerIncluder
+        include ExceptionMailer
+      end
+    end
+
+    let(:opts) { double }
+    let(:block) { Proc.new {} }
+
+    it 'passes opts and block to ExceptionMailer.mail_exceptions' do
+      expect(ExceptionMailer).to receive(:mail_exceptions).with(opts, &block)
+      ExceptionMailerIncluder.new.mail_exceptions(opts, &block)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/version

@@ -0,0 +1 @@
+0.0.1

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: exception_mailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tyler Hartland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: rspec
+  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'
+description: 
+email:
+- tylerhartland7@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exception_mailer.gemspec
+- lib/exception_mailer.rb
+- lib/exception_mailer/mailer.rb
+- spec/lib/exception_mailer/mailer_spec.rb
+- spec/lib/exception_mailer_spec.rb
+- spec/spec_helper.rb
+- version
+homepage: ''
+licenses:
+- MIT
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Simple email notification of uncaught exceptions
+test_files:
+- spec/lib/exception_mailer/mailer_spec.rb
+- spec/lib/exception_mailer_spec.rb
+- spec/spec_helper.rb
+has_rdoc: