crashlog 1.0.3 → 1.0.4

data/.gitignore

@@ -15,4 +15,7 @@ test/tmp
 test/version_tmp
 tmp
 
-spec/dummy/log/development.log
+spec/dummy/log/development.log
+.rbenv-*
+
+/.rbx/

data/Gemfile

@@ -3,11 +3,13 @@ source :rubygems
 # Specify your gem's dependencies in crashlog.gemspec
 gemspec
 
-gem 'rspec-rails'
+# gem 'rspec-rails'
+gem 'rspec'
 gem 'guard-rspec'
 gem 'uuid'
 gem 'json_spec'
 gem 'rake', '~> 0.9.2'
-gem 'rails', '~> 3.2.7'
+# gem 'rails', '~> 3.2.7'
 gem 'delorean'
 gem 'rack-test', :git => 'git://github.com/brynary/rack-test.git'
+gem 'simplecov', :platforms => :mri_19

data/Gemfile.lock

@@ -8,11 +8,11 @@ GIT
 PATH
   remote: .
   specs:
-    crashlog (1.0.1)
-      activesupport
+    crashlog (1.0.3)
       crashlog-auth-hmac (~> 1.1.6)
       faraday (~> 0.8.4)
       hashr
+      json
       multi_json (~> 1.3.6)
       rabl (>= 0.6.14)
       uuid
@@ -20,54 +20,27 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.7)
-      actionpack (= 3.2.7)
-      mail (~> 2.4.4)
-    actionpack (3.2.7)
-      activemodel (= 3.2.7)
-      activesupport (= 3.2.7)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.3)
-    activemodel (3.2.7)
-      activesupport (= 3.2.7)
-      builder (~> 3.0.0)
-    activerecord (3.2.7)
-      activemodel (= 3.2.7)
-      activesupport (= 3.2.7)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.7)
-      activemodel (= 3.2.7)
-      activesupport (= 3.2.7)
-    activesupport (3.2.7)
+    activesupport (3.2.8)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.0)
     chronic (0.6.7)
     crashlog-auth-hmac (1.1.6)
     delorean (2.0.0)
       chronic
     diff-lcs (1.1.3)
-    erubis (2.7.0)
     faraday (0.8.4)
       multipart-post (~> 1.1)
     ffi (1.1.1)
+    ffi (1.1.1-java)
     guard (1.2.3)
       listen (>= 0.4.2)
       thor (>= 0.14.6)
     guard-rspec (1.2.0)
       guard (>= 1.1)
     hashr (0.0.22)
-    hike (1.2.1)
-    i18n (0.6.0)
-    journey (1.0.4)
-    json (1.7.4)
+    i18n (0.6.1)
+    json (1.7.5)
+    json (1.7.5-java)
     json_spec (1.0.3)
       multi_json (~> 1.0)
       rspec (~> 2.0)
@@ -77,45 +50,18 @@ GEM
       rb-inotify (~> 0.8.8)
     macaddr (1.6.1)
       systemu (~> 2.5.0)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.19)
     multi_json (1.3.6)
     multipart-post (1.1.5)
-    polyglot (0.3.3)
-    rabl (0.7.2)
+    rabl (0.7.3)
       activesupport (>= 2.3.14)
       multi_json (~> 1.0)
     rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rails (3.2.7)
-      actionmailer (= 3.2.7)
-      actionpack (= 3.2.7)
-      activerecord (= 3.2.7)
-      activeresource (= 3.2.7)
-      activesupport (= 3.2.7)
-      bundler (~> 1.0)
-      railties (= 3.2.7)
-    railties (3.2.7)
-      actionpack (= 3.2.7)
-      activesupport (= 3.2.7)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
     rake (0.9.2.2)
     rb-fchange (0.0.5)
       ffi
     rb-fsevent (0.9.1)
     rb-inotify (0.8.8)
       ffi (>= 0.5.0)
-    rdoc (3.12)
-      json (~> 1.4)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
       rspec-expectations (~> 2.11.0)
@@ -124,26 +70,17 @@ GEM
     rspec-expectations (2.11.2)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.1)
-    rspec-rails (2.11.0)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec (~> 2.11.0)
-    sprockets (2.1.3)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
     systemu (2.5.2)
     thor (0.15.4)
-    tilt (1.3.3)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
     uuid (2.3.5)
       macaddr (~> 1.0)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES
@@ -152,7 +89,7 @@ DEPENDENCIES
   guard-rspec
   json_spec
   rack-test!
-  rails (~> 3.2.7)
   rake (~> 0.9.2)
-  rspec-rails
+  rspec
+  simplecov
   uuid

data/README.md

@@ -9,7 +9,9 @@ insight into issues occurring within your production applications, in realtime.
 
 Add this line to your application's Gemfile:
 
-    gem 'crashlog'
+```ruby
+gem 'crashlog'
+```
 
 And then execute:
 

data/Rakefile

@@ -1,9 +1,7 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
 
-$: << 'lib'
-
-require "crash_log"
+require File.expand_path("../lib/crash_log", __FILE__)
 
 require 'rake'
 require "rspec/core/rake_task"
@@ -11,4 +9,4 @@ require "rspec/core/rake_task"
 desc "Run all examples"
 RSpec::Core::RakeTask.new
 
-task :default => :spec
+task :default => :spec

data/crashlog.gemspec

@@ -15,11 +15,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = CrashLog::VERSION
 
-  gem.add_dependency("activesupport")
   gem.add_dependency("faraday",       '~> 0.8.4')
   gem.add_dependency("multi_json",    '~> 1.3.6')
   gem.add_dependency("crashlog-auth-hmac", '~> 1.1.6')
   gem.add_dependency("rabl",          '>= 0.6.14')
   gem.add_dependency("uuid")
   gem.add_dependency("hashr")
+  gem.add_dependency("json")
 end

data/lib/core_ext/hash/keys.rb

@@ -0,0 +1,51 @@
+class Hash
+  # Return a new hash with all keys converted to strings.
+  #
+  #   { :name => 'Rob', :years => '28' }.stringify_keys
+  #   #=> { "name" => "Rob", "years" => "28" }
+  def stringify_keys
+    dup.stringify_keys!
+  end
+
+  # Destructively convert all keys to strings. Same as
+  # +stringify_keys+, but modifies +self+.
+  def stringify_keys!
+    keys.each do |key|
+      self[key.to_s] = delete(key)
+    end
+    self
+  end
+
+  # Return a new hash with all keys converted to symbols, as long as
+  # they respond to +to_sym+.
+  #
+  #   { 'name' => 'Rob', 'years' => '28' }.symbolize_keys
+  #   #=> { :name => "Rob", :years => "28" }
+  def symbolize_keys
+    dup.symbolize_keys!
+  end
+
+  # Destructively convert all keys to symbols, as long as they respond
+  # to +to_sym+. Same as +symbolize_keys+, but modifies +self+.
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    self
+  end
+
+  # Validate all keys in a hash match *valid keys, raising ArgumentError on a mismatch.
+  # Note that keys are NOT treated indifferently, meaning if you use strings for keys but assert symbols
+  # as keys, this will fail.
+  #
+  # ==== Examples
+  #   { :name => "Rob", :years => "28" }.assert_valid_keys(:name, :age) # => raises "ArgumentError: Unknown key: years"
+  #   { :name => "Rob", :age => "28" }.assert_valid_keys("name", "age") # => raises "ArgumentError: Unknown key: name"
+  #   { :name => "Rob", :age => "28" }.assert_valid_keys(:name, :age) # => passes, raises nothing
+  def assert_valid_keys(*valid_keys)
+    valid_keys.flatten!
+    each_key do |k|
+      raise(ArgumentError, "Unknown key: #{k}") unless valid_keys.include?(k)
+    end
+  end
+end

data/lib/core_ext/kernel/require_relative.rb

@@ -0,0 +1,7 @@
+unless Kernel.respond_to?(:require_relative)
+  module Kernel
+    def require_relative(path)
+      require File.join(File.dirname(caller[0]), path.to_str)
+    end
+  end
+end

data/lib/crash_log.rb

@@ -1,31 +1,23 @@
-$: << File.expand_path('..', __FILE__)
-
-require 'crash_log/version'
-
-begin
-  require 'active_support'
-  require 'active_support/core_ext'
-rescue LoadError
-  require 'activesupport'
-  require 'activesupport/core_ext'
-end
-
 require 'faraday'
 require 'multi_json'
+require 'time'
+
+require File.expand_path('../core_ext/kernel/require_relative', __FILE__)
 
-require 'crash_log/railtie' if defined?(Rails::Railtie)
-require 'crash_log/logging'
+require_relative 'core_ext/hash/keys'
+require_relative 'crash_log/version'
+require_relative 'crash_log/logging'
+require_relative 'crash_log/helpers'
+require_relative 'crash_log/backtrace'
+require_relative 'crash_log/configuration'
+require_relative 'crash_log/payload'
+require_relative 'crash_log/reporter'
+require_relative 'crash_log/system_information'
+require_relative 'crash_log/rack'
 
 module CrashLog
   extend Logging::ClassMethods
 
-  autoload :Backtrace,          'crash_log/backtrace'
-  autoload :Configuration,      'crash_log/configuration'
-  autoload :Payload,            'crash_log/payload'
-  autoload :Rack,               'crash_log/rack'
-  autoload :Reporter,           'crash_log/reporter'
-  autoload :SystemInformation,  'crash_log/system_information'
-
   LOG_PREFIX = '** [CrashLog]'
 
   class << self
@@ -49,7 +41,7 @@ module CrashLog
     #   def something_dangerous
     #     raise RuntimeError, "This is too dangerous for you"
     #   rescue => e
-    #     CrashLog.notify(e, {current_user: current_user})
+    #     CrashLog.notify(e, {context: {current_user: current_user}})
     #   end
     #
     # Returns true if successful, otherwise false
@@ -57,7 +49,11 @@ module CrashLog
       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)
+          if notification.has_key?(:location_id)
+            info "Event URL: http://crashlog.io/locate/#{notification[:location_id]}"
+          else
+            error "No Event location ID returned. There may have been a problem processing this Event"
+          end
         else
           error "Failed to send event to CrashLog.io"
           log_exception(exception)
@@ -67,7 +63,7 @@ module CrashLog
 
     # Sends the notice unless it is one of the default ignored exceptions.
     def notify_or_ignore(exception, context = {})
-      notify(exception, context = {}) unless ignored?(exception)
+      notify(exception, context) unless ignored?(exception)
     end
 
     # Print a message at the top of the applciation's logs to say we're ready.
@@ -94,7 +90,7 @@ module CrashLog
           if announce.eql?(true)
             report_for_duty!
           else
-            info("Configuration updated")
+            debug("Configuration updated successfully")
           end
         elsif !configuration.invalid_keys.include?(:api_key)
           error("Not configured correctly. Missing the following keys: #{configuration.invalid_keys.join(', ')}")
@@ -108,6 +104,10 @@ module CrashLog
       @configuration ||= Configuration.new
     end
 
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+
     # The default logging device.
     def logger
       self.configuration.logger || Logger.new($stdout)
@@ -131,9 +131,7 @@ module CrashLog
   private
 
     def send_notification(exception, context = {})
-      if live?
-        build_payload(exception, context).deliver!
-      end
+      build_payload(exception, context).deliver! if live?
     end
 
     def build_payload(exception, data = {})
@@ -146,3 +144,8 @@ module CrashLog
     end
   end
 end
+
+# Require this last to resolve an issue with Rails apps that use Bundler.setup
+# instead of Bundler.require which results in the CrashLog module not being made
+# available in time. FIXES: https://github.com/crashlog/crashlog/issues/7
+require_relative 'crash_log/railtie' if defined?(Rails::Railtie)

data/lib/crash_log/backtrace.rb

@@ -1,8 +1,8 @@
 module CrashLog
   class Backtrace
 
-    autoload :Line,       'crash_log/backtrace/line'
-    autoload :LineCache,  'crash_log/backtrace/line_cache'
+    require_relative 'backtrace/line'
+    require_relative 'backtrace/line_cache'
 
     # holder for an Array of Backtrace::Line instances
     attr_reader :lines
@@ -56,8 +56,8 @@ module CrashLog
     attr_writer :lines
 
     def self.split_multiline_backtrace(backtrace)
-      if backtrace.to_a.size == 1
-        backtrace.to_a.first.split(/\n\s*/)
+      if Array(backtrace).size == 1
+        Array(backtrace).first.split(/\n\s*/)
       else
         backtrace
       end

data/lib/crash_log/configuration.rb

@@ -1,5 +1,7 @@
 require 'hashr'
 require 'multi_json'
+require 'logger'
+
 module CrashLog
   class Configuration < Hashr
     DEFAULT_PARAMS_FILTERS = %w(password password_confirmation).freeze
@@ -33,10 +35,25 @@ module CrashLog
                       'AbstractController::ActionNotFound',
                       'Mongoid::Errors::DocumentNotFound']
 
+    ENVIRONMENT_FILTERS_DEFAULT = [
+      /SECRET/, /AWS/, /PASSWORD/, /PRIVATE/, /EC2/, /HEROKU/
+    ]
 
       # The logger to use for internal messages
     define :logger => nil,
 
+      # One of:
+      # - Logger::DEBUG
+      # - Logger::INFO
+      # - Logger::WARN
+      # - Logger::ERROR
+      # - Logger::FATAL
+      # - Logger::ANY
+      :level => Logger::INFO,
+
+      # Colorize log output
+      :colorize => true,
+
       # The API key to authenticate this project with CrashLog
       #
       # Get this from your projects configuration page within http://CrashLog.io
@@ -102,6 +119,11 @@ module CrashLog
       # Timeout for connecting to CrashLog collector interface
       :http_open_timeout => 5,
 
+      # +true+ to use whatever CAs OpenSSL has installed on your system.
+      # +false+ to use the ca-bundle.crt file included in CrashLog itself
+      # Defaut: false (reccomended)
+      :use_system_ssl_cert_chain => false,
+
       # Ignored error class names
       :ignore => IGNORE_DEFAULT.dup,
 
@@ -115,7 +137,7 @@ module CrashLog
       :context_lines => 5,
 
       # Environment variables to discard from ENV.
-      :environment_filters => [],
+      :environment_filters => ENVIRONMENT_FILTERS_DEFAULT.dup,
 
       # Framework name
       :framework => 'Standalone',
@@ -134,7 +156,12 @@ module CrashLog
       :service_name => 'CrashLog',
 
       # MultiJson adapter
-      :json_parser => MultiJson.default_adapter
+      :json_parser => MultiJson.default_adapter,
+
+      # Development mode
+      # When enabled we don't swallow internal exceptions.
+      # Useful for debugging connection issues.
+      :development_mode => false
 
     def root
       fetch(:project_root)
@@ -187,6 +214,36 @@ module CrashLog
       CrashLog::VERSION
     end
 
+    def development_mode?
+      development_mode.eql?(true)
+    end
+
+    def ca_bundle_path
+      if use_system_ssl_cert_chain? && File.exist?(OpenSSL::X509::DEFAULT_CERT_FILE)
+        OpenSSL::X509::DEFAULT_CERT_FILE
+      else
+        local_cert_path # ca-bundle.crt built from source, see resources/README.md
+      end
+    end
+
+    def local_cert_path
+      File.expand_path(File.join("../../../resources/ca-bundle.crt"), __FILE__)
+    end
+
+    def logger=(new_logger)
+      self[:logger] = new_logger
+      new_logger.level = self.level if self.logger.respond_to?(:level=)
+    end
+
+    # Helps to enable debug logging when in development mode
+    def development_mode=(flag)
+      self[:development_mode] = flag
+      self.level = Logger::DEBUG
+      if new_logger
+        new_logger.level = self.level if self.logger.respond_to?(:level=)
+      end
+    end
+
   private
 
     def error_class(exception)