rollbar 1.5.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c44f500c23b54909d0aad2fd733826f930cfaf9e
-  data.tar.gz: 93a929d8d6b08b8015848b1a591fa209ddd14161
+  metadata.gz: 4dd960fba2b048a769f6de1c197af1db2b8ac13f
+  data.tar.gz: 40540eb9711481d7340bfe7f2714b9ef2aa59c5d
 SHA512:
-  metadata.gz: f4a82ff17e2d2ee1f4bc65aef0be7c2ad1fcccc1b4129b91916c22cb67aa53b2b013f1480f895cc0219f70d516ea6f0a75c83b25dc2d4f5c656f33d2cf5f8e88
-  data.tar.gz: ff01f87388099db81156bd5a2c83587dcb4eeab5bd3a72da42db76422bf313fc73c4ad6b0fe5690485d6e0d1de835f81462a7f146003abd529dfbc4b2d714f95
+  metadata.gz: 8146d9676a4979c7d08f18cbb84559426168c769a5b08e61539e2421409a559563bd7dc4fba94da92f57ad347840d557398e75da9c1b3c5f31c9fa899024b66e
+  data.tar.gz: 322436eea5226b598a8988776c80e68886c429c5d021e2136ca45c6521eaaad235bda9d13259d611719172368ab77c8484e815391ffa8926400c1e5d3c869cd2

data/.gitignore

@@ -19,3 +19,4 @@ test/tmp
 test/version_tmp
 tmp
 *.swp
+.idea/

data/.travis.yml

@@ -1,4 +1,6 @@
 sudo: false
+services:
+  - redis-server
 language: ruby
 # Broken bundler on travis CI - https://github.com/bundler/bundler/issues/2784
 before_install:
@@ -15,17 +17,79 @@ rvm:
   - jruby-19mode
   - jruby-head
   - rbx
+jdk:
+  - openjdk6
+  - openjdk7
+  - oraclejdk7
+  - oraclejdk8
 env:
   - SKIP_DUMMY_ROLLBAR=true
   - SKIP_DUMMY_ROLLBAR=false
+gemfile:
+  - gemfiles/rails30.gemfile
+  - gemfiles/rails31.gemfile
+  - gemfiles/rails32.gemfile
+  - gemfiles/rails40.gemfile
+  - gemfiles/rails41.gemfile
 matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-18mode
-    - rvm: jruby-19mode
     - rvm: jruby-head
-    - rvm: rbx
+
+    # NOTE: Allowing this to fail because of some strange error in rspec-core `undefined method `example_group_finished'`.
+    # Seems to work with oraclejdk7.
+    - rvm: jruby-19mode
+      jdk: openjdk7
+      env: SKIP_DUMMY_ROLLBAR=false
+
   exclude:
+    # Don't run tests for non-jruby environments with the JDK.
+    # NOTE: openjdk7 is missing from these exclusions so that Travis will run at least 1 build for the given rvm.
+    - rvm: 1.8.7
+      jdk: openjdk6
+    - rvm: 1.8.7
+      jdk: oraclejdk7
+    - rvm: 1.8.7
+      jdk: oraclejdk8
+    - rvm: 1.9.2
+      jdk: openjdk6
+    - rvm: 1.9.2
+      jdk: oraclejdk7
+    - rvm: 1.9.2
+      jdk: oraclejdk8
+    - rvm: 1.9.3
+      jdk: openjdk6
+    - rvm: 1.9.3
+      jdk: oraclejdk7
+    - rvm: 1.9.3
+      jdk: oraclejdk8
+    - rvm: 2.0.0
+      jdk: openjdk6
+    - rvm: 2.0.0
+      jdk: oraclejdk7
+    - rvm: 2.0.0
+      jdk: oraclejdk8
+    - rvm: 2.1.0
+      jdk: openjdk6
+    - rvm: 2.1.0
+      jdk: oraclejdk7
+    - rvm: 2.1.0
+      jdk: oraclejdk8
+    - rvm: ruby-head
+      jdk: openjdk6
+    - rvm: ruby-head
+      jdk: oraclejdk7
+    - rvm: ruby-head
+      jdk: oraclejdk8
+    - rvm: rbx
+      jdk: openjdk6
+    - rvm: rbx
+      jdk: oraclejdk7
+    - rvm: rbx
+      jdk: oraclejdk8
+
+    # TODO: comment as to why these are excluded
     - rvm: 1.8.7
       gemfile: gemfiles/rails40.gemfile
     - rvm: 1.8.7
@@ -84,9 +148,3 @@ matrix:
       gemfile: gemfiles/rails40.gemfile
     - rvm: rbx
       gemfile: gemfiles/rails41.gemfile
-gemfile:
-  - gemfiles/rails30.gemfile
-  - gemfiles/rails31.gemfile
-  - gemfiles/rails32.gemfile
-  - gemfiles/rails40.gemfile
-  - gemfiles/rails41.gemfile

data/CHANGELOG.md

@@ -1,10 +1,26 @@
 # Change Log
 
+## 2.0.0
+
+Possibly breaking changes:
+
+- If active_support version < 4.1.0 is installed, this gem will now monkeypatch `BasicSocket#to_json`. This is needed to work around a bug causing JSON serialization to fail when the payload contains a Socket instance. We don't expect this to break anything for anyone, unless you are using active_support version < 4.1.0 and also happened to be relying on the buggy Socket serialization behavior.
+
+Bug fixes:
+
+- Use the JSON gem or native by default. Along with the aforementioned monkeypatch, this fixes the existing bug in active_support < 4.1.0 serializing Socket instances. To disable the monkeypatch, set `config.disable_core_monkey_patch = true`.
+- Add Encoding module, with Encoder and LegacyEncoder classes. This fixes some issues with ISO-8859 strings
+
+Other changes:
+
+- Update README.md and warn about upgrade to capistrano >= 3.1
+- Fix error in code example for custom Async handlers
+
 ## 1.5.3
 
 Bug fixes:
 
-- Run `rollbar-rails-runner` in the context of `Rails` module so we avoid namespace conflitcs. See [#242](https://github.com/rollbar/rollbar-gem/pull/242)
+- Run `rollbar-rails-runner` in the context of `Rails` module so we avoid namespace conflicts. See [#242](https://github.com/rollbar/rollbar-gem/pull/242)
 
 ## 1.5.2
 

data/README.md

@@ -1,4 +1,4 @@
-# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v1.5.3)](https://travis-ci.org/rollbar/rollbar-gem/branches)
+# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v2.0.0)](https://travis-ci.org/rollbar/rollbar-gem/branches)
 
 <!-- RemoveNext -->
 [Rollbar](https://rollbar.com) is an error tracking service for Ruby and other languages. The Rollbar service will alert you of problems with your code and help you understand them in a ways never possible before. We love it and we hope you will too.
@@ -12,7 +12,7 @@ This is the Ruby library for Rollbar. It will instrument many kinds of Ruby appl
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rollbar', '~> 1.5.3'
+gem 'rollbar', '~> 2.0.0
 ```
 
 And then execute:
@@ -121,13 +121,13 @@ begin
 rescue NoMethodError => e
   # simple exception report (level can be 'debug', 'info', 'warning', 'error' and 'critical')
   Rollbar.log('error', e)
-  
+
   # same functionality as above
   Rollbar.error(e)
-  
+
   # with a description
   Rollbar.error(e, 'The user info hash doesn\'t contain the correct data')
-  
+
   # with extra data giving more insight about the exception
   Rollbar.error(e, :user_info => user_info, :job_id => job_id)
 end
@@ -154,7 +154,7 @@ after_validation :report_validation_errors_to_rollbar
 
 ### Advanced usage
 
-You can use `Rollbar.scope()` to copy a notifier instance and customize the payload data for one-off reporting. The hash argument to `scope()` will be merged into the copied notifier's "payload options", a hash that will be merged into the final payload just before it is reported to Rollbar. 
+You can use `Rollbar.scope()` to copy a notifier instance and customize the payload data for one-off reporting. The hash argument to `scope()` will be merged into the copied notifier's "payload options", a hash that will be merged into the final payload just before it is reported to Rollbar.
 
 For example:
 
@@ -504,7 +504,7 @@ config.use_thread
 You can supply your own handler using ```config.async_handler```. The object to set for `async_handler` should respond to `#call` and receive the payload. The handler should schedule the payload for later processing (i.e. with a delayed_job, in a resque queue, etc.) and should itself return immediately. For example:
 
 ```ruby
-config.use_async
+config.use_async = true
 config.async_handler = Proc.new { |payload|
   Thread.new { Rollbar.process_payload_safely(payload) }
 }
@@ -590,6 +590,8 @@ set :rollbar_env, Proc.new { fetch :stage }
 set :rollbar_role, Proc.new { :app }
 ```
 
+NOTE: We've seen problems with Capistrano version `3.0.x` where the revision reported is incorrect. Version `3.1.0` and higher works correctly.
+
 ### Capistrano 2
 
 Add the following to ```deploy.rb```:
@@ -665,6 +667,14 @@ require 'json'
 MultiJson.use(:json_common)
 ```
 
+If you are using jRuby with Oracle and JDK7, you may be expecting some errors sending reports to our API. This is caused by a bug in that JDK and the primer number used in the SSL algorithm. In order to fix this you can set the next configuration:
+
+```ruby
+Rollbar.configure do|config|
+  config.endpoint = 'https://api-alt.rollbar.com/api/1/item/'
+end
+```
+
 
 ## Help / Support
 

data/lib/generators/rollbar/templates/initializer.rb

@@ -2,21 +2,22 @@ require 'rollbar/rails'
 Rollbar.configure do |config|
   # Without configuration, Rollbar is enabled in all environments.
   # To disable in specific environments, set config.enabled=false.
-  <% if (defined? EY::Config) %>
+  
+<%- if (defined? EY::Config) -%>
   # Here we'll disable in 'test' and 'development':
   if Rails.env.test? or Rails.env.development?
     config.enabled = false
   else
     config.access_token = EY::Config.get('rollbar', 'ROLLBAR_ACCESS_TOKEN')
   end
-  <% else %>
+<%- else -%>
   config.access_token = <%= access_token_expr %>
 
   # Here we'll disable in 'test':
   if Rails.env.test?
     config.enabled = false
   end
-  <% end %>
+<%- end -%>
 
   # By default, Rollbar will try to call the `current_user` controller method
   # to fetch the logged-in user object, and then call that object's `id`,

data/lib/rollbar.rb

@@ -2,7 +2,6 @@ require 'net/https'
 require 'socket'
 require 'thread'
 require 'uri'
-require 'multi_json'
 require 'forwardable'
 
 begin
@@ -11,7 +10,9 @@ rescue LoadError
 end
 
 require 'rollbar/version'
+require 'rollbar/json'
 require 'rollbar/configuration'
+require 'rollbar/encoding'
 require 'rollbar/logger_proxy'
 require 'rollbar/exception_reporter'
 require 'rollbar/util'
@@ -20,10 +21,6 @@ require 'rollbar/delay/girl_friday'
 require 'rollbar/delay/thread'
 require 'rollbar/truncation'
 
-unless ''.respond_to? :encode
-  require 'iconv'
-end
-
 module Rollbar
   ATTACHMENT_CLASSES = %w[
     ActionDispatch::Http::UploadedFile
@@ -444,28 +441,7 @@ module Rollbar
     end
 
     def enforce_valid_utf8(payload)
-      normalizer = lambda do |object|
-        is_symbol = object.is_a?(Symbol)
-
-        return object unless object == object.to_s || is_symbol
-
-        value = object.to_s
-
-        if value.respond_to? :encode
-          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
-
-        is_symbol ? encoded_value.to_sym : encoded_value
-      end
+      normalizer = lambda { |object| Encoding.encode(object) }
 
       Rollbar::Util.iterate_and_update(payload, normalizer)
     end
@@ -508,7 +484,7 @@ module Rollbar
 
     def send_payload(payload)
       log_info '[Rollbar] Sending payload'
-      payload = MultiJson.load(payload) if payload.is_a?(String)
+      payload = Rollbar::JSON.load(payload) if payload.is_a?(String)
 
       if configuration.use_eventmachine
         send_payload_using_eventmachine(payload)
@@ -648,7 +624,7 @@ module Rollbar
         rescue
           next unless handler == failover_handlers.last
 
-          log_error "[Rollbar] All failover handlers failed while processing payload: #{MultiJson.dump(payload)}"
+          log_error "[Rollbar] All failover handlers failed while processing payload: #{Rollbar::JSON.dump(payload)}"
         end
       end
     end
@@ -660,10 +636,10 @@ module Rollbar
       result = Truncation.truncate(stringified_payload)
       return result unless Truncation.truncate?(result)
 
-      original_size = MultiJson.dump(payload).bytesize
+      original_size = Rollbar::JSON.dump(payload).bytesize
       final_size = result.bytesize
       send_failsafe("Could not send payload due to it being too large after truncating attempts. Original size: #{original_size} Final size: #{final_size}", nil)
-      log_error "[Rollbar] Payload too large to be sent: #{MultiJson.dump(payload)}"
+      log_error "[Rollbar] Payload too large to be sent: #{Rollbar::JSON.dump(payload)}"
 
       nil
     end
@@ -710,14 +686,17 @@ module Rollbar
 
       yield(configuration)
 
+      configure_json_backend
       require_hooks
-      # This monkey patch is always needed in order
-      # to use Rollbar.scoped
-      require 'rollbar/core_ext/thread'
+      require_core_extensions
 
       reset_notifier!
     end
 
+    def configure_json_backend
+      Rollbar::JSON.setup
+    end
+
     def reconfigure
       @configuration = Configuration.new
       @configuration.enabled = true
@@ -750,6 +729,28 @@ module Rollbar
       require 'rollbar/better_errors' if defined?(BetterErrors)
     end
 
+    def require_core_extensions
+      # This monkey patch is always needed in order
+      # to use Rollbar.scoped
+      require 'rollbar/core_ext/thread'
+
+      return if configuration.disable_core_monkey_patch
+
+      # Needed to avoid active_support (< 4.1.0) bug serializing JSONs
+      require 'rollbar/core_ext/basic_socket' if monkey_patch_socket?
+    end
+
+    def monkey_patch_socket?
+      return false unless defined?(ActiveSupport::VERSION::STRING)
+
+      major, minor = ActiveSupport::VERSION::STRING.split('.').map(&:to_i)
+
+      return true if major == 3
+      return true if major == 4 && minor == 0
+
+      false
+    end
+
     def wrap_delayed_worker
       return unless defined?(Delayed) && defined?(Delayed::Worker) && configuration.delayed_job_enabled
 

data/lib/rollbar/configuration.rb

@@ -11,6 +11,7 @@ module Rollbar
     attr_accessor :delayed_job_enabled
     attr_accessor :default_logger
     attr_accessor :disable_monkey_patch
+    attr_accessor :disable_core_monkey_patch
     attr_accessor :dj_threshold
     attr_accessor :enabled
     attr_accessor :endpoint
@@ -53,6 +54,7 @@ module Rollbar
       @default_logger = lambda { Logger.new(STDERR) }
       @delayed_job_enabled = true
       @disable_monkey_patch = false
+      @disable_core_monkey_patch = false
       @dj_threshold = 0
       @enabled = nil  # set to true when configure is called
       @endpoint = DEFAULT_ENDPOINT

data/lib/rollbar/core_ext/basic_socket.rb

@@ -0,0 +1,7 @@
+require 'socket'
+
+class BasicSocket
+  def as_json
+    to_s
+  end
+end

data/lib/rollbar/encoding.rb

@@ -0,0 +1,21 @@
+module Rollbar
+  module Encoding
+    def self.encode(object)
+      can_be_encoded = object.is_a?(Symbol) || object.is_a?(String)
+
+      return object unless can_be_encoded
+
+      encoding_class.new(object).encode
+    end
+
+    def self.encoding_class
+      if String.instance_methods.include?(:encode)
+        require 'rollbar/encoding/encoder'
+        Encoder
+      else
+        require 'rollbar/encoding/legacy_encoder'
+        LegacyEncoder
+      end
+    end
+  end
+end

data/lib/rollbar/encoding/encoder.rb

@@ -0,0 +1,54 @@
+module Rollbar
+  module Encoding
+    class Encoder
+      ALL_ENCODINGS = [::Encoding::UTF_8, ::Encoding::ISO_8859_1, ::Encoding::ASCII_8BIT, ::Encoding::US_ASCII]
+      ASCII_ENCODINGS = [::Encoding::US_ASCII, ::Encoding::ASCII_8BIT, ::Encoding::ISO_8859_1]
+      ENCODING_OPTIONS = { :invalid => :replace, :undef => :replace, :replace => '' }
+
+      attr_accessor :object
+
+      def initialize(object)
+        @object = object
+      end
+
+      def encode
+        value = object.to_s
+
+        encoded_value = force_encoding(value).encode(*encoding_args(value))
+
+        object.is_a?(Symbol) ? encoded_value.to_sym : encoded_value
+      end
+
+      private
+
+      def force_encoding(value)
+        return value if value.frozen?
+
+        value.force_encoding(detect_encoding(value)) if value.encoding == ::Encoding::UTF_8
+
+        value
+      end
+
+      def detect_encoding(v)
+        value = v.dup
+
+        ALL_ENCODINGS.detect do |encoding|
+          begin
+            value.force_encoding(encoding).encode(::Encoding::UTF_8).codepoints
+            true
+          rescue
+            false
+          end
+        end
+      end
+
+      def encoding_args(value)
+        args = ['UTF-8']
+        args << 'binary' if ASCII_ENCODINGS.include?(value.encoding)
+        args << ENCODING_OPTIONS
+
+        args
+      end
+    end
+  end
+end