rollbar 2.15.6 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 308597023c833b27f29c551f13eb92c9b4ae24c3
-  data.tar.gz: f0b5bebb851e64c0f831c7fe4f0c8d05bb3dca80
+  metadata.gz: 11bd20d68ff24396b75b8518ea2ffbe641cfd8fc
+  data.tar.gz: c3838b31c21856ad31abe72f82b96edeff3a8eda
 SHA512:
-  metadata.gz: 0a03bb676d4bff746f6c691c92bedf00e14d6b6a0ff8ca0afee5dc3b8c8ee8f96bdad2d912a037f7914c86424c1aae7b64fa8c6a338da0918dc553142c5835a7
-  data.tar.gz: f9597a902bbba23e993f2bc2c8473e5b22a3e1a18337648ea5697e7a9762880e0cd6024c51b40e2d2c1c6f38a3bf3ffda80cee045c2c3acf3e79c6ee0f6e259b
+  metadata.gz: 9ea80cb9c0b5d102bdd16b784e531efbb7c74ba771da22a63d64d2b34c8ada1dec0ad95db2974267ec33c6cee4ad49c24450b39f4c1859391ab8483aa6dd7efd
+  data.tar.gz: ac2f51581aeca7f5af213f79651a1123e4e8a5810ac9bf8e6298b05cb57bf205de773246b717d554ace0b42d02b8a4aa3e0e14d78a9d9a6555d0351f3ec2104f

data/CHANGELOG.md

@@ -10,6 +10,7 @@
 - Add documentation note for usage of `Rollbar.scope!` to `README.md` [#653](https://github.com/rollbar/rollbar-gem/issues/653)
 - Add example of using `Grape` to deal with `500` responses status [#645](https://github.com/rollbar/rollbar-gem/issues/645)
 - Always report errors from `delayed_job` to deal with `dj_threshold > 0` edge case [#615](https://github.com/rollbar/rollbar-gem/issues/615)
+- Fix "Empty message" items for exceptions reported from JRuby [#658]
 
 ## 2.15.5
 

data/README.md

@@ -379,8 +379,8 @@ If the methods to extract the ```id```, ```username```, and ```email``` from the
 ```ruby
 Rollbar.configure do |config|
   config.person_id_method = "user_id"  # default is "id"
-  config.person_username_method = "user_name"  # default is "username"
-  config.person_email_method = "email_address"  # default is "email"
+  config.person_username_method = "user_name"  # default is `nil`
+  config.person_email_method = "email_address"  # default is `nil`
 end
 ```
 

data/THANKS.md

@@ -25,6 +25,7 @@ Huge thanks to the following contributors (by github username). For the most up-
 - [jeremyvdw](https://github.com/jeremyvdw)
 - [jjb](https://github.com/jjb)
 - [johnknott](https://github.com/johnknott)
+- [johnsyweb](https://github.com/johnsyweb)
 - [jonah-williams](https://github.com/jonah-williams)
 - [jondeandres](https://github.com/jondeandres)
 - [JoshuaOSHickman](https://github.com/JoshuaOSHickman)

data/docs/configuration.md

@@ -174,12 +174,16 @@ if `person_method` not present.
 
 ### person_username_method
 
+**Default** `nil`
+
 A string or symbol giving the name of the method on the user instance that
 returns the person's username. Gets called on the result of `person_method`.
 Ignored if `person_method` not present.
 
 ### person_email_method
 
+**Default** `nil`
+
 A string or symbol giving the name of the method on the user instance that
 returns the person's email. Gets called on the result of `person_method`.
 Ignored if `person_method` not present.

data/lib/generators/rollbar/templates/initializer.rb

@@ -19,12 +19,14 @@ Rollbar.configure do |config|
 <%- end -%>
 
   # By default, Rollbar will try to call the `current_user` controller method
-  # to fetch the logged-in user object, and then call that object's `id`,
-  # `username`, and `email` methods to fetch those properties. To customize:
+  # to fetch the logged-in user object, and then call that object's `id`
+  # method to fetch this property. To customize:
   # config.person_method = "my_current_user"
   # config.person_id_method = "my_id"
-  # config.person_username_method = "my_username"
-  # config.person_email_method = "my_email"
+
+  # Additionally, you may specify the following:
+  # config.person_username_method = "username"
+  # config.person_email_method = "email"
 
   # If you want to attach custom data to all exception and message reports,
   # provide a lambda like the following. It should return a hash.

data/lib/rollbar/configuration.rb

@@ -43,6 +43,8 @@ module Rollbar
     attr_accessor :scrub_fields
     attr_accessor :scrub_user
     attr_accessor :scrub_password
+    attr_accessor :collect_user_ip
+    attr_accessor :anonymize_user_ip
     attr_accessor :user_ip_obfuscator_secret
     attr_accessor :randomize_scrub_length
     attr_accessor :uncaught_exception_level
@@ -90,8 +92,8 @@ module Rollbar
       @payload_options = {}
       @person_method = 'current_user'
       @person_id_method = 'id'
-      @person_username_method = 'username'
-      @person_email_method = 'email'
+      @person_username_method = nil
+      @person_email_method = nil
       @project_gems = []
       @populate_empty_backtraces = false
       @report_dj_data = true
@@ -120,6 +122,8 @@ module Rollbar
       @project_gem_paths = []
       @use_exception_level_filters_default = false
       @proxy = nil
+      @collect_user_ip = true
+      @anonymize_user_ip = false
     end
 
     def initialize_copy(orig)

data/lib/rollbar/request_data_extractor.rb

@@ -5,6 +5,7 @@ require 'rollbar/scrubbers'
 require 'rollbar/scrubbers/url'
 require 'rollbar/scrubbers/params'
 require 'rollbar/util/ip_obfuscator'
+require 'rollbar/util/ip_anonymizer'
 require 'rollbar/json'
 
 module Rollbar
@@ -131,8 +132,11 @@ module Rollbar
     end
 
     def rollbar_user_ip(env)
+      return nil unless Rollbar.configuration.collect_user_ip
       user_ip_string = (env['action_dispatch.remote_ip'] || env['HTTP_X_REAL_IP'] || x_forwarded_for_client(env['HTTP_X_FORWARDED_FOR']) || env['REMOTE_ADDR']).to_s
 
+      user_ip_string = Rollbar::Util::IPAnonymizer.anonymize_ip(user_ip_string)
+
       Rollbar::Util::IPObfuscator.obfuscate_ip(user_ip_string)
     rescue
       nil

data/lib/rollbar/scrubbers/params.rb

@@ -3,9 +3,9 @@ require 'rollbar/scrubbers'
 
 module Rollbar
   module Scrubbers
-    # This class contains the logic to scrub the receive parameters. It will
+    # This class contains the logic to scrub the received parameters. It will
     # scrub the parameters matching Rollbar.configuration.scrub_fields Array.
-    # Also, if that configuration option is se to :scrub_all, it will scrub all
+    # Also, if that configuration option is set to :scrub_all, it will scrub all
     # received parameters
     class Params
       SKIPPED_CLASSES = [::Tempfile]

data/lib/rollbar/tasks/rollbar.cap

@@ -32,7 +32,7 @@ namespace :rollbar do
   desc 'Upload sourcemaps to Rollbar.'
   task :sourcemap do
     on primary fetch(:rollbar_role) do
-      info "Uploading source maps from #{fetch(:rollbar_sourcemaps_target_dir)}"
+      info "Uploading source maps"
       warn("You need to upgrade capistrano to '>= 3.1' version in order to correctly upload sourcemaps to Rollbar. (On 3.0, the reported revision will be incorrect.)") if Capistrano::VERSION =~ /^3\.0/
       url_base = fetch(:rollbar_sourcemaps_minified_url_base)
       unless url_base
@@ -42,11 +42,21 @@ namespace :rollbar do
       url_base = "http://#{url_base}" unless url_base.index(/https?:\/\//)
       within release_path do
         within 'public' do
-          source_maps = capture(:find, '-name', "'*.js.map'").split("\n")
+          source_maps = capture(:find, '-L', '.', '-name', "'*.js.map'").split("\n")
           source_maps = source_maps.map { |file| file.gsub(/^\.\//, '') }
           source_maps.each do |source_map|
             minified_url = File.join(url_base, source_map)
-            execute(:curl, *%W(https://api.rollbar.com/api/1/sourcemap -F access_token=#{fetch(:rollbar_token)} -F version=#{fetch(:rollbar_revision)} -F minified_url=#{minified_url} -F source_map=@./#{source_map}))
+            args = *%W(--silent https://api.rollbar.com/api/1/sourcemap -F access_token=#{fetch(:rollbar_token)} -F version=#{fetch(:rollbar_revision)} -F minified_url=#{minified_url} -F source_map=@./#{source_map})
+            info "curl #{args.join(' ')}" # log the command, since capture doesn't output anything
+            api_response_body = capture(:curl, args)
+            begin
+              api_response_json = JSON.parse(api_response_body)
+              if api_response_json["err"] != 0
+                warn "Error uploading sourcemaps: #{api_response_json["message"] || 'Unknown Error'}"
+              end
+            rescue JSON::ParserError => e
+              warn "Error parsing response: #{e.message}. Response body: #{api_response_body}"
+            end
           end
         end
       end

data/lib/rollbar/util/ip_anonymizer.rb

@@ -0,0 +1,32 @@
+module Rollbar
+  module Util
+    module IPAnonymizer
+      require 'ipaddr'
+
+      def self.anonymize_ip(ip_string)
+        return ip_string unless Rollbar.configuration.anonymize_user_ip
+        ip = IPAddr.new(ip_string)
+        return anonymize_ipv6 ip if ip.ipv6?
+        return anonymize_ipv4 ip if ip.ipv4?
+      rescue
+        nil
+      end
+      
+      def self.anonymize_ipv4(ip)
+        ip_parts = ip.to_s.split '.'
+        
+        ip_parts[ip_parts.count - 1] = '0'
+        
+        IPAddr.new(ip_parts.join('.')).to_s
+      end
+      
+      def self.anonymize_ipv6(ip)
+        ip_parts = ip.to_s.split ':'
+        
+        ip_string = ip_parts[0..2].join(':') + ':0000:0000:0000:0000:0000'
+        
+        IPAddr.new(ip_string).to_s
+      end
+    end
+  end
+end

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = '2.15.6'
+  VERSION = '2.16.0'
 end

data/spec/controllers/home_controller_spec.rb

@@ -335,14 +335,40 @@ describe HomeController do
 
         before { cookies[:session_id] = user.id }
 
-        it 'sends the current user data' do
-          put '/report_exception', *wrap_process_args({ 'foo' => 'bar' })
+        subject(:person_data) do
+          put '/report_exception', *wrap_process_args('foo' => 'bar')
 
-          person_data = Rollbar.last_report[:person]
+          Rollbar.last_report[:person]
+        end
 
-          expect(person_data[:id]).to be_eql(user.id)
-          expect(person_data[:email]).to be_eql(user.email)
-          expect(person_data[:username]).to be_eql(user.username)
+        context 'default' do
+          it 'sends the current user data excluding personally identifiable information' do
+            expect(person_data).to eq(:id => user.id,
+                                      :email => nil,
+                                      :username => nil)
+          end
+        end
+
+        context 'without EU GDPR subjects' do
+          context 'configured to send email addresses' do
+            before { Rollbar.configure { |config| config.person_email_method = 'email' } }
+
+            it 'sends the current user data including email address' do
+              expect(person_data).to eq(:id => user.id,
+                                        :email => 'foo@bar.com',
+                                        :username => nil)
+            end
+
+            context 'configured to send email addresses and username' do
+              before { Rollbar.configure { |config| config.person_username_method = 'username' } }
+
+              it 'sends the current user data including email address and username' do
+                  expect(person_data).to eq(:id => user.id,
+                                            :email => 'foo@bar.com',
+                                            :username => 'the_username')
+              end
+            end
+          end
         end
       end
     end

data/spec/dummyapp/config/initializers/rollbar.rb

@@ -7,12 +7,14 @@ Rollbar.configure do |config|
     :foo => :bar
   }
   # By default, Rollbar will try to call the `current_user` controller method
-  # to fetch the logged-in user object, and then call that object's `id`,
-  # `username`, and `email` methods to fetch those properties. To customize:
+  # to fetch the logged-in user object, and then call that object's `id`
+  # method to fetch this property. To customize:
   # config.person_method = "my_current_user"
   # config.person_id_method = "my_id"
-  # config.person_username_method = "my_username"
-  # config.person_email_method = "my_email"
+
+  # Additionally, you may specify the following:
+  # config.person_username_method = "username"
+  # config.person_email_method = "email"
 
   # Add exception class names to the exception_level_filters hash to
   # change the level that exception is reported at. Note that if an exception

data/spec/rollbar/request_data_extractor_spec.rb

@@ -138,6 +138,30 @@ describe Rollbar::RequestDataExtractor do
 
           expect(result[:user_ip]).to be_eql('2.2.2.2')
         end
+        
+        context 'with collect_user_ip configuration option disabled' do
+          before do
+            Rollbar.configuration.collect_user_ip = false
+          end
+          
+          it 'does not extract user\'s IP' do
+            result = subject.extract_request_data_from_rack(env)
+  
+            expect(result[:user_ip]).to be_nil
+          end
+        end
+        
+        context 'with anonymize_user_ip configuration option enabled' do
+          before do
+            Rollbar.configuration.anonymize_user_ip = true
+          end
+          
+          it 'it anonymizes the IPv4 address' do
+            result = subject.extract_request_data_from_rack(env)
+  
+            expect(result[:user_ip]).to be_eql('2.2.2.0')
+          end
+        end
       end
 
       context 'with private first client IP' do

data/spec/rollbar/util/ip_anonymizer_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'rollbar/util/ip_anonymizer'
+
+describe Rollbar::Util::IPAnonymizer do
+  
+  before do
+    Rollbar.configuration.anonymize_user_ip = true
+  end
+  
+  context 'with IPv4 address' do
+    let(:ip) { '127.0.0.1' }
+    
+    it 'anonymizes the IP by replacing the last octet with 0' do
+      anonymized_ip = described_class.anonymize_ip(ip)
+  
+      expect(anonymized_ip).to be_eql(IPAddr.new('127.0.0.0').to_s)
+    end
+  end
+  
+  context 'with IPv6 address' do
+    let(:ip) { '2001:0db8:85a3:0000:0000:8a2e:0370:7334' }
+    
+    it 'anonymizes the IP by replacing the last 80 bits with 0' do
+      
+      anonymized_ip = described_class.anonymize_ip(ip)
+  
+      expect(anonymized_ip).to be_eql(IPAddr.new('2001:db8:85a3::').to_s)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 2.15.6
+  version: 2.16.0
 platform: ruby
 authors:
 - Rollbar, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-17 00:00:00.000000000 Z
+date: 2018-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -133,6 +133,7 @@ files:
 - lib/rollbar/truncation/strings_strategy.rb
 - lib/rollbar/util.rb
 - lib/rollbar/util/hash.rb
+- lib/rollbar/util/ip_anonymizer.rb
 - lib/rollbar/util/ip_obfuscator.rb
 - lib/rollbar/version.rb
 - lib/tasks/tasks.rake
@@ -248,6 +249,7 @@ files:
 - spec/rollbar/truncation/strings_strategy_spec.rb
 - spec/rollbar/truncation_spec.rb
 - spec/rollbar/util/hash_spec.rb
+- spec/rollbar/util/ip_anonymizer_spec.rb
 - spec/rollbar/util_spec.rb
 - spec/rollbar_bc_spec.rb
 - spec/rollbar_spec.rb
@@ -282,7 +284,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Reports exceptions to Rollbar
@@ -398,6 +400,7 @@ test_files:
 - spec/rollbar/truncation/strings_strategy_spec.rb
 - spec/rollbar/truncation_spec.rb
 - spec/rollbar/util/hash_spec.rb
+- spec/rollbar/util/ip_anonymizer_spec.rb
 - spec/rollbar/util_spec.rb
 - spec/rollbar_bc_spec.rb
 - spec/rollbar_spec.rb