bugsnag 4.0.2 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a229f778796995938a5bc4d2e1f6260e8b5ad975
-  data.tar.gz: 2bf93ba3af00b2aa7e1038b2863c0dcab591dbc4
+  metadata.gz: 270f44756bef1cd0216474d1d63bed40fc4bfdb2
+  data.tar.gz: c9848a9c9ab917581749ad1c1e5eb98b97c3c950
 SHA512:
-  metadata.gz: d84f962040e273a06bcc392df1b157445ef31db06772e998fb005f9477e64f5d7ebe89cd96184cc45315cb51bfb1183c84e41ca1104b39db8cc2207f1a9a3356
-  data.tar.gz: 4ebd9be31fe102764c9b9eec6920e8d51685b02669be624470187ee4f3b42884cee2a188a05cfbbe4445c350969169fb52556f0580779093cf4c2a7942bf3748
+  metadata.gz: aa1811e86e5526cb984946fd2b8082bcdf5da3b48aaec1fc62e56f2396cd799b37a23fb35dad30baa771e4ae3824663b4a2551541e079e7ccb46aaa3f5812c1e
+  data.tar.gz: 5fc7427a1f8475b38d8f599d73b624d71d69002c79806be5c133adc146bba0001c00778c0e548896870729c2971299156b2aea27e6965eecef076038784b18c7

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 Changelog
 =========
 
+## 4.1.0 (11 May 2016)
+
+### Enhancements
+
+* Add support for 'block syntax' on Bugsnag.notify calls
+  | [James Smith](https://github.com/loopj)
+  | [#292](https://github.com/bugsnag/bugsnag-ruby/pull/292)
+
+### Fixes
+
+* Trim stacktraces and metadata to ensure payload delivery
+  | [#294](https://github.com/bugsnag/bugsnag-ruby/issues/294)
+  | [#295](https://github.com/bugsnag/bugsnag-ruby/pull/295)
+
 ## 4.0.2 (13 Apr 2016)
 
 ### Fixes

data/CONTRIBUTING.md

@@ -41,3 +41,7 @@ If you're a member of the core team, follow these instructions for releasing bug
     ```
 
 * Update the version running in the bugsnag-website project
+
+### Update docs.bugsnag.com
+
+Update the setup guides for Ruby (and its frameworks) with any new content.

data/README.md

@@ -188,8 +188,17 @@ If you would like to send non-fatal exceptions to Bugsnag, you can call
 Bugsnag.notify(RuntimeError.new("Something broke"))
 ```
 
-Additional data can be sent with exceptions as an options hash as detailed in the [Notification Options](https://github.com/bugsnag/bugsnag-ruby/tree/master/docs/Notification Options.md) documentation, including some [options specific to non-fatal exceptions](https://github.com/bugsnag/bugsnag-ruby/tree/master/docs/Notification Options.md#handled-notification-options).
+Additional information can be attached to a notification using a configuration
+block:
 
+```ruby
+Bugsnag.notify(RuntimeError.new("Something broke")) do |notif|
+  notif.severity = 'warning'
+end
+```
+
+The complete list of available properties is available in
+[the documentation for the `Notification` object](https://github.com/bugsnag/bugsnag-ruby/blob/master/docs/Notification%20Options.md#notification-object)
 
 ### Callbacks
 

data/VERSION

@@ -1 +1 @@
-4.0.2
+4.1.0

data/lib/bugsnag.rb

@@ -53,16 +53,21 @@ module Bugsnag
     end
 
     # Explicitly notify of an exception
-    def notify(exception, overrides=nil, request_data=nil)
+    def notify(exception, overrides=nil, request_data=nil, &block)
       notification = Notification.new(exception, configuration, overrides, request_data)
+
+      yield(notification) if block_given?
+
       notification.deliver
       notification
     end
 
     # Notify of an exception unless it should be ignored
-    def notify_or_ignore(exception, overrides=nil, request_data=nil)
+    def notify_or_ignore(exception, overrides=nil, request_data=nil, &block)
       notification = Notification.new(exception, configuration, overrides, request_data)
 
+      yield(notification) if block_given?
+
       unless notification.ignore?
         notification.deliver
         notification
@@ -74,10 +79,10 @@ module Bugsnag
     # Auto notify of an exception, called from rails and rack exception
     # rescuers, unless auto notification is disabled, or we should ignore this
     # error class
-    def auto_notify(exception, overrides=nil, request_data=nil)
+    def auto_notify(exception, overrides=nil, request_data=nil, &block)
       overrides ||= {}
       overrides.merge!({:severity => "error"})
-      notify_or_ignore(exception, overrides, request_data) if configuration.auto_notify
+      notify_or_ignore(exception, overrides, request_data, &block) if configuration.auto_notify
     end
 
     # Log wrapper

data/lib/bugsnag/helpers.rb

@@ -5,9 +5,9 @@ require 'json' unless defined?(JSON)
 
 module Bugsnag
   module Helpers
-    MAX_STRING_LENGTH = 4096
+    MAX_STRING_LENGTH = 3072
     MAX_PAYLOAD_LENGTH = 128000
-    MAX_ARRAY_LENGTH = 400
+    MAX_ARRAY_LENGTH = 40
     RAW_DATA_TYPES = [Numeric, TrueClass, FalseClass]
 
     # Trim the size of value if the serialized JSON value is longer than is
@@ -17,7 +17,9 @@ module Bugsnag
       return sanitized_value unless payload_too_long?(sanitized_value)
       reduced_value = trim_strings_in_value(sanitized_value)
       return reduced_value unless payload_too_long?(reduced_value)
-      truncate_arrays_in_value(reduced_value)
+      reduced_value = truncate_arrays_in_value(reduced_value)
+      return reduced_value unless payload_too_long?(reduced_value)
+      remove_metadata_from_events(reduced_value)
     end
 
     def self.flatten_meta_data(overrides)
@@ -42,13 +44,11 @@ module Bugsnag
     TRUNCATION_INFO = '[TRUNCATED]'
 
     # Shorten array until it fits within the payload size limit when serialized
-    def self.truncate_arrays(array)
+    def self.truncate_array(array)
       return [] unless array.respond_to?(:slice)
-      array = array.slice(0, MAX_ARRAY_LENGTH)
-      while array.length > 0 and payload_too_long?(array)
-        array = array.slice(0, array.length - 1)
+      array.slice(0, MAX_ARRAY_LENGTH).map do |item|
+        truncate_arrays_in_value(item)
       end
-      array
     end
 
     # Trim all strings to be less than the maximum allowed string length
@@ -101,12 +101,21 @@ module Bugsnag
       when Hash
         truncate_arrays_in_hash(value)
       when Array, Set
-        truncate_arrays(value)
+        truncate_array(value)
       else
         value
       end
     end
 
+    # Remove `metaData` from array of `events` within object
+    def self.remove_metadata_from_events(object)
+      return {} unless object.is_a?(Hash) and object[:events].respond_to?(:map)
+      object[:events].map do |event|
+        event.delete(:metaData) if object.is_a?(Hash)
+      end
+      object
+    end
+
     def self.truncate_arrays_in_hash(hash)
       return {} unless hash.is_a?(Hash)
       hash.each_with_object({}) do |(key, value), reduced_hash|

data/spec/helper_spec.rb

@@ -135,16 +135,28 @@ describe Bugsnag::Helpers do
 
       context "and trimmed strings are not enough" do
         it "truncates long arrays" do
-          value = 100.times.map {|i| SecureRandom.hex(8192) }
+          value = [100.times.map {|i| SecureRandom.hex(8192) }, "a"]
           trimmed_value = Bugsnag::Helpers.trim_if_needed(value)
-          expect(trimmed_value.length).to be > 0
-          trimmed_value.each do |str|
+          expect(trimmed_value.length).to eq 2
+          expect(trimmed_value.first.length).to eq Bugsnag::Helpers::MAX_ARRAY_LENGTH
+          trimmed_value.first.each do |str|
             expect(str.match(/\[TRUNCATED\]$/)).to_not be_nil
             expect(str.length).to eq(Bugsnag::Helpers::MAX_STRING_LENGTH)
           end
 
           expect(::JSON.dump(trimmed_value).length).to be < Bugsnag::Helpers::MAX_PAYLOAD_LENGTH
         end
+
+        it "removes metadata from events" do
+          metadata = Hash[*20000.times.map {|i| [i,i+1]}.flatten]
+          frames = 100.times.map {|i| SecureRandom.hex(4096) }
+          value = {key:"abc", events:[{metaData: metadata, frames: frames, cake: "carrot"}]}
+          trimmed_value = Bugsnag::Helpers.trim_if_needed(value)
+          expect(::JSON.dump(trimmed_value).length).to be < Bugsnag::Helpers::MAX_PAYLOAD_LENGTH
+          expect(trimmed_value[:key]).to eq value[:key]
+          expect(trimmed_value[:events].first.keys.to_set).to eq [:frames, :cake].to_set
+          expect(trimmed_value[:events].first[:metaData]).to be_nil
+        end
       end
     end
   end

data/spec/notification_spec.rb

@@ -335,6 +335,17 @@ describe Bugsnag::Notification do
     }
   end
 
+  it "lets you override severity using block syntax" do
+    Bugsnag.notify(BugsnagTestException.new("It crashed")) do |notification|
+      notification.severity = "info"
+    end
+
+    expect(Bugsnag).to have_sent_notification{ |payload|
+      event = get_event_from_payload(payload)
+      expect(event["severity"]).to eq("info")
+    }
+  end
+
   it "autonotifies errors" do
     Bugsnag.auto_notify(BugsnagTestException.new("It crashed"))
 

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.1.0
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.1.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.8
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby notifier for bugsnag.com
@@ -103,10 +103,10 @@ extra_rdoc_files:
 - README.md
 - CHANGELOG.md
 files:
-- .document
-- .gitignore
-- .rspec
-- .travis.yml
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -181,17 +181,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby notifier for bugsnag.com