toadhopper 0.3 → 0.4

data/Readme.md

@@ -1,19 +1,16 @@
-Toadhopper
-----------
-
 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 library specific gem, such as the yet-to-be-built toadhopper-sinatra and toadhopper-rack gems (they're next on my list).
 
 ## Example
 
-     require 'rubygems'
+    require 'rubygems'
 
-     gem 'toadhopper'
-     require 'toadhopper'
+    gem 'toadhopper'
+    require 'toadhopper'
 
-     Toadhopper.api_key = "YOURAPIKEY"
+    Toadhopper.api_key = "YOURAPIKEY"
 
-     error = begin; raise "Kaboom!"; rescue => e; e; end
+    error = begin; raise "Kaboom!"; rescue => e; e; end
 
-     puts Toadhopper.post!(error)
+    puts Toadhopper.post!(error)

data/lib/toadhopper/test/methods.rb

@@ -0,0 +1,19 @@
+require 'toadhopper'
+
+module Toadhopper
+module Test
+# Helper methods for testing Toadhopper posting
+module Methods
+  # Stub the posting of the error, storing the post params for accessing via
+  # last_toadhopper_post_params
+  def stub_toadhopper_post!
+    def Toadhopper.post!(*args)
+      Toadhopper.instance_variable_set(:@last_post_arguments, args)
+    end
+  end
+  def last_toadhopper_post_arguments
+    Toadhopper.instance_variable_get(:@last_post_arguments)
+  end
+end
+end
+end

data/lib/toadhopper/test.rb

@@ -1,13 +1 @@
-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
+require 'toadhopper/test/methods'

data/lib/toadhopper.rb

@@ -2,77 +2,77 @@ require 'net/http'
 require 'yaml'
 
 module Toadhopper
-  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 TimeoutError => e
-        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)
-      ))
+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
-    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
+  # 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 TimeoutError => e
       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
-    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
+  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: toadhopper
 version: !ruby/object:Gem::Version 
-  version: "0.3"
+  version: "0.4"
 platform: ruby
 authors: 
 - Tim Lucas
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-11 00:00:00 +10:00
+date: 2009-09-16 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -26,6 +26,7 @@ files:
 - Rakefile
 - lib/toadhopper.rb
 - lib/toadhopper/test.rb
+- lib/toadhopper/test/methods.rb
 - test/test_filter.rb
 - test/test_notice_params.rb
 - test/test_setters.rb