ratchetio 0.5.2 → 0.5.3

data/.gitignore

@@ -10,6 +10,7 @@ coverage
 doc/
 log/
 lib/bundler/man
+vendor/bundle
 pkg
 rdoc
 spec/reports

data/.travis.yml

@@ -13,3 +13,4 @@ rvm:
 matrix:
   allow_failures:
     - rvm: ruby-head
+    - rvm: rbx-18mode

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+**0.5.3**
+- Add `Ratchetio.silenced`; which allows disabling reporting for a given block. See README for usage.
+
 **0.5.2**
 - Fix compat issue with delayed_job below version 3. Exceptions raised by delayed_job below version 3 will not be automatically caught; upgrade to v3 or catch and report by hand. 
 

data/README.md

@@ -94,6 +94,16 @@ By default, all exceptions reported through `Ratchetio.report_exception()` are r
 If you'd like to customize this list, see the example code in `config/initializers/ratchetio.rb`. Supported levels: "critical", "error", "warning", "info", "debug", "ignore". Set to "ignore" to cause the exception not to be reported at all.
 
 
+## Silencing exceptions at runtime
+
+If you just want to disable exception reporting for a single block, use `Ratchetio.silenced`:
+
+```ruby
+Ratchetio.silenced {
+  foo = bar  # will not be reported
+}
+```
+
 
 ## Asynchronous reporting
 

data/THANKS

@@ -1,5 +1,6 @@
 Huge thanks to the following contributors (by github username). For the most up-to-date list, see https://github.com/ratchetio/ratchetio-gem/graphs/contributors
 
+arr-ee
 kavu
 mipearson
 trisweb

data/lib/ratchetio/version.rb

@@ -1,3 +1,3 @@
 module Ratchetio
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end

data/lib/ratchetio.rb

@@ -15,9 +15,9 @@ require 'ratchetio/version'
 module Ratchetio
   class << self
     attr_writer :configuration
-    
+
     # Configures the gem.
-    # 
+    #
     # Call on app startup to set the `access_token` (required) and other config params.
     # In a Rails app, this is called by `config/initializers/ratchetio.rb` which is generated
     # with `rails generate ratchetio access-token-here`
@@ -29,7 +29,7 @@ module Ratchetio
     def configure
       yield(configuration)
     end
-    
+
     def reconfigure
       @configuration = Configuration.new
       yield(configuration)
@@ -52,7 +52,7 @@ module Ratchetio
     #   end
     #
     # @param exception [Exception] The exception object to report
-    # @param request_data [Hash] Data describing the request. Should be the result of calling 
+    # @param request_data [Hash] Data describing the request. Should be the result of calling
     #   `ratchetio_request_data`.
     # @param person_data [Hash] Data describing the affected person. Should be the result of calling
     #   `ratchetio_person_data`
@@ -61,13 +61,11 @@ module Ratchetio
         return
       end
 
-      filtered_level = configuration.exception_level_filters[exception.class.name]
-      if filtered_level == 'ignore'
-        # ignored - do nothing
+      if ignored?(exception)
         return
       end
 
-      data = exception_data(exception, filtered_level)
+      data = exception_data(exception, filtered_level(exception))
       data[:request] = request_data if request_data
       data[:person] = person_data if person_data
 
@@ -84,17 +82,17 @@ module Ratchetio
     # @example
     #   Ratchetio.report_message("User login failed", 'info', :user_id => 123)
     #
-    # @param message [String] The message body. This will be used to identify the message within 
-    #   Ratchet. For best results, avoid putting variables in the message body; pass them as 
-    #   `extra_data` instead. 
+    # @param message [String] The message body. This will be used to identify the message within
+    #   Ratchet. For best results, avoid putting variables in the message body; pass them as
+    #   `extra_data` instead.
     # @param level [String] The level. One of: 'critical', 'error', 'warning', 'info', 'debug'
-    # @param extra_data [Hash] Additional data to include alongside the body. Don't use 'body' as 
+    # @param extra_data [Hash] Additional data to include alongside the body. Don't use 'body' as
     #   it is reserved.
     def report_message(message, level = 'info', extra_data = {})
       unless configuration.enabled
         return
       end
-      
+
       data = message_data(message, level, extra_data)
       payload = build_payload(data)
       schedule_payload(payload)
@@ -102,6 +100,21 @@ module Ratchetio
       logger.error "[Ratchet.io] Error reporting message to Ratchet.io: #{e}"
     end
 
+    # Turns off reporting for the given block.
+    #
+    # @example
+    #   Ratchetio.silenced { raise }
+    #
+    # @yield Block which exceptions won't be reported.
+    def silenced
+      begin
+        yield
+      rescue => e
+        e.instance_variable_set(:@_ratchet_do_not_report, true)
+        raise
+      end
+    end
+
     def process_payload(payload)
       begin
         if configuration.write_to_file
@@ -116,9 +129,25 @@ module Ratchetio
 
     private
 
+    def ignored?(exception)
+      if filtered_level(exception) == 'ignore'
+        return true
+      end
+
+      if exception.instance_variable_get(:@_ratchet_do_not_report)
+        return true
+      end
+
+      false
+    end
+
+    def filtered_level(exception)
+      configuration.exception_level_filters[exception.class.name]
+    end
+
     def message_data(message, level, extra_data)
       data = base_data(level)
-      
+
       data[:body] = {
         :message => {
           :body => message.to_s
@@ -126,13 +155,13 @@ module Ratchetio
       }
       data[:body][:message].merge!(extra_data)
       data[:server] = server_data
-      
+
       data
     end
 
     def exception_data(exception, force_level = nil)
       data = base_data
-      
+
       data[:level] = force_level if force_level
 
       # parse backtrace
@@ -159,7 +188,7 @@ module Ratchetio
       }
 
       data[:server] = server_data
-      
+
       data
     end
 
@@ -170,7 +199,7 @@ module Ratchetio
       end
       configuration.logger
     end
-    
+
     def write_payload(payload)
       if configuration.use_async
         @file_semaphore.synchronize {
@@ -180,15 +209,15 @@ module Ratchetio
         do_write_payload(payload)
       end
     end
-    
+
     def do_write_payload(payload)
       logger.info '[Ratchet.io] Writing payload to file'
-      
+
       begin
         unless @file
           @file = File.open(configuration.filepath, "a")
         end
-        
+
         @file.puts payload
         @file.flush
         logger.info "[Ratchet.io] Success"
@@ -196,13 +225,13 @@ module Ratchetio
         logger.error "[Ratchet.io] Error opening/writing to file: #{e}"
       end
     end
-    
+
     def send_payload(payload)
       logger.info '[Ratchet.io] Sending payload'
-    
+
       uri = URI.parse(configuration.endpoint)
       http = Net::HTTP.new(uri.host, uri.port)
-      
+
       if uri.scheme == 'https'
         http.use_ssl = true
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE
@@ -219,21 +248,21 @@ module Ratchetio
         logger.info "[Ratchet.io] Response: #{response.body}"
       end
     end
-    
+
     def schedule_payload(payload)
       logger.info '[Ratchet.io] Scheduling payload'
-      
+
       if configuration.use_async
         unless configuration.async_handler
           configuration.async_handler = method(:default_async_handler)
         end
-        
+
         if configuration.write_to_file
           unless @file_semaphore
             @file_semaphore = Mutex.new
           end
         end
-        
+
         configuration.async_handler.call(payload)
       else
         process_payload(payload)
@@ -261,26 +290,26 @@ module Ratchetio
           :version => VERSION
         }
       }
-      
+
       if defined?(SecureRandom) and SecureRandom.respond_to?(:uuid)
         data[:uuid] = SecureRandom.uuid
       end
-      
+
       data
     end
 
     def server_data
       config = configuration
-      
+
       data = {
         :host => Socket.gethostname
       }
       data[:root] = config.root.to_s if config.root
       data[:branch] = config.branch if config.branch
-      
+
       data
     end
-    
+
     def default_async_handler(payload)
       if defined?(GirlFriday)
         unless @queue
@@ -288,7 +317,7 @@ module Ratchetio
             process_payload(payload)
           end
         end
-        
+
         @queue.push(payload)
       else
         logger.warn '[Ratchet.io] girl_friday not found to handle async call, falling back to Thread'

data/spec/dummyapp/app/controllers/home_controller.rb

@@ -3,7 +3,7 @@ class HomeController < ApplicationController
     @users = User.all
 
     Ratchetio.report_message("Test message from controller with no data", "debug")
-    Ratchetio.report_message("Test message from controller with extra data", "debug", 
+    Ratchetio.report_message("Test message from controller with extra data", "debug",
                              :foo => "bar", :num_users => @users.length)
   end
 

data/spec/ratchetio_spec.rb

@@ -10,14 +10,14 @@ describe Ratchetio do
       Ratchetio.configure do |config|
         config.logger = logger_mock
       end
-      
+
       begin
         foo = bar
       rescue => e
         @exception = e
       end
     end
-   
+
     let(:logger_mock) { double("Rails.logger").as_null_object }
 
     it 'should report exceptions without person or request data' do
@@ -30,9 +30,9 @@ describe Ratchetio do
       Ratchetio.configure do |config|
         config.enabled = false
       end
-      
+
       Ratchetio.report_exception(@exception)
-      
+
       Ratchetio.configure do |config|
         config.enabled = true
       end
@@ -66,14 +66,30 @@ describe Ratchetio do
       logger_mock.should_not_receive(:info)
       logger_mock.should_not_receive(:warn)
       logger_mock.should_not_receive(:error)
-      
+
       Ratchetio.report_exception(@exception)
-      
+
       Ratchetio.configure do |config|
         config.exception_level_filters = saved_filters
       end
     end
 
+    it 'should not report exceptions when silenced' do
+      Ratchetio.should_not_receive :schedule_payload
+
+      begin
+        test_var = 1
+        Ratchetio.silenced do
+          test_var = 2
+          raise
+        end
+      rescue => e
+        Ratchetio.report_exception(e)
+      end
+
+      test_var.should == 2
+    end
+
     it 'should report exception objects with no backtrace' do
       payload = nil
       Ratchetio.stub(:schedule_payload) do |*args|
@@ -93,7 +109,7 @@ describe Ratchetio do
       end
     end
   end
-  
+
   context 'report_message' do
     before(:each) do
       configure
@@ -101,7 +117,7 @@ describe Ratchetio do
         config.logger = logger_mock
       end
     end
-    
+
     let(:logger_mock) { double("Rails.logger").as_null_object }
 
     it 'should report simple messages' do
@@ -115,9 +131,9 @@ describe Ratchetio do
       Ratchetio.configure do |config|
         config.enabled = false
       end
-      
+
       Ratchetio.report_message("Test message that should be ignored")
-      
+
       Ratchetio.configure do |config|
         config.enabled = true
       end
@@ -145,7 +161,7 @@ describe Ratchetio do
       end
     end
   end
-  
+
   context 'payload_destination' do
     before(:each) do
       configure
@@ -153,83 +169,84 @@ describe Ratchetio do
         config.logger = logger_mock
         config.filepath = 'test.ratchet'
       end
-      
+
       begin
         foo = bar
       rescue => e
         @exception = e
       end
     end
-    
+
     let(:logger_mock) { double("Rails.logger").as_null_object }
-    
+
     it 'should send the payload over the network by default' do
       logger_mock.should_not_receive(:info).with('[Ratchet.io] Writing payload to file')
       logger_mock.should_receive(:info).with('[Ratchet.io] Sending payload')
       logger_mock.should_receive(:info).with('[Ratchet.io] Success')
       Ratchetio.report_exception(@exception)
     end
-    
+
     it 'should save the payload to a file if set' do
       logger_mock.should_not_receive(:info).with('[Ratchet.io] Sending payload')
       logger_mock.should_receive(:info).with('[Ratchet.io] Writing payload to file')
       logger_mock.should_receive(:info).with('[Ratchet.io] Success')
-      
+
       filepath = ''
-      
+
       Ratchetio.configure do |config|
         config.write_to_file = true
         filepath = config.filepath
       end
-      
+
       Ratchetio.report_exception(@exception)
-      
+
       File.exist?(filepath).should == true
       File.read(filepath).should include test_access_token
       File.delete(filepath)
-      
+
       Ratchetio.configure do |config|
         config.write_to_file = false
       end
     end
   end
-  
+
   context 'asynchronous_handling' do
     before(:each) do
       configure
       Ratchetio.configure do |config|
         config.logger = logger_mock
       end
-      
+
       begin
         foo = bar
       rescue => e
         @exception = e
       end
     end
-    
+
     let(:logger_mock) { double("Rails.logger").as_null_object }
-    
+
     it 'should send the payload using the default asynchronous handler girl_friday' do
       logger_mock.should_receive(:info).with('[Ratchet.io] Success')
-      
+
       Ratchetio.configure do |config|
         config.use_async = true
         GirlFriday::WorkQueue::immediate!
       end
-      
+
       Ratchetio.report_exception(@exception)
-      
+
       Ratchetio.configure do |config|
         config.use_async = false
         GirlFriday::WorkQueue::queue!
       end
     end
-    
+
     it 'should send the payload using a user-supplied asynchronous handler' do
       logger_mock.should_receive(:info).with('Custom async handler called')
+      logger_mock.should_receive(:info).with('[Ratchet.io] Sending payload')
       logger_mock.should_receive(:info).with('[Ratchet.io] Success')
-      
+
       Ratchetio.configure do |config|
         config.use_async = true
         config.async_handler = Proc.new { |payload|
@@ -237,9 +254,9 @@ describe Ratchetio do
           Ratchetio.process_payload(payload)
         }
       end
-      
+
       Ratchetio.report_exception(@exception)
-      
+
       Ratchetio.configure do |config|
         config.use_async = false
         config.async_handler = Ratchetio.method(:default_async_handler)
@@ -264,16 +281,16 @@ describe Ratchetio do
       user_id = 123
       name = "Tester"
 
-      data = Ratchetio.send(:message_data, @message_body, 'info', 
+      data = Ratchetio.send(:message_data, @message_body, 'info',
                             :user_id => user_id, :name => name)
-      
+
       message = data[:body][:message]
       message[:body].should == @message_body
       message[:user_id].should == user_id
       message[:name].should == name
     end
   end
-  
+
   context 'exception_data' do
     before(:each) do
       configure
@@ -283,7 +300,7 @@ describe Ratchetio do
         @exception = e
       end
     end
-    
+
     it 'should accept force_level' do
       level = 'critical'
       data = Ratchetio.send(:exception_data, @exception, level)
@@ -292,11 +309,11 @@ describe Ratchetio do
 
     it 'should build valid exception data' do
       data = Ratchetio.send(:exception_data, @exception)
-      
+
       data[:level].should_not be_nil
-      
+
       trace = data[:body][:trace]
-      
+
       frames = trace[:frames]
       frames.should be_a_kind_of(Array)
       frames.each do |frame|
@@ -306,14 +323,14 @@ describe Ratchetio do
           frame[:method].should be_a_kind_of(String)
         end
       end
-      
+
       # should be NameError, but can be NoMethodError sometimes on rubinius 1.8
       # http://yehudakatz.com/2010/01/02/the-craziest-fing-bug-ive-ever-seen/
       trace[:exception][:class].should match(/^(NameError|NoMethodError)$/)
       trace[:exception][:message].should match(/^(undefined local variable or method `bar'|undefined method `bar' on an instance of)/)
     end
   end
-  
+
   context 'logger' do
     before(:each) do
       reset_configuration
@@ -340,7 +357,7 @@ describe Ratchetio do
       reset_configuration
     end
   end
-  
+
   context 'build_payload' do
     it 'should build valid json' do
       json = Ratchetio.send(:build_payload, {:foo => {:bar => "baz"}})
@@ -357,7 +374,7 @@ describe Ratchetio do
     it 'should have the correct notifier name' do
       Ratchetio.send(:base_data)[:notifier][:name].should == 'ratchetio-gem'
     end
-    
+
     it 'should have the correct notifier version' do
       Ratchetio.send(:base_data)[:notifier][:version].should == Ratchetio::VERSION
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ratchetio
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors: