party_foul 0.5.0 → 0.6.0

data/README.md

@@ -16,10 +16,10 @@ following:
    unique title, session information, and stack trace. The issue is
 tagged as a `bug`. A new comment is added with relevant data on the
 application state.
-3. If an open issue is found the occurance count and time stamp is
+3. If an open issue is found the occurence count and time stamp is
    updated. A new comment is added with relevant data on the
 application state.
-4. If a closed issue is found the occurance count and time stamp is
+4. If a closed issue is found the occurence count and time stamp is
    updated. The issue is reopened and a `regression` tag is
 added. A new comment is added with relevant data on the
 application state.
@@ -64,32 +64,29 @@ You need to initialize `PartyFoul`, use the following:
 
 ```ruby
 PartyFoul.configure do |config|
-  # the collection of exceptions to be ignored by PartyFoul
+  # The collection of exceptions PartyFoul should not be allowed to handle
   # The constants here *must* be represented as strings
-  config.ignored_exceptions    = ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError']
-
-  # The names of the HTTP headers to not report
-  config.filtered_http_headers = ['Cookie']
+  config.blacklisted_exceptions = ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError']
 
   # The OAuth token for the account that is opening the issues on Github
-  config.oauth_token           = 'abcdefgh1234567890'
+  config.oauth_token            = 'abcdefgh1234567890'
 
   # The API endpoint for Github. Unless you are hosting a private
   # instance of Enterprise Github you do not need to include this
-  config.endpoint              = 'https://api.github.com'
+  config.endpoint               = 'https://api.github.com'
 
   # The Web URL for Github. Unless you are hosting a private
   # instance of Enterprise Github you do not need to include this
-  config.web_url               = 'https://github.com'
+  config.web_url                = 'https://github.com'
 
   # The organization or user that owns the target repository
-  config.owner                 = 'owner_name'
+  config.owner                  = 'owner_name'
 
   # The repository for this application
-  config.repo                  = 'repo_name'
+  config.repo                   = 'repo_name'
 
   # The branch for your deployed code
-  # config.branch              = 'master'
+  # config.branch               = 'master'
 end
 ```
 
@@ -98,8 +95,8 @@ You can generate an OAuth token from via the
 with cURL:
 
 ```bash
-curl -X POST -i -d "{ \"scopes\": [\"repo\"] }" \
-https://<github_login>:<github_password>@api.github.com/authorizations
+curl -u <github_login> -i -d "{ \"scopes\": [\"repo\"] }" \
+https://api.github.com/authorizations
 ```
 
 Add as the very last middleware in your production `Rack` stack.
@@ -128,25 +125,34 @@ end
 
 ```
 
-### Changing How Issues Are Reported ###
+### Using PartyFoul with Sidekiq
+
+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).
 
-`PartyFoul` comes with default templates for what the body of issues and
-comments are. If you want to override these templates you simply need to
-add them as an option in your initializer:
+File: config/initializers/partyfoul_sidekiq.rb
 
 ```ruby
-PartyFoul.configure do |config|
-  config.issue_body   = ':issue_title'
-  config.comment_body = ':occurred_at'
+module PartyFoul
+  class Sidekiq
+    def call(worker, msg, queue)
+      begin
+        yield
+      rescue => ex
+        PartyFoul::RacklessExceptionHandler.handle(ex, {class: worker.class.name, method: queue, params: msg})
+        raise
+      end
+    end
+  end
+end
+
+::Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add ::PartyFoul::Sidekiq
+  end
 end
 ```
 
-In this over-simplistic example the words that start with `:` in the
-templates are evaluated with the value of the corresponding named
-instance method on the instance of `PartyFoul::IssueRenderer`. If you
-want to add additional values for replacement you should open that class
-to add the methods. Depending upon the data point you may want o make
-the change in one of the [different issue renderer adapters](https://github.com/dockyard/party_foul/tree/master/lib/party_foul/issue_renderers).
+This will pass the worker class name and queue as well as all worker-related parameters off to PartyFoul before passing on the exception.
 
 ## Authors ##
 

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

@@ -1,28 +1,25 @@
 PartyFoul.configure do |config|
-  # the collection of exceptions to be ignored by PartyFoul
+  # The collection of exceptions PartyFoul should not be allowed to handle
   # The constants here *must* be represented as strings
-  config.ignored_exceptions    = ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError']
-
-  # The names of the HTTP headers to not report
-  config.filtered_http_headers = ['Cookie']
+  config.blacklisted_exceptions = ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError']
 
   # The OAuth token for the account that is opening the issues on Github
-  config.oauth_token           = '<%= @oauth_token %>'
+  config.oauth_token            = '<%= @oauth_token %>'
 
   # The API endpoint for Github. Unless you are hosting a private
   # instance of Enterprise Github you do not need to include this
-  config.endpoint              = '<%= @endpoint %>'
+  config.endpoint               = '<%= @endpoint %>'
 
   # The Web URL for Github. Unless you are hosting a private
   # instance of Enterprise Github you do not need to include this
-  config.web_url               = '<%= @web_url %>'
+  config.web_url                = '<%= @web_url %>'
 
   # The organization or user that owns the target repository
-  config.owner                 = '<%= @owner %>'
+  config.owner                  = '<%= @owner %>'
 
   # The repository for this application
-  config.repo                  = '<%= @repo %>'
+  config.repo                   = '<%= @repo %>'
 
   # The branch for your deployed code
-  # config.branch              = 'master'
+  # config.branch               = 'master'
 end

data/lib/party_foul.rb

@@ -2,9 +2,11 @@ require 'github_api'
 
 module PartyFoul
   class << self
-    attr_accessor :github, :oauth_token, :endpoint, :owner, :repo,
-      :ignored_exceptions, :processor, :issue_template,
-      :comment_template, :filtered_http_headers, :web_url, :branch
+    attr_accessor :github, :oauth_token, :endpoint, :owner, :repo, :blacklisted_exceptions, :processor, :web_url, :branch, :whitelisted_rack_variables
+  end
+
+  def self.whitelisted_rack_variables
+    @whitelisted_rack_variables ||= %w{GATEWAY_INTERFACE PATH_INFO REMOTE_ADDR REMOTE_HOST REQUEST_METHOD REQUEST_URI SERVER_NAME SERVER_PORT SERVER_PROTOCOL SERVER_SOFTWARE HTTP_HOST HTTP_CONNECTION HTTP_CACHE_CONTROL HTTP_ACCEPT HTTP_USER_AGENT HTTP_ACCEPT_ENCODING HTTP_ACCEPT_LANGUAGE HTTP_ACCEPT_CHARSET rack.version rack.input rack.errors rack.multithread rack.multiprocess rack.run_once rack.url_scheme HTTP_VERSION REQUEST_PATH ORIGINAL_FULLPATH action_dispatch.routes action_dispatch.parameter_filter action_dispatch.secret_token action_dispatch.show_exceptions action_dispatch.show_detailed_exceptions action_dispatch.logger action_dispatch.backtrace_cleaner action_dispatch.request_id action_dispatch.remote_ip rack.session rack.session.options rack.request.cookie_hash rack.request.cookie_string action_dispatch.cookies action_dispatch.request.unsigned_session_cookie action_dispatch.request.path_parameters action_controller.instance action_dispatch.request.request_parameters rack.request.query_string rack.request.query_hash action_dispatch.request.query_parameters action_dispatch.request.parameters action_dispatch.request.formats}
   end
 
   # The git branch that is used for linking in the stack trace
@@ -22,38 +24,20 @@ module PartyFoul
     @web_url ||= 'https://github.com'
   end
 
-  # The template used for rendering the body of a new issue
+  # The api endpoint for Github. This is only interesting for Enterprise
+  # users
   #
-  # @return [String]
-  def self.issue_template
-    @issue_template ||=
-    <<-TEMPLATE
-<table>
-<tr><th>Exception</th><td>:exception</td></tr>
-<tr><th>Count</th><td>1</td></tr>
-<tr><th>Last Occurance</th><td>:occurred_at</td></tr>
-</table>
-
-## Stack Trace
-<pre>:stack_trace</pre>
-Fingerprint: `:fingerprint`
-    TEMPLATE
+  # @return [String] Defaults to 'https://api.github.com' if not set
+  def self.endpoint
+    @endpoint ||= 'https://api.github.com'
   end
 
-  # The template used for rendering the body of a new comment
+  # The processor to be used when handling the exception. Defaults to a
+  # synchrons processor
   #
-  # @return [String]
-  def self.comment_template
-    @comment_template ||=
-    <<-TEMPLATE
-<table>
-<tr><th>Occurred at</th><td>:occurred_at</td></tr>
-<tr><th>Params</th><td>:params</td></tr>
-<tr><th>IP Address</th><td>:ip_address</td></tr>
-<tr><th>Session</th><td>:session</td></tr>
-<tr><th>HTTP Headers</th><td>:http_headers</td></tr>
-</table>
-    TEMPLATE
+  # @return [Class] Defaults to 'PartyFoul::Processors:Sync
+  def self.processor
+    @processor ||= PartyFoul::Processors::Sync
   end
 
   # The collection of exceptions that should not be captured. Members of
@@ -67,8 +51,8 @@ Fingerprint: `:fingerprint`
   #     [ActiveRecord::RecordNotFound]
   #
   # @return [Array]
-  def self.ignored_exceptions
-    @ignored_exceptions || []
+  def self.blacklisted_exceptions
+    @blacklisted_exceptions || []
   end
 
   # The url of the repository. Built using the {.web_url}, {.owner}, and {.repo}
@@ -87,20 +71,17 @@ Fingerprint: `:fingerprint`
   #       config.oauth_token = ENV['oauth_token']
   #     end
   #
+  # Will also setup for Github api connections
+  #
   # @param [Block]
   def self.configure(&block)
     yield self
-    self.processor ||= PartyFoul::Processors::Sync
-    _self = self
-    self.github ||= Github.new do |config|
-      %w{endpoint oauth_token}.each do |option|
-        config.send("#{option}=", _self.send(option)) if !_self.send(option).nil?
-      end
-    end
+    self.github ||= Github.new oauth_token: oauth_token, endpoint: endpoint
   end
 end
 
 require 'party_foul/exception_handler'
-require 'party_foul/issue_renderer'
+require 'party_foul/rackless_exception_handler'
+require 'party_foul/issue_renderers'
 require 'party_foul/middleware'
 require 'party_foul/processors'

data/lib/party_foul/exception_handler.rb

@@ -7,7 +7,7 @@ class PartyFoul::ExceptionHandler
   #
   # @param [Exception, Hash]
   def self.handle(exception, env)
-    PartyFoul.processor.handle(exception, env)
+    PartyFoul.processor.handle(exception, clean_env(env))
   end
 
   # Makes an attempt to determine what framework is being used and will use the proper
@@ -16,9 +16,9 @@ class PartyFoul::ExceptionHandler
   # @param [Exception, Hash]
   def initialize(exception, env)
     renderer_klass = if defined?(Rails)
-                       PartyFoul::RailsIssueRenderer
+                       PartyFoul::IssueRenderers::Rails
                      else
-                       PartyFoul::RackIssueRenderer
+                       PartyFoul::IssueRenderers::Rack
                      end
 
     self.rendered_issue = renderer_klass.new(exception, env)
@@ -69,6 +69,10 @@ class PartyFoul::ExceptionHandler
 
   private
 
+  def self.clean_env(env)
+    env.select { |key, value| PartyFoul.whitelisted_rack_variables.include?(key) }
+  end
+
   def fingerprint
     rendered_issue.fingerprint
   end

data/lib/party_foul/issue_renderers.rb

@@ -0,0 +1,5 @@
+module PartyFoul::IssueRenderers; end
+require 'party_foul/issue_renderers/base'
+require 'party_foul/issue_renderers/rack'
+require 'party_foul/issue_renderers/rails'
+require 'party_foul/issue_renderers/rackless'

data/lib/party_foul/{issue_renderer.rb → issue_renderers/base.rb}

@@ -1,4 +1,4 @@
-class PartyFoul::IssueRenderer
+class PartyFoul::IssueRenderers::Base
   attr_accessor :exception, :env, :sha
 
   # A new renderer instance for Githug issues
@@ -16,18 +16,27 @@ class PartyFoul::IssueRenderer
     raise NotImplementedError
   end
 
-  # Will compile the template for an issue body as defined in
-  # {PartyFoul.issue_template}
+  # Renders the issue body
+  #
+  # Customize by overriding {#body_options}
   #
   # @return [String]
   def body
-    compile_template(PartyFoul.issue_template)
+    <<-BODY
+#{build_table_from_hash(body_options)}
+
+## Stack Trace
+<pre>#{stack_trace}</pre>
+Fingerprint: `#{fingerprint}`
+BODY
   end
 
-  # Will compile the template for a comment body as defined in
-  # {PartyFoul.comment_template}
+  # Renderes the issue comment
+  #
+  # Customize by overriding {#comment_options}
+  #
   def comment
-    compile_template(PartyFoul.comment_template)
+    build_table_from_hash(comment_options)
   end
 
   # Compiles the stack trace for use in the issue body. Lines in the
@@ -67,21 +76,13 @@ class PartyFoul::IssueRenderer
     begin
       current_count = old_body.match(/<th>Count<\/th><td>(\d+)<\/td>/)[1].to_i
       old_body.sub!("<th>Count</th><td>#{current_count}</td>", "<th>Count</th><td>#{current_count + 1}</td>")
-      old_body.sub!(/<th>Last Occurance<\/th><td>.+<\/td>/, "<th>Last Occurance</th><td>#{occurred_at}</td>")
+      old_body.sub!(/<th>Last Occurrence<\/th><td>.+<\/td>/, "<th>Last Occurrence</th><td>#{occurred_at}</td>")
       old_body
     rescue
       self.body
     end
   end
 
-  # The params hash at the time the exception occurred. This method is
-  # overriden for each framework adapter. It should return a hash.
-  #
-  # @return [NotImplementedError]
-  def params
-    raise NotImplementedError
-  end
-
   # The timestamp when the exception occurred.
   #
   # @return [String]
@@ -89,48 +90,45 @@ class PartyFoul::IssueRenderer
     Time.now.strftime('%B %d, %Y %H:%M:%S %z')
   end
 
-  # IP address of the client who triggered the exception
+  # The hash used for building the table in issue body
   #
-  # @return [String]
-  def ip_address
-    env['REMOTE_ADDR']
+  # @return [Hash]
+  def body_options(count = 0)
+    { Exception: exception, 'Last Occurrence' => occurred_at, Count: count + 1 }
   end
 
-  # The session hash for the client at the time of the exception
+  # The hash used for building the table in the comment body
   #
   # @return [Hash]
-  def session
-    env['rack.session']
+  def comment_options
+    { 'Occurred At' => occurred_at }
   end
 
-  # HTTP Headers hash from the request. Headers can be filtered out by
-  # adding matching key names to {PartyFoul.filtered_http_headers}
+
+  # Builds an HTML table from hash
   #
-  # @return [Hash]
-  def http_headers
-    env.keys.select { |key| key =~ /^HTTP_(\w+)/ && !(PartyFoul.filtered_http_headers || []).include?($1.split('_').map(&:capitalize).join('-')) }.sort.inject({}) do |hash, key|
-      hash[key.split('HTTP_').last.split('_').map(&:capitalize).join('-')] = env[key]
-      hash
-    end
+  # @return [String]
+  def build_table_from_hash(hash)
+    "<table>#{rows_for_table_from_hash(hash)}</table>"
   end
 
-  def compile_template(template)
-    template.gsub(/:\w+/) do |method|
-      value = self.send(method.split(':').last)
-      if value.kind_of?(Hash)
-        hash_as_table(value)
-      else
-        value
+  # Builds the rows of an HTML table from hash.
+  # Keys as Headers cells and Values as Data cells
+  # If the Value is a Hash it will be rendered as a table
+  #
+  # @return [String]
+  def rows_for_table_from_hash(hash)
+    hash.inject('') do |rows, row|
+      key, value = row
+      if row[1].kind_of?(Hash)
+        value = build_table_from_hash(row[1])
       end
+      rows << "<tr><th>#{key}</th><td>#{value}</td></tr>"
     end
   end
 
   private
 
-  def hash_as_table(value)
-    "<table>#{value.map {|key, value| "<tr><th>#{key}</th><td>#{value}</td></tr>"}.join}</table>"
-  end
-
   def app_root
     Dir.pwd
   end
@@ -139,6 +137,3 @@ class PartyFoul::IssueRenderer
     backtrace_line.match(/#{app_root}\/((.+?):(\d+))/)
   end
 end
-
-require 'party_foul/issue_renderers/rack'
-require 'party_foul/issue_renderers/rails'

data/lib/party_foul/issue_renderers/rack.rb

@@ -1,19 +1,45 @@
-require 'party_foul/issue_renderer'
+class PartyFoul::IssueRenderers::Rack < PartyFoul::IssueRenderers::Base
+  # Title for the issue comprised of (exception) "message"
+  #
+  # @return [String]
+  def title
+    %{(#{exception.class}) "#{exception.message}"}
+  end
+
+  def comment_options
+    super.merge(URL: url, Params: params, Session: session, 'IP Address' => ip_address, 'HTTP Headers' => http_headers)
+  end
+
+  # Rack params
+  #
+  # @return [Hash]
+  def params
+    env['QUERY_STRING']
+  end
 
-module PartyFoul
-  class RackIssueRenderer < IssueRenderer
-    # Rack params
-    #
-    # @return [Hash]
-    def params
-      env['QUERY_STRING']
-    end
+  # IP address of the client who triggered the exception
+  #
+  # @return [String]
+  def ip_address
+    env['REMOTE_ADDR']
+  end
+
+  def url
+    "[#{env['REQUEST_METHOD']}] #{env['REQUEST_URI']}"
+  end
+
+  # The session hash for the client at the time of the exception
+  #
+  # @return [Hash]
+  def session
+    env['rack.session']
+  end
 
-    # Title for the issue comprised of (exception) "message"
-    #
-    # @return [String]
-    def title
-      %{(#{exception.class}) "#{exception.message}"}
-    end
+  # HTTP Headers hash from the request. Headers can be filtered out by
+  # adding matching key names to {PartyFoul.blacklisted_headers}
+  #
+  # @return [Hash]
+  def http_headers
+    { Version: env['HTTP_VERSION'], 'User Agent' => env['HTTP_USER_AGENT'], 'Accept Encoding' => env['HTTP_ACCEPT_ENCODING'], Accept: env['HTTP_ACCEPT'] }
   end
 end

data/lib/party_foul/issue_renderers/rackless.rb

@@ -0,0 +1,26 @@
+require 'party_foul/issue_renderers/base'
+
+class PartyFoul::IssueRenderers::Rackless < PartyFoul::IssueRenderers::Base
+  # env in a rackless environment is expected to contain three keys:
+  # class: name of the class that raised the exception
+  # method: name of the method that raised the exception
+  # params: parameters passed to the method that raised the exception
+
+  # Rails params hash. Filtered parms are respected.
+  #
+  # @return [Hash]
+  def params
+    env[:params]
+  end
+
+  # Title for the issue comprised of Controller#action (exception) "message"
+  #
+  # @return [String]
+  def title
+    %{#{env[:class]}##{env[:method]} (#{exception.class}) "#{exception.message}"}
+  end
+
+  def comment_options
+    super.merge(Params: params)
+  end
+end

data/lib/party_foul/issue_renderers/rails.rb

@@ -1,26 +1,30 @@
-require 'party_foul/issue_renderer'
+class PartyFoul::IssueRenderers::Rails < PartyFoul::IssueRenderers::Rack
+  # Title for the issue comprised of Controller#action (exception) "message"
+  #
+  # @return [String]
+  def title
+    %{#{env['action_controller.instance'].class}##{env['action_dispatch.request.path_parameters']['action']} (#{exception.class}) "#{exception.message}"}
+  end
 
-module PartyFoul
-  class RailsIssueRenderer < IssueRenderer
-    # Rails params hash. Filtered parms are respected.
-    #
-    # @return [Hash]
-    def params
-      parameter_filter = ActionDispatch::Http::ParameterFilter.new(env["action_dispatch.parameter_filter"])
-      parameter_filter.filter(env['action_dispatch.request.path_parameters'])
-    end
+  # Rails params hash. Filtered parms are respected.
+  #
+  # @return [Hash]
+  def params
+    parameter_filter = ActionDispatch::Http::ParameterFilter.new(env["action_dispatch.parameter_filter"])
+    parameter_filter.filter(env['action_dispatch.request.path_parameters'])
+  end
 
-    # Title for the issue comprised of Controller#action (exception) "message"
-    #
-    # @return [String]
-    def title
-      %{#{env['action_controller.instance'].class}##{env['action_dispatch.request.path_parameters']['action']} (#{exception.class}) "#{exception.message}"}
-    end
+  # Rails session hash. Filtered parms are respected.
+  #
+  # @return [Hash]
+  def session
+    parameter_filter = ActionDispatch::Http::ParameterFilter.new(env['action_dispatch.parameter_filter'])
+    parameter_filter.filter(env['rack.session'])
+  end
 
-    private
+  private
 
-    def app_root
-      Rails.root
-    end
+  def app_root
+    Rails.root
   end
 end

data/lib/party_foul/middleware.rb

@@ -16,8 +16,8 @@ module PartyFoul
     private
 
     def allow_handling?(captured_exception)
-      !PartyFoul.ignored_exceptions.find do |ignored_exception|
-        names = ignored_exception.split('::')
+      !PartyFoul.blacklisted_exceptions.find do |blacklisted_exception|
+        names = blacklisted_exception.split('::')
         names.shift if names.empty? || names.first.empty?
 
         constant = Object

data/lib/party_foul/processors.rb

@@ -1,4 +1,2 @@
-module PartyFoul::Processors
-end
-
+module PartyFoul::Processors; end
 require 'party_foul/processors/sync'

data/lib/party_foul/processors/base.rb

@@ -0,0 +1,11 @@
+class PartyFoul::Processors::Base
+  # Passes the exception and rack env data to the ExceptionHandler and
+  # runs everything synchronously. This base class method must be
+  # overriden by any inheriting class.
+  #
+  # @param [Exception, Hash]
+  # @return [NotImplementedError]
+  def self.handle(exception, env)
+    raise NotImplementedError
+  end
+end

data/lib/party_foul/processors/sync.rb

@@ -1,4 +1,6 @@
-class PartyFoul::Processors::Sync
+require 'party_foul/processors/base'
+
+class PartyFoul::Processors::Sync < PartyFoul::Processors::Base
   # Passes the exception and rack env data to the ExceptionHandler and
   # runs everything synchronously.
   #

data/lib/party_foul/rackless_exception_handler.rb

@@ -0,0 +1,17 @@
+class PartyFoul::RacklessExceptionHandler < PartyFoul::ExceptionHandler
+  # This handler will pass the exception and working environment from Rack off to a processor.
+  # The default PartyFoul processor will work synchronously. Processor adapters can be written
+  # to push this logic to a background job if desired.
+  #
+  # @param [Exception, Hash]
+  def self.handle(exception, env)
+    self.new(exception, clean_env(env)).run
+  end
+
+  # Uses the Rackless IssueRenderer for a rackless environment
+  #
+  # @param [Exception, Hash]
+  def initialize(exception, env)
+    self.rendered_issue = PartyFoul::IssueRenderers::Rackless.new(exception, env)
+  end
+end

data/lib/party_foul/version.rb

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

data/test/party_foul/configure_test.rb

@@ -8,7 +8,7 @@ describe 'Party Foul Confg' do
 
   it 'sets the proper config variables' do
     PartyFoul.configure do |config|
-      config.ignored_exceptions = ['StandardError']
+      config.blacklisted_exceptions = ['StandardError']
       config.oauth_token        = 'test_token'
       config.web_url            = 'http://example.com'
       config.endpoint           = 'http://api.example.com'
@@ -17,7 +17,7 @@ describe 'Party Foul Confg' do
       config.branch             = 'master'
     end
 
-    PartyFoul.ignored_exceptions.must_equal ['StandardError']
+    PartyFoul.blacklisted_exceptions.must_equal ['StandardError']
     PartyFoul.github.must_be_instance_of Github::Client
     PartyFoul.github.oauth_token.must_equal 'test_token'
     PartyFoul.github.endpoint.must_equal 'http://api.example.com'

data/test/party_foul/exception_handler_test.rb

@@ -16,14 +16,14 @@ describe 'Party Foul Exception Handler' do
     PartyFoul.github.issues.stubs(:edit)
     PartyFoul.github.issues.stubs(:comments).returns(mock('Comments'))
     PartyFoul.github.issues.comments.stubs(:create)
-    PartyFoul::RailsIssueRenderer.any_instance.stubs(:title).returns('Test Title')
-    PartyFoul::RailsIssueRenderer.any_instance.stubs(:fingerprint).returns('test_fingerprint')
+    PartyFoul::IssueRenderers::Rails.any_instance.stubs(:title).returns('Test Title')
+    PartyFoul::IssueRenderers::Rails.any_instance.stubs(:fingerprint).returns('test_fingerprint')
   end
 
   context 'when error is new' do
     it 'will open a new error on Github' do
-      PartyFoul::RailsIssueRenderer.any_instance.stubs(:body).returns('Test Body')
-      PartyFoul::RailsIssueRenderer.any_instance.stubs(:comment).returns('Test Comment')
+      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']).returns(Hashie::Mash.new('number' => 1))
@@ -35,8 +35,8 @@ describe 'Party Foul Exception Handler' do
 
   context 'when error is not new' do
     before do
-      PartyFoul::RailsIssueRenderer.any_instance.stubs(:update_body).returns('New Body')
-      PartyFoul::RailsIssueRenderer.any_instance.stubs(:comment).returns('Test Comment')
+      PartyFoul::IssueRenderers::Rails.any_instance.stubs(:update_body).returns('New Body')
+      PartyFoul::IssueRenderers::Rails.any_instance.stubs(:comment).returns('Test Comment')
     end
 
     context 'and open' do
@@ -63,7 +63,7 @@ describe 'Party Foul Exception Handler' do
 
   context 'when issue is marked as "wontfix"' do
     it 'does nothing' do
-      PartyFoul::RailsIssueRenderer.any_instance.stubs(:body).returns('Test Body')
+      PartyFoul::IssueRenderers::Rails.any_instance.stubs(:body).returns('Test Body')
       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, 'labels' => ['wontfix']}]))
       PartyFoul.github.issues.expects(:create).never

data/test/party_foul/issue_renderers/base_test.rb

@@ -0,0 +1,91 @@
+require 'test_helper'
+require 'active_support/core_ext/object/blank'
+require 'action_dispatch/http/parameter_filter'
+
+describe 'Party Foul Issue Renderer Base' do
+  before do
+    Time.stubs(:now).returns(Time.new(1970, 1, 1, 0, 0, 0, '-05:00'))
+  end
+
+  after do
+    clean_up_party
+  end
+
+  describe '#body' do
+    describe 'updating issue body' do
+      before do
+        @rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+        @rendered_issue.stubs(:exception).returns('Test Exception')
+        @rendered_issue.stubs(:fingerprint).returns('abcdefg1234567890')
+        @rendered_issue.stubs(:stack_trace)
+      end
+
+      it 'updates count and timestamp' do
+        body = <<-BODY
+<table>
+<tr><th>Exception</th><td>Test Exception</td></tr>
+<tr><th>Count</th><td>1</td></tr>
+<tr><th>Last Occurrence</th><td>January 01, 1970 00:00:00 -0500</td></tr>
+</table>
+
+## Stack Trace
+<pre></pre>
+Fingerprint: `abcdefg1234567890`
+    BODY
+
+        Time.stubs(:now).returns(Time.new(1985, 10, 25, 1, 22, 0, '-05:00'))
+
+        expected_body = <<-BODY
+<table>
+<tr><th>Exception</th><td>Test Exception</td></tr>
+<tr><th>Count</th><td>2</td></tr>
+<tr><th>Last Occurrence</th><td>October 25, 1985 01:22:00 -0500</td></tr>
+</table>
+
+## Stack Trace
+<pre></pre>
+Fingerprint: `abcdefg1234567890`
+    BODY
+
+        @rendered_issue.update_body(body).must_equal expected_body
+      end
+    end
+
+    describe 'empty body' do
+      before do
+        @rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+        @rendered_issue.stubs(:exception).returns('Test Exception')
+        @rendered_issue.stubs(:fingerprint).returns('abcdefg1234567890')
+        @rendered_issue.stubs(:stack_trace)
+      end
+
+      it 'resets body' do
+        expected_body = <<-BODY
+<table><tr><th>Exception</th><td>Test Exception</td></tr><tr><th>Last Occurrence</th><td>January 01, 1970 00:00:00 -0500</td></tr><tr><th>Count</th><td>1</td></tr></table>
+
+## Stack Trace
+<pre></pre>
+Fingerprint: `abcdefg1234567890`
+    BODY
+        @rendered_issue.update_body(nil).must_equal expected_body
+      end
+    end
+  end
+
+  describe '#build_table_from_hash' do
+    it 'builds an HTML table from a hash' do
+      rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+      hash = { 'Value 1' => 'abc', 'Value 2' => { 'Value A' => 123, 'Value B' => 456 } }
+      expected = '<table><tr><th>Value 1</th><td>abc</td></tr><tr><th>Value 2</th><td><table><tr><th>Value A</th><td>123</td></tr><tr><th>Value B</th><td>456</td></tr></table></td></tr></table>'
+      rendered_issue.build_table_from_hash(hash).must_equal expected
+    end
+  end
+
+  describe '#fingerprint' do
+    it 'SHA1s the title' do
+      rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+      rendered_issue.stubs(:title).returns('abcdefg1234567890')
+      rendered_issue.fingerprint.must_equal Digest::SHA1.hexdigest(rendered_issue.title)
+    end
+  end
+end

data/test/party_foul/issue_renderers/rack_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 describe 'Rack Issue Renderer' do
   describe '#params' do
     before do
-      @rendered_issue = PartyFoul::RackIssueRenderer.new(nil, {'QUERY_STRING' => { 'status' => 'ok' } })
+      @rendered_issue = PartyFoul::IssueRenderers::Rack.new(nil, {'QUERY_STRING' => { 'status' => 'ok' } })
     end
 
     it 'returns ok' do
@@ -17,7 +17,7 @@ describe 'Rack Issue Renderer' do
     end
 
     it 'constructs the title with the class and instance method' do
-      @rendered_issue = PartyFoul::RackIssueRenderer.new(@exception, {})
+      @rendered_issue = PartyFoul::IssueRenderers::Rack.new(@exception, {})
       @rendered_issue.title.must_equal %{(Exception) "message"}
     end
   end

data/test/party_foul/issue_renderers/rackless_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+describe 'Rackless Issue Renderer' do
+  before do
+    @env = { :params => { :val1 => '1', :val2 => '2' }, :class => 'Worker', :method => 'perform' }
+  end
+
+  describe '#params' do
+    before do
+      @rendered_issue = PartyFoul::IssueRenderers::Rackless.new(nil, @env)
+    end
+
+    it 'returns the parameters' do
+      @rendered_issue.params[:val1].must_equal '1'
+      @rendered_issue.params[:val2].must_equal '2'
+    end
+  end
+
+  describe '#title' do
+    before do
+      @exception = Exception.new('message')
+      @rendered_issue = PartyFoul::IssueRenderers::Rackless.new(@exception, @env)
+    end
+
+    it 'constructs the title with the controller and action' do
+      @rendered_issue.title.must_equal %{Worker#perform (Exception) "message"}
+    end
+  end
+end

data/test/party_foul/issue_renderers/rails_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 describe 'Rails Issue Renderer' do
   describe '#params' do
     before do
-      @rendered_issue = PartyFoul::RailsIssueRenderer.new(nil, {'action_dispatch.parameter_filter' => ['password'], 'action_dispatch.request.path_parameters' => { 'status' => 'ok', 'password' => 'test' }, 'QUERY_STRING' => { 'status' => 'fail' } })
+      @rendered_issue = PartyFoul::IssueRenderers::Rails.new(nil, {'action_dispatch.parameter_filter' => ['password'], 'action_dispatch.request.path_parameters' => { 'status' => 'ok', 'password' => 'test' }, 'QUERY_STRING' => { 'status' => 'fail' } })
     end
 
     it 'returns ok' do
@@ -12,6 +12,17 @@ describe 'Rails Issue Renderer' do
     end
   end
 
+  describe '#session' do
+    before do
+      @rendered_issue = PartyFoul::IssueRenderers::Rails.new(nil, {'action_dispatch.parameter_filter' => ['password'], 'rack.session' => { 'status' => 'ok', 'password' => 'test' }, 'QUERY_STRING' => { 'status' => 'fail' } })
+    end
+
+    it 'returns ok' do
+      @rendered_issue.session['status'].must_equal 'ok'
+      @rendered_issue.session['password'].must_equal '[FILTERED]'
+    end
+  end
+
   describe '#title' do
     before do
       @exception = Exception.new('message')
@@ -21,7 +32,7 @@ describe 'Rails Issue Renderer' do
         'action_dispatch.request.path_parameters' => { 'controller' => 'landing', 'action' => 'index' },
         'action_controller.instance' => controller_instance
       }
-      @rendered_issue = PartyFoul::RailsIssueRenderer.new(@exception, env)
+      @rendered_issue = PartyFoul::IssueRenderers::Rails.new(@exception, env)
     end
 
     it 'constructs the title with the controller and action' do

data/test/party_foul/middleware_test.rb

@@ -33,7 +33,7 @@ describe 'Party Foul Middleware' do
 
   context 'filtering based upon exception' do
     before do
-      PartyFoul.ignored_exceptions = ['StandardError']
+      PartyFoul.blacklisted_exceptions = ['StandardError']
       self.stubs(:error_to_raise).returns(StandardError)
     end
 

data/test/party_foul/rackless_exception_handler_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+describe 'Party Foul Rackless Exception Handler' do
+  before do
+    PartyFoul.configure do |config|
+      config.oauth_token = 'abcdefg1234567890'
+      config.owner       = 'test_owner'
+      config.repo        = 'test_repo'
+    end
+  end
+
+  describe '#handle' do
+    it 'will call run on itself' do
+      PartyFoul::RacklessExceptionHandler.any_instance.expects(:run)
+      PartyFoul::RacklessExceptionHandler.handle(nil, {})
+    end
+  end
+
+  describe '#initialize' do
+    it 'should use PartyFoul::IssueRenderers::Rackless for rendering issues' do
+      issue_renderer = PartyFoul::RacklessExceptionHandler.new(nil, {}).rendered_issue
+      assert_kind_of(PartyFoul::IssueRenderers::Rackless, issue_renderer)
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,13 +1,16 @@
+require 'bundler/setup'
+
 if defined?(M)
   require 'minitest/spec'
 else
   require 'minitest/autorun'
 end
-require 'rack/test'
-require 'mocha/setup'
-unless ENV['CI']
+begin
   require 'debugger'
+rescue LoadError
 end
+require 'rack/test'
+require 'mocha/setup'
 require 'party_foul'
 
 class MiniTest::Spec
@@ -21,7 +24,7 @@ module MiniTest::Expectations
 end
 
 def clean_up_party
-  %w{github oauth_token endpoint owner repo ignored_exceptions processor issue_template comment_template filtered_http_headers web_url branch}.each do |attr|
+  %w{github oauth_token endpoint owner repo blacklisted_exceptions processor web_url branch}.each do |attr|
     PartyFoul.send("#{attr}=", nil)
   end
 end

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

@@ -1,28 +1,25 @@
 PartyFoul.configure do |config|
-  # the collection of exceptions to be ignored by PartyFoul
+  # The collection of exceptions PartyFoul should not be allowed to handle
   # The constants here *must* be represented as strings
-  config.ignored_exceptions    = ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError']
-
-  # The names of the HTTP headers to not report
-  config.filtered_http_headers = ['Cookie']
+  config.blacklisted_exceptions = ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError']
 
   # The OAuth token for the account that is opening the issues on Github
-  config.oauth_token           = 'test_token'
+  config.oauth_token            = 'test_token'
 
   # The API endpoint for Github. Unless you are hosting a private
   # instance of Enterprise Github you do not need to include this
-  config.endpoint              = 'http://api.example.com'
+  config.endpoint               = 'http://api.example.com'
 
   # The Web URL for Github. Unless you are hosting a private
   # instance of Enterprise Github you do not need to include this
-  config.web_url               = 'http://example.com'
+  config.web_url                = 'http://example.com'
 
   # The organization or user that owns the target repository
-  config.owner                 = 'test_owner'
+  config.owner                  = 'test_owner'
 
   # The repository for this application
-  config.repo                  = 'test_repo'
+  config.repo                   = 'test_repo'
 
   # The branch for your deployed code
-  # config.branch              = 'master'
+  # config.branch               = 'master'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: party_foul
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-28 00:00:00.000000000 Z
+date: 2013-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -28,6 +28,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: io-console
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -167,12 +183,16 @@ files:
 - lib/generators/party_foul/install_generator.rb
 - lib/generators/party_foul/templates/party_foul.rb
 - lib/party_foul/exception_handler.rb
-- lib/party_foul/issue_renderer.rb
+- lib/party_foul/issue_renderers/base.rb
 - lib/party_foul/issue_renderers/rack.rb
+- lib/party_foul/issue_renderers/rackless.rb
 - lib/party_foul/issue_renderers/rails.rb
+- lib/party_foul/issue_renderers.rb
 - lib/party_foul/middleware.rb
+- lib/party_foul/processors/base.rb
 - lib/party_foul/processors/sync.rb
 - lib/party_foul/processors.rb
+- lib/party_foul/rackless_exception_handler.rb
 - lib/party_foul/version.rb
 - lib/party_foul.rb
 - Rakefile
@@ -180,10 +200,12 @@ files:
 - test/generator_test.rb
 - test/party_foul/configure_test.rb
 - test/party_foul/exception_handler_test.rb
-- test/party_foul/issue_renderer_test.rb
+- test/party_foul/issue_renderers/base_test.rb
 - test/party_foul/issue_renderers/rack_test.rb
+- test/party_foul/issue_renderers/rackless_test.rb
 - test/party_foul/issue_renderers/rails_test.rb
 - test/party_foul/middleware_test.rb
+- test/party_foul/rackless_exception_handler_test.rb
 - test/test_helper.rb
 - test/tmp/config/initializers/party_foul.rb
 homepage: https://github.com/dockyard/party_foul
@@ -200,7 +222,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -549281873562555121
+      hash: -845978866647605957
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -209,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -549281873562555121
+      hash: -845978866647605957
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -220,9 +242,11 @@ test_files:
 - test/generator_test.rb
 - test/party_foul/configure_test.rb
 - test/party_foul/exception_handler_test.rb
-- test/party_foul/issue_renderer_test.rb
+- test/party_foul/issue_renderers/base_test.rb
 - test/party_foul/issue_renderers/rack_test.rb
+- test/party_foul/issue_renderers/rackless_test.rb
 - test/party_foul/issue_renderers/rails_test.rb
 - test/party_foul/middleware_test.rb
+- test/party_foul/rackless_exception_handler_test.rb
 - test/test_helper.rb
 - test/tmp/config/initializers/party_foul.rb

data/test/party_foul/issue_renderer_test.rb

@@ -1,139 +0,0 @@
-require 'test_helper'
-require 'active_support/core_ext/object/blank'
-require 'action_dispatch/http/parameter_filter'
-
-describe 'Party Foul Issue Renderer' do
-  before do
-    Time.stubs(:now).returns(Time.new(1970, 1, 1, 0, 0, 0, '-05:00'))
-  end
-
-  after do
-    clean_up_party
-  end
-
-  describe '#body' do
-    describe 'updating issue body' do
-      before do
-        @rendered_issue = PartyFoul::IssueRenderer.new(nil, nil)
-        @rendered_issue.stubs(:exception).returns('Test Exception')
-        @rendered_issue.stubs(:fingerprint).returns('abcdefg1234567890')
-        @rendered_issue.stubs(:stack_trace)
-      end
-
-      it 'updates count and timestamp' do
-        body = <<-BODY
-<table>
-<tr><th>Exception</th><td>Test Exception</td></tr>
-<tr><th>Count</th><td>1</td></tr>
-<tr><th>Last Occurance</th><td>January 01, 1970 00:00:00 -0500</td></tr>
-</table>
-
-## Stack Trace
-<pre></pre>
-Fingerprint: `abcdefg1234567890`
-    BODY
-
-        Time.stubs(:now).returns(Time.new(1985, 10, 25, 1, 22, 0, '-05:00'))
-
-        expected_body = <<-BODY
-<table>
-<tr><th>Exception</th><td>Test Exception</td></tr>
-<tr><th>Count</th><td>2</td></tr>
-<tr><th>Last Occurance</th><td>October 25, 1985 01:22:00 -0500</td></tr>
-</table>
-
-## Stack Trace
-<pre></pre>
-Fingerprint: `abcdefg1234567890`
-    BODY
-
-        @rendered_issue.update_body(body).must_equal expected_body
-      end
-    end
-
-    describe 'empty body' do
-      before do
-        @rendered_issue = PartyFoul::IssueRenderer.new(nil, nil)
-        @rendered_issue.stubs(:exception).returns('Test Exception')
-        @rendered_issue.stubs(:fingerprint).returns('abcdefg1234567890')
-        @rendered_issue.stubs(:stack_trace)
-      end
-
-      it 'resets body' do
-        expected_body = <<-BODY
-<table>
-<tr><th>Exception</th><td>Test Exception</td></tr>
-<tr><th>Count</th><td>1</td></tr>
-<tr><th>Last Occurance</th><td>January 01, 1970 00:00:00 -0500</td></tr>
-</table>
-
-## Stack Trace
-<pre></pre>
-Fingerprint: `abcdefg1234567890`
-    BODY
-        @rendered_issue.update_body(nil).must_equal expected_body
-      end
-    end
-  end
-
-  describe '#issue_comment' do
-    before do
-      env = {
-        'REQUEST_URI' => 'http://example.com/',
-        'HTTP_USER_AGENT' => 'test_user_agent',
-        'REMOTE_ADDR' => '127.0.0.1',
-        'HTTP_HOST' => 'localhost:3000',
-        'rack.session' => { :id => 1 }
-      }
-      @rendered_issue = PartyFoul::IssueRenderer.new(nil, env)
-      @rendered_issue.stubs(:params).returns({})
-    end
-
-    it 'renders a new comment' do
-      expected_comment = <<-COMMENT
-<table>
-<tr><th>Occurred at</th><td>January 01, 1970 00:00:00 -0500</td></tr>
-<tr><th>Params</th><td><table></table></td></tr>
-<tr><th>IP Address</th><td>127.0.0.1</td></tr>
-<tr><th>Session</th><td><table><tr><th>id</th><td>1</td></tr></table></td></tr>
-<tr><th>HTTP Headers</th><td><table><tr><th>Host</th><td>localhost:3000</td></tr><tr><th>User-Agent</th><td>test_user_agent</td></tr></table></td></tr>
-</table>
-COMMENT
-
-      @rendered_issue.comment.must_equal expected_comment
-    end
-  end
-
-  describe '#compile_template' do
-    it 'it parses the tags and inserts proper data' do
-      template = '<span>:data1</span><div>:data2</div>'
-      @rendered_issue = PartyFoul::IssueRenderer.new(nil, nil)
-      @rendered_issue.stubs(:data1).returns('123')
-      @rendered_issue.stubs(:data2).returns('abc')
-      @rendered_issue.compile_template(template).must_equal '<span>123</span><div>abc</div>'
-    end
-  end
-
-  describe '#http_headers' do
-    before do
-      PartyFoul.filtered_http_headers = ['Cookie']
-      env = {
-        'HTTP_USER_AGENT' => 'test_user_agent',
-        'HTTP_COOKIE' => 'test_cookie',
-      }
-      @rendered_issue = PartyFoul::IssueRenderer.new(nil, env)
-    end
-
-    it 'ignored Cookie' do
-      @rendered_issue.http_headers.must_equal('User-Agent' => 'test_user_agent')
-    end
-  end
-
-  describe '#fingerprint' do
-    it 'SHA1s the title' do
-      rendered_issue = PartyFoul::IssueRenderer.new(nil, nil)
-      rendered_issue.stubs(:title).returns('abcdefg1234567890')
-      rendered_issue.fingerprint.must_equal Digest::SHA1.hexdigest(rendered_issue.title)
-    end
-  end
-end