squash_rails 1.0.0 → 1.1.0

data/README.md

@@ -31,9 +31,16 @@ https://github.com/SquareSquash/ruby
 Usage
 -----
 
-See the `squash_ruby` gem for installation and configuration instructions. Note
-that it is no longer necessary to set the `:environment` configuration option;
-the Rails client library automatically sets that to the Rails environment.
+Add this gem and the Squash Ruby gem to your Gemfile:
+
+```` ruby
+gem 'squash_ruby', :require => 'squash/ruby'
+gem 'squash_rails', :require => 'squash/rails'
+````
+
+See the `squash_ruby` gem for configuration instructions. Note that it is no
+longer necessary to set the `:environment` configuration option; the Rails
+client library automatically sets that to the Rails environment.
 
 You can use the usual `Squash::Ruby.notify` method in your Rails projects, but
 you will miss out on some Rails-specific information in your exception logs. You

data/lib/squash/rails/capistrano.rb

@@ -14,11 +14,15 @@
 
 # Capistrano tasks for Rails apps using Squash.
 
-desc "Notifies Squash of a new deploy."
-task 'squash:notify', :roles => :web, :only => {:primary => true}, :except => {:no_release => true} do
-  rails_env = fetch(:rails_env, 'production')
-  run "bundle exec rake squash:notify REVISION=#{real_revision} DEPLOY_ENV=#{rails_env}"
-end
+Capistrano::Configuration.instance.load do
+  namespace :squash do
+    desc "Notifies Squash of a new deploy."
+    task :notify, :roles => :web, :only => {:primary => true}, :except => {:no_release => true} do
+      rails_env = fetch(:rails_env, 'production')
+      run "cd #{current_path} && env RAILS_ENV=#{rails_env} #{fetch(:bundle_cmd, "bundle")} exec rake squash:notify REVISION=#{real_revision} DEPLOY_ENV=#{rails_env}"
+    end
+  end
 
-after 'deploy:restart', 'squash:notify'
-after 'deploy:start', 'squash:notify'
+  after 'deploy:restart', 'squash:notify'
+  after 'deploy:start', 'squash:notify'
+end

data/lib/squash/rails/rack.rb

@@ -0,0 +1,94 @@
+module Squash
+  module Rails
+
+    # Rack middleware that catches exceptions thrown outside the scope of
+    # Rails's request processing. This middleware is automatically added to your
+    # stack when you include the `squash_rails` gem.
+
+    class Rack
+
+      # Instantiates the middleware.
+      #
+      # @param [Array] app The middleware stack.
+
+      def initialize(app)
+        @app = app
+      end
+
+      # Rescues any exceptions thrown downstream, notifies Squash, then
+      # re-raises them.
+      #
+      # @param [Hash] env The Rack environment.
+      # @return [Hash] The Rack result to pass up the stack.
+
+      def call(env)
+        @env = env
+
+        begin
+          result = @app.call(env)
+        rescue ::Exception => ex
+          @env['squash.notified'] = ::Squash::Ruby.notify(ex, squash_rack_data)
+          raise ex
+        end
+
+        result
+      end
+
+      # @abstract
+      #
+      # Override this method to implement filtering of sensitive data in the
+      # headers, cookies, and rack hashes (see {#squash_rack_data}). The method
+      # signature is the same as `Squash::Ruby#filter_for_squash`, but `kind`
+      # can also be `:env` for the Rack environment hash.
+
+      def filter_for_squash(data, kind)
+        data
+      end
+
+      # @return [Hash<Symbol, Object>] The additional information this
+      #   middleware gives to `Squash::Ruby.notify`.
+
+      def squash_rack_data
+        {
+          :environment    => environment_name,
+          :root           => root_path,
+
+          :headers        => filter_for_squash(request_headers, :headers),
+          :request_method => @env['REQUEST_METHOD'].to_s.upcase,
+          :schema         => @env['rack.url_scheme'],
+          :host           => @env['SERVER_NAME'],
+          :port           => @env['SERVER_PORT'],
+          :path           => @env['PATH_INFO'],
+          :query          => @env['QUERY_STRING'],
+
+          :params         => filter_for_squash(@env['action_dispatch.request.parameters'], :params),
+          :session        => filter_for_squash(@env['rack.session'], :session),
+          :flash          => filter_for_squash(@env[ActionDispatch::Flash::KEY], :flash),
+          :cookies        => filter_for_squash(@env['rack.request.cookie_hash'], :cookies),
+
+          :"rack.env"     => filter_for_squash(@env, :rack)
+        }
+      end
+
+      private
+
+      def environment_name
+        if defined?(::Rails)
+          ::Rails.env.to_s
+        else
+          ENV['RAILS_ENV'] || ENV['RACK_ENV']
+        end
+      end
+
+      # Extract any rack key/value pairs where the key begins with HTTP_*
+      def request_headers
+        @env.select { |key, _| key[0, 5] == 'HTTP_' }
+      end
+
+      def root_path
+        defined?(::Rails) ? ::Rails.root.to_s : ENV['RAILS_ROOT']
+      end
+    end
+  end
+end
+

data/lib/squash/rails.rb

@@ -25,6 +25,19 @@ end
 module Squash::Ruby
   CONFIGURATION_DEFAULTS[:deploy_path] = "/api/1.0/deploy"
 
+  # @private
+  def self.failsafe_log(tag, message)
+    logger = Rails.respond_to?(:logger) ? Rails.logger : RAILS_DEFAULT_LOGGER
+    if (logger.respond_to?(:tagged))
+      logger.tagged(tag) { logger.error message }
+    else
+      logger.error "[#{tag}]\t#{message}"
+    end
+  rescue Object => err
+    $stderr.puts "Couldn't write to failsafe log (#{err.to_s}); writing to stderr instead."
+    $stderr.puts "#{Time.now.to_s}\t[#{tag}]\t#{message}"
+  end
+
   private
 
   def self.client_name() 'rails' end

data/lib/squash/ruby/railtie.rb

@@ -17,11 +17,24 @@
 # versions, see `rails/init.rb`.
 
 class Squash::Ruby::Railtie < Rails::Railtie
-  initializer "squash_client.configure_rails_initialization" do
+  initializer "squash_client.configure_rails_initialization" do |app|
     Squash::Ruby.configure :environment     => Rails.env.to_s,
                            :project_root    => Rails.root.to_s,
                            :repository_root => Rails.root.to_s,
                            :failsafe_log    => Rails.root.join('log', 'squash.failsafe.log').to_s
+
+    # Load the Rack middleware into the stack at the top.
+    if app.respond_to?(:config) && app.config.respond_to?(:middleware)
+      require 'squash/rails/rack'
+
+      if defined?(ActionDispatch::DebugExceptions)
+        app.config.middleware.insert_after ActionDispatch::DebugExceptions, Squash::Rails::Rack
+      elsif defined?(ActionDispatch::ShowExceptions)
+        app.config.middleware.insert_after ActionDispatch::ShowExceptions, Squash::Rails::Rack
+      else
+        app.config.middleware.insert 0, Squash::Rails::Rack
+      end
+    end
   end
 
   rake_tasks { load 'squash/rails/tasks.rake' }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: squash_rails
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Tim Morgan
@@ -15,10 +15,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-07 00:00:00 Z
+date: 2013-02-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -28,11 +27,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  name: squash_ruby
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  name: squash_ruby
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -42,11 +41,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  name: rails
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  name: rails
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -56,11 +55,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  name: rspec
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -70,11 +69,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  name: yard
   version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  name: yard
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -84,11 +83,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  name: redcarpet
   version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  name: redcarpet
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -98,9 +97,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  name: jeweler
   version_requirements: *id006
+  name: jeweler
+  prerelease: false
+  type: :development
 description: This client library records Ruby on Rails exceptions to Squash.
 email: tim@squareup.com
 executables: []
@@ -116,6 +116,7 @@ files:
 - lib/squash/rails.rb
 - lib/squash/rails/capistrano.rb
 - lib/squash/rails/configure.rb
+- lib/squash/rails/rack.rb
 - lib/squash/rails/tasks.rake
 - lib/squash/ruby/controller_methods.rb
 - lib/squash/ruby/railtie.rb