sentry-raven 0.4.6 → 0.4.7

data/README.md

@@ -16,7 +16,11 @@ gem "sentry-raven" #, :github => "getsentry/raven-ruby"
 
 ## Usage
 
-You'll want to set your ```SENTRY_DSN``` environment variable to the URL on your project's API Keys setting page (e.g. ```https://secret:public@app.getsentry.com/9999```). For more information, see [Configuration](#configuration).
+The easiest way to configure Raven is by setting the ``SENTRY_DSN`` environment variable.
+
+You'll find this value on your project settings page, and it should resemble something like ```https://secret:public@app.getsentry.com/9999```.
+
+For alternative configuration methods, and other options see [Configuration](#configuration).
 
 ### Rails 3
 
@@ -93,13 +97,6 @@ The following attributes are available:
 * `tags`: a mapping of [tags](https://www.getsentry.com/docs/tags/) describing this event
 * `extra`: a mapping of arbitrary context
 
-## Testing
-
-```bash
-$ bundle install
-$ rake spec
-```
-
 ## Configuration
 
 ### SENTRY_DSN
@@ -160,12 +157,44 @@ Raven.configure do |config|
 end
 ```
 
-## Command Line Interface
+## Testing Your Configuration
 
-Raven includes a basic CLI for testing your DSN:
+To ensure you've setup your configuration correctly we recommend running the
+included rake task::
 
-```ruby
-ruby -Ilib ./bin/raven test <DSN>
+```bash
+$ rake raven:test[https://public:secret@app.getsentry.com/3825]
+Client configuration:
+-> server: https://app.getsentry.com
+-> project_id: 3825
+-> public_key: public
+-> secret_key: secret
+
+Sending a test event:
+-> event ID: 033c343c852b45c2a3add98e425ea4b4
+
+Done!
+```
+
+A couple of things to note:
+
+* This won't test your environment configuration. The test CLI forces the your
+  coniguration to represent itself as if it were running in the production env.
+* If you're running within Rails (or anywhere else that will bootstrap the
+  rake environment), you should be able to omit the DSN argument.
+
+## Contributing
+
+### Bootstrap
+
+```bash
+$ bundle install
+```
+
+### Running the test suite
+
+```bash
+$ rake spec
 ```
 
 Resources

data/bin/raven

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 require "raven"
+require "raven/cli"
 require "optparse"
 
 options = {}
@@ -34,21 +35,7 @@ case ARGV[0]
     if !dsn
       puts "Usage: raven test <dsn>"
     else
-      Raven.configure do |config|
-        config.dsn = dsn
-        config.current_environment = 'production'
-      end
-
-      puts "Sending test event"
-
-      begin
-        1 / 0
-      rescue ZeroDivisionError => exception
-        Raven.capture_exception(exception)
-      end
-
-      puts "Done!"
-
+      Raven::CLI::test(dsn)
     end
   else
     puts parser

data/lib/raven.rb

@@ -11,6 +11,7 @@ require 'raven/interfaces/exception'
 require 'raven/interfaces/stack_trace'
 require 'raven/interfaces/http'
 require 'raven/processors/sanitizedata'
+require 'raven/tasks'
 
 require 'raven/railtie' if defined?(Rails::Railtie)
 require 'raven/sidekiq' if defined?(Sidekiq)
@@ -104,14 +105,14 @@ module Raven
     end
 
     def capture_exception(exception, options={})
-      if evt = Event.capture_exception(exception, options)
+      if evt = Event.from_exception(exception, options)
         yield evt if block_given?
         send(evt)
       end
     end
 
     def capture_message(message, options={})
-      if evt = Event.capture_message(message, options)
+      if evt = Event.from_message(message, options)
         yield evt if block_given?
         send(evt)
       end
@@ -149,6 +150,10 @@ module Raven
       self.context.extra.merge!(options)
     end
 
+    def rack_context(env)
+      self.context.rack_env = env
+    end
+
     # For cross-language compat
     alias :captureException :capture_exception
     alias :captureMessage :capture_message

data/lib/raven/backtrace.rb

@@ -11,7 +11,7 @@ module Raven
       # regexp (optionnally allowing leading X: for windows support)
       INPUT_FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$}.freeze
 
-      APP_DIRS_PATTERN = /^\/?(bin|app|config|lib|test)/
+      APP_DIRS_PATTERN = /^(bin|app|config|lib|test)/
 
       # The file portion of the line (such as app/models/user.rb)
       attr_reader :file
@@ -37,13 +37,18 @@ module Raven
       end
 
       def in_app
-        if self.file =~ APP_DIRS_PATTERN
+        if (project_root && self.file.start_with?(project_root)) ||
+            (self.file =~ APP_DIRS_PATTERN)
           true
         else
           false
         end
       end
 
+      def project_root
+        @project_root ||= Raven.configuration.project_root && Raven.configuration.project_root.to_s
+      end
+
       # Reconstructs the line in a readable fashion
       def to_s
         "#{file}:#{number}:in `#{method}'"

data/lib/raven/cli.rb

@@ -0,0 +1,62 @@
+require 'raven'
+
+module Raven
+  class CLI
+    def self.test(dsn=nil)
+      require 'logger'
+
+      logger = ::Logger.new(STDOUT)
+      logger.level = ::Logger::ERROR
+      logger.formatter = proc do |severity, datetime, progname, msg|
+        "-> #{msg}\n"
+      end
+
+      Raven.configuration.logger = logger
+
+      if dsn then
+        Raven.configuration.dsn = dsn
+      end
+
+      # wipe out env settings to ensure we send the event
+      if !Raven.configuration.send_in_current_environment? then
+        env_name = Raven.coniguration.environments[0]
+        puts "Setting environment to #{env_name}"
+        Raven.configuration.current_environment = env_name
+      end
+
+      if !Raven.configuration.server then
+        puts "Your client is not configured!"
+        exit 1
+      end
+
+      puts "Client configuration:"
+      ['server', 'project_id', 'public_key', 'secret_key'].each do |key|
+        if !Raven.configuration[key] then
+          puts "Missing configuration for #{key}"
+          exit 1
+        end
+        puts "-> #{key}: #{Raven.configuration[key]}"
+      end
+      puts ""
+
+      puts "Sending a test event:"
+
+      begin
+        1 / 0
+      rescue ZeroDivisionError => exception
+        evt = Raven.capture_exception(exception)
+      end
+
+      if evt then
+        puts "-> event ID: #{evt.id}"
+      else
+        puts ""
+        puts "An error occurred while attempting to send the event."
+        exit 1
+      end
+
+      puts ""
+      puts "Done!"
+    end
+  end
+end

data/lib/raven/client.rb

@@ -22,7 +22,10 @@ module Raven
     end
 
     def send(event)
-      return unless configuration.send_in_current_environment?
+      if !configuration.send_in_current_environment?
+        Raven.logger.debug "Event not sent due to excluded environment: #{configuration.current_environment}"
+        return
+      end
 
       # Set the project ID correctly
       event.project = self.configuration.project_id
@@ -32,9 +35,12 @@ module Raven
       begin
         transport.send(generate_auth_header(encoded_data), encoded_data,
                      :content_type => content_type)
-      rescue
-        Raven.logger.error "Unable to record event with remote Sentry server"
+      rescue => e
+        Raven.logger.error "Unable to record event with remote Sentry server (#{e.class} - #{e.message})"
+        return
       end
+
+      return event
     end
 
   private

data/lib/raven/configuration.rb

@@ -52,6 +52,9 @@ module Raven
     # Should the SSL certificate of the server be verified?
     attr_accessor :ssl_verification
 
+    # Ssl settings passed direactly to faraday's ssl option
+    attr_accessor :ssl
+
     attr_reader :current_environment
 
     # The Faraday adapter to be used. Will default to Net::HTTP when not set.

data/lib/raven/context.rb

@@ -9,11 +9,13 @@ module Raven
     end
     
     attr_reader :extra, :tags, :user
+    attr_accessor :rack_env
     
     def initialize
-      @extra  = {}
-      @tags   = {}
-      @user   = {}
+      @extra = {}
+      @tags = {}
+      @user = {}
+      @rack_env = nil
     end
   end
 end

data/lib/raven/event.rb

@@ -57,6 +57,12 @@ module Raven
 
       block.call(self) if block
 
+      if !self[:http] && context.rack_env
+        self.interface :http do |int|
+          int.from_rack(context.rack_env)
+        end
+      end
+
       # Some type coercion
       @timestamp = @timestamp.strftime('%Y-%m-%dT%H:%M:%S') if @timestamp.is_a?(Time)
       @level = LOG_LEVELS[@level.to_s.downcase] if @level.is_a?(String) || @level.is_a?(Symbol)
@@ -110,7 +116,7 @@ module Raven
       data
     end
 
-    def self.capture_exception(exc, options={}, &block)
+    def self.from_exception(exc, options={}, &block)
       configuration = options[:configuration] || Raven.configuration
       if exc.is_a?(Raven::Error)
         # Try to prevent error reporting loops
@@ -150,7 +156,7 @@ module Raven
       end
     end
 
-    def self.capture_message(message, options={})
+    def self.from_message(message, options={})
       new(options) do |evt|
         evt.message = message
         evt.level = options[:level] || :error
@@ -173,7 +179,7 @@ module Raven
 
     def get_culprit(frames)
       lastframe = frames.reverse.detect { |f| f.in_app } || frames.last
-      "#{lastframe.filename} in #{lastframe.function}" if lastframe
+      "#{lastframe.filename} in #{lastframe.function} at line #{lastframe.lineno}" if lastframe
     end
 
     def parse_exception(exception)
@@ -186,8 +192,10 @@ module Raven
 
     # For cross-language compat
     class << self
-      alias :captureException :capture_exception
-      alias :captureMessage :capture_message
+      alias :captureException :from_exception
+      alias :captureMessage :from_message
+      alias :capture_exception :from_exception
+      alias :capture_message :from_message
     end
 
     private

data/lib/raven/interfaces/http.rb

@@ -31,7 +31,9 @@ module Raven
           # Header
           http_key = key[5..key.length-1].split('_').map{|s| s.capitalize}.join('-')
           self.headers[http_key] = value.to_s
-        else
+        elsif ['CONTENT_TYPE', 'CONTENT_LENGTH'].include? key
+          self.headers[key.capitalize] = value.to_s
+        elsif ['REMOTE_ADDR', 'SERVER_NAME', 'SERVER_PORT'].include? key
           # Environment
           self.env[key] = value.to_s
         end

data/lib/raven/rack.rb

@@ -39,6 +39,10 @@ module Raven
     end
 
     def call(env)
+      # store the current environment in our local context for arbitrary
+      # callers
+      Raven.rack_context(env)
+
       begin
         response = @app.call(env)
       rescue Error => e

data/lib/raven/railtie.rb

@@ -28,6 +28,10 @@ module Raven
         ::ActionDispatch::ShowExceptions.send(:include, Raven::Rails::Middleware::DebugExceptionsCatcher)
       end
     end
+
+    rake_tasks do
+      require 'raven/tasks'
+    end
   end
 end
 

data/lib/raven/tasks.rb

@@ -0,0 +1,10 @@
+require 'rake'
+require 'raven'
+require 'raven/cli'
+
+namespace :raven do
+  desc "Send a test event to the remote Sentry server"
+  task :test, [:dsn] do |t, args|
+    Raven::CLI::test(args.dsn)
+  end
+end

data/lib/raven/transports/http.rb

@@ -27,9 +27,12 @@ module Raven
 
           Raven.logger.debug "Raven HTTP Transport connecting to #{self.configuration.server}"
 
+          ssl_configuration = self.configuration.ssl || {}
+          ssl_configuration[:verify] = self.configuration.ssl_verification if self.configuration.ssl_verification
+
           conn = Faraday.new(
             :url => self.configuration[:server],
-            :ssl => {:verify => self.configuration.ssl_verification}
+            :ssl => ssl_configuration
           ) do |builder|
             builder.adapter(*adapter)
           end

data/lib/raven/version.rb

@@ -1,3 +1,3 @@
 module Raven
-  VERSION = "0.4.6"
+  VERSION = "0.4.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-24 00:00:00.000000000 Z
+date: 2013-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70157840148660 !ruby/object:Gem::Requirement
+  requirement: &70216994650660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 0.7.6
   type: :runtime
   prerelease: false
-  version_requirements: *70157840148660
+  version_requirements: *70216994650660
 - !ruby/object:Gem::Dependency
   name: uuidtools
-  requirement: &70157840148260 !ruby/object:Gem::Requirement
+  requirement: &70216994650180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70157840148260
+  version_requirements: *70216994650180
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70157840147720 !ruby/object:Gem::Requirement
+  requirement: &70216994649560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,21 +44,21 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70157840147720
+  version_requirements: *70216994649560
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70157840147300 !ruby/object:Gem::Requirement
+  requirement: &70216994648520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70157840147300
+  version_requirements: *70216994648520
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70157840163200 !ruby/object:Gem::Requirement
+  requirement: &70216994648060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70157840163200
+  version_requirements: *70216994648060
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70157840162700 !ruby/object:Gem::Requirement
+  requirement: &70216994647080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: '2.10'
   type: :development
   prerelease: false
-  version_requirements: *70157840162700
+  version_requirements: *70216994647080
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70157840162260 !ruby/object:Gem::Requirement
+  requirement: &70216994646440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70157840162260
+  version_requirements: *70216994646440
 - !ruby/object:Gem::Dependency
   name: coveralls
-  requirement: &70157840161800 !ruby/object:Gem::Requirement
+  requirement: &70216994645920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,7 +99,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70157840161800
+  version_requirements: *70216994645920
 description: 
 email: noah@coderanger.net
 executables:
@@ -110,6 +110,7 @@ extra_rdoc_files:
 - LICENSE
 files:
 - lib/raven/backtrace.rb
+- lib/raven/cli.rb
 - lib/raven/client.rb
 - lib/raven/configuration.rb
 - lib/raven/context.rb
@@ -129,6 +130,7 @@ files:
 - lib/raven/rails/middleware/debug_exceptions_catcher.rb
 - lib/raven/railtie.rb
 - lib/raven/sidekiq.rb
+- lib/raven/tasks.rb
 - lib/raven/transports/http.rb
 - lib/raven/transports/udp.rb
 - lib/raven/transports.rb