honeybadger 1.0.0

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+gemspec
+
+if true
+  group :test do
+    gem 'turn'
+    gem 'pry'
+    gem 'guard'
+    gem 'guard-test'
+    gem 'simplecov'
+  end
+end

data/Gemfile.lock

@@ -0,0 +1,114 @@
+PATH
+  remote: .
+  specs:
+    honeybadger (0.0.1)
+      activesupport
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (2.3.14)
+      activesupport (= 2.3.14)
+      rack (~> 1.1.0)
+    activerecord (2.3.14)
+      activesupport (= 2.3.14)
+    activesupport (2.3.14)
+    ansi (1.4.2)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
+    builder (3.0.0)
+    capistrano (2.8.0)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.1.0)
+    coderay (1.0.6)
+    cucumber (0.10.7)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.4.0)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.5)
+    diff-lcs (1.1.3)
+    fakeweb (1.3.0)
+    ffi (1.0.11)
+    gherkin (2.4.21)
+      json (>= 1.4.6)
+    guard (1.2.1)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-test (0.5.0)
+      guard (>= 1.1.0)
+      test-unit (~> 2.2)
+    highline (1.6.13)
+    json (1.7.3)
+    listen (0.4.6)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    metaclass (0.0.1)
+    method_source (0.7.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.6)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-sftp (2.0.5)
+      net-ssh (>= 2.0.9)
+    net-ssh (2.5.2)
+    net-ssh-gateway (1.1.0)
+      net-ssh (>= 1.99.1)
+    pry (0.9.9.6)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    rack (1.1.3)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sham_rack (1.3.4)
+      rack
+    shoulda (2.11.3)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    slop (2.4.4)
+    term-ansicolor (1.0.7)
+    test-unit (2.5.0)
+    thor (0.15.3)
+    turn (0.9.5)
+      ansi
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 2.3.8)
+  activerecord (~> 2.3.8)
+  activesupport (~> 2.3.8)
+  bourne (>= 1.0)
+  capistrano (~> 2.8.0)
+  cucumber (~> 0.10.6)
+  fakeweb (~> 1.3.0)
+  guard
+  guard-test
+  honeybadger!
+  pry
+  rspec (~> 2.6.0)
+  sham_rack (~> 1.3.0)
+  shoulda (~> 2.11.3)
+  simplecov
+  turn

data/Guardfile

@@ -0,0 +1,5 @@
+guard :test do
+  watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/unit/.+_test\.rb$})
+  watch('test/test_helper.rb')  { "test" }
+end

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012, Honeybadger
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,271 @@
+Honeybadger
+===============
+
+This is the notifier gem for integrating apps with [Honeybadger](http://honeybadger.io).
+
+When an uncaught exception occurs, Honeybadger will POST the relevant data
+to the Honeybadger server specified in your environment.
+
+## Rails Installation
+
+Add the Honeybadger gem to your gemfile:
+
+    gem 'honeybadger'
+
+Create an initializer in config/initializers and configure your API key
+for your project:
+
+    # Uncomment the following line if running lower than Rails 3.2
+    # require 'honeybadger/rails'
+    Honeybadger.configure do |config|
+      config.api_key = '[your-api-key]'
+    end
+
+That's it!
+
+### Rails 2.x
+
+Add the honeybadger gem to your app. In config/environment.rb:
+
+    config.gem 'honeybadger'
+    
+or if you are using bundler:
+
+    gem 'honeybadger', :require => 'honeybadger/rails'
+
+Then from your project's RAILS_ROOT, and in your development environment, run:
+
+    rake gems:install
+    rake gems:unpack GEM=honeybadger
+
+As always, if you choose not to vendor the honeybadger gem, make sure
+every server you deploy to has the gem installed or your application won't start.
+
+Finally, create an initializer in config/initializers and configure your
+API key for your project:
+
+    require 'honeybadger/rails'
+    Honeybadger.configure do |config|
+      config.api_key = '[your-api-key]'
+    end
+
+## Rack
+
+In order to use honeybadger in a non-Rails rack app, just load
+honeybadger, configure your API key, and use the Honeybadger::Rack
+middleware:
+
+    require 'rack'
+    require 'honeybadger'
+
+    Honeybadger.configure do |config|
+      config.api_key = 'my_api_key'
+    end
+
+    app = Rack::Builder.app do
+      run lambda { |env| raise "Rack down" }
+    end
+    
+    use Honeybadger::Rack
+    run app
+
+## Sinatra
+
+Using honeybadger in a Sinatra app is just like a Rack app:
+
+    require 'sinatra'
+    require 'honeybadger'
+
+    Honeybadger.configure do |config|
+      config.api_key = 'my api key'
+    end
+
+    use Honeybadger::Rack
+
+    get '/' do
+      raise "Sinatra has left the building"
+    end
+
+## Usage
+
+For the most part, Honeybadger works for itself. 
+
+It intercepts the exception middleware calls, sends notifications and continues the middleware call chain.
+
+If you want to log arbitrary things which you've rescued yourself from a
+controller, you can do something like this:
+
+    ...
+    rescue => ex
+      notify_honeybadger(ex)
+      flash[:failure] = 'Encryptions could not be rerouted, try again.'
+    end
+    ...
+
+The `#notify_honeybadger` call will send the notice over to Honeybadger for later
+analysis. While in your controllers you use the `notify_honeybadger` method, anywhere
+else in your code, use `Honeybadger.notify`.
+
+To perform custom error processing after Honeybadger has been notified, define the
+instance method `#rescue_action_in_public_without_honeybadger(exception)` in your
+controller.
+
+You can test that Honeybadger is working in your production environment by using
+this rake task (from RAILS_ROOT):
+
+    rake honeybadger:test
+
+If everything is configured properly, that task will send a notice to Honeybadger
+which will be visible immediately.
+
+## Going beyond exceptions
+
+You can also pass a hash to `Honeybadger.notify` method and store whatever you want,
+not just an exception. And you can also use it anywhere, not just in
+controllers:
+
+    begin
+      params = {
+        # params that you pass to a method that can throw an exception
+      }
+      my_unpredicable_method(params)
+    rescue => e
+      Honeybadger.notify(
+        :error_class   => "Special Error",
+        :error_message => "Special Error: #{e.message}",
+        :parameters    => params
+      )
+    end
+
+While in your controllers you use the `notify_honeybadger` method, anywhere else in
+your code, use `Honeybadger.notify`. Honeybadger 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 Honeybadger 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 Honeybadger, passing a Hash as :parameters as in the example above is the most common use case. When Honeybadger catches an exception in a controller, the actual HTTP client request parameters are sent using this key.
+
+Honeybadger merges the hash you pass with these default options:
+
+    {
+      :api_key       => Honeybadger.api_key,
+      :error_message => 'Notification',
+      :backtrace     => caller,
+      :parameters    => {},
+      :session       => {}
+    }
+
+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 Honeybadger::Notice#initialize in lib/honeybadger/notice.rb for
+more details.
+
+## Filtering
+
+You can specify a whitelist of errors that Honeybadger 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).
+
+Honeybadger ignores the following exceptions by default:
+
+    ActiveRecord::RecordNotFound
+    ActionController::RoutingError
+    ActionController::InvalidAuthenticityToken
+    CGI::Session::CookieStore::TamperedWithCookie
+    ActionController::UnknownAction
+    AbstractController::ActionNotFound
+    Mongoid::Errors::DocumentNotFound
+
+To ignore errors in addition to those, specify their names in your Honeybadger
+configuration block.
+
+    Honeybadger.configure do |config|
+      config.api_key      = '1234567890abcdef'
+      config.ignore       << "ActiveRecord::IgnoreThisError"
+    end
+
+To ignore *only* certain errors (and override the defaults), use the #ignore_only attribute.
+
+    Honeybadger.configure do |config|
+      config.api_key      = '1234567890abcdef'
+      config.ignore_only  = ["ActiveRecord::IgnoreThisError"] # or [] to ignore no exceptions.
+    end
+
+To ignore certain user agents, add in the #ignore_user_agent attribute as a
+string or regexp:
+
+    Honeybadger.configure do |config|
+      config.api_key      = '1234567890abcdef'
+      config.ignore_user_agent  << /Ignored/
+      config.ignore_user_agent << 'IgnoredUserAgent'
+    end
+
+To ignore exceptions based on other conditions, use #ignore_by_filter:
+
+    Honeybadger.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 Honeybadger service with [FILTERED] use #params_filters:
+
+    Honeybadger.configure do |config|
+      config.api_key      = '1234567890abcdef'
+      config.params_filters << "credit_card_number"
+    end
+
+Note that, when rescuing exceptions within an ActionController method,
+honeybadger will reuse filters specified by #filter_parameter_logging.
+
+## Testing
+
+When you run your tests, you might notice that the Honeybadger 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 or spec_helper.rb files to redefine
+that method so those errors are not reported while running tests.
+
+    module Honeybadger
+      def self.notify(exception, opts = {})
+        # do nothing.
+      end
+    end
+
+## Proxy Support
+
+The notifier supports using a proxy, if your server is not able to
+directly reach the Honeybadger servers. To configure the proxy settings,
+added the following information to your Honeybadger configuration block.
+
+    Honeybadger.configure do |config|
+      config.proxy_host = proxy.host.com
+      config.proxy_port = 4038
+      config.proxy_user = foo # optional
+      config.proxy_pass = bar # optional
+    end
+
+## Supported Rails versions
+
+Honeybadger supports Rails 2.3.14 through rails 3.2.6.
+
+## Credits
+
+Original code based on the [airbrake](http://airbrake.io) gem,
+originally by Thoughtbot, Inc.
+
+Thank you to Thoughtbot and all of the Airbrake contributors!
+
+## License
+
+Honeybadger is Copyright 2012 © Honeybadger. It is free software, and
+may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -0,0 +1,261 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+begin
+  require 'cucumber/rake/task'
+rescue LoadError
+  $stderr.puts "Please install cucumber: `gem install cucumber`"
+  exit 1
+end
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/*_test.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+FEATURES = ['sinatra', 'rack', 'metal']
+
+desc 'Default: run unit & acceptance tests.'
+task :default => [:test, "cucumber:rails:all"] + FEATURES
+
+GEM_ROOT = File.dirname(__FILE__).freeze
+
+LOCAL_GEM_ROOT = File.join(GEM_ROOT, 'tmp', 'local_gems').freeze
+RAILS_VERSIONS = IO.read('SUPPORTED_RAILS_VERSIONS').strip.split("\n")
+LOCAL_GEMS =
+  [
+    ["rack","1.3.2"],
+  ] +
+  RAILS_VERSIONS.collect { |version| ['rails', version] } +
+  [
+    ['sham_rack', nil],
+    ['capistrano', nil],
+    ['sqlite3-ruby', nil],
+    ["therubyracer",nil],
+    ["sinatra",nil]
+  ]
+
+desc "Vendor test gems: Run this once to prepare your test environment"
+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
+    if existing
+      puts "\nskipping #{gem_name} since it's already vendored," +
+      "remove it from the tmp directory first."
+      next
+    end
+
+    command = "gem install -i #{LOCAL_GEM_ROOT} --no-ri --no-rdoc --backtrace #{version_option} #{gem_name}"
+    puts "Vendoring #{gem_file_pattern}..."
+    unless system("#{command} 2>&1")
+      puts "Command failed: #{command}"
+      exit(1)
+    end
+  end
+
+  ENV['GEM_PATH'] = old_gem_path
+  ENV['GEM_HOME'] = old_gem_home
+end
+
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.fork = true
+  t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'progress')]
+end
+
+task :cucumber => [:vendor_test_gems]
+
+def run_rails_cucumber_task(version, additional_cucumber_args)
+  puts "Testing Rails #{version}"
+  if version.empty?
+    raise "No Rails version specified - make sure ENV['RAILS_VERSION'] is set, e.g. with `rake cucumber:rails:all`"
+  end
+  ENV['RAILS_VERSION'] = version
+  cmd   = "cucumber --format #{ENV['CUCUMBER_FORMAT'] || 'progress'} #{additional_cucumber_args} features/rails.feature"
+  puts "Running command: #{cmd}"
+  system(cmd)
+end
+
+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 => [:vendor_test_gems] do
+        exit 1 unless run_rails_cucumber_task(version, additional_cucumber_args)
+      end
+    end
+
+    desc "Test integration of the gem with all Rails versions"
+    task :all do
+      results = RAILS_VERSIONS.map do |version|
+        run_rails_cucumber_task(version, additional_cucumber_args)
+      end
+
+      exit 1 unless results.all?
+    end
+  end
+end
+
+namespace :cucumber do
+  namespace :wip do
+    define_rails_cucumber_tasks('--tags @wip')
+  end
+
+  define_rails_cucumber_tasks
+
+  rule /#{"(" + FEATURES.join("|") + ")"}/ do |t|
+    framework = t.name
+    desc "Test integration of the gem with #{framework}"
+    task framework.to_sym do
+      puts "Testing #{framework.split(":").last}..."
+      cmd = "cucumber --format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features/#{framework.split(":").last}.feature"
+      puts "Running command: #{cmd}"
+      system(cmd)
+    end
+  end
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}_tasks.rb", "lib/#{name}", "lib/rails"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain `#{name}.rb` and `#{name}_tasks.rb` files, and `#{name}` and lib/rails dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end