raygun4ruby 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87bcff1d09782d4e215f3c5bcaec19c5ab14d43e
-  data.tar.gz: 4d033882abae5990a864817801f3c928981bb60a
+  metadata.gz: 558ace0abc94bf42933ffec0ae4327a8cfba09a2
+  data.tar.gz: a27eb894bc5e0079d7b10b40463c5e47c82b21ad
 SHA512:
-  metadata.gz: 683c9f6446683722f334a370ec6e4c463fcdc43699deb9146c1bb44bfa8f9017324271036396c77639e9129e21a749655ddfbb0a9c750f0bcfa8fed7bf3c59ef
-  data.tar.gz: 47c6be6d9106a7eff502f64f15cc72ea751534ad239e392224388f186d8fea8e1b0c2c7b7480f5f8d585db960a711f1afc6242b3b3687577040437a36e81b5c7
+  metadata.gz: c390cf858fa96eef0e2a42174c0098cefda944dc9d4e1ea85ce2c06b4e9e0795170fa409ff726ac2d5431aa2a928803a61c5d963a71e472bd0ebfa793f31f62f
+  data.tar.gz: 6d334a8df11475639df6ad6eebdedc7d7301d61915392179b711ee45030ec2ec8f9e0fc411794e5ea53ce5bac90447af489925298e325a83760aea6bcf1dd21c

data/CHANGELOG.md

@@ -1,34 +1,40 @@
+## 2.0.0 (20/04/2017)
+
+Bugfixes:
+  - Fix broken handling of raw request body reading in Rack applications ([#116](https://github.com/MindscapeHQ/raygun4ruby/pull/116))
+    - This is a breaking change to how raw data was being read before so it requires a major version bump
+    - Raw request data reading is now disabled by default and can be enabled via the `record_raw_data` configuration option
 ## 1.5.0 (16/03/2017)
 
 Features
-  - Send utcOffset with Raygun payload to calculate local server time in Raygun dashboard
+  - Send utcOffset with Raygun payload to calculate local server time in Raygun dashboard ([#112](https://github.com/MindscapeHQ/raygun4ruby/pull/112))
 
 ## 1.4.0 (14/03/2017)
 
 Features:
-  - Raygun API url is now configurable via `Configuration.api_url`
-  - Added support for `Exception#cause` to be tracked as `innerError` on Raygun. Only supported on Ruby >= 2.1
+  - Raygun API url is now configurable via `Configuration.api_url` ([#111](https://github.com/MindscapeHQ/raygun4ruby/pull/111))
+  - Added support for `Exception#cause` to be tracked as `innerError` on Raygun. Only supported on Ruby >= 2.1 ([#107](https://github.com/MindscapeHQ/raygun4ruby/pull/107))
 
 ## 1.3.0 (10/03/2017)
 
 Features:
-  - Improve affected user handling to let you specify all Raygun parameters, identifier, email, first name, full name and uuid. See [README.md](https://github.com/MindscapeHQ/raygun4ruby#affected-user-tracking) for details
-  - Pass a user object as the third parameter to `Raygun.track_exception` to have affected user tracking for manually tracked exceptions, see the above link for more information on configuring this
-  - If the exception instance responds to `:raygun_custom_data` that method will be called and the return value merged into the `custom_data` hash sent to Raygun. For convenience a `Raygun::Error` class is provided that takes this custom data as a second argument
-  - Allowed `Configuration.custom_data` to be set to a proc to allow a global custom data hook for all exceptions. It is passed as arguments the exception and the environment hash
-  - Added `Configuration.debug` to enable logging the reason why an exception was not reported
+  - Improve affected user handling to let you specify all Raygun parameters, identifier, email, first name, full name and uuid. See [README.md](https://github.com/MindscapeHQ/raygun4ruby#affected-user-tracking) for details ([#34](https://github.com/MindscapeHQ/raygun4ruby/pull/34))
+  - Pass a user object as the third parameter to `Raygun.track_exception` to have affected user tracking for manually tracked exceptions, see the above link for more information on configuring this ([#106](https://github.com/MindscapeHQ/raygun4ruby/pull/106))
+  - If the exception instance responds to `:raygun_custom_data` that method will be called and the return value merged into the `custom_data` hash sent to Raygun. For convenience a `Raygun::Error` class is provided that takes this custom data as a second argument ([#101](https://github.com/MindscapeHQ/raygun4ruby/pull/101))
+  - Allowed `Configuration.custom_data` to be set to a proc to allow a global custom data hook for all exceptions. It is passed as arguments the exception and the environment hash ([#108](https://github.com/MindscapeHQ/raygun4ruby/pull/108))
+  - Added `Configuration.debug` to enable logging the reason why an exception was not reported ([#109](https://github.com/MindscapeHQ/raygun4ruby/pull/109))
 
 ## 1.2.1 (09/03/2017)
 
 Bugfixes:
-  - dup input hashes before applying whitelist filtering, previously this was modifying the contents of `action_dispatch.request.parameters`
+  - dup input hashes before applying whitelist filtering, previously this was modifying the contents of `action_dispatch.request.parameters` ([#105](https://github.com/MindscapeHQ/raygun4ruby/pull/105))
 
 ## 1.2.0 (09/03/2017)
 
 Features:
-  - Added two new configuration options, `filter_payload_with_whitelist` and `whitelist_payload_shape`
+  - Added two new configuration options, `filter_payload_with_whitelist` and `whitelist_payload_shape` ([#100](https://github.com/MindscapeHQ/raygun4ruby/pull/100))
     - See [README.md](https://github.com/MindscapeHQ/raygun4ruby#filtering-the-payload-by-whitelist) for an example of how to use them
-  - When raygun4ruby encounters an exception trying to track an exception it will try once to send that exception to Raygun so you are notified
+  - When raygun4ruby encounters an exception trying to track an exception it will try once to send that exception to Raygun so you are notified ([#104](https://github.com/MindscapeHQ/raygun4ruby/pull/104))
 
 Bugfixes:
-  - raygun4ruby will no longer crash and suppress app exceptions when the API key is not configured
+  - raygun4ruby will no longer crash and suppress app exceptions when the API key is not configured ([#87](https://github.com/MindscapeHQ/raygun4ruby/pull/87))

data/lib/raygun/client.rb

@@ -132,9 +132,21 @@ module Raygun
       end
 
       def raw_data(rack_env)
+        return unless Raygun.configuration.record_raw_data
+
         request = Rack::Request.new(rack_env)
-        unless request.form_data?
-          form_params(rack_env)
+        input = rack_env['rack.input']
+
+        if input && !request.form_data?
+          current_position = input.pos
+          input.rewind
+
+          body = (input.read || '').slice(0, 4096)
+          input.seek(current_position)
+
+          body
+        else
+          {}
         end
       end
 

data/lib/raygun/configuration.rb

@@ -70,6 +70,10 @@ module Raygun
     # Override this if you wish to connect to a different Raygun API than the standard one
     config_option :api_url
 
+    # Should Raygun include the raw request body in the payload? This will not include
+    # form submissions and will not be filtered by the blacklist
+    config_option :record_raw_data
+
     # Exception classes to ignore by default
     IGNORE_DEFAULT = ['ActiveRecord::RecordNotFound',
                       'ActionController::RoutingError',
@@ -119,7 +123,8 @@ module Raygun
         whitelist_payload_shape:          DEFAULT_WHITELIST_PAYLOAD_SHAPE,
         proxy_settings:                   {},
         debug:                            false,
-        api_url:                          'https://api.raygun.io/'
+        api_url:                          'https://api.raygun.io/',
+        record_raw_data:                  false
       })
     end
 

data/lib/raygun/version.rb

@@ -1,3 +1,3 @@
 module Raygun
-  VERSION = "1.5.0"
+  VERSION = "2.0.0"
 end

data/test/unit/client_test.rb

@@ -29,6 +29,7 @@ class ClientTest < Raygun::UnitTest
   def setup
     super
     @client = Raygun::Client.new
+    Raygun.configuration.record_raw_data = true
     fake_successful_entry
 
     # Force NZ time zone for utcOffset tests
@@ -222,15 +223,36 @@ class ClientTest < Raygun::UnitTest
     assert_equal({}, @client.send(:request_information, nil))
   end
 
-  def test_non_form_parameters
-    put_body_env_hash = sample_env_hash.merge({
-      "REQUEST_METHOD"=>"PUT",
-      "action_dispatch.request.parameters"=> { "a" => "b", "c" => "4945438", "password" => "swordfish" }
+  def test_raw_post_body
+    env_hash = sample_env_hash.merge({
+      "CONTENT_TYPE" => "application/json",
+      "REQUEST_METHOD" => "POST",
+      "rack.input" => StringIO.new('{"foo": "bar"}')
     })
 
-    expected_form_hash = { "a" => "b", "c" => "4945438", "password" => "[FILTERED]" }
+    assert_equal '{"foo": "bar"}', @client.send(:request_information, env_hash)[:rawData]
+  end
+
+  def test_raw_post_body_with_more_than_4096_chars
+    input = "0" * 5000;
+    env_hash = sample_env_hash.merge({
+      "CONTENT_TYPE" => "application/json",
+      "REQUEST_METHOD" => "POST",
+      "rack.input" => StringIO.new(input)
+    })
 
-    assert_equal expected_form_hash, @client.send(:request_information, put_body_env_hash)[:rawData]
+    assert_equal input.slice(0, 4096), @client.send(:request_information, env_hash)[:rawData]
+  end
+
+  def test_raw_post_body_with_config_disabled
+    Raygun.configuration.record_raw_data = false
+    env_hash = sample_env_hash.merge({
+      "CONTENT_TYPE" => "application/json",
+      "REQUEST_METHOD" => "POST",
+      "rack.input" => StringIO.new('{"foo": "bar"}')
+    })
+
+    assert_equal(nil, @client.send(:request_information, env_hash)[:rawData])
   end
 
   def test_error_raygun_custom_data
@@ -461,6 +483,7 @@ class ClientTest < Raygun::UnitTest
     Raygun.configuration.filter_payload_with_whitelist = true
 
     post_body_env_hash = sample_env_hash.merge(
+      "CONTENT_TYPE" => 'application/x-www-form-urlencoded',
       "REQUEST_METHOD" => "POST",
       "rack.input"=>StringIO.new("a=b&c=4945438&password=swordfish")
     )
@@ -475,7 +498,7 @@ class ClientTest < Raygun::UnitTest
       queryString: { },
       headers:     { "Version"=>"HTTP/1.1", "Host"=>"localhost:3000", "Cookie"=>"cookieval" },
       form:        { "a" => "[FILTERED]", "c" => "[FILTERED]", "password" => "[FILTERED]" },
-      rawData:     nil
+      rawData:     {}
     }
 
     assert_equal expected_hash, details[:request]
@@ -506,7 +529,7 @@ class ClientTest < Raygun::UnitTest
       queryString: { },
       headers:     { "Version"=>"HTTP/1.1", "Host"=>"localhost:3000", "Cookie"=>"cookieval" },
       form:        { "username" => "foo", "password" => "[FILTERED]" },
-      rawData:     nil
+      rawData:     {}
     }
 
     assert_equal expected_hash, details[:request]

data/test/unit/configuration_test.rb

@@ -129,4 +129,8 @@ class ConfigurationTest < Raygun::UnitTest
   def test_api_url_default
     assert_equal "https://api.raygun.io/", Raygun.configuration.api_url
   end
+
+  def test_record_raw_data_default
+    assert_equal false, Raygun.configuration.record_raw_data
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raygun4ruby
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Mindscape
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-15 00:00:00.000000000 Z
+date: 2017-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty