flail 0.1.6 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89d0fd9af2111f029883bf00961abfbc4aa88ed5
+  data.tar.gz: d503ca06042d751c61880a42fe603f3010d1f6f5
+SHA512:
+  metadata.gz: 9d805dd45ac83a802f8c74352f92e7cda861fed0dd5c3192081a23a81258a8fc87f3b14ef64a93f591efe3a559af2ebbc059dd3d40fb0d7cbf02ee8352b60494
+  data.tar.gz: ef102a70922af14d7c08f5f5850a7dfe6460441d68a29120b94d71e62246f44e98236f4cdc53b6323499622ef67de84ff8f2f65ecf0c7392aa6be9523b52af7c

data/.gitignore

@@ -1,3 +1,8 @@
-*.gem
-
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
 
+# Ignore gem stuff
+*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    flail (0.1.5)
+    flail (1.0.0)
       json
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     actionpack (2.3.14)
       activesupport (= 2.3.14)
@@ -15,7 +15,7 @@ GEM
     activesupport (2.3.14)
     diff-lcs (1.1.3)
     fakeweb (1.3.0)
-    json (1.7.5)
+    json (1.8.1)
     rack (1.1.3)
     rake (0.9.2.2)
     rr (1.0.4)

data/README.md

@@ -2,8 +2,8 @@ Flail is an exception catcher for Rack applications.
 
 ##### Supports
 
-* Rails 2.3.x
 * Rails 3.x
+* (See earlier 0.x.x releases for Rails 2.3.x support)
 
 
 ### Install
@@ -14,23 +14,8 @@ gem :flail
 ```
 
 
-###### Rails 2.3.x
-```ruby
-gem :flail, :require => false
-```
-
-When configuring in the initializer as seen in Usage below be sure to add
-```ruby
-require 'flail/rails'
-```
-
-so the proper requires are done for Rails 2.3.x
-
-
-
 ### Usage
 
-
 Add an initializer to configure (or call configure during application startup):
 
 ```ruby
@@ -59,10 +44,12 @@ end
 
 
 ### Helpful Additions
+
 See flail_web for a Rails 3 application designed to receive flail exceptions so you can inspect them.
 https://github.com/asceth/flail_web
 
-### Author
 
+### Authors
 
 Original author: John "asceth" Long
+Contributor: Ben Fenner

data/lib/flail.rb

@@ -6,6 +6,7 @@ require 'flail/base'
 require 'flail/configuration'
 require 'flail/backtrace'
 require 'flail/exception'
-require 'flail/rack'
+require 'flail/rack_middleware_exception_hook'
 
+# Railtie is not defined in spec tests so don't require during them.
 require 'flail/railtie' if defined?(::Rails::Railtie)

data/lib/flail/{rack.rb → rack_middleware_exception_hook.rb}

@@ -1,5 +1,5 @@
 class Flail
-  class Rack
+  class RackMiddlewareExceptionHook
     def initialize(app)
       @app = app
     end

data/lib/flail/rails/controller_methods.rb

@@ -1,6 +1,22 @@
 class Flail
   module Rails
     module ControllerMethods
+    
+      def self.included(base)
+        base.send(:before_filter, :inject_flail_data_into_environment)
+      end
+
+      # This method is inserted into the host application's controllers as a before_filter
+      # and is used to pass the parameters, session data, user data, and URL data from the app's 
+      # controller to the flail gem via the env variable (data is always passed, even if no 
+      # exception is thrown). This hook only works when a host app's controller is called. 
+      # Routing error exceptions are thrown before the controller is called so those errors are 
+      # handled elsewhere and contain less information (mainly the user data is missing).
+      def inject_flail_data_into_environment
+        request.env['flail.request'] ||= request
+        request.env['flail.request.data'] ||= flail_request_data
+      end
+
       def flail_request_data
         {
           :parameters => params.to_hash,

data/lib/flail/railtie.rb

@@ -1,20 +1,27 @@
 class Flail
   class Railtie < ::Rails::Railtie
+
+    # Setup Flail::RackMiddlewareExceptionHook as the first rack middleware 
+    # to catch exceptions that happen in the middleware chain.
     initializer "flail.use_rack_middleware" do |app|
-      app.config.middleware.insert 0, Flail::Rack
+      app.config.middleware.insert 0, Flail::RackMiddlewareExceptionHook
     end
 
+    # Set the environment and host.
     config.after_initialize do
       Flail.configure do
         environment ::Rails.env
         host Socket.gethostname
       end
 
+      # Add methods to the Aciont Controller so they may be run from within the
+      # controller scope. Useful for getting user data and similar.
       ActiveSupport.on_load(:action_controller) do
         require 'flail/rails/controller_methods'
         include Flail::Rails::ControllerMethods
       end
 
+      # Setup the hooks to catch typical exceptions when they happen.
       if defined?(::ActionDispatch::DebugExceptions)
         # Rails 3.2.x
         require 'flail/rails/action_dispatch'

data/lib/flail/version.rb

@@ -1,3 +1,3 @@
 class Flail
-  VERSION = "0.1.6"
+  VERSION = "1.0.0"
 end

data/spec/exception_spec.rb

@@ -6,12 +6,15 @@ require 'flail/backtrace'
 require 'flail/exception'
 
 describe Flail::Exception do
+  
+  #Setup flail with dummy handler as these tests aren't very complex.
+  Flail.configure do
+    handle do |payload|
+      # Do nothing.
+    end
+  end
 
-  subject { Flail::Exception.new({}, Exception.new) }
-  SAMPLE_BACKTRACE = [
-                      "app/models/user.rb:13:in `magic'",
-                      "app/controllers/users_controller.rb:8:in `index'"
-                     ]
+  subject { Flail::Exception.new(Exception.new, {}) }
 
   it "should not choke on bad utf-8" do
     b1r = 0xc0..0xc2
@@ -25,7 +28,7 @@ describe Flail::Exception do
     end
   end
 
-  it "should be able to accept and generic error with no request attached" do
+  it "should be able to accept a generic exception with no request attached" do
     lambda { Flail::Exception.notify(Exception.new) }.should_not raise_error
   end
 end

data/spec/{rack_spec.rb → rack_middleware_exception_hook_spec.rb}

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
 require 'ostruct'
-require 'flail/rack'
+require 'flail/rack_middleware_exception_hook'
 
-describe Flail::Rack do
+describe Flail::RackMiddlewareExceptionHook do
 
-  subject { Flail::Rack.new lambda {|env| "val: #{env.fetch(:required_key)}" } }
+  subject { Flail::RackMiddlewareExceptionHook.new lambda {|env| "val: #{env.fetch(:required_key)}" } }
 
   context "when an exception is raised by the app" do
     let(:env) { {} }

data/spec/spec_helper.rb

@@ -9,16 +9,12 @@ RSpec.configure do |config|
   config.mock_with :rr
 end
 
-require 'action_controller'
-require 'action_controller/test_process'
 require 'active_record'
-require 'active_support'
 require 'rack'
 require 'sham_rack'
 
 require 'flail'
 require 'flail/rails/controller_methods'
-require 'flail/rails/rescue_action'
 
 
 Dir["#{File.expand_path(File.dirname(__FILE__))}/support/*.rb"].map {|file| require(file)}
@@ -35,7 +31,6 @@ class FlailArmory
     def build_controller_class(&definition)
       Class.new(ActionController::Base).tap do |klass|
         klass.__send__(:include, Flail::Rails::ControllerMethods)
-        klass.__send__(:include, Flail::Rails::RescueAction)
         klass.class_eval(&definition) if definition
 
         klass.class_eval do

metadata

@@ -1,158 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: flail
 version: !ruby/object:Gem::Version
-  version: 0.1.6
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - John 'asceth' Long
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-09 00:00:00.000000000 Z
+date: 2014-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.8
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.8
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.8
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sham_rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
 description: Handle Rails exceptions with the fail flail.
@@ -162,10 +143,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gemtest
-- .gitignore
-- .rspec
-- .rvmrc
+- ".gemtest"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -177,50 +158,44 @@ files:
 - lib/flail/base.rb
 - lib/flail/configuration.rb
 - lib/flail/exception.rb
-- lib/flail/rack.rb
-- lib/flail/rails.rb
+- lib/flail/rack_middleware_exception_hook.rb
 - lib/flail/rails/action_dispatch.rb
 - lib/flail/rails/controller_methods.rb
-- lib/flail/rails/rescue_action.rb
 - lib/flail/railtie.rb
 - lib/flail/version.rb
-- rails/init.rb
 - spec/backtrace_spec.rb
 - spec/base_spec.rb
 - spec/exception_spec.rb
-- spec/rack_spec.rb
-- spec/rescue_action_spec.rb
+- spec/rack_middleware_exception_hook_spec.rb
 - spec/spec_helper.rb
 - spec/support/rr.rb
 homepage: https://github.com/asceth/flail
 licenses: []
+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'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: flail
-rubygems_version: 1.8.23
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rails exception handler
 test_files:
 - spec/backtrace_spec.rb
 - spec/base_spec.rb
 - spec/exception_spec.rb
-- spec/rack_spec.rb
-- spec/rescue_action_spec.rb
+- spec/rack_middleware_exception_hook_spec.rb
 - spec/spec_helper.rb
 - spec/support/rr.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.9.3@flail

data/lib/flail/rails.rb

@@ -1,16 +0,0 @@
-require 'flail'
-require 'flail/rails/rescue_action'
-
-if defined?(::ActionController::Base)
-  ::ActionController::Base.send(:include, Flail::Rails::RescueAction)
-  ::ActionController::Base.send(:include, Flail::Rails::ControllerMethods)
-end
-
-if defined?(::Rails.configuration) && ::Rails.configuration.respond_to?(:middleware)
-  ::Rails.configuration.middleware.insert_after 'ActionController::Failsafe', Flail::Rack
-end
-
-Flail.configure do
-  environment(defined?(::Rails.env) && ::Rails.env || defined?(RAILS_ENV) && RAILS_ENV)
-  host Socket.gethostname
-end

data/lib/flail/rails/rescue_action.rb

@@ -1,24 +0,0 @@
-class Flail
-  module Rails
-    module RescueAction
-      # Sets up an alias chain to catch exceptions when Rails does
-      def self.included(base)
-        base.send(:alias_method, :rescue_action_in_public_without_flail, :rescue_action_in_public)
-        base.send(:alias_method, :rescue_action_in_public, :rescue_action_in_public_with_flail)
-      end
-
-      private
-
-      # Overrides the rescue_action method in ActionController::Base
-      # but uses any custom processing that is defined with
-      # Rails 2's exception helpers.
-      def rescue_action_in_public_with_flail(exception)
-        request.env['flail.request'] = request
-        request.env['flail.request.data'] = flail_request_data
-
-        Flail::Exception.new(request.env, exception).handle!
-        rescue_action_in_public_without_flail(exception)
-      end
-    end
-  end
-end

data/rails/init.rb

@@ -1 +0,0 @@
-require 'flail/rails'

data/spec/rescue_action_spec.rb

@@ -1,87 +0,0 @@
-require 'spec_helper'
-
-require 'ostruct'
-require 'flail/rails/rescue_action'
-
-describe Flail::Rails::RescueAction do
-
-  context "catching requests" do
-    before do
-      FlailArmory.setup
-    end
-
-    before(:each) do
-      FlailArmory.raid
-    end
-
-    it "should deliver an exception raised in public requests" do
-      FlailArmory.process_action_with_error
-      FlailArmory.payload.should_not be_nil
-    end
-
-    it "should not deliver exceptions in local requests" do
-      FlailArmory.process_action_with_error(:local => true)
-      FlailArmory.payload.should be_nil
-    end
-
-    it "should not deliver exceptions when all requests are local" do
-      FlailArmory.process_action_with_error(:all_local => true)
-      FlailArmory.payload.should be_nil
-    end
-
-    it "should not deliver exceptions from actions that don't raise" do
-      controller = FlailArmory.process_action { render :text => 'Hello' }
-
-      FlailArmory.payload.should be_nil
-      controller.response.body.should == 'Hello'
-    end
-
-    it "should send session data" do
-      data = {'one' => 'two'}
-      FlailArmory.process_action_with_error(:session => data)
-
-      FlailArmory.payload['session_data'].should == data
-    end
-
-    it "should send user data" do
-      user = OpenStruct.new(:attributes => {:id => 1, :login => 'jlong'})
-      FlailArmory.process_action_with_error(:user => user)
-
-      FlailArmory.payload['user'].should == {'id' => 1, 'login' => 'jlong'}
-    end
-
-    it "should call session.to_hash if available" do
-      hash_data = {:key => :value}
-
-      session = ActionController::TestSession.new
-      stub(ActionController::TestSession).new { session }
-      stub(session).to_hash { hash_data }
-
-      FlailArmory.process_action_with_error
-
-      session.should have_received.to_hash
-      session.should_not have_received.data
-      FlailArmory.payload.should_not be_nil
-    end
-
-    it "should call session.to_hash if available" do
-      hash_data = {:key => :value}
-
-      session = ActionController::TestSession.new
-      stub(ActionController::TestSession).new { session }
-      stub(session).data { hash_data }
-
-      if session.respond_to?(:to_hash)
-        class << session
-          undef :to_hash
-        end
-      end
-
-      FlailArmory.process_action_with_error
-
-      session.should_not have_received.to_hash
-      session.should have_received.data
-      FlailArmory.payload.should_not be_nil
-    end
-  end
-end