flail 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+
+

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 John "asceth" Long
+
+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

@@ -0,0 +1,51 @@
+Flail is an exception catcher for Rack applications.
+
+##### Supports
+
+* Rails 2.3.x
+* Rails 3.x
+
+
+#### Install
+
+```
+$ [sudo] gem install flail
+```
+
+For Rails 2.3.x, install the gem as a plugin
+
+
+#### Usage
+
+
+Add an initializer to configure (or call configure during application startup):
+
+```ruby
+Flail.configure do
+  # configure a custom handler for the error payload
+  # don't call if you want to use the default http post handler
+  handler do |payload|
+  end
+
+  # endpoint for default handler
+  endpoint "https://flail.net/swing"
+
+  # environment of application, defaults to Rails.env
+  # included in payload
+  env "production"
+
+  # hostname to use of server, defaults to Socket.gethostname
+  # included in payload
+  host Socket.gethostname
+
+  # arbitrary api key which can identify
+  # your project or be anything else
+  api "custom_key"
+end
+```
+
+
+#### Author
+
+
+Original author: John "asceth" Long

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler"
+Bundler.setup
+
+require "rspec"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+gemspec = eval(File.read(File.join(Dir.pwd, "flail.gemspec")))
+
+task :build => "#{gemspec.full_name}.gem"
+
+task :test => :spec
+task :default => :spec
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["flail.gemspec"] do
+  system "gem build flail.gemspec"
+  system "gem install flail-#{Flail::VERSION}.gem"
+end
+

data/flail.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "flail/version"
+
+Gem::Specification.new do |s|
+  s.name        = "flail"
+  s.version     = Flail::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John 'asceth' Long"]
+  s.email       = ["machinist@asceth.com"]
+  s.homepage    = "https://github.com/asceth/flail"
+  s.summary     = "Rails exception handler"
+  s.description = "Handle Rails exceptions with the fail flail."
+
+  s.rubyforge_project = "flail"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rr'
+end

data/lib/flail/base.rb

@@ -0,0 +1,16 @@
+class Flail
+  module ClassMethods
+    def configure(&block)
+      configuration.instance_eval(&block)
+    end
+
+    def configuration
+      @configuration ||= Flail::Configuration.new.defaults!
+    end
+
+    def swing(payload)
+      Flail.configuration.handler.call(payload)
+    end
+  end
+  extend ClassMethods
+end

data/lib/flail/configuration.rb

@@ -0,0 +1,76 @@
+class Flail
+  class Configuration
+    # custom handler for payloads
+    attr_reader :handler
+
+    # endpoint for default handler (used with flail-web)
+    attr_reader :endpoint
+
+    # environment of application
+    attr_reader :env
+
+    # hostname sending the error
+    attr_reader :hostname
+
+    # is the endpoint ssl?
+    attr_reader :secure_endpoint
+
+    # api key to use with payloads
+    attr_reader :api_key
+
+
+    def handle(&block)
+      @handler = block
+    end
+
+    def url(endpoint)
+      @endpoint = endpoint
+    end
+
+    def secure
+      @secure_endpoint = true
+    end
+
+    def environment(value)
+      @env = value
+    end
+
+    def host(value)
+      @hostname = value
+    end
+
+    def api(value)
+      @api_key = value
+    end
+
+    def defaults!
+      # configure some defaults
+      @secure_endpoint = false
+
+      handle do |payload|
+
+        url = URI.parse(Flail.configuration.endpoint)
+
+        http = Net::HTTP.new(url.host, url.port)
+
+        http.read_timeout = 5
+        http.open_timeout = 2
+
+        if Flail.configuration.secure_endpoint
+          http.use_ssl      = true
+          http.verify_mode  = OpenSSL::SSL::VERIFY_PEER
+        else
+          http.use_ssl      = false
+        end
+
+        begin
+          http.post(url.path, payload, HEADERS)
+        rescue *HTTP_ERRORS => e
+          nil
+        end
+      end
+
+      self
+    end # end defaults!
+  end
+end

data/lib/flail/exception.rb

@@ -0,0 +1,67 @@
+require 'socket'
+
+class Flail
+  class Exception
+    def initialize(env, exception)
+      @exception = exception
+      @env = env
+    end
+
+    #
+    # Helpers
+    #
+    def request
+      @request ||= ActionDispatch::Request.new(@env)
+    end
+
+    def controller
+      @controller ||= @env['action_controller.instance']
+    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
+    end
+
+
+    #
+    # Handling the exception
+    #
+    def handle!
+      Flail.swing(self.extract.to_json) unless self.ignore?
+    end
+
+    def extract
+      @extract ||= {}.tap do |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[:params]      = request.params.to_json       # request parameters
+        info[:user_agent]  = request.user_agent           # user agent
+        info[:user]        = self.user.to_json            # current user
+
+        # special variables
+        info[:environment] = Flail.configuration.env
+        info[:hostname]    = Flail.configuration.hostname
+        info[:api_key]    = Flail.configuration.api_key
+      end
+    end
+
+    def ignore?
+      # Ignore requests with user agent string matching
+      # this regxp as they are surely made by bots
+      if @request.user_agent =~ /\b(Baidu|Gigabot|Googlebot|libwww-perl|lwp-trivial|msnbot|SiteUptime|Slurp|WordPress|ZIBB|ZyBorg|Yandex|Jyxobot|Huaweisymantecspider|ApptusBot)\b/i
+        return true
+      end
+
+      false
+    end
+  end
+end

data/lib/flail/rack.rb

@@ -0,0 +1,24 @@
+class Flail
+  module Handlers
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        begin
+          response = @app.call(env)
+        rescue Exception => exception
+          Flail::Exception.new(env, exception).handle!
+          raise
+        end
+
+        if env['rack.exception']
+          Flail::Exception.new(env, env['rack.exception']).handle!
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/flail/rails/action_dispatch.rb

@@ -0,0 +1,15 @@
+class Flail
+  module Rails
+    module ActionDispatch
+      def self.included(base)
+        base.send(:alias_method_chain, :render_exception, :flail)
+      end
+
+      def render_exception_with_flail(env, exception)
+        Flail::Exception.new(env, exception).handle!
+
+        render_exception_without_flail(env, exception)
+      end
+    end
+  end
+end

data/lib/flail/rails/rescue_action.rb

@@ -0,0 +1,21 @@
+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)
+        Flail::Exception.new(request.env, exception).handle!
+        rescue_action_in_public_without_flail(exception)
+      end
+    end
+  end
+end

data/lib/flail/rails.rb

@@ -0,0 +1,15 @@
+require 'flail'
+require 'flail/rails/rescue_action'
+
+if defined?(::ActionController::Base)
+  ::ActionController::Base.send(:include, Flail::Rails::RescueAction)
+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/railtie.rb

@@ -0,0 +1,25 @@
+class Flail
+  class Railtie < ::Rails::Railtie
+    initializer "flail.use_rack_middleware" do |app|
+      app.config.middleware.insert 0, "Flail::Rack"
+    end
+
+    config.after_initialize do
+      Flail.configure do
+        environment ::Rails.env
+        host Socket.gethostname
+      end
+
+      if defined?(::ActionDispatch::DebugExceptions)
+        # Rails 3.2.x
+        require 'flail/rails/action_dispatch'
+        ::ActionDispatch::DebugExceptions.send(:include, Flail::Rails::ActionDispatch)
+
+      elsif defined?(::ActionDispatch::ShowExceptions)
+        # Rails 3.0.x || 3.1.x
+        require 'flail/rails/action_dispatch'
+        ::ActionDispatch::ShowExceptions.send(:include, Flail::Rails::ActionDispatch)
+      end
+    end
+  end
+end

data/lib/flail/version.rb

@@ -0,0 +1,3 @@
+class Flail
+  VERSION = "0.0.1"
+end

data/lib/flail.rb

@@ -0,0 +1,10 @@
+require 'net/http'
+require 'net/https'
+require 'socket'
+
+require 'flail/base'
+require 'flail/configuration'
+require 'flail/exception'
+require 'flail/rack'
+
+require 'flail/railtie' if defined?(::Rails::Railtie)

data/rails/init.rb

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

data/spec/base_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Flail do
+
+  context "#configuration" do
+    it "should return the same object for multiple calls" do
+      Flail.configuration.should == Flail.configuration
+    end
+  end
+
+  context "#configure" do
+    it "should fail without a block" do
+      lambda { Flail.configure }.should raise_error
+    end
+
+    it "should instance_eval the block onto configuration" do
+      block = Proc.new { handle {|payload| } }
+      mock(Flail).configuration.stub!.instance_eval(&block)
+      Flail.configure(&block)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'rspec'
+require 'flail'
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: flail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- John 'asceth' Long
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-27 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: Handle Rails exceptions with the fail flail.
+email:
+- machinist@asceth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemtest
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- flail.gemspec
+- lib/flail.rb
+- lib/flail/base.rb
+- lib/flail/configuration.rb
+- lib/flail/exception.rb
+- lib/flail/rack.rb
+- lib/flail/rails.rb
+- lib/flail/rails/action_dispatch.rb
+- lib/flail/rails/rescue_action.rb
+- lib/flail/railtie.rb
+- lib/flail/version.rb
+- rails/init.rb
+- spec/base_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/asceth/flail
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Rails exception handler
+test_files:
+- spec/base_spec.rb
+- spec/spec_helper.rb