gbuesing-toadhopper 0.1.0

data/.gitignore

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

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+-r
+README.md
+-
+LICENSE

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Tim Lucas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+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).
+
+    begin
+      raise "Kaboom!"
+    rescue  => e
+      require 'toadhopper'
+      ToadHopper("YOURAPIKEY").post!(e)
+    end
+
+You can install it via rubygems:
+
+    gem install toadhopper
+
+## Development
+
+Firstly, `gem install bundler`, then:
+
+    % git clone git://github.com/toolmantim/toadhopper.git
+    % cd toadhopper
+    % gem bundle
+    % bin/rake test
+
+If you set a `HOPTOAD_API_KEY` environment variable it'll test actually posting to the Hoptoad API. For example:
+
+    % bin/rake test HOPTOAD_API_KEY=abc123
+
+To generate the docs:
+
+    % bin/yardoc
+
+## Contributors
+
+* [Tim Lucas](http://github.com/toolmantim)
+* [Samuel Tesla](http://github.com/stesla)
+* [atmos](http://github.com/atmos)

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+task :default => :test
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "gbuesing-toadhopper"
+    gemspec.summary = "Post error notifications to Hoptoad"
+    gemspec.description = "Fork of toolmantim-toadhopper, with Haml and Nokogiri dependencies removed"
+    gemspec.email = "gbuesing@gmail.com"
+    gemspec.homepage = "http://github.com/gbuesing/toadhopper"
+    gemspec.authors = ["Geoff Buesing"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/gbuesing-toadhopper.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gbuesing-toadhopper}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Geoff Buesing"]
+  s.date = %q{2009-12-29}
+  s.description = %q{Fork of toolmantim-toadhopper, with Haml and Nokogiri dependencies removed}
+  s.email = %q{gbuesing@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     ".yardopts",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "gbuesing-toadhopper.gemspec",
+     "lib/notice.haml",
+     "lib/notice.xml.erb",
+     "lib/toadhopper.rb",
+     "test/helper.rb",
+     "test/test_filters.rb",
+     "test/test_posting.rb"
+  ]
+  s.homepage = %q{http://github.com/gbuesing/toadhopper}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Post error notifications to Hoptoad}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_filters.rb",
+     "test/test_posting.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/notice.haml

@@ -0,0 +1,34 @@
+!!!XML
+%notice{:version => '2.0.0'}
+  %api-key= api_key
+  %notifier
+    %name= notifier_name
+    %version= notifier_version
+    %url= notifier_url
+  %error
+    %class= error.class.name
+    %message= "#{error.class.name}: #{error.message}"
+    %backtrace
+      - backtrace.each do |line|
+        %line{:method => line.method, :file => line.file, :number => line.number}/
+  %request
+    %url= url
+    %component= component
+    - if action && !action.blank?
+      %action= action
+    - if request && request.params.any?
+      %params
+        - request.params.each do |key,value|
+          %var{:key => key}= value
+    - if session && session.any?
+      %session
+        - session.each do |key,value|
+          %var{:key => key}= value
+    - if environment && environment.any?
+      %cgi-data
+        - environment.each do |key,value|
+          %var{:key => key}= value
+
+  %server-environment
+    %project-root= project_root
+    %environment-name= framework_env

data/lib/notice.xml.erb

@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<notice version="2.0.0">
+  <api-key><%=h defaults[:api_key] %></api-key>
+  <notifier>
+    <name><%=h defaults[:notifier_name] %></name>
+    <version><%=h defaults[:notifier_version] %></version>
+    <url><%=h defaults[:notifier_url] %></url>
+  </notifier>
+  <error>
+    <class><%=h defaults[:error].class.name %></class>
+    <message><%=h defaults[:error].class.name %>: <%=h defaults[:error].message %></message>
+    <backtrace>
+      <% defaults[:backtrace].each do |line| %>
+        <line method="<%=h line.method %>" file="<%=h line.file %>" number="<%=h line.number %>"/>
+      <% end %>
+    </backtrace>
+  </error>
+  <request>
+    <url><%=h defaults[:url] %></url>
+    <component><%=h defaults[:component] %></component>
+    <% if defaults[:action] %>
+    <component><%=h defaults[:action] %></component>
+    <% end %>
+    <% if defaults[:request] && defaults[:request].params.any? %>
+    <params>
+      <% defaults[:request].params.each do |key,value| %>
+        <var key="<%=h key %>"><%=h value %></var>
+      <% end %>
+    </params>
+    <% end %>
+    <% if defaults[:session] && defaults[:session].any? %>
+    <session>
+      <% defaults[:session].each do |key,value| %>
+        <var key="<%=h key %>"><%=h value %></var>
+      <% end %>
+    </session>
+    <% end %>
+    <% if defaults[:environment] && defaults[:environment].any? %>
+    <cgi-data>
+      <% defaults[:environment].each do |key,value| %>
+        <var key="<%=h key %>"><%=h value %></var>
+      <% end %>
+    </cgi-data>
+    <% end %>
+  </request>
+  <server-environment>
+    <project-root><%=h defaults[:project_root] %></project-root>
+    <environment-name><%=h defaults[:framework_env] %></environment-name>
+  </server-environment>
+</notice>

data/lib/toadhopper.rb

@@ -0,0 +1,136 @@
+require 'net/http'
+require 'erb'
+
+# Posts errors to the Hoptoad API
+class ToadHopper
+  VERSION = "0.9.3"
+  include ERB::Util
+
+  # Hoptoad API response
+  class Response < Struct.new(:status, :body, :errors); end
+
+  attr_reader :api_key
+
+  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
+
+  # @private
+  def filters
+    [@filters].flatten.compact
+  end
+
+  # Posts an exception to hoptoad.
+  #
+  # @param [Exception] error the error to post
+  #
+  # @param [Hash] options
+  # @option options [String]  url              The url for the request, required to post but not useful in a console environment
+  # @option options [String]  component        Normally this is your Controller name in an MVC framework
+  # @option options [String]  action           Normally the action for your request in an MVC framework
+  # @option options [#params] request          An object that response to #params and returns a hash
+  # @option options [String]  notifier_name    Say you're a different notifier than ToadHopper
+  # @option options [String]  notifier_version Specify the version of your custom notifier
+  # @option options [String]  notifier_url     Specify the project URL of your custom notifier
+  # @option options [Hash]    session          A hash of the user session in a web request
+  # @option options [String]  framework_env    The framework environment your app is running under
+  # @option options [Array]   backtrace        Normally not needed, parsed automatically from the provided exception parameter
+  # @option options [Hash]    environment      You MUST scrub your environment if you plan to use this, please do not use it though. :)
+  # @option options [String]  project_root     The root directory of your app
+  #
+  # @param [Hash] http_headers extra HTTP headers to be sent in the post to the API
+  #
+  # @example
+  #   ToadHopper('apikey').post! error,
+  #                              {:action => 'show', :controller => 'Users'},
+  #                              {'X-Hoptoad-Client-Name' => 'My Awesome Notifier'}
+  #
+  # @return [Response]
+  def post!(error, options={}, http_headers={})
+    options[:notifier_name] ||= 'ToadHopper'
+    post_document(document_for(error, options), {'X-Hoptoad-Client-Name' => options[:notifier_name]})
+  end
+
+  # @private
+  def post_document(document, headers={})
+    uri = URI.parse("http://hoptoadapp.com:80/notifier_api/v2/notices")
+    Net::HTTP.start(uri.host, uri.port) do |http|
+      http.read_timeout = 5 # seconds
+      http.open_timeout = 2 # seconds
+      begin
+        response = http.post uri.path,
+                             document,
+                             {'Content-type' => 'text/xml', 'Accept' => 'text/xml, application/xml'}.merge(headers)
+        Response.new response.code.to_i,
+                     response.body
+      rescue TimeoutError => e
+        Response.new(500, '', ['Timeout error'])
+      end
+    end
+  end
+
+  # @private
+  def document_for(exception, options={})
+    defaults = {
+      :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_version => VERSION,
+      :notifier_url     => 'http://github.com/toolmantim/toadhopper',
+      :session          => {},
+      :framework_env    => ENV['RACK_ENV'] || 'development',
+      :project_root     => Dir.pwd
+    }.merge(options)
+
+    ERB.new(notice_template).result(binding)
+  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.xml.erb'))
+  end
+
+  # @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 filtered_value(key, value)
+    if filters.any? {|f| key.to_s =~ Regexp.new(f)}
+      "[FILTERED]"
+    else
+      value
+    end
+  end
+
+  # @private
+  def serializable?(value)
+    [Fixnum, Array, String, Hash, Bignum].any? {|c| value.is_a?(c)}
+  end
+end
+
+# Convenience method for creating ToadHoppers
+#
+# @return [ToadHopper]
+def ToadHopper(api_key)
+  ToadHopper.new(api_key)
+end

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+
+require File.join(File.dirname(__FILE__), "..", "lib", "toadhopper")

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("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

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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: gbuesing-toadhopper
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Geoff Buesing
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-29 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: Fork of toolmantim-toadhopper, with Haml and Nokogiri dependencies removed
+email: gbuesing@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- .yardopts
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- gbuesing-toadhopper.gemspec
+- lib/notice.haml
+- lib/notice.xml.erb
+- lib/toadhopper.rb
+- test/helper.rb
+- test/test_filters.rb
+- test/test_posting.rb
+has_rdoc: true
+homepage: http://github.com/gbuesing/toadhopper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Post error notifications to Hoptoad
+test_files: 
+- test/helper.rb
+- test/test_filters.rb
+- test/test_posting.rb