resque-honeybadger 0.2.0 → 1.0.0

data/README.md

@@ -1,33 +1,42 @@
 resque-honeybadger
 ==================
 
-resque-honeybadger provides a [Resque][re] failure backend that sends exceptions
-raised by jobs to [honeybadger.io][hb]
+resque-honeybadger provides a [Resque][re] failure backend that sends exceptions raised by jobs to [honeybadger.io][hb].
 
 Install & Quick Start
 ---------------------
 
 Before you jump into code, you'll need a honeybadger.io account.
 
-To install:
+Add this line to your application's Gemfile:
+
+    gem 'resque-honeybadger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
 
     $ gem install resque-honeybadger
 
-### Example: Single Failure Backend
+
+### Example
 
 Using only the honeybadger failure backend:
 
+    # Suggested file in Rails: config/initializers/resque.rb
+
     require 'resque'
     require 'resque-honeybadger'
 
+    # If you don't already do `Honeybadger.configure` elsewhere.
     Resque::Failure::Honeybadger.configure do |config|
-      config.api_key = '505f2518c41866bb0be7ba434bb2b079'
+      config.api_key = 'abc123'  # Your key here.
     end
 
     Resque::Failure.backend = Resque::Failure::Honeybadger
 
-### Example: Multiple Failure Backends
-
 Using both the redis and honeybadger failure backends:
 
     require 'resque'
@@ -36,37 +45,19 @@ Using both the redis and honeybadger failure backends:
     require 'resque/failure/multiple'
     require 'resque/failure/redis'
 
+    # If you don't already do `Honeybadger.configure` elsewhere.
     Resque::Failure::Honeybadger.configure do |config|
-      config.api_key = '505f2518c41866bb0be7ba434bb2b079'
+      config.api_key = 'abc123'  # Your key here.
     end
 
     Resque::Failure::Multiple.classes = [Resque::Failure::Redis, Resque::Failure::Honeybadger]
     Resque::Failure.backend = Resque::Failure::Multiple
 
-Configuration Options
----------------------
-
-**Required**
-
-  * `api_key` - your honeybadger.io api key.
-
-
-Note on Patches/Pull Requests
------------------------------
-
-  * Fork the project.
-  * Make your feature addition or bug fix.
-  * Add tests for it. This is important so I don't break it in a future
-    version unintentionally.
-  * Commit, do not mess with the version. (if you want to have your own
-    version, that is fine but bump version in a commit by itself I can ignore
-    when I pull)
-  * Send me a pull request. Bonus points for topic branches.
-
 
 Forked by
 ------
 
+Henrik Nyh :: <http://henrik.nyh.se> :: @henrik
 Jacques Crocker :: <http://railsjedi.com> :: @railsjedi
 
 
@@ -77,4 +68,4 @@ Luke Antins :: [http://lividpenguin.com][lp] :: @lantins
 
 [re]: http://github.com/defunkt/resque
 [lp]: http://lividpenguin.com
-[hb]: http://honeybadger.io
+[hb]: http://honeybadger.io

data/lib/resque/failure/honeybadger.rb

@@ -1,8 +1,6 @@
 module Resque
   module Failure
-    # A Resque failure backend that sends exception data to honeybadger.io
     class Honeybadger < Base
-
       # Configures the failure backend. At a minimum you will need to set
       # an api_key.
       #
@@ -10,13 +8,15 @@ module Resque
       #   Resque::Failure::Honeybadger.configure do |config|
       #     config.api_key = '505f2518c41866bb0be7ba434bb2b079'
       #   end
+      #
+      # If you already configured Honeybadger for your app, x§
       def self.configure(&block)
         ::Honeybadger.configure(&block)
       end
 
       def count
-        # We can't get the total # of errors from Hoptoad so we fake it
-        # by asking Resque how many errors it has seen.
+        # We don't want to ask Honeybadger for the total # of errors,
+        # so we fake it by asking Resque instead.
         Stat[:failed]
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-honeybadger
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70204656822680 !ruby/object:Gem::Requirement
+  requirement: &70100617603500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *70204656822680
+  version_requirements: *70100617603500
 - !ruby/object:Gem::Dependency
   name: honeybadger
-  requirement: &70204656822080 !ruby/object:Gem::Requirement
+  requirement: &70100617602900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70204656822080
+  version_requirements: *70100617602900
 description: ! "    resque-honeybadger provides a Resque failure backend that sends
   exceptions\n    raised by jobs to honeybadger.io.\n"
 email: railsjedi@gmail.com