failbot_rails 0.3.2 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 441b416474c1c69f22134a48f0020ad0785dc5553265f53cc783ee8197a9f5b3
+  data.tar.gz: 519fe049ede9e2befbcdd49cf01122dd764f3e1c4a08123dc872084702ee40ca
+SHA512:
+  metadata.gz: 3d9abe3b2fa52c43867175219a9a7170404ddf613a69f5c5eb8497e56341e087c7cb109c10dbf43d49274490b4c6f8f4b6b6269251aab4f70dd439775d4df5cf
+  data.tar.gz: ffbf33ec1535ce975f005e2b7771a6f026f8f26e860933f5fd72169ccea2ffe423893b4bfe5d2b152b03cae30239d100c28af1bd3e7cb9404621b951fba7c9b8

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor/gems

data/Dockerfile

@@ -0,0 +1,6 @@
+FROM ruby:2.5
+
+WORKDIR /ci
+ADD . .
+
+ENTRYPOINT ["/ci/script/cibuild.docker"]

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in failbot_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 GitHub
+
+MIT License
+
+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

@@ -12,7 +12,7 @@ Add it to the app's Gemfile manifest. The gem is publicly available but **keep
 this repository private.**
 
 ```ruby
-gem "failbot_rails", "~>0.3.1"
+gem "failbot_rails", "~>0.3.4"
 ```
 
 ## Usage
@@ -33,6 +33,34 @@ FailbotRails.setup("my_app")
 Every library, script or unicorn that loads the Rails environment are now setup
 to automatically report all exceptions to Haystack.
 
+### ENV Vars
+
+In order for your exceptions to reach Haystack, you'll need to inform your
+application of how to do that. Set these `ENV` vars on your application in
+production.
+
+#### Heroku
+
+To use failbot with heroku applications, the application needs the following environment variables set:
+
+* `FAILBOT_BACKEND`
+* `FAILBOT_HAYSTACK_URL`
+
+`FAILBOT_BACKEND` should always be set to `http`. `FAILBOT_HAYSTACK_URL` should be set to the value of `FAILBOT_HAYSTACK_URL` of https://github.com/github/puppet/blob/master/modules/github/files/home/deploy/.rbexec/_failbot.rb.
+
+Most versions of Failbot expect `FAILBOT_BACKEND` to always be present. Try adding this line above `require 'failbot'` to ensure that if `FAILBOT_BACKEND` isn't configured, it will fall back to `memory`:
+
+```ruby
+ENV["FAILBOT_BACKEND"] ||= "memory"
+```
+
+
+#### EC2
+
+Apps hosted on EC2 are managed by puppet. Puppet has these ENV vars already. You
+don't have to worry about them.
+
+
 ### `failbot_context`
 
 The exception context is automatically populated with request metadata including

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+    t.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test

data/failbot_rails.gemspec

@@ -1,21 +1,29 @@
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'failbot_rails/version'
 
-Gem::Specification.new do |s|
-  s.name        = "failbot_rails"
-  s.version     = "0.3.2"
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = %w[@sr]
-  s.email       = ["sr@github.com"]
-  s.homepage    = "https://github.com/github/failbot_rails#readme"
-  s.summary     = "Glue code for using Failbot in a Rails app"
-  s.description = s.summary
+Gem::Specification.new do |spec|
+  spec.name          = "failbot_rails"
+  spec.version       = FailbotRails::VERSION
+  spec.authors       = ["sr", "Grant Rodgers"]
+  spec.email         = ["grant.rodgers@github.com"]
+  spec.summary       = %q{Glue code for using Failbot in a Rails app}
+  spec.description   = %q{Glue code for using Failbot in a Rails app}
+  spec.homepage      = "https://github.com/github/failbot_rails"
+  spec.license       = "MIT"
 
-  s.required_rubygems_version = ">= 1.3.6"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files.reject! { |filename| filename == ".ruby-version" }
 
-  s.add_runtime_dependency "failbot", "~>0.9.1"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  s.files         = `git ls-files`.split("\n") - %w[Gemfile Gemfile.lock]
-  s.test_files    = `git ls-files -- test`.split("\n").select { |f| f =~ /_test.rb$/ }
-  s.executables   = `git ls-files -- bin`.split("\n").map { |f| File.basename(f) }
-  s.require_paths = %w[lib]
+  spec.add_runtime_dependency "failbot", ">= 0.9.2", "< 3"
+  spec.add_runtime_dependency "rails", "~> 6.0"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.required_ruby_version = ">= 2.5.0"
 end

data/lib/failbot_rails.rb

@@ -6,7 +6,7 @@ require "rails/railtie"
 require "active_support/concern"
 
 module FailbotRails
-  def self.setup(app_name)
+  def self.setup(app_name, default_context={})
     if _setup
       fail "FailbotRails already setup"
     end
@@ -26,7 +26,7 @@ module FailbotRails
       end
     end
 
-    Failbot.setup(settings, {:app => app_name.to_str})
+    Failbot.setup(settings, default_context.merge({:app => app_name.to_str}))
     Failbot.install_unhandled_exception_hook!
 
     @_setup = true
@@ -63,30 +63,18 @@ module FailbotRails
   class Middleware < ::Failbot::Rescuer
     def initialize(app)
       @app = app
+      @other = {}
     end
 
-    def call(env)
-      request = Rack::Request.new(env)
-      @app.call(env)
-    rescue Exception
-      context = {
-        :method       => request.request_method,
-        :url          => request.url,
-        :user_agent   => request.env["HTTP_USER_AGENT"],
-        :params       => request.params,
-        :session      => (request.session.to_hash rescue nil),
-        :referrer     => request.referrer,
-        :remote_ip    => request.ip,
-      }
-      Failbot.report($!, ::FailbotRails._failbot_safe_context(context))
-      raise
+    def self.context(env)
+      ::FailbotRails._failbot_safe_context(super)
     end
   end
 
   def self._failbot_safe_context(context)
     new_context = {}.merge(context)
     filters = Rails.application.config.filter_parameters
-    filter = ActionDispatch::Http::ParameterFilter.new(filters)
+    filter = ActiveSupport::ParameterFilter.new(filters)
 
     if new_context.key?(:params)
       new_context[:params] = filter.filter(new_context[:params])
@@ -100,9 +88,9 @@ module FailbotRails
 
     included do
       # reset context before populating it with rails-specific info
-      before_filter :_failbot_rails
+      before_action :_failbot_rails
 
-      helper_method :failbot
+      respond_to?(:helper_method) and helper_method :failbot
     end
 
     private
@@ -122,9 +110,6 @@ module FailbotRails
     end
 
     def _failbot_rails
-      # clear context before every request
-      Failbot.reset!
-
       context = {
         :controller => params[:controller],
         :action => params[:action],

data/lib/failbot_rails/version.rb

@@ -0,0 +1,3 @@
+module FailbotRails
+  VERSION = "0.7.0"
+end

data/script/cibuild

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+set -e
+set -x
+
+img=failbotd:$(git rev-parse HEAD)
+docker build -f Dockerfile . -t $img
+docker run --rm -i $img

data/script/cibuild.docker

@@ -0,0 +1,8 @@
+#!/bin/sh
+set -e
+
+export PATH=/usr/share/rbenv/shims:$PATH
+
+bundle --path vendor/gems --binstubs vendor/gems
+
+bundle exec rake

metadata

@@ -1,64 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: failbot_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.2
-  prerelease: 
+  version: 0.7.0
 platform: ruby
 authors:
-- ! '@sr'
-autorequire: 
+- sr
+- Grant Rodgers
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-08-15 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: failbot
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 description: Glue code for using Failbot in a Rails app
 email:
-- sr@github.com
+- grant.rodgers@github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Dockerfile
+- Gemfile
+- LICENSE.txt
 - README.md
+- Rakefile
 - failbot_rails.gemspec
 - lib/failbot_rails.rb
-homepage: https://github.com/github/failbot_rails#readme
-licenses: []
-post_install_message: 
+- lib/failbot_rails/version.rb
+- script/cibuild
+- script/cibuild.docker
+homepage: https://github.com/github/failbot_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
-signing_key: 
-specification_version: 3
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
 summary: Glue code for using Failbot in a Rails app
 test_files: []