cloudtrapper 0.0.2.pre

data/Gemfile

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

data/Guardfile

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

data/INSTALL

@@ -0,0 +1,20 @@
+=== Configuration
+
+You should have something like this in config/initializers/cloudtrapper.rb.
+
+  Cloudtrapper.configure do |config|
+    config.api_key = '1234567890abcdef'
+  end
+
+(Please note that this configuration should be in a global configuration, and
+is *not* environment-specific. Cloudtrapper 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 Cloudtrapper is working in your production environment by using
+this rake task (from RAILS_ROOT):
+
+  rake cloudtrapper:test
+
+If everything is configured properly, that task will send a notice to Cloudtrapper
+which will be visible immediately.

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2007, Tammer Saleh, Thoughtbot, Inc.
+
+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,465 @@
+Cloudtrapper
+========
+
+This is the notifier gem for integrating apps with [Cloudtrapper](http://cloudtrapper.io).
+
+When an uncaught exception occurs, Cloudtrapper will POST the relevant data
+to the Cloudtrapper server specified in your environment.
+
+Help
+----
+
+For help with using Cloudtrapper and this notifier visit [our support site](http://help.cloudtrapper.io).
+
+For discussion of Cloudtrapper development check out the [mailing list](http://groups.google.com/group/hoptoad-notifier-dev).
+
+For SSL verification see the [Resources](https://github.com/cloudtrapper/cloudtrapper/blob/master/resources/README.md).
+
+Rails Installation
+------------------
+
+### Rails 3.x
+
+Add the cloudtrapper gem to your Gemfile.  In Gemfile:
+
+    gem "cloudtrapper"
+
+Then from your project's RAILS_ROOT, and in your development environment, run:
+
+    bundle install
+    rails generate cloudtrapper --api-key your_key_here
+
+That's it!
+
+The generator creates a file under `config/initializers/cloudtrapper.rb` configuring Cloudtrapper with your API key. This file should be checked into your version control system so that it is deployed to your staging and production environments.
+
+### Rails 2.x
+
+Add the cloudtrapper gem to your app. In config/environment.rb:
+
+    config.gem 'cloudtrapper'
+
+or if you are using bundler:
+
+    gem 'cloudtrapper', :require => 'cloudtrapper/rails'
+
+Then from your project's RAILS_ROOT, and in your development environment, run:
+
+    rake gems:install
+    rake gems:unpack GEM=cloudtrapper
+    script/generate cloudtrapper --api-key your_key_here
+
+As always, if you choose not to vendor the cloudtrapper gem, make sure
+every server you deploy to has the gem installed or your application won't start.
+
+The generator creates a file under `config/initializers/cloudtrapper.rb` configuring Cloudtrapper with your API key. This file should be checked into your version control system so that it is deployed to your staging and production environments.
+
+### Upgrading From Earlier Versions of Cloudtrapper
+
+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 cloudtrapper gem to your app. In config/environment.rb:
+
+    config.gem 'cloudtrapper'
+
+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 Cloudtrapper.
+
+Before running the cloudtrapper generator, you need to find your project's API key.
+Log in to your account at cloudtrapper.io, 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 key. If you accidentally use your personal API auth_token,
+you will get API key not found errors, and exceptions will not be stored
+by the Cloudtrapper service.
+
+Then from your project's RAILS_ROOT, run:
+
+    rake gems:install
+    script/generate cloudtrapper --api-key your_key_here
+
+Once installed, you should vendor the cloudtrapper gem.
+
+    rake gems:unpack GEM=cloudtrapper
+
+As always, if you choose not to vendor the cloudtrapper 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 then 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).
+
+
+
+You can test that Cloudtrapper is working in your production environment by using
+this rake task (from RAILS_ROOT):
+
+    rake cloudtrapper:test
+
+If everything is configured properly, that task will send a notice to Cloudtrapper
+which will be visible immediately.
+
+### Removing hoptoad_notifier
+
+in your ApplicationController, REMOVE this line:
+
+    include HoptoadNotifiable
+
+In your config/environment* files, remove all references to HoptoadNotifier
+
+Remove the vendor/plugins/hoptoad_notifier directory.
+
+### Remove hoptoad_notifier plugin
+
+Remove the vendor/plugins/hoptoad_notifier directory before installing the gem, or run:
+
+    script/plugin remove hoptoad_notifier
+
+Non-rails apps using Bundler
+----------------------------
+There is an undocumented dependency in `activesupport` where the `i18n` gem is
+required only if the core classes extensions are used (`active_support/core_ext`).
+This can lead to a confusing `LoadError` exception when using Cloudtrapper. Until
+this is fixed in `activesupport` the workaround is to add `i18n` to the Gemfile
+for your Sinatra/Rack/pure ruby application:
+
+    gem 'i18n'
+    gem 'cloudtrapper'
+
+Rack
+----
+
+In order to use cloudtrapper in a non-Rails rack app, just load
+cloudtrapper, configure your API key, and use the Cloudtrapper::Rack
+middleware:
+
+    require 'rack'
+    require 'cloudtrapper'
+
+    Cloudtrapper.configure do |config|
+      config.api_key = 'my_api_key'
+    end
+
+    app = Rack::Builder.app do
+      run lambda { |env| raise "Rack down" }
+    end
+
+    use Cloudtrapper::Rack
+    run app
+
+Sinatra
+-------
+
+Using cloudtrapper in a Sinatra app is just like a Rack app:
+
+    require 'sinatra'
+    require 'cloudtrapper'
+
+    Cloudtrapper.configure do |config|
+      config.api_key = 'my api key'
+    end
+
+    use Cloudtrapper::Rack
+
+    get '/' do
+      raise "Sinatra has left the building"
+    end
+
+Usage
+-----
+
+For the most part, Cloudtrapper 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_cloudtrapper(ex)
+      flash[:failure] = 'Encryptions could not be rerouted, try again.'
+    end
+    ...
+
+The `#notify_cloudtrapper` call will send the notice over to Cloudtrapper for later
+analysis. While in your controllers you use the `notify_cloudtrapper` method, anywhere
+else in your code, use `Cloudtrapper.notify`.
+
+To perform custom error processing after Cloudtrapper has been notified, define the
+instance method `#rescue_action_in_public_without_cloudtrapper(exception)` in your
+controller.
+
+Informing the User
+------------------
+
+The cloudtrapper gem is capable of telling the user information about the error that just happened
+via the user_information option. They can give this error number in bug reports, for example.
+By default, if your 500.html contains the text
+
+    <!-- AIRBRAKE ERROR -->
+
+then that comment will be replaced with the text "Cloudtrapper Error [errnum]". You can modify the text
+of the informer by setting `config.user_information`. Cloudtrapper will replace "{{ error_id }}" with the
+ID of the error that is returned from Cloudtrapper.
+
+    Cloudtrapper.configure do |config|
+    ...
+      config.user_information = "<p>Tell the devs that it was <strong>{{ error_id }}</strong>'s fault.</p>"
+    end
+
+You can also turn the middleware that handles this completely off by setting `config.user_information` to false.
+
+Note that this feature is reading the error id from `env['cloudtrapper.error_id']`. When the exception is caught
+automatically in a controller, Cloudtrapper sets that value. If you're, however, calling the Cloudtrapper methods like
+`Cloudtrapper#notify` or `Cloudtrapper#notify_or_ignore`, please make sure you set that value. So the proper way of calling the
+"manual" methods would be `env['cloudtrapper.error_id'] = Cloudtrapper.notify_or_ignore(...)`.
+
+Tracking deployments in Cloudtrapper
+--------------------------------
+
+Paying Cloudtrapper plans support the ability to track deployments of your application in Cloudtrapper.
+By notifying Cloudtrapper 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 Cloudtrapper that occurred before and after a deploy.
+
+When Cloudtrapper is installed as a gem, you need to add
+
+    require 'cloudtrapper/capistrano'
+
+to your deploy.rb
+
+If you don't use Capistrano, then you can use the following rake task from your
+deployment process to notify Cloudtrapper:
+
+    rake cloudtrapper:deploy TO=#{rails_env} REVISION=#{current_revision} REPO=#{repository} USER=#{local_user}
+
+Going beyond exceptions
+-----------------------
+
+You can also pass a hash to `Cloudtrapper.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
+      Cloudtrapper.notify(
+        :error_class   => "Special Error",
+        :error_message => "Special Error: #{e.message}",
+        :parameters    => params
+      )
+    end
+
+While in your controllers you use the `notify_cloudtrapper` method, anywhere else in
+your code, use `Cloudtrapper.notify`. Cloudtrapper 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 Cloudtrapper 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 Cloudtrapper, passing a Hash as :parameters as in the example above is the most common use case. When Cloudtrapper catches an exception in a controller, the actual HTTP client request parameters are sent using this key.
+
+Cloudtrapper merges the hash you pass with these default options:
+
+    {
+      :api_key       => Cloudtrapper.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 Cloudtrapper::Notice#initialize in lib/cloudtrapper/notice.rb for
+more details.
+
+Filtering
+---------
+
+You can specify a whitelist of errors that Cloudtrapper 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).
+
+Cloudtrapper 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 Cloudtrapper
+configuration block.
+
+    Cloudtrapper.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.
+
+    Cloudtrapper.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:
+
+    Cloudtrapper.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:
+
+    Cloudtrapper.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 Cloudtrapper service with [FILTERED] use #params_filters:
+
+    Cloudtrapper.configure do |config|
+      config.api_key      = '1234567890abcdef'
+      config.params_filters << "credit_card_number"
+    end
+
+Note that, when rescuing exceptions within an ActionController method,
+cloudtrapper will reuse filters specified by #filter_parameter_logging.
+
+Testing
+-------
+
+When you run your tests, you might notice that the Cloudtrapper 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 Cloudtrapper
+      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 Cloudtrapper servers. To configure the proxy settings, added the following information to your Cloudtrapper configuration block.
+
+    Cloudtrapper.configure do |config|
+      config.proxy_host = proxy.host.com
+      config.proxy_port = 4038
+      config.proxy_user = foo # optional
+      config.proxy_pass = bar # optional
+
+Supported Rails versions
+------------------------
+
+See SUPPORTED_RAILS_VERSIONS for a list of official supported versions of
+Rails.
+
+Please open up a support ticket ( http://help.cloudtrapper.io ) or submit a new github issue
+if you're using a version of Rails that is listed above and the notifier is
+not working properly.
+
+Javascript Notifer
+------------------
+
+To automatically include the Javascript node on every page, use this helper method from your layouts:
+
+    <%= cloudtrapper_javascript_notifier %>
+
+It's important to insert this very high in the markup, above all other javascript.  Example:
+
+    <!DOCTYPE html>
+    <html>
+      <head>
+        <meta charset="utf8">
+        <%= cloudtrapper_javascript_notifier %>
+        <!-- more javascript -->
+      </head>
+      <body>
+        ...
+      </body>
+    </html>
+
+This helper will automatically use the API key, host, and port specified in the configuration.
+
+The Javascript notifier tends to send much more notifications than the base Rails project.
+If you want to receive them into a separate Cloudtrapper project, specify its
+API key in the `js_api_key` option.
+
+    config.js_api_key = 'another-projects-api-key'
+
+To test the Javascript notifier in development environment, overwrite (temporarily) the development_environments option:
+
+    Cloudtrapper.configure do |config|
+      # ...
+      config.development_environments = []
+    end
+
+Development
+-----------
+
+See TESTING.md for instructions on how to run the tests.
+
+Credits
+-------
+
+![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+
+Cloudtrapper is maintained and funded by [cloudtrapper.io](http://cloudtrapper.io)
+
+Thank you to all [the contributors](https://github.com/cloudtrapper/cloudtrapper/contributors)!
+
+The names and logos for Cloudtrapper, thoughtbot are trademarks of their respective holders.
+
+License
+-------
+
+Cloudtrapper is Copyright © 2008-2012 Cloudtrapper. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/README_FOR_HEROKU_ADDON.md

@@ -0,0 +1,94 @@
+Cloudtrapper on Heroku
+==================
+
+Send your application errors to our hosted service and reclaim your inbox.
+
+1. Installing the Heroku add-on
+----------------------------
+To use Cloudtrapper on Heroku, install the Cloudtrapper add-on:
+
+    $ heroku addons:add cloudtrapper:basic # This adds the the basic plan.
+                                       # If you'd like another plan, specify that instead.
+
+2. Including the Cloudtrapper notifier in your application
+--------------------------------------------------
+After adding the Cloudtrapper add-on, you will need to install and configure the Cloudtrapper notifier.
+
+Your application connects to Cloudtrapper with an API key. On Heroku, this is automatically provided to your
+application in `ENV['HOPTOAD_API_KEY']`, so installation should be a snap! (Hoptoad is Cloudtrapper's old name.)
+
+### Rails 3.x
+
+Add the cloudtrapper and heroku gems to your Gemfile.  In Gemfile:
+
+    gem 'cloudtrapper'
+    gem 'heroku'
+
+Then from your project's RAILS_ROOT, run:
+
+    $ bundle install
+    $ script/rails generate cloudtrapper --heroku
+
+### Rails 2.x
+
+Install the heroku gem if you haven't already:
+
+    gem install heroku
+
+Add the cloudtrapper gem to your app. In config/environment.rb:
+
+    config.gem 'cloudtrapper'
+
+Then from your project's RAILS_ROOT, run:
+
+    $ rake gems:install
+    $ rake gems:unpack GEM=cloudtrapper
+    $ script/generate cloudtrapper --heroku
+
+As always, if you choose not to vendor the cloudtrapper gem, make sure
+every server you deploy to has the gem installed or your application won't start.
+
+### Rack applications
+
+In order to use cloudtrapper in a non-Rails rack app, just load the cloudtrapper, configure your API key, and use the Cloudtrapper::Rack middleware:
+
+    require 'rubygems'
+    require 'rack'
+    require 'cloudtrapper'
+
+    Cloudtrapper.configure do |config|
+      config.api_key = `ENV['HOPTOAD_API_KEY']`
+    end
+
+    app = Rack::Builder.app do
+      use Cloudtrapper::Rack
+      run lambda { |env| raise "Rack down" }
+    end
+
+### Rails 1.x
+
+For Rails 1.x, visit the [Cloudtrapper notifier's README on GitHub](http://github.com/thoughtbot/cloudtrapper),
+and be sure to use `ENV['HOPTOAD_API_KEY']` where your API key is required in configuration code.
+
+3. Configure your notification settings (important!)
+---------------------------------------------------
+
+Once you have included and configured the notifier in your application,
+you will want to configure your notification settings.
+
+This is important - without setting your email address, you won't receive notification emails.
+
+Cloudtrapper can deliver exception notifications to your email inbox.  To configure these delivery settings:
+
+1. Visit your applications resources page, like [ http://api.heroku.com/myapps/my-great-app/resources ](http://api.heroku.com/myapps/my-great-app/resources).
+2. Click the name of your Cloudtrapper addon. (It may still be called Hoptoad.)
+3. Click "Settings" to configure the Hoptoad Add-on.
+
+4. Optionally: Set up deploy notification
+-----------------------------------------
+
+If your Cloudtrapper plan supports deploy notification, set it up for your Heroku application like this:
+
+    rake cloudtrapper:heroku:add_deploy_notification
+
+This will install a Heroku [HTTP Deploy Hook](http://docs.heroku.com/deploy-hooks) to notify Cloudtrapper of the deploy.