bugsnag 6.6.4 → 6.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4833943785d255e81284063ae7e3c6f9a751613
-  data.tar.gz: 56e345f1855da00e3a8ea239d721810dece1bc38
+  metadata.gz: 60129feaa76e872e91284f6c222eeeaa6728fb23
+  data.tar.gz: ab2269d57bd7c131967acf0a37b7508fd1095d7a
 SHA512:
-  metadata.gz: b2bdb0d75b43d858e57679eb456131e699785ea3af5c1173ba20948b341812a20811a251c1923038fcb66f716abc564b3c2fc39af37798e302b37b2ecf21f492
-  data.tar.gz: bd75ebbabe899516b47e1d8126fe12491ef998076b4479f7adc6fdfb4d1b3ee40197588c0e3c6cf951ebb0fc2d588c68278f1b389892aace502b15894cc36246
+  metadata.gz: 123b069a26b2e6d3b611eb65a43b36c79878ad49075e63e7b0d600fcdcaecd9396bf7c9a42e66cbeb236d4d06a44290bdc7125b8eff0dab54ae4531209882b07
+  data.tar.gz: 2afa07a981784dff59491cb8a156f977905f06e462dcaacb352b3f09241d6ae90afadf6b3bd0bbecd4ce1a321e88bda4af35a8e03f9a2dbfce3009ac886bc976

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 Changelog
 =========
 
+## 6.7.0 (05 Apr 2018)
+
+### Enhancements
+
+* Support HTTP proxy from `http_proxy` and `https_proxy` environment variables
+  | [#424](https://github.com/bugsnag/bugsnag-ruby/pull/424)
+  | [#437](https://github.com/bugsnag/bugsnag-ruby/pull/437)
+  | [Bill Kirtley](https://github.com/cluesque)
+
+* Add option to disable auto-configuration
+  | [#419](https://github.com/bugsnag/bugsnag-ruby/pull/419)
+
+* Add `warden.user.rack` data to default filters
+  | [#436](https://github.com/bugsnag/bugsnag-ruby/pull/436)
+
+### Fixes
+
+* Ensure logged messages include Bugsnag progname
+  | [#443](https://github.com/bugsnag/bugsnag-ruby/pull/443)
+
 ## 6.6.4 (14 Feb 2018)
 
 ### Fixes

data/README.md

@@ -2,7 +2,7 @@
 [![build status](https://travis-ci.org/bugsnag/bugsnag-ruby.svg?branch=master)](https://travis-ci.org/bugsnag/bugsnag-ruby)
 
 
-The Bugsnag exception reporter for Ruby gives you instant notification of exceptions thrown from your **[Rails](https://bugsnag.com/platforms/rails)**, **Sinatra**, **Rack** or **plain Ruby** app. Any uncaught exceptions will trigger a notification to be sent to your Bugsnag project.
+The Bugsnag exception reporter for Ruby gives you instant notification of exceptions thrown from your **[Rails](https://www.bugsnag.com/platforms/rails)**, **Sinatra**, **Rack** or **plain Ruby** app. Any uncaught exceptions will trigger a notification to be sent to your Bugsnag project.
 
 ## Features
 
@@ -13,26 +13,26 @@ The Bugsnag exception reporter for Ruby gives you instant notification of except
 
 ## Getting started
 
-1. [Create a Bugsnag account](https://bugsnag.com)
+1. [Create a Bugsnag account](https://www.bugsnag.com)
 2. Complete the instructions in the integration guide for your framework:
-    * [Que](http://docs.bugsnag.com/platforms/ruby/que)
-    * [Rack](http://docs.bugsnag.com/platforms/ruby/rack)
-    * [Rails](http://docs.bugsnag.com/platforms/ruby/rails)
-    * [Rake](http://docs.bugsnag.com/platforms/ruby/rake)
-    * [Sidekiq](http://docs.bugsnag.com/platforms/ruby/sidekiq)
-    * [Other Ruby apps](http://docs.bugsnag.com/platforms/ruby/other)
-    * For [EventMachine](http://rubyeventmachine.com) integration, see [`bugsnag-em`](https://github.com/bugsnag/bugsnag-em)
+    * [Que](https://docs.bugsnag.com/platforms/ruby/que)
+    * [Rack](https://docs.bugsnag.com/platforms/ruby/rack)
+    * [Rails](https://docs.bugsnag.com/platforms/ruby/rails)
+    * [Rake](https://docs.bugsnag.com/platforms/ruby/rake)
+    * [Sidekiq](https://docs.bugsnag.com/platforms/ruby/sidekiq)
+    * [Other Ruby apps](https://docs.bugsnag.com/platforms/ruby/other)
+    * For [EventMachine](https://rubyeventmachine.com) integration, see [`bugsnag-em`](https://github.com/bugsnag/bugsnag-em)
 3. Relax!
 
 ## Support
 
 * Read the configuration reference:
-    * [Que](http://docs.bugsnag.com/platforms/ruby/que/configuration-options)
-    * [Rack](http://docs.bugsnag.com/platforms/ruby/rack/configuration-options)
-    * [Rails](http://docs.bugsnag.com/platforms/ruby/rails/configuration-options)
-    * [Rake](http://docs.bugsnag.com/platforms/ruby/rake/configuration-options)
-    * [Sidekiq](http://docs.bugsnag.com/platforms/ruby/sidekiq/configuration-options)
-    * [Other Ruby apps](http://docs.bugsnag.com/platforms/ruby/other/configuration-options)
+    * [Que](https://docs.bugsnag.com/platforms/ruby/que/configuration-options)
+    * [Rack](https://docs.bugsnag.com/platforms/ruby/rack/configuration-options)
+    * [Rails](https://docs.bugsnag.com/platforms/ruby/rails/configuration-options)
+    * [Rake](https://docs.bugsnag.com/platforms/ruby/rake/configuration-options)
+    * [Sidekiq](https://docs.bugsnag.com/platforms/ruby/sidekiq/configuration-options)
+    * [Other Ruby apps](https://docs.bugsnag.com/platforms/ruby/other/configuration-options)
 * Check out some [example apps integrated with Bugsnag](https://github.com/bugsnag/bugsnag-example-apps/tree/master/apps/ruby) using Rails, Sinatra, Padrino, and more.
 * [Search open and closed issues](https://github.com/bugsnag/bugsnag-ruby/issues?utf8=✓&q=is%3Aissue) for similar problems
 * [Report a bug or request a feature](https://github.com/bugsnag/bugsnag-ruby/issues/new)

data/UPGRADING.md

@@ -39,7 +39,7 @@ guide](https://docs.bugsnag.com/api/deploy-tracking/capistrano/) for more inform
   + end
   ```
 
-* `Bugsnag.notify_or_ignore` and `Bugsnag.auto_notify` have been removed removed. Call `notify` directly instead.
+* `Bugsnag.notify_or_ignore` and `Bugsnag.auto_notify` have been removed. Call `notify` directly instead.
 * `after_notify_callbacks` has been removed
 * `Bugsnag::Notification` has been renamed to `Bugsnag::Report`
 

data/VERSION

@@ -1 +1 @@
-6.6.4
+6.7.0

data/lib/bugsnag.rb

@@ -13,6 +13,8 @@ require "bugsnag/delivery"
 require "bugsnag/delivery/synchronous"
 require "bugsnag/delivery/thread_queue"
 
+# Rack is not bundled with the other integrations
+# as it doesn't auto-configure when loaded
 require "bugsnag/integrations/rack"
 
 require "bugsnag/middleware/rack_request"
@@ -28,6 +30,7 @@ require "bugsnag/middleware/classify_error"
 
 module Bugsnag
   LOCK = Mutex.new
+  INTEGRATIONS = [:resque, :sidekiq, :mailman, :delayed_job, :shoryuken, :que]
 
   class << self
     ##
@@ -155,13 +158,28 @@ module Bugsnag
     def before_notify_callbacks
       Bugsnag.configuration.request_data[:before_callbacks] ||= []
     end
-  end
-end
 
-require "bugsnag/integrations/railtie" if defined?(Rails::Railtie)
-[:resque, :sidekiq, :mailman, :delayed_job, :shoryuken, :que].each do |integration|
-  begin
-    require "bugsnag/integrations/#{integration}"
-  rescue LoadError
+    # Attempts to load all integrations through auto-discovery
+    def load_integrations
+      require "bugsnag/integrations/railtie" if defined?(Rails::Railtie)
+      INTEGRATIONS.each do |integration|
+        begin
+          require "bugsnag/integrations/#{integration}"
+        rescue LoadError
+        end
+      end
+    end
+
+    # Load a specific integration
+    def load_integration(integration)
+      integration = :railtie if integration == :rails
+      if INTEGRATIONS.include?(integration) || integration == :railtie
+        require "bugsnag/integrations/#{integration}"
+      else
+        configuration.debug("Integration #{integration} is not currently supported")
+      end
+    end
   end
 end
+
+Bugsnag.load_integrations unless ENV["BUGSNAG_DISABLE_AUTOCONFIGURE"]

data/lib/bugsnag/configuration.rb

@@ -47,6 +47,7 @@ module Bugsnag
       /cookie/i,
       /password/i,
       /secret/i,
+      /warden\.user\.([^.]+)\.key/,
       "rack.request.form_vars"
     ].freeze
 
@@ -75,14 +76,16 @@ module Bugsnag
       # Read the API key from the environment
       self.api_key = ENV["BUGSNAG_API_KEY"]
 
-      # Read NET::HTTP proxy environment variable
-      self.proxy_host = ENV["http_proxy"]
+      # Read NET::HTTP proxy environment variables
+      if (proxy_uri = ENV["https_proxy"] || ENV['http_proxy'])
+        parse_proxy(proxy_uri)
+      end
 
       # Set up logging
       self.logger = Logger.new(STDOUT)
       self.logger.level = Logger::INFO
       self.logger.formatter = proc do |severity, datetime, progname, msg|
-        "** [Bugsnag] #{datetime}: #{msg}\n"
+        "** #{progname} #{datetime}: #{msg}\n"
       end
 
       # Configure the bugsnag middleware stack
@@ -162,23 +165,35 @@ module Bugsnag
     ##
     # Logs an info level message
     def info(message)
-      logger.info(message)
+      logger.info(PROG_NAME) { message }
     end
 
     ##
     # Logs a warning level message
     def warn(message)
-      logger.warn(message)
+      logger.warn(PROG_NAME) { message }
     end
 
     ##
     # Logs a debug level message
     def debug(message)
-      logger.debug(message)
+      logger.debug(PROG_NAME) { message }
+    end
+
+    ##
+    # Parses and sets proxy from a uri
+    def parse_proxy(uri)
+      proxy = URI.parse(uri)
+      self.proxy_host = proxy.host
+      self.proxy_port = proxy.port
+      self.proxy_user = proxy.user
+      self.proxy_password = proxy.password
     end
 
     private
 
+    PROG_NAME = "[Bugsnag]"
+
     def default_hostname
       # Send the heroku dyno name instead of hostname if available
       ENV["DYNO"] || Socket.gethostname;

data/spec/bugsnag_spec.rb

@@ -16,4 +16,71 @@ describe Bugsnag do
       expect(Bugsnag.configuration.logger).to have_received(:warn)
     end
   end
+
+  describe 'loading integrations' do
+    before do
+      module Kernel
+        REQUIRED = []
+        alias_method :old_require, :require
+        def require(path)
+          if path.include?("bugsnag/integrations/")
+            REQUIRED << path
+          else
+            old_require(path)
+          end
+        end
+      end
+    end
+
+    it 'attempts to load integrations' do
+      Kernel::REQUIRED = []
+      ENV["BUGSNAG_DISABLE_AUTOCONFIGURE"] = nil
+      load "./lib/bugsnag.rb"
+      Bugsnag::INTEGRATIONS.each do |integration|
+        expect(Kernel::REQUIRED).to include("bugsnag/integrations/#{integration}")
+      end
+    end
+
+    it 'does not load integrations when BUGSNAG_DISABLE_AUTOCONFIGURE is true' do
+      Kernel::REQUIRED = []
+      ENV["BUGSNAG_DISABLE_AUTOCONFIGURE"] = 'true'
+      load "./lib/bugsnag.rb"
+      expect(Kernel::REQUIRED).to eq(["bugsnag/integrations/rack"])
+    end
+
+    it 'loads all integrations if requested' do
+      Kernel::REQUIRED = []
+      expect(Kernel::REQUIRED).to eq([])
+      Bugsnag.load_integrations
+      Bugsnag::INTEGRATIONS.each do |integration|
+        expect(Kernel::REQUIRED).to include("bugsnag/integrations/#{integration}")
+      end
+    end
+
+    it 'loads singular integrations' do
+      Kernel::REQUIRED = []
+      expect(Kernel::REQUIRED).to eq([])
+      Bugsnag::INTEGRATIONS.each do |integration|
+        Kernel::REQUIRED = []
+        Bugsnag.load_integration(integration)
+        expect(Kernel::REQUIRED).to include("bugsnag/integrations/#{integration}")
+      end
+    end
+
+    it 'loads railtie for :rails or :railtie' do
+      Kernel::REQUIRED = []
+      Bugsnag.load_integration(:rails)
+      expect(Kernel::REQUIRED).to include("bugsnag/integrations/railtie")
+      Kernel::REQUIRED = []
+      Bugsnag.load_integration(:railtie)
+      expect(Kernel::REQUIRED).to include("bugsnag/integrations/railtie")
+    end
+
+    after do
+      module Kernel
+        alias_method :require, :old_require
+      end
+      Kernel.send(:remove_const, :REQUIRED)
+    end
+  end
 end

data/spec/configuration_spec.rb

@@ -29,6 +29,135 @@ describe Bugsnag::Configuration do
     end
   end
 
+  describe "set_proxy" do
+    it "defaults proxy settings to nil" do
+      expect(subject.proxy_host).to be nil
+      expect(subject.proxy_port).to be nil
+      expect(subject.proxy_user).to be nil
+      expect(subject.proxy_password).to be nil
+    end
+
+    it "allows proxy settings to be set directly" do
+      subject.proxy_host = "http://localhost"
+      subject.proxy_port = 34000
+      subject.proxy_user = "user"
+      subject.proxy_password = "password"
+      expect(subject.proxy_host).to eq("http://localhost")
+      expect(subject.proxy_port).to eq(34000)
+      expect(subject.proxy_user).to eq("user")
+      expect(subject.proxy_password).to eq("password")
+    end
+
+    it "parses a uri if provided" do
+      subject.parse_proxy("http://user:password@localhost:34000")
+      expect(subject.proxy_host).to eq("localhost")
+      expect(subject.proxy_port).to eq(34000)
+      expect(subject.proxy_user).to eq("user")
+      expect(subject.proxy_password).to eq("password")
+    end
+
+    it "automatically parses http_proxy environment variable" do
+      ENV['http_proxy'] = "http://user:password@localhost:34000"
+      expect(subject.proxy_host).to eq("localhost")
+      expect(subject.proxy_port).to eq(34000)
+      expect(subject.proxy_user).to eq("user")
+      expect(subject.proxy_password).to eq("password")
+    end
+
+    it "automatically parses https_proxy environment variable" do
+      ENV['https_proxy'] = "https://user:password@localhost:34000"
+      expect(subject.proxy_host).to eq("localhost")
+      expect(subject.proxy_port).to eq(34000)
+      expect(subject.proxy_user).to eq("user")
+      expect(subject.proxy_password).to eq("password")
+    end
+
+    after do
+      ENV['http_proxy'] = nil
+      ENV['https_proxy'] = nil
+    end
+  end
+
+  describe "logger" do
+    class TestLogger
+      attr_accessor :logs
+
+      def initialize
+        @logs = []
+      end
+
+      def log(level, name, &block)
+        message = block.call
+        @logs << {
+          :level => level,
+          :name => name,
+          :message => message
+        }
+      end
+
+      def info(name, &block)
+        log('info', name, &block)
+      end
+
+      def warn(name, &block)
+        log('warning', name, &block)
+      end
+
+      def debug(name, &block)
+        log('debug', name, &block)
+      end
+    end
+
+    before do
+      @logger = TestLogger.new
+      Bugsnag.configure do |bugsnag|
+        bugsnag.logger = @logger
+      end
+    end
+
+    it "should log info messages to the set logger" do
+      expect(@logger.logs.size).to eq(0)
+      Bugsnag.configuration.info("Info message")
+      expect(@logger.logs.size).to eq(1)
+      log = @logger.logs.first
+      expect(log).to eq({
+        :level => "info",
+        :name => "[Bugsnag]",
+        :message => "Info message"
+      })
+    end
+
+    it "should log warning messages to the set logger" do
+      expect(@logger.logs.size).to eq(0)
+      Bugsnag.configuration.warn("Warning message")
+      expect(@logger.logs.size).to eq(1)
+      log = @logger.logs.first
+      expect(log).to eq({
+        :level => "warning",
+        :name => "[Bugsnag]",
+        :message => "Warning message"
+      })
+    end
+
+    it "should log debug messages to the set logger" do
+      expect(@logger.logs.size).to eq(0)
+      Bugsnag.configuration.debug("Debug message")
+      expect(@logger.logs.size).to eq(1)
+      log = @logger.logs.first
+      expect(log).to eq({
+        :level => "debug",
+        :name => "[Bugsnag]",
+        :message => "Debug message"
+      })
+    end
+
+    after do
+      Bugsnag.configure do |bugsnag|
+        bugsnag.logger = Logger.new(StringIO.new)
+      end
+    end
+  end
+
   it "should have exit exception classes ignored by default" do
     expect(subject.ignore_classes).to eq(Set.new([SystemExit, Interrupt]))
   end

data/spec/report_spec.rb

@@ -574,7 +574,27 @@ describe Bugsnag::Report do
   it "filters params from all payload hashes if they are set in default meta_data_filters" do
 
     Bugsnag.notify(BugsnagTestException.new("It crashed")) do |report|
-      report.meta_data.merge!({:request => {:params => {:password => "1234", :other_password => "12345", :other_data => "123456"}}})
+      report.meta_data.merge!({
+        :request => {
+          :params => {
+            :password => "1234",
+            :other_password => "12345",
+            :other_data => "123456"
+          },
+          :cookie => "1234567890",
+          :authorization => "token",
+          :user_authorization => "token",
+          :secret_key => "key",
+          :user_secret => "key"
+        }
+      })
+      report.meta_data.merge!({
+        :session => {
+          :"warden.user.user.key" => "1234",
+          :"warden.user.foobar.key" => "1234",
+          :"warden.user.test" => "1234"
+        }
+      })
     end
 
     expect(Bugsnag).to have_sent_notification{ |payload, headers|
@@ -585,6 +605,15 @@ describe Bugsnag::Report do
       expect(event["metaData"]["request"]["params"]["password"]).to eq("[FILTERED]")
       expect(event["metaData"]["request"]["params"]["other_password"]).to eq("[FILTERED]")
       expect(event["metaData"]["request"]["params"]["other_data"]).to eq("123456")
+      expect(event["metaData"]["request"]["cookie"]).to eq("[FILTERED]")
+      expect(event["metaData"]["request"]["authorization"]).to eq("[FILTERED]")
+      expect(event["metaData"]["request"]["user_authorization"]).to eq("[FILTERED]")
+      expect(event["metaData"]["request"]["secret_key"]).to eq("[FILTERED]")
+      expect(event["metaData"]["request"]["user_secret"]).to eq("[FILTERED]")
+      expect(event["metaData"]["session"]).not_to be_nil
+      expect(event["metaData"]["session"]["warden.user.user.key"]).to eq("[FILTERED]")
+      expect(event["metaData"]["session"]["warden.user.foobar.key"]).to eq("[FILTERED]")
+      expect(event["metaData"]["session"]["warden.user.test"]).to eq("1234")
     }
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 6.6.4
+  version: 6.7.0
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby