exception_no 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGYwNDYzMDA0NmQzN2U4YTU2MGYxMzQ3OTQ5YTY5NTQ5Y2JiNTExNA==
+    NDMwNTRkNzExMWNiOWQ0OGQ5NzFmYmJhYmM2MTBhNGYzMWZiZWZkMg==
   data.tar.gz: !binary |-
-    NWY4ODFiOGIwNDI3YzcwZjBkOGE3YjE0ZGY4NTQ3MzEzNDM5ZDM2OQ==
+    NTY4YmJhNjUzZWU5YTJjMmUyODI5M2ZiMTVkYTZmOGJmNWE2MWIwNw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    N2Q3NWE4ZGEyZDI4NTg4MTA5Y2ZkMTQ0MmU4MWQyODUxMzAyMzYwZTk3ZjFm
-    NjBhZTFmZTcxMTg4M2JjN2NlZjEwNzAyZGNiNTQyMGI4MmNhNzEzMzBiMDQ4
-    YzRlYjI1ZGVkNzBkMzM0MTUzYzFkY2I3YzZhYjk4NjRhMDFkMDc=
+    MDI3ZTY2NjhkYjk2NjU3ODZmNGNhNTMyNjczZDUwYWRiZDE1NmFmZjdhOWI4
+    YWNjYmIzYjAyMGM5MzhmOTdkMWUyMGYyNGIwNjFlMzQxMWJlMTUxMzU1ZTYx
+    NTU2YTc2NDY5NDBmNzAzN2I4M2RjNjlhYzA4YWY2MDUwODFkMzU=
   data.tar.gz: !binary |-
-    MWI4YWI5MzQwNTU3ZjNiYzZjYmU1ZDBhNjUwNDkxYmIwMTI3OGMzNDJiYTgz
-    Y2Y3ZDk5OGQzYTU3OTViNmNiMTc2MGUyODBjY2MxYzFjOTNmNTMyY2UwYzhl
-    ZjBlYjJkMGM2MmFjMmQ0MmNhMDQ5NWFhOTZkMGMxNjU0MWEyZDk=
+    M2RmMjc2ZjQyNjg1MzRlN2M0OTUyNDY1MTVjNjM2ODNjZjk4ZjNmNmZjNTU5
+    NzFlYjU0ODNkZmY1NjNiMDVkYzdkNzkwZWVhYzBhMjdmNzY1Y2NhM2E0YjE2
+    ZDkxMmZjMDgyOTFhYjY4MTAzNzM4NDYzZmYyYmFlMWY5NzBiYWI=

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+0.0.5 - 2014-09-10
+==================
+
+* The middleware now extracts the request IP address.
+
+* The middleware now extracts the request body.
+
+* Added `ExceptionNo#run` which takes a block and notifies about errors.
+
 0.0.3 - 2013-09-18
 ==================
 

data/exception_no.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
 
   s.license = "Unlicense"
 
-  s.add_development_dependency "mini-smtp-server"
   s.add_development_dependency "cutest"
+  s.add_development_dependency "mini-smtp-server"
+  s.add_development_dependency "rack"
 end

data/lib/exception_no.rb

@@ -1,8 +1,9 @@
 require "net/smtp"
 require "erb"
+require "pp"
 
 class ExceptionNo
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 
   attr_accessor :backtrace_filter
   attr_accessor :behaviors
@@ -15,7 +16,7 @@ class ExceptionNo
     @backtrace_filter = -> line { true }
   end
 
-  def _deliver(exception, options = {})
+  def _deliver(exception, env = {})
     body = @template.result(binding)
 
     Net::SMTP.start(@config.fetch(:host), @config.fetch(:port, 25)) do |smtp|
@@ -42,12 +43,20 @@ class ExceptionNo
     raise exception if @behaviors.include?(:raise)
   end
 
+  def run(env = {})
+    begin
+      yield
+    rescue Exception => ex
+      notify(ex, env)
+    end
+  end
+
   TEMPLATE = (<<-'EMAIL').gsub(/^ {2}/, '')
   From: <%= @config[:from_alias] %> <<%= @config[:from] %>>
   To: <<%= @config[:to] %>>
   Subject: <%= exception.class %>: <%= exception.message.split.join(" ") %>
 
-  <%= options[:body] %>
+  <%= env.map { |*parts| parts.join(": ") }.join("\n") %>
 
   <%= "~" * 80 %>
 
@@ -66,7 +75,7 @@ class ExceptionNo
       begin
         @app.call(env)
       rescue Exception => e
-        @notifier.notify(e, body: extract_env(env))
+        @notifier.notify(e, extract_env(env))
 
         raise e
       end
@@ -80,9 +89,24 @@ class ExceptionNo
       parts << "#{req.request_method} #{req.url}"
       parts << "User-Agent: #{req.user_agent}" if req.user_agent
       parts << "Referrer: #{req.referrer}" if req.referrer
+      parts << "IP: #{req.ip}" if req.ip
       parts << "Cookie: #{req.env["HTTP_COOKIE"]}" if req.cookies.size > 0
 
-      parts.join("\n")
+      if req.form_data?
+        body = req.POST.pretty_inspect
+      else
+        req.body.rewind
+
+        body = req.body.read
+
+        body = nil if body.empty?
+      end
+
+      if body
+        parts << "Body: \n#{body.gsub(/^/, "  ")}"
+      end
+
+      parts
     end
   end
 end

data/test/exception_no.rb

@@ -16,7 +16,7 @@ test "deliver exception notification" do |notifier|
 
   notifier.notify(ex)
 
-  email = $smtp.outbox.last
+  email = $smtp.outbox.pop
 
   assert_equal email[:to], "<root@localhost>"
   assert_equal email[:from], "<service@localhost>"
@@ -32,7 +32,7 @@ test "exception messages with multiple lines" do |notifier|
 
   notifier.notify(ArgumentError.new("A really\nbad\nargument"))
 
-  headers, body = parse_email($smtp.outbox.last[:data])
+  headers, body = parse_email($smtp.outbox.pop[:data])
 
   assert_equal headers["Subject"], "ArgumentError: A really bad argument"
 end
@@ -46,7 +46,7 @@ test "includes backtrace information" do |notifier|
     notifier.notify(ex)
   end
 
-  headers, body = parse_email($smtp.outbox.last[:data])
+  headers, body = parse_email($smtp.outbox.pop[:data])
 
   assert body.include?(__FILE__)
   assert body.include?(Gem.path.first)
@@ -65,7 +65,7 @@ test "allows to filter the backtrace" do |notifier|
     notifier.notify(ex)
   end
 
-  headers, body = parse_email($smtp.outbox.last[:data])
+  headers, body = parse_email($smtp.outbox.pop[:data])
 
   assert body.include?(__FILE__)
   assert !body.include?(Gem.path.first)
@@ -76,7 +76,9 @@ test "disable delivery" do |notifier|
 
   notifier.notify(ArgumentError.new)
 
-  assert_equal $smtp.outbox.size, 0
+  assert_raise(QueueWithTimeout::Timeout) do
+    $smtp.outbox.pop(0.5)
+  end
 end
 
 test "raise exception" do |notifier|
@@ -84,7 +86,9 @@ test "raise exception" do |notifier|
 
   assert_raise(ArgumentError) { notifier.notify(ArgumentError.new) }
 
-  assert_equal $smtp.outbox.size, 0
+  assert_raise(QueueWithTimeout::Timeout) do
+    $smtp.outbox.pop(0.5)
+  end
 end
 
 test "raise exception and deliver notification" do |notifier|
@@ -92,8 +96,27 @@ test "raise exception and deliver notification" do |notifier|
 
   assert_raise(ArgumentError) { notifier.notify(ArgumentError.new) }
 
-  assert_equal $smtp.outbox.size, 1
+  assert $smtp.outbox.pop
+end
+
+test "block behavior" do |notifier|
+  notifier.behaviors = [:deliver]
+
+  notifier.run do
+    raise ArgumentError, "A bad argument"
+  end
+
+  assert $smtp.outbox.pop
 end
 
-$smtp.stop
-$smtp.join
+test "block with environment" do |notifier|
+  notifier.behaviors = [:deliver]
+
+  notifier.run("Foo" => "Bar") do
+    raise ArgumentError, "A bad argument"
+  end
+
+  headers, body = parse_email($smtp.outbox.pop[:data])
+
+  assert body.include?("Foo: Bar")
+end

data/test/middleware.rb

@@ -26,6 +26,7 @@ test "extracts interesting stuff from the request" do |app|
     "HTTP_USER_AGENT" => "Mozilla/4.0 (compatible)",
     "HTTP_REFERER"    => "/other",
     "HTTP_COOKIE"     => "foo=bar",
+    "REMOTE_ADDR"     => "127.0.0.2",
   )
 
   begin
@@ -33,13 +34,53 @@ test "extracts interesting stuff from the request" do |app|
   rescue ZeroDivisionError
   end
 
-  headers, body = parse_email($smtp.outbox.last[:data])
+  headers, body = parse_email($smtp.outbox.pop[:data])
 
   assert_equal headers["Subject"], "ZeroDivisionError: divided by 0"
-  assert body.include?("GET http://example.org/baz")
+  assert body.include?("GET http://example.org/baz\r\n")
   assert body.include?("User-Agent: Mozilla/4.0 (compatible)")
   assert body.include?("Referrer: /other")
   assert body.include?("Cookie: foo=bar")
+  assert body.include?("IP: 127.0.0.2")
+end
+
+test "extracts the posted form" do |app|
+  env = Rack::MockRequest.env_for(
+    "/baz",
+    "REQUEST_METHOD" => "POST",
+    input: "foo=bar&baz=qux",
+  )
+
+  begin
+    app.call(env)
+  rescue ZeroDivisionError
+  end
+
+  headers, body = parse_email($smtp.outbox.pop[:data])
+
+  assert_equal headers["Subject"], "ZeroDivisionError: divided by 0"
+  assert body.include?("POST http://example.org/baz\r\n")
+  assert body.include?(%Q[  {"foo"=>"bar", "baz"=>"qux"}])
+end
+
+test "extracts the request body" do |app|
+  env = Rack::MockRequest.env_for(
+    "/baz",
+    "REQUEST_METHOD" => "POST",
+    "CONTENT_TYPE" => "text/plain; charset=utf-8",
+    input: "foo:bar",
+  )
+
+  begin
+    app.call(env)
+  rescue ZeroDivisionError
+  end
+
+  headers, body = parse_email($smtp.outbox.pop[:data])
+
+  assert_equal headers["Subject"], "ZeroDivisionError: divided by 0"
+  assert body.include?("POST http://example.org/baz\r\n")
+  assert body.include?(%Q[  foo:bar])
 end
 
 test "doesn't raise when the notification fails" do |app|

data/test/prelude.rb

@@ -4,16 +4,57 @@ require "mini-smtp-server"
 require_relative "../lib/exception_no"
 
 class SMTPServer < MiniSmtpServer
-  def outbox
-    @outbox ||= []
+  attr :outbox
+
+  def initialize(*args)
+    @outbox = QueueWithTimeout.new
+    super(*args)
   end
 
   def new_message_event(message)
-    outbox << message
+    @outbox << message
     true
   end
 end
 
+# Source: http://spin.atomicobject.com/2014/07/07/ruby-queue-pop-timeout
+class QueueWithTimeout
+  Timeout = Class.new(StandardError)
+
+  def initialize
+    @mutex = Mutex.new
+    @queue = []
+    @recieved = ConditionVariable.new
+  end
+
+  def <<(x)
+    @mutex.synchronize do
+      @queue << x
+      @recieved.signal
+    end
+  end
+
+  def size
+    @queue.size
+  end
+
+  def clear
+    @mutex.synchronize do
+      @queue.clear
+    end
+  end
+
+  def pop(timeout = 2)
+    @mutex.synchronize do
+      if @queue.empty?
+        @recieved.wait(@mutex, timeout) if timeout != 0
+        raise Timeout, "queue empty" if @queue.empty?
+      end
+      @queue.pop
+    end
+  end
+end
+
 def parse_email(raw)
   headers = {}
   body = []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_no
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Educabilia
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2014-09-10 00:00:00.000000000 Z
 dependencies:
+- !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'
 - !ruby/object:Gem::Dependency
   name: mini-smtp-server
   requirement: !ruby/object:Gem::Requirement
@@ -26,7 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cutest
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='