bugsnag 1.1.5 → 1.2.0.beta

data/lib/bugsnag/rack.rb

@@ -1,70 +1,55 @@
+require "bugsnag/middleware/rack_request"
+require "bugsnag/middleware/warden_user"
+require "bugsnag/middleware/callbacks"
+
 module Bugsnag
   class Rack
     def initialize(app)
       @app = app
 
-      # Automatically set the release_stage
-      Bugsnag.configuration.release_stage = ENV['RACK_ENV'] if ENV['RACK_ENV']
-
-      # Automatically set the project_root if possible
-      if Bugsnag.configuration.project_root.nil? || Bugsnag.configuration.project_root.empty?
-        if defined?(settings)
-          Bugsnag.configuration.project_root = settings.root
-        else
-          caller.each do |c|
-            if c =~ /[\/\\]config.ru$/
-              Bugsnag.configuration.project_root = File.dirname(c.split(":").first)
-              break
-            end
+      # Configure bugsnag rack defaults
+      Bugsnag.configure do |config|
+        # Try to set the release_stage automatically if it hasn't already been set
+        config.release_stage ||= ENV["RACK_ENV"] if ENV["RACK_ENV"]
+
+        # Try to set the project_root if it hasn't already been set, or show a warning if we can't
+        unless config.project_root && !config.project_root.empty?
+          if defined?(settings)
+            config.project_root = settings.root
+          else
+            Bugsnag.warn("You should set your app's project_root (see https://bugsnag.com/docs/notifiers/ruby#project_root).")
           end
         end
+
+        # Hook up rack-based notification middlewares
+        config.middleware.use Bugsnag::Middleware::RackRequest
+        config.middleware.use Bugsnag::Middleware::WardenUser if defined?(Warden)
       end
     end
 
     def call(env)
+      # Set the request data for bugsnag middleware to use
+      Bugsnag.set_request_data(:rack_env, env)
+
       begin
         response = @app.call(env)
       rescue Exception => raised
-        Bugsnag.auto_notify(raised, self.class.bugsnag_request_data(env))
+        # Notify bugsnag of rack exceptions
+        Bugsnag.auto_notify(raised)
+
+        # Re-raise the exception
         raise
       end
 
-      if env['rack.exception']
-        Bugsnag.auto_notify(env['rack.exception'], self.class.bugsnag_request_data(env))
+      # Notify bugsnag of rack exceptions
+      if env["rack.exception"]
+        Bugsnag.auto_notify(env["rack.exception"])
       end
-
+        
       response
-    end
-
-    class << self
-      def bugsnag_request_data(env)
-        request = ::Rack::Request.new(env)
-
-        session = env["rack.session"]
-        params = env["action_dispatch.request.parameters"] || request.params
-        user_id = session[:session_id] || session["session_id"] rescue nil
-
-        {
-          :user_id => user_id,
-          :context => Bugsnag::Helpers.param_context(params) || Bugsnag::Helpers.request_context(request),
-          :meta_data => {
-            :request => {
-              :url => request.url,
-              :controller => params[:controller],
-              :action => params[:action],
-              :params => bugsnag_filter_if_filtering(env, Bugsnag::Helpers.cleanup_hash(params.to_hash)),
-            },
-            :session => bugsnag_filter_if_filtering(env, Bugsnag::Helpers.cleanup_hash(session)),
-            :environment => bugsnag_filter_if_filtering(env, Bugsnag::Helpers.cleanup_hash(env))
-          }
-        }
-      end
-
-      private
-      def bugsnag_filter_if_filtering(env, hash)
-        @params_filters ||= env["action_dispatch.parameter_filter"]
-        Bugsnag::Helpers.apply_filters(hash, @params_filters)
-      end
+    ensure
+      # Clear per-request data after processing the each request
+      Bugsnag.clear_request_data
     end
   end
-end
+end

data/lib/bugsnag/rails.rb

@@ -1,8 +1,11 @@
-# Rails 2.x support
+# Rails 2.x hooks
+# For Rails 3+ hooks, see railtie.rb
 
 require "bugsnag"
 require "bugsnag/rails/controller_methods"
 require "bugsnag/rails/action_controller_rescue"
+require "bugsnag/middleware/rails2_request"
+require "bugsnag/middleware/callbacks"
 
 module Bugsnag
   module Rails
@@ -21,11 +24,17 @@ module Bugsnag
       end
 
       Bugsnag.configure do |config|
-        config.logger = rails_logger
+        config.logger ||= rails_logger
         config.release_stage = RAILS_ENV  if defined?(RAILS_ENV)
         config.project_root = RAILS_ROOT if defined?(RAILS_ROOT)
-        config.framework = "Rails: #{::Rails::VERSION::STRING}" if defined?(::Rails::VERSION)
+
+        config.middleware.use Bugsnag::Middleware::Rails2Request
       end
+
+      # Auto-load configuration settings from config/bugsnag.yml if it exists
+      config_file = File.join(RAILS_ROOT, "config", "bugsnag.yml")
+      config = YAML.load_file(config_file) if File.exists?(config_file)
+      Bugsnag.configure(config[RAILS_ENV] ? config[RAILS_ENV] : config) if config
     end
   end
 end

data/lib/bugsnag/rails/action_controller_rescue.rb

@@ -1,26 +1,38 @@
-module Bugsnag
-  module Rails
-    module ActionControllerRescue
-      def self.included(base)
-        base.send(:alias_method, :rescue_action_in_public_without_bugsnag, :rescue_action_in_public)
-        base.send(:alias_method, :rescue_action_in_public, :rescue_action_in_public_with_bugsnag)
+# Rails 2.x only
+module Bugsnag::Rails
+  module ActionControllerRescue
+    def self.included(base)
+      # Hook into rails exception rescue stack
+      base.send(:alias_method, :rescue_action_in_public_without_bugsnag, :rescue_action_in_public)
+      base.send(:alias_method, :rescue_action_in_public, :rescue_action_in_public_with_bugsnag)
 
-        base.send(:alias_method, :rescue_action_locally_without_bugsnag, :rescue_action_locally)
-        base.send(:alias_method, :rescue_action_locally, :rescue_action_locally_with_bugsnag)
-      end
+      base.send(:alias_method, :rescue_action_locally_without_bugsnag, :rescue_action_locally)
+      base.send(:alias_method, :rescue_action_locally, :rescue_action_locally_with_bugsnag)
 
-      private
-      def rescue_action_in_public_with_bugsnag(exception)
-        # bugsnag_request_data is defined in controller_methods.rb
-        Bugsnag.auto_notify(exception, bugsnag_request_data)
-        rescue_action_in_public_without_bugsnag(exception)
-      end
-      
-      def rescue_action_locally_with_bugsnag(exception)
-        # bugsnag_request_data is defined in controller_methods.rb
-        Bugsnag.auto_notify(exception, bugsnag_request_data)
-        rescue_action_locally_without_bugsnag(exception)
-      end
+      # Run filters on requests to capture request data
+      base.send(:before_filter, :set_bugsnag_request_data)
+      base.send(:after_filter, :clear_bugsnag_request_data)
+    end
+
+    private
+    def set_bugsnag_request_data
+      Bugsnag.set_request_data(:rails2_request, request)
+    end
+    
+    def clear_bugsnag_request_data
+      Bugsnag.clear_request_data
+    end
+
+    def rescue_action_in_public_with_bugsnag(exception)
+      Bugsnag.auto_notify(exception)
+
+      rescue_action_in_public_without_bugsnag(exception)
+    end
+
+    def rescue_action_locally_with_bugsnag(exception)
+      Bugsnag.auto_notify(exception)
+
+      rescue_action_locally_without_bugsnag(exception)
     end
   end
 end

data/lib/bugsnag/rails/controller_methods.rb

@@ -1,64 +1,48 @@
-module Bugsnag
-  module Rails
-    module ControllerMethods
-      private
-      def notify_bugsnag(exception, custom_data=nil)
-        request_data = bugsnag_request_data
-        request_data[:meta_data][:custom] = custom_data if custom_data
-        Bugsnag.notify(exception, request_data)
+module Bugsnag::Rails
+  module ControllerMethods
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      private      
+      def before_bugsnag_notify(*methods, &block)
+        _add_bugsnag_notify_callback(:rails_before_callbacks, *methods, &block)
       end
 
-      def bugsnag_request_data
-        {
-          :user_id => bugsnag_session_id,
-          :context => Bugsnag::Helpers.param_context(params),
-          :meta_data => {
-            :request => {
-              :url => bugsnag_request_url,
-              :controller => params[:controller],
-              :action => params[:action],
-              :params => bugsnag_filter_if_filtering(Bugsnag::Helpers.cleanup_hash(params.to_hash)),
-            },
-            :session => bugsnag_filter_if_filtering(Bugsnag::Helpers.cleanup_hash(bugsnag_session_data)),
-            :environment => bugsnag_filter_if_filtering(Bugsnag::Helpers.cleanup_hash(request.env))
-          }
-        }
+      def after_bugsnag_notify(*methods, &block)
+        _add_bugsnag_notify_callback(:rails_after_callbacks, *methods, &block)
       end
 
-      def bugsnag_session_id
-        session = bugsnag_session_data
-        session[:session_id] || session["session_id"]
-      end
-      
-      def bugsnag_request_url
-        url = "#{request.protocol}#{request.host}"
+      def _add_bugsnag_notify_callback(callback_key, *methods, &block)
+        options = methods.last.is_a?(Hash) ? methods.pop : {}
 
-        unless [80, 443].include?(request.port)
-          url << ":#{request.port}"
-        end
+        before_filter(options) do |controller|
+          request_data = Bugsnag.configuration.request_data
+          request_data[callback_key] ||= []
 
-        url << request.fullpath
-        url
-      end
+          # Set up "method symbol" callbacks
+          methods.each do |method_symbol|
+            request_data[callback_key] << lambda { |notification|
+              self.send(method_symbol, notification)
+            }
+          end
 
-      def bugsnag_session_data
-        if session.respond_to?(:to_hash)
-          session.to_hash
-        else
-          session.data
+          # Set up "block" callbacks
+          request_data[callback_key] << lambda { |notification|
+            controller.instance_exec(notification, &block)
+          } if block_given?
         end
       end
-    
-      def bugsnag_filter_if_filtering(hash)
-        return hash if ! hash.is_a?(Hash)
+    end
 
-        if respond_to?(:filter_parameters)
-          filter_parameters(hash) rescue hash
-        else
-          hash
-        end
-      end
+    private
+    def notify_bugsnag(exception, custom_data=nil)
+      Bugsnag.warn "DEPRECATED METHOD: notify_bugsnag is deprecated and will be removed in the future. Please use Bugsnag.notify instead" if Bugsnag.configuration.release_stage != "production"
 
+      overrides = {}
+      overrides[:custom] = custom_data if custom_data
+      Bugsnag.notify(exception, overrides)
     end
   end
 end

data/lib/bugsnag/railtie.rb

@@ -1,12 +1,33 @@
-# Rails 3.x support
+# Rails 3.x hooks
 
-require "bugsnag"
 require "rails"
+require "bugsnag"
+require "bugsnag/middleware/rails3_request"
 
 module Bugsnag
   class Railtie < Rails::Railtie
     rake_tasks do
-      load "tasks/bugsnag.rake"
+      load "bugsnag/tasks/bugsnag.rake"
+    end
+
+    config.before_initialize do
+      # Configure bugsnag rails defaults
+      Bugsnag.configure do |config|
+        config.logger = Rails.logger
+        config.release_stage = Rails.env.to_s
+        config.project_root = Rails.root.to_s
+        config.params_filters += Rails.configuration.filter_parameters
+      end
+
+      # Auto-load configuration settings from config/bugsnag.yml if it exists
+      config_file = Rails.root.join("config", "bugsnag.yml")
+      config = YAML.load_file(config_file) if File.exists?(config_file)
+      Bugsnag.configure(config[Rails.env] ? config[Rails.env] : config) if config
+
+      if defined?(::ActionController::Base)
+        require "bugsnag/rails/controller_methods"
+        ::ActionController::Base.send(:include, Bugsnag::Rails::ControllerMethods)
+      end
     end
 
     initializer "bugsnag.use_rack_middleware" do |app|
@@ -19,17 +40,8 @@ module Bugsnag
 
     config.after_initialize do
       Bugsnag.configure do |config|
-        config.release_stage = ::Rails.env
-        config.project_root = ::Rails.root
-        config.framework = "Rails: #{::Rails::VERSION::STRING}"
-
-        config.logger ||= ::Rails.logger
-      end
-
-      if defined?(::ActionController::Base)
-        require "bugsnag/rails/controller_methods"
-        ::ActionController::Base.send(:include, Bugsnag::Rails::ControllerMethods)
+        config.middleware.use Bugsnag::Middleware::Rails3Request
       end
     end
   end
-end
+end

data/lib/bugsnag/tasks.rb

@@ -1,3 +1,3 @@
-Dir["#{File.dirname(__FILE__)}/../tasks/*.rake"].each do |task|
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].each do |task|
   load task
 end

data/lib/{tasks → bugsnag/tasks}/bugsnag.rake

@@ -42,6 +42,11 @@ namespace :bugsnag do
       Bugsnag.notify(e, {:context => "rake#test_exception"})
     end
   end
+
+  desc "Show the bugsnag middleware stack"
+  task :middleware => :load do
+    Bugsnag.configuration.middleware.each {|m| puts m.to_s}
+  end
 end
 
 task :load do

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: bugsnag
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: 
+  hash: -639319559
+  prerelease: 6
   segments: 
   - 1
-  - 1
-  - 5
-  version: 1.1.5
+  - 2
+  - 0
+  - beta
+  version: 1.2.0.beta
 platform: ruby
 authors: 
 - James Smith
@@ -15,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-21 00:00:00 Z
+date: 2012-09-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -36,14 +37,20 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - <
       - !ruby/object:Gem::Version 
-        hash: 57
+        hash: 15
         segments: 
+        - 1
         - 0
-        - 8
-        - 3
-        version: 0.8.3
+        version: "1.0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 5
+        version: "0.5"
   version_requirements: *id002
   name: httparty
   prerelease: false
@@ -113,8 +120,13 @@ files:
 - lib/bugsnag.rb
 - lib/bugsnag/capistrano.rb
 - lib/bugsnag/configuration.rb
-- lib/bugsnag/delay/resque.rb
 - lib/bugsnag/helpers.rb
+- lib/bugsnag/middleware/callbacks.rb
+- lib/bugsnag/middleware/rack_request.rb
+- lib/bugsnag/middleware/rails2_request.rb
+- lib/bugsnag/middleware/rails3_request.rb
+- lib/bugsnag/middleware/warden_user.rb
+- lib/bugsnag/middleware_stack.rb
 - lib/bugsnag/notification.rb
 - lib/bugsnag/rack.rb
 - lib/bugsnag/rails.rb
@@ -122,9 +134,9 @@ files:
 - lib/bugsnag/rails/controller_methods.rb
 - lib/bugsnag/railtie.rb
 - lib/bugsnag/tasks.rb
+- lib/bugsnag/tasks/bugsnag.rake
 - lib/bugsnag/version.rb
 - lib/resque/failure/bugsnag.rb
-- lib/tasks/bugsnag.rake
 - rails/init.rb
 - test/helper.rb
 - test/test_bugsnag.rb
@@ -148,12 +160,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: