ratchetio 0.2.1 → 0.3.0

data/README.md

@@ -28,6 +28,36 @@ To confirm that it worked, run:
 
 This will raise an exception within a test request; if it works, you'll see a stacktrace in the console, and the exception will appear in the Ratchet.io dashboard.
 
+## Manually reporting exceptions and messages
+
+To report a caught exception to Ratchet, simply call `Ratchetio.report_exception`:
+
+    begin
+      foo = bar
+    rescue Exception => e
+      Ratchetio.report_exception(e)
+    end
+
+If you're reporting an exception in the context of a request and are in a controller, you can pass along the same request and person context as the global exception handler, like so:
+
+    begin
+      foo = bar
+    rescue Exception => e
+      Ratchetio.report_exception(e, ratchetio_request_data, ratchetio_person_data)
+    end
+
+You can also log individual messages:
+
+    # logs at the 'warning' level. all levels: debug, info, warning, error, critical
+    Ratchetio.report_message("Unexpected input", "warning")
+
+    # default level is "info"
+    Ratchetio.report_message("Login successful")
+
+    # can also include additional data as a hash in the final param
+    Ratchetio.report_message("Login successful", "info", :user => @user)
+
+
 ## Person tracking
 
 Ratchet will send information about the current user (called a "person" in Ratchet parlance) along with each error report, when available. This works by trying the `current_user` and `current_member` controller methods. The return value should be an object with an `id` property and, optionally, `username` and `email` properties.

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

@@ -12,7 +12,7 @@ module Ratchetio
             controller = env['action_controller.instance']
             request_data = controller.try(:ratchetio_request_data)
             person_data = controller.try(:ratchetio_person_data)
-            Ratchetio.report_request_exception(env, exception, request_data, person_data)
+            Ratchetio.report_exception(exception, request_data, person_data)
           rescue Exception => exc
             # TODO use logger here?
             puts "[Ratchet.io] Exception while reporting exception to Ratchet.io: " 

data/lib/ratchetio/version.rb

@@ -1,3 +1,3 @@
 module Ratchetio
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/ratchetio.rb

@@ -19,7 +19,45 @@ module Ratchetio
       @configuration ||= Configuration.new
     end
 
-    def report_request_exception(env, exception, request_data, person_data)
+    def report_exception(exception, request_data={}, person_data={})
+      begin
+        data = exception_data(exception)
+        if request_data
+          data[:request] = request_data
+        end
+        if person_data
+          data[:person] = person_data
+        end
+
+        payload = build_payload(data)
+        send_payload(payload)
+      rescue
+        logger.error "[Ratchet.io] Error reporting exception to Ratchet.io"
+      end
+    end
+
+    def report_message(message, level="info", extra_data={})
+      begin
+        data = base_data(level)
+        
+        data[:body] = {
+          :message => {
+            :body => message.to_s
+          }
+        }
+        data[:body][:message].merge!(extra_data)
+        data[:server] = server_data
+        
+        payload = build_payload(data)
+        send_payload(payload)
+      rescue
+        logger.error "[Ratchet.io] Error reporting message to Ratchet.io"
+      end
+    end
+
+  private
+
+    def exception_data(exception)
       data = base_data
 
       # parse backtrace
@@ -43,19 +81,10 @@ module Ratchetio
       }
 
       data[:server] = server_data
-      data[:request] = request_data
-      data[:person] = person_data
-
-      payload = build_payload(data)
-      send_payload(payload)
-    end
-
-    def report_message()
-      # TODO
+      
+      data
     end
 
-  private
-
     def logger
       configuration.logger
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ratchetio
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-17 00:00:00.000000000 Z
+date: 2012-10-19 00:00:00.000000000 Z
 dependencies: []
 description: Rails plugin to catch and send exceptions to Ratchet.io
 email: