airbrake-extended 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ec52ddc9bb46636c71f9db08278c5af2fd78e11
+  data.tar.gz: 19ed9ca49c538bcfdc2bb890a80c8523f5d770cd
+SHA512:
+  metadata.gz: 39b58075b9a7d09069e4ea437c68c45caf7052558124a01a588e5b4216159991e692590acc23b56cc117adafde44b3c1f3347b524253690694cc626459c11774
+  data.tar.gz: 300906efd699bc907976724ae16926a596961a9ba6e00e4e50f4275992dfd7c082747ccac73c58e886eb5b0ece66ae0b5b7346aeedb240bd788040cea05d3719

data/.gitignore

@@ -0,0 +1 @@
+.bundle

data/Gemfile

@@ -0,0 +1,5 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+# gem "rails"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    airbrake-extended (0.0.3)
+      delayed_job (~> 4.0, >= 4.0.0)
+      rails (~> 4.0, >= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.0)
+      actionview (= 4.2.0)
+      activesupport (= 4.2.0)
+      rack (~> 1.6.0)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activejob (4.2.0)
+      activesupport (= 4.2.0)
+      globalid (>= 0.3.0)
+    activemodel (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+    activerecord (4.2.0)
+      activemodel (= 4.2.0)
+      activesupport (= 4.2.0)
+      arel (~> 6.0)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.0)
+    builder (3.2.2)
+    delayed_job (4.0.6)
+      activesupport (>= 3.0, < 5.0)
+    erubis (2.7.0)
+    globalid (0.3.0)
+      activesupport (>= 4.1.0)
+    hike (1.2.3)
+    i18n (0.7.0)
+    json (1.8.2)
+    loofah (2.0.1)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.4.3)
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    multi_json (1.10.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rack (1.6.0)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.0)
+      actionmailer (= 4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      activemodel (= 4.2.0)
+      activerecord (= 4.2.0)
+      activesupport (= 4.2.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.0)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.5)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.1)
+      loofah (~> 2.0)
+    railties (4.2.0)
+      actionpack (= 4.2.0)
+      activesupport (= 4.2.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    sprockets (2.12.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  airbrake-extended!

data/README.md

@@ -0,0 +1,16 @@
+# Airbrake Extended
+
+_Send instance variables from raised exceptions as parameters with Airbrake notifications._
+
+## Install
+
+    gem 'airbrake-extended'
+
+
+### Caveats
+
+ - Currently only wraps exceptions raised within DelayedJob jobs. 
+ - Meant to be used in a Rails environment.
+
+
+Made with ♥ by [@jfeldstein](http://twitter.com/jfeldstein).

data/airbrake-extended.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = 'airbrake-extended'
+  s.version     = '0.0.3'
+  s.date        = '2015-03-09'
+  s.summary     = "Informative Airbrake parameters."
+  s.description = "Instance variables from the raised exception are included as parameters in the Airbrake notification. Currently only active in DelayedJob jobs. Meant to be used in a Rails environment."
+  s.authors     = ["Jordan Feldstein", "@jfeldstein"]
+  s.email       = 'jfeldstein+gem@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    =
+    'https://github.com/jfeldstein/airbrake-extended'
+  s.license       = 'MIT'
+
+  s.add_dependency 'delayed_job', '~> 4.0', '>= 4.0.0'
+  s.add_dependency 'rails', '~> 4.0', '>= 4.0.0'
+end

data/lib/README.md

@@ -0,0 +1,22 @@
+# Airbrake Extended
+
+_Send instance variables from raised exceptions as parameters with Airbrake notifications._
+
+## Install
+
+    gem 'airbrake-extended'
+    
+Automatically patches DelayedJob jobs with its custom notifier. 
+
+
+### Caveats
+
+ - Currently only wraps exceptions raised within DelayedJob jobs. 
+ - Meant to be used in a Rails environment.
+ 
+### To-Do
+
+ - Want to patch core Airbrake capture, so that parameters are sent with all errors, not just Delayed Job. 
+
+
+Made with ♥ by [@jfeldstein](http://twitter.com/jfeldstein).

data/lib/airbrake-extended.rb

@@ -0,0 +1,3 @@
+require 'delayed_job'
+require 'patches/standard_error'
+require 'patches/delayed_plugin'

data/lib/patches/delayed_plugin.rb

@@ -0,0 +1,46 @@
+module Delayed::Plugins::AirbrakeExtended
+  class Plugin < ::Delayed::Plugin
+    module Notify
+      def error(job, exception)
+        # rescue if ExceptionNotifier fails for some reason
+        begin
+          # Default is to include the job_id
+          params = {job_id: job.id}
+
+          # But also include any instance variables set in the exception itself.
+          #
+          # The is the heart of things. I recommend using custom exception classes
+          # which take the objects being worked on when the erorr is raised, and
+          # stores them as instance variables. This means when an error occurs, you
+          # get to see exactly which instance of a model was being worked on, and
+          # exactly what that hash of updates consisted of. Much easier than just the
+          # line number and message, or having to write custom begin/rescue/notifiy's
+          # everywhere.
+          #
+          params.merge!(error.airbrake_params) if error.respond_to? :airbrake_params
+
+          Airbrake.notify_or_ignore(error, parameters: params)
+
+        rescue Exception => e
+          Rails.logger.error "ExceptionNotifier failed: #{e.class.name}: #{e.message}"
+
+          e.backtrace.each do |f|
+            Rails.logger.error "  #{f}"
+          end
+
+          Rails.logger.flush
+        end
+
+        super if defined?(super)
+      end
+    end
+
+    callbacks do |lifecycle|
+      lifecycle.before(:invoke_job) do |job|
+        payload = job.payload_object
+        payload = payload.object if payload.is_a? Delayed::PerformableMethod
+        payload.extend Notify
+      end
+    end
+  end
+end

data/lib/patches/standard_error.rb

@@ -0,0 +1,24 @@
+class StandardError
+  # Shortcut for .send(:notify_or_ignore, *e.airbrake_args)
+  def airbrake_args
+    [self, parameters: airbrake_params]
+  end
+
+  # Default is to report all instance variables to Airbrake.
+  def airbrake_params
+    params = {}
+
+    begin
+      instance_variables.each do |name|
+        params[name.to_s] = instance_variable_get(name).try(:as_json)
+      end
+    rescue StandardError => e
+      # In development or test, complain if this goes wrong.
+      # In production, don't crash, omitting params instead.
+      # Dear user: If your errors stop showing parameters, this may be why.
+      raise e if Rails.env.development?
+    end
+
+    params
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: airbrake-extended
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Jordan Feldstein
+- '@jfeldstein'
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: Instance variables from the raised exception are included as parameters
+  in the Airbrake notification. Currently only active in DelayedJob jobs. Meant to
+  be used in a Rails environment.
+email: jfeldstein+gem@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- airbrake-extended.gemspec
+- lib/README.md
+- lib/airbrake-extended.rb
+- lib/patches/delayed_plugin.rb
+- lib/patches/standard_error.rb
+homepage: https://github.com/jfeldstein/airbrake-extended
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Informative Airbrake parameters.
+test_files: []