ratchetio 0.5.0 → 0.5.1

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 # Change Log
 
+**0.5.1**
+- Save the exception uuid in `env['ratchetio.exception_uuid']` for display in user-facing error pages.
+
 **0.5.0**
 - Add support to report exceptions raised in delayed_job.
 
+**0.4.11**
+- Allow exceptions with no backtrace (e.g. StandardError subclasses)
+
 **0.4.10**
 - Fix compatability issue with ruby 1.8
 

data/README.md

@@ -128,11 +128,16 @@ For even more asynchrony, you can configure the gem to write to a file instead o
 
 For this to work, you'll also need to set up ratchet-agent--see its docs for details.
 
+## Using with Goalie
+
+If you're using [Goalie](https://github.com/obvio171/goalie) for custom error pages, you may need to explicitly add `require 'goalie'` to `config/application.rb` (in addition to `require goalie/rails`) so that the monkeypatch will work. (This will be obvious if it is needed because your app won't start up: you'll see a cryptic error message about `Goalie::CustomErrorPages.render_exception` not being defined.)
+
 
 ## Help / Support
 
 If you run into any issues, please email us at `support@ratchet.io`
 
+
 ## Contributing
 
 1. Fork it

data/lib/ratchetio/goalie.rb

@@ -5,19 +5,29 @@ module Goalie
     private
 
     def render_exception(env, exception)
+      exception_data = nil
       begin
         controller = env['action_controller.instance']
         request_data = controller.try(:ratchetio_request_data)
         person_data = controller.try(:ratchetio_person_data)
-        Ratchetio.report_exception(exception, request_data, person_data)
+        exception_data = Ratchetio.report_exception(exception, request_data, person_data)
       rescue => e
         # TODO use logger here?
         puts "[Ratchet.io] Exception while reporting exception to Ratchet.io: #{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
+        begin
+          env['ratchetio.exception_uuid'] = exception_data[:uuid]
+        rescue => e
+          puts "[Ratchet.io] Exception saving uuid in env: #{e}"
+        end
+      end
 
       # now continue as normal
       orig_render_exception(env, exception)
     end
   end
 end
-

data/lib/ratchetio/rails/middleware/exception_catcher.rb

@@ -7,16 +7,27 @@ module Ratchetio
         end
 
         def render_exception_with_ratchetio(env, exception)
+          exception_data = nil
           begin
             controller = env['action_controller.instance']
             request_data = controller.try(:ratchetio_request_data)
             person_data = controller.try(:ratchetio_person_data)
-            Ratchetio.report_exception(exception, request_data, person_data)
+            exception_data = Ratchetio.report_exception(exception, request_data, person_data)
           rescue => e
             # TODO use logger here?
             puts "[Ratchet.io] Exception while reporting exception to Ratchet.io: #{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
+            begin
+              env['ratchetio.exception_uuid'] = exception_data[:uuid]
+            rescue => e
+              puts "[Ratchet.io] Exception saving uuid in env: #{e}"
+            end
+          end
+
           # now continue as normal
           render_exception_without_ratchetio(env, exception)
         end

data/lib/ratchetio/version.rb

@@ -1,3 +1,3 @@
 module Ratchetio
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/spec/ratchetio_spec.rb

@@ -84,6 +84,12 @@ describe Ratchetio do
       payload["data"]["body"]["trace"]["exception"]["class"].should == "StandardError"
       payload["data"]["body"]["trace"]["exception"]["message"].should == "oops"
     end
+
+    it 'should return the exception data with a uuid' do
+      Ratchetio.stub(:schedule_payload) do |*args| end
+      exception_data = Ratchetio.report_exception(StandardError.new("oops"))
+      exception_data[:uuid].should_not be_nil
+    end
   end
   
   context 'report_message' do
@@ -97,6 +103,7 @@ describe Ratchetio do
     let(:logger_mock) { double("Rails.logger").as_null_object }
 
     it 'should report simple messages' do
+      logger_mock.should_receive(:info).with('[Ratchet.io] Scheduling payload')
       logger_mock.should_receive(:info).with('[Ratchet.io] Success')
       Ratchetio.report_message("Test message")
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ratchetio
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-14 00:00:00.000000000 Z
+date: 2013-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -254,4 +254,3 @@ test_files:
 - spec/ratchetio_spec.rb
 - spec/spec_helper.rb
 - spec/support/devise.rb
-has_rdoc: