bugsnag 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b35ad98c2895eeed859811b80eca504689062318
-  data.tar.gz: 7101aa6328e378bbd6adca3287e2a0a804861990
+  metadata.gz: 0521fc3cace95079dc4d038dc75c02481ba7847b
+  data.tar.gz: 1d34bcc368eb9e4fc6b04a15ccd31e6ec3db2380
 SHA512:
-  metadata.gz: e950f27e53ee24ebbf7e08c5983a957fc1cb3b84f510b9031dcd2aac1ca403c0d8c20a330620096cef5df7c93e89da17e34810fe3c6aee846fc67fe2203c250e
-  data.tar.gz: a79292d91d5f4743c7a1d1cea919b9500d8ad83575be19a8e706c6c16b59db7e44140508530d00ce1876552544f8e1577294bc4848b4fb6980f77e45dd957934
+  metadata.gz: 5a2fbdbd810edc36b0ca20ac6e44dbd61c59cccd3ad96cb53e8b8da49ea38e6010e9969e4d34096f58e53892faf061a1b81af677fe937fa7fa3609af566c06f1
+  data.tar.gz: e48a77338ef9d1ec47e277aa40e8ac84dadbecdb688938531b9f508dba39b242ebce72a0999a387bd08e0a82201acc08148a99b63db1fdf83ce5a37ec7ef5f81

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+2.4.0
+-----
+-   Allow filters to be regular expressions (thanks @tamird)
+-   Ensure filtering behavior matches rails' when importing filters from
+    `Rails.configuration.filter_parameters`
+
 2.3.0
 -----
 -   Use ssl by default (Thanks @dkubb)

data/README.md

@@ -347,16 +347,19 @@ config.app_version = "2.5.1"
 
 ###params_filters
 
-Sets the strings to filter out from the `params` hashes before sending
-them to Bugsnag. Use this if you want to ensure you don't send
-sensitive data such as passwords, and credit card numbers to our
-servers. Any keys which *contain* these strings will be filtered.
+Sets which keys should be filtered out from `params` hashes before sending
+them to Bugsnag. Use this if you want to ensure you don't send sensitive data
+such as passwords, and credit card numbers to our servers. You can add both
+strings and regular expressions to this array. When adding strings, keys which
+*contain* the string will be filtered. When adding regular expressions, any
+keys which *match* the regular expression will be filtered.
 
 ```ruby
-config.params_filters << "credit_card_number"
+config.params_filters += ["credit_card_number", /^password$/]
 ```
 
-By default, `params_filters` is set to `["password", "secret"]`
+By default, `params_filters` is set to `["password", "secret"]`, and for rails
+apps, imports all values from `Rails.configuration.filter_parameters`.
 
 ###ignore_classes
 

data/VERSION

@@ -1 +1 @@
-2.3.0
+2.4.0

data/lib/bugsnag/helpers.rb

@@ -27,7 +27,7 @@ module Bugsnag
       when Hash
         clean_hash = {}
         obj.each do |k,v|
-          if filters && filters.any? {|f| k.to_s.include?(f.to_s)}
+          if filters_match?(k, filters)
             clean_hash[k] = "[FILTERED]"
           else
             clean_obj = cleanup_obj(v, filters, seen)
@@ -62,6 +62,19 @@ module Bugsnag
       end
     end
 
+    def self.filters_match?(object, filters)
+      str = object.to_s
+
+      Array(filters).any? do |f|
+        case f
+        when Regexp
+          str.match(f)
+        else
+          str.include?(f.to_s)
+        end
+      end
+    end
+
     def self.cleanup_url(url, filters = nil)
       return url unless filters
 

data/lib/bugsnag/railtie.rb

@@ -18,7 +18,14 @@ module Bugsnag
         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
+        config.params_filters += Rails.configuration.filter_parameters.map do |filter|
+          case filter
+          when String
+            /\A#{filter}\z/
+          else
+            filter
+          end
+        end
         config.middleware.insert_before Bugsnag::Middleware::Callbacks, Bugsnag::Middleware::Rails3Request
       end
 

data/spec/helper_spec.rb

@@ -44,6 +44,16 @@ describe Bugsnag::Helpers do
     end
   end
 
+  it "filters by string inclusion" do
+    expect(Bugsnag::Helpers.cleanup_obj({ :foo => 'bar' }, ['f'])).to eq({ :foo => '[FILTERED]' })
+    expect(Bugsnag::Helpers.cleanup_obj({ :foo => 'bar' }, ['b'])).to eq({ :foo => 'bar' })
+  end
+
+  it "filters by regular expression" do
+    expect(Bugsnag::Helpers.cleanup_obj({ :foo => 'bar' }, [/fb?/])).to eq({ :foo => '[FILTERED]' })
+    expect(Bugsnag::Helpers.cleanup_obj({ :foo => 'bar' }, [/fb+/])).to eq({ :foo => 'bar' })
+  end
+
   it "reduces hash size correctly" do
     meta_data = {
       :key_one => "this should not be truncated",

metadata

@@ -1,103 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2014-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby notifier for bugsnag.com
@@ -108,10 +108,10 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- ".document"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .document
+- .gitignore
+- .rspec
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -168,17 +168,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Ruby notifier for bugsnag.com