jira_exception_collector 0.8.0 → 0.8.3

data/.travis.yml

@@ -3,5 +3,4 @@ rvm:
   - 1.9.2
   - 1.9.3
   - jruby
-  - ruby-head
   - ree

data/README.md

@@ -1,5 +1,7 @@
 # JIRA Exception Collector
 
+![Travis CI](https://secure.travis-ci.org/manalang/jira_exception_collector.png?branch=master)
+
 A gem that logs your exceptions as a JIRA issue. Once it's in JIRA, you can route it to
 the appropriate developer to fix the issue using JIRA's workflow engine.
 
@@ -60,7 +62,7 @@ You can also configure filters to scrub out sensitive environment variables:
 use Rack::JiraExceptionCollector do |collector|
   collector.collector_url = "[collector url]"
   collector.report_under << "your_custom_env"
-  collector.filters << %w(SECRET_KEY SECRET_TOKEN)
+  collector.environment_filters << %w(SECRET_KEY SECRET_TOKEN)
 end
 ````
 

data/lib/rack/jira_exception_collector.rb

@@ -12,14 +12,18 @@ module Rack
 
     class Error < StandardError; end
 
-    def initialize(app, collector_url = nil, rack_environment = 'RACK_ENV')
+    attr_accessor :collector_url, :environment_filters, :report_under, :rack_environment, 
+      :failsafe, :error
+
+    def initialize(app, collector_url = nil)
       @app                 = app
       @collector_url       = collector_url
-      @report_under        = report_under
-      @rack_environment    = %w(production staging)
-      @filters             = %w(AWS_ACCESS_KEY AWS_SECRET_ACCESS_KEY AWS_ACCOUNT SSH_AUTH_SOCK)
+      @report_under        = %w(production staging)
+      @rack_environment    = "RACK_ENV"
+      @environment_filters = %w(AWS_ACCESS_KEY AWS_SECRET_ACCESS_KEY AWS_ACCOUNT SSH_AUTH_SOCK)
       @failsafe            = $stderr
       yield self if block_given?
+      raise(Error, "You need to provide a collector URL") unless @collector_url
     end
 
     def call(env)
@@ -35,7 +39,7 @@ module Rack
     end
 
     def environment_filter_keys
-      @filters.flatten
+      @environment_filters.flatten
     end
 
     def environment_filter_regexps
@@ -45,13 +49,12 @@ module Rack
     end
     private
     def report?
-      @report_under.include?(rack_env) || rack_env == "test"
+      @report_under.include?(rack_env)
     end
 
     def send_exception(exception, env)
       return true unless report?
       request = Rack::Request.new(env)
-      env['rack.session'] = {:a => 1}
 
       options = {
         :url               => env['REQUEST_URI'],
@@ -141,10 +144,10 @@ module Rack
       http.use_ssl = true if uri.scheme == "https"
       request = Net::HTTP::Post.new(uri.request_uri)
       request['X-JIRA-Client-Name'] = "Rack::JiraExceptionCollector"
-      error = document_for(exception, options)
+      @error = document_for(exception, options)
       request.set_form_data({ 
         "description" => "#{exception.class.name}: #{exception.message}",
-        "webInfo" => error
+        "webInfo" => @error
       })
       response = http.request(request)
     end

data/lib/rack/jira_exception_collector_version.rb

@@ -1,5 +1,5 @@
 module Rack
   class JiraExceptionCollector
-    VERSION = "0.8.0"
+    VERSION = "0.8.3"
   end
 end

data/test/test_log_exception.rb

@@ -7,13 +7,35 @@ class Rack::JiraExceptionCollector::TestLogException < Test::Unit::TestCase
                          :body => "Thanks for providing your feedback", :status => ["200", "OK"])
 
     @app = Rack::Lobster.new
-    @collector = Rack::JiraExceptionCollector.new @app, @collector_url
+    @collector = Rack::JiraExceptionCollector.new(@app, @collector_url){|c| 
+      c.report_under << "test"
+    }
     @request = Rack::MockRequest.new @collector
   end
 
-  def test_exception_was_sent
+  def make_it_crash
+    ENV['RACK_ENV'] = 'test'
+    env = Rack::MockRequest.env_for('/?flip=crash', :method => 'GET')
+  end
+
+  def test_no_collector_url_generates_exception
+    assert_raise(Rack::JiraExceptionCollector::Error){ Rack::JiraExceptionCollector.new(@app) }
+  end
+
+  def test_collector_url_can_be_configured_in_block
     ENV['RACK_ENV'] = 'test'
     env = Rack::MockRequest.env_for('/?flip=crash', :method => 'GET')
+    collector = Rack::JiraExceptionCollector.new(@app){|c|
+      c.collector_url = @collector_url
+      c.report_under << "test"
+    }
+    assert collector.collector_url == @collector_url
+    assert_raise(RuntimeError) { collector.call(env) }
+    assert_true env['jira.notified'], "JIRA exception created"
+  end
+
+  def test_exception_was_sent
+    env = make_it_crash
     assert_raise(RuntimeError) { @collector.call(env) }
     assert_true env['jira.notified'], "JIRA exception created"
   end
@@ -21,7 +43,42 @@ class Rack::JiraExceptionCollector::TestLogException < Test::Unit::TestCase
   def test_exception_can_be_sent_from_a_custom_env
     ENV['RACK_ENV'] = "my_custom_env"
     env = Rack::MockRequest.env_for('/?flip=crash', :method => 'GET')
-    collector = Rack::JiraExceptionCollector.new @app, @collector_url, "my_custom_env"
+    collector = Rack::JiraExceptionCollector.new(@app, @collector_url){|c| c.report_under << "my_custom_env"}
+    assert_raise(RuntimeError) { collector.call(env) }
+    assert_true env['jira.notified'], "JIRA exception created"
+  end
+
+  def test_exception_can_be_filtered
+    ENV["SUPER_SECRET_CODE"] = "My super secret code"
+    env = make_it_crash
+    collector = Rack::JiraExceptionCollector.new(@app, @collector_url){|c| 
+      c.environment_filters << "SUPER_SECRET_CODE"
+      c.report_under << "test"
+    }
+    assert_raise(RuntimeError) { collector.call(env) }
+    assert_match /ENV\["SUPER_SECRET_CODE"\]\: \[FILTERED\]/, collector.error
+  end
+
+  def test_exception_can_be_filtered_with_more_than_one_filter
+    ENV["SUPER_SECRET_CODE1"] = "My super secret code1"
+    ENV["SUPER_SECRET_CODE2"] = "My super secret code2"
+    env = make_it_crash
+    collector = Rack::JiraExceptionCollector.new(@app, @collector_url){|c| 
+      c.environment_filters = %w(SUPER_SECRET_CODE1 SUPER_SECRET_CODE2)
+      c.report_under << "test"
+    }
+    assert_raise(RuntimeError) { collector.call(env) }
+    assert_match /ENV\["SUPER_SECRET_CODE1"\]\: \[FILTERED\]/, collector.error
+    assert_match /ENV\["SUPER_SECRET_CODE2"\]\: \[FILTERED\]/, collector.error
+  end
+
+  def test_rack_env_can_be_changed
+    ENV['CUSTOM_ENV'] = 'test'
+    env = Rack::MockRequest.env_for('/?flip=crash', :method => 'GET')
+    collector = Rack::JiraExceptionCollector.new(@app, @collector_url){|c|
+      c.report_under << "test"
+      c.rack_environment = "CUSTOM_ENV"
+    }
     assert_raise(RuntimeError) { collector.call(env) }
     assert_true env['jira.notified'], "JIRA exception created"
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jira_exception_collector
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 57
   prerelease: 
   segments: 
   - 0
   - 8
-  - 0
-  version: 0.8.0
+  - 3
+  version: 0.8.3
 platform: ruby
 authors: 
 - Rich Manalang