exception_no 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDg1YTk5NDNkNmRhNTA4NGVmNzE1ZTU3YzcwZDM3MGRlOWUyZWFiZg==
+  data.tar.gz: !binary |-
+    Yjc4Mzk0NjQzZWFjNjI4MWRjMDQ1OTA2Y2FiOGY3MWNjZjA2MjAyNA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YjQ1NGJmNjY1YWM2ZDc1OGJkNjMzYWQzZGZjNmJjNTE2YmNlZDBmMzdjYTgy
+    NDM1M2EzNmJkOWZiOTU0MzRkNWZlZDQyNTExZmU0NzY3MGJjMDgzYmJiYzMw
+    NTA0NDI5MjFmYWZiNjRjMDExZjZhMjRmMGZmNDkzZjA2MmYwZTI=
+  data.tar.gz: !binary |-
+    MjVhNzkxY2E2ZDFhY2UzNzUzMjJkMTIzNmY0MmZmY2NmNDdjOTU4ODVmOGRm
+    NDYwYjU1NTgyMmZlNWYwNGJhMmIwNTFlZDRiODk0M2FjMTVjOTQ1M2E1N2E0
+    ODU4ZGQxM2FmNTczNGE4NjI3NzY4MzRkM2M5Y2MzYTJlNTAzODg=

data/.gitignore

@@ -0,0 +1 @@
+.gs

data/Makefile

@@ -0,0 +1,4 @@
+test:
+	cutest test/*.rb
+
+.PHONY: test

data/exception_no.gemspec

@@ -0,0 +1,16 @@
+require File.expand_path("lib/exception_no", File.dirname(__FILE__))
+
+Gem::Specification.new do |s|
+  s.name              = "exception_no"
+  s.version           = ExceptionNo::VERSION
+  s.summary           = "Truly basic exception notification."
+  s.authors           = ["Educabilia", "Damian Janowski"]
+  s.email             = ["opensource@educabilia.com", "djanowski@dimaion.com"]
+  s.homepage          = "https://github.com/djanowski/exception_no"
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- {test}/*`.split("\n")
+
+  s.add_development_dependency "mini-smtp-server"
+  s.add_development_dependency "cutest"
+end

data/lib/exception_no.rb

@@ -0,0 +1,81 @@
+require "net/smtp"
+require "erb"
+
+class ExceptionNo
+  VERSION = "0.0.1"
+
+  attr_accessor :backtrace_filter
+
+  def initialize(config = {})
+    @config = config
+    @template = ERB.new(TEMPLATE)
+
+    @backtrace_filter = -> line { true }
+  end
+
+  def _notify(exception, options = {})
+    body = @template.result(binding)
+
+    Net::SMTP.start(@config.fetch(:host), @config.fetch(:port, 25)) do |smtp|
+      smtp.send_message(body, @config.fetch(:from), @config.fetch(:to))
+    end
+  end
+
+  def notify(exception, options = {})
+    begin
+      _notify(exception, options)
+    rescue => notification_error
+      $stderr.write("*** FAILED SENDING ERROR NOTIFICATION\n")
+      $stderr.write("*** #{notification_error.class}: #{notification_error}\n")
+      $stderr.write("*** #{exception.class}: #{exception.message}\n")
+
+      exception.backtrace.each do |line|
+        $stderr.write("*** #{line}\n")
+      end
+    end
+  end
+
+  TEMPLATE = (<<-'EMAIL').gsub(/^ {2}/, '')
+  From: <%= @config[:from_alias] %> <<%= @config[:from] %>>
+  To: <<%= @config[:to] %>>
+  Subject: <%= exception.class %>: <%= exception.message.split.join(" ") %>
+
+  <%= options[:body] %>
+
+  <%= "~" * 80 %>
+
+  A <%= exception.class.to_s %> occured: <%= exception.to_s %>
+
+  <%= exception.backtrace.select { |line| @backtrace_filter.call(line) }.join("\n") if exception.backtrace %>
+  EMAIL
+
+  class Middleware
+    def initialize(app, config = {})
+      @app = app
+      @notifier = ExceptionNo.new(config)
+    end
+
+    def call(env)
+      begin
+        @app.call(env)
+      rescue Exception => e
+        @notifier.notify(e, body: extract_env(env))
+
+        raise e
+      end
+    end
+
+    def extract_env(env)
+      req = Rack::Request.new(env)
+
+      parts = []
+
+      parts << "#{req.request_method} #{req.url}"
+      parts << "User-Agent: #{req.user_agent}" if req.user_agent
+      parts << "Referrer: #{req.referrer}" if req.referrer
+      parts << "Cookie: #{req.env["HTTP_COOKIE"]}" if req.cookies.size > 0
+
+      parts.join("\n")
+    end
+  end
+end

data/test/exception_no.rb

@@ -0,0 +1,67 @@
+require_relative "prelude"
+
+setup do
+  ExceptionNo.new(
+    host: "127.0.0.1",
+    port: 2525,
+    to: "root@localhost",
+    from: "service@localhost"
+  )
+end
+
+test "deliver exception notification" do |notifier|
+  ex = ArgumentError.new("Really bad argument")
+
+  notifier.notify(ex)
+
+  email = $smtp.outbox.last
+
+  assert_equal email[:to], "<root@localhost>"
+  assert_equal email[:from], "<service@localhost>"
+
+  headers, body = parse_email(email[:data])
+
+  assert_equal headers["Subject"], "ArgumentError: Really bad argument"
+  assert body.include?("A ArgumentError occured: Really bad argument")
+end
+
+test "exception messages with multiple lines" do |notifier|
+  notifier.notify(ArgumentError.new("A really\nbad\nargument"))
+
+  headers, body = parse_email($smtp.outbox.last[:data])
+
+  assert_equal headers["Subject"], "ArgumentError: A really bad argument"
+end
+
+test "includes backtrace information" do |notifier|
+  begin
+    raise ArgumentError, "A bad argument"
+  rescue Exception => ex
+    notifier.notify(ex)
+  end
+
+  headers, body = parse_email($smtp.outbox.last[:data])
+
+  assert body.include?(__FILE__)
+  assert body.include?(Gem.path.first)
+end
+
+test "allows to filter the backtrace" do |notifier|
+  notifier.backtrace_filter = -> line do
+    !line.include?(Gem.path.first)
+  end
+
+  begin
+    raise ArgumentError, "A bad argument"
+  rescue Exception => ex
+    notifier.notify(ex)
+  end
+
+  headers, body = parse_email($smtp.outbox.last[:data])
+
+  assert body.include?(__FILE__)
+  assert !body.include?(Gem.path.first)
+end
+
+$smtp.stop
+$smtp.join

data/test/middleware.rb

@@ -0,0 +1,66 @@
+require_relative "prelude"
+
+require "rack"
+
+setup do
+  Rack::Builder.new do |builder|
+    builder.use ExceptionNo::Middleware,
+      host: "127.0.0.1",
+      port: 2525,
+      to: "root@localhost",
+      from: "service@localhost"
+
+    builder.run(-> env { 1 / 0 })
+  end
+end
+
+test "re-raises exceptions" do |app|
+  assert_raise(ZeroDivisionError) { app.call(Rack::MockRequest.env_for("/")) }
+end
+
+test "extracts interesting stuff from the request" do |app|
+  env = Rack::MockRequest.env_for(
+    "/baz",
+    "HTTP_USER_AGENT" => "Mozilla/4.0 (compatible)",
+    "HTTP_REFERER"    => "/other",
+    "HTTP_COOKIE"     => "foo=bar",
+  )
+
+  begin
+    app.call(env)
+  rescue ZeroDivisionError
+  end
+
+  headers, body = parse_email($smtp.outbox.last[:data])
+
+  assert_equal headers["Subject"], "ZeroDivisionError: divided by 0"
+  assert body.include?("GET http://example.org/baz")
+  assert body.include?("User-Agent: Mozilla/4.0 (compatible)")
+  assert body.include?("Referrer: /other")
+  assert body.include?("Cookie: foo=bar")
+end
+
+test "doesn't raise when the notification fails" do |app|
+  app = Rack::Builder.new do |builder|
+    builder.use ExceptionNo::Middleware,
+      host: "127.0.0.1",
+      port: 2526,
+      to: "root@localhost",
+      from: "service@localhost"
+
+    builder.run(-> env { 1 / 0 })
+  end
+
+  env = Rack::MockRequest.env_for(
+    "/baz",
+    "HTTP_USER_AGENT" => "Mozilla/4.0 (compatible)",
+    "HTTP_REFERER"    => "/other",
+    "HTTP_COOKIE"     => "foo=bar",
+  )
+
+  assert_raise(ZeroDivisionError) do
+    capture_stderr do
+      app.call(env)
+    end
+  end
+end

data/test/prelude.rb

@@ -0,0 +1,62 @@
+require "cutest"
+require "mini-smtp-server"
+
+require_relative "../lib/exception_no"
+
+class SMTPServer < MiniSmtpServer
+  def outbox
+    @outbox ||= []
+  end
+
+  def new_message_event(message)
+    outbox << message
+    true
+  end
+end
+
+def parse_email(raw)
+  headers = {}
+  body = []
+  reading_body = false
+
+  raw.each_line do |line|
+    if !reading_body && line == "\r\n"
+      reading_body = true
+      next
+    end
+
+    if reading_body
+      body << line
+    else
+      key, value = line.split(": ", 2)
+      headers[key] = value && value.chomp
+    end
+  end
+
+  body.pop
+
+  return headers, body.join("").chomp
+end
+
+def capture_stderr
+  old, $stderr = $stderr, StringIO.new
+
+  begin
+    yield
+  ensure
+    $stderr = old
+  end
+end
+
+$smtp = SMTPServer.new(2525, "127.0.0.1")
+$smtp.start
+
+until SMTPServer.in_service?(2525)
+end
+
+at_exit do
+  if $smtp
+    $smtp.stop
+    $smtp.join
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: exception_no
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Educabilia
+- Damian Janowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mini-smtp-server
+  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: cutest
+  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:
+- opensource@educabilia.com
+- djanowski@dimaion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Makefile
+- exception_no.gemspec
+- lib/exception_no.rb
+- test/exception_no.rb
+- test/middleware.rb
+- test/prelude.rb
+homepage: https://github.com/djanowski/exception_no
+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.0
+signing_key: 
+specification_version: 4
+summary: Truly basic exception notification.
+test_files: []