cheaptoad

• cheaptoad.rubyforge.org

DESCRIPTION:

CheapToad is a simple server plugin for the HopToad notifier. Make your app a HopToad server in just a couple of lines!

FEATURES/PROBLEMS:

• Very simple installation

• Very simple configuration

• Keeps your exceptions around to browse later

SYNOPSIS:

Make a Rails app, or choose an existing one. In config/environment.rb, add the line ‘config.gem “cheaptoad”’. Now, that app can receive HopToad errors! If you want it to give you an RSS feed of errors (who wouldn’t?), you’ll also need to go into config/routes.rb and add the line “resources :notices”.

In any and all apps that you want to send errors to your app, create a file called config/initializers/hoptoad.rb, as you always would when using HopToad. Install the HopToad notifier also, of course. The config file will look a bit like this:

HoptoadNotifier.configure do |config|

config.api_key = 'My Project Name'
config.host = 'mycheaptoadapp.host.com'
config.port = 3000

config.environment_filters << "MY_SECRET_KEY"

end

Note that the host and port are for the app that will receive HopToad errors, the app you added the ‘config.gem “cheaptoad”’ to.

REQUIREMENTS:

You’ll need a Rails app, which will be your CheapToad server. It can do whatever else you like, but its notices controller (by default “/notices”) will be used for CheapToad stuff.

You will not need a HopToad API key. That’s kind of the point of this project. Instead of using a big hexadecimal string as your API key, I recommend you use a simple string like “My Blog” or “Secret Project X”.

RESKINNING:

By default, CheapToad has a built-in set of HTML and RSS files to give a very simple list of your errors. If you’d rather use your own, it’s probably easiest to just build your own notices_controller.rb file and appropriate view files to go with it. You can look at the ones in your local copy of the CheapToad gem to do it – they’re really quite simple. Then, add your own new HTML, CSS and whatnot to pretty it up.

INSTALL:

sudo gem install cheaptoad

LICENSE:

(The MIT License)

Copyright © 2009 Noah Gibbs

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.