crashlog 1.0.0 → 1.0.1

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    crashlog (1.0.0.rc1)
+    crashlog (1.0.0)
       activesupport
       crashlog-auth-hmac (~> 1.1.6)
       faraday

data/lib/crash_log/payload.rb

@@ -20,28 +20,33 @@ module CrashLog
       log_exception(e)
     end
 
-    attr_reader :config, :backtrace_filters
+    attr_reader :config, :backtrace_filters, :data
 
     def initialize(event_data, config)
       @config = config || {}
       @event_data = event_data
       @context = {}
       @environment = {}
+      @data = {}
       @backtrace_filters = config[:backtrace_filters] || []
 
       # Actually serialize the exception/event hash for transport
       @event = serialize_event(event_data)
 
-      # add_environment_data(:system => SystemInformation.to_hash)
+      add_environment_data(:system => SystemInformation.to_hash)
+      add_context(:stage => config.stage)
     end
 
     def deliver
-      reporter = Reporter.new(config)
       if reporter.notify(self.body)
         reporter.result
       end
     end
 
+    def reporter
+      CrashLog.reporter
+    end
+
     attr_reader :event, :backtrace, :exception_object, :environment, :context
 
     def body
@@ -52,16 +57,12 @@ module CrashLog
       (@context ||= {}).merge!(data) if data.is_a?(Hash)
     end
 
-    def add_user_data(data, value = nil)
-      if data.respond_to?(:keys)
-        @user_data.merge!(data)
-      elsif value && data.respond_to?(:to_sym)
-        @user_data[data.to_sym] = value
-      end
+    def add_data(data)
+      (@data ||= {}).merge!(data) if data.is_a?(Hash)
     end
 
     def add_session_data(data)
-      (@environment[:session] ||= {}).merge!(data) if data.is_a?(Hash)
+      (@data[:session] ||= {}).merge!(data) if data.is_a?(Hash)
     end
 
     def add_environment_data(data)
@@ -87,11 +88,6 @@ module CrashLog
       }
     end
 
-    # Returns the hostname of this machine
-    def hostname
-      SystemInformation.hostname
-    end
-
   private
 
     def serialize_event(event_data)

data/lib/crash_log/rails/action_controller_rescue.rb

@@ -1,7 +1,7 @@
 module CrashLog
   module Rails
 
-    # CrashLog controller integration
+    # CrashLog Rails 2.x controller integration
     # Aliases method chain for Rails internal rescue action
     module ActionControllerRescue
       def self.included(base)

data/lib/crash_log/rails/controller_methods.rb

@@ -3,25 +3,27 @@ module CrashLog
     module ControllerMethods
 
       def crash_log_context
-        { :parameters       => crash_log_filter_if_filtering(params.to_hash),
+        {
+          :context => {
+            :controller       => params[:controller],
+            :action           => params[:action],
+            :current_user     => crash_log_current_user
+          },
+          :parameters       => crash_log_filter_if_filtering(params.to_hash),
           :session_data     => crash_log_filter_if_filtering(crash_log_session_data),
-          :controller       => params[:controller],
-          :action           => params[:action],
           :url              => crash_log_request_url,
           :cgi_data         => crash_log_filter_if_filtering(request.env),
-          :current_user     => crash_log_current_user
         }
       end
 
     private
+
       def notify_crashlog(exception, custom_data = nil)
         request_data = crash_log_context
-        #request_data[:meta_data][:custom] = custom_data if custom_data
+        request_data[:custom] = custom_data if custom_data
         CrashLog.notify(exception, request_data)
       end
 
-      alias_method :notify_airbrake, :notify_crashlog
-
       def crash_log_session_data
         if session.respond_to?(:to_hash)
           session.to_hash
@@ -41,6 +43,18 @@ module CrashLog
         url
       end
 
+      def crash_log_filter_if_filtering(hash)
+        return hash if ! hash.is_a?(Hash)
+
+        if respond_to?(:filter_parameters) # Rails 2
+          filter_parameters(hash)
+        elsif defined?(ActionDispatch::Http::ParameterFilter) # Rails 3
+          ActionDispatch::Http::ParameterFilter.new(::Rails.application.config.filter_parameters).filter(hash)
+        else
+          hash
+        end rescue hash
+      end
+
       def crash_log_current_user
         user = begin current_user rescue current_member end
         user.attributes.select do |k, v|

data/lib/crash_log/rails/middleware/debug_exception_catcher.rb

@@ -10,31 +10,32 @@ module CrashLog
         # Hook into the rails error rendering page to send this exception to
         # CrashLog before rails handlers take over.
         def render_exception_with_crash_log(env, exception)
-          controller = env['action_controller.instance']
+          begin
+            controller = env['action_controller.instance']
+            CrashLog.notify_or_ignore(exception, crash_log_context(controller, env))
 
-          CrashLog.notify_or_ignore(exception) #,
-                                     # crash_log_context(controller, env))
+            if defined?(controller.rescue_action_in_public_without_crash_log)
+              controller.rescue_action_in_public_without_crash_log(exception)
+            end
 
-          if defined?(controller.rescue_action_in_public_without_crash_log)
-            controller.rescue_action_in_public_without_crash_log(exception)
+          rescue Exception => e
+            # If it breaks here there is possibly something wrong with us, so
+            # instead of crashing again, we'll just pass it on.
           end
-
-        rescue Exception => e
-          # If it breaks here there is possibly something wrong with us, so
-          # instead of crashing again, we'll just pass it on.
-        ensure
           render_exception_without_crash_log(env, exception)
         end
 
       private
 
         def crash_log_context(controller, env)
-          # TODO: Replace this with user context lookup
-          if controller.respond_to?(:crash_log_request_data)
-            controller.crash_log_request_data
+          if controller.respond_to?(:crash_log_context)
+            controller.crash_log_context
           else
             {:rack_env => env}
           end
+
+        rescue => e
+          {:failed_context => true}
         end
 
       end

data/lib/crash_log/system_information.rb

@@ -28,6 +28,8 @@ module CrashLog
 
       def username
         ENV['LOGNAME'] || ENV['USER'] || ENV['USERNAME'] || ENV['APACHE_RUN_USER'] || 'UNKNOWN'
+      rescue
+        nil
       end
 
       def environment
@@ -38,6 +40,8 @@ module CrashLog
         else
           {}
         end
+      rescue
+        {}
       end
 
       def libraries_loaded

data/lib/crash_log/templates/payload.rabl

@@ -5,3 +5,4 @@ attribute :event
 attribute :backtrace
 attribute :environment
 attribute :context
+attribute :data

data/lib/crash_log/version.rb

@@ -1,3 +1,3 @@
 module CrashLog
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/crash_log.rb

@@ -26,6 +26,7 @@ module CrashLog
   LOG_PREFIX = '** [CrashLog]'
 
   class << self
+    attr_accessor :reporter
 
     # Sends a notification to CrashLog
     #
@@ -48,12 +49,9 @@ module CrashLog
     #     CrashLog.notify(e, {current_user: current_user})
     #   end
     #
-    #   This will try to serialize the current user by calling `as_crashlog_context` or `as_json`
-    #   otherwise it will try `to_s`
-    #
     # Returns true if successful, otherwise false
-    def notify(exception, context = {})
-      send_notification(exception, context).tap do |notification|
+    def notify(exception, data = {})
+      send_notification(exception, data).tap do |notification|
         if notification
           info "Event sent to CrashLog.io"
           info "Event URL: http://crashlog.io/locate/#{notification[:location_id]}" if notification.has_key?(:location_id)
@@ -86,6 +84,8 @@ module CrashLog
       if block_given?
         yield(configuration)
 
+        self.reporter = CrashLog::Reporter.new(configuration)
+
         if configuration.valid?
           if announce.eql?(true)
             report_for_duty!
@@ -96,6 +96,7 @@ module CrashLog
           error("Not configured correctly. Missing the following keys: #{configuration.invalid_keys.join(', ')}")
         end
       end
+      configuration
     end
 
     # The global configuration object.
@@ -131,9 +132,12 @@ module CrashLog
       end
     end
 
-    def build_payload(exception, context = {})
+    def build_payload(exception, data = {})
       Payload.build(exception, configuration) do |payload|
-        payload.add_context(context)
+        if context = data.delete(:context)
+          payload.add_context(context)
+        end
+        payload.add_data(data)
       end
     end
   end

data/script/integration_test

@@ -34,13 +34,13 @@ class SimulatedExceptionRaiser
   end
 end
 
-CrashLog.configure do |config|
+CrashLog.configure(true) do |config|
   config.api_key = ARGV[0]
   config.secret  = ARGV[1]
   config.scheme  = secure ? 'https' : 'http'
   config.host    = URI.parse(host).host
   config.port    = URI.parse(host).port
-  config.service_name = 'Staging'
+  # config.service_name = 'Staging'
 end
 
 puts "Configuration:"

data/spec/crash_log/payload_spec.rb

@@ -5,8 +5,9 @@ describe CrashLog::Payload do
   include JsonSpec
 
   let(:configuration) do
-    stub('configuration').tap do |config|
-      config.stub(:[])
+    CrashLog.configure do |config|
+      config.api_key = 'API_KEY'
+      config.secret = 'SECRET'
     end
   end
 
@@ -21,12 +22,13 @@ describe CrashLog::Payload do
   end
 
   describe '#add_context' do
-    it 'user_data should be empty' do
-      subject.context.should be_empty
+    it 'has stage set from payload' do
+      data = {:stage=>"production"}
+      subject.context.should == data
     end
 
     it 'merges in new user data' do
-      data = {:email => "user@example.com"}
+      data = {:stage=>"production", :email=>"user@example.com"}
       subject.add_context(data)
       subject.context.should == data
     end
@@ -34,13 +36,13 @@ describe CrashLog::Payload do
 
   describe '#add_session_data' do
     it 'is empty by default' do
-      subject.environment[:session].should be_nil
+      subject.data[:session].should be_nil
     end
 
     it 'allows merging in data' do
       data = {:path => '/problematic/path'}
       subject.add_session_data(data)
-      subject.environment[:session].should == data
+      subject.data[:session].should == data
     end
 
     it 'allows adding more data' do
@@ -49,8 +51,8 @@ describe CrashLog::Payload do
       subject.add_session_data(data_1)
       subject.add_session_data(data_2)
 
-      subject.environment[:session][:path].should == data_1[:path]
-      subject.environment[:session][:count].should == data_2[:count]
+      subject.data[:session][:path].should == data_1[:path]
+      subject.data[:session][:count].should == data_2[:count]
     end
   end
 
@@ -72,9 +74,9 @@ describe CrashLog::Payload do
       end
     end
 
-    describe 'exception' do
+    describe 'event' do
 
-      it 'has class_name' do
+      it 'has type' do
         subject.body.to_json.should have_json_path('event/type')
       end
 
@@ -82,42 +84,61 @@ describe CrashLog::Payload do
         subject.body.to_json.should have_json_path('event/message')
       end
 
-      describe 'backtrace' do
-        it 'has line number' do
-          subject.body.to_json.should have_json_path('backtrace/0/number')
-        end
+      it 'has timestamp' do
+        subject.body.to_json.should have_json_path('event/timestamp')
+      end
+    end
 
-        it 'has integer as line number' do
-          subject.body.to_json.should have_json_type(Integer).at_path('backtrace/0/number')
-        end
+    it 'has backtrace' do
+      subject.body.to_json.should have_json_path('backtrace/0')
+    end
 
-        it 'has filename' do
-          subject.body.to_json.should have_json_path('backtrace/0/file')
-        end
+    describe 'environment' do
+      it 'should have system information' do
+        subject.body.to_json.should have_json_path('environment/system/hostname')
+      end
 
-        it 'has method' do
-          subject.body.to_json.should have_json_path('backtrace/0/method')
-        end
+      it 'has system ruby version' do
+        subject.body.to_json.should have_json_path('environment/system/ruby_version')
       end
 
-      it 'has backtrace' do
-        subject.body.to_json.should have_json_path('backtrace/0')
+      it 'has system username' do
+        subject.body.to_json.should have_json_path('environment/system/username')
       end
 
-      it 'has timestamp' do
-        subject.body.to_json.should have_json_path('event/timestamp')
+      it 'has system environment' do
+        subject.body.to_json.should have_json_path('environment/system/environment')
       end
     end
 
-    describe 'session' do
+    describe 'backtrace' do
+      it 'has line number' do
+        subject.body.to_json.should have_json_path('backtrace/0/number')
+      end
+
+      it 'has integer as line number' do
+        subject.body.to_json.should have_json_type(Integer).at_path('backtrace/0/number')
+      end
+
+      it 'has filename' do
+        subject.body.to_json.should have_json_path('backtrace/0/file')
+      end
 
+      it 'has method' do
+        subject.body.to_json.should have_json_path('backtrace/0/method')
+      end
+    end
+
+    describe 'context' do
+      it 'has stage' do
+        subject.body.to_json.should have_json_path('context/stage')
+      end
     end
 
-    describe 'user_data' do
-      it 'has first key provided by user' do
-        pending
-        # subject.add_user_data({:email => "user@example.com"})
-        # subject.body.to_json.should have_json_path('user_data/email')
+    describe 'data' do
+      it 'adds data to data interface' do
+        subject.add_data(something_awesome: 'Indeed')
+        subject.body.to_json.should have_json_path('data/something_awesome')
       end
     end
   end

data/spec/dummy/app/controllers/break_controller.rb

@@ -7,4 +7,13 @@ class BreakController < ApplicationController
     raise RuntimeError, "You hit the broken route"
   end
 
+  def manual_notify
+    raise RuntimeError, "Manual exception"
+  rescue => e
+    notify_crashlog(e)
+  end
+
+  def current_user
+    CurrentUser.new
+  end
 end

data/spec/dummy/app/models/current_user.rb

@@ -0,0 +1,9 @@
+class CurrentUser
+  attr_reader :username, :full_name, :id
+
+  def initialize(*args)
+    @id = 1337
+    @username = "testuser"
+    @full_name = "Test User"
+  end
+end

data/spec/dummy/config/routes.rb

@@ -1,6 +1,7 @@
 Rails.application.routes.draw do
 
   get 'broken' => 'break#really_broken'
+  get 'manual' => 'break#manual_notify'
 
   root :to => "break#index"
 end

data/spec/requests/rails_controller_rescue_spec.rb

@@ -1,10 +1,45 @@
 require 'spec_helper'
 require 'rack/test'
+require 'uuid'
 
 describe 'Rescue from within a Rails 3.x controller' do
   include RSpec::Rails::RequestExampleGroup
   include Rack::Test::Methods
 
+  class CollectingReporter
+    attr_reader :collected
+
+    def initialize
+      @collected = []
+    end
+
+    def result
+      {:location_id => UUID.generate }
+    end
+
+    def notify(payload)
+      @collected << payload
+      true
+    end
+  end
+
+  def assert_caught_and_sent
+    CrashLog.reporter.collected.should_not be_empty
+  end
+
+  def assert_caught_and_not_sent
+    expect { CrashLog.reporter.collected.empty? }.to be_true
+  end
+
+  def last_notice
+    CrashLog.reporter.collected.last
+  end
+
+  before do
+    CrashLog.reporter = CollectingReporter.new
+    CrashLog.configuration.root = File.expand_path("../..", __FILE__)
+  end
+
   it 'is testing tails 3.x' do
     Rails.version.should =~ /^3\.2\./
   end
@@ -17,20 +52,46 @@ describe 'Rescue from within a Rails 3.x controller' do
     end
   end
 
+  let(:action) { get '/broken' }
+
+  it 'collects payloads' do
+    CrashLog.notify(RuntimeError.new("TEST"))
+    assert_caught_and_sent
+  end
+
   it 'should intercept error and notify crashlog' do
-    CrashLog.should_receive(:notify_or_ignore).with(kind_of(RuntimeError)).once
+    get '/broken'
+    last_response.status.should == 500
+    last_response.body.should match /We're sorry, but something went wrong/
 
-    # begin
-      get '/broken'
-      last_response.status.should == 500
-      last_response.body.should match /We're sorry, but something went wrong/
-    # rescue => e
-      # nil
-    # end
+    assert_caught_and_sent
+  end
+
+  it 'captures standard backtrace attributes' do
+    action
+
+    last_notice.to_json.should have_json_path('notifier/name')
+    last_notice.to_json.should have_json_path('backtrace/0/number')
+    last_notice.to_json.should have_json_path('backtrace/0/method')
+    last_notice.to_json.should have_json_path('backtrace/0/file')
+    last_notice.to_json.should have_json_path('backtrace/0/context_line')
+    last_notice.to_json.should have_json_path('backtrace/0/pre_context/1')
+    last_notice.to_json.should have_json_path('backtrace/0/pre_context/2')
+    last_notice.to_json.should have_json_path('backtrace/0/pre_context/3')
+    last_notice.to_json.should have_json_path('backtrace/0/pre_context/4')
+    last_notice.to_json.should have_json_path('environment/system/hostname')
+    last_notice.to_json.should have_json_path('environment/system/application_root')
+  end
+
+  it 'captures current user' do
+    # ActionController::Base.any_instance.stub(:crash_log_context).and_return({current_user: {id: 1}})
+
+    action
 
+    # last_notice.should == ''
+    last_notice.to_json.should have_json_path('context/current_user')
   end
 
-  it 'should capture current user'
   it 'should capture crash log custom data'
 
   it 'should raise error again after notifying' do

data/spec/spec_helper.rb

@@ -18,4 +18,13 @@ Dir[File.expand_path("../support/*.rb", __FILE__)].each { |file| require file }
 RSpec.configure do |config|
   config.mock_with :rspec
   config.include Delorean
+  config.include DefinesConstants
+
+  config.before(:each) do
+    setup_constants
+  end
+
+  config.after(:each) do
+    teardown_constants
+  end
 end

data/spec/support/define_constants.rb

@@ -0,0 +1,16 @@
+module DefinesConstants
+  def setup_constants
+    @defined_constants = []
+  end
+
+  def teardown_constants
+    @defined_constants.each do |constant|
+      Object.__send__(:remove_const, constant)
+    end
+  end
+
+  def define_constant(name, value)
+    Object.const_set(name, value)
+    @defined_constants << name
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crashlog
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-10 00:00:00.000000000 Z
+date: 2012-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70193507965760 !ruby/object:Gem::Requirement
+  requirement: &70168301743680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70193507965760
+  version_requirements: *70168301743680
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70193507965340 !ruby/object:Gem::Requirement
+  requirement: &70168301743260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70193507965340
+  version_requirements: *70168301743260
 - !ruby/object:Gem::Dependency
   name: crashlog-auth-hmac
-  requirement: &70193507964840 !ruby/object:Gem::Requirement
+  requirement: &70168301742760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.1.6
   type: :runtime
   prerelease: false
-  version_requirements: *70193507964840
+  version_requirements: *70168301742760
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70193507964420 !ruby/object:Gem::Requirement
+  requirement: &70168301742340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70193507964420
+  version_requirements: *70168301742340
 - !ruby/object:Gem::Dependency
   name: rabl
-  requirement: &70193507963880 !ruby/object:Gem::Requirement
+  requirement: &70168301741800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.6.14
   type: :runtime
   prerelease: false
-  version_requirements: *70193507963880
+  version_requirements: *70168301741800
 - !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &70193507963460 !ruby/object:Gem::Requirement
+  requirement: &70168301741380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70193507963460
+  version_requirements: *70168301741380
 - !ruby/object:Gem::Dependency
   name: hashr
-  requirement: &70193507963000 !ruby/object:Gem::Requirement
+  requirement: &70168301740920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70193507963000
+  version_requirements: *70168301740920
 description: CrashLog Exception reporter
 email:
 - support@crashlog.io
@@ -145,6 +145,7 @@ files:
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.gitkeep
 - spec/dummy/app/models/.gitkeep
+- spec/dummy/app/models/current_user.rb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
@@ -172,6 +173,7 @@ files:
 - spec/requests/rack_spec.rb
 - spec/requests/rails_controller_rescue_spec.rb
 - spec/spec_helper.rb
+- spec/support/define_constants.rb
 - spec/support/doing.rb
 - spec/support/dummy_app.rb
 - spec/support/hash_ext.rb
@@ -215,6 +217,7 @@ test_files:
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.gitkeep
 - spec/dummy/app/models/.gitkeep
+- spec/dummy/app/models/current_user.rb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
@@ -242,6 +245,7 @@ test_files:
 - spec/requests/rack_spec.rb
 - spec/requests/rails_controller_rescue_spec.rb
 - spec/spec_helper.rb
+- spec/support/define_constants.rb
 - spec/support/doing.rb
 - spec/support/dummy_app.rb
 - spec/support/hash_ext.rb