crashlog 1.0.4 → 1.0.5

data/Gemfile.lock

@@ -8,13 +8,13 @@ GIT
 PATH
   remote: .
   specs:
-    crashlog (1.0.3)
+    crashlog (1.0.4)
       crashlog-auth-hmac (~> 1.1.6)
       faraday (~> 0.8.4)
       hashr
       json
-      multi_json (~> 1.3.6)
-      rabl (>= 0.6.14)
+      multi_json (>= 1.1.0)
+      rabl (>= 0.6.13)
       uuid
 
 GEM
@@ -50,9 +50,9 @@ GEM
       rb-inotify (~> 0.8.8)
     macaddr (1.6.1)
       systemu (~> 2.5.0)
-    multi_json (1.3.6)
+    multi_json (1.3.7)
     multipart-post (1.1.5)
-    rabl (0.7.3)
+    rabl (0.7.6)
       activesupport (>= 2.3.14)
       multi_json (~> 1.0)
     rack (1.4.1)

data/README.md

@@ -21,7 +21,11 @@ Or install it yourself as:
 
     $ gem install crashlog
 
-## Configuration
+Generate a Rails Initializer:
+
+    $ rails generate crashlog KEY:SECRET
+
+## Custom Configuration
 
 ### Basic:
 

data/crashlog.gemspec

@@ -16,9 +16,9 @@ Gem::Specification.new do |gem|
   gem.version       = CrashLog::VERSION
 
   gem.add_dependency("faraday",       '~> 0.8.4')
-  gem.add_dependency("multi_json",    '~> 1.3.6')
+  gem.add_dependency("multi_json",    '>= 1.1.0')
   gem.add_dependency("crashlog-auth-hmac", '~> 1.1.6')
-  gem.add_dependency("rabl",          '>= 0.6.14')
+  gem.add_dependency("rabl",          '>= 0.6.13')
   gem.add_dependency("uuid")
   gem.add_dependency("hashr")
   gem.add_dependency("json")

data/generators/crashlog/USAGE

@@ -0,0 +1,15 @@
+Description:
+  Generates an initializer in config/initializers and
+  runs `rake crashlog:test` to ensure you're able to send exceptions.
+
+Example:
+
+  rails generate crashlog KEY:SECRET
+
+Help:
+  If you receive an error during the connection test it is most likely that your
+  KEY or SECRET are incorrect.
+
+  If you continue to have issues, or you just want to say hi, send
+  an email to support@crashlog.io
+

data/generators/crashlog/templates/initializer.rb

@@ -1,7 +1,100 @@
+# Use this hook to configure how you want CrashLog to behave in your application.
+
+# If you're using Bundler.setup instead of Bundler.require you will need to
+# require CrashLog explicitly:
+#
+# require 'crashlog'
+
 <% if Rails::VERSION::MAJOR < 3 && Rails::VERSION::MINOR < 2 -%>
 require 'crash_log/rails'
 <% end -%>
 CrashLog.configure do |config|
+  # ==> Authentication credentials
+  # Enter your authentication credentials here. You can get these from the
+  # 'Authentication' tab of your project in the CrashLog UI https://crashlog.io
   config.api_key  = <%= api_key_expression %>
   config.secret   = <%= secret_expression %>
+
+  # ==> Ignored exceptions
+  # By default we ignore:
+  # - ActiveRecord::RecordNotFound,
+  # - ActionController::RoutingError,
+  # - ActionController::InvalidAuthenticityToken
+  # - CGI::Session::CookieStore::TamperedWithCookie
+  # - ActionController::UnknownAction
+  # - AbstractController::ActionNotFound
+  # - Mongoid::Errors::DocumentNotFound
+  #
+  # Generally most of these result in a 404 being sent back to the client,
+  # as such they can create a lot of noise.
+  #
+  # To disable any of them uncomment and update this line:
+  # config.ignore -= %w(ActionController::RoutingError)
+  # or, don't ignore anything:
+  # config.ignore = []
+
+  # ==> Release stages
+  # Configure the stages that you can to capture exceptions in. By default
+  # we only activate in production and staging.
+  #
+  # When your application starts it will set the current stage to the name
+  # of the current environment.
+  #
+  # Add another stage:
+  # config.release_stages << 'integration'
+
+  # ==> HTTP Adapter
+  # Change adapter used to talk to CrashLog collection endpoints.
+  # Available options:
+  #
+  # - :test                 - Test adapter, used for running tests.
+  # - :net_http             - (Default) Ruby Net::HTTP
+  # - :net_http_persistent  - Ruby Net::HTTP in persistent mode
+  # - :typhoeus             - High performance parallel HTTP adapter
+  # - :patron               - Ruby HTTP client based on libcurl
+  # - :em_synchrony         - Asynchronous EventMachine based adapter
+  # - :em_http              - Pretty much the same of above.
+  # - :excon                - The wonderful adapter used by Fog.
+  # - :rack                 - Rack adapter
+  # - :httpclient           - 'httpclient' gives something like the
+  #                           functionality of libwww-perl (LWP) in Ruby
+  #
+  # config.adapter = :net_http
+
+  # ==> Timeouts
+  # Increase these if you experience connection issues.
+  #
+  # Timeout for connecting to CrashLog collector interface (in seconds)
+  # config.http_open_timeout = 5
+  #
+  # Timeout for actually sending the exeption payload (in seconds)
+  # config.http_read_timeout = 2
+
+  # ==> Environment filters
+  # Filters for filtering ENV[] which gets sent with each exception.
+  # Refer to https://github.com/crashlog/crashlog/blob/master/lib/crash_log/configuration.rb
+  #
+  # config.environment_filters += [/SOMETHING_SECRET/]
+
+  # ==> Backtrace filters
+  # Standard backtrace filters (processed by every line)
+  # config.backtrace_filters += lambda { |line| }
+
+  # ==> JSON Engine
+  # If you have trouble encoding or decoding, or you're using a specific JSON
+  # engine in your app, set it here.
+  #
+  # We use MultiJson behind the scenes so any option available to MultiJson can
+  # be set.
+  # config.json_parser = :yajl
+
+  # ==> SSL certificate chain
+  # On some platforms the SSL implementation available to Ruby doesn't include
+  # our SSL providers certificate in the default chain. Because of this we package
+  # our own certificate chain and use if by default. If you want to use the
+  # system chain, set this to false.
+  # config.use_system_ssl_cert_chain = false
+
+  # ==> Advanced options
+  # Refer to https://github.com/crashlog/crashlog/blob/master/lib/crash_log/configuration.rb
 end

data/lib/crash_log/configuration.rb

@@ -156,7 +156,9 @@ module CrashLog
       :service_name => 'CrashLog',
 
       # MultiJson adapter
-      :json_parser => MultiJson.default_adapter,
+      :json_parser => MultiJson.respond_to?(:default_adapter) ?
+                      MultiJson.default_adapter :
+                      MultiJson.default_engine,
 
       # Development mode
       # When enabled we don't swallow internal exceptions.

data/lib/crash_log/reporter.rb

@@ -19,10 +19,10 @@ module CrashLog
       @announce_endpoint = config.announce == true ?
                            config.announce_endpoint : nil
 
-      # Old versions of MultiJson don't support #use.
-      # TODO: Figure out what they do support. IV.
       if MultiJson.respond_to?(:use)
         MultiJson.use(config.json_parser || MultiJson.default_adapter)
+      elsif MultiJson.respond_to?(:engine=)
+        MultiJson.engine = (config.json_parser || MultiJson.default_engine)
       end
     end
 
@@ -31,7 +31,7 @@ module CrashLog
 
       # TODO: Move this to Payload.
       payload[:data] = CrashLog::Helpers.cleanup_obj(payload[:data])
-      payload_string = MultiJson.encode({:payload => payload})
+      payload_string = encode({:payload => payload})
 
       # Useful to make sure we're successfully capturing the right data
       debug(payload.inspect) if config.development_mode?
@@ -50,9 +50,9 @@ module CrashLog
       return if dry_run?
       return "Unknown application" unless announce_endpoint
 
-      response = post(config.announce_endpoint, MultiJson.encode({:payload => identification_hash}))
+      response = post(config.announce_endpoint, encode({:payload => identification_hash}))
       if response.status == 201
-        MultiJson.load(response.body).symbolize_keys.fetch(:application_name, 'Default')
+        decode(response.body).symbolize_keys.fetch(:application_name, 'Default')
       else
         nil
       end
@@ -63,7 +63,7 @@ module CrashLog
     end
 
     def report_result(body)
-      @result = MultiJson.load(body).symbolize_keys
+      @result = decode(body).symbolize_keys
     end
 
     def url
@@ -117,5 +117,28 @@ module CrashLog
     def adapter
       config.adapter
     end
+
+    # FIXME: This is some seriously annoying shit.
+    # MultiJson should not have deprecated its old API and we wouldn't need
+    # to do this.
+    def encode(object)
+      if MultiJson.respond_to?(:dump)
+        # MultiJson >= 1.3
+        MultiJson.dump(object)
+      elsif MultiJson.respond_to?(:encode)
+        # MultiJson < 1.3
+        MultiJson.encode(object)
+      end
+    end
+
+    def decode(string, options = {})
+      if MultiJson.respond_to?(:load)
+        # MultiJson >= 1.3
+        MultiJson.load(string, options)
+      elsif MultiJson.respond_to?(:decode)
+        # MultiJson < 1.3
+        MultiJson.decode(string, options)
+      end
+    end
   end
 end

data/lib/crash_log/version.rb

@@ -1,3 +1,3 @@
 module CrashLog
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/lib/rails/generators/crashlog/crashlog_generator.rb

@@ -1,37 +1,41 @@
 require 'rails/generators'
 
 class CrashlogGenerator < Rails::Generators::Base
-
-  class_option :api_key, :aliases => "-k", :type => :string, :desc => "Your CrashLog API key"
-  class_option :secret, :aliases => "-s", :type => :string, :desc => "Your CrashLog API secret"
-
-  def self.source_root
-    @_crashlog_source_root ||= File.expand_path("../../../../../generators/crashlog/templates", __FILE__)
-  end
+  argument :api_key, :type => :string
+  class_option :force, :aliases => "-f", :type => :boolean, :desc => "Replace existing crashlog.rb file"
+  source_root File.expand_path("../../../../../generators/crashlog/templates", __FILE__)
 
   def install
-    ensure_api_key_was_configured
+    ensure_api_key_is_valid_format
     generate_initializer unless api_key_configured?
     test_crashlog
   end
 
   private
 
-  def ensure_api_key_was_configured
-    if !options[:api_key] &&
-       !options[:secret] &&
-       !api_key_configured?
-      puts "Must pass --api-key and --secret or create config/initializers/crashlog.rb"
-      exit
+  def ensure_api_key_is_valid_format
+    unless api_key_pair_provided?
+      puts "API_KEY does not match required format: <KEY>:<SECRET>"
+      exit(1)
     end
   end
 
+  def api_key_pair_provided?
+    !!(self.api_key =~ /^(\h){8}-(\h){4}-(\h){4}-(\h){4}-(\h){12}\:\w+$/)
+  end
+
+  def api_key_pair
+    /(?<api_key>^(\h){8}-(\h){4}-(\h){4}-(\h){4}-(\h){12})\:(?<secret>\w+)$/.match(self.api_key)
+  end
+
   def api_key_expression
-    "'#{options[:api_key]}'"
+    api_key = api_key_pair[:api_key]
+    "'#{api_key}'"
   end
 
   def secret_expression
-    "'#{options[:secret]}'"
+    secret = api_key_pair[:secret]
+    "'#{secret}'"
   end
 
   def generate_initializer
@@ -39,11 +43,11 @@ class CrashlogGenerator < Rails::Generators::Base
   end
 
   def api_key_configured?
+    return false if options[:force]
     File.exists?('config/initializers/crashlog.rb')
   end
 
   def test_crashlog
-    puts run("rake crashlog:test")
+    run("rake crashlog:test")
   end
 end
-

data/script/integration_test

@@ -14,7 +14,9 @@ require File.expand_path('../../rails/init', __FILE__)
 
 fail "Please supply an API Key as the first argument" if ARGV.empty?
 
-host = ARGV[2]
+staging = ARGV.find { |arg| arg == '--staging' }
+host = ARGV.find { |arg| arg =~ /^http/ }
+
 host = "https://stdin.crashlog.io" if host.blank?
 
 class SimulatedExceptionRaiser
@@ -39,7 +41,7 @@ CrashLog.configure(true) do |config|
   config.host    = URI.parse(host).host
   config.port    = URI.parse(host).port
   config.development_mode = true
-  # config.service_name = 'Staging'
+  config.service_name = 'Staging' if staging
 end
 
 secure = CrashLog.configuration.secure?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crashlog
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-25 00:00:00.000000000 Z
+date: 2012-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70334148342160 !ruby/object:Gem::Requirement
+  requirement: &70229446276380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,21 +21,21 @@ dependencies:
         version: 0.8.4
   type: :runtime
   prerelease: false
-  version_requirements: *70334148342160
+  version_requirements: *70229446276380
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70334148341620 !ruby/object:Gem::Requirement
+  requirement: &70229446274140 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70334148341620
+  version_requirements: *70229446274140
 - !ruby/object:Gem::Dependency
   name: crashlog-auth-hmac
-  requirement: &70334148340920 !ruby/object:Gem::Requirement
+  requirement: &70229446273460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,21 +43,21 @@ dependencies:
         version: 1.1.6
   type: :runtime
   prerelease: false
-  version_requirements: *70334148340920
+  version_requirements: *70229446273460
 - !ruby/object:Gem::Dependency
   name: rabl
-  requirement: &70334148340160 !ruby/object:Gem::Requirement
+  requirement: &70229446272540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.6.14
+        version: 0.6.13
   type: :runtime
   prerelease: false
-  version_requirements: *70334148340160
+  version_requirements: *70229446272540
 - !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &70334148339540 !ruby/object:Gem::Requirement
+  requirement: &70229446271620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70334148339540
+  version_requirements: *70229446271620
 - !ruby/object:Gem::Dependency
   name: hashr
-  requirement: &70334148338780 !ruby/object:Gem::Requirement
+  requirement: &70229446287340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70334148338780
+  version_requirements: *70229446287340
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70334148337940 !ruby/object:Gem::Requirement
+  requirement: &70229446286920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70334148337940
+  version_requirements: *70229446286920
 description: CrashLog Exception reporter
 email:
 - support@crashlog.io
@@ -105,6 +105,7 @@ files:
 - README.md
 - Rakefile
 - crashlog.gemspec
+- generators/crashlog/USAGE
 - generators/crashlog/templates/initializer.rb
 - install.rb
 - lib/core_ext/hash/keys.rb