flail 0.0.3 → 0.0.4

data/.rvmrc

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

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    flail (0.0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (2.3.14)
+      activesupport (= 2.3.14)
+      rack (~> 1.1.0)
+    activerecord (2.3.14)
+      activesupport (= 2.3.14)
+    activesupport (2.3.14)
+    diff-lcs (1.1.3)
+    fakeweb (1.3.0)
+    rack (1.1.3)
+    rake (0.9.2.2)
+    rr (1.0.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    sham_rack (1.3.4)
+      rack
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 2.3.8)
+  activerecord (~> 2.3.8)
+  activesupport (~> 2.3.8)
+  fakeweb (~> 1.3.0)
+  flail!
+  rake
+  rr
+  rspec
+  sham_rack (~> 1.3.0)

data/flail.gemspec

@@ -18,7 +18,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_development_dependency 'actionpack', '~> 2.3.8'
+  s.add_development_dependency 'activerecord', '~> 2.3.8'
+  s.add_development_dependency 'activesupport', '~> 2.3.8'
+  s.add_development_dependency 'fakeweb', '~> 1.3.0'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rr'
+  s.add_development_dependency 'sham_rack', '~> 1.3.0'
 end

data/lib/flail/exception.rb

@@ -1,8 +1,9 @@
 require 'socket'
+require 'json'
 
 class Flail
   class Exception
-    def initialize(env, exception)
+    def initialize(env, exception, local = false)
       @exception = exception
       @env = env
     end
@@ -18,19 +19,15 @@ class Flail
                    end
     end
 
-    def controller
-      @controller ||= @env['action_controller.instance']
-      @controller ||= @request.controller if @request.respond_to?(:controller)
-    end
-
-    def user
-      if controller.respond_to?(:current_user)
-        current_user = controller.current_user
-
-        {:id => current_user.id, :name => current_user.to_s}
-      else
-        {}
-      end
+    def request_data
+      @request_data ||= if @env['flail.request.data']
+                          @env['flail.request.data']
+                        else
+                          {
+                            :parameters => {},
+                            :user => {},
+                          }
+                        end
     end
 
 
@@ -45,14 +42,17 @@ class Flail
       @extract ||= begin
                      info = {}
 
-                     info[:class_name]  = @exception.class.to_s        # @exception class
-                     info[:message]     = @exception.to_s              # error message
-                     info[:trace]       = @exception.backtrace.to_json # backtrace of error
-                     info[:target_url]  = request.url                  # url of request
-                     info[:referer_url] = request.referer              # referer
-                     info[:parameters]  = request.params.to_json       # request parameters
-                     info[:user_agent]  = request.user_agent           # user agent
-                     info[:user]        = self.user.to_json            # current user
+                     # rack env
+                     info[:rack]        = @env.to_json(:except => ['flail.request', 'flail.request.data'])
+                     info[:class_name]  = @exception.class.to_s             # @exception class
+                     info[:message]     = @exception.to_s                   # error message
+                     info[:trace]       = @exception.backtrace              # backtrace of error
+                     info[:target_url]  = request_data[:target_url]         # url of request
+                     info[:referer_url] = request_data[:referer_url]        # referer
+                     info[:parameters]  = request_data[:parameters]         # request parameters
+                     info[:user_agent]  = request_data[:user_agent]         # user agent
+                     info[:user]        = request_data[:user]               # current user
+                     info[:session_data]= request_data[:session_data]       # session
 
                      # special variables
                      info[:environment] = Flail.configuration.env

data/lib/flail/rails.rb

@@ -3,6 +3,7 @@ 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)

data/lib/flail/rails/controller_methods.rb

@@ -0,0 +1,34 @@
+class Flail
+  module Rails
+    module ControllerMethods
+      def flail_request_data
+        {
+          :parameters => params.to_hash,
+          :session_data => flail_session_data,
+          :target_url => request.url,
+          :referer_url => request.referer,
+          :user_agent => request.user_agent,
+          :user => flail_user_data
+        }
+      end
+
+      def flail_session_data
+        if session.respond_to?(:to_hash)
+          session.to_hash
+        else
+          session.data
+        end
+      end
+
+      def flail_user_data
+        user = current_user
+
+        user.attributes.select do |k, v|
+          /^(id|name|username|email|login)$/ === k unless v.blank?
+        end
+      rescue NoMethodError, NameError
+        {}
+      end
+    end # ControllerMethods
+  end
+end

data/lib/flail/rails/rescue_action.rb

@@ -14,7 +14,8 @@ class Flail
       # Rails 2's exception helpers.
       def rescue_action_in_public_with_flail(exception)
         request.env['flail.request'] = request
-        request.env['action_controller.instance'] = self
+        request.env['flail.request.data'] = flail_request_data
+
         Flail::Exception.new(request.env, exception).handle!
         rescue_action_in_public_without_flail(exception)
       end

data/lib/flail/railtie.rb

@@ -10,6 +10,11 @@ class Flail
         host Socket.gethostname
       end
 
+      ActiveSupport.on_load(:action_controller) do
+        require 'flail/rails/controller_methods'
+        include Flail::Rails::ControllerMethods
+      end
+
       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.0.3"
+  VERSION = "0.0.4"
 end

data/spec/rescue_action_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+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
+  end
+end

data/spec/spec_helper.rb

@@ -3,9 +3,110 @@ require 'bundler'
 Bundler.setup
 
 require 'rspec'
-require 'flail'
+require 'rr'
 
 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'
+
+class FlailArmory
+
+  module ClassMethods
+    def define_constant(name, value)
+      @defined_constants ||= []
+      Object.const_set(name, value)
+      @defined_constants << name
+    end
+
+    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
+          def rescue_action_in_public_without_flail(*args)
+          end
+        end
+        define_constant('FlailTestController', klass)
+      end
+    end
+
+    def process_action(options = {}, &action)
+      options[:request] ||= ActionController::TestRequest.new
+      options[:response] ||= ActionController::TestResponse.new
+
+      klass = build_controller_class do
+        cattr_accessor :local
+        define_method(:index, &action)
+
+        def local_request?
+          local
+        end
+      end
+
+      if options[:user_agent]
+        if options[:request].respond_to?(:user_agent=)
+          options[:request].user_agent = options[:user_agent]
+        else
+          options[:request].env["HTTP_USER_AGENT"] = options[:user_agent]
+        end
+      end
+
+      klass.consider_all_requests_local = options[:all_local]
+      klass.local = options[:local]
+
+      controller = klass.new
+      options[:request].query_parameters = options[:request].query_parameters.merge(options[:params] || {})
+      options[:request].session = ActionController::TestSession.new(options[:session] || {})
+
+      options[:request].env['REQUEST_URI'] = options[:request].request_uri
+      controller.process(options[:request], options[:response])
+      controller
+    end
+
+    def process_action_with_error(options = {})
+      process_action(options) do
+        raise "Hello"
+      end
+    end
+
+    def setup
+      Flail.configure do
+        handle do |payload|
+          FlailArmory.payload = ActiveSupport::JSON.decode(payload)
+        end
+      end
+      define_constant('RAILS_ROOT', '/path/to/rails/root')
+    end
+
+    def payload=(value)
+      @payload = value
+    end
+
+    def payload
+      @payload
+    end
+
+    def raid
+      @defined_constants.each do |constant|
+        Object.__send__(:remove_const, constant)
+      end
+
+      @payload = nil
+      @defined_constants = []
+    end
+  end
+  extend ClassMethods
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flail
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,72 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-08 00:00:00.000000000 Z
+date: 2012-08-09 00:00:00.000000000 Z
 dependencies:
+- !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
@@ -59,6 +123,22 @@ dependencies:
     - - ! '>='
       - !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.
 email:
 - machinist@asceth.com
@@ -69,7 +149,9 @@ files:
 - .gemtest
 - .gitignore
 - .rspec
+- .rvmrc
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -81,11 +163,13 @@ files:
 - lib/flail/rack.rb
 - lib/flail/rails.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/base_spec.rb
+- spec/rescue_action_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/asceth/flail
 licenses: []
@@ -113,4 +197,5 @@ specification_version: 3
 summary: Rails exception handler
 test_files:
 - spec/base_spec.rb
+- spec/rescue_action_spec.rb
 - spec/spec_helper.rb