toadhopper-sinatra 0.7 → 0.10

data/README.md

@@ -16,21 +16,6 @@
                              \ \ /\/\  
                              /\/\
 
-How?
-
-    require 'sinatra/toadhopper'
-    
-    set :toadhopper, :api_key => "your hoptoad API key", :filters => /password/
-    
-    get "/" do
-      raise "Kaboom!"
-    end
-    
-    error do
-      post_error_to_hoptoad!
-      "Ouch, that hurt."
-    end
-
-Install it via rubygems:
+For usage see example.rb. To install:
 
     gem install toadhopper-sinatra

data/Rakefile

@@ -17,7 +17,7 @@ begin
   gem "yard"
   require 'yard'
   YARD::Rake::YardocTask.new do |t|
-    t.options = ['-r', 'README.md', '--files', 'LICENSE'] # optional
+    t.options = ['-r', 'README.md', '--files', 'example.rb', 'LICENSE', 'example.rb'] # optional
   end
 rescue Gem::LoadError
 end

data/example.rb

@@ -0,0 +1,14 @@
+require 'sinatra'
+require 'sinatra/toadhopper'
+
+set :toadhopper, :api_key => "apikey", :filters => /password/
+
+post "/register" do
+  session[:user_id] = 42
+  raise "Kaboom!"
+end
+
+error do
+  post_error_to_hoptoad!
+  "Ouch, that hurt."
+end

data/lib/sinatra/toadhopper.rb

@@ -3,31 +3,31 @@ require 'toadhopper'
 
 module Sinatra
   # The Toadhopper helper methods
-  module Toadhopper
+  module ToadHopper
+    VERSION = "0.10"
     # Reports the current sinatra error to Hoptoad
     def post_error_to_hoptoad!
-      options.toadhopper.each_pair {|k, v| ::Toadhopper.__send__("#{k}=", v)} if options.respond_to?(:toadhopper)
-      unless ::Toadhopper.api_key
-        STDERR.puts "WARNING: Ignoring hoptoad notification - :api_key not set"
-        return
+      unless options.toadhopper && options.toadhopper[:api_key]
+        STDERR.puts "ToadHopper api key not set, e.g. set :toadhopper, :api_key => 'my api key'"
       end
-      ::Toadhopper.post!(
+      toadhopper = ToadHopper(options.toadhopper[:api_key])
+      toadhopper.filters = options.toadhopper[:filters] if options.toadhopper[:filters]
+      toadhopper.post!(
         env['sinatra.error'],
         {
-          :environment => ENV,
-          :request     => {
-            :params => params,
-            :rails_root => options.root,
-            :url => request.url
-          },
-          :session => {
-            :key => 42, # Doesn't apply to Rack sessions
-            :data => session
-          }
+          :url => request.url,
+          :request => request,
+          :session => session.to_hash,
+          :environment => ENV.to_hash,
+          :framework_env => options.environment.to_s,
+          :project_root => options.root,
+          :notifier_name => (notifier_name = "toadhopper-sinatra"),
+          :notifier_version => VERSION,
+          :notifier_url => 'http://github.com/toolmantim/toadhopper-sinatra'
         },
-        {'X-Hoptoad-Client-Name'    => 'toadhopper-sinatra'}
+        {'X-Hoptoad-Client-Name' => notifier_name}
       )
     end
   end
-  helpers Toadhopper
+  helpers ToadHopper
 end

data/test_example.rb

@@ -0,0 +1,67 @@
+require 'test/unit'
+
+require 'rr'
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit
+end
+
+require 'rack/test'
+
+toadhopper_dir = "#{File.dirname(__FILE__)}/../toadhopper"
+raise "#{toadhopper_dir} does not exist" unless File.directory?(toadhopper_dir)
+$:.unshift "#{toadhopper_dir}/lib"
+
+$:.unshift "#{File.dirname(__FILE__)}/lib"
+
+require "#{File.dirname(__FILE__)}/example"
+
+Sinatra::Application.set :environment, :production
+
+class Sinatra::ToadHopper::TestExample < Test::Unit::TestCase
+  
+  include Rack::Test::Methods
+
+  def app; Sinatra::Application end
+
+  def setup
+    app.set :environment, :production
+
+    @toadhopper = ::ToadHopper.new("")
+    stub(::ToadHopper).new do |api_key|
+      @api_key = api_key
+      @toadhopper
+    end
+    stub(@toadhopper).post! do |*args|
+      @error, @options, @header = *args
+    end
+
+    post "/register", :name => "Billy", :password => "Bob"
+  end
+
+  def test_api_key_set
+    assert_equal "apikey", @api_key
+  end
+  def test_filter_set
+    assert_equal [/password/], @toadhopper.filters
+  end
+  def test_reported_error
+    assert_equal RuntimeError, @error.class
+    assert_equal "Kaboom!", @error.message
+  end
+
+  def test_options
+    assert_equal ENV.to_hash, @options[:environment]
+    assert_equal "http://example.org/register", @options[:url]
+    assert @options[:request]
+    assert @options[:request].respond_to?(:params)
+    assert @options[:framework_env] = "production"
+    assert @options[:project_root] = app.root
+    assert @options[:session] = {:user_id => 42}
+    assert @options[:notifier_name] = "toadhopper-sinatra"
+  end
+  
+  def test_header_options
+    assert_equal "toadhopper-sinatra", @header['X-Hoptoad-Client-Name']
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: toadhopper-sinatra
 version: !ruby/object:Gem::Version 
-  version: "0.7"
+  version: "0.10"
 platform: ruby
 authors: 
 - Tim Lucas
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-17 00:00:00 +10:00
+date: 2010-01-21 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -18,9 +18,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: "0.6"
+        version: 0.9.4
     version: 
 description: Post Hoptoad notifications from Sinatra
 email: t.lucas@toolmantim.com
@@ -29,16 +29,19 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- Readme.md
+- README.md
+- LICENSE
 files: 
 - README.md
 - Rakefile
 - LICENSE
 - lib/sinatra/toadhopper.rb
-- test/test_report_error_to_hoptoad.rb
-- Readme.md
+- example.rb
+- test_example.rb
 has_rdoc: true
 homepage: http://github.com/toolmantim/toadhopper-sinatra
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -59,9 +62,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: th-sinatra
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Post Hoptoad notifications from Sinatra
 test_files: []
 

data/Readme.md

@@ -1,36 +0,0 @@
-[Hoptoad](http://www.hoptoadapp.com/) meets [Sinatra](http://www.sinatrarb.com/).
-
-        _____                                ,
-       /     \______                         |\        __
-      | o     |     \____                    | |      |--|             __
-      /\_____/           \___                |/       |  |            |~'
-     /                       \              /|_      () ()            |
-    |_______/                 \            //| \             |\      ()
-      \______   _       ___    \          | \|_ |            | \
-            /\_//      /   \    |          \_|_/            ()  |
-           // //______/    /___/             |                  |
-          /\/\/\      \   / \ \             @'                 ()
-                        \ \   \ \      
-                          \ \   \ \    
-                            \ \  \ \   
-                             \ \ /\/\  
-                             /\/\
-
-How?
-
-    require 'sinatra/toadhopper'
-    
-    set :toadhopper, :api_key => "your hoptoad API key", :filters => /password/
-    
-    get "/" do
-      raise "Kaboom!"
-    end
-    
-    error do
-      post_error_to_hoptoad!
-      "Ouch, that hurt."
-    end
-
-Install it via rubygems:
-
-    gem install toadhopper-sinatra

data/test/test_report_error_to_hoptoad.rb

@@ -1,71 +0,0 @@
-require 'rubygems'
-
-require 'test/unit'
-
-require 'rr'
-class Test::Unit::TestCase
-  include RR::Adapters::TestUnit
-end
-
-require 'sinatra/base'
-require 'rack/test'
-
-$:.unshift File.dirname(__FILE__) + "/../lib"
-require 'sinatra/toadhopper'
-
-class TestReportErrorToHoptoad < Test::Unit::TestCase
-  
-  class AppThatGoesBoom < Sinatra::Base
-
-    helpers Sinatra::Toadhopper
-
-    set :raise_errors, false
-    set :sessions, true
-
-    set :toadhopper, :api_key => "apikey", :filters => /afilter/
-
-    get "/:id" do
-      session["id"] = "sessionid"
-      raise "Kaboom!"
-    end
-
-    error do
-      post_error_to_hoptoad!
-      "Ouch, that hurt."
-    end
-  end
-  
-  include Rack::Test::Methods
-
-  def app; AppThatGoesBoom end
-
-  def setup
-    stub(Toadhopper).post! {|*args| @error, @options, @header_options = *args }
-    get "/theid"
-  end
-
-  def test_api_key_set
-    assert_equal "apikey", Toadhopper.api_key
-  end
-  def test_filter_set
-    assert_equal [/afilter/], Toadhopper.filters
-  end
-
-  def test_reported_error
-    assert_equal RuntimeError, @error.class
-    assert_equal "Kaboom!", @error.message
-  end
-
-  def test_options
-    assert_equal ENV, @options[:environment]
-    assert_equal "http://example.org/theid", @options[:request][:url]
-    assert_equal({"id" => "theid"}, @options[:request][:params])
-    assert_equal nil, @options[:request][:rails_root]
-    assert_equal({:key => 42, :data => {"id" => "sessionid"}}, @options[:session])
-  end
-  
-  def test_header_options
-    assert_equal "toadhopper-sinatra", @header_options['X-Hoptoad-Client-Name']
-  end
-  
-end