rollbar 1.1.0 → 1.2.0

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/spec/controllers/home_controller_spec.rb

@@ -2,8 +2,9 @@ require 'spec_helper'
 
 describe HomeController do
   let(:logger_mock) { double("Rails.logger").as_null_object }
+  let(:notifier) { Rollbar.notifier }
 
-  before(:each) do
+  before do
     reset_configuration
     Rollbar::Rails.initialize
     Rollbar.configure do |config|
@@ -12,30 +13,29 @@ describe HomeController do
       config.request_timeout = 60
     end
   end
-  
+
   context "rollbar base_data" do
     it 'should have the Rails environment' do
-      data = Rollbar.send(:base_data)
-      data[:environment].should == ::Rails.env
+      data = Rollbar.notifier.send(:build_payload, 'error', 'message', nil, nil)
+      data['data'][:environment].should == ::Rails.env
     end
-    
+
     it 'should have an overridden environment' do
       Rollbar.configure do |config|
         config.environment = 'dev'
       end
-      
-      data = Rollbar.send(:base_data)
-      data[:environment].should == 'dev'
+
+      data = Rollbar.notifier.send(:build_payload, 'error', 'message', nil, nil)
+      data['data'][:environment].should == 'dev'
     end
-    
+
     it 'should use the default "unspecified" environment if rails env ends up being empty' do
-      old_env = ::Rails.env
-      ::Rails.env = ''
+      old_env, ::Rails.env = ::Rails.env, ''
       Rollbar::Rails.initialize
-      
-      data = Rollbar.send(:base_data)
-      data[:environment].should == 'unspecified'
-      
+
+      data = Rollbar.notifier.send(:build_payload, 'error', 'message', nil, nil)
+      data['data'][:environment].should == 'unspecified'
+
       ::Rails.env = old_env
     end
   end
@@ -58,104 +58,7 @@ describe HomeController do
       data.should == {}
     end
 
-    context "rollbar_filter_params" do
-      it "should filter files" do
-        name = "John Doe"
-        file_hash = {
-          :filename => "test.txt",
-          :type => "text/plain",
-          :head => {},
-          :tempfile => "dummy"
-        }
-        file = ActionDispatch::Http::UploadedFile.new(file_hash)
-
-        params = {
-          :name => name,
-          :a_file => file
-        }
-
-        filtered = controller.send(:rollbar_filtered_params, Rollbar.configuration.scrub_fields, params)
-
-        filtered[:name].should == name
-        filtered[:a_file].should be_a_kind_of(Hash)
-        filtered[:a_file][:content_type].should == file_hash[:type]
-        filtered[:a_file][:original_filename].should == file_hash[:filename]
-        filtered[:a_file][:size].should == file_hash[:tempfile].size
-      end
-
-      it "should filter files in nested params" do
-        name = "John Doe"
-        file_hash = {
-          :filename => "test.txt",
-          :type => "text/plain",
-          :head => {},
-          :tempfile => "dummy"
-        }
-        file = ActionDispatch::Http::UploadedFile.new(file_hash)
-
-        params = {
-          :name => name,
-          :wrapper => {
-            :wrapper2 => {
-              :a_file => file,
-              :foo => "bar"
-            }
-          }
-        }
-
-        filtered = controller.send(:rollbar_filtered_params, Rollbar.configuration.scrub_fields, params)
-
-        filtered[:name].should == name
-        filtered[:wrapper][:wrapper2][:foo].should == "bar"
-
-        filtered_file = filtered[:wrapper][:wrapper2][:a_file]
-        filtered_file.should be_a_kind_of(Hash)
-        filtered_file[:content_type].should == file_hash[:type]
-        filtered_file[:original_filename].should == file_hash[:filename]
-        filtered_file[:size].should == file_hash[:tempfile].size
-      end
-
-      it "should scrub the default scrub_fields" do
-        params = {
-          :passwd       => "hidden",
-          :password     => "hidden",
-          :secret       => "hidden",
-          :notpass      => "visible",
-          :secret_token => "f6805fea1cae0fb79c5e63bbdcd12bc6",
-        }
-
-        filtered = controller.send(:rollbar_filtered_params, Rollbar.configuration.scrub_fields, params)
-
-        filtered[:passwd].should == "******"
-        filtered[:password].should == "******"
-        filtered[:secret].should == "******"
-        filtered[:notpass].should == "visible"
-        filtered[:secret_token].should == "*" * 32
-      end
-
-      it "should scrub custom scrub_fields" do
-        Rollbar.configure do |config|
-          config.scrub_fields = [:notpass, :secret]
-        end
-
-        params = {
-          :passwd => "visible",
-          :password => "visible",
-          :secret => "hidden",
-          :notpass => "hidden"
-        }
-
-        filtered = controller.send(:rollbar_filtered_params, Rollbar.configuration.scrub_fields, params)
-
-        filtered[:passwd].should == "visible"
-        filtered[:password].should == "visible"
-        filtered[:secret].should == "******"
-        filtered[:notpass].should == "******"
-      end
-    end
-
     context 'rollbar_scrub_headers' do
-
       it 'should filter authentication by default' do
         headers = {
           'HTTP_AUTHORIZATION' => 'some-user',
@@ -197,7 +100,7 @@ describe HomeController do
 
         controller.send(:rollbar_request_data)[:url].should == 'http://rollbar.com'
       end
-      
+
       it "should respect forwarded host" do
         req = controller.request
         req.host = '127.0.0.1:8080'
@@ -205,7 +108,7 @@ describe HomeController do
 
         controller.send(:rollbar_request_data)[:url].should == 'http://test.com'
       end
-      
+
       it "should respect forwarded proto" do
         req = controller.request
         req.host = 'rollbar.com'
@@ -213,7 +116,7 @@ describe HomeController do
 
         controller.send(:rollbar_request_data)[:url].should == 'https://rollbar.com'
       end
-      
+
       it "should respect forwarded port" do
         req = controller.request
         req.host = '127.0.0.1:8080'
@@ -221,7 +124,7 @@ describe HomeController do
         req.env['HTTP_X_FORWARDED_PORT'] = '80'
 
         controller.send(:rollbar_request_data)[:url].should == 'http://test.com'
-        
+
         req.env['HTTP_X_FORWARDED_PORT'] = '81'
         controller.send(:rollbar_request_data)[:url].should == 'http://test.com:81'
       end
@@ -243,32 +146,77 @@ describe HomeController do
         controller.send(:rollbar_request_data)[:user_ip].should == '0.0.0.0'
       end
     end
-    
-    context "rollbar_route_params" do
+
+    context "rollbar_route_params", :type => 'request' do
       it "should save route params in request[:route]" do
         route = controller.send(:rollbar_request_data)[:route]
-        
+
         route.should have_key(:controller)
         route.should have_key(:action)
         route.should have_key(:format)
-        
+
         route[:controller].should == 'home'
         route[:action].should == 'index'
       end
-      
+
       it "should save controller and action in the payload body" do
         post 'report_exception'
-        
+
         route = controller.send(:rollbar_request_data)[:route]
-        
+
         route[:controller].should == 'home'
         route[:action].should == 'report_exception'
-        
+
         Rollbar.last_report.should_not be_nil
         Rollbar.last_report[:context].should == 'home#report_exception'
       end
     end
+  end
+
+  context "param_scrubbing", :type => "request" do
+    it "should scrub the default scrub_fields" do
+      params = {
+        :passwd       => "hidden",
+        :password     => "hidden",
+        :secret       => "hidden",
+        :notpass      => "visible",
+        :secret_token => "f6805fea1cae0fb79c5e63bbdcd12bc6",
+      }
+
+      post 'report_exception', params
+
+      filtered = Rollbar.last_report[:request][:params]
+
+      filtered["passwd"].should == "******"
+      filtered["password"].should == "******"
+      filtered["secret"].should == "******"
+      filtered["notpass"].should == "visible"
+      filtered["secret_token"].should == "*" * 32
+    end
 
+    it "should scrub custom scrub_fields" do
+      Rollbar.configure do |config|
+        config.scrub_fields = [:notpass, :secret]
+      end
+
+      params = {
+        :passwd => "visible",
+        :password => "visible",
+        :secret => "hidden",
+        :notpass => "hidden"
+      }
+
+      post 'report_exception', params
+
+      filtered = Rollbar.last_report[:request][:params]
+
+      filtered["passwd"].should == "visible"
+      # config.filter_parameters is set to [:password] in
+      # spec/dummyapp/config/application.rb
+      filtered["password"].should == "*******"
+      filtered["secret"].should == "******"
+      filtered["notpass"].should == "******"
+    end
   end
 
   describe "GET 'index'" do
@@ -286,35 +234,46 @@ describe HomeController do
       get 'report_exception'
       response.should be_success
     end
-    
+
     it "should raise a NameError and have PUT params in the reported exception" do
       logger_mock.should_receive(:info).with('[Rollbar] Success')
 
       put 'report_exception', :putparam => "putval"
-      
+
       Rollbar.last_report.should_not be_nil
       Rollbar.last_report[:request][:params]["putparam"].should == "putval"
     end
-    
+
+    context 'using deprecated report_exception' do
+      it 'reports the errors successfully' do
+        logger_mock.should_receive(:info).with('[Rollbar] Success')
+
+        put '/deprecated_report_exception', :putparam => "putval"
+
+        Rollbar.last_report.should_not be_nil
+        Rollbar.last_report[:request][:params]["putparam"].should == "putval"
+      end
+    end
+
     it "should raise a NameError and have JSON POST params" do
       logger_mock.should_receive(:info).with('[Rollbar] Success')
       @request.env["HTTP_ACCEPT"] = "application/json"
-      
-      params = {:jsonparam => 'jsonval'}.to_json
-      post 'report_exception', params, {'CONTENT_TYPE' => 'application/json'}
-      
+
+      params = { :jsonparam => 'jsonval' }.to_json
+      post 'report_exception', params, { 'CONTENT_TYPE' => 'application/json' }
+
       Rollbar.last_report.should_not be_nil
       Rollbar.last_report[:request][:params]['jsonparam'].should == 'jsonval'
     end
   end
-  
+
   describe "'cause_exception'", :type => "request" do
     it "should raise an uncaught exception and report a message" do
       logger_mock.should_receive(:info).with('[Rollbar] Success').once
-      
+
       expect { get 'cause_exception' }.to raise_exception
     end
-    
+
     context 'show_exceptions' do
       before(:each) do
         if Dummy::Application.respond_to? :env_config
@@ -322,46 +281,52 @@ describe HomeController do
         else
           config = Dummy::Application.env_defaults
         end
-        
+
         config['action_dispatch.show_exceptions'] = true
       end
-      
+
       after(:each) do
         if Dummy::Application.respond_to? :env_config
           config = Dummy::Application.env_config
         else
           config = Dummy::Application.env_defaults
         end
-        
+
         config['action_dispatch.show_exceptions'] = false
       end
-      
+
       it "middleware should catch the exception and only report to rollbar once" do
         logger_mock.should_receive(:info).with('[Rollbar] Success').once
-        
-        get 'cause_exception'
-      end
-      
-      it 'rollbar request store should extract person data and put it into the reqest' do
-        Rollbar.configure do |config|
-          config.person_method = 'custom_current_user'
-        end
-        
+
         get 'cause_exception'
-        
-        user = request.env['rollbar.person_data']
-        user[:id].should == 123
-        user[:username].should == 'test'
-        user[:email].should == 'email@test.com'
       end
-      
+
       it 'should not fail if the controller doesnt contain the person method' do
         Rollbar.configure do |config|
           config.person_method = 'invalid_method'
         end
-        
+
         get 'cause_exception'
       end
+
+      context 'with logged user' do
+        let(:user) do
+          User.create(:email => 'foo@bar.com',
+                      :username => 'the_username')
+        end
+
+        before { cookies[:session_id] = user.id }
+
+        it 'sends the current user data' do
+          put 'report_exception', 'foo' => 'bar'
+
+          person_data = Rollbar.last_report[:person]
+
+          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)
+        end
+      end
     end
   end
 

data/spec/dummyapp/app/controllers/home_controller.rb

@@ -2,27 +2,37 @@ class HomeController < ApplicationController
   def index
     @users = User.all
 
-    Rollbar.report_message("Test message from controller with no data", "debug")
-    Rollbar.report_message("Test message from controller with extra data", "debug",
-                             :foo => "bar", :num_users => @users.length)
+    Rollbar.debug("Test message from controller with no data")
+    Rollbar.debug("Test message from controller with extra data",
+                  :foo => "bar", :num_users => @users.length)
   end
 
   def report_exception
     begin
       foo = bar
     rescue => e
-      Rollbar.report_exception(e, rollbar_request_data, rollbar_person_data)
+      Rollbar.error(e)
     end
   end
 
+  def deprecated_report_exception
+    begin
+      foo = bar
+    rescue => e
+      Rollbar.report_exception(e)
+    end
+    render :json => {}
+  end
+
+
   def cause_exception
     foo = bar
   end
 
   def current_user
-    User.find_by_encrypted_password(cookies[:session_id])
+    @current_user ||= User.find_by_id(cookies[:session_id])
   end
-  
+
   def custom_current_user
     user = User.new
     user.id = 123