errornot_notifier 0.1.0 → 1.0.0

data/CHANGELOG

@@ -0,0 +1,5 @@
+Version 1.0.0 - XXX
+===============================================================================
+
+Extract from HopToad notifier code base
+and adapt to ErrorNot server

data/INSTALL

@@ -1,25 +1,25 @@
 === Configuration
 
-You should have something like this in config/initializers/hoptoad.rb.
+You should have something like this in config/initializers/errornot.rb.
 
-  HoptoadNotifier.configure do |config|
+  ErrornotNotifier.configure do |config|
     config.api_key = '1234567890abcdef'
   end
 
 (Please note that this configuration should be in a global configuration, and
-is *not* environment-specific. Hoptoad is smart enough to know what errors are
+is *not* environment-specific. Errornot is smart enough to know what errors are
 caused by what environments, so your staging errors don't get mixed in with
 your production errors.)
 
-You can test that Hoptoad is working in your production environment by using 
+You can test that Errornot is working in your production environment by using
 this rake task (from RAILS_ROOT):
 
-  rake hoptoad:test
+  rake errornot: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 Errornot
 which will be visible immediately.
 
 NOTE FOR RAILS 1.2.* USERS:
 
-You will 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.
+You will need to copy the errornot_notifier_tasks.rake file into your
+RAILS_ROOT/lib/tasks directory in order for the rake errornot:test task to work.

data/README.rdoc

@@ -21,14 +21,14 @@ Remove the vendor/plugins/exception_notifier directory.
 
 Add the errornot_notifier gem to your app. In config/environment.rb:
 
-  config.gem 'errornot_notifier', :lib => 'hoptoad_notifier'
+  config.gem 'errornot_notifier'
 
 Then from your project's RAILS_ROOT, run:
 
   rake gems:install
-  script/generate hoptoad --api-key your_key_here --server your_host
+  script/generate errornot --api-key your_key_here --server your_host
 
-Once installed, you should vendor the hoptoad_notifier gem.
+Once installed, you should vendor the errornot_notifier gem.
 
   rake gems:unpack GEM=errornot_notifier
 
@@ -41,7 +41,7 @@ Install the errornot_notifier gem:
 
   gem install errornot_notifier
 
-Once installed, you should vendor the hoptoad_notifier gem:
+Once installed, you should vendor the errornot_notifier gem:
 
   mkdir vendor/gems
   cd vendor/gems
@@ -55,17 +55,17 @@ block in environment.rb so that the vendored gem is loaded.
 
 Next add something like this at the bottom of your config/environment.rb:
 
-  require 'hoptoad_notifier'
-  require 'hoptoad_notifier/rails'
-  HoptoadNotifier.configure do |config|
+  require 'errornot_notifier'
+  require 'errornot_notifier/rails'
+  ErrornotNotifier.configure do |config|
     config.api_key = 'your_key_here'
     config.host = 'host_of_your_errornot_instance'
   end
 
-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:
+You will also need to copy the errornot_notifier_tasks.rake file into your
+RAILS_ROOT/lib/tasks directory in order for the rake errornot:test task to work:
 
-  cp vendor/gems/errornot_notifier-0.1.0/generators/hoptoad/templates/hoptoad_notifier_tasks.rake lib/tasks
+  cp vendor/gems/errornot_notifier-*/generators/errornot/templates/errornot_notifier_tasks.rake lib/tasks
 
 As always, if you choose not to vendor the errornot_notifier gem, make sure
 every server you deploy to has the gem installed or your application won't start.
@@ -75,27 +75,27 @@ every server you deploy to has the gem installed or your application won't start
 You can test that ErrorNot is working in your production environment by using
 this rake task (from RAILS_ROOT):
 
-  rake hoptoad:test
+  rake errornot: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 Errornot
 which will be visible immediately.
 
 == Rack
 
-In order to use hoptoad_notifier in a non-Rails rack app, just load the
-hoptoad_notifier, configure your API key, and use the HoptoadNotifier::Rack
+In order to use errornot_notifier in a non-Rails rack app, just load the
+errornot_notifier, configure your API key, and use the ErrornotNotifier::Rack
 middleware:
 
   require 'rack'
-  require 'hoptoad_notifier'
+  require 'errornot_notifier'
 
-  HoptoadNotifier.configure do |config|
+  ErrornotNotifier.configure do |config|
     config.api_key = 'my_api_key'
     config.host = 'host_of_your_errornot_instance'
   end
 
   app = Rack::Builder.app do
-    use HoptoadNotifier::Rack
+    use errornotNotifier::Rack
     run lambda { |env| raise "Rack down" }
   end
 
@@ -105,15 +105,15 @@ Using errornot_notifier in a Sinatra app is just like a Rack app, but you have
 to disable Sinatra's error rescuing functionality:
 
   require 'sinatra/base'
-  require 'hoptoad_notifier'
+  require 'errornot_notifier'
 
-  HoptoadNotifier.configure do |config|
+  ErrornotNotifier.configure do |config|
     config.api_key = 'my_api_key'
     config.host =' host_of_your_errornot_instance'
   end
 
   class MyApp < Sinatra::Default
-    use HoptoadNotifier::Rack
+    use ErrornotNotifier::Rack
     enable :raise_errors
 
     get "/" do
@@ -132,36 +132,36 @@ controller, you can do something like this:
 
   ...
   rescue => ex
-    notify_hoptoad(ex)
+    notify_errornot(ex)
     flash[:failure] = 'Encryptions could not be rerouted, try again.'
   end
   ...
 
-The #notify_hoptoad call will send the notice over to Hoptoad for later
-analysis. While in your controllers you use the notify_hoptoad method, anywhere
-else in your code, use HoptoadNotifier.notify.
+The #notify_errornot call will send the notice over to Errornot for later
+analysis. While in your controllers you use the notify_errornot method, anywhere
+else in your code, use ErrornotNotifier.notify.
 
-To perform custom error processing after Hoptoad has been notified, define the
-instance method #rescue_action_in_public_without_hoptoad(exception) in your
+To perform custom error processing after Errornot has been notified, define the
+instance method #rescue_action_in_public_without_errornot(exception) in your
 controller.
 
-== Tracking deployments in Hoptoad ( It's not implement in ErrorNot )
+== Tracking deployments in Errornot ( It's not implement in ErrorNot )
 
-Paying Hoptoad plans support the ability to track deployments of your application in Hoptoad.
-By notifying Hoptoad of your application deployments, all errors are resolved when a deploy occurs,
+Paying Errornot plans support the ability to track deployments of your application in Errornot.
+By notifying Errornot of your application deployments, all errors are resolved when a deploy occurs,
 so that you'll be notified again about any errors that reoccur after a deployment.
 
-Additionally, it's possible to review the errors in Hoptoad that occurred before and after a deploy.
+Additionally, it's possible to review the errors in Errornot that occurred before and after a deploy.
 
-When Hoptoad is installed as a gem, you need to add
+When Errornot is installed as a gem, you need to add
 
-  require 'hoptoad_notifier/capistrano'
+  require 'errornot_notifier/capistrano'
 
 to your deploy.rb
 
 == Going beyond exceptions
 
-You can also pass a hash to notify_hoptoad method and store whatever you want,
+You can also pass a hash to notify_errornot method and store whatever you want,
 not just an exception. And you can also use it anywhere, not just in
 controllers:
 
@@ -171,25 +171,25 @@ controllers:
     }
     my_unpredicable_method(params)
   rescue => e
-    HoptoadNotifier.notify(
+    ErrornotNotifier.notify(
       :error_class   => "Special Error",
       :error_message => "Special Error: #{e.message}",
       :parameters    => params
     )
   end
 
-While in your controllers you use the notify_hoptoad method, anywhere else in
-your code, use HoptoadNotifier.notify. Hoptoad will get all the information
+While in your controllers you use the notify_errornot method, anywhere else in
+your code, use ErrornotNotifier.notify. Errornot will get all the information
 about the error itself. As for a hash, these are the keys you should pass:
 
-* :error_class - Use this to group similar errors together. When Hoptoad catches an exception it sends the class name of that exception object.
+* :error_class - Use this to group similar errors together. When Errornot catches an exception it sends the class name of that exception object.
 * :error_message - This is the title of the error you see in the errors list. For exceptions it is "#{exception.class.name}: #{exception.message}"
-* :parameters - While there are several ways to send additional data to Hoptoad, passing a Hash as :parameters as in the example above is the most common use case. When Hoptoad catches an exception in a controller, the actual HTTP client request parameters are sent using this key.
+* :parameters - While there are several ways to send additional data to Errornot, passing a Hash as :parameters as in the example above is the most common use case. When Errornot catches an exception in a controller, the actual HTTP client request parameters are sent using this key.
 
-Hoptoad merges the hash you pass with these default options:
+Errornot merges the hash you pass with these default options:
 
   {
-    :api_key       => HoptoadNotifier.api_key,
+    :api_key       => ErrornotNotifier.api_key,
     :error_message => 'Notification',
     :backtrace     => caller,
     :parameters    => {},
@@ -200,14 +200,14 @@ You can override any of those parameters.
 
 == Filtering
 
-You can specify a whitelist of errors, that Hoptoad will not report on.  Use
+You can specify a whitelist of errors, that Errornot 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
 notifications (when #notify is called directly).
 
-Hoptoad ignores the following exceptions by default:
+Errornot ignores the following exceptions by default:
 
   ActiveRecord::RecordNotFound
   ActionController::RoutingError
@@ -215,10 +215,10 @@ 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 Errornot
 configuration block.
 
-  HoptoadNotifier.configure do |config|
+  ErrornotNotifier.configure do |config|
     config.api_key      = '1234567890abcdef'
     config.ignore       << ActiveRecord::IgnoreThisError
   end
@@ -226,7 +226,7 @@ configuration block.
 To ignore *only* certain errors (and override the defaults), use the
 #ignore_only attribute.
 
-  HoptoadNotifier.configure do |config|
+  ErrornotNotifier.configure do |config|
     config.api_key      = '1234567890abcdef'
     config.ignore_only  = [ActiveRecord::IgnoreThisError]
   end
@@ -234,7 +234,7 @@ To ignore *only* certain errors (and override the defaults), use the
 To ignore certain user agents, add in the #ignore_user_agent attribute as a
 string or regexp:
 
-  HoptoadNotifier.configure do |config|
+  ErrornotNotifier.configure do |config|
     config.api_key      = '1234567890abcdef'
     config.ignore_user_agent  << /Ignored/
     config.ignore_user_agent << 'IgnoredUserAgent'
@@ -242,42 +242,52 @@ string or regexp:
 
 To ignore exceptions based on other conditions, use #ignore_by_filter:
 
-  HoptoadNotifier.configure do |config|
+  ErrornotNotifier.configure do |config|
     config.api_key      = '1234567890abcdef'
     config.ignore_by_filter do |exception_data|
       true if exception_data[:error_class] == "RuntimeError"
     end
   end
 
-To replace sensitive information sent to the Hoptoad service with [FILTERED] use #params_filters:
+To replace sensitive information sent to the Errornot service with [FILTERED] use #params_filters:
 
-  HoptoadNotifier.configure do |config|
+  ErrornotNotifier.configure do |config|
     config.api_key      = '1234567890abcdef'
     config.params_filters << "credit_card_number"
   end
 
 Note that, when rescuing exceptions within an ActionController method,
-hoptoad_notifier will reuse filters specified by #filter_params_logging.
+errornot_notifier will reuse filters specified by #filter_params_logging.
 
 == Testing
 
-When you run your tests, you might notice that the Hoptoad service is recording
+When you run your tests, you might notice that the Errornot 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
 errors are not reported while running tests.
 
-  module HoptoadNotifier
+  module ErrornotNotifier
     def self.notify(thing)
       # do nothing.
     end
   end
 
+== Proxy Support
+
+The notifier supports using a proxy, if your server is not able to directly reach the Errornot servers.  To configure the proxy settings, added the following information to your Errornot configuration block.
+
+ErrornotNotifier.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
 Rails.
 
-Please open up a support ticket on Tender ( http://help.hoptoadapp.com ) if
+Please open up a support ticket on Tender ( http://help.Errornotapp.com ) if
 you're using a version of Rails that is not listed above and the notifier is
 not working properly.
 

data/Rakefile

@@ -7,7 +7,7 @@ require 'cucumber/rake/task'
 desc 'Default: run unit tests.'
 task :default => [:test, :cucumber]
 
-desc 'Test the hoptoad_notifier gem.'
+desc 'Test the errornot_notifier gem.'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.pattern = 'test/**/*_test.rb'
@@ -22,6 +22,83 @@ task :ginger do
   load File.join(*%w[vendor ginger bin ginger])
 end
 
+namespace :changeling do
+  desc "Bumps the version by a minor or patch version, depending on what was passed in."
+  task :bump, :part do |t, args|
+    # Thanks, Jeweler!
+    if ErrornotNotifier::VERSION  =~ /^(\d+)\.(\d+)\.(\d+)(?:\.(.*?))?$/
+      major = $1.to_i
+      minor = $2.to_i
+      patch = $3.to_i
+      build = $4
+    else
+      abort
+    end
+
+    case args[:part]
+    when /minor/
+      minor += 1
+      patch = 0
+    when /patch/
+      patch += 1
+    else
+      abort
+    end
+
+    version = [major, minor, patch, build].compact.join('.')
+
+    File.open(File.join("lib", "errornot_notifier", "version.rb"), "w") do |f|
+      f.write <<EOF
+module ErrornotNotifier
+  VERSION = "#{version}".freeze
+end
+EOF
+    end
+  end
+
+  desc "Writes out the new CHANGELOG and prepares the release"
+  task :change do
+    load 'lib/errornot_notifier/version.rb'
+    file    = "CHANGELOG"
+    old     = File.read(file)
+    version = ErrornotNotifier::VERSION
+    message = "Bumping to version #{version}"
+
+    File.open(file, "w") do |f|
+      f.write <<EOF
+Version #{version} - #{Date.today}
+===============================================================================
+
+#{`git log $(git tag | tail -1)..HEAD | git shortlog`}
+#{old}
+EOF
+    end
+
+    exec ["#{ENV["EDITOR"]} #{file}",
+          "git commit -aqm '#{message}'",
+          "git tag -a -m '#{message}' v#{version}",
+          "echo '\n\n\033[32mMarked v#{version} /' `git show-ref -s refs/heads/master` 'for release. Run: rake changeling:push\033[0m\n\n'"].join(' && ')
+  end
+
+  desc "Bump by a minor version (1.2.3 => 1.3.0)"
+  task :minor do |t|
+    Rake::Task['changeling:bump'].invoke(t.name)
+    Rake::Task['changeling:change'].invoke
+  end
+
+  desc "Bump by a patch version, (1.2.3 => 1.2.4)"
+  task :patch do |t|
+    Rake::Task['changeling:bump'].invoke(t.name)
+    Rake::Task['changeling:change'].invoke
+  end
+
+  desc "Push the latest version and tags"
+  task :push do |t|
+    system("git push origin master")
+    system("git push origin $(git tag | tail -1)")
+  end
+end
+
 begin
   require 'yard'
   YARD::Rake::YardocTask.new do |t|
@@ -31,13 +108,13 @@ rescue LoadError
 end
 
 GEM_ROOT     = File.dirname(__FILE__).freeze
-VERSION_FILE = File.join(GEM_ROOT, 'lib', 'hoptoad_notifier', 'version')
+VERSION_FILE = File.join(GEM_ROOT, 'lib', 'errornot_notifier', 'version')
 
 require VERSION_FILE
 
 gemspec = Gem::Specification.new do |s|
   s.name        = %q{errornot_notifier}
-  s.version     = HoptoadNotifier::VERSION
+  s.version     = ErrornotNotifier::VERSION
   s.summary     = %q{Send your application errors to a hosted service and reclaim your inbox.}
 
   s.files        = FileList['[A-Z]*', 'generators/**/*.*', 'lib/**/*.rb',
@@ -58,8 +135,8 @@ gemspec = Gem::Specification.new do |s|
   s.add_development_dependency("shoulda")
 
   s.authors = ["thoughtbot, inc, Cyril Mougel"]
-  s.email   = %q{support@hoptoadapp.com}
-  s.homepage = "http://www.hoptoadapp.com"
+  s.email   = %q{cyril.mougel@gmail.com}
+  s.homepage = "http://github.com/shingara/errornot_notifier"
 
   s.platform = Gem::Platform::RUBY
 end
@@ -85,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|

data/TESTING.rdoc

@@ -1,6 +1,6 @@
 = For Maintainers:
 
-When developing the Hoptoad Notifier, be sure to use the integration test
+When developing the Errornot Notifier, be sure to use the integration test
 against an existing project on staging before pushing to master.
 
 +./script/integration_test.rb <test project's api key> <staging server hostname>+

data/generators/{hoptoad/hoptoad_generator.rb → errornot/errornot_generator.rb}

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
 require File.expand_path(File.dirname(__FILE__) + "/lib/rake_commands.rb")
 
-class HoptoadGenerator < Rails::Generator::Base
+class ErrornotGenerator < Rails::Generator::Base
   def add_options!(opt)
     opt.on('-k', '--api-key=key', String, "Your ErrorNot API key") {|v| options[:api_key] = v}
     opt.on('-s', '--server=host', String, "Your host with errorNot is installed") {|v| options[:host] = v}
@@ -19,7 +19,7 @@ class HoptoadGenerator < Rails::Generator::Base
     end
     record do |m|
       m.directory 'lib/tasks'
-      m.file 'hoptoad_notifier_tasks.rake', 'lib/tasks/hoptoad_notifier_tasks.rake'
+      m.file 'errornot_notifier_tasks.rake', 'lib/tasks/errornot_notifier_tasks.rake'
       if File.exists?('config/deploy.rb')
         m.append_to 'config/deploy.rb', capistrano_hook
       end
@@ -32,10 +32,10 @@ class HoptoadGenerator < Rails::Generator::Base
           m.template 'initializer.rb', 'config/errornot.rb',
             :assigns => {:api_key => options[:api_key],
           :host => options[:host]}
-          m.append_to 'config/environment.rb', "require 'config/hoptoad'"
+          m.append_to 'config/environment.rb', "require 'config/errornot'"
         end
       end
-      m.rake "hoptoad:test", :generate_only => true
+      m.rake "errornot:test", :generate_only => true
     end
   end
 
@@ -44,8 +44,8 @@ class HoptoadGenerator < Rails::Generator::Base
   end
 
   def api_key_configured?
-    File.exists?('config/initializers/hoptoad.rb') ||
-      system("grep HoptoadNotifier config/environment.rb")
+    File.exists?('config/initializers/errornot.rb') ||
+      system("grep ErrornotNotifier config/environment.rb")
   end
 
   def capistrano_hook

data/generators/errornot/templates/capistrano_hook.rb

@@ -0,0 +1,6 @@
+
+Dir[File.join(File.dirname(__FILE__), '..', 'vendor', 'gems', 'errornot_notifier-*')].each do |vendored_notifier|
+  $: << File.join(vendored_notifier, 'lib')
+end
+
+require 'errornot_notifier/capistrano'

data/generators/errornot/templates/errornot_notifier_tasks.rake

@@ -0,0 +1,5 @@
+Dir[File.join(RAILS_ROOT, 'vendor', 'gems', 'errornot_notifier-*')].each do |vendored_notifier|
+  $: << File.join(vendored_notifier, 'lib')
+end
+
+require 'errornot_notifier/tasks'

data/generators/{hoptoad → errornot}/templates/initializer.rb

@@ -1,7 +1,7 @@
 <% if Rails::VERSION::MINOR < 2 -%>
-require 'hoptoad_notifier/rails'
+require 'errornot_notifier/rails'
 <% end -%>
-HoptoadNotifier.configure do |config|
+ErrornotNotifier.configure do |config|
   config.api_key = '<%= api_key %>'
   config.host = '<%= host %>'
 end

data/lib/{hoptoad_notifier → errornot_notifier}/backtrace.rb

@@ -1,4 +1,4 @@
-module HoptoadNotifier
+module ErrornotNotifier
   # Front end to parsing the backtrace for each notice
   class Backtrace
 

data/lib/errornot_notifier/capistrano.rb

@@ -0,0 +1,20 @@
+# Defines deploy:notify_errornot which will send information about the deploy to Errornot.
+
+Capistrano::Configuration.instance(:must_exist).load do
+  after "deploy",            "deploy:notify_errornot"
+  after "deploy:migrations", "deploy:notify_errornot"
+
+  namespace :deploy do
+    desc "Notify Errornot of the deployment"
+    task :notify_errornot, :except => { :no_release => true } do
+      rails_env = fetch(:errornot_env, fetch(:rails_env, "production"))
+      local_user = ENV['USER'] || ENV['USERNAME']
+      executable = RUBY_PLATFORM.downcase.include?('mswin') ? 'rake.bat' : 'rake'
+      notify_command = "#{executable} errornot:deploy TO=#{rails_env} REVISION=#{current_revision} REPO=#{repository} USER=#{local_user}"
+      notify_command << " API_KEY=#{ENV['API_KEY']}" if ENV['API_KEY']
+      puts "Notifying Errornot of Deploy (#{notify_command})"
+      `#{notify_command}`
+      puts "Errornot Notification Complete."
+    end
+  end
+end