hoptoad_notifier 2.2.0 → 2.2.2

data/CHANGELOG

@@ -1,3 +1,35 @@
+Version 2.2.2 - 2010-03-10
+===============================================================================
+
+Chad Pytel (1):
+      document proxy support
+
+Joe Ferris (8):
+      Added upgrade instructions to the README
+      Give a clearer error message when generating a Rails app fails
+      Fail loudly when a gem can't be vendored
+      Debugging rubygems issues
+      Explicitly specify the gem paths
+      Less noisy
+      Restore gem path after vendoring
+      Fixed a typo
+
+Jon Yurek (1):
+      Added notice about removing hoptoad rake tasks to upgrade gem
+
+Mike Burns (1):
+      Remove stray file with notes in it
+
+
+Version 2.2.1 - 2010-03-10
+===============================================================================
+
+Jason Morrison (3):
+      LH-629 Ensure notifier is not considered a framework gem
+      Removing things-the-generator-must-do file
+      Add rake cucumber:wip:rails* tasks for work-in-progress features
+
+
 Version 2.2.0 - 2010-02-18
 ===============================================================================
 
@@ -39,3 +71,5 @@ Nick Quaranto (3):
 
 
 
+
+

data/README.rdoc

@@ -2,7 +2,7 @@
 
 This is the notifier gem for integrating apps with Hoptoad.
 
-When an uncaught exception occurs, HoptoadNotifier will POST the relevant data 
+When an uncaught exception occurs, HoptoadNotifier will POST the relevant data
 to the Hoptoad server specified in your environment.
 
 == Help
@@ -48,7 +48,7 @@ every server you deploy to has the gem installed or your application won't start
 
 === Rails 1.2.6
 
-Install the hoptoad_notifier gem: 
+Install the hoptoad_notifier gem:
 
   gem install hoptoad_notifier
 
@@ -75,19 +75,70 @@ Next add something like this at the bottom of your config/environment.rb:
 You will also need to copy the hoptoad_notifier_tasks.rake file into your
 RAILS_ROOT/lib/tasks directory in order for the rake hoptoad:test task to work:
 
-  cp vendor/gems/hoptoad_notifier-2.1.3/generators/hoptoad/templates/hoptoad_notifier_tasks.rake lib/tasks 
+  cp vendor/gems/hoptoad_notifier-*/generators/hoptoad/templates/hoptoad_notifier_tasks.rake lib/tasks
 
 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.
 
+=== Upgrading From Earlier Versions of Hoptoad
+
+If you're currently using the plugin version (if you have a
+vendor/plugins/hoptoad_notifier directory, you are), you'll need to perform a
+few extra steps when upgrading to the gem version.
+
+Add the hoptoad_notifier gem to your app. In config/environment.rb:
+
+    config.gem 'hoptoad_notifier'
+
+Remove the plugin:
+
+    rm -rf vendor/plugins/hoptoad_notifier
+
+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
+column, you'll see an "Edit this project" button. Click on that to get your
+project's API. (If you accidentally use your personal API auth_token, you won't
+be able to install the gem.)
+
+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
+
+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.
+
+== Upgrading from Earlier Versions of the Hoptoad Gem (with config.gem)
+
+If you're currently using the gem version of the hoptoad_notifier and have
+a version of Rails that uses config.gem (in the 2.x series), there is
+a step or two that you need to do to upgrade. First, you need to remove
+the old version of the gem from vendor/gems:
+
+    rm -rf vendor/gems/hoptoad_notifier-X.X.X
+
+Then you must remove the hoptoad_notifier_tasks.rake file from lib:
+
+    rm lib/tasks/hoptoad_notifier_tasks.rake
+
+You can them continue to install normally. If you don't remove the rake file,
+you will be unable to unpack this gem (Rails will think it's part of the
+framework).
+
 === Testing it out
 
-You can test that Hoptoad is working in your production environment by using 
+You can test that Hoptoad is working in your production environment by using
 this rake task (from RAILS_ROOT):
 
   rake hoptoad:test
 
-If everything is configured properly, that task will send a notice to Hoptoad 
+If everything is configured properly, that task will send a notice to Hoptoad
 which will be visible immediately.
 
 == Rack
@@ -131,11 +182,11 @@ to disable Sinatra's error rescuing functionality:
 
 == Usage
 
-For the most part, Hoptoad works for itself.  Once you've included the notifier 
-in your ApplicationController (which is now done automatically by the gem), 
+For the most part, Hoptoad works for itself.  Once you've included the notifier
+in your ApplicationController (which is now done automatically by the gem),
 all errors will be rescued by the #rescue_action_in_public provided by the gem.
 
-If you want to log arbitrary things which you've rescued yourself from a 
+If you want to log arbitrary things which you've rescued yourself from a
 controller, you can do something like this:
 
   ...
@@ -175,7 +226,7 @@ controllers:
 
   begin
     params = {
-      # params that you pass to a method that can throw an exception 
+      # params that you pass to a method that can throw an exception
     }
     my_unpredicable_method(params)
   rescue => e
@@ -208,11 +259,11 @@ You can override any of those parameters.
 
 == Filtering
 
-You can specify a whitelist of errors, that Hoptoad will not report on.  Use 
-this feature when you are so apathetic to certain errors that you don't want 
+You can specify a whitelist of errors, that Hoptoad will not report on.  Use
+this feature when you are so apathetic to certain errors that you don't want
 them even logged.
 
-This filter will only be applied to automatic notifications, not manual 
+This filter will only be applied to automatic notifications, not manual
 notifications (when #notify is called directly).
 
 Hoptoad ignores the following exceptions by default:
@@ -223,7 +274,7 @@ Hoptoad ignores the following exceptions by default:
   ActionController::UnknownAction
   CGI::Session::CookieStore::TamperedWithCookie
 
-To ignore errors in addition to those, specify their names in your Hoptoad 
+To ignore errors in addition to those, specify their names in your Hoptoad
 configuration block.
 
   HoptoadNotifier.configure do |config|
@@ -231,7 +282,7 @@ configuration block.
     config.ignore       << ActiveRecord::IgnoreThisError
   end
 
-To ignore *only* certain errors (and override the defaults), use the 
+To ignore *only* certain errors (and override the defaults), use the
 #ignore_only attribute.
 
   HoptoadNotifier.configure do |config|
@@ -270,8 +321,8 @@ hoptoad_notifier will reuse filters specified by #filter_params_logging.
 == Testing
 
 When you run your tests, you might notice that the Hoptoad service is recording
-notices generated using #notify when you don't expect it to.  You can 
-use code like this in your test_helper.rb to redefine that method so those 
+notices generated using #notify when you don't expect it to.  You can
+use code like this in your test_helper.rb to redefine that method so those
 errors are not reported while running tests.
 
   module HoptoadNotifier
@@ -280,6 +331,16 @@ errors are not reported while running tests.
     end
   end
 
+== Proxy Support
+
+The notifier supports using a proxy, if your server is not able to directly reach the Hoptoad servers.  To configure the proxy settings, added the following information to your Hoptoad configuration block.
+
+  HoptoadNotifier.configure do |config|
+    config.proxy_host = ...
+    config.proxy_port = ...
+    config.proxy_user = ...
+    config.proxy_pass = ...
+
 == Supported Rails versions
 
 See SUPPORTED_RAILS_VERSIONS for a list of official supported versions of

data/Rakefile

@@ -162,19 +162,26 @@ LOCAL_GEMS = [['sham_rack', nil], ['capistrano', nil], ['sqlite3-ruby', nil], ['
   RAILS_VERSIONS.collect { |version| ['rails', version] }
 
 task :vendor_test_gems do
+  old_gem_path = ENV['GEM_PATH']
+  old_gem_home = ENV['GEM_HOME']
+  ENV['GEM_PATH'] = LOCAL_GEM_ROOT
+  ENV['GEM_HOME'] = LOCAL_GEM_ROOT
   LOCAL_GEMS.each do |gem_name, version|
     gem_file_pattern = [gem_name, version || '*'].compact.join('-')
     version_option = version ? "-v #{version}" : ''
     pattern = File.join(LOCAL_GEM_ROOT, 'gems', "#{gem_file_pattern}")
     existing = Dir.glob(pattern).first
     unless existing
-      command = "gem install -i #{LOCAL_GEM_ROOT} --no-ri --no-rdoc #{version_option} #{gem_name}"
+      command = "gem install -i #{LOCAL_GEM_ROOT} --no-ri --no-rdoc --backtrace #{version_option} #{gem_name}"
       puts "Vendoring #{gem_file_pattern}..."
-      unless system(command)
-        $stderr.puts "Command failed: #{command}"
+      unless system("#{command} 2>&1")
+        puts "Command failed: #{command}"
+        exit(1)
       end
     end
   end
+  ENV['GEM_PATH'] = old_gem_path
+  ENV['GEM_HOME'] = old_gem_home
 end
 
 Cucumber::Rake::Task.new(:cucumber) do |t|
@@ -184,14 +191,14 @@ end
 
 task :cucumber => [:gemspec, :vendor_test_gems]
 
-namespace :cucumber do
+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
         puts "Testing Rails #{version}"
         ENV['RAILS_VERSION'] = version
-        system("cucumber --format progress features/rails.feature")
+        system("cucumber --format progress #{additional_cucumber_args} features/rails.feature")
       end
     end
 
@@ -199,3 +206,12 @@ namespace :cucumber do
     task :all => RAILS_VERSIONS
   end
 end
+
+namespace :cucumber do
+  namespace :wip do
+    define_rails_cucumber_tasks('--tags @wip')
+  end
+
+  define_rails_cucumber_tasks
+end
+

data/generators/hoptoad/templates/hoptoad_notifier_tasks.rake

@@ -1,5 +1,12 @@
-Dir[File.join(RAILS_ROOT, 'vendor', 'gems', 'hoptoad_notifier-*')].each do |vendored_notifier|
-  $: << File.join(vendored_notifier, 'lib')
-end
+# Don't load anything when running the gems:* tasks.
+# Otherwise, hoptoad_notifier will be considered a framework gem.
+# https://thoughtbot.lighthouseapp.com/projects/14221/tickets/629
+unless ARGV.any? {|a| a =~ /^gems/} 
+
+  Dir[File.join(RAILS_ROOT, 'vendor', 'gems', 'hoptoad_notifier-*')].each do |vendored_notifier|
+    $: << File.join(vendored_notifier, 'lib')
+  end
 
-require 'hoptoad_notifier/tasks'
+  require 'hoptoad_notifier/tasks'
+
+end

data/lib/hoptoad_notifier/version.rb

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

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: hoptoad_notifier
 version: !ruby/object:Gem::Version 
-  version: 2.2.0
+  prerelease: false
+  segments: 
+  - 2
+  - 2
+  - 2
+  version: 2.2.2
 platform: ruby
 authors: 
 - thoughtbot, inc
@@ -9,69 +14,81 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-18 00:00:00 -05:00
+date: 2010-03-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: activerecord
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: actionpack
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: jferris-mocha
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: nokogiri
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id006
 description: 
 email: support@hoptoadapp.com
 executables: []
@@ -137,18 +154,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Send your application errors to our hosted service and reclaim your inbox.