hockeybrake 0.0.2 → 0.0.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2012 Dirk Eisenberg
+
+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

@@ -7,7 +7,7 @@ An extension for the amazing airbrake gem which routes crash reports to HockeyAp
 Add this to your Gemfile
 ```ruby
 gem 'airbrake'
-gem 'hockeybrake', :git => 'git://github.com/dei79/hockeybrake.git'
+gem 'hockeybrake'
 ```
 
 Execute the following command for your Rails app
@@ -17,7 +17,28 @@ rails g hockeybrake
 
 ## Configuration
 
-Update hockeybrake.rb in config/initializers
+### General
+
+Update hockeybrake.rb in config/initializers, at least the following settings needs to be changed
+
+```ruby
+  # the bundle id
+  config.app_bundle_id= "###YOUR BUNDLE IDENTIFIER FROM HOCKEYAPP###"
+
+  # The application ID in hockey app
+  config.app_id="###YOUR APP SECRET###"
+```
+
+### Resque Failures
+
+Resque comes with out of the box support for Airbrake. This gem is compatible with this support and it is well configured by default when the resque gem becomes part of your app. This behavious can be changed through configuration if needed. Just add the following to your configuration:
+
+```ruby
+  # Support for resque exception handling is enabled by default. Wit this
+  # settings the resque support will be disabled. If no resque gem is installed
+  # it will be disabled automatically
+  config.no_resque_handler = true
+``` 
 
 ## Contributing
  

data/lib/generators/hockeybrake/templates/initializer.rb

@@ -1,9 +1,18 @@
+#
+# This section contain the standard airbrake configuration and it should be used to manipulate everything
+# what the execption handler can do for your. Airbrae API relevant things are ignored from the HockeyApp
+# sender except proxy settings.
+#
 Airbrake.configure do |config|
   # comment out if sending exceptions in the development environment 
   # is needed as well
   # config.development_environments.delete("development")
 end
 
+#
+# This section conains your hockeyapp configuration and should be used to set your HockeyApp relevant
+# key and secrets.
+#
 HockeyBrake.configure do |config|
 
   # the bundle id
@@ -16,4 +25,9 @@ HockeyBrake.configure do |config|
   # as version, otherwise use the name of your version 
   config.app_version="#{Rails.env}"
 
+  # Support for resque exception handling is enabled by default. Wit this
+  # settings the resque support will be disabled. If no resque gem is installed
+  # it will be disabled automatically
+  # config.no_resque_handler = true
+
 end

data/lib/hockeybrake/configuration.rb

@@ -10,17 +10,27 @@ module HockeyBrake
     # The app version
     attr_accessor :app_version
 
+    # Allow to disable resque support
+    attr_accessor :no_resque_handler
+
     # The service url
     def hockey_url
       "https://rink.hockeyapp.net/api/2/apps/#{app_id}/crashes/upload"
     end
 
+    # ctor
+    def initialize
+      # resque is enable by default
+      self.no_resque_handler = false
+    end
+
     # convert to hash
     def to_hash
       h = Hash.new
       h[:app_id] = self.app_id
       h[:app_version] = self.app_version
       h[:hockey_url] = self.hockey_url
+      h[:no_resque_handler] = self.no_resque_handler
       h
     end
   end

data/lib/hockeybrake/version.rb

@@ -1,4 +1,4 @@
 module HockeyBrake
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end
 

data/lib/hockeybrake.rb

@@ -10,6 +10,24 @@ module HockeyBrake
     def configure
       # receive the configuration
       yield(configuration)
+
+      # check if we have resque support
+      if self.configuration.no_resque_handler == false
+
+        # Load optional modules for resque support and configure the resque handler for
+        # us if needed
+        begin
+          require 'resque/failure/multiple'
+          require 'resque/failure/airbrake'
+          require 'resque/failure/redis'
+
+          Resque::Failure::Multiple.classes = [Resque::Failure::Redis, Resque::Failure::Airbrake]
+          Resque::Failure.backend = Resque::Failure::Multiple
+        rescue
+          # nothing to do
+        end
+
+      end
     end
 
     def configuration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hockeybrake
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -54,6 +54,7 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - hockeybrake.gemspec
 - lib/generators/hockeybrake/hockeybrake_generator.rb