rollbar 2.5.2 → 2.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94bfaab6020d2299a4f491bcaf08c1fb1e7ffaa7
+  data.tar.gz: 37873db26e50016607aa5b03a7298da79fe112a4
+SHA512:
+  metadata.gz: 6389ed78df71156fb8f44c22a9d2550d99e367988fede657a3ec58b83bd09781403e8f1d2571f657a7ec535bf1b2c1a12447fb9aace2f678c332d0e1d2fddeae
+  data.tar.gz: 601cdc2a21f5a2e4ba23a157ed378058e3440cf4e72fea2d1d1b85631cbfa9d67ae0ece44157a732256eee9846ccc7c22cf692bb79fa9e5abadf9b5f36c77a55

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 2.6.0
+
+Features
+
+- Sidekiq threshold for retried jobs. Allows you define a minimum number of retries to start reporting errors to Rollbar. See [#336](https://github.com/rollbar/rollbar-gem/pull/336).
+- User IP obfuscator. See [#331](https://github.com/rollbar/rollbar-gem/pull/331)  and [#338](https://github.com/rollbar/rollbar-gem/pull/338).
+
 ## 2.5.2
 
 Bug fixes:

data/README.md

@@ -1,4 +1,4 @@
-# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v2.5.2)](https://travis-ci.org/rollbar/rollbar-gem/branches)
+# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v2.6.0)](https://travis-ci.org/rollbar/rollbar-gem/branches)
 
 <!-- RemoveNext -->
 [Rollbar](https://rollbar.com) is an error tracking service for Ruby and other languages. The Rollbar service will alert you of problems with your code and help you understand them in a ways never possible before. We love it and we hope you will too.
@@ -12,7 +12,7 @@ This is the Ruby library for Rollbar. It will instrument many kinds of Ruby appl
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rollbar', '~> 2.5.2'
+gem 'rollbar', '~> 2.6.0'
 ```
 
 If you are not using JRuby we suggest using [Oj](https://github.com/ohler55/oj) for JSON serialization. In order to install Oj you can add this line to your Gemfile:
@@ -347,6 +347,12 @@ And ```Rollbar.configuration.scrub_headers```:
 Rollbar.configuration.scrub_headers |= ["X-Access-Token"]
 ```
 
+If you want to obfuscate the user IP reported to the Rollbar API you can configure a secret to do it and a different IP address from the original will be reported:
+
+```
+Rollbar.configuration.user_ip_obfuscator_secret = "a-private-secret-here"
+```
+
 ## Including additional runtime data
 
 You can provide a callable that will be called for each exception or message report.  ```custom_data_method``` should be a lambda that takes no arguments and returns a hash.
@@ -490,6 +496,12 @@ Start Sidekiq from the root directory of your Rails app and declare the name of
 $ bundle exec sidekiq -q rollbar
 ```
 
+For every errored job a new report will be sent to Rollbar API, also for errored retried jobs. You can configure the retries threshold to start reporting to rollbar:
+
+```ruby
+config.sidekiq_threshold = 3 # Start reporting from 3 retries jobs
+```
+
 ### Using Resque
 
 Add the following in ```config/initializers/rollbar.rb```:

data/gemfiles/rails32.gemfile

@@ -15,5 +15,3 @@ gem "rubinius-developer_tools", :platform => :rbx
 gem "rails", "3.2.22"
 
 gemspec :path => "../"
-
-gem 'debugger'

data/lib/rollbar/configuration.rb

@@ -35,9 +35,11 @@ module Rollbar
     attr_accessor :scrub_fields
     attr_accessor :scrub_user
     attr_accessor :scrub_password
+    attr_accessor :user_ip_obfuscator_secret
     attr_accessor :randomize_scrub_length
     attr_accessor :uncaught_exception_level
     attr_accessor :scrub_headers
+    attr_accessor :sidekiq_threshold
     attr_accessor :verify_ssl_peer
     attr_accessor :use_async
     attr_accessor :use_eventmachine
@@ -87,6 +89,7 @@ module Rollbar
       @randomize_scrub_length = true
       @uncaught_exception_level = 'error'
       @scrub_headers = ['Authorization']
+      @sidekiq_threshold = 0
       @safely = false
       @use_async = false
       @use_eventmachine = false

data/lib/rollbar/request_data_extractor.rb

@@ -2,6 +2,7 @@ require 'rack'
 require 'tempfile'
 
 require 'rollbar/scrubbers/url'
+require 'rollbar/util/ip_obfuscator'
 
 module Rollbar
   module RequestDataExtractor
@@ -116,7 +117,9 @@ module Rollbar
     end
 
     def rollbar_user_ip(env)
-      (env['action_dispatch.remote_ip'] || env['HTTP_X_REAL_IP'] || env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR']).to_s
+      user_ip_string = (env['action_dispatch.remote_ip'] || env['HTTP_X_REAL_IP'] || env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR']).to_s
+
+      Rollbar::Util::IPObfuscator.obfuscate_ip(user_ip_string)
     rescue
       nil
     end

data/lib/rollbar/sidekiq.rb

@@ -5,12 +5,18 @@ module Rollbar
     PARAM_BLACKLIST = %w[backtrace error_backtrace error_message error_class]
 
     def self.handle_exception(msg_or_context, e)
+      return if skip_report?(msg_or_context, e)
+
       params = msg_or_context.reject{ |k| PARAM_BLACKLIST.include?(k) }
       scope = { :request => { :params => params } }
 
       Rollbar.scope(scope).error(e, :use_exception_level_filters => true)
     end
 
+    def self.skip_report?(msg_or_context, e)
+      msg_or_context.is_a?(Hash) && msg_or_context["retry"] && msg_or_context["retry_count"] < ::Rollbar.configuration.sidekiq_threshold
+    end
+
     def call(worker, msg, queue)
       yield
     rescue Exception => e

data/lib/rollbar/util.rb

@@ -1,5 +1,6 @@
 require 'rollbar/util/hash'
 
+
 module Rollbar
   module Util
     def self.iterate_and_update(obj, block)

data/lib/rollbar/util/ip_obfuscator.rb

@@ -0,0 +1,21 @@
+module Rollbar
+  module Util
+    module IPObfuscator
+      require 'ipaddr'
+      require 'digest'
+
+      def self.obfuscate_ip(ip_string)
+        return ip_string unless Rollbar.configuration.user_ip_obfuscator_secret
+
+        secret = Rollbar.configuration.user_ip_obfuscator_secret
+        ip_int32 = IPAddr.new(ip_string, Socket::AF_INET).to_i
+        secret_int32 = Digest::MD5.hexdigest(secret)[0..7].to_i(16)
+        obfuscated_ip_int32 = ip_int32 ^ secret_int32 % (2 << 31)
+
+        IPAddr.new(obfuscated_ip_int32, Socket::AF_INET).to_s
+      rescue
+        nil
+      end
+    end
+  end
+end

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = "2.5.2"
+  VERSION = "2.6.0"
 end

data/spec/controllers/home_controller_spec.rb

@@ -8,8 +8,9 @@ describe HomeController do
   before do
     reset_configuration
     preconfigure_rails_notifier
+
     Rollbar.configure do |config|
-      config.access_token = 'aaaabbbbccccddddeeeeffff00001111'
+      config.access_token = test_access_token
       config.logger = logger_mock
       config.request_timeout = 60
     end
@@ -143,6 +144,27 @@ describe HomeController do
       it "should use the remote_addr when neither is set" do
         controller.send(:rollbar_request_data)[:user_ip].should == '0.0.0.0'
       end
+
+      context "rollbar_user_ip obfuscator" do
+        before do
+          Rollbar.configure do |config|
+            config.user_ip_obfuscator_secret = 'secret'
+          end
+        end
+
+        it "should obfuscate the ip when user_ip_obfuscator_secret is set" do
+          real_ip = '1.1.1.1'
+          obfuscated_ip = '95.191.35.149'
+          controller.request.env["HTTP_X_REAL_IP"] = real_ip
+          controller.send(:rollbar_request_data)[:user_ip].should == obfuscated_ip
+        end
+
+        it "should clear the ip field when an invalid ip is provided" do
+          invalid_ip = '1.1.1.999'
+          controller.request.env["HTTP_X_REAL_IP"] = invalid_ip
+          controller.send(:rollbar_request_data)[:user_ip].should == nil
+        end
+      end
     end
 
     context "rollbar_route_params", :type => 'request' do

data/spec/rollbar/sidekiq_spec.rb

@@ -27,6 +27,39 @@ describe Rollbar::Sidekiq, :reconfigure_notifier => false do
 
       described_class.handle_exception(msg_or_context, exception)
     end
+
+    context 'when set a sidekiq_threshold' do
+      before do
+        Rollbar.configuration.sidekiq_threshold = 2
+      end
+
+      it 'does not send error to rollbar under the threshold' do
+        allow(Rollbar).to receive(:scope).and_return(rollbar)
+        expect(rollbar).to receive(:error).never
+
+        msg_or_context = {"retry" => true, "retry_count" => 1}
+
+        described_class.handle_exception(msg_or_context, exception)
+      end
+
+      it 'sends the error to rollbar above the threshold' do
+        allow(Rollbar).to receive(:scope).and_return(rollbar)
+        expect(rollbar).to receive(:error)
+
+        msg_or_context = {"retry" => true, "retry_count" => 2}
+
+        described_class.handle_exception(msg_or_context, exception)
+      end
+
+      it 'sends the error to rollbar if not retry' do
+        allow(Rollbar).to receive(:scope).and_return(rollbar)
+        expect(rollbar).to receive(:error)
+
+        msg_or_context = {"retry" => false}
+
+        described_class.handle_exception(msg_or_context, exception)
+      end
+    end
   end
 
   describe '#call' do
@@ -43,5 +76,3 @@ describe Rollbar::Sidekiq, :reconfigure_notifier => false do
     end
   end
 end unless RUBY_VERSION == '1.8.7'
-
-

metadata

@@ -1,238 +1,209 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 2.5.2
-  prerelease: 
+  version: 2.6.0
 platform: ruby
 authors:
 - Rollbar, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-03 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: girl_friday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.1
 - !ruby/object:Gem::Dependency
   name: sucker_punch
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: genspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.8
 - !ruby/object:Gem::Dependency
   name: sinatra
   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: resque
   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: delayed_job
   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: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: redis
   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: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.12.14
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.12.14
 description: Easy and powerful exception tracking for Ruby
@@ -243,8 +214,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -312,6 +283,7 @@ files:
 - lib/rollbar/truncation/strings_strategy.rb
 - lib/rollbar/util.rb
 - lib/rollbar/util/hash.rb
+- lib/rollbar/util/ip_obfuscator.rb
 - lib/rollbar/version.rb
 - rollbar.gemspec
 - spec/cacert.pem
@@ -412,27 +384,26 @@ files:
 homepage: https://rollbar.com
 licenses:
 - MIT
+metadata: {}
 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: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Reports exceptions to Rollbar
 test_files:
 - spec/cacert.pem