ratchetio 0.6.0 → 0.6.1

data/CHANGELOG.md

@@ -1,7 +1,11 @@
 # Change Log
 
+**0.6.1**
+- Added a log message containing a link to the instance. Copy-paste the link into your browser to view its details in Ratchet.
+- Ratchetio.report_message now returns 'ignored' or 'error' instead of nil when a message is not reported for one of those reasons, for consistency with Ratchetio.report_exception.
+
 **0.6.0**
-- BREAKING CHANGE: Ratchetio.report_exception now returns 'ignored', 'disabled', or 'error' instead of nil when the exception is not reported for one of those reasons. It still returns the payload upon success.
+- POSSIBLE BREAKING CHANGE: Ratchetio.report_exception now returns 'ignored', 'disabled', or 'error' instead of nil when the exception is not reported for one of those reasons. It still returns the payload upon success.
 - Request data is now parsed from the rack environment instead of from within the controller, addressing issue #10.
 - Add Sidekiq middleware for catching workers' exceptions
 - Replaced activesupport dependency with multi_json

data/lib/ratchetio/configuration.rb

@@ -4,14 +4,14 @@ module Ratchetio
   class Configuration
 
     attr_accessor :access_token
+    attr_accessor :async_handler
     attr_accessor :branch
     attr_accessor :default_logger
     attr_accessor :enabled
     attr_accessor :endpoint
-    attr_accessor :write_to_file
-    attr_accessor :filepath
     attr_accessor :environment
     attr_accessor :exception_level_filters
+    attr_accessor :filepath
     attr_accessor :framework
     attr_accessor :logger
     attr_accessor :person_method
@@ -21,21 +21,23 @@ module Ratchetio
     attr_accessor :root
     attr_accessor :scrub_fields
     attr_accessor :use_async
-    attr_accessor :async_handler
+    attr_accessor :web_base
+    attr_accessor :write_to_file
 
     DEFAULT_ENDPOINT = 'https://submit.ratchet.io/api/1/item/'
+    DEFAULT_WEB_BASE = 'https://ratchet.io'
 
     def initialize
+      @async_handler = nil
       @default_logger = lambda { Logger.new(STDERR) }
       @enabled = true
       @endpoint = DEFAULT_ENDPOINT
-      @write_to_file = false
-      @framework = 'Plain'
       @exception_level_filters = {
         'ActiveRecord::RecordNotFound' => 'warning',
         'AbstractController::ActionNotFound' => 'warning',
         'ActionController::RoutingError' => 'warning'
       }
+      @framework = 'Plain'
       @person_method = 'current_user'
       @person_id_method = 'id'
       @person_username_method = 'username'
@@ -43,7 +45,8 @@ module Ratchetio
       @scrub_fields = [:passwd, :password, :password_confirmation, :secret,
                        :confirm_password, :password_confirmation]
       @use_async = false
-      @async_handler = nil
+      @web_base = DEFAULT_WEB_BASE
+      @write_to_file = false
     end
 
     # allow params to be read like a hash

data/lib/ratchetio/version.rb

@@ -1,3 +1,3 @@
 module Ratchetio
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/lib/ratchetio.rb

@@ -74,6 +74,7 @@ module Ratchetio
 
       payload = build_payload(data)
       schedule_payload(payload)
+      log_instance_link(data)
       data
     rescue => e
       logger.error "[Ratchet.io] Error reporting exception to Ratchet.io: #{e}"
@@ -92,15 +93,16 @@ module Ratchetio
     # @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
+      return 'disabled' unless configuration.enabled
 
       data = message_data(message, level, extra_data)
       payload = build_payload(data)
       schedule_payload(payload)
+      log_instance_link(data)
+      data
     rescue => e
       logger.error "[Ratchet.io] Error reporting message to Ratchet.io: #{e}"
+      'error'
     end
 
     # Turns off reporting for the given block.
@@ -132,6 +134,10 @@ module Ratchetio
 
     private
 
+    def log_instance_link(data)
+      logger.info "[Ratchet.io] Details: #{configuration.web_base}/instance/uuid?uuid=#{data[:uuid]}"
+    end
+
     def ignored?(exception)
       if filtered_level(exception) == 'ignore'
         return true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ratchetio
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-29 00:00:00.000000000 Z
+date: 2013-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -278,4 +278,3 @@ test_files:
 - spec/requests/home_spec.rb
 - spec/spec_helper.rb
 - spec/support/devise.rb
-has_rdoc: