jira_exception_collector 0.0.1 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/README.md CHANGED
@@ -9,11 +9,11 @@ the appropriate developer to fix the issue using JIRA's workflow engine.
9
9
 
10
10
  JIRA Exception Collector is a gem. To install:
11
11
 
12
- gem install jira-exception-collector
12
+ gem install jira_exception_collector
13
13
 
14
14
  ... or, add this to your Gemfile:
15
15
 
16
- gem jira-exception-collector
16
+ gem jira_exception_collector
17
17
 
18
18
  ... then:
19
19
 
@@ -45,10 +45,23 @@ use Rack::JiraExceptionCollector, "[collector url]"
45
45
  ````
46
46
 
47
47
  By default, JIRA Exception Collector is enabled under production and staging environments.
48
- To modify this, just supply an array of the environments you want exceptions to be logged:
48
+ To modify this, just supply an array of the environments you want exceptions to be logged
49
+ inside the block syntax:
49
50
 
50
51
  ````ruby
51
- use Rack::JiraExceptionCollector, "[collector url]", %w(prod1 prod2 stage deploy)
52
+ use Rack::JiraExceptionCollector, "[collector url]" do |collector|
53
+ collector.report_under << "your_custom_env"
54
+ end
55
+ ````
56
+
57
+ You can also configure filters to scrub out sensitive environment variables:
58
+
59
+ ````ruby
60
+ use Rack::JiraExceptionCollector do |collector|
61
+ collector.collector_url = "[collector url]"
62
+ collector.report_under << "your_custom_env"
63
+ collector.filters << %w(SECRET_KEY SECRET_TOKEN)
64
+ end
52
65
  ````
53
66
 
54
67
  ## Compatibility with JIRA
@@ -58,8 +71,9 @@ this gem is only compatible with the JIRA versions that the JIRA Issue Collector
58
71
 
59
72
  ## Contributing
60
73
 
61
- This is a pushmepullyou type of project. Fork it hard, push in your awesome sauce, then
62
- send in your pull request. Oh, don't forget to add tests.
74
+ This is a [pushmepullyou](http://amysuenathan.com/wp-content/uploads/2009/03/pushmepullyou.jpg)
75
+ type of project. Fork it hard, push in your awesome sauce, then send in your pull request. Oh,
76
+ don't forget to add tests.
63
77
 
64
78
  ## Copyright
65
79
 
@@ -12,12 +12,11 @@ module Rack
12
12
 
13
13
  class Error < StandardError; end
14
14
 
15
- def initialize(app, collector_url = nil, report_under = %w(staging production),
16
- rack_environment = 'RACK_ENV')
15
+ def initialize(app, collector_url = nil, rack_environment = 'RACK_ENV')
17
16
  @app = app
18
17
  @collector_url = collector_url
19
18
  @report_under = report_under
20
- @rack_environment = rack_environment
19
+ @rack_environment = %w(production staging)
21
20
  @filters = %w(AWS_ACCESS_KEY AWS_SECRET_ACCESS_KEY AWS_ACCOUNT SSH_AUTH_SOCK)
22
21
  @failsafe = $stderr
23
22
  yield self if block_given?
@@ -1,5 +1,5 @@
1
1
  module Rack
2
2
  class JiraExceptionCollector
3
- VERSION = "0.0.1"
3
+ VERSION = "0.8.0"
4
4
  end
5
5
  end
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jira_exception_collector
3
3
  version: !ruby/object:Gem::Version
4
- hash: 29
4
+ hash: 63
5
5
  prerelease:
6
6
  segments:
7
7
  - 0
8
+ - 8
8
9
  - 0
9
- - 1
10
- version: 0.0.1
10
+ version: 0.8.0
11
11
  platform: ruby
12
12
  authors:
13
13
  - Rich Manalang