hoptoad_notifier 2.2.2 → 2.2.5

data/CHANGELOG

@@ -1,3 +1,66 @@
+Version 2.2.5 - 2010-06-02
+===============================================================================
+
+Jason Morrison (1):
+      Add documentation for Rails 3.x installation
+
+
+Version 2.2.4 - 2010-06-02
+===============================================================================
+
+Jason Morrison (1):
+      Add a note to README about removing the explicit Catcher #include in ApplicationController
+
+
+Version 2.2.3 - 2010-06-02
+===============================================================================
+
+Summary: Fixed a variety of issues for Rails 3.0.0.beta3,
+         Fixed a bug when using Vlad to deploy instead of Capistrano
+         Give better error output when gem is not installed
+
+Chad Pytel (2):
+      revise gem unpack instructions step
+      Merge branch 'master' of github.com:thoughtbot/hoptoad_notifier
+
+Dan Lawless (1):
+      don't append capistrano details to config.deploy.rb when target app uses Vlad
+
+Jason Morrison (7):
+      LH-556 Clarify sending ENV environment variables
+      Starting to add features for Rails 3
+      Make rails rake tasks depend on gem-making tasks
+      Start to get Rails 3 features to pass
+      require fileutils to reflect rubygems 1.3.6 change
+      Support ENV['CUCUMBER_FORMAT'] in rails cucumber tasks for testing
+      Fix the initializer syntax in the Rails 3 Railtie
+
+Joe Ferris (11):
+      Got the generator running and a request dispatched to the test endpoint
+      Fixed logging in hoptoad:test rake task
+      Separated Rails 2 and 3 entry
+      Support bundler
+      Rails 3 generator works with an existing api key
+      Extract request info from rack env
+      Detect presence of the plugin
+      Added a capistrano hook for Rails 3
+      Fixed rack/sinatra being broken without active_support
+      Fixes for earlier versions of Rails
+      Fixed Rails 3 generator not to append cap hooks for vlad deploys
+
+Josh Kalderimis (7):
+      updated railtie to work with the new rails 3 middleware api
+      railtie_name is deprecated
+      updated app_middleware call to use string version as to make sure constant is loaded
+      moved generator using the new rails 3 convention
+      update path to template for Rails 3 generator
+      correction to referencing of the rails application in rails3_tasks
+      add environment_name and project_root back to rails 3 railtie
+
+Joshua Nichols (1):
+      Handle gem not being installed more gracefully.
+
+
 Version 2.2.2 - 2010-03-10
 ===============================================================================
 
@@ -73,3 +136,6 @@ Nick Quaranto (3):
 
 
 
+
+
+

data/README.rdoc

@@ -28,6 +28,19 @@ Remove the vendor/plugins/hoptoad_notifier directory before installing the gem,
 
   script/plugin remove hoptoad_notifier
 
+=== Rails 3.x
+
+Add the hoptoad_notifier gem to your Gemfile.  In Gemfile:
+
+  gem 'hoptoad_notifier'
+
+Then from your project's RAILS_ROOT, run:
+
+  bundle install
+  script/rails generate hoptoad --api-key your_key_here
+
+That's it!
+
 === Rails 2.x
 
 Add the hoptoad_notifier gem to your app. In config/environment.rb:
@@ -37,11 +50,8 @@ Add the hoptoad_notifier gem to your app. In config/environment.rb:
 Then from your project's RAILS_ROOT, run:
 
   rake gems:install
-  script/generate hoptoad --api-key your_key_here
-
-Once installed, you should vendor the hoptoad_notifier gem.
-
   rake gems:unpack GEM=hoptoad_notifier
+  script/generate hoptoad --api-key your_key_here
 
 As always, if you choose not to vendor the hoptoad_notifier gem, make sure
 every server you deploy to has the gem installed or your application won't start.
@@ -94,6 +104,13 @@ Remove the plugin:
 
     rm -rf vendor/plugins/hoptoad_notifier
 
+Make sure the following line DOES NOT appear in your ApplicationController file:
+
+    include HoptoadNotifier::Catcher
+
+If it does, remove it.  The new catcher is automatically included by the gem
+version of Hoptoad.
+
 Before running the hoptoad generator, you need to find your project's API key.
 Log in to your account at hoptoadapp.com, and click on the "Projects" button.
 Then, find your project in the list, and click on its name. In the left-hand
@@ -257,6 +274,15 @@ Hoptoad merges the hash you pass with these default options:
 
 You can override any of those parameters.
 
+=== Sending shell environment variables when "Going beyond exceptions"
+
+One common request we see is to send shell environment variables along with
+manual exception notification.  We recommend sending them along with CGI data
+or Rack environment (:cgi_data or :rack_env keys, respectively.)
+
+See HoptoadNotifier::Notice#initialize in lib/hoptoad_notifier/notice.rb for
+more details.
+
 == Filtering
 
 You can specify a whitelist of errors, that Hoptoad will not report on.  Use

data/Rakefile

@@ -195,10 +195,10 @@ def define_rails_cucumber_tasks(additional_cucumber_args = '')
   namespace :rails do
     RAILS_VERSIONS.each do |version|
       desc "Test integration of the gem with Rails #{version}"
-      task version do
+      task version => [:gemspec, :vendor_test_gems] do
         puts "Testing Rails #{version}"
         ENV['RAILS_VERSION'] = version
-        system("cucumber --format progress #{additional_cucumber_args} features/rails.feature")
+        system("cucumber --format #{ENV['CUCUMBER_FORMAT'] || 'progress'} #{additional_cucumber_args} features/rails.feature")
       end
     end
 

data/SUPPORTED_RAILS_VERSIONS

@@ -6,3 +6,4 @@
 2.3.2
 2.3.4
 2.3.5
+3.0.0.beta3

data/generators/hoptoad/hoptoad_generator.rb

@@ -18,7 +18,7 @@ class HoptoadGenerator < Rails::Generator::Base
     record do |m|
       m.directory 'lib/tasks'
       m.file 'hoptoad_notifier_tasks.rake', 'lib/tasks/hoptoad_notifier_tasks.rake'
-      if File.exists?('config/deploy.rb')
+      if ['config/deploy.rb', 'Capfile'].all? { |file| File.exists?(file) }
         m.append_to 'config/deploy.rb', capistrano_hook
       end
       if options[:api_key]
@@ -47,7 +47,7 @@ class HoptoadGenerator < Rails::Generator::Base
   def capistrano_hook
     IO.read(source_path('capistrano_hook.rb'))
   end
-  
+
   def plugin_is_present?
     File.exists?('vendor/plugins/hoptoad_notifier')
   end

data/generators/hoptoad/templates/hoptoad_notifier_tasks.rake

@@ -7,6 +7,19 @@ unless ARGV.any? {|a| a =~ /^gems/}
     $: << File.join(vendored_notifier, 'lib')
   end
 
-  require 'hoptoad_notifier/tasks'
+  begin
+    require 'hoptoad_notifier/tasks'
+  rescue LoadError => exception
+    namespace :hoptoad do
+      %w(deploy test log_stdout).each do |task_name|
+        desc "Missing dependency for hoptoad:#{task_name}"
+        task task_name do
+          $stderr.puts "Failed to run hoptoad:#{task_name} because of missing dependency."
+          $stderr.puts "You probably need to run `rake gems:install` to install the hoptoad_notifier gem"
+          abort exception.inspect
+        end
+      end
+    end
+  end
 
 end

data/generators/hoptoad/templates/initializer.rb

@@ -1,4 +1,4 @@
-<% if Rails::VERSION::MINOR < 2 -%>
+<% if Rails::VERSION::MAJOR < 3 && Rails::VERSION::MINOR < 2 -%>
 require 'hoptoad_notifier/rails'
 <% end -%>
 HoptoadNotifier.configure do |config|

data/lib/hoptoad_notifier.rb

@@ -9,6 +9,8 @@ require 'hoptoad_notifier/sender'
 require 'hoptoad_notifier/backtrace'
 require 'hoptoad_notifier/rack'
 
+require 'hoptoad_notifier/railtie' if defined?(Rails::Railtie)
+
 # Gem for applications to automatically post errors to the Hoptoad of their choice.
 module HoptoadNotifier
 

data/lib/hoptoad_notifier/notice.rb

@@ -1,3 +1,5 @@
+require 'builder'
+
 module HoptoadNotifier
   class Notice
 
@@ -78,9 +80,12 @@ module HoptoadNotifier
       self.ignore_by_filters   = args[:ignore_by_filters]   || []
       self.backtrace_filters   = args[:backtrace_filters]   || []
       self.params_filters      = args[:params_filters]      || []
-      self.parameters          = args[:parameters]          || rack_env(:params) || {}
-      self.component           = args[:component] || args[:controller]
-      self.action              = args[:action]
+      self.parameters          = args[:parameters] ||
+                                   action_dispatch_params ||
+                                   rack_env(:params) ||
+                                   {}
+      self.component           = args[:component] || args[:controller] || parameters['controller']
+      self.action              = args[:action] || parameters['action']
 
       self.environment_name = args[:environment_name]
       self.cgi_data         = args[:cgi_data] || args[:rack_env]
@@ -126,17 +131,17 @@ module HoptoadNotifier
             request.url(url)
             request.component(controller)
             request.action(action)
-            unless parameters.blank?
+            unless parameters.nil? || parameters.empty?
               request.params do |params|
                 xml_vars_for(params, parameters)
               end
             end
-            unless session_data.blank?
+            unless session_data.nil? || session_data.empty?
               request.session do |session|
                 xml_vars_for(session, session_data)
               end
             end
-            unless cgi_data.blank?
+            unless cgi_data.nil? || cgi_data.empty?
               request.tag!("cgi-data") do |cgi_datum|
                 xml_vars_for(cgi_datum, cgi_data)
               end
@@ -266,7 +271,7 @@ module HoptoadNotifier
     end
 
     def find_session_data
-      self.session_data = args[:session_data] || args[:session] || {}
+      self.session_data = args[:session_data] || args[:session] || rack_session || {}
       self.session_data = session_data[:data] if session_data[:data]
     end
 
@@ -301,5 +306,13 @@ module HoptoadNotifier
         ::Rack::Request.new(args[:rack_env])
       end
     end
+
+    def action_dispatch_params
+      args[:rack_env]['action_dispatch.request.parameters'] if args[:rack_env]
+    end
+
+    def rack_session
+      args[:rack_env]['rack.session'] if args[:rack_env]
+    end
   end
 end

data/lib/hoptoad_notifier/rails/controller_methods.rb

@@ -23,8 +23,7 @@ module HoptoadNotifier
           :controller       => params[:controller],
           :action           => params[:action],
           :url              => hoptoad_request_url,
-          :cgi_data         => hoptoad_filter_if_filtering(request.env),
-          :environment_vars => hoptoad_filter_if_filtering(ENV) }
+          :cgi_data         => hoptoad_filter_if_filtering(request.env) }
       end
 
       def hoptoad_filter_if_filtering(hash)

data/lib/hoptoad_notifier/rails3_tasks.rb

@@ -0,0 +1,90 @@
+require 'hoptoad_notifier'
+
+namespace :hoptoad do
+  desc "Notify Hoptoad of a new deploy."
+  task :deploy => :environment do
+    require 'hoptoad_tasks'
+    HoptoadTasks.deploy(:rails_env      => ENV['TO'],
+                        :scm_revision   => ENV['REVISION'],
+                        :scm_repository => ENV['REPO'],
+                        :local_username => ENV['USER'],
+                        :api_key        => ENV['API_KEY'])
+  end
+
+  desc "Verify your gem installation by sending a test exception to the hoptoad service"
+  task :test => [:environment] do
+    Rails.logger = Logger.new(STDOUT)
+    Rails.logger.level = Logger::DEBUG
+    HoptoadNotifier.configure(true) do |config|
+      config.logger = Rails.logger
+    end
+
+    require 'app/controllers/application_controller'
+
+    class HoptoadTestingException < RuntimeError; end
+
+    unless HoptoadNotifier.configuration.api_key
+      puts "Hoptoad needs an API key configured! Check the README to see how to add it."
+      exit
+    end
+
+    HoptoadNotifier.configuration.development_environments = []
+
+    puts "Configuration:"
+    HoptoadNotifier.configuration.to_hash.each do |key, value|
+      puts sprintf("%25s: %s", key.to_s, value.inspect.slice(0, 55))
+    end
+
+    unless defined?(ApplicationController)
+      puts "No ApplicationController found"
+      exit
+    end
+
+    puts 'Setting up the Controller.'
+    class ApplicationController
+      # This is to bypass any filters that may prevent access to the action.
+      prepend_before_filter :test_hoptoad
+      def test_hoptoad
+        puts "Raising '#{exception_class.name}' to simulate application failure."
+        raise exception_class.new, 'Testing hoptoad via "rake hoptoad:test". If you can see this, it works.'
+      end
+
+      # def rescue_action(exception)
+      #   rescue_action_in_public exception
+      # end
+
+      # Ensure we actually have an action to go to.
+      def verify; end
+
+      # def consider_all_requests_local
+      #   false
+      # end
+
+      # def local_request?
+      #   false
+      # end
+
+      def exception_class
+        exception_name = ENV['EXCEPTION'] || "HoptoadTestingException"
+        Object.const_get(exception_name)
+      rescue
+        Object.const_set(exception_name, Class.new(Exception))
+      end
+
+      def logger
+        nil
+      end
+    end
+    class HoptoadVerificationController < ApplicationController; end
+
+    Rails::Application.routes_reloader.reload_if_changed
+    Rails::Application.routes.draw do |map|
+      match 'verify' => 'application#verify', :as => 'verify'
+    end
+
+    puts 'Processing request.'
+    env = Rack::MockRequest.env_for("/verify")
+    Rails::Application.call(env)
+  end
+end
+

data/lib/hoptoad_notifier/railtie.rb

@@ -0,0 +1,23 @@
+require 'hoptoad_notifier'
+require 'rails'
+
+module HoptoadNotifier
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      require "hoptoad_notifier/rails3_tasks"
+    end
+
+    initializer "hoptoad.use_rack_middleware" do |app|
+      app.config.middleware.insert_after "::ActionDispatch::ShowExceptions", "HoptoadNotifier::Rack"
+    end
+
+    config.after_initialize do
+      HoptoadNotifier.configure(true) do |config|
+        config.logger           = Rails.logger
+        config.environment_name = Rails.env
+        config.project_root     = Rails.root
+        config.framework        = "Rails: #{::Rails::VERSION::STRING}"
+      end
+    end
+  end
+end

data/lib/hoptoad_notifier/version.rb

@@ -1,3 +1,3 @@
 module HoptoadNotifier
-  VERSION = "2.2.2".freeze
+  VERSION = "2.2.5".freeze
 end

data/lib/rails/generators/hoptoad/hoptoad_generator.rb

@@ -0,0 +1,64 @@
+require 'rails/generators'
+
+class HoptoadGenerator < Rails::Generators::Base
+
+  class_option :api_key, :aliases => "-k", :type => :string, :desc => "Your Hoptoad API key"
+
+  def self.source_root
+    @_hoptoad_source_root ||= File.expand_path("../../../../../generators/hoptoad/templates", __FILE__)
+  end
+
+  def install
+    ensure_api_key_was_configured
+    ensure_plugin_is_not_present
+    append_capistrano_hook
+    generate_initializer unless api_key_configured?
+    test_hoptoad
+  end
+
+  private
+
+  def ensure_api_key_was_configured
+    if !options[:api_key] && !api_key_configured?
+      puts "Must pass --api-key or create config/initializers/hoptoad.rb"
+      exit
+    end
+  end
+
+  def ensure_plugin_is_not_present
+    if plugin_is_present?
+      puts "You must first remove the hoptoad_notifier plugin. Please run: script/plugin remove hoptoad_notifier"
+      exit
+    end
+  end
+
+  def append_capistrano_hook
+    if File.exists?('config/deploy.rb') && File.exists?('Capfile')
+      append_file('config/deploy.rb', <<-HOOK)
+
+        require 'config/boot'
+        require 'hoptoad_notifier/capistrano'
+      HOOK
+    end
+  end
+
+  def api_key
+    options[:api_key]
+  end
+
+  def generate_initializer
+    template 'initializer.rb', 'config/initializers/hoptoad.rb'
+  end
+
+  def api_key_configured?
+    File.exists?('config/initializers/hoptoad.rb')
+  end
+
+  def test_hoptoad
+    puts run("rake hoptoad:test --trace")
+  end
+
+  def plugin_is_present?
+    File.exists?('vendor/plugins/hoptoad_notifier')
+  end
+end

data/test/notice_test.rb

@@ -339,9 +339,6 @@ class NoticeTest < Test::Unit::TestCase
   end
 
   should "extract data from a rack environment hash" do
-    # TODO: extract session data
-    # TODO: extract controller
-    # TODO: extract action
     url = "https://subdomain.happylane.com:100/test/file.rb?var=value&var2=value2"
     parameters = { 'var' => 'value', 'var2' => 'value2' }
     env = Rack::MockRequest.env_for(url)
@@ -353,6 +350,35 @@ class NoticeTest < Test::Unit::TestCase
     assert_equal 'GET', notice.cgi_data['REQUEST_METHOD']
   end
 
+  should "extract data from a rack environment hash with action_dispatch info" do
+    params = { 'controller' => 'users', 'action' => 'index', 'id' => '7' }
+    env = Rack::MockRequest.env_for('/', { 'action_dispatch.request.parameters' => params })
+
+    notice = build_notice(:rack_env => env)
+
+    assert_equal params, notice.parameters
+    assert_equal params['controller'], notice.component
+    assert_equal params['action'], notice.action
+  end
+
+  should "extract session data from a rack environment" do
+    session_data = { 'something' => 'some value' }
+    env = Rack::MockRequest.env_for('/', 'rack.session' => session_data)
+
+    notice = build_notice(:rack_env => env)
+
+    assert_equal session_data, notice.session_data
+  end
+
+  should "prefer passed session data to rack session data" do
+    session_data = { 'something' => 'some value' }
+    env = Rack::MockRequest.env_for('/')
+
+    notice = build_notice(:rack_env => env, :session_data => session_data)
+
+    assert_equal session_data, notice.session_data
+  end
+
   def assert_accepts_exception_attribute(attribute, args = {}, &block)
     exception = build_exception
     block ||= lambda { exception.send(attribute) }

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 2
   - 2
-  - 2
-  version: 2.2.2
+  - 5
+  version: 2.2.5
 platform: ruby
 authors: 
 - thoughtbot, inc
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-10 00:00:00 -05:00
+date: 2010-06-02 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -120,11 +120,14 @@ files:
 - lib/hoptoad_notifier/rails/controller_methods.rb
 - lib/hoptoad_notifier/rails/error_lookup.rb
 - lib/hoptoad_notifier/rails.rb
+- lib/hoptoad_notifier/rails3_tasks.rb
+- lib/hoptoad_notifier/railtie.rb
 - lib/hoptoad_notifier/sender.rb
 - lib/hoptoad_notifier/tasks.rb
 - lib/hoptoad_notifier/version.rb
 - lib/hoptoad_notifier.rb
 - lib/hoptoad_tasks.rb
+- lib/rails/generators/hoptoad/hoptoad_generator.rb
 - test/backtrace_test.rb
 - test/catcher_test.rb
 - test/configuration_test.rb