toolmantim-toadhopper 0.2

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+begin
+  gem "sr-mg", "<= 0.0.5"
+  require "mg"
+  MG.new("toadhopper.gemspec")
+rescue LoadError
+end

data/Readme.md

@@ -0,0 +1,19 @@
+Toadhopper
+----------
+
+A base library for Hoptoad reporting.
+
+You can use this to report plain old Ruby exceptions, or to build a library specific gem such as the yet-to-be-built toadhopper-sinatra and toadhopper-rack gems (that's next on my list).
+
+## Example
+
+     require 'rubygems'
+
+     gem 'toadhopper'
+     require 'toadhopper'
+
+     Toadhopper.api_key = "YOURAPIKEY"
+
+     error = begin; raise "Kaboom!"; rescue => e; e; end
+
+     puts Toadhopper.post!(error)

data/lib/toadhopper.rb

@@ -0,0 +1,81 @@
+require 'net/http'
+require 'yaml'
+require 'timeout'
+
+module Toadhopper
+  class PostTimeoutError < StandardError; end
+  class << self
+    # Set the API key
+    def api_key=(key)
+      @@api_key = key
+    end
+    # Returns the key set by Toadhopper.api_key=
+    def api_key
+      @@api_key
+    end
+    # Sets patterns to [FILTER] out sensitive data such as passwords, emails and credit card numbers.
+    #
+    #   Toadhopper.filters = /password/, /email/, /credit_card_number/
+    def filters=(*filters)
+      @@filters = filters.flatten
+    end
+    # Returns the filters set by Toadhopper.filters=
+    def filters
+      [@@filters].flatten.compact
+    end
+    # Replaces the values of the keys matching Toadhopper.filters with [FILTERED]. Typically used on the params and environment hashes.
+    def filter(hash)
+      hash.inject({}) do |acc, (key, val)|
+        acc[key] = filters.any? {|f| key.to_s =~ Regexp.new(f)} ? "[FILTERED]" : val
+        acc
+      end
+    end
+    # Posts an error to Hoptoad
+    def post!(error, options={}, header_options={})
+      uri = URI.parse("http://hoptoadapp.com/notices/")
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        headers = {
+          'Content-type'             => 'application/x-yaml',
+          'Accept'                   => 'text/xml, application/xml',
+          'X-Hoptoad-Client-Name'    => 'Toadhopper',
+        }.merge(header_options)
+        http.read_timeout = 5 # seconds
+        http.open_timeout = 2 # seconds
+        begin
+          http.post uri.path, {"notice" => notice_params(error, options)}.to_yaml, headers
+        rescue Timeout::TimeoutError => e
+          raise ToadHopper::PostTimeoutError
+        end
+       end
+    end
+    def notice_params(error, options={}) # :nodoc:
+      clean_non_serializable_data(stringify_keys(
+        {
+          :api_key       => api_key,
+          :error_class   => error.class.name,
+          :error_message => error.message,
+          :backtrace     => error.backtrace,
+        }.merge(options)
+      ))
+    end
+    def stringify_keys(hash) #:nodoc:
+      hash.inject({}) do |h, pair|
+        h[pair.first.to_s] = pair.last.is_a?(Hash) ? stringify_keys(pair.last) : pair.last
+        h
+      end
+    end
+    def serializable?(value) #:nodoc:
+      value.is_a?(Fixnum) ||
+      value.is_a?(Array) ||
+      value.is_a?(String) ||
+      value.is_a?(Hash) ||
+      value.is_a?(Bignum)
+    end
+    def clean_non_serializable_data(data) #:nodoc:
+      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
+end

data/lib/toadhopper/test.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + "/../toadhopper"
+
+# Helper methods for testing Toadhopper posting
+module Toadhopper::Test
+  # Stub the posting of the error, storing the post params for accessing via
+  # last_toadhopper_post_params
+  def stub_toadhopper_post!
+    # TODO:
+  end
+  def last_toadhopper_post_params
+    # TODO:
+  end
+end

data/test/test_filter.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + "/../lib/toadhopper"
+
+require 'test/unit'
+
+class Toadhopper::TestFilter < Test::Unit::TestCase
+  def setup
+    Toadhopper.filters = nil
+  end
+  def test_no_filters
+    assert_equal(                 {:id => "myid", :password => "mypassword"},
+                 Toadhopper.filter(:id => "myid", :password => "mypassword"))
+  end
+  def test_string_filter
+    Toadhopper.filters = "pass"
+    assert_equal(                 {:id => "myid", :password => "[FILTERED]"},
+                 Toadhopper.filter(:id => "myid", :password => "mypassword"))
+  end
+  def test_regex_filter
+    Toadhopper.filters = /pas{2}/
+    assert_equal(                 {:id => "myid", :password => "[FILTERED]"},
+                 Toadhopper.filter(:id => "myid", :password => "mypassword"))
+  end
+  def test_multiple_filters
+    Toadhopper.filters = "email", /pas{2}/
+    assert_equal(                 {:id => "myid", :email => "[FILTERED]", :password => "[FILTERED]"},
+                 Toadhopper.filter(:id => "myid", :email => "myemail", :password => "mypassword"))
+  end
+end

data/test/test_notice_params.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + "/../lib/toadhopper"
+
+require 'test/unit'
+
+class Toadhopper::TestNoticeParams < Test::Unit::TestCase
+  def test_notice_params
+    Toadhopper.api_key = "abc123"
+    error = begin; raise "Kaboom!"; rescue => e; e end
+    def error.backtrace; ["backtrace line 1", "backtrace line 2"] end
+    assert_equal({
+      "api_key"       => "abc123",
+      "error_class"   => "RuntimeError",
+      "error_message" => "Kaboom!",
+      "backtrace"     => ["backtrace line 1", "backtrace line 2"],
+      "request"       => {"request_var" => "request_val"},
+      "environment"   => {"env_var" => "env_val"},
+      "session"       => {"session_var" => "session_val"},
+      },
+      Toadhopper.notice_params(
+        error,
+        {
+          "request" => {"request_var" => "request_val"},
+          "environment" => {"env_var" => "env_val"},
+          "session" => {"session_var" => "session_val"}
+        }
+      )
+    )
+  end
+end

data/test/test_setters.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + "/../lib/toadhopper"
+
+require 'test/unit'
+
+class Toadhopper::TestSetters < Test::Unit::TestCase
+  def setup
+    Toadhopper.api_key = nil
+    Toadhopper.filters = nil
+  end
+  def test_setting_api_key
+    Toadhopper.api_key = "abc123"
+    assert_equal "abc123", Toadhopper.api_key
+  end
+  def test_setting_single_filter
+    Toadhopper.filters = /password/
+    assert_equal [/password/], Toadhopper.filters
+  end
+  def test_setting_multple_filters
+    Toadhopper.filters = /password/, /email/
+    assert_equal [/password/, /email/], Toadhopper.filters
+  end
+end

data/test/test_test.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + "/../lib/toadhopper/test"
+
+require 'test/unit'
+
+class Toadhopper::TestTest < Test::Unit::TestCase
+  def test_stub_toadhopper_post!
+    # TODO:
+  end
+  def test_last_toadhopper_post_params
+    # TODO:
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: toolmantim-toadhopper
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Tim Lucas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Library for posting Hoptoad notifications
+email: t.lucas@toolmantim.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Readme.md
+files: 
+- Readme.md
+- Rakefile
+- lib/toadhopper.rb
+- lib/toadhopper/test.rb
+- test/test_filter.rb
+- test/test_notice_params.rb
+- test/test_setters.rb
+- test/test_test.rb
+has_rdoc: true
+homepage: http://github.com/toolmantim/toadhopper
+post_install_message: 
+rdoc_options: []
+
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Library for posting Hoptoad notifications
+test_files: []
+