sentry-raven 0.4.5 → 0.4.6

data/README.md

@@ -1,92 +1,54 @@
 # Raven-Ruby
 
-[![Build Status](https://secure.travis-ci.org/getsentry/raven-ruby.png?branch=master)](http://travis-ci.org/getsentry/raven-ruby)
+[![Gem Version](https://badge.fury.io/rb/sentry-raven.png)](http://badge.fury.io/rb/sentry-raven) [![Build Status](https://secure.travis-ci.org/getsentry/raven-ruby.png?branch=master)](http://travis-ci.org/getsentry/raven-ruby) [![Coverage Status](https://coveralls.io/repos/getsentry/raven-ruby/badge.png?branch=master)](https://coveralls.io/r/getsentry/raven-ruby)
 
 A client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
 
-This library is still forming, so if you are looking to just use it, please check back in a few weeks.
+## Requirements
 
-## Installation
+We test on Ruby MRI 1.8.7, 1.9.2, 1.9.3 and 2.0.0. Other versions/VMs are untested but we will accept pull requests to support them.
 
-Add the following to your `Gemfile`:
+## Installation
 
 ```ruby
-gem "sentry-raven", :git => "https://github.com/getsentry/raven-ruby.git"
-```
-
-Or install manually
-```bash
-$ gem install sentry-raven
+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).
+
 ### Rails 3
 
-Add a `config/initializers/raven.rb` containing:
+In Rails 3, Sentry will "just work," capturing any exceptions thrown in your app. All Rails integrations also
+have mixed-in methods for capturing exceptions you've rescued yourself inside of controllers:
 
 ```ruby
-require 'raven'
-
-Raven.configure do |config|
-  config.dsn = 'http://public:secret@example.com/project-id'
-end
+ # ...
+ rescue => exception
+   capture_exception(exception) # or capture_message('Flux overload')
+   flash[:error] = 'Your flux capacitor is overloaded!'
+ end
 ```
 
 ### Rails 2
 
-No support for Rails 2 yet.
+No support for Rails 2 yet, but it is being worked on.
 
 ### Rack
 
-Basic RackUp file.
-
-```ruby
-require 'raven'
-
-Raven.configure do |config|
-  config.dsn = 'http://public:secret@example.com/project-id'
-end
-
-use Raven::Rack
-```
+Add ```use Raven::Rack``` to your ```config.ru``` (or other rackup file). 
 
 ### Sinatra
 
-```ruby
-require 'sinatra'
-require 'raven'
-
-Raven.configure do |config|
-  config.dsn = 'http://public:secret@example.com/project-id'
-end
-
-use Raven::Rack
-
-get '/' do
-  1 / 0
-end
-```
-
-### Other Ruby
-
-```ruby
-require 'raven'
-
-Raven.configure do |config|
-  config.dsn = 'http://public:secret@example.com/project-id'
-
-  # manually configure environment if ENV['RACK_ENV'] is not defined
-  config.current_environment = 'production'
-end
-```
+Like any other Rack middleware, add ```use Raven::Rack``` to your Sinatra app.
 
 ## Capturing Events
 
 Many implementations will automatically capture uncaught exceptions (such as Rails, Sidekiq or by using
 the Rack middleware). Sometimes you may want to catch those exceptions, but still report on them.
 
-Several helps are available to assist with this.
+Several helpers are available to assist with this.
 
 ### Capture Exceptions in a Block
 
@@ -128,7 +90,7 @@ The following attributes are available:
 * `logger`: the logger name to record this event under
 * `level`: a string representing the level of this event (fatal, error, warning, info, debug)
 * `server_name`: the hostname of the server
-* `tags`: a mapping of tags describing this event
+* `tags`: a mapping of [tags](https://www.getsentry.com/docs/tags/) describing this event
 * `extra`: a mapping of arbitrary context
 
 ## Testing
@@ -138,32 +100,48 @@ $ bundle install
 $ rake spec
 ```
 
-## Notifications in development mode
+## Configuration
 
-By default events will only be sent to Sentry if your application is running in a production environment. This is configured by default if you are running a Rack application (i.e. anytime `ENV['RACK_ENV']` is set).
+### SENTRY_DSN
 
-You can configure Raven to run in non-production environments by configuring the `environments` whitelist:
+After you complete setting up a project, you'll be given a value which we call a DSN, or Data Source Name. It looks a lot like a standard URL, but it's actually just a representation of the configuration required by Raven (the Sentry client). It consists of a few pieces, including the protocol, public and secret keys, the server address, and the project identifier.
 
-```ruby
-require 'raven'
+With Raven, you may either set the ```SENTRY_DSN``` environment variable (recommended), or set your DSN manually in a config block:
 
+```ruby
 Raven.configure do |config|
   config.dsn = 'http://public:secret@example.com/project-id'
-  config.environments = %w[ development production ]
 end
 ```
 
-## Excluding Exceptions
+### Environments
+
+By default events will be sent to Sentry in all environments except 'test', 'development', and 'cucumber'.
+
+You can configure Raven to run only in certain environments by configuring the `environments` whitelist. For example, to only run Sentry in production:
+
+```ruby
+Raven.configure do |config|
+  config.environments = %w[ production ]
+end
+```
+
+Sentry automatically sets the current environment to ```RAILS_ENV```, or if it is not present, ```RACK_ENV```. If you are using Sentry outside of Rack or Rails, you'll need to set the current environment yourself:
+
+```ruby
+Raven.configure do |config|
+  config.current_environment = 'my_cool_environment'
+end
+```
+
+### Excluding Exceptions
 
 If you never wish to be notified of certain exceptions, specify 'excluded_exceptions' in your config file.
 
 In the example below, the exceptions Rails uses to generate 404 responses will be suppressed.
 
 ```ruby
-require 'raven'
-
 Raven.configure do |config|
-  config.dsn = 'http://public:secret@example.com/project-id'
   config.excluded_exceptions = ['ActionController::RoutingError', 'ActiveRecord::RecordNotFound']
 end
 ```
@@ -177,10 +155,7 @@ sanitize keys that match various patterns (e.g. password) and values that resemb
 To specify your own (or to remove the defaults), simply pass them with your configuration:
 
 ```ruby
-require 'raven'
-
 Raven.configure do |config|
-  config.dsn = 'http://public:secret@example.com/project-id'
   config.processors = [Raven::Processor::SanitizeData]
 end
 ```

data/lib/raven.rb

@@ -104,13 +104,17 @@ module Raven
     end
 
     def capture_exception(exception, options={})
-      evt = Event.capture_exception(exception, options)
-      send(evt) if evt
+      if evt = Event.capture_exception(exception, options)
+        yield evt if block_given?
+        send(evt)
+      end
     end
 
     def capture_message(message, options={})
-      evt = Event.capture_message(message, options)
-      send(evt) if evt
+      if evt = Event.capture_message(message, options)
+        yield evt if block_given?
+        send(evt)
+      end
     end
 
     # Bind user context. Merges with existing context (if any).

data/lib/raven/client.rb

@@ -33,7 +33,7 @@ module Raven
         transport.send(generate_auth_header(encoded_data), encoded_data,
                      :content_type => content_type)
       rescue
-        logger.error "Unable to record event with remote Sentry server"
+        Raven.logger.error "Unable to record event with remote Sentry server"
       end
     end
 

data/lib/raven/configuration.rb

@@ -70,8 +70,7 @@ module Raven
     def initialize
       self.server = ENV['SENTRY_DSN'] if ENV['SENTRY_DSN']
       @context_lines = 3
-      self.environments = %w[ production ]
-      self.current_environment = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+      self.current_environment = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'default'
       self.send_modules = true
       self.excluded_exceptions = IGNORE_DEFAULT
       self.processors = [Raven::Processor::SanitizeData]
@@ -122,7 +121,11 @@ module Raven
     end
 
     def send_in_current_environment?
-      environments.include? current_environment
+      if environments
+        environments.include?(current_environment)
+      else
+        !%w[test cucumber development].include?(current_environment)
+      end
     end
 
   end

data/lib/raven/event.rb

@@ -150,15 +150,6 @@ module Raven
       end
     end
 
-    def self.capture_rack_exception(exc, rack_env, options={}, &block)
-      capture_exception(exc, options) do |evt|
-        evt.interface :http do |int|
-          int.from_rack(rack_env)
-        end
-        block.call(evt) if block
-      end
-    end
-
     def self.capture_message(message, options={})
       new(options) do |evt|
         evt.message = message

data/lib/raven/rack.rb

@@ -18,6 +18,22 @@ module Raven
   #
   # Use a standard Raven.configure call to configure your server credentials.
   class Rack
+    def self.capture_exception(exception, env, options = {})
+      Raven.capture_exception(exception, options) do |evt|
+        evt.interface :http do |int|
+          int.from_rack(env)
+        end
+      end
+    end
+
+    def self.capture_message(message, env, options = {})
+      Raven.capture_message(message, options) do |evt|
+        evt.interface :http do |int|
+          int.from_rack(env)
+        end
+      end
+    end
+
     def initialize(app)
       @app = app
     end
@@ -28,8 +44,7 @@ module Raven
       rescue Error => e
         raise # Don't capture Raven errors
       rescue Exception => e
-        evt = Event.capture_rack_exception(e, env)
-        Raven.send(evt)
+        Raven::Rack.capture_exception(e, env)
         raise
       ensure
         Context.clear!
@@ -38,8 +53,7 @@ module Raven
       error = env['rack.exception'] || env['sinatra.error']
 
       if error
-        evt = Event.capture_rack_exception(error, env)
-        Raven.send(evt) if evt
+        Raven::Rack.capture_exception(error, env)
       end
 
       response

data/lib/raven/rails/controller_methods.rb

@@ -0,0 +1,13 @@
+module Raven
+  module Rails
+    module ControllerMethods
+      def capture_message(message, options = {})
+        Raven::Rack.capture_message(message, request.env, options)
+      end
+
+      def capture_exception(exception, options = {})
+        Raven::Rack.capture_exception(exception, request.env, options)
+      end
+    end
+  end
+end

data/lib/raven/rails/middleware/debug_exceptions_catcher.rb

@@ -7,8 +7,7 @@ module Raven
         end
 
         def render_exception_with_raven(env, exception)
-          evt = Raven::Event.capture_rack_exception(exception, env)
-          Raven.send(evt) if evt
+          Raven::Rack.capture_exception(exception, env)
           render_exception_without_raven(env, exception)
         end
       end

data/lib/raven/railtie.rb

@@ -7,6 +7,13 @@ module Raven
       app.config.middleware.insert 0, "Raven::Rack"
     end
 
+    initializer 'raven.action_controller' do
+      ActiveSupport.on_load :action_controller do
+        require 'raven/rails/controller_methods'
+        include Raven::Rails::ControllerMethods
+      end
+    end
+
     config.after_initialize do
       Raven.configure(true) do |config|
         config.logger ||= ::Rails.logger
@@ -23,3 +30,4 @@ module Raven
     end
   end
 end
+

data/lib/raven/transports/http.rb

@@ -10,7 +10,8 @@ module Raven
     class HTTP < Transport
 
       def send(auth_header, data, options = {})
-        response = conn.post '/api/store/' do |req|
+        project_id = self.configuration[:project_id]
+        response = conn.post "/api/#{project_id}/store/" do |req|
           req.headers['Content-Type'] = options[:content_type]
           req.headers['X-Sentry-Auth'] = auth_header
           req.body = data

data/lib/raven/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-18 00:00:00.000000000 Z
+date: 2013-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70093744928500 !ruby/object:Gem::Requirement
+  requirement: &70157840148660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 0.7.6
   type: :runtime
   prerelease: false
-  version_requirements: *70093744928500
+  version_requirements: *70157840148660
 - !ruby/object:Gem::Dependency
   name: uuidtools
-  requirement: &70093744926620 !ruby/object:Gem::Requirement
+  requirement: &70157840148260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70093744926620
+  version_requirements: *70157840148260
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70093744923680 !ruby/object:Gem::Requirement
+  requirement: &70157840147720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70093744923680
+  version_requirements: *70157840147720
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70093744938880 !ruby/object:Gem::Requirement
+  requirement: &70157840147300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,51 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70093744938880
+  version_requirements: *70157840147300
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70157840163200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70157840163200
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70157840162700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: *70157840162700
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70157840162260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70157840162260
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: &70157840161800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70157840161800
 description: 
 email: noah@coderanger.net
 executables:
@@ -81,6 +125,7 @@ files:
 - lib/raven/processor.rb
 - lib/raven/processors/sanitizedata.rb
 - lib/raven/rack.rb
+- lib/raven/rails/controller_methods.rb
 - lib/raven/rails/middleware/debug_exceptions_catcher.rb
 - lib/raven/railtie.rb
 - lib/raven/sidekiq.rb