airbrake 5.6.0 → 5.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0101d07aaa70ffe17d357dbeefd3c00b0e750ac0
-  data.tar.gz: c6642bb8d3f2515bad7f22b79b0d96119609d536
+  metadata.gz: 74d407054008e4b64ea9fd13bbbb4e4b5532ef4e
+  data.tar.gz: 8d39d898036c546a052c211191419d5448495970
 SHA512:
-  metadata.gz: 6e3be8dd51149933fa2cbc6c92a972f0c029b1c649377e2b55e9a476d119725d65d98554cbfc103e15d698f992d964cac8c910af4b44fce6502a6ea57d930d9e
-  data.tar.gz: 0c4295e72b8e09e5d9cc30146d6b43f8aa7c9f48a579b7ef4f60ac56bd0514f41f560acb58ce62f51bd9b1c336c911a541bf893266b375b5a6e647d63129830e
+  metadata.gz: 25563fe3c612bc3ce4eb0b7b3320f893e26f1be866781673f5866d896804801ca5427d007c14b8f7a62afa2733ea25d9031b6a49fa2b1d09b0ae62e5650497c4
+  data.tar.gz: 6b66de7a73b659090fe9f5526d0d69631938c52b74042a332424a2e8e735255a855bc8dd35c58dec1ce3dfab46d107011d8f30da08bb2830b2899753097a1bde

data/lib/airbrake/rack/notice_builder.rb

@@ -90,8 +90,10 @@ module Airbrake
       ##
       # Adds HTTP request parameters.
       add_builder do |notice, request|
-        params = request.env['action_dispatch.request.parameters']
-        notice[:params] = params if params
+        notice[:params] = request.params
+
+        rails_params = request.env['action_dispatch.request.parameters']
+        notice[:params].merge!(rails_params) if rails_params
       end
 
       ##
@@ -110,6 +112,15 @@ module Airbrake
           referer: request.referer,
           headers: http_headers
         )
+
+        notice[:environment][:body] =
+          if request.body
+            data = request.body.read(512)
+            request.body.rewind
+            data
+          end
+
+        notice[:environment]
       end
     end
   end

data/lib/airbrake/rack/user.rb

@@ -17,10 +17,17 @@ module Airbrake
         end
 
         # Fallback mode (OmniAuth support included). Works only for Rails.
+        user = try_current_user(rack_env)
+        new(user) if user
+      end
+
+      def self.try_current_user(rack_env)
         controller = rack_env['action_controller.instance']
         return unless controller.respond_to?(:current_user)
-        new(controller.current_user) if controller.current_user
+        return unless [-1, 0].include?(controller.method(:current_user).arity)
+        controller.current_user
       end
+      private_class_method :try_current_user
 
       def initialize(user)
         @user = user

data/lib/airbrake/version.rb

@@ -2,5 +2,5 @@
 # We use Semantic Versioning v2.0.0
 # More information: http://semver.org/
 module Airbrake
-  AIRBRAKE_VERSION = '5.6.0'.freeze
+  AIRBRAKE_VERSION = '5.6.1'.freeze
 end

data/spec/unit/rack/notice_builder_spec.rb

@@ -1,9 +1,13 @@
 require 'spec_helper'
 
 RSpec.describe Airbrake::Rack::NoticeBuilder do
+  def env_for(url, opts = {})
+    Rack::MockRequest.env_for(url, opts)
+  end
+
   describe "#build_notice" do
-    it "doesn't overwrite session with nil" do
-      notice_builder = described_class.new('rack.session' => nil)
+    it "doesn't overwrite the session key with nil" do
+      notice_builder = described_class.new(env_for('/', 'rack.session' => nil))
       notice = notice_builder.build_notice(AirbrakeTestError.new)
 
       expect(notice[:session]).to eq({})
@@ -11,34 +15,47 @@ RSpec.describe Airbrake::Rack::NoticeBuilder do
 
     it "sets session if it is present" do
       session = { a: 1, b: 2 }
-      notice_builder = described_class.new('rack.session' => session)
+      notice_builder = described_class.new(env_for('/', 'rack.session' => session))
       notice = notice_builder.build_notice(AirbrakeTestError.new)
 
       expect(notice[:session]).to eq(session)
     end
 
-    it "doesn't overwrite params with nil" do
-      notice_builder = described_class.new('action_dispatch.request.parameters' => nil)
+    it "doesn't overwrite the params key with nil" do
+      notice_builder = described_class.new(env_for('/'))
       notice = notice_builder.build_notice(AirbrakeTestError.new)
 
       expect(notice[:session]).to eq({})
     end
 
-    it "sets params if they're present" do
+    it "sets form params if they're present" do
       params = { a: 1, b: 2 }
-      notice_builder = described_class.new('action_dispatch.request.parameters' => params)
+      input = StringIO.new
+
+      notice_builder = described_class.new(
+        'rack.request.form_hash' => params,
+        'rack.request.form_input' => input,
+        'rack.input' => input
+      )
       notice = notice_builder.build_notice(AirbrakeTestError.new)
 
       expect(notice[:params]).to eq(params)
     end
 
+    it "sets query string params if they're present" do
+      notice_builder = described_class.new(env_for('/?bingo=bango&bongo=bish'))
+      notice = notice_builder.build_notice(AirbrakeTestError.new)
+
+      expect(notice[:params]).to eq('bingo' => 'bango', 'bongo' => 'bish')
+    end
+
     it "adds CONTENT_TYPE, CONTENT_LENGTH and HTTP_* headers in the environment" do
       headers = {
         "HTTP_HOST" => "example.com",
         "CONTENT_TYPE" => "text/html",
         "CONTENT_LENGTH" => 100500
       }
-      notice_builder = described_class.new(headers.dup)
+      notice_builder = described_class.new(env_for('/', headers.dup))
       notice = notice_builder.build_notice(AirbrakeTestError.new)
       expect(notice[:environment][:headers]).to eq(headers)
     end
@@ -49,8 +66,11 @@ RSpec.describe Airbrake::Rack::NoticeBuilder do
         "CONTENT_TYPE" => "text/html",
         "CONTENT_LENGTH" => 100500
       }
-      notice_builder = described_class.new(headers.merge("X-SOME-HEADER" => "value"))
+      notice_builder = described_class.new(
+        env_for('/', headers.merge("X-SOME-HEADER" => "value"))
+      )
       notice = notice_builder.build_notice(AirbrakeTestError.new)
+
       expect(notice[:environment][:headers]).to eq(headers)
     end
 
@@ -65,29 +85,73 @@ RSpec.describe Airbrake::Rack::NoticeBuilder do
         notice[:environment]["SOME_KEY"] = "SOME_VALUE"
         notice
       end
-      notice_builder = described_class.new(headers)
+      notice_builder = described_class.new(env_for('/', headers))
       notice = notice_builder.build_notice(AirbrakeTestError.new)
+
       expect(notice[:environment]["SOME_KEY"]).to eq("SOME_VALUE")
     end
 
-    it "runs user defined builders against notices" do
-      extended_class = described_class.dup
-      extended_class.add_builder do |notice, request|
-        notice[:params][:remoteIp] = request.env['REMOTE_IP']
+    context "when a custom builder is defined" do
+      before do
+        described_class.add_builder do |notice, request|
+          notice[:params][:remoteIp] = request.env['REMOTE_IP']
+        end
+      end
+
+      after do
+        described_class.instance_variable_get(:@builders).pop
+      end
+
+      it "runs the builder against notices" do
+        notice_builder = described_class.new(env_for('/', 'REMOTE_IP' => '127.0.0.1'))
+        notice = notice_builder.build_notice(AirbrakeTestError.new)
+
+        expect(notice[:params][:remoteIp]).to eq("127.0.0.1")
       end
-      notice_builder = extended_class.new('REMOTE_IP' => '127.0.0.1')
-      notice = notice_builder.build_notice(AirbrakeTestError.new)
-      expect(notice[:params][:remoteIp]).to eq("127.0.0.1")
     end
 
     context "when Airbrake is not configured" do
       it "returns nil" do
         allow(Airbrake).to receive(:build_notice).and_return(nil)
-        notice_builder = described_class.new('bingo' => 'bango')
+        notice_builder = described_class.new(env_for('/', 'bingo' => 'bango'))
 
         expect(notice_builder.build_notice('bongo')).to be_nil
         expect(Airbrake).to have_received(:build_notice)
       end
     end
+
+    context "when a request has a body" do
+      it "reads the body" do
+        body = StringIO.new('<bingo>bongo</bango>')
+        notice_builder = described_class.new(
+          env_for('/', 'rack.input' => body)
+        )
+        notice = notice_builder.build_notice(AirbrakeTestError.new)
+
+        expect(notice[:environment][:body]).to eq(body.string)
+      end
+
+      it "rewinds rack.input" do
+        body = StringIO.new('<bingo>bongo</bango>' * 512)
+        notice_builder = described_class.new(
+          env_for('/', 'rack.input' => body)
+        )
+
+        notice_builder.build_notice(AirbrakeTestError.new)
+
+        expect(body.pos).to be_zero
+      end
+
+      it "reads only first 512 bytes" do
+        len = 513
+        body = StringIO.new('a' * len)
+        notice_builder = described_class.new(
+          env_for('/', 'rack.input' => body)
+        )
+        notice = notice_builder.build_notice(AirbrakeTestError.new)
+
+        expect(notice[:environment][:body]).to eq(body.string[0...len - 1])
+      end
+    end
   end
 end

data/spec/unit/rack/user_spec.rb

@@ -52,10 +52,11 @@ RSpec.describe Airbrake::Rack::User do
     end
 
     context "when the current_user Rails controller method is defined" do
+      let(:controller) { instance_double('DummyController') }
+      let(:env) { env_for('/', 'action_controller.instance' => controller) }
+
       context "and it is nil" do
         it "returns nil" do
-          controller = instance_double('DummyController')
-          env = env_for('/', 'action_controller.instance' => controller)
           allow(controller).to receive(:current_user) { nil }
 
           retval = described_class.extract(env)
@@ -65,13 +66,76 @@ RSpec.describe Airbrake::Rack::User do
 
       context "and it is not nil" do
         it "returns the wrapped user" do
-          controller = instance_double('DummyController')
-          env = env_for('/', 'action_controller.instance' => controller)
           allow(controller).to receive(:current_user) { user }
 
           retval = described_class.extract(env)
           expect(retval).to be_a(described_class)
         end
+
+        context "but it requires parameters" do
+          let(:controller) { dummy_controller.new }
+          subject { described_class.extract(env) }
+
+          context ": current_user(a)" do
+            let(:dummy_controller) do
+              Class.new do
+                def current_user(_a)
+                  "username"
+                end
+              end
+            end
+
+            it { should be_nil }
+          end
+
+          context ": current_user(a, b)" do
+            let(:dummy_controller) do
+              Class.new do
+                def current_user(_a, _b)
+                  "username"
+                end
+              end
+            end
+
+            it { should be_nil }
+          end
+
+          context ": current_user(a, *b)" do
+            let(:dummy_controller) do
+              Class.new do
+                def current_user(_a, *_b)
+                  "username"
+                end
+              end
+            end
+
+            it { should be_nil }
+          end
+
+          context ": current_user(a, b, *c, &d)" do
+            let(:dummy_controller) do
+              Class.new do
+                def current_user(_a, _b, *_c, &_d)
+                  "username"
+                end
+              end
+            end
+
+            it { should be_nil }
+          end
+
+          context ": current_user(*a)" do
+            let(:dummy_controller) do
+              Class.new do
+                def current_user(*_a)
+                  "username"
+                end
+              end
+            end
+
+            it { should be_a(described_class) }
+          end
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 5.6.1
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2016-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrake-ruby