crashlog 0.0.2 → 1.0.0.rc1

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    crashlog (0.0.1)
+    crashlog (1.0.0.rc1)
       activesupport
       crashlog-auth-hmac (~> 1.1.5)
       faraday
@@ -86,7 +86,7 @@ GEM
     multipart-post (1.1.5)
     pg (0.14.0)
     polyglot (0.3.3)
-    rabl (0.7.0)
+    rabl (0.7.1)
       activesupport (>= 2.3.14)
       multi_json (~> 1.0)
     rack (1.4.1)

data/INSTALL

@@ -3,8 +3,8 @@
 You should have something like this in config/initializers/crashlog.rb.
 
   CrashLog.configure do |config|
-    config.api_key    = 'AhHusJhJHAjJajA'
-    config.project_id = 'ca9e5931-310f-4897-90c2-d0626f0f2a01'
+    config.api_key    = 'API_KEY'
+    config.secret     = 'SECRET'
   end
 
 (Please note that this configuration should be in a global configuration, and
@@ -18,5 +18,4 @@ this rake task (from RAILS_ROOT):
   rake crashlog:test
 
 If everything is configured properly, that task will send a notice to CrashLog
-which will be visible immediately.
-
+which will be visible immediately.

data/README.md

@@ -1,5 +1,7 @@
 # CrashLog
 
+[![Build Status](https://secure.travis-ci.org/crashlog/crashlog.png)](http://travis-ci.org/crashlog/crashlog)
+
 CrashLog is a exception tracking and notification service that gives you unparalleled
 insight into issues occurring within your production applications, in realtime.
 

data/Rakefile

@@ -11,5 +11,4 @@ require "rspec/core/rake_task"
 desc "Run all examples"
 RSpec::Core::RakeTask.new
 
-task :default => :spec
-
+task :default => :spec

data/lib/crash_log/configuration.rb

@@ -39,14 +39,14 @@ module CrashLog
       #
       # Get this from your projects configuration page within http://CrashLog.io
       :api_key => nil,
-      :project_id => nil,
+      :secret => nil,
 
       # Stages (environments) which we consider to be in a production environment
       # and thus you want to be sent notifications for.
       :release_stages => ['staging', 'production'],
 
       # The name of the current stage
-      :stage => 'development',
+      :stage => 'production',
 
       # Project Root directory
       :project_root => nil,
@@ -127,7 +127,9 @@ module CrashLog
 
       # Internal
       # Do not change unless you know what this does.
-      :service_name => 'CrashLog'
+      :service_name => 'CrashLog',
+
+      :json_parser => :yajl
 
     def root
       fetch(:project_root)
@@ -147,7 +149,7 @@ module CrashLog
 
     # Release stages are stages which send exceptions
     def release_stage?
-      release_stages.include?(stage)
+      Array(release_stages).include?(stage)
     end
 
     # Set the current stage
@@ -159,9 +161,13 @@ module CrashLog
     #
     # Returns true if all required keys are provided, otherwise false
     def valid?
-      [:api_key, :project_id, :host, :port].all? do |key|
-        !__send__(key).nil?
-      end
+      invalid_keys.empty?
+    end
+
+    def invalid_keys
+      [:api_key, :secret, :host, :port].map do |key|
+        key if send(key).nil?
+      end.compact
     end
 
     def ignored?(exception)

data/lib/crash_log/payload.rb

@@ -36,7 +36,10 @@ module CrashLog
     end
 
     def deliver
-      Reporter.new(config).notify(self.body)
+      reporter = Reporter.new(config)
+      if reporter.notify(self.body)
+        reporter.result
+      end
     end
 
     attr_reader :event, :backtrace, :exception_object, :environment, :context

data/lib/crash_log/rails.rb

@@ -21,7 +21,7 @@ module CrashLog
 
       CrashLog.configure do |config|
         config.logger = rails_logger
-        config.release_stage = RAILS_ENV  if defined?(RAILS_ENV)
+        config.stage = RAILS_ENV  if defined?(RAILS_ENV)
         config.project_root = RAILS_ROOT if defined?(RAILS_ROOT)
         config.framework = "Rails: #{::Rails::VERSION::STRING}" if defined?(::Rails::VERSION)
       end

data/lib/crash_log/railtie.rb

@@ -7,9 +7,9 @@ module CrashLog
 
     config.after_initialize do
       CrashLog.configure do |config|
-        config.logger           ||= ::Rails.logger
-        config.stage            ||= ::Rails.env
-        config.project_root     ||= ::Rails.root
+        config.logger           = ::Rails.logger
+        config.stage            = ::Rails.env
+        config.project_root     = ::Rails.root
         config.framework        = "Rails: #{::Rails::VERSION::STRING}"
       end
 

data/lib/crash_log/reporter.rb

@@ -1,6 +1,7 @@
 require 'faraday'
 require 'faraday/request/hmac_authentication'
 require 'uuid'
+require 'multi_json'
 require 'yajl'
 
 module CrashLog
@@ -18,11 +19,12 @@ module CrashLog
       @endpoint   = config.endpoint
       @announce_endpoint = config.announce == true ?
                            config.announce_endpoint : nil
+      MultiJson.use(config.json_parser || :yajl)
     end
 
     def notify(payload)
-      #return if dry_run?
-      #MultiJson.use(:yajl)
+      return if dry_run?
+
       response = post(endpoint, MultiJson.encode({:payload => payload}))
       @response = response
       report_result(response.body)
@@ -30,6 +32,7 @@ module CrashLog
     rescue => e
       log_exception e
       error("Sending exception failed due to a connectivity issue")
+      nil
     end
 
     def announce
@@ -38,13 +41,11 @@ module CrashLog
 
       response = post(config.announce_endpoint, JSON.dump(identification_hash))
       if response.status == 201
-        JSON.load(response.body).symbolize_keys.fetch(:application, 'Default')
+        JSON.load(response.body).symbolize_keys.fetch(:application_name, 'Default')
       else
-        false
+        nil
       end
     rescue => e
-      # We only want to log our mess when testing
-      log_exception(e) # if respond_to?(:should)
       error("Failed to announce application launch")
       nil
     end
@@ -54,7 +55,7 @@ module CrashLog
     end
 
     def url
-      URI.parse("#{scheme}://#{host}:#{port}")
+      URI.parse("#{scheme}://#{host}:#{port}").to_s
     end
 
     def identification_hash
@@ -64,10 +65,6 @@ module CrashLog
       }
     end
 
-    def print_result
-
-    end
-
     def dry_run?
       config.dry_run == true
     end
@@ -75,18 +72,15 @@ module CrashLog
     def post(endpoint, body)
       connection.post do |req|
         req.url(endpoint)
-        # req.sign!(config.project_id, config.api_key)
         req.headers['Content-Type'] = 'application/json'
         req.body = body
       end
     end
 
-#  private
-
     def connection
       @connection ||= begin
         Faraday.new(:url => url) do |faraday|
-          faraday.request :hmac_authentication, config.project_id, config.api_key, {:service_id => config.service_name}
+          faraday.request :hmac_authentication, config.api_key, config.secret, {:service_id => config.service_name}
           faraday.adapter(adapter)
           faraday.request :url_encoded
           # faraday.request                 :token_auth, config.api_key

data/lib/crash_log/version.rb

@@ -1,3 +1,3 @@
 module CrashLog
-  VERSION = "0.0.2"
+  VERSION = "1.0.0.rc1"
 end

data/lib/crash_log.rb

@@ -53,7 +53,15 @@ module CrashLog
     #
     # Returns true if successful, otherwise false
     def notify(exception, context = {})
-      send_notification(exception, context)
+      send_notification(exception, context).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)
+        else
+          error "Failed to send event to CrashLog.io"
+          log_exception(exception)
+        end
+      end
     end
 
     # Sends the notice unless it is one of the default ignored exceptions.
@@ -66,7 +74,7 @@ module CrashLog
       application = CrashLog::Reporter.new(configuration).announce
 
       if application
-        info("Initialized and ready to handle exceptions for #{application}")
+        info("Configured correctly and ready to handle exceptions for '#{application}'")
       else
         error("Failed to report for duty, your application failed to authenticate correctly with stdin.crashlog.io")
       end
@@ -74,12 +82,15 @@ module CrashLog
 
     # Configure the gem to send notifications, at the very least an api_key is
     # required.
-    def configure
-      yield(configuration) if block_given?
-      if configuration.valid?
-        report_for_duty!
-      else
-        error('Not configured correctly')
+    def configure(&block)
+      if block_given?
+        yield(configuration)
+
+        if configuration.valid?
+          report_for_duty!
+        elsif !configuration.invalid_keys.include?(:api_key)
+          error("Not configured correctly. Missing the following keys: #{configuration.invalid_keys.join(', ')}")
+        end
       end
     end
 
@@ -111,7 +122,9 @@ module CrashLog
   private
 
     def send_notification(exception, context = {})
-      build_payload(exception, context).deliver! if live?
+      if live?
+        build_payload(exception, context).deliver!
+      end
     end
 
     def build_payload(exception, context = {})

data/lib/faraday/request/hmac_authentication.rb

@@ -26,10 +26,6 @@ module Faraday
           request[:body]
         end
 
-        # def request_path(request)
-        #   URI.parse(request[:url]).path
-        # end
-
         def request_path(request)
           URI.parse(request[:url].to_s).path
         end
@@ -53,8 +49,7 @@ module Faraday
 
       # Public
       def call(env)
-        env[:request_headers][KEY] ||= hmac_auth_header(env).to_s #if sign_request?
-        puts env[:request_headers]
+        env[:request_headers][KEY] ||= hmac_auth_header(env).to_s if sign_request?
         @app.call(env)
       end
 

data/script/integration_test

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+require 'logger'
+require 'fileutils'
+
+RAILS_ENV = "production"
+RAILS_ROOT = FileUtils.pwd
+RAILS_DEFAULT_LOGGER = Logger.new(STDOUT)
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'crashlog'
+require File.expand_path('../../rails/init', __FILE__)
+
+fail "Please supply an API Key as the first argument" if ARGV.empty?
+
+host = ARGV[3]
+host ||= "stdin.crashlog.io"
+
+secure = (ARGV[2] == "secure")
+
+exception = begin
+              raise "Testing crashlog notifier with secure = #{secure}. If you can see this, it works."
+            rescue => foo
+              foo
+            end
+
+CrashLog.configure do |config|
+  config.api_key = ARGV[0]
+  config.secret  = ARGV[1]
+  config.scheme  = secure ? 'https' : 'http'
+  config.host    = host
+  config.service_name = 'Staging'
+end
+
+puts "Configuration:"
+CrashLog.configuration.each do |key, value|
+  puts sprintf("%25s: %s", key.to_s, value.inspect.slice(0, 55))
+end
+puts "Sending #{secure ? "" : "in"}secure notification to project with key #{ARGV.first}"
+CrashLog.notify(exception)

data/spec/crash_log/configuration_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe CrashLog::Configuration do
+  context 'release stage' do
+    it 'includes production' do
+      subject.release_stages.should include 'production'
+    end
+
+    it 'includes staging' do
+      subject.release_stages.should include 'staging'
+    end
+
+    it 'is true if production' do
+      subject.stage = 'production'
+      subject.release_stage?.should be_true
+    end
+
+    it 'is true if staging' do
+      subject.stage = 'staging'
+      subject.release_stage?.should be_true
+    end
+
+    it 'is false in development' do
+      subject.stage = 'development'
+      subject.release_stage?.should be_false
+    end
+  end
+
+  context 'valid?' do
+    it 'is valid if api_key and secret are present' do
+      subject.should_not be_valid
+      subject.api_key = 'API_KEY'
+      subject.secret = 'SECRET'
+      subject.should be_valid
+    end
+  end
+end

data/spec/crash_log/reporter_spec.rb

@@ -5,7 +5,7 @@ describe CrashLog::Reporter do
 
   let(:config) {
     CrashLog::Configuration.new.tap do |config|
-      config.project_id = 'PROJECT_ID'
+      config.secret = 'SECRET'
       config.api_key = 'API_KEY'
       # config.adapter = test_adapter
       config.scheme = 'http'
@@ -44,7 +44,7 @@ describe CrashLog::Reporter do
   end
 
   let(:announce_response) do
-    {:application => "CrashLog Test"}
+    {:application_name=> "CrashLog Test"}
   end
 
   let(:positive_response_json) { positive_response.to_json }
@@ -66,7 +66,7 @@ describe CrashLog::Reporter do
     before do
       test_connection = Faraday.new(:url => subject.url) do |builder|
         builder.adapter :test, stubs
-        builder.request :hmac_authentication, 'PROJECT_ID', 'SECRET', {:service_id => 'CrashLog'}
+        builder.request :hmac_authentication, 'API_KEY', 'SECRET', {:service_id => 'CrashLog'}
         builder.request :url_encoded
       end
 
@@ -84,14 +84,22 @@ describe CrashLog::Reporter do
     end
 
     it 'makes a post request' do
-      subject.send(:connection).should_receive(:post).once
+      response = double("Post", success?: true)
+      response.stub(:body).and_return(positive_response_json)
+      subject.send(:connection).should_receive(:post).once.and_return(response)
       subject.notify(payload)
     end
 
     it 'authenticates request with HMAC' do
+      time_travel_to "2012-08-01 00:00:00 UTC"
+
       subject.notify(payload).should be_true
+
       subject.response.env[:request_headers]['Authorization'].should ==
-        CrashLog::AuthHMAC.new({}, {:service_id => 'CrashLog'}).authorization(subject.response.env, 'PROJECT_ID', 'SECRET')
+        CrashLog::AuthHMAC.new({}, {
+        :service_id => 'CrashLog',
+        :signature => Faraday::Request::HMACAuthentication::CanonicalString
+      }).authorization(subject.response.env, 'API_KEY', 'SECRET')
       stubs.verify_stubbed_calls
     end
 

data/spec/crash_log_spec.rb

@@ -96,7 +96,7 @@ describe CrashLog do
       CrashLog::Reporter.any_instance.stub(:announce).and_return("Test Application")
       logger = stub('Logger')
       logger.should_receive(:info).
-        with("** [CrashLog] Initialized and ready to handle exceptions for Test Application")
+        with("** [CrashLog] Configured correctly and ready to handle exceptions for 'Test Application'")
 
       CrashLog.stub(:logger).and_return(logger)
       CrashLog.report_for_duty!

data/spec/dummy/config/initializers/crashlog.rb

@@ -2,5 +2,6 @@ require 'crashlog'
 
 CrashLog.configure do |config|
   config.api_key = "API_KEY"
+  config.secret  = "SECRET"
   config.dry_run = true
 end

data/spec/requests/rails_controller_rescue_spec.rb

@@ -5,6 +5,10 @@ describe 'Rescue from within a Rails 3.x controller' do
   include RSpec::Rails::RequestExampleGroup
   include Rack::Test::Methods
 
+  it 'is testing tails 3.x' do
+    Rails.version.should =~ /^3\./
+  end
+
   describe 'dummy app' do
     it 'should response nicely to index' do
       get '/'

data/spec/spec_helper.rb

@@ -17,7 +17,5 @@ Dir[File.expand_path("../support/*.rb", __FILE__)].each { |file| require file }
 
 RSpec.configure do |config|
   config.mock_with :rspec
-
-  config.before do
-  end
+  config.include Delorean
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: crashlog
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 1.0.0.rc1
+  prerelease: 6
 platform: ruby
 authors:
 - TestPilot CI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-06 00:00:00.000000000 Z
+date: 2012-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70175970544380 !ruby/object:Gem::Requirement
+  requirement: &70309383792940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70175970544380
+  version_requirements: *70309383792940
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70175970543240 !ruby/object:Gem::Requirement
+  requirement: &70309383792280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70175970543240
+  version_requirements: *70309383792280
 - !ruby/object:Gem::Dependency
   name: crashlog-auth-hmac
-  requirement: &70175970541460 !ruby/object:Gem::Requirement
+  requirement: &70309383791780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.1.5
   type: :runtime
   prerelease: false
-  version_requirements: *70175970541460
+  version_requirements: *70309383791780
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70175970540800 !ruby/object:Gem::Requirement
+  requirement: &70309383791260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70175970540800
+  version_requirements: *70309383791260
 - !ruby/object:Gem::Dependency
   name: rabl
-  requirement: &70175970540040 !ruby/object:Gem::Requirement
+  requirement: &70309383806820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.6.14
   type: :runtime
   prerelease: false
-  version_requirements: *70175970540040
+  version_requirements: *70309383806820
 - !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &70175970539280 !ruby/object:Gem::Requirement
+  requirement: &70309383806220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70175970539280
+  version_requirements: *70309383806220
 - !ruby/object:Gem::Dependency
   name: hashr
-  requirement: &70175970538820 !ruby/object:Gem::Requirement
+  requirement: &70309383805760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70175970538820
+  version_requirements: *70309383805760
 description: CrashLog Exception reporter
 email:
 - support@crashlog.io
@@ -129,7 +129,9 @@ files:
 - lib/faraday/request/hmac_authentication.rb
 - lib/rails/generators/crashlog/crashlog_generator.rb
 - rails/init.rb
+- script/integration_test
 - spec/crash_log/backtrace_spec.rb
+- spec/crash_log/configuration_spec.rb
 - spec/crash_log/initializer_spec.rb
 - spec/crash_log/payload_spec.rb
 - spec/crash_log/reporter_spec.rb
@@ -188,9 +190,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.15
@@ -199,6 +201,7 @@ specification_version: 3
 summary: CrashLog is an exception handler for production applications
 test_files:
 - spec/crash_log/backtrace_spec.rb
+- spec/crash_log/configuration_spec.rb
 - spec/crash_log/initializer_spec.rb
 - spec/crash_log/payload_spec.rb
 - spec/crash_log/reporter_spec.rb