toadhopper 0.8 → 0.9

data/.gitignore

@@ -1,7 +1,6 @@
-/dist/
-.yardoc
-/doc/bin
-vendor
-bin
-doc
-toadhopper.gemspec
+/pkg
+/.yardoc
+/vendor
+/bin
+/doc
+/toadhopper.gemspec

data/README.md

@@ -2,13 +2,12 @@ A base library for [Hoptoad](http://www.hoptoadapp.com/) error reporting.
 
 Toadhopper can be used to report plain old Ruby exceptions, or to build a framework-specific gem such as [toadhopper-sinatra](http://github.com/toolmantim/toadhopper-sinatra).
 
-    require 'toadhopper'
-
-    dispatcher = Toadhopper::Dispatcher.new("YOURAPIKEY")
-
-    error = begin; raise "Kaboom!"; rescue => e; e; end
-
-    puts dispatcher.post!(error)
+    begin
+      raise "Kaboom!"
+    rescue  => e
+      require 'toadhopper'
+      ToadHopper.new("YOURAPIKEY").post!(e)
+    end
 
 You can install it via rubygems:
 

data/Rakefile

@@ -14,9 +14,11 @@ Jeweler::Tasks.new do |s|
   s.email    = "t.lucas@toolmantim.com"
   s.homepage = "http://github.com/toolmantim/toadhopper"
   s.authors  = ["Tim Lucas", "Samuel Tesla", "Corey Donohoe"]
-  s.version  = "0.8"
   s.extra_rdoc_files  = ["README.md", "LICENSE"]
   s.executables = nil # stops jeweler automatically adding bin/*
+  
+  require File.join(File.dirname(__FILE__), 'lib', 'toadhopper')
+  s.version  = ToadHopper::VERSION
 
   require 'bundler'
   bundler_env = Bundler::Environment.load(File.dirname(__FILE__) + '/Gemfile')

data/lib/notice.haml

@@ -4,7 +4,7 @@
   %notifier
     %name= notifier_name
     %version= notifier_version
-    %url http://github.com/toolmantim/toadhopper
+    %url= notifier_url
   %error
     %class= error.class.name
     %message= "#{error.class.name}: #{error.message}"
@@ -30,5 +30,5 @@
           %var{:key => key}= value
 
   %server-environment
-    %project-root= Dir.pwd
+    %project-root= project_root
     %environment-name= framework_env

data/lib/toadhopper.rb

@@ -1,153 +1,130 @@
-root = File.expand_path(File.dirname(__FILE__))
 require 'net/http'
 require 'haml'
 require 'haml/engine'
 require 'nokogiri'
-require File.join(root, 'backtrace')
 
-module ToadHopper
+# Posts errors to the Hoptoad API
+class ToadHopper
+  VERSION = "0.9"
+  
   # Hoptoad API response
   class Response < Struct.new(:status, :body, :errors); end
 
-  # Posts errors to the Hoptoad API
-  class Dispatcher
-    attr_reader :api_key
+  attr_reader :api_key
 
-    def initialize(api_key)
-      @api_key = api_key
-    end
-    
-    # Sets patterns to [FILTER] out sensitive data such as passwords, emails and credit card numbers.
-    #
-    #   Toadhopper::Dispatcher.new('apikey').filters = /password/, /email/, /credit_card_number/
-    def filters=(*filters)
-      @filters = filters.flatten
-    end
-
-    # Filters for the Dispatcher
-    #
-    # @return [Regexp]
-    def filters
-      [@filters].flatten.compact
-    end
+  def initialize(api_key)
+    @api_key = api_key
+  end
+  
+  # Sets patterns to +[FILTER]+ out sensitive data such as +/password/+, +/email/+ and +/credit_card_number/+
+  def filters=(*filters)
+    @filters = filters.flatten
+  end
 
-    # Posts an exception to hoptoad.
-    #   Toadhopper::Dispatcher.new('apikey').post!(exception, {:action => 'show', :controller => 'Users'})
-    # The Following Keys are available as parameters to the document_options
-    #   error            The actual exception to be reported
-    #   api_key          The api key for your project
-    #   url              The url for the request, required to post but not useful in a console environment
-    #   component        Normally this is your Controller name in an MVC framework
-    #   action           Normally the action for your request in an MVC framework
-    #   request          An object that response to #params and returns a hash
-    #   notifier_name    Say you're a different notifier than ToadHopper
-    #   notifier_version Specify the version of your custom notifier
-    #   session          A hash of the user session in a web request
-    #   framework_env    The framework environment your app is running under
-    #   backtrace        Normally not needed, parsed automatically from the provided exception parameter
-    #   environment      You MUST scrub your environment if you plan to use this, please do not use it though. :)
-    #
-    # @return Toadhopper::Response
-    def post!(error, document_options={}, header_options={})
-      post_document(document_for(error, document_options), header_options)
-    end
+  # @private
+  def filters
+    [@filters].flatten.compact
+  end
 
-    # Posts a v2 document error to Hoptoad
-    # header_options can be passed in to indicate you're posting from a separate client
-    #   Toadhopper::Dispatcher.new('API KEY').post_document(doc, 'X-Hoptoad-Client-Name' => 'MyCustomDispatcher')
-    #
-    # @private
-    def post_document(document, header_options={})
-      uri = URI.parse("http://hoptoadapp.com:80/notifier_api/v2/notices")
+  # Posts an exception to hoptoad.
+  #   Toadhopper.new('apikey').post!(error, {:action => 'show', :controller => 'Users'})
+  # The Following Keys are available as parameters to the document_options
+  #   url              The url for the request, required to post but not useful in a console environment
+  #   component        Normally this is your Controller name in an MVC framework
+  #   action           Normally the action for your request in an MVC framework
+  #   request          An object that response to #params and returns a hash
+  #   notifier_name    Say you're a different notifier than ToadHopper
+  #   notifier_version Specify the version of your custom notifier
+  #   notifier_url     Specify the project URL of your custom notifier
+  #   session          A hash of the user session in a web request
+  #   framework_env    The framework environment your app is running under
+  #   backtrace        Normally not needed, parsed automatically from the provided exception parameter
+  #   environment      You MUST scrub your environment if you plan to use this, please do not use it though. :)
+  #   project_root     The root directory of your app
+  #
+  # @return Toadhopper::Response
+  def post!(error, document_options={}, header_options={})
+    post_document(document_for(error, document_options), header_options)
+  end
 
-      Net::HTTP.start(uri.host, uri.port) do |http|
-        headers = {
-          'Content-type'             => 'text/xml',
-          'Accept'                   => 'text/xml, application/xml',
-          'X-Hoptoad-Client-Name'    => 'Toadhopper',
-        }.merge(header_options)
-        http.read_timeout = 5 # seconds
-        http.open_timeout = 2 # seconds
-        begin
-          response = http.post uri.path, document, headers
-          response_for(response)
-        rescue TimeoutError => e
-          Response.new(500, '', ['Timeout error'])
-        end
+  # Posts a v2 document error to Hoptoad
+  # header_options can be passed in to indicate you're posting from a separate client
+  #   Toadhopper.new('API KEY').post_document(doc, 'X-Hoptoad-Client-Name' => 'MyCustomLib')
+  #
+  # @private
+  def post_document(document, header_options={})
+    uri = URI.parse("http://hoptoadapp.com:80/notifier_api/v2/notices")
+
+    Net::HTTP.start(uri.host, uri.port) do |http|
+      headers = {
+        'Content-type'             => 'text/xml',
+        'Accept'                   => 'text/xml, application/xml',
+        'X-Hoptoad-Client-Name'    => 'Toadhopper',
+      }.merge(header_options)
+      http.read_timeout = 5 # seconds
+      http.open_timeout = 2 # seconds
+      begin
+        response = http.post(uri.path, document, headers)
+        Response.new response.code.to_i,
+                     response.body,
+                     Nokogiri::XML.parse(response.body).xpath('//errors/error').map {|e| e.content}
+      rescue TimeoutError => e
+        Response.new(500, '', ['Timeout error'])
       end
     end
+  end
 
-    # @private
-    def document_for(exception, options={})
-      locals = {
-        :error            => exception,
-        :api_key          => api_key,
-        :environment      => scrub_environment(ENV.to_hash),
-        :backtrace        => Backtrace.from_exception(exception),
-        :url              => 'http://localhost/',
-        :component        => 'http://localhost/',
-        :action           => nil,
-        :request          => nil,
-        :notifier_name    => 'ToadHopper',
-        :notifier_version => '0.8',
-        :session          => { },
-        :framework_env    => ENV['RACK_ENV'] || 'development' }.merge(options)
-
-      Haml::Engine.new(notice_template).render(Object.new, locals)
-    end
-
-    # @private
-    def response_for(http_response)
-      status = Integer(http_response.code)
-      case status
-      when 422
-        errors = Nokogiri::XML.parse(http_response.body).xpath('//errors/error')
-        Response.new(status, http_response.body, errors.map { |error| error.content })
-      else
-        Response.new(status, http_response.body, [])
-      end
-    end
+  # @private
+  def document_for(exception, options={})
+    locals = {
+      :error            => exception,
+      :api_key          => api_key,
+      :environment      => clean(ENV.to_hash),
+      :backtrace        => exception.backtrace.map {|l| backtrace_line(l)},
+      :url              => 'http://localhost/',
+      :component        => 'http://localhost/',
+      :action           => nil,
+      :request          => nil,
+      :notifier_name    => 'ToadHopper',
+      :notifier_version => VERSION,
+      :notifier_url     => 'http://github.com/toolmantim/toadhopper',
+      :session          => {},
+      :framework_env    => ENV['RACK_ENV'] || 'development',
+      :project_root     => Dir.pwd
+    }.merge(options)
+
+    Haml::Engine.new(notice_template).render(Object.new, locals)
+  end
+  
+  # @private
+  def backtrace_line(line)
+    Struct.new(:file, :number, :method).new(*line.match(%r{^([^:]+):(\d+)(?::in `([^']+)')?$}).captures)
+  end
+  
+  # @private
+  def notice_template
+    File.read(::File.join(::File.dirname(__FILE__), 'notice.haml'))
+  end
 
-    # @private
-    def filter(hash)
-      hash.inject({}) do |acc, (key, val)|
-        acc[key] = filter?(key) ? "[FILTERED]" : val
+  # @private
+  def clean(hash)
+    hash.inject({}) do |acc, (k, v)|
+      acc[k] = (v.is_a?(Hash) ? clean(v) : filtered_value(k,v)) if serializable?(v)
       acc
-      end
-    end
-
-    # @private
-    def filter?(key)
-      filters.any? do |filter|
-        key.to_s =~ Regexp.new(filter)
-      end
-    end
-
-    # @private
-    def scrub_environment(hash)
-      filter(clean_non_serializable_data(hash))
-    end
-
-    # @private
-    def clean_non_serializable_data(data)
-      data.select{|k,v| serializable?(v) }.inject({}) do |h, pair|
-        h[pair.first] = pair.last.is_a?(Hash) ? clean_non_serializable_data(pair.last) : pair.last
-        h
-      end
     end
+  end
 
-    # @private
-    def serializable?(value)
-      value.is_a?(Fixnum) ||
-      value.is_a?(Array) ||
-      value.is_a?(String) ||
-      value.is_a?(Hash) ||
-      value.is_a?(Bignum)
+  # @private
+  def filtered_value(key, value)
+    if filters.any? {|f| key.to_s =~ Regexp.new(f)}
+      "[FILTERED]"
+    else
+      value
     end
+  end
 
-    # @private
-    def notice_template
-      File.read(::File.join(::File.dirname(__FILE__), 'notice.haml'))
-    end
+  # @private
+  def serializable?(value)
+    [Fixnum, Array, String, Hash, Bignum].any? {|c| value.is_a?(c)}
   end
 end

data/test/test_filters.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+
+class ToadHopper::TestFilters < Test::Unit::TestCase
+  def toadhopper
+    @toadhopper ||= ToadHopper.new("test api key")
+  end
+  
+  def test_no_filters
+    assert_equal(                {:id => "myid", :password => "mypassword"},
+                 toadhopper.clean(:id => "myid", :password => "mypassword"))
+  end
+
+  def test_string_filter
+    toadhopper.filters = "pass"
+    assert_equal(                {:id => "myid", :password => "[FILTERED]"},
+                 toadhopper.clean(:id => "myid", :password => "mypassword"))
+  end
+
+  def test_regex_filter
+    toadhopper.filters = /pas{2}/
+    assert_equal(                {:id => "myid", :password => "[FILTERED]"},
+                 toadhopper.clean(:id => "myid", :password => "mypassword"))
+  end
+
+  def test_multiple_filters
+    toadhopper.filters = "email", /pas{2}/
+    assert_equal(                 {:id => "myid", :email => "[FILTERED]", :password => "[FILTERED]"},
+                 toadhopper.clean(:id => "myid", :email => "myemail", :password => "mypassword"))
+  end
+end

data/test/test_posting.rb

@@ -1,21 +1,21 @@
 require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
 
-class ToadHopper::Dispatcher::TestPosting < Test::Unit::TestCase
+class ToadHopper::TestPosting < Test::Unit::TestCase
   def test_posting
-    dispatcher = ToadHopper::Dispatcher.new("abc123")
+    toadhopper = ToadHopper.new("abc123")
     error = begin; raise "Kaboom!"; rescue => e; e end
 
-    response = dispatcher.post!(error)
+    response = toadhopper.post!(error)
     assert_equal 422, response.status
     assert_equal ['No project exists with the given API key.'], response.errors
   end
 
   if ENV['HOPTOAD_API_KEY']
     def test_posting_integration
-      dispatcher = ToadHopper::Dispatcher.new(ENV['HOPTOAD_API_KEY'])
+      toadhopper = ToadHopper.new(ENV['HOPTOAD_API_KEY'])
       error = begin; raise "Kaboom!"; rescue => e; e end
 
-      response = dispatcher.post!(error)
+      response = toadhopper.post!(error)
       assert_equal 200, response.status
       assert_equal [], response.errors
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: toadhopper
 version: !ruby/object:Gem::Version 
-  version: "0.8"
+  version: "0.9"
 platform: ruby
 authors: 
 - Tim Lucas
@@ -40,13 +40,11 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- lib/backtrace.rb
 - lib/notice.haml
 - lib/toadhopper.rb
 - test/helper.rb
-- test/test_filter.rb
+- test/test_filters.rb
 - test/test_posting.rb
-- test/test_setters.rb
 has_rdoc: true
 homepage: http://github.com/toolmantim/toadhopper
 licenses: []
@@ -77,6 +75,5 @@ specification_version: 3
 summary: Post error notifications to Hoptoad
 test_files: 
 - test/helper.rb
-- test/test_filter.rb
+- test/test_filters.rb
 - test/test_posting.rb
-- test/test_setters.rb

data/lib/backtrace.rb

@@ -1,31 +0,0 @@
-module ToadHopper
-  # A line in a ruby Backtrace
-  #
-  # @private
-  class BacktraceLine < Struct.new(:file, :number, :method); end
-
-  # A collection of BacktraceLines representing an entire ruby backtrace
-  #
-  # @private
-  class Backtrace
-    INPUT_FORMAT = %r{^([^:]+):(\d+)(?::in `([^']+)')?$}.freeze
-
-    # the collection of lines in the backtrace
-    attr_reader :lines
-
-    # create a collection of BacktraceLines from an exception
-    def self.from_exception(exception)
-      @lines = exception.backtrace.map do |line|
-        _, file, number, method = line.match(INPUT_FORMAT).to_a
-        BacktraceLine.new(file, number, method)
-      end
-    end
-
-    # iterate over the lines in a Backtrace
-    def each_line(&block)
-      lines.each do |line|
-        yield line
-      end
-    end
-  end
-end

data/test/test_filter.rb

@@ -1,30 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
-
-class ToadHopper::Dispatcher::TestFilter < Test::Unit::TestCase
-  def dispatcher
-    @dispatcher ||= ToadHopper::Dispatcher.new("test api key")
-  end
-  
-  def test_no_filters
-    assert_equal(                 {:id => "myid", :password => "mypassword"},
-                 dispatcher.filter(:id => "myid", :password => "mypassword"))
-  end
-
-  def test_string_filter
-    dispatcher.filters = "pass"
-    assert_equal(                 {:id => "myid", :password => "[FILTERED]"},
-                 dispatcher.filter(:id => "myid", :password => "mypassword"))
-  end
-
-  def test_regex_filter
-    dispatcher.filters = /pas{2}/
-    assert_equal(                 {:id => "myid", :password => "[FILTERED]"},
-                 dispatcher.filter(:id => "myid", :password => "mypassword"))
-  end
-
-  def test_multiple_filters
-    dispatcher.filters = "email", /pas{2}/
-    assert_equal(                 {:id => "myid", :email => "[FILTERED]", :password => "[FILTERED]"},
-                 dispatcher.filter(:id => "myid", :email => "myemail", :password => "mypassword"))
-  end
-end

data/test/test_setters.rb

@@ -1,18 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
-
-class ToadHopper::Dispatcher::TestSetters < Test::Unit::TestCase
-  def test_setting_api_key
-    dispatcher = ToadHopper::Dispatcher.new('abc123')
-    assert_equal "abc123", dispatcher.api_key
-  end
-  def test_setting_single_filter
-    dispatcher = ToadHopper::Dispatcher.new('')
-    dispatcher.filters = /password/
-    assert_equal [/password/], dispatcher.filters
-  end
-  def test_setting_multple_filters
-    dispatcher = ToadHopper::Dispatcher.new('')
-    dispatcher.filters = /password/, /email/
-    assert_equal [/password/, /email/], dispatcher.filters
-  end
-end