party_foul 0.2.0 → 0.3.0

data/README.md

@@ -69,6 +69,9 @@ PartyFoul.configure do |config|
   # 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']
+
   # The OAuth token for the account that will be opening the issues on Github
   config.oauth_token        = 'abcdefgh1234567890'
 

data/lib/generators/party_foul/install_generator.rb

@@ -7,22 +7,15 @@ module PartyFoul
     source_root File.expand_path('../templates', __FILE__)
 
     def create_initializer_file
-      username      = ask 'Github username:'
-      password      = STDIN.noecho do
-        ask 'Github password:'
-      end
-
-      say ''
-
-      @owner    = ask_with_default 'Repository owner:', username
+      login     = ask 'Github login:'
+      password  = STDIN.noecho { ask 'Github password:' }
+      @owner    = ask_with_default "\nRepository owner:", login
       @repo     = ask 'Repository name:'
       @endpoint = ask_with_default 'Endpoint:', 'https://api.github.com'
 
-      github = Github.new :login => username, :password => password, :endpoint => @endpoint
-
       begin
-        github.oauth.create 'scopes' => ['repo']
-        @oauth_token = github.oauth_token
+        github       = Github.new :login => login, :password => password, :endpoint => @endpoint
+        @oauth_token = github.oauth.create('scopes' => ['repo']).token
         template 'party_foul.rb', 'config/initializers/party_foul.rb'
       rescue Github::Error::Unauthorized
         say 'There was an error retrieving your Github OAuth token'

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

@@ -1,18 +1,21 @@
 PartyFoul.configure do |config|
   # the collection of exceptions to be ignored by PartyFoul
   # The constants here *must* be represented as strings
-  config.ignored_exceptions = ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError']
+  config.ignored_exceptions    = ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError']
+
+  # The names of the HTTP headers to not report
+  config.filtered_http_headers = ['Cookie']
 
   # The OAuth token for the account that will be 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 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 %>'
 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, :ignored_exceptions, :adapter, :issue_template, :comment_template
+    attr_accessor :github, :oauth_token, :endpoint, :owner, :repo, :ignored_exceptions, :adapter, :issue_template, :comment_template, :filtered_http_headers
   end
 
   def self.issue_template
@@ -27,6 +27,7 @@ Fingerprint: `:fingerprint`
 <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

data/lib/party_foul/exception_handler.rb

@@ -94,10 +94,19 @@ class PartyFoul::ExceptionHandler
 
   def compile_template(template)
     template.gsub(/:\w+/) do |method|
-      self.send(method.split(':').last)
+      value = self.send(method.split(':').last)
+      if value.kind_of?(Hash)
+        hash_as_table(value)
+      else
+        value
+      end
     end
   end
 
+  def hash_as_table(value)
+    "<table>#{value.map {|key, value| "<tr><th>#{key}</th><td>#{value}</td></tr>"}.join}</table>"
+  end
+
   def occurred_at
     Time.now.strftime('%B %d, %Y %H:%M:%S %z')
   end
@@ -106,8 +115,15 @@ class PartyFoul::ExceptionHandler
     env['REMOTE_ADDR']
   end
 
+  def session
+    env['rack.session']
+  end
+
   def http_headers
-    "<table>#{env.keys.select { |k| k =~ /^HTTP_/ }.sort.map { |k| "<tr><th>#{k.split('HTTP_').last.split('_').map(&:capitalize).join(' ')}</th><td>#{env[k]}</td></tr>" }.join }</table>"
+    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
   end
 
   private

data/lib/party_foul/version.rb

@@ -1,3 +1,3 @@
 module PartyFoul
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/test/generator_test.rb

@@ -8,10 +8,9 @@ class PartyFoul::GeneratorTest < Rails::Generators::TestCase
   test 'it copies the initializer' do
     oauth = mock('Oauth')
     oauth.stubs(:create)
-    oauth.expects(:create).with('scopes' => ['repo'])
+    oauth.expects(:create).with('scopes' => ['repo']).returns(Hashie::Mash.new(token: 'test_token'))
     github = mock('Github')
     github.stubs(:oauth).returns(oauth)
-    github.stubs(:oauth_token).returns('test_token')
     Github.stubs(:new).with(:login => 'test_login', :password => 'test_password', :endpoint => 'test_endpoint').returns(github)
     $stdin.stubs(:gets).returns('test_login').then.returns('test_password').then.returns('').then.returns('test_repo').then.returns("test_endpoint").then.returns('')
     run_generator

data/test/party_foul/exception_handler_test.rb

@@ -4,7 +4,11 @@ require 'action_dispatch/http/parameter_filter'
 
 describe 'Party Foul Exception Handler' do
   before do
-    Time.stubs(:now).returns(Time.at(0))
+    Time.stubs(:now).returns(Time.new(1970, 1, 1, 0, 0, 0, '-05:00'))
+  end
+
+  after do
+    clean_up_party
   end
 
   describe '#body' do
@@ -21,7 +25,7 @@ describe 'Party Foul Exception Handler' do
 <table>
 <tr><th>Exception</th><td>Test Exception</td></tr>
 <tr><th>Count</th><td>1</td></tr>
-<tr><th>Last Occurance</th><td>December 31, 1969 19:00:00 -0500</td></tr>
+<tr><th>Last Occurance</th><td>January 01, 1970 00:00:00 -0500</td></tr>
 </table>
 
 ## Stack Trace
@@ -60,7 +64,7 @@ Fingerprint: `abcdefg1234567890`
 <table>
 <tr><th>Exception</th><td>Test Exception</td></tr>
 <tr><th>Count</th><td>1</td></tr>
-<tr><th>Last Occurance</th><td>December 31, 1969 19:00:00 -0500</td></tr>
+<tr><th>Last Occurance</th><td>January 01, 1970 00:00:00 -0500</td></tr>
 </table>
 
 ## Stack Trace
@@ -102,7 +106,8 @@ Fingerprint: `abcdefg1234567890`
         'HTTP_USER_AGENT' => 'test_user_agent',
         'REMOTE_ADDR' => '127.0.0.1',
         'HTTP_HOST' => 'localhost:3000',
-        'QUERY_STRING' => { :controller => 'landing', :action => 'index' }
+        'QUERY_STRING' => { :controller => 'landing', :action => 'index' },
+        'rack.session' => { :id => 1 }
       }
       @handler = PartyFoul::ExceptionHandler.new(nil, env)
     end
@@ -110,10 +115,11 @@ Fingerprint: `abcdefg1234567890`
     it 'renders a new comment' do
       expected_comment = <<-COMMENT
 <table>
-<tr><th>Occurred at</th><td>December 31, 1969 19:00:00 -0500</td></tr>
-<tr><th>Params</th><td>{:controller=>"landing", :action=>"index"}</td></tr>
+<tr><th>Occurred at</th><td>January 01, 1970 00:00:00 -0500</td></tr>
+<tr><th>Params</th><td><table><tr><th>controller</th><td>landing</td></tr><tr><th>action</th><td>index</td></tr></table></td></tr>
 <tr><th>IP Address</th><td>127.0.0.1</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>
+<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
 
@@ -130,4 +136,26 @@ COMMENT
       @handler.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',
+      }
+      @handler = PartyFoul::ExceptionHandler.new(nil, env)
+    end
+
+    it 'ignored Cookie' do
+      @handler.http_headers.must_equal('User-Agent' => 'test_user_agent')
+    end
+  end
+
+  describe '#hash_as_table' do
+    it 'renders as an HTML table' do
+      expected = '<table><tr><th>Value 1</th><td>A</td></tr><tr><th>Value B</th><td>2</td></tr></table>'
+      PartyFoul::ExceptionHandler.new(nil, nil).hash_as_table('Value 1' => 'A', 'Value B' => 2).must_equal expected
+    end
+  end
 end

data/test/test_helper.rb

@@ -21,7 +21,7 @@ module MiniTest::Expectations
 end
 
 def clean_up_party
-  %w{github oauth_token endpoint owner repo ignored_exceptions}.each do |attr|
+  %w{github oauth_token endpoint owner repo ignored_exceptions adapter issue_template comment_template filtered_http_headers}.each do |attr|
     PartyFoul.send("#{attr}=", nil)
   end
 end

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

@@ -1,18 +1,21 @@
 PartyFoul.configure do |config|
   # the collection of exceptions to be ignored by PartyFoul
   # The constants here *must* be represented as strings
-  config.ignored_exceptions = ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError']
+  config.ignored_exceptions    = ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError']
+
+  # The names of the HTTP headers to not report
+  config.filtered_http_headers = ['Cookie']
 
   # The OAuth token for the account that will be 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           = 'test_endpoint'
+  config.endpoint              = 'test_endpoint'
 
   # The organization or user that owns the target repository
-  config.owner              = 'test_login'
+  config.owner                 = 'test_login'
 
   # The repository for this application
-  config.repo               = 'test_repo'
+  config.repo                  = 'test_repo'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: party_foul
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -193,7 +193,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1173897567857159302
+      hash: 3070115477891214928
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -202,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1173897567857159302
+      hash: 3070115477891214928
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23