raygun4ruby 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8406d25f885f4bff7478ef400ec6b6533beabeb1
-  data.tar.gz: 0cff5631608f72c7fe29e42b043f0e45a05c0f33
+  metadata.gz: 1b5dc6fa5ba97eb5e725e33957adb0938d497c04
+  data.tar.gz: d8251293800014da04f65d59a7de524310bf0575
 SHA512:
-  metadata.gz: 81aaeb31a3c51c0aab19614aedc0be72ff9bc3b047e54534f665ef296449617e536dcf0f9eae3776609790bed94b776bd3820a28bd7e773a844fce7204b44816
-  data.tar.gz: 33b0cbebc15be4473bbec8db356ccc09138b6fa8d33538bf1394518d96c527e902c442a5fa332678631d66e4d0ef995713b3f091e92431360764b446a9dfe907
+  metadata.gz: a7e838b56806115af7f151908b8323c106677de99764b4fe0a30939cc15e9a529f34193643c3173d02ccd65c60b8492cd96b934f317f3b44f46827463d86a8b1
+  data.tar.gz: 362c3b34876de277572b93e7c4017adee6222839a3e1c711c7cf20181438501d302446d95735c4d8f61b719ae2dbfdc93428ef4ce61276158a6505e0d062854a

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 2.5.0 (04/10/2017)
+
+Features
+  - Teach tags configuration how to handle a proc to allow dynamically settings tags ([#127](https://github.com/MindscapeHQ/raygun4ruby/pull/127))
+
+Bugfixes
+  - Fix crash when recording breadcrumb with uninitialized store ([#126](https://github.com/MindscapeHQ/raygun4ruby/pull/126))
+  - Make raw data handling more robus and fix in unicorn ([#125](https://github.com/MindscapeHQ/raygun4ruby/pull/125))
+  - Backwards compatible affected_user_identifier_methods ([#120](https://github.com/MindscapeHQ/raygun4ruby/pull/120))
+
 ## 2.4.1 (29/08/2017)
 
 Bugfixes

data/README.md

@@ -138,6 +138,7 @@ end
 
 If you are using Sinatra or another rack framework you will need to include the Breadcrumbs middleware, this is used for storing the breadcrumbs during a request
 `use Raygun::Middleware::BreadcrumbsStoreInitializer`
+(this must be before you `use` the `Raygun::Middleware::RackExceptionInterceptor`)
 
 If you are using a non web based Ruby application you will have to call `Raygun::Breadcrumbs::Store.initialize` during your applications boot process. The store is per thread, but I have not tested it in a multi threaded application.
 
@@ -192,13 +193,11 @@ end
 Custom data can be added to `track_exception` by passing a custom_data key in the second parameter hash.
 
 ```ruby
-
 begin
   # more lovely code
 rescue Exception => e
   Raygun.track_exception(e, custom_data: {my: 'custom data', goes: 'here'})
 end
-
 ```
 
 Custom data can also be specified globally either by setting `config.custom_data` to a hash
@@ -320,8 +319,17 @@ end
 
 ### Tags
 
-Raygun allows you to tag error reports with any number of tags. In your Raygun.setup block, set `tags` to an array of strings to have those
-set on any error reports sent by the gem.
+Tags can be added to `track_exception` by passing a tags key in the second parameter hash.
+
+```ruby
+begin
+  # more lovely code
+rescue Exception => e
+  Raygun.track_exception(e, tags: ['my', 'tags', 'go here')
+end
+```
+
+Tags can also be specified globally either by setting `config.custom_data` to an array
 
 ```ruby
 Raygun.setup do |config|
@@ -329,6 +337,17 @@ Raygun.setup do |config|
 end
 ```
 
+or to a proc, which gets passed the exception and environment hash. This proc _must_ return an array of strings
+
+```ruby
+Raygun.setup do |config|
+  config.api_key = "YOUR_RAYGUN_API_KEY"
+  config.tags do |e, env|
+    [env["SERVER_NAME"]]
+  end
+end
+```
+
 ### Resque Error Tracking
 
 Raygun4Ruby also includes a Resque failure backend. You should include it inside your Resque initializer (usually something like `config/initializers/load_resque.rb`)

data/lib/raygun/breadcrumbs/store.rb

@@ -50,6 +50,14 @@ module Raygun
       private
 
       def self.should_record?(crumb)
+        if stored.nil?
+          if Raygun.configuration.debug
+            Raygun.log('[Raygun.breadcrumbs] store is uninitialized while breadcrumb is being recorded, discarding breadcrumb')
+          end
+
+          return false
+        end
+
         levels = Raygun::Breadcrumbs::BREADCRUMB_LEVELS
 
         active_level = levels.index(Raygun.configuration.breadcrumb_level)

data/lib/raygun/client.rb

@@ -132,20 +132,18 @@ module Raygun
       end
 
       def raw_data(rack_env)
+        request = Rack::Request.new(rack_env)
+
         return unless Raygun.configuration.record_raw_data
+        return if request.get?
 
-        request = Rack::Request.new(rack_env)
         input = rack_env['rack.input']
-        return if request.get?
 
-        # If size is 0 the buffer is at best empty and at worst
-        # something like the Puma::NullIO buffer which is missing methods
-        if input && input.size && input.respond_to?(:pos) && !request.form_data?
-          current_position = input.pos
+        if input && !request.form_data?
           input.rewind
 
-          body = (input.read || '').slice(0, 4096)
-          input.seek(current_position)
+          body = input.read(4096) || ''
+          input.rewind
 
           body
         else
@@ -175,6 +173,13 @@ module Raygun
           tags << rack_env
         end
 
+        configuration_tags = []
+        if Raygun.configuration.tags.is_a?(Proc)
+          configuration_tags = Raygun.configuration.tags.call(exception_instance, env)
+        else
+          configuration_tags = Raygun.configuration.tags
+        end
+
         grouping_key = env.delete(:grouping_key)
 
         configuration_custom_data = Raygun.configuration.custom_data
@@ -190,7 +195,7 @@ module Raygun
             client:         client_details,
             error:          error_details(exception_instance),
             userCustomData: exception_custom_data.merge(custom_data).merge(configured_custom_data),
-            tags:           Raygun.configuration.tags.concat(tags).compact.uniq,
+            tags:           configuration_tags.concat(tags).compact.uniq,
             request:        request_information(env),
             environment:    {
               utcOffset: Time.now.utc_offset / 3600

data/lib/raygun/configuration.rb

@@ -35,7 +35,7 @@ module Raygun
     proc_config_option :custom_data
 
     # Tags to send with each exception
-    config_option :tags
+    proc_config_option :tags
 
     # Logger to use when we find an exception :)
     config_option :logger
@@ -163,7 +163,7 @@ module Raygun
 
     def affected_user_identifier_methods
       Raygun.deprecation_warning("Please note: You should now user config.affected_user_method_mapping.Identifier instead of config.affected_user_identifier_methods")
-      read_value(:affected_user_method_mapping).Identifier
+      read_value(:affected_user_mapping)[:identifier]
     end
 
     private

data/lib/raygun/version.rb

@@ -1,3 +1,3 @@
 module Raygun
-  VERSION = "2.4.1"
+  VERSION = "2.5.0"
 end

data/test/unit/client_test.rb

@@ -36,6 +36,14 @@ class ClientTest < Raygun::UnitTest
     ENV['TZ'] = 'UTC-13'
   end
 
+  def test_record_breadcrumb_does_not_crash_without_initialized_store
+    Raygun.record_breadcrumb(
+      message: 'aliens',
+      category: 'exceptions',
+      level: :info
+    )
+  end
+
   def test_api_key_required_message
     Raygun.configuration.api_key = nil
 
@@ -139,6 +147,23 @@ class ClientTest < Raygun::UnitTest
     assert_equal expected_tags, @client.send(:build_payload_hash, test_exception, test_env)[:details][:tags]
   end
 
+  def test_tags_with_proc
+    configuration_tags = %w{bar}
+    explicit_env_tags  = %w{one two three four}
+    rack_env_tag       = %w{test}
+
+    Raygun.setup do |config|
+      config.tags = ->(exception, env) {
+        [env[:foo]]
+      }
+    end
+
+    test_env      = { tags: explicit_env_tags, foo: 'bar' }
+    expected_tags =  configuration_tags + explicit_env_tags + rack_env_tag
+
+    assert_equal expected_tags, @client.send(:build_payload_hash, test_exception, test_env)[:details][:tags]
+  end
+
   def test_hostname
     assert_equal Socket.gethostname, @client.send(:hostname)
   end
@@ -656,21 +681,6 @@ class ClientTest < Raygun::UnitTest
     assert breadcrumbs[0].is_a? Hash
   end
 
-  def test_raw_data_rewinds_and_restores_correctly
-    buffer = StringIO.new('123456789')
-    rack_env = {
-      REQUEST_METHOD: 'POST',
-      'rack.input' => buffer
-    }
-
-    buffer.seek(2)
-
-    raw_data = @client.send(:raw_data, rack_env)
-
-    assert_equal '123456789', raw_data
-    assert_equal buffer.pos, 2
-  end
-
   def test_raw_data_does_not_crash_on_buffer_without_pos
     buffer = StringIO.new('123456789')
     rack_env = {
@@ -682,7 +692,7 @@ class ClientTest < Raygun::UnitTest
 
     raw_data = @client.send(:raw_data, rack_env)
 
-    assert_equal({}, raw_data)
+    assert_equal('123456789', raw_data)
   end
 
   private

data/test/unit/configuration_test.rb

@@ -126,6 +126,22 @@ class ConfigurationTest < Raygun::UnitTest
       Raygun.configuration.custom_data = nil
   end
 
+  def test_setting_tags_to_array
+    Raygun.setup do |c|
+      c.tags = ['test']
+    end
+
+    assert_equal Raygun.configuration.tags, ['test']
+  end
+
+  def test_setting_tags_to_proc
+    Raygun.setup do |c|
+      c.tags = ->(exception, env) {}
+    end
+
+    assert Raygun.configuration.tags.is_a?(Proc)
+  end
+
   def test_api_url_default
     assert_equal "https://api.raygun.io/", Raygun.configuration.api_url
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raygun4ruby
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Mindscape
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-28 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty