rollbar 1.4.5 → 1.5.0

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## 1.5.0
+
+Bug fixes:
+
+- Fixed support for extended unicode characters. See [#234](https://github.com/rollbar/rollbar-gem/pull/234)
+
+Possible breaking changes:
+
+- Some characters that previously were stripped are now encoded. This could cause some events to be grouped into new items by Rollbar.
+
+
 ## 1.4.5
 
 Bug fixes:

data/README.md

@@ -1,4 +1,4 @@
-# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v1.4.5)](https://travis-ci.org/rollbar/rollbar-gem/branches)
+# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v1.5.0)](https://travis-ci.org/rollbar/rollbar-gem/branches)
 
 <!-- RemoveNext -->
 Ruby gem for reporting exceptions, errors, and log messages to [Rollbar](https://rollbar.com).
@@ -9,7 +9,7 @@ Ruby gem for reporting exceptions, errors, and log messages to [Rollbar](https:/
 
 Add this line to your application's Gemfile:
 
-    gem 'rollbar', '~> 1.4.5'
+    gem 'rollbar', '~> 1.5.0
 
 And then execute:
 

data/lib/rollbar.rb

@@ -423,7 +423,14 @@ module Rollbar
         value = object.to_s
 
         if value.respond_to? :encode
-          encoded_value = value.encode('UTF-8', 'binary', :invalid => :replace, :undef => :replace, :replace => '')
+          options = { :invalid => :replace, :undef => :replace, :replace => '' }
+          ascii_encodings = [Encoding.find('US-ASCII'), Encoding.find('ASCII-8BIT')]
+
+          args = ['UTF-8']
+          args << 'binary' if ascii_encodings.include?(value.encoding)
+          args << options
+
+          encoded_value = value.encode(*args)
         else
           encoded_value = ::Iconv.conv('UTF-8//IGNORE', 'UTF-8', value)
         end

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = "1.4.5"
+  VERSION = "1.5.0"
 end

data/spec/rollbar_spec.rb

@@ -943,7 +943,7 @@ describe Rollbar do
 
     context 'with invalid utf8 encoding' do
       let(:extra) do
-        { :extra => "bad value 1\255" }
+        { :extra => force_to_ascii("bad value 1\255") }
       end
 
       it 'removes te invalid characteres' do
@@ -1336,27 +1336,40 @@ describe Rollbar do
   end
 
   context 'enforce_valid_utf8' do
+    context 'with utf8 string and ruby > 1.8' do
+      next unless String.instance_methods.include?(:force_encoding)
+
+      let(:payload) { { :foo => 'Изменение' } }
+
+      it 'just returns the same string' do
+        payload_copy = payload.clone
+        notifier.send(:enforce_valid_utf8, payload_copy)
+
+        expect(payload_copy[:foo]).to be_eql('Изменение')
+      end
+    end
+
     it 'should replace invalid utf8 values' do
-      bad_key = "inner \x92bad key"
-      bad_key.force_encoding('ASCII-8BIT') if bad_key.respond_to?('force_encoding')
+      bad_key = force_to_ascii("inner \x92bad key")
 
       payload = {
-        :bad_value => "bad value 1\255",
-        :bad_value_2 => "bad\255 value 2",
-        "bad\255 key" => "good value",
+        :bad_value => force_to_ascii("bad value 1\255"),
+        :bad_value_2 => force_to_ascii("bad\255 value 2"),
+        force_to_ascii("bad\255 key") => "good value",
         :hash => {
-          :inner_bad_value => "\255\255bad value 3",
+          :inner_bad_value => force_to_ascii("\255\255bad value 3"),
           bad_key.to_sym => 'inner good value',
-          "bad array key\255" => [
+          force_to_ascii("bad array key\255") => [
             'good array value 1',
-            "bad\255 array value 1\255",
+            force_to_ascii("bad\255 array value 1\255"),
             {
-              :inner_inner_bad => "bad inner \255inner value"
+              :inner_inner_bad => force_to_ascii("bad inner \255inner value")
             }
           ]
         }
       }
 
+
       payload_copy = payload.clone
       notifier.send(:enforce_valid_utf8, payload_copy)
 

data/spec/spec_helper.rb

@@ -17,6 +17,7 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 RSpec.configure do |config|
   config.include(NotifierHelpers)
   config.include(FixtureHelpers)
+  config.include(EncodingHelpers)
 
   config.color_enabled = true
   config.formatter = 'documentation'

data/spec/support/encoding_helpers.rb

@@ -0,0 +1,8 @@
+module EncodingHelpers
+  def force_to_ascii(string)
+    return string unless string.respond_to?('force_encoding')
+
+    string.force_encoding('ASCII-8BIT')
+    string
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-02 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &7871420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *7871420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &7869800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *7869800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &7818380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: 2.14.0
   type: :development
   prerelease: false
-  version_requirements: *7818380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &7817420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *7817420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: girl_friday
-  requirement: &7816620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: 0.11.1
   type: :development
   prerelease: false
-  version_requirements: *7816620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.1
 - !ruby/object:Gem::Dependency
   name: sucker_punch
-  requirement: &7815720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +101,15 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *7815720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: sidekiq
-  requirement: &7814720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +117,15 @@ dependencies:
         version: 2.13.0
   type: :development
   prerelease: false
-  version_requirements: *7814720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: genspec
-  requirement: &7813460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +133,15 @@ dependencies:
         version: 0.2.8
   type: :development
   prerelease: false
-  version_requirements: *7813460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.8
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &7811380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +149,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7811380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &7756540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +165,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7756540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: delayed_job
-  requirement: &7755160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +181,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7755160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &7754120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,7 +197,12 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *7754120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 description: Rails plugin to catch and send exceptions to Rollbar
 email:
 - support@rollbar.com
@@ -287,6 +347,7 @@ files:
 - spec/rollbar_spec.rb
 - spec/spec_helper.rb
 - spec/support/cause_exception.rb
+- spec/support/encoding_helpers.rb
 - spec/support/fixture_helpers.rb
 - spec/support/get_ip_raising.rb
 - spec/support/notifier_helpers.rb
@@ -312,7 +373,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Reports exceptions to Rollbar
@@ -393,6 +454,7 @@ test_files:
 - spec/rollbar_spec.rb
 - spec/spec_helper.rb
 - spec/support/cause_exception.rb
+- spec/support/encoding_helpers.rb
 - spec/support/fixture_helpers.rb
 - spec/support/get_ip_raising.rb
 - spec/support/notifier_helpers.rb