party_foul 0.6.0 → 1.0.0

data/README.md

@@ -6,6 +6,14 @@
 
 Rails exceptions automatically opened as issues on Github
 
+## Looking for help? ##
+
+If it is a bug [please open an issue on
+Github](https://github.com/dockyard/party_foul/issues). If you need help using
+the gem please ask the question on
+[Stack Overflow](http://stackoverflow.com). Be sure to tag the
+question with `DockYard` so we can find it.
+
 ## About ##
 
 `PartyFoul` captures exceptions in your application and does the
@@ -99,21 +107,47 @@ curl -u <github_login> -i -d "{ \"scopes\": [\"repo\"] }" \
 https://api.github.com/authorizations
 ```
 
-Add as the very last middleware in your production `Rack` stack.
-
 ## Customization ##
 
+### Labels ###
+
+You can specify an additional array of labels that will be applied to the issues PartyFoul creates.
+
+```ruby
+PartyFoul.configure do |config|
+  config.additional_labels = ['front-end']
+end
+```
+
+You can also provide a Proc that is passed the exception and the environment.
+
+```ruby
+PartyFoul.configure do |config|
+  config.additional_labels = Proc.new do |exception, env|
+    labels = if env["HTTP_HOST"] =~ /beta\./
+      ['beta']
+    else
+      ['production']
+    end
+    if exception.message =~ /PG::Error/
+      labels << 'database'
+    end
+    labels
+  end
+end
+```
+
 ### Background Processing ###
 
 You can specify the adapter with which the exceptions should be
 handled. By default, PartyFoul includes the
-[`PartyFoul::SyncAdapter`](https://github.com/dockyard/party_foul/tree/master/lib/party_foul/sync_adapter.rb)
+[`PartyFoul::Processors::Sync`](https://github.com/dockyard/party_foul/tree/master/lib/party_foul/processors/sync.rb)
 which handles the exception synchronously. To use your own adapter,
 include the following in your `PartyFoul.configure` block:
 
 ```ruby
 PartyFoul.configure do |config|
-  config.adapter = PartyFoul::Processors::MyBackgroundProcessor
+  config.processor = PartyFoul::Processors::MyBackgroundProcessor
 end
 
 class PartyFoul::Processors::MyBackgroundProcessor
@@ -125,8 +159,41 @@ end
 
 ```
 
-### Using PartyFoul with Sidekiq
+`PartyFoul` comes with the following background processing adapters:
+
+* [PartyFoul::Processors::Sidekiq](https://github.com/dockyard/party_foul/blob/master/lib/party_foul/processors/sidekiq.rb)
+* [PartyFoul::Processors::Resque](https://github.com/dockyard/party_foul/blob/master/lib/party_foul/processors/resque.rb)
+* [PartyFoul::Processors::DelayedJob](https://github.com/dockyard/party_foul/blob/master/lib/party_foul/processors/delayed_job.rb)
+
+These adapters are not loaded by default. You must explicitly require if
+you want to use:
+
+```ruby
+require 'party_foul/processors/sidekiq'
+
+PartyFoul.configure do |config|
+  config.processor = PartyFoul::Processors::Sidekiq
+end
+```
+
+## Tracking errors outside of an HTTP request
+
+You may want to track errors outside of a reqular HTTP stack. In that
+case you will need to make sure of the
+`PartyFoul::RacklessExceptionHandler`.
+
+The code that you want to handle should be wrapped like so:
+
+```ruby
+begin
+  ... # some code that might raise an error
+rescue => e
+  PartyFoul::RacklessExceptionHandler.handle(e, {class: class_name, method: method_name, params: message)
+  raise e
+end
+```
 
+### Tracking errors in a Sidekiq worker
 In order to use PartyFoul for exception handling with Sidekiq you will need to create an initializer with some middleware configuration. The following example is based on using [Sidekiq with another exception notifiier server](https://github.com/bugsnag/bugsnag-ruby/blob/master/lib/bugsnag/sidekiq.rb).
 
 File: config/initializers/partyfoul_sidekiq.rb

data/lib/generators/party_foul/templates/party_foul.rb

@@ -22,4 +22,11 @@ PartyFoul.configure do |config|
 
   # The branch for your deployed code
   # config.branch               = 'master'
+
+  # Additional labels to add to issues created
+  # config.additional_labels    = ['production']
+  # or
+  # config.additional_labels    = Proc.new do |exception, env|
+  #   []
+  # end
 end

data/lib/party_foul/exception_handler.rb

@@ -46,7 +46,7 @@ class PartyFoul::ExceptionHandler
   # Will create a new issue and a comment with the proper details. All issues are labeled as 'bug'.
   def create_issue
     self.sha = PartyFoul.github.git_data.references.get(PartyFoul.owner, PartyFoul.repo, "heads/#{PartyFoul.branch}").object.sha
-    issue = PartyFoul.github.issues.create(PartyFoul.owner, PartyFoul.repo, title: rendered_issue.title, body: rendered_issue.body, labels: ['bug'])
+    issue = PartyFoul.github.issues.create(PartyFoul.owner, PartyFoul.repo, title: rendered_issue.title, body: rendered_issue.body, labels: ['bug'] + rendered_issue.labels)
     PartyFoul.github.issues.comments.create(PartyFoul.owner, PartyFoul.repo, issue['number'], body: rendered_issue.comment)
   end
 
@@ -58,7 +58,7 @@ class PartyFoul::ExceptionHandler
       params = {body: rendered_issue.update_body(issue['body']), state: 'open'}
 
       if issue['state'] == 'closed'
-        params[:labels] = ['bug', 'regression']
+        params[:labels] = (['bug', 'regression'] + issue['labels']).uniq
       end
 
       self.sha = PartyFoul.github.git_data.references.get(PartyFoul.owner, PartyFoul.repo, "heads/#{PartyFoul.branch}").object.sha

data/lib/party_foul/issue_renderers/base.rb

@@ -127,6 +127,17 @@ BODY
     end
   end
 
+  # Provides additional labels using the configured options
+  #
+  # @return [Array]
+  def labels
+    if PartyFoul.additional_labels.respond_to? :call
+      PartyFoul.additional_labels.call(self.exception, self.env) || []
+    else
+      PartyFoul.additional_labels || []
+    end
+  end
+
   private
 
   def app_root

data/lib/party_foul/processors/delayed_job.rb

@@ -0,0 +1,16 @@
+require 'party_foul/processors/base'
+
+class PartyFoul::Processors::DelayedJob < PartyFoul::Processors::Base
+  @queue = 'party_foul'
+
+  # Passes the exception and rack env data to DelayedJob to be processed later
+  #
+  # @param [Exception, Hash]
+  def self.handle(exception, env)
+    new.delay(queue: @queue).perform(Marshal.dump(exception), Marshal.dump(env))
+  end
+
+  def perform(exception, env)
+    PartyFoul::ExceptionHandler.new(Marshal.load(exception), Marshal.load(env)).run
+  end
+end

data/lib/party_foul/processors/resque.rb

@@ -0,0 +1,16 @@
+require 'party_foul/processors/base'
+
+class PartyFoul::Processors::Resque < PartyFoul::Processors::Base
+  @queue = :party_foul
+
+  # Passes the exception and rack env data to Resque to be processed later
+  #
+  # @param [Exception, Hash]
+  def self.handle(exception, env)
+    Resque.enqueue(PartyFoul::Processors::Resque, Marshal.dump(exception), Marshal.dump(env))
+  end
+
+  def self.perform(exception, env)
+    PartyFoul::ExceptionHandler.new(Marshal.load(exception), Marshal.load(env)).run
+  end
+end

data/lib/party_foul/processors/sidekiq.rb

@@ -0,0 +1,17 @@
+require 'party_foul/processors/base'
+
+class PartyFoul::Processors::Sidekiq < PartyFoul::Processors::Base
+  include Sidekiq::Worker
+  sidekiq_options queue: 'party_foul'
+
+  # Passes the exception and rack env data to Sidekiq to be processed later
+  #
+  # @param [Exception, Hash]
+  def self.handle(exception, env)
+    perform_async(Marshal.dump(exception), Marshal.dump(env))
+  end
+
+  def perform(exception, env)
+    PartyFoul::ExceptionHandler.new(Marshal.load(exception), Marshal.load(env)).run
+  end
+end

data/lib/party_foul/version.rb

@@ -1,3 +1,3 @@
 module PartyFoul
-  VERSION = '0.6.0'
+  VERSION = '1.0.0'
 end

data/lib/party_foul.rb

@@ -2,7 +2,7 @@ require 'github_api'
 
 module PartyFoul
   class << self
-    attr_accessor :github, :oauth_token, :endpoint, :owner, :repo, :blacklisted_exceptions, :processor, :web_url, :branch, :whitelisted_rack_variables
+    attr_accessor :github, :oauth_token, :endpoint, :owner, :repo, :blacklisted_exceptions, :processor, :web_url, :branch, :whitelisted_rack_variables, :additional_labels
   end
 
   def self.whitelisted_rack_variables

data/test/party_foul/exception_handler_test.rb

@@ -31,6 +31,65 @@ describe 'Party Foul Exception Handler' do
       PartyFoul.github.issues.comments.expects(:create).with('test_owner', 'test_repo', 1, body: 'Test Comment')
       PartyFoul::ExceptionHandler.new(nil, {}).run
     end
+
+    context 'when additional labels are configured' do
+      before do
+        PartyFoul.configure do |config|
+          config.additional_labels = ['custom', 'label']
+        end
+      end
+      after do
+        clean_up_party
+      end
+      it 'will open a new error on Github with the additional labels' do
+        PartyFoul::IssueRenderers::Rails.any_instance.stubs(:body).returns('Test Body')
+        PartyFoul::IssueRenderers::Rails.any_instance.stubs(:comment).returns('Test Comment')
+        PartyFoul.github.search.stubs(:issues).with(owner: 'test_owner', repo: 'test_repo', keyword: 'test_fingerprint', state: 'open').returns(Hashie::Mash.new(issues: []))
+        PartyFoul.github.search.stubs(:issues).with(owner: 'test_owner', repo: 'test_repo', keyword: 'test_fingerprint', state: 'closed').returns(Hashie::Mash.new(issues: []))
+        PartyFoul.github.issues.expects(:create).with('test_owner', 'test_repo', title: 'Test Title', body: 'Test Body', :labels => ['bug', 'custom', 'label']).returns(Hashie::Mash.new('number' => 1))
+        PartyFoul.github.git_data.references.expects(:get).with('test_owner', 'test_repo', 'heads/deploy').returns(Hashie::Mash.new(object: Hashie::Mash.new(sha: 'abcdefg1234567890')))
+        PartyFoul.github.issues.comments.expects(:create).with('test_owner', 'test_repo', 1, body: 'Test Comment')
+        PartyFoul::ExceptionHandler.new(nil, {}).run
+      end
+    end
+
+    context 'when a proc for additional labels are configured' do
+      before do
+        PartyFoul.configure do |config|
+          config.additional_labels = Proc.new do |exception, env|
+            if env[:http_host] =~ /beta\./
+              ['beta']
+            elsif exception.message =~ /Database/
+              ['database_error']
+            end
+          end
+        end
+        PartyFoul::IssueRenderers::Rails.any_instance.stubs(:body).returns('Test Body')
+        PartyFoul::IssueRenderers::Rails.any_instance.stubs(:comment).returns('Test Comment')
+        PartyFoul.github.search.stubs(:issues).with(owner: 'test_owner', repo: 'test_repo', keyword: 'test_fingerprint', state: 'open').returns(Hashie::Mash.new(issues: []))
+        PartyFoul.github.search.stubs(:issues).with(owner: 'test_owner', repo: 'test_repo', keyword: 'test_fingerprint', state: 'closed').returns(Hashie::Mash.new(issues: []))
+        PartyFoul.github.git_data.references.expects(:get).with('test_owner', 'test_repo', 'heads/deploy').returns(Hashie::Mash.new(object: Hashie::Mash.new(sha: 'abcdefg1234567890')))
+        PartyFoul.github.issues.comments.expects(:create).with('test_owner', 'test_repo', 1, body: 'Test Comment')
+      end
+      after do
+        clean_up_party
+      end
+
+      it 'will open a new error on Github with the default labels if no additional labels are returned from the proc' do
+        PartyFoul.github.issues.expects(:create).with('test_owner', 'test_repo', title: 'Test Title', body: 'Test Body', :labels => ['bug']).returns(Hashie::Mash.new('number' => 1))
+        PartyFoul::ExceptionHandler.new(stub(:message => ''), {}).run
+      end
+
+      it 'will open a new error on Github with the additional labels based on the exception message' do
+        PartyFoul.github.issues.expects(:create).with('test_owner', 'test_repo', title: 'Test Title', body: 'Test Body', :labels => ['bug', 'database_error']).returns(Hashie::Mash.new('number' => 1))
+        PartyFoul::ExceptionHandler.new(stub(:message => 'Database'), {}).run
+      end
+
+      it 'will open a new error on Github with the additional labels based on the env' do
+        PartyFoul.github.issues.expects(:create).with('test_owner', 'test_repo', title: 'Test Title', body: 'Test Body', :labels => ['bug', 'beta']).returns(Hashie::Mash.new('number' => 1))
+        PartyFoul::ExceptionHandler.new(stub(:message => ''), {:http_host => 'beta.example.com'}).run
+      end
+    end
   end
 
   context 'when error is not new' do
@@ -52,8 +111,8 @@ describe 'Party Foul Exception Handler' do
     context 'and closed' do
       it 'will update the count on the body and re-open the issue' do
         PartyFoul.github.search.stubs(:issues).with(owner: 'test_owner', repo: 'test_repo', keyword: 'test_fingerprint', state: 'open').returns(Hashie::Mash.new(issues: []))
-        PartyFoul.github.search.stubs(:issues).with(owner: 'test_owner', repo: 'test_repo', keyword: 'test_fingerprint', state: 'closed').returns(Hashie::Mash.new(issues: [{title: 'Test Title', body: 'Test Body', state: 'closed', number: 1}]))
-        PartyFoul.github.issues.expects(:edit).with('test_owner', 'test_repo', 1, body: 'New Body', state: 'open', labels: ['bug', 'regression'])
+        PartyFoul.github.search.stubs(:issues).with(owner: 'test_owner', repo: 'test_repo', keyword: 'test_fingerprint', state: 'closed').returns(Hashie::Mash.new(issues: [{title: 'Test Title', body: 'Test Body', state: 'closed', number: 1, labels: ['staging']}]))
+        PartyFoul.github.issues.expects(:edit).with('test_owner', 'test_repo', 1, body: 'New Body', state: 'open', labels: ['bug', 'regression', 'staging'])
         PartyFoul.github.issues.comments.expects(:create).with('test_owner', 'test_repo', 1, body: 'Test Comment')
         PartyFoul.github.git_data.references.expects(:get).with('test_owner', 'test_repo', 'heads/deploy').returns(Hashie::Mash.new(object: Hashie::Mash.new(sha: 'abcdefg1234567890')))
         PartyFoul::ExceptionHandler.new(nil, {}).run

data/test/test_helper.rb

@@ -24,7 +24,7 @@ module MiniTest::Expectations
 end
 
 def clean_up_party
-  %w{github oauth_token endpoint owner repo blacklisted_exceptions processor web_url branch}.each do |attr|
+  %w{github oauth_token endpoint owner repo blacklisted_exceptions processor web_url branch additional_labels}.each do |attr|
     PartyFoul.send("#{attr}=", nil)
   end
 end

data/test/tmp/config/initializers/party_foul.rb

@@ -22,4 +22,11 @@ PartyFoul.configure do |config|
 
   # The branch for your deployed code
   # config.branch               = 'master'
+
+  # Additional labels to add to issues created
+  # config.additional_labels    = ['production']
+  # or
+  # config.additional_labels    = Proc.new do |exception, env|
+  #   []
+  # end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: party_foul
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -190,6 +190,9 @@ files:
 - lib/party_foul/issue_renderers.rb
 - lib/party_foul/middleware.rb
 - lib/party_foul/processors/base.rb
+- lib/party_foul/processors/delayed_job.rb
+- lib/party_foul/processors/resque.rb
+- lib/party_foul/processors/sidekiq.rb
 - lib/party_foul/processors/sync.rb
 - lib/party_foul/processors.rb
 - lib/party_foul/rackless_exception_handler.rb
@@ -222,7 +225,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -845978866647605957
+      hash: 764634010609561347
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -231,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -845978866647605957
+      hash: 764634010609561347
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23