Merge pull request #735 from rollbar/github-727-collect-ip-config

GitHub Issue 727: Allow IP collection to be easily turned on and off in config

Author: ArturMoczulski

lib/rollbar/configuration.rb

@@ -43,6 +43,7 @@ class Configuration
     attr_accessor :scrub_fields
     attr_accessor :scrub_user
     attr_accessor :scrub_password
+    attr_accessor :collect_user_ip
     attr_accessor :user_ip_obfuscator_secret
     attr_accessor :randomize_scrub_length
     attr_accessor :uncaught_exception_level
@@ -120,6 +121,7 @@ def initialize
       @project_gem_paths = []
       @use_exception_level_filters_default = false
       @proxy = nil
+      @collect_user_ip = true
     end
 
     def initialize_copy(orig)

lib/rollbar/request_data_extractor.rb

@@ -131,6 +131,7 @@ def rollbar_url(env)
     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
 
       Rollbar::Util::IPObfuscator.obfuscate_ip(user_ip_string)

spec/rollbar/request_data_extractor_spec.rb

@@ -138,6 +138,18 @@ class ExtractorDummy
 
           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
       end
 
       context 'with private first client IP' do