rollbar 0.11.8 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e34c12766fca0c2c51b5d6259d61bd885d694363
-  data.tar.gz: cd6a924aec8457baed0c13ebd42a0fdc74510d1c
+  metadata.gz: d821880871796e7a3f286f28efed45d344e58f7a
+  data.tar.gz: 3e955416377adb50366976787a1b96f8fe0f7267
 SHA512:
-  metadata.gz: 89089b7cdb5258f4b1213f9bcea22e6935833572726a7719e0fa031a030a98d25a4fa8f5fb559f441e4d302e10d3b0d35f6fb385b6ae2dd43c92f1255b39d55d
-  data.tar.gz: 2afcf44b731cd0afa68ba8200e3bab04c38da570b5420296fba3dbbf88a883b52c0db2ac86d2c5a969e984a204c74750826fc8c15fb881f547fe2eccec8202e3
+  metadata.gz: f524945b9cddd9a18ef5a346d0416475c12d257dde63598a49514d3601e24e773e7b8705d434a9d5cc77a97b2c5b2df676f80aa0fe26264f40771d33e2d25c77
+  data.tar.gz: 093270b5b4852101b26196e287c92be720cdb02e1c198b29397b977c1db249115484024670b59b31501b1ed34871be756b968655a15cdfbac606aedebdae2ff4

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+**0.12.0**
+- Added [#73](https://github.com/rollbar/rollbar-gem/pull/73), enhanced Sidekiq and SuckerPunch configuration. NOTE: The old `Rollbar::Configuration#use_sidekiq=` and `Rollbar::Configuration#use_sucker_punch=` methods are now depricated, see the docs for updated usage information.
+
 **0.11.8**
 - Make sure the person method exists for the controller before trying to extract person data
 

data/README.md

@@ -206,7 +206,7 @@ Asynchronous reporting falls back to Threading if girl_friday is not installed.
 Add the following in ```config/initializers/rollbar.rb```:
 
 ```ruby
-config.use_sucker_punch = true
+config.use_sucker_punch
 ```
 
 ### Using Sidekiq
@@ -214,13 +214,13 @@ config.use_sucker_punch = true
 Add the following in ```config/initializers/rollbar.rb```:
 
 ```ruby
-config.use_sidekiq = true
+config.use_sidekiq
 ```
 
 You can also supply custom Sidekiq options:
 
 ```ruby
-config.use_sidekiq = { 'queue' => 'my_queue' }
+config.use_sidekiq { 'queue' => 'my_queue' }
 ```
 
 Start the redis server:

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

@@ -41,10 +41,10 @@ Rollbar.configure do |config|
   # }
 
   # Enable asynchronous reporting (using sucker_punch)
-  # config.use_sucker_punch = true
+  # config.use_sucker_punch
 
   # Enable delayed reporting (using Sidekiq)
-  # config.use_sidekiq = true
+  # config.use_sidekiq
   # You can supply custom Sidekiq options:
-  # config.use_sidekiq = { 'queue' => 'my_queue' }
+  # config.use_sidekiq { 'queue' => 'my_queue' }
 end

data/lib/rollbar/configuration.rb

@@ -63,21 +63,31 @@ module Rollbar
       @write_to_file = false
     end
 
+    def use_sidekiq(options = {})
+      require 'rollbar/delay/sidekiq' if defined?(Sidekiq)
+      @use_async      = true
+      @use_sidekiq    = true
+      @async_handler  = Rollbar::Delay::Sidekiq.new(options)
+    end
+
     def use_sidekiq=(value)
-      if value
-        require 'rollbar/delay/sidekiq' if defined?(Sidekiq)
-        @use_async      = true
-        @use_sidekiq    = value
-        @async_handler  = Rollbar::Delay::Sidekiq.method(:handle)
-      end
+      deprecation_message = "#use_sidekiq=(value) has been deprecated in favor of #use_sidekiq(options = {}). Please update your rollbar configuration."
+      defined?(ActiveSupport) ? ActiveSupport::Deprecation.warn(deprecation_message) : puts(deprecation_message)
+
+      value.is_a?(Hash) ? use_sidekiq(value) : use_sidekiq
+    end
+
+    def use_sucker_punch
+      require 'rollbar/delay/sucker_punch' if defined?(SuckerPunch)
+      @use_async      = true
+      @async_handler  = Rollbar::Delay::SuckerPunch.new
     end
 
     def use_sucker_punch=(value)
-      if value
-        require 'rollbar/delay/sucker_punch' if defined?(SuckerPunch)
-        @use_async      = true
-        @async_handler  = Rollbar::Delay::SuckerPunch.method(:handle)
-      end
+      deprecation_message = "#use_sucker_punch=(value) has been deprecated in favor of #use_sucker_punch. Please update your rollbar configuration."
+      defined?(ActiveSupport) ? ActiveSupport::Deprecation.warn(deprecation_message) : puts(deprecation_message)
+
+      use_sucker_punch
     end
 
     def use_eventmachine=(value)

data/lib/rollbar/delay/sidekiq.rb

@@ -5,10 +5,12 @@ module Rollbar
     class Sidekiq
       OPTIONS = { 'queue' => 'rollbar', 'class' => self.name }.freeze
 
-      def self.handle(payload)
-        item = Rollbar.configuration.use_sidekiq.is_a?(Hash) ? OPTIONS.merge(Rollbar.configuration.use_sidekiq) : OPTIONS
+      def initialize(*args)
+        @options = (opts = args.shift) ? OPTIONS.merge(opts) : OPTIONS
+      end
 
-        ::Sidekiq::Client.push item.merge('args' => [payload])
+      def call(payload)
+        ::Sidekiq::Client.push @options.merge('args' => [payload])
       end
 
       include ::Sidekiq::Worker

data/lib/rollbar/delay/sucker_punch.rb

@@ -3,13 +3,13 @@ require 'sucker_punch'
 module Rollbar
   module Delay
     class SuckerPunch
-      def self.handle(payload)
-        @@sucker_punch_worker ||= self.new
-        @@sucker_punch_worker.async.perform payload
-      end
 
       include ::SuckerPunch::Job
 
+      def call(payload)
+        async.perform payload
+      end
+
       def perform(*args)
         Rollbar.process_payload(*args)
       end

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = "0.11.8"
+  VERSION = "0.12.0"
 end

data/spec/delay/sidekiq_spec.rb

@@ -2,39 +2,60 @@ require 'spec_helper'
 
 begin
   require 'rollbar/delay/sidekiq'
+  require 'sidekiq/testing'
 rescue LoadError
+  module Rollbar
+    module Delay
+      class Sidekiq
+      end
+    end
+  end
 end
 
-if defined?(Sidekiq)
-  describe Rollbar::Delay::Sidekiq do
-    before(:each) do
-      reset_configuration
+describe Rollbar::Delay::Sidekiq, :if => RUBY_VERSION != '1.8.7' do
+  let(:payload) { anything }
+
+  describe "#perform" do
+    it "performs payload" do
+      Rollbar.should_receive(:process_payload).with(payload)
+      subject.perform payload
     end
-  
-    describe ".handler" do
-      let(:payload) { anything }
-  
-      context "with default options" do
-        before { Rollbar.configuration.use_sidekiq = true }
-  
-        it "enqueues to default queue" do
-          ::Sidekiq::Client.should_receive(:push).with(Rollbar::Delay::Sidekiq::OPTIONS.merge('args' => payload))
-          Rollbar::Delay::Sidekiq.handle(payload)
-        end
+  end
+
+  describe "#call" do
+    shared_examples "a Rollbar processor" do
+
+      it "processes payload" do
+        Rollbar.should_receive(:process_payload).with(payload)
+
+        subject.call payload
+        described_class.drain
       end
-  
-      context "with custom options" do
-        let(:custom_config) { { 'queue' => 'custom_queue' } }
-  
-        before { Rollbar.configuration.use_sidekiq = custom_config }
-  
-        it "enqueues to custom queue" do
-          options = Rollbar::Delay::Sidekiq::OPTIONS.merge(custom_config.merge('args' => payload))
-          ::Sidekiq::Client.should_receive(:push).with options
-  
-          Rollbar::Delay::Sidekiq.handle(payload)
-        end
+    end
+
+    context "with default options" do
+      it "enqueues to default queue" do
+        options = Rollbar::Delay::Sidekiq::OPTIONS.merge('args' => payload)
+        ::Sidekiq::Client.should_receive(:push).with options
+
+        subject.call payload
       end
+
+      it_behaves_like "a Rollbar processor"
+    end
+
+    context "with custom options" do
+      let(:custom_config) { { 'queue' => 'custom_queue' } }
+      subject { Rollbar::Delay::Sidekiq.new custom_config }
+
+      it "enqueues to custom queue" do
+        options = Rollbar::Delay::Sidekiq::OPTIONS.merge(custom_config.merge('args' => payload))
+        ::Sidekiq::Client.should_receive(:push).with options
+
+        subject.call payload
+      end
+
+      it_behaves_like "a Rollbar processor"
     end
   end
-end
+end

data/spec/delay/sucker_punch_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+begin
+  require 'rollbar/delay/sucker_punch'
+  require 'sucker_punch/testing/inline'
+rescue LoadError
+  module Rollbar
+    module Delay
+      class SuckerPunch
+      end
+    end
+  end
+end
+
+describe Rollbar::Delay::SuckerPunch, :if => RUBY_VERSION != '1.8.7' do
+  describe "#call" do
+    let(:payload) { "anything" }
+
+    it "performs asynchronously the task" do
+      Rollbar.should_receive(:process_payload)
+
+      subject.call payload
+    end
+  end
+end

data/spec/rollbar_spec.rb

@@ -370,18 +370,18 @@ describe Rollbar do
       end
     end
 
-    if defined?(SuckerPunch)
+    describe "#use_sucker_punch", :if => defined?(SuckerPunch) do
       it "should send the payload to sucker_punch delayer" do
         logger_mock.should_receive(:info).with('[Rollbar] Scheduling payload')
         logger_mock.should_receive(:info).with('[Rollbar] Sending payload')
         logger_mock.should_receive(:info).with('[Rollbar] Success')
-  
+
         Rollbar.configure do |config|
-          config.use_sucker_punch = true
+          config.use_sucker_punch
         end
-  
+
         Rollbar.report_exception(@exception)
-  
+
         Rollbar.configure do |config|
           config.use_async = false
           config.async_handler = Rollbar.method(:default_async_handler)
@@ -389,25 +389,28 @@ describe Rollbar do
       end
     end
 
-    it "should send the payload to sidekiq delayer" do
-      module Rollbar
-        module Delay
-          class Sidekiq
-          end
-        end
+    describe "#use_sidekiq", :if => defined?(Sidekiq) do
+      it "should instanciate sidekiq delayer with custom values" do
+        Rollbar::Delay::Sidekiq.should_receive(:new).with('queue' => 'test_queue')
+        config = Rollbar::Configuration.new
+        config.use_sidekiq 'queue' => 'test_queue'
       end
 
-      Rollbar::Delay::Sidekiq.should_receive(:handle).with(anything)
+      it "should send the payload to sidekiq delayer" do
+        handler = double('sidekiq_handler_mock')
+        handler.should_receive(:call)
 
-      Rollbar.configure do |config|
-        config.use_sidekiq = { 'queue' => 'test_queue' }
-      end
+        Rollbar.configure do |config|
+          config.use_sidekiq
+          config.async_handler = handler
+        end
 
-      Rollbar.report_exception(@exception)
+        Rollbar.report_exception(@exception)
 
-      Rollbar.configure do |config|
-        config.use_async = false
-        config.async_handler = Rollbar.method(:default_async_handler)
+        Rollbar.configure do |config|
+          config.use_async = false
+          config.async_handler = Rollbar.method(:default_async_handler)
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 0.11.8
+  version: 0.12.0
 platform: ruby
 authors:
 - Brian Rue
@@ -171,6 +171,7 @@ files:
 - rollbar.gemspec
 - spec/controllers/home_controller_spec.rb
 - spec/delay/sidekiq_spec.rb
+- spec/delay/sucker_punch_spec.rb
 - spec/dummyapp/.gitignore
 - spec/dummyapp/Rakefile
 - spec/dummyapp/app/assets/javascripts/application.js
@@ -252,6 +253,7 @@ summary: Reports exceptions to Rollbar
 test_files:
 - spec/controllers/home_controller_spec.rb
 - spec/delay/sidekiq_spec.rb
+- spec/delay/sucker_punch_spec.rb
 - spec/dummyapp/.gitignore
 - spec/dummyapp/Rakefile
 - spec/dummyapp/app/assets/javascripts/application.js