rollbar 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e71e17b7e4734a7d1f0ef5b089a35786b962b4e
-  data.tar.gz: 6b91570fd7e15397aa2100e0e2e99339d99544b0
+  metadata.gz: 0ee59f6efb2ed9591c13fd03dd37eeed85c4b4d5
+  data.tar.gz: 65970f20f1642e47866019178365991fafd6f6bf
 SHA512:
-  metadata.gz: 5d768005681a92731a4947f3f8afb7db45cf73f2cc51119495e731dd7cf8fdf3b58c7dc6220e234e47f3dc00acf1c1b50c4870763b7685e6e8ec362f5001cf5d
-  data.tar.gz: 0383bbc528d88144cf755ac2d7042fcb4165faa521d69c58f65f2a2ebb7be1db17dddd98cd5c41187e85fbc8264e20f0cc12555a32bd577725f49d3c2ade2b37
+  metadata.gz: dcb250c0823c101c5b0b29e56b6a05dc7b2cab3f2f20337f9ef4ca6a3b2277f67e5fa266c40b92659bd3f34f4fdfa8479a05c03d8447322f7fec47e976ce633e
+  data.tar.gz: 890c9a76c08386c2322d688e1560427a68e125a18399101a3ca573de152b607b2fafd60cea506af2c5cedcb1df1774d24c2e2bb8025471fc7d9838bac7cc4c30

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change Log
 
+## 2.4.0
+
+Features:
+
+- Allow custom revision name on capistrano integration. See [#312](https://github.com/rollbar/rollbar-gem/pull/312)
+
+Internal changes:
+
+- Restore MultiJson and add custom option modules. Fix #303. See [#304](https://github.com/rollbar/rollbar-gem/pull/304)
+- Don't require rollbar/rails on initializer. See [#310](https://github.com/rollbar/rollbar-gem/pull/310)
+- Fix delayed_job tests for delayed_job >= 4.1. See [#309](https://github.com/rollbar/rollbar-gem/pull/309)
+
+Documentation:
+
+- Change README.md and template to use 'default' Sidekiq queue. See [#306](https://github.com/rollbar/rollbar-gem/pull/306)
+
+Bug fixes:
+
+- Remove better errors hook. This was causing to report twice the errors. See [#313](https://github.com/rollbar/rollbar-gem/pull/300)
+
+
 ## 2.3.0
 
 Internal changes:

data/Gemfile

@@ -11,6 +11,7 @@ gem "racc", :platform => :rbx
 gem "minitest", :platform => :rbx
 gem "rubinius-developer_tools", :platform => :rbx
 gem "rails", "4.2.3"
+gem 'byebug'
 
 gemspec
-gem 'byebug'
+

data/README.md

@@ -1,4 +1,4 @@
-# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v2.3.0)](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.4.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,13 @@ 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', '~> 2.3.0'
+gem 'rollbar', '~> 2.4.0'
+```
+
+If you are not using JRuby we suggest using [Oj](https://github.com/ohler55/oj) for JSON serialization. In order to install Oj you can add this line to your Gemfile:
+
+```ruby
+gem 'oj', '~> 2.12.14'
 ```
 
 And then execute:
@@ -465,10 +471,11 @@ Add the following in ```config/initializers/rollbar.rb```:
 config.use_sidekiq
 ```
 
-You can also supply custom Sidekiq options:
+
+The default Sidekiq queue will be `rollbar` but you can also supply custom Sidekiq options:
 
 ```ruby
-config.use_sidekiq 'queue' => 'my_queue'
+config.use_sidekiq 'queue' => 'default'
 ```
 
 Start the redis server:

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

@@ -1,4 +1,3 @@
-require 'rollbar/rails'
 Rollbar.configure do |config|
   # Without configuration, Rollbar is enabled in all environments.
   # To disable in specific environments, set config.enabled=false.
@@ -56,5 +55,5 @@ Rollbar.configure do |config|
   # Enable delayed reporting (using Sidekiq)
   # config.use_sidekiq
   # You can supply custom Sidekiq options:
-  # config.use_sidekiq 'queue' => 'my_queue'
+  # config.use_sidekiq 'queue' => 'default'
 end

data/lib/rollbar.rb

@@ -740,17 +740,12 @@ module Rollbar
 
       yield(configuration)
 
-      configure_json_backend
       require_hooks
       require_core_extensions
 
       reset_notifier!
     end
 
-    def configure_json_backend
-      Rollbar::JSON.setup
-    end
-
     def reconfigure
       @configuration = Configuration.new
       @configuration.enabled = true
@@ -781,7 +776,6 @@ module Rollbar
       require 'rollbar/goalie' if defined?(Goalie)
       require 'rollbar/rack' if defined?(Rack)
       require 'rollbar/rake' if defined?(Rake)
-      require 'rollbar/better_errors' if defined?(BetterErrors)
     end
 
     def require_core_extensions

data/lib/rollbar/delayed_job.rb

@@ -33,6 +33,12 @@ module Rollbar
       self.wrapped = true
     end
 
+    def self.wrap_worker!
+      self.wrapped = false
+
+      wrap_worker
+    end
+
     def self.around_invoke_job(&block)
       ::Delayed::Worker.lifecycle.around(:invoke_job, &block)
     end

data/lib/rollbar/json.rb

@@ -1,37 +1,64 @@
+require 'multi_json'
+require 'rollbar/json/oj'
+require 'rollbar/json/default'
+
+begin
+  require 'oj'
+rescue LoadError
+end
+
 module Rollbar
   module JSON
     extend self
 
-    attr_accessor :backend_name
-    attr_accessor :dump_method
-    attr_accessor :load_method
+    attr_writer :options_module
+
+    def dump(object)
+      with_adapter { MultiJson.dump(object, adapter_options) }
+    end
+
+    def load(string)
+      with_adapter { MultiJson.load(string, adapter_options) }
+    end
 
-    def load_oj
-      require 'oj'
+    def with_adapter(&block)
+      MultiJson.with_adapter(detect_multi_json_adapter, &block)
+    end
 
-      options = { :mode=> :compat,
-                  :use_to_json => false,
-                  :symbol_keys => false,
-                  :circular => false
-                }
+    def detect_multi_json_adapter
+      options = {}
+      options[:adapter] = :oj if defined?(::Oj)
 
-      self.dump_method = proc { |obj| Oj.dump(obj, options) }
-      self.load_method = proc { |obj| Oj.load(obj, options) }
-      self.backend_name = :oj
+      MultiJson.current_adapter(options)
+    end
 
-      true
+    def adapter_options
+      options_module.options
     end
 
-    def dump(object)
-      dump_method.call(object)
+    def options_module
+      @options_module ||= find_options_module
     end
 
-    def load(string)
-      load_method.call(string)
+    def find_options_module
+      module_name = multi_json_adapter_module_name
+
+      begin
+        const_get(module_name)
+      rescue NameError
+        Default
+      end
     end
 
-    def setup
-      load_oj
+    # MultiJson adapters have this name structure:
+    # "MultiJson::Adapters::{AdapterModule}"
+    #
+    # Ex: MultiJson::Adapters::Oj
+    # Ex: MultiJson::Adapters::JsonGem
+    #
+    # In this method we just get the last module name.
+    def multi_json_adapter_module_name
+      MultiJson.current_adapter.name[/^MultiJson::Adapters::(.*)$/, 1]
     end
   end
 end

data/lib/rollbar/json/default.rb

@@ -0,0 +1,11 @@
+module Rollbar
+  module JSON
+    module Default
+      extend self
+
+      def options
+        {}
+      end
+    end
+  end
+end

data/lib/rollbar/json/oj.rb

@@ -0,0 +1,15 @@
+module Rollbar
+  module JSON
+    module Oj
+      extend self
+
+      def options
+        { :mode=> :compat,
+          :use_to_json => false,
+          :symbol_keys => false,
+          :circular => false
+        }
+      end
+    end
+  end
+end

data/lib/rollbar/rails.rb

@@ -1,22 +1,5 @@
-require 'rollbar'
-
 module Rollbar
   module Rails
-    def self.initialize
-      rails_logger = if defined?(::Rails.logger)
-                       ::Rails.logger
-                     elsif defined?(RAILS_DEFAULT_LOGGER)
-                       RAILS_DEFAULT_LOGGER
-                     end
 
-      Rollbar.preconfigure do |config|
-        config.logger = rails_logger
-        config.environment = defined?(::Rails.env) && ::Rails.env || defined?(RAILS_ENV) && RAILS_ENV
-        config.root = defined?(::Rails.root) && ::Rails.root || defined?(RAILS_ROOT) && RAILS_ROOT
-        config.framework = defined?(::Rails.version) && "Rails: #{::Rails.version}" || defined?(::Rails::VERSION::STRING) && "Rails: #{::Rails::VERSION::STRING}"
-      end
-    end
   end
 end
-
-Rollbar::Rails.initialize

data/lib/rollbar/tasks/rollbar.cap

@@ -14,7 +14,7 @@ namespace :rollbar do
         :local_username => fetch(:rollbar_user),
         :access_token   => fetch(:rollbar_token),
         :environment    => fetch(:rollbar_env),
-        :revision       => fetch(:current_revision) }
+        :revision       => fetch(:rollbar_revision) }
 
       debug "Building Rollbar POST to #{uri} with #{params.inspect}"
 
@@ -36,9 +36,10 @@ end
 
 namespace :load do
   task :defaults do
-    set :rollbar_user,  Proc.new { ENV['USER'] || ENV['USERNAME'] }
-    set :rollbar_env,   Proc.new { fetch :rails_env, 'production' }
-    set :rollbar_token, Proc.new { abort "Please specify the Rollbar access token, set :rollbar_token, 'your token'" }
-    set :rollbar_role,  Proc.new { :app }
+    set :rollbar_user,      Proc.new { ENV['USER'] || ENV['USERNAME'] }
+    set :rollbar_env,       Proc.new { fetch :rails_env, 'production' }
+    set :rollbar_token,     Proc.new { abort "Please specify the Rollbar access token, set :rollbar_token, 'your token'" }
+    set :rollbar_role,      Proc.new { :app }
+    set :rollbar_revision,  Proc.new { fetch :current_revision }
   end
 end

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = "2.3.0"
+  VERSION = "2.4.0"
 end

data/rollbar.gemspec

@@ -1,7 +1,10 @@
 # -*- encoding: utf-8 -*-
 require File.expand_path('../lib/rollbar/version', __FILE__)
 
+
 Gem::Specification.new do |gem|
+  is_jruby = defined?(JRUBY_VERSION) || (defined?(RUBY_ENGINE) && 'jruby' == RUBY_ENGINE)
+
   gem.authors       = ["Rollbar, Inc."]
   gem.email         = ["support@rollbar.com"]
   gem.description   = %q{Easy and powerful exception tracking for Ruby}
@@ -28,5 +31,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'delayed_job'
   gem.add_development_dependency 'rake', '>= 0.9.0'
   gem.add_development_dependency 'redis'
-  gem.add_runtime_dependency     'oj', '~> 2.12.14'
+  gem.add_runtime_dependency     'multi_json'
+  gem.add_development_dependency 'oj', '~> 2.12.14' unless is_jruby
 end

data/spec/controllers/home_controller_spec.rb

@@ -1,12 +1,13 @@
 require 'spec_helper'
 
+
 describe HomeController do
   let(:logger_mock) { double("Rails.logger").as_null_object }
   let(:notifier) { Rollbar.notifier }
 
   before do
     reset_configuration
-    Rollbar::Rails.initialize
+    preconfigure_rails_notifier
     Rollbar.configure do |config|
       config.access_token = 'aaaabbbbccccddddeeeeffff00001111'
       config.logger = logger_mock
@@ -31,7 +32,7 @@ describe HomeController do
 
     it 'should use the default "unspecified" environment if rails env ends up being empty' do
       old_env, ::Rails.env = ::Rails.env, ''
-      Rollbar::Rails.initialize
+      preconfigure_rails_notifier
 
       data = Rollbar.notifier.send(:build_payload, 'error', 'message', nil, nil)
       data['data'][:environment].should == 'unspecified'

data/spec/delayed/backend/test.rb

@@ -14,7 +14,13 @@ module Delayed
       end
 
       def self.worker
-        @worker ||= ::Delayed::Worker.new
+        prepare_worker unless @worker
+
+        @worker
+      end
+
+      def self.prepare_worker
+        @worker = ::Delayed::Worker.new
       end
 
       class Job
@@ -38,7 +44,7 @@ module Delayed
           self.attempts = 0
           self.priority = 0
           self.id = (self.class.id += 1)
-          hash.each { |k, v| send(:"#{k}=", v) }
+          hash.each { |k, v| send("#{k}=", v) }
         end
 
         def self.all

data/spec/dummyapp/config/initializers/rollbar.rb

@@ -1,5 +1,3 @@
-require 'rollbar/rails'
-
 Rollbar.configure do |config|
   config.access_token = 'aaaabbbbccccddddeeeeffff00001111'
   config.request_timeout = 60

data/spec/rollbar/delayed_job_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 require 'delayed_job'
 require 'rollbar/delayed_job'
+require 'delayed/backend/test'
 
 describe Rollbar::Delayed, :reconfigure_notifier => true do
   class FailingJob
@@ -12,9 +13,10 @@ describe Rollbar::Delayed, :reconfigure_notifier => true do
   end
 
   before do
-    Rollbar::Delayed.wrap_worker
-    Delayed::Worker.backend = :test
+    Delayed::Backend::Test.prepare_worker
+    Rollbar::Delayed.wrap_worker!
 
+    Delayed::Worker.backend = :test
     Delayed::Backend::Test::Job.delete_all
   end
 

data/spec/rollbar/json/oj_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+require 'rollbar/json/oj'
+
+describe Rollbar::JSON::Oj do
+  let(:options) do
+    {
+      :mode => :compat,
+      :use_to_json => false,
+      :symbol_keys => false,
+      :circular => false
+    }
+  end
+
+  it 'returns correct options' do
+    expect(described_class.options).to be_eql(options)
+  end
+end

data/spec/rollbar/json_spec.rb

@@ -1,43 +1,108 @@
 require 'spec_helper'
+
+require 'multi_json'
 require 'rollbar/json'
 require 'rollbar/configuration'
 
-describe Rollbar::JSON do
-  before do
-    Rollbar::JSON.setup
+class Rollbar::JSON::MockAdapter
+  def self.options
+    { 'mock' => 'adapter' }
   end
+end
 
-  let(:payload) do
-    { :foo => :bar }
+module MultiJson
+  module Adapters
+    module MockAdapter
+    end
   end
+end
 
-  let(:options) do
-    {
-      :mode => :compat,
-      :use_to_json => false,
-      :symbol_keys => false,
-      :circular => false
-    }
+module MultiJson
+  module Adapters
+    module MissingCustomOptions
+    end
   end
+end
+
+
+describe Rollbar::JSON do
+  let(:payload) do
+    { :foo => :bar }
+  end
+  let(:adapter_options) { { 'option' => 'value' } }
 
   describe '.dump' do
-    it 'has JSON as backend' do
-      expect(Rollbar::JSON.backend_name).to be_eql(:oj)
+    before do
+      allow(described_class).to receive(:adapter_options).and_return(adapter_options)
     end
 
+    it 'calls MultiJson.dump' do
+      expect(::MultiJson).to receive(:dump).once.with(payload, adapter_options)
 
-    it 'calls JSON.generate' do
-      expect(::Oj).to receive(:dump).once.with(payload, options)
-
-      Rollbar::JSON.dump(payload)
+      described_class.dump(payload)
     end
   end
 
   describe '.load' do
+    before do
+      allow(described_class).to receive(:adapter_options).and_return(adapter_options)
+    end
+
     it 'calls MultiJson.load' do
-      expect(::Oj).to receive(:load).once.with(payload, options)
+      expect(::MultiJson).to receive(:load).once.with(payload, adapter_options)
+
+      described_class.load(payload)
+    end
+  end
+
+  describe '.with_adapter' do
+    let(:object) { double(:foo => 'bar') }
+    let(:callback) do
+      proc { object.foo }
+    end
+    let(:adapter) { described_class.detect_multi_json_adapter }
+
+    it 'calls mock.something with an adapter' do
+      expect(MultiJson).to receive(:with_adapter).with(adapter).and_call_original
+      expect(object).to receive(:foo).once
+
+      described_class.with_adapter(&callback)
+    end
+  end
+
+  describe '.detect_multi_json_adapter' do
+    
+  end
+
+  describe '.adapter_options' do
+    it 'calls .options in adapter module' do
+      expect(described_class.options_module).to receive(:options)
+
+      described_class.adapter_options
+    end
+  end
+
+  describe '.options_module' do
+    before { described_class.options_module = nil }
+
+    context 'with a defined rollbar adapter' do
+      let(:expected_adapter) { Rollbar::JSON::MockAdapter }
+
+      it 'returns the correct options' do
+        MultiJson.with_adapter(MultiJson::Adapters::MockAdapter) do
+          expect(described_class.options_module).to be(expected_adapter)
+        end
+      end
+    end
+
+    context 'without a defined rollbar adapter' do
+      let(:expected_adapter) { Rollbar::JSON::Default }
 
-      Rollbar::JSON.load(payload)
+      it 'returns the correct options' do
+        MultiJson.with_adapter(MultiJson::Adapters::MissingCustomOptions) do
+          expect(described_class.options_module).to be(expected_adapter)
+        end
+      end
     end
   end
 end

data/spec/support/notifier_helpers.rb

@@ -10,6 +10,21 @@ module NotifierHelpers
     end
   end
 
+  def preconfigure_rails_notifier
+    rails_logger = if defined?(::Rails.logger)
+                     ::Rails.logger
+                   elsif defined?(RAILS_DEFAULT_LOGGER)
+                     RAILS_DEFAULT_LOGGER
+                   end
+
+    Rollbar.preconfigure do |config|
+      config.logger = rails_logger
+      config.environment = defined?(::Rails.env) && ::Rails.env || defined?(RAILS_ENV) && RAILS_ENV
+      config.root = defined?(::Rails.root) && ::Rails.root || defined?(RAILS_ROOT) && RAILS_ROOT
+      config.framework = defined?(::Rails.version) && "Rails: #{::Rails.version}" || defined?(::Rails::VERSION::STRING) && "Rails: #{::Rails::VERSION::STRING}"
+    end
+  end
+
   def test_access_token
     'bfec94a1ede64984b862880224edd0ed'
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Rollbar, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-17 00:00:00.000000000 Z
+date: 2015-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -185,7 +199,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.12.14
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -224,7 +238,6 @@ files:
 - lib/rollbar.rb
 - lib/rollbar/active_job.rb
 - lib/rollbar/active_record_extension.rb
-- lib/rollbar/better_errors.rb
 - lib/rollbar/capistrano.rb
 - lib/rollbar/capistrano3.rb
 - lib/rollbar/configuration.rb
@@ -242,6 +255,8 @@ files:
 - lib/rollbar/exception_reporter.rb
 - lib/rollbar/goalie.rb
 - lib/rollbar/json.rb
+- lib/rollbar/json/default.rb
+- lib/rollbar/json/oj.rb
 - lib/rollbar/logger_proxy.rb
 - lib/rollbar/middleware/rack/builder.rb
 - lib/rollbar/middleware/rack/test_session.rb
@@ -337,6 +352,7 @@ files:
 - spec/rollbar/delayed_job/job_data.rb
 - spec/rollbar/delayed_job_spec.rb
 - spec/rollbar/encoding/encoder_spec.rb
+- spec/rollbar/json/oj_spec.rb
 - spec/rollbar/json_spec.rb
 - spec/rollbar/logger_proxy_spec.rb
 - spec/rollbar/middleware/rack/builder_spec.rb
@@ -453,6 +469,7 @@ test_files:
 - spec/rollbar/delayed_job/job_data.rb
 - spec/rollbar/delayed_job_spec.rb
 - spec/rollbar/encoding/encoder_spec.rb
+- spec/rollbar/json/oj_spec.rb
 - spec/rollbar/json_spec.rb
 - spec/rollbar/logger_proxy_spec.rb
 - spec/rollbar/middleware/rack/builder_spec.rb

data/lib/rollbar/better_errors.rb

@@ -1,38 +0,0 @@
-require 'better_errors'
-
-module BetterErrors
-  class Middleware
-    alias_method :orig_show_error_page, :show_error_page
-
-    private
-
-    def show_error_page(*args)
-      exception = @error_page.exception
-
-      env = args.first
-      exception_data = nil
-      begin
-        controller = env['action_controller.instance']
-        request_data = controller.rollbar_request_data rescue nil
-        person_data = controller.rollbar_person_data rescue nil
-        exception_data = Rollbar.scope(:request => request_data, :person => person_data).error(exception, :use_exception_level_filters => true)
-      rescue => e
-        Rollbar.log_warning "[Rollbar] Exception while reporting exception to Rollbar: #{e}"
-      end
-
-      # if an exception was reported, save uuid in the env
-      # so it can be displayed to the user on the error page
-      if exception_data.is_a?(Hash)
-        env['rollbar.exception_uuid'] = exception_data[:uuid]
-        Rollbar.log_info "[Rollbar] Exception uuid saved in env: #{exception_data[:uuid]}"
-      elsif exception_data == 'disabled'
-        Rollbar.log_info "[Rollbar] Exception not reported because Rollbar is disabled"
-      elsif exception_data == 'ignored'
-        Rollbar.log_info "[Rollbar] Exception not reported because it was ignored"
-      end
-
-      # now continue as normal
-      orig_show_error_page(*args)
-    end
-  end
-end