red_alert 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d83a2fe0d578441d5dcd018946390eb65d110b2f
+  data.tar.gz: 15b5f1f4e982a82ffb0ea972dc796236713cd869
+SHA512:
+  metadata.gz: 436f1460909f014b8ce0504a10f6debee939589a94439099d897634205861c6bacd22b7f0faa93a4322da786c32f29cb8fcd5fc5c3edeec85d7b01c1bd9f3430
+  data.tar.gz: a9a617d550af2aec898d09bfa1b524cebb10613e63dd549d0b0cde5bea9fb4344a89a31319ada6608593a628f9935b197571f78ee948330a8b00c31fa5059d3d

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'mail'
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'minitest' do
+  watch(%r|^spec/.+_spec\.rb|)
+  watch(%r|^lib/(.+)\.rb$|)     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2012, Peer60
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+- Neither the name of Katalus nor the names of its contributors may be used
+  to endorse or promote products derived from this software without specific
+  prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,60 @@
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'red_alert'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install red_alert
+
+## Sidekiq Wireup
+
+```ruby
+Sidekiq.configure_server do |c|
+  c.server_middleware do |chain|
+    chain.add Sidekiq::Middleware::RedAlert,
+      to: 'recipient@example.com',
+      from: 'sender@example.com',
+      subject: "BOOM!: %s",
+      transport_settings: {
+        address: 'smtp.server.net',
+        port: '587',
+        user_name: 'user',
+        password: 'secret',
+        domain: 'example.com',
+        authentication: :plain,
+        enable_starttls_auto: true
+      }
+  end
+end
+```
+
+## Rack Wireup
+
+```ruby
+use Rack::RedAlert,
+  to: 'recipient@example.com',
+  from: 'sender@example.com',
+  subject: "BOOM!: %s",
+  transport_settings: {
+    address: 'smtp.server.net',
+    port: '587',
+    user_name: 'user',
+    password: 'secret',
+    domain: 'example.com',
+    authentication: :plain,
+    enable_starttls_auto: true
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+    puts ENV['TERM']
+    t.libs = ['spec', 'lib']
+    t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/red_alert/notification.rb

@@ -0,0 +1,30 @@
+require 'erb'
+
+module RedAlert
+  class Notification
+    attr_reader :subject, :body
+
+    def initialize(subject, body)
+      @subject = subject
+      @body = body
+    end
+
+    class << self
+      def build(subject_template, body_template, exception, data = {})
+        subject = compile_subject subject_template, exception
+        body = compile_body body_template, exception, data
+        self.new subject, body
+      end
+
+      private
+
+      def compile_subject(template, exception)
+        template % exception unless template.nil?
+      end
+
+      def compile_body(template, exception, data)
+        ERB.new(template).result binding
+      end
+    end
+  end
+end

data/lib/red_alert/notifier.rb

@@ -0,0 +1,38 @@
+module RedAlert
+  module Notifier
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    def notifier_settings
+      @notifier_settings ||= {}
+    end
+
+    def alert(exception, data = {})
+      notification = Notification.build notifier_settings[:subject], template, exception, data
+      mail = Mail.new(
+        to: notifier_settings[:to],
+        from: notifier_settings[:from],
+        subject: notification.subject,
+        body: notification.body
+      )
+      mail.delivery_method :smtp, notifier_settings[:transport_settings]
+      mail.deliver!
+    end
+
+    %i{ to from subject transport_settings }.each do |name|
+      define_method(name){ |value| notifier_settings[name] = value }
+    end
+
+    module ClassMethods
+      def build(settings)
+        notifier = self.new
+        notifier.to settings.fetch(:to)
+        notifier.from settings.fetch(:from)
+        notifier.subject settings.fetch(:subject)
+        notifier.transport_settings settings.fetch(:transport_settings)
+        notifier
+      end
+    end
+  end
+end

data/lib/red_alert/rack/middleware.rb

@@ -0,0 +1,16 @@
+module Rack
+  class RedAlert
+    def initialize(inner, settings)
+      @inner = inner
+      @settings = settings
+    end
+
+    def call(env)
+      @inner.call env
+    rescue => e
+      notification = ::RedAlert::Rack::Notifier.build @settings
+      notification.alert e, env: env
+      raise e
+    end
+  end
+end

data/lib/red_alert/rack/notifier.rb

@@ -0,0 +1,43 @@
+require 'pp'
+
+module RedAlert
+  module Rack
+    class Notifier
+      include RedAlert::Notifier
+
+      def template
+      <<-EMAIL
+A <%= exception.class %> occured: <%= exception %>
+<% if data[:request] %>
+
+===================================================================
+Request Body:
+===================================================================
+
+<%= data[:request].gsub(/^/, '  ') %>
+<% end %>
+
+===================================================================
+Rack Environment:
+===================================================================
+
+  PID:                     <%= $$ %>
+  PWD:                     <%= Dir.getwd %>
+
+  <%= data[:env].to_a.
+    sort{|a,b| a.first <=> b.first}.
+    map{ |k,v| "%-25s%p" % [k+':', v] }.
+    join("\n  ") %>
+
+<% if exception.respond_to?(:backtrace) %>
+===================================================================
+Backtrace:
+===================================================================
+
+  <%= exception.backtrace.join("\n  ") %>
+<% end %>
+      EMAIL
+      end
+    end
+  end
+end

data/lib/red_alert/rack.rb

@@ -0,0 +1 @@
+Dir[File.expand_path("../rack/*.rb", __FILE__)].each { |f| require f }

data/lib/red_alert/sidekiq/middleware.rb

@@ -0,0 +1,20 @@
+module Sidekiq
+  module Middleware
+    class RedAlert
+      def initialize(settings)
+        @settings = settings
+      end
+
+      def call(worker_class, message, queue)
+        yield
+      rescue => e
+        notification = ::RedAlert::Sidekiq::Notifier.build @settings
+        notification.alert e,
+          worker_class: worker_class,
+          message: message,
+          queue: queue
+        raise e
+      end
+    end
+  end
+end

data/lib/red_alert/sidekiq/notifier.rb

@@ -0,0 +1,40 @@
+module RedAlert
+  module Sidekiq
+    class Notifier
+      include RedAlert::Notifier
+
+      def template
+      <<-EMAIL
+A <%= exception.class %> occured: <%= exception %>
+
+===================================================================
+Message:
+===================================================================
+
+<%= data[:message].to_a.
+  sort{|a,b| a.first <=> b.first}.
+  map{ |k,v| "%-25s%p" % [k+':', v] }.
+  join("\n  ") %>
+
+===================================================================
+Sidekiq Environment:
+===================================================================
+
+  PID:                     <%= $$ %>
+  PWD:                     <%= Dir.getwd %>
+
+  Worker Class:            <%= data[:worker_class] %>
+  Queue:                   <%= data[:queue] %>
+
+<% if exception.respond_to?(:backtrace) %>
+===================================================================
+Backtrace:
+===================================================================
+
+  <%= exception.backtrace.join("\n  ") %>
+<% end %>
+      EMAIL
+      end
+    end
+  end
+end

data/lib/red_alert/sidekiq.rb

@@ -0,0 +1 @@
+Dir[File.expand_path("../sidekiq/*.rb", __FILE__)].each { |f| require f }

data/lib/red_alert/version.rb

@@ -0,0 +1,3 @@
+module RedAlert
+  VERSION = "0.0.1"
+end

data/lib/red_alert.rb

@@ -0,0 +1,4 @@
+module RedAlert
+end
+
+Dir[File.expand_path("../red_alert/*.rb", __FILE__)].each { |f| require f }

data/red_alert.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/red_alert/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.author        = 'vyrak.bunleang@gmail.com'
+  gem.description   = 'Middlewares for mailing errors'
+  gem.summary       = 'Middlewares for mailing errors'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "red_alert"
+  gem.require_paths = ["lib"]
+  gem.version       = RedAlert::VERSION
+
+  gem.add_dependency 'mail', '>= 2.5.4'
+end

data/spec/red_alert/notification_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe RedAlert::Notification do
+  describe '::new' do
+    it 'initalizes' do
+       result = RedAlert::Notification.new 'test subject', 'test body'
+       result.subject.must_equal 'test subject'
+       result.body.must_equal 'test body'
+    end
+  end
+
+  describe '::build' do
+    let(:exception) { RuntimeError.new 'explosion happened' }
+    let(:subject_template) { 'BOOM! %s' }
+    let(:body_template) { 'error: <%= exception.to_s %>' }
+    let(:additional_data) { {} }
+    subject { RedAlert::Notification.build subject_template, body_template, exception, additional_data }
+
+    it 'has subject' do
+      subject.subject.must_equal 'BOOM! explosion happened'
+    end
+
+    it 'has body' do
+      subject.body.must_equal 'error: explosion happened'
+    end
+
+    describe 'without subject' do
+      let(:subject_template) { nil }
+
+      it 'has nil subject' do
+        subject.subject.must_be_nil
+      end
+    end
+
+    describe 'with additional data for body' do
+      let(:additional_data) { { stuff: 'in body' } }
+      let(:body_template) { 'error: <%= exception.to_s %> with stuff: <%= data[:stuff] %>' }
+
+      it 'has body' do
+        subject.body.must_equal 'error: explosion happened with stuff: in body'
+      end
+    end
+  end
+end

data/spec/red_alert/notifier_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+class TestNotifier
+  include RedAlert::Notifier
+  attr_reader :template
+
+  def initialize(template = '')
+    @template = template
+  end
+end
+
+describe RedAlert::Notifier do
+  let(:settings) {
+    { to: 'recipient@example.com',
+      from: 'sender@example.com',
+      subject: 'something go bad',
+      transport_settings: {
+        field: 'custom'
+      }
+    }
+  }
+
+  subject { TestNotifier.build settings }
+
+  describe '::build' do
+    %w{ to from subject transport_settings }.each do |field|
+      it "builds with #{field} setting" do
+        field_sym = field.to_sym
+        subject.notifier_settings[field_sym].must_equal settings[field_sym]
+      end
+    end
+  end
+
+  describe '#alert' do
+    let(:exception) { RuntimeError.new 'something bad happened' }
+    let(:to) { 'recipient@example.com' }
+    let(:from) { 'sender@example.com' }
+    let(:mail_subject) { 'test subject %s' }
+    let(:data) { { stuff: 'here' } }
+    let(:settings) { {
+      domain: 'example.com',
+      address: 'smtp.sendgrid.net',
+      port: '587',
+      user_name: 'the_user',
+      password: 'secret',
+      authentication: :plain,
+      enable_starttls_auto: true
+    } }
+
+    subject { TestNotifier.new 'test template <%= exception %> |<%= data[:stuff] %>|' }
+
+    before do
+      subject.to to
+      subject.from from
+      subject.subject mail_subject
+      subject.transport_settings settings
+    end
+
+    after { deliveries.clear }
+
+    it 'delivers mail' do
+      result = subject.alert exception, data
+
+      deliveries.length.must_equal 1
+      notification = deliveries.first
+      result.must_equal notification
+      notification.to.must_include to
+      notification.from.must_include from
+      notification.subject.must_equal 'test subject something bad happened'
+      notification.body.to_s.must_equal 'test template something bad happened |here|'
+    end
+
+    it 'uses settings' do
+      result = subject.alert(exception).delivery_method.settings
+      result.must_equal settings
+    end
+  end
+end

data/spec/red_alert/rack/middleware_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Rack::RedAlert do
+  let(:notification) { mock }
+  let(:env) { { 'field' => 'variable' } }
+  let(:error) { RuntimeError.new }
+  let(:settings) { { domain: 'example.com' } }
+
+  it 'wont alert' do
+    inner = mock
+    inner.expect :call, nil, [env]
+    subject = Rack::RedAlert.new inner, settings
+    subject.call env
+    inner.verify
+  end
+
+  it 'alerts' do
+    actual_args = nil
+    actual_error = nil
+    data = { env: env }
+    inner = OpenStruct.new error: error
+    def inner.call(*args); raise error end
+    notification.expect :alert, nil, [error, data]
+
+    begin
+      action = ->(*args) { actual_args = args; notification }
+      RedAlert::Rack::Notifier.stub :build, action do
+        subject = Rack::RedAlert.new inner, settings
+        subject.call env
+      end
+    rescue => e
+      actual_error = e
+    end
+    actual_args.length.must_equal 1
+    actual_args[0].must_equal settings
+    actual_error.must_equal error
+  end
+end

data/spec/red_alert/rack/notifier_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe RedAlert::Rack::Notifier do
+  subject { RedAlert::Rack::Notifier.new }
+
+  before do
+    subject.to 'recipient@example.com'
+    subject.from 'sender@example.com'
+    subject.transport_settings({})
+  end
+
+  after { deliveries.clear }
+
+  it 'alerts' do
+    begin
+      raise 'boom'
+    rescue => e
+      subject.alert(e, request: 'data', env: { 'in' => 'out' }).body.wont_be_nil
+      deliveries.length.must_be :>, 0
+    end
+  end
+end

data/spec/red_alert/sidekiq/middleware_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Sidekiq::Middleware::RedAlert do
+  let(:notification) { mock }
+  let(:worker_class) { mock }
+  let(:msg) { mock }
+  let(:queue) { mock }
+  let(:error) { RuntimeError.new }
+  let(:settings) { { domain: 'example.com' } }
+
+  subject { Sidekiq::Middleware::RedAlert.new settings }
+
+  after { notification.verify }
+
+  it 'wont alert' do
+    subject.call(worker_class, msg, queue) { }
+  end
+
+  it 'alerts' do
+    actual_args = nil
+    actual_error = nil
+    data = {
+      worker_class: worker_class,
+      message: msg,
+      queue: queue
+    }
+    notification.expect :alert, nil, [error, data]
+
+    begin
+      action = ->(*args) { actual_args = args; notification }
+      RedAlert::Sidekiq::Notifier.stub :build, action do
+        subject.call(worker_class, msg, queue) { raise error }
+      end
+    rescue => e
+      actual_error = e
+    end
+    actual_args.length.must_equal 1
+    actual_args[0].must_equal settings
+    actual_error.must_equal error
+  end
+end

data/spec/red_alert/sidekiq/notifier_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe RedAlert::Sidekiq::Notifier do
+  subject { RedAlert::Sidekiq::Notifier.new }
+
+  before do
+    subject.to 'recipient@example.com'
+    subject.from 'sender@example.com'
+    subject.transport_settings({})
+  end
+
+  after { deliveries.clear }
+
+  it 'alerts' do
+    begin
+      raise 'boom'
+    rescue => e
+      subject.alert(e, message: { 'args' => ['something', 'useful'] }).body.wont_be_nil
+      deliveries.length.must_be :>, 0
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'bundler/setup'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'red_alert'
+require 'minitest/pride'
+require 'minitest/autorun'
+
+Bundler.require :development
+
+class Minitest::Spec
+  def mock
+    Minitest::Mock.new
+  end
+
+  def deliveries
+    Mail::TestMailer.deliveries
+  end
+end
+
+Mail.defaults do
+  delivery_method :test
+end
+
+mail_configuration = Mail::Configuration.instance
+def mail_configuration.lookup_delivery_method(*args)
+  Mail::TestMailer
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: red_alert
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- vyrak.bunleang@gmail.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+description: Middlewares for mailing errors
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/red_alert.rb
+- lib/red_alert/notification.rb
+- lib/red_alert/notifier.rb
+- lib/red_alert/rack.rb
+- lib/red_alert/rack/middleware.rb
+- lib/red_alert/rack/notifier.rb
+- lib/red_alert/sidekiq.rb
+- lib/red_alert/sidekiq/middleware.rb
+- lib/red_alert/sidekiq/notifier.rb
+- lib/red_alert/version.rb
+- red_alert.gemspec
+- spec/red_alert/notification_spec.rb
+- spec/red_alert/notifier_spec.rb
+- spec/red_alert/rack/middleware_spec.rb
+- spec/red_alert/rack/notifier_spec.rb
+- spec/red_alert/sidekiq/middleware_spec.rb
+- spec/red_alert/sidekiq/notifier_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Middlewares for mailing errors
+test_files:
+- spec/red_alert/notification_spec.rb
+- spec/red_alert/notifier_spec.rb
+- spec/red_alert/rack/middleware_spec.rb
+- spec/red_alert/rack/notifier_spec.rb
+- spec/red_alert/sidekiq/middleware_spec.rb
+- spec/red_alert/sidekiq/notifier_spec.rb
+- spec/spec_helper.rb