Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 58 lines (36 sloc) 1.665 kB
e8755de @kyledrake Hoptoad is now Airbrake due to trademark issue, update API url
authored
1 A base library for [Airbrake](http://airbrakeapp.com) (formerly [Hoptoad](http://robots.thoughtbot.com/post/7665411707/hoptoad-is-now-airbrake)) error reporting.
b8f47a5 @toolmantim Re-add the readme
toolmantim authored
2
3 Toadhopper can be used to report plain old Ruby exceptions, or to build a framework-specific gem such as [toadhopper-sinatra](http://github.com/toolmantim/toadhopper-sinatra).
4
afd4636 @toolmantim Simplify the readme example
toolmantim authored
5 begin
6 raise "Kaboom!"
7 rescue => e
8 require 'toadhopper'
2373928 @toolmantim Renamed ToadHopper to Toadhopper
toolmantim authored
9 Toadhopper("YOURAPIKEY").post!(e)
afd4636 @toolmantim Simplify the readme example
toolmantim authored
10 end
b8f47a5 @toolmantim Re-add the readme
toolmantim authored
11
12 You can install it via rubygems:
13
14 gem install toadhopper
4fa2d2e @toolmantim Added Toadhopper() rather than Toadhopper.new() for instantiating Toa…
toolmantim authored
15
5e8a4e5 @iconara Updated the documentation
iconara authored
16 ## Deploy tracking
17
18 You can use Toadhopper to notify Hoptoad of deployments:
19
20 Toadhopper('YOURAPIKEY').deploy!
21
22 The method accepts options to set the environment, SCM revision, etc.
23
24 There is Capistrano support for deploy tracking. Simply require `toadhopper/capistrano` in your deploy config and set the variable `hoptoad_api_key`:
25
26 require 'toadhopper/capistrano'
27
28 set :hoptoad_api_key, 'YOURAPIKEY'
29
bb73a30 @atmos explain how to bundle the app and run specs
atmos authored
30 ## Development
31
8bba7cf @atmos update to bundler 0.9.x
atmos authored
32 Install Bundler 0.9.x, then:
62da13e @toolmantim Readme updates for Bundler and integration testing
toolmantim authored
33
bb73a30 @atmos explain how to bundle the app and run specs
atmos authored
34 % git clone git://github.com/toolmantim/toadhopper.git
35 % cd toadhopper
8bba7cf @atmos update to bundler 0.9.x
atmos authored
36 % bundle install
37 % bundle exec rake test
bb73a30 @atmos explain how to bundle the app and run specs
atmos authored
38
62da13e @toolmantim Readme updates for Bundler and integration testing
toolmantim authored
39 If you set a `HOPTOAD_API_KEY` environment variable it'll test actually posting to the Hoptoad API. For example:
40
8bba7cf @atmos update to bundler 0.9.x
atmos authored
41 % bundle exec rake test HOPTOAD_API_KEY=abc123
62da13e @toolmantim Readme updates for Bundler and integration testing
toolmantim authored
42
d77915e @toolmantim Use Bundler in the Rakefile and switch to using yardoc
toolmantim authored
43 To generate the docs:
44
8bba7cf @atmos update to bundler 0.9.x
atmos authored
45 % bundle exec yardoc
d77915e @toolmantim Use Bundler in the Rakefile and switch to using yardoc
toolmantim authored
46
50ddc03 @toolmantim Added instructions to build the gem
toolmantim authored
47 To build the gem:
48
49 % bundle exec rake build
50
0938d99 @toolmantim Added Samuel (stesla) to the Readme - thanks mate!
toolmantim authored
51 ## Contributors
52
53 * [Tim Lucas](http://github.com/toolmantim)
54 * [Samuel Tesla](http://github.com/stesla)
952314c @toolmantim Added Loren Segal to contributors
toolmantim authored
55 * [Corey Donohoe](http://github.com/atmos)
56 * [Andre Arko](http://github.com/indirect)
5e8a4e5 @iconara Updated the documentation
iconara authored
57 * [Loren Segal](http://github.com/lsegal)
58 * [Theo Hultberg](http://github.com/iconara)
Something went wrong with that request. Please try again.