exception_no 0.0.5 → 0.0.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDMwNTRkNzExMWNiOWQ0OGQ5NzFmYmJhYmM2MTBhNGYzMWZiZWZkMg==
+    NTc5YjE1YzBkNmYxMjg1ODM2NDAxMjQwNzdlODcxMmMxZDA2MWI1Zg==
   data.tar.gz: !binary |-
-    NTY4YmJhNjUzZWU5YTJjMmUyODI5M2ZiMTVkYTZmOGJmNWE2MWIwNw==
+    ODNmYTNmOTBmYjYyMmIyZTE2MDc2NzhmYzBmNzk5ZDI2NTM3NzAyZg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDI3ZTY2NjhkYjk2NjU3ODZmNGNhNTMyNjczZDUwYWRiZDE1NmFmZjdhOWI4
-    YWNjYmIzYjAyMGM5MzhmOTdkMWUyMGYyNGIwNjFlMzQxMWJlMTUxMzU1ZTYx
-    NTU2YTc2NDY5NDBmNzAzN2I4M2RjNjlhYzA4YWY2MDUwODFkMzU=
+    OGRmOGQ2ZjI3MmYyNDdlMjUzOGJkZGE1MjBjMDcwN2Y0MTdhOWRjNzI5ZGIw
+    MDQ0ZDFhZGExMGUzOGJiZDQ4ZTI0MWI1NmJiMGUyNDBkZDc2ZDQyNzNhOTUy
+    YzZmZGFmMTNlZTgyMThiOTliY2UyODkwNTViNmE4M2I1NWQzMGQ=
   data.tar.gz: !binary |-
-    M2RmMjc2ZjQyNjg1MzRlN2M0OTUyNDY1MTVjNjM2ODNjZjk4ZjNmNmZjNTU5
-    NzFlYjU0ODNkZmY1NjNiMDVkYzdkNzkwZWVhYzBhMjdmNzY1Y2NhM2E0YjE2
-    ZDkxMmZjMDgyOTFhYjY4MTAzNzM4NDYzZmYyYmFlMWY5NzBiYWI=
+    ZTMyZTllNjY0OGJiYzdmZmVkYzVjNzJkOTZkNzEwZTAxNTEyNDAzOWQwODVi
+    Zjk1NzIwNWIwZmM4Yzk3MDNjMTRhOWI1NWE4ODExYTM5YTFkZDc5NTBkY2Nj
+    MGI5ZWNlNGU4MDllYTIwYzFkYTU4NjIwMTAwNGM0ZGI3NzRkMTU=

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.0.6 - 2014-09-11
+==================
+
+* The middleware now accepts a `:sanitizer` proc that filters the environment
+  for sensitive parameters before notifying (e.g. credit card numbers).
+
 0.0.5 - 2014-09-10
 ==================
 

data/lib/exception_no.rb

@@ -3,7 +3,7 @@ require "erb"
 require "pp"
 
 class ExceptionNo
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 
   attr_accessor :backtrace_filter
   attr_accessor :behaviors
@@ -66,9 +66,10 @@ class ExceptionNo
   EMAIL
 
   class Middleware
-    def initialize(app, notifier)
+    def initialize(app, notifier, options = {})
       @app = app
       @notifier = notifier
+      @sanitizer = options.fetch(:sanitizer, -> _ { _ })
     end
 
     def call(env)
@@ -93,17 +94,21 @@ class ExceptionNo
       parts << "Cookie: #{req.env["HTTP_COOKIE"]}" if req.cookies.size > 0
 
       if req.form_data?
-        body = req.POST.pretty_inspect
+        body = @sanitizer.call(req.POST).pretty_inspect
       else
         req.body.rewind
 
         body = req.body.read
 
-        body = nil if body.empty?
+        if body.empty?
+          body = nil
+        else
+          body = @sanitizer.call(body)
+        end
       end
 
       if body
-        parts << "Body: \n#{body.gsub(/^/, "  ")}"
+        parts << "Body: \n\n#{body.gsub(/^/, "  ")}"
       end
 
       parts

data/test/middleware.rb

@@ -109,3 +109,57 @@ test "doesn't raise when the notification fails" do |app|
     end
   end
 end
+
+test "allows for env sanitization before notifying" do
+  app = Rack::Builder.new do |builder|
+    builder.use ExceptionNo::Middleware,
+      ExceptionNo.new(
+        host: "127.0.0.1",
+        port: 2525,
+        to: "root@localhost",
+        from: "service@localhost",
+      ),
+      sanitizer: -> payload do
+        if payload.kind_of?(String)
+          payload.sub(/credit_card:(\d+)/, "credit_card:masked")
+        else
+          payload.merge("credit_card" => "masked")
+        end
+      end
+
+    builder.run(-> env { 1 / 0 })
+  end
+
+  env = Rack::MockRequest.env_for(
+    "/baz",
+    "REQUEST_METHOD" => "POST",
+    input: "foo=bar&credit_card=12345",
+  )
+
+  begin
+    app.call(env)
+  rescue ZeroDivisionError
+  end
+
+  headers, body = parse_email($smtp.outbox.pop[:data])
+
+  assert body.include?(%Q[  {"foo"=>"bar", "credit_card"=>"masked"}])
+  assert !body.include?("12345")
+
+  env = Rack::MockRequest.env_for(
+    "/baz",
+    "REQUEST_METHOD" => "POST",
+    "CONTENT_TYPE" => "text/plain; charset=utf-8",
+    input: "foo:bar, credit_card:12345",
+  )
+
+  begin
+    app.call(env)
+  rescue ZeroDivisionError
+  end
+
+  headers, body = parse_email($smtp.outbox.pop[:data])
+
+  assert body.include?(%Q[  foo:bar, credit_card:masked])
+  assert !body.include?("12345")
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_no
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Educabilia
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest