sentry-raven 0.9.4 → 0.10.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZGNhZTllOWIxNjg1ZDNkZmMxMzBmNmJhZDEzNjliOGYyNzNiZDc1MQ==
-  data.tar.gz: !binary |-
-    ZWRjN2MyNTA2YzQ4ODliYTY0N2Y3ZTg3Y2MyNjUzMjYxODg0NWYzZg==
+SHA1:
+  metadata.gz: 057d8d70d5fbf847fa8c41a33a8dabc5f4bf1f4d
+  data.tar.gz: 2042e4bbae25824369c260746f21c31b64d3c4f4
 SHA512:
-  metadata.gz: !binary |-
-    ZDI3NWFlZjY2YjBjNjYxNTBlYjg5NWRmOWQ2OWRmYTZlY2RkYzIyNTg2NDRl
-    NzZkYjQ0OTFiNjhmMmZlMzRiYzgyNWRkYjAzZWUzN2NlM2M3OGZiNDRlNzBk
-    YjhmYWM0ZjlkNTU2YWE3NDkwMTM2M2RiNWJjMDIzNDA0NjAzMDU=
-  data.tar.gz: !binary |-
-    YmIzZDVlM2RhZDU3MzNiYmI2MDkxNTM0MmYxNTRhOTEwZTRkOTkyOWMxOWEx
-    M2U4ZmQwN2MxOGM0NDYzYWZiY2Y1NmIxOTNkZTIyN2RiYTliMGVlNjU0NmUy
-    MWFjZDgzYmEzYmNiZWU5ODFmNGY4NmQ0YmY5ZGRiNDg2MmM5YmE=
+  metadata.gz: a74a58c59287a2d4fde07886f26d9634e08f1b3b5bcf9c5c793facaec632094a83e047f426953a88b193911b71e4364fa541a0276b851f2dc86c1ea1a1aa7913
+  data.tar.gz: de5656fd29ce7aff1ad06c919179363f3330ff05cd4a7ab0ad17a733fb300d4468c2e3b487b4c9480abf9841d8ed28a928336d31d8df0d7d9a979c1f0cf9938b

data/README.md

@@ -25,7 +25,15 @@ the Rack middleware). If you catch those exceptions yourself, but still want to
 
 ### Rails 3 or 4
 
-In Rails 3 or 4 all uncaught exceptions will be automatically reported.
+In Rails 3 or 4 all uncaught exceptions will be automatically reported under most situations.
+
+You'll still want to ensure you've disabled anything that would prevent errors from being propagated to the ```Raven::Rack``` middleware:
+
+Disable ```ActionDispatch::ShowExceptions```:
+
+```ruby
+config.action_dispatch.show_exceptions = false
+```
 
 #### Delayed::Job
 
@@ -175,9 +183,11 @@ end
 
 ### Environments
 
-By default events will be sent to Sentry in all environments except 'test', 'development', and 'cucumber'.
+By default, events will be sent to Sentry in all environments. If you do not wish
+to send events in an environment, we suggest you unset the ```SENTRY_DSN```
+variable in that environment.
 
-You can configure Raven to run only in certain environments by configuring the `environments` whitelist. For example, to only run Sentry in production:
+Alternately, 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|
@@ -233,7 +243,7 @@ end
 
 ### Asynchronous Delivery
 
-When an error occurs, the notification is immediately sent to Sentry. Raven can be configured 
+When an error occurs, the notification is immediately sent to Sentry. Raven can be configured
 to send notifications asynchronously:
 
 ```ruby
@@ -244,7 +254,7 @@ Raven.configure do |config|
 end
 ```
 
-This example uses a thread, but other tools can be used (GirlFriday, Resque, Sidekiq, etc...) as 
+This example uses a thread, but other tools can be used (GirlFriday, Resque, Sidekiq, etc...) as
 long as the `event` argument is eventually passed to `Raven.send`.
 
 ### Logging
@@ -261,6 +271,35 @@ Raven.configure do |config|
 end
 ```
 
+If you are using Rails, Raven will default to using Rails.logger as the logger.
+
+### Encoding
+
+While unlikely that you'll need to change it, by default Raven compresses outgoing messages with gzip. This has a slight impact on performance, but due to the size of many Ruby stacktrace it's required for the serve to accept the content.
+
+To disable gzip, set the encoding to 'json':
+
+```ruby
+Raven.configure do |config|
+  config.encoding = 'json'
+end
+```
+
+### Silencing the ready message
+
+Upon start, Raven will write the following message to the log at the INFO level:
+
+    ** [out :: hostname.example.com] I, [2014-07-22T15:32:57.498368 #30897]  INFO -- : ** [Raven] Raven 0.9.4 ready to catch errors"
+
+You can turn off this message by passing `true` to `Raven.configure`
+
+```ruby
+Raven.configure(true) do |config|
+   ...
+end
+```
+
+
 ## Sanitizing Data (Processors)
 
 If you need to sanitize or pre-process (before its sent to the server) data, you can do so using the Processors

data/lib/raven/better_attr_accessor.rb

@@ -0,0 +1,44 @@
+require 'set'
+
+module Raven
+  module BetterAttrAccessor
+
+    def attributes
+      Hash[
+        self.class.attributes.map do |attr|
+          [attr, send(attr)]
+        end
+      ]
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def attributes
+        @attributes ||= Set.new
+
+        if superclass.include? BetterAttrAccessor
+          @attributes + superclass.attributes
+        else
+          @attributes
+        end
+      end
+
+      def attr_accessor(attr, options = {})
+        @attributes ||= Set.new
+        @attributes << attr.to_s
+
+        define_method attr do
+          if instance_variable_defined? "@#{attr}"
+            instance_variable_get "@#{attr}"
+          elsif options.key? :default
+            instance_variable_set "@#{attr}", options[:default].dup
+          end
+        end
+        attr_writer attr
+      end
+    end
+  end
+end

data/lib/raven/cli.rb

@@ -12,7 +12,7 @@ module Raven
       end
 
       Raven.configuration.logger = logger
-
+      Raven.configuration.timeout = 5
       Raven.configuration.dsn = dsn if dsn
 
       # wipe out env settings to ensure we send the event

data/lib/raven/client.rb

@@ -59,7 +59,7 @@ module Raven
       case self.configuration.encoding
       when 'gzip'
         gzipped = Zlib::Deflate.deflate(encoded)
-        b64_encoded = Base64.strict_encode64(gzipped)
+        b64_encoded = strict_encode64(gzipped)
         return 'application/octet-stream', b64_encoded
       else
         return 'application/json', encoded
@@ -89,5 +89,16 @@ module Raven
       }
       'Sentry ' + fields.map { |key, value| "#{key}=#{value}" }.join(', ')
     end
+
+    private
+
+    def strict_encode64(string)
+      if Base64.respond_to? :strict_encode64
+        Base64.strict_encode64 string
+      else # Ruby 1.8
+        Base64.encode64(string)[0..-2]
+      end
+    end
+
   end
 end

data/lib/raven/configuration.rb

@@ -76,6 +76,10 @@ module Raven
     # Exceptions from these directories to be ignored
     attr_accessor :app_dirs_pattern
 
+    # Catch exceptions before they're been processed by
+    # ActionDispatch::ShowExceptions or ActionDispatch::DebugExceptions
+    attr_accessor :catch_debugged_exceptions
+
     IGNORE_DEFAULT = ['ActiveRecord::RecordNotFound',
                       'ActionController::RoutingError',
                       'ActionController::InvalidAuthenticityToken',
@@ -92,11 +96,12 @@ module Raven
       self.excluded_exceptions = IGNORE_DEFAULT
       self.processors = [Raven::Processor::SanitizeData]
       self.ssl_verification = false
-      self.encoding = 'json'
+      self.encoding = 'gzip'
       self.timeout = 1
       self.open_timeout = 1
       self.tags = {}
       self.async = false
+      self.catch_debugged_exceptions = true
     end
 
     def server=(value)
@@ -150,7 +155,7 @@ module Raven
       if environments
         environments.include?(current_environment)
       else
-        !%w[test cucumber development].include?(current_environment)
+        true
       end
     end
 

data/lib/raven/interfaces.rb

@@ -1,39 +1,23 @@
-require 'hashie'
+require 'raven/better_attr_accessor'
 
 module Raven
 
   INTERFACES = {}
 
-  class Interface < Hashie::Dash
-    if defined?(Hashie::Extensions::Dash::IndifferentAccess)
-      include Hashie::Extensions::Dash::IndifferentAccess
-    end
-
-    def initialize(attributes = {}, &block)
-      @check_required = false
-      super(attributes)
-      block.call(self) if block
-      @check_required = true
-
-      begin
-        assert_required_attributes_set!
-      rescue NoMethodError
-        assert_required_properties_set!
-      end
+  class Interface
+    include BetterAttrAccessor
+    alias_method :to_hash, :attributes
 
-    end
-
-    def assert_required_attributes_set!
-      super if @check_required
-    end
+    def initialize(attributes = nil)
+      attributes.each do |attr, value|
+        send "#{attr}=", value
+      end if attributes
 
-    def assert_required_properties_set!
-      super if @check_required
+      yield self if block_given?
     end
 
     def self.name(value = nil)
-      @interface_name = value if value
-      @interface_name
+      @interface_name ||= value
     end
   end
 

data/lib/raven/interfaces/exception.rb

@@ -4,10 +4,10 @@ module Raven
   class ExceptionInterface < Interface
 
     name 'exception'
-    property :type, :required => true
-    property :value, :required => true
-    property :module
-    property :stacktrace
+    attr_accessor :type
+    attr_accessor :value
+    attr_accessor :module
+    attr_accessor :stacktrace
 
     def to_hash(*args)
       data = super(*args)

data/lib/raven/interfaces/http.rb

@@ -4,13 +4,13 @@ module Raven
   class HttpInterface < Interface
 
     name 'request'
-    property :url, :required => true
-    property :method, :required => true
-    property :data
-    property :query_string
-    property :cookies
-    property :headers
-    property :env
+    attr_accessor :url
+    attr_accessor :method
+    attr_accessor :data
+    attr_accessor :query_string
+    attr_accessor :cookies
+    attr_accessor :headers
+    attr_accessor :env
 
     def initialize(*arguments)
       self.headers = {}

data/lib/raven/interfaces/message.rb

@@ -4,8 +4,8 @@ module Raven
   class MessageInterface < Interface
 
     name 'sentry.interfaces.Message'
-    property :message, :required => true
-    property :params
+    attr_accessor :message
+    attr_accessor :params
 
     def initialize(*arguments)
       self.params = []

data/lib/raven/interfaces/stack_trace.rb

@@ -1,12 +1,10 @@
-require 'hashie'
-
 require 'raven/interfaces'
 
 module Raven
   class StacktraceInterface < Interface
 
     name 'stacktrace'
-    property :frames, :default => []
+    attr_accessor :frames, :default => []
 
     def initialize(*arguments)
       self.frames = []
@@ -25,27 +23,20 @@ module Raven
 
     # Not actually an interface, but I want to use the same style
     class Frame < Interface
-      property :abs_path
-      property :function
-      property :vars
-      property :pre_context
-      property :post_context
-      property :context_line
-      property :lineno, :required => true
-      property :in_app
-
-      def initialize(*arguments)
-        self.vars = {}
-        self.pre_context = []
-        self.post_context = []
-        super(*arguments)
-      end
+      attr_accessor :abs_path
+      attr_accessor :function
+      attr_accessor :vars,         :default => []
+      attr_accessor :pre_context,  :default => []
+      attr_accessor :post_context, :default => []
+      attr_accessor :context_line
+      attr_accessor :lineno
+      attr_accessor :in_app
 
       def filename
         return nil if self.abs_path.nil?
 
         prefix = $LOAD_PATH.select { |s| self.abs_path.start_with?(s.to_s) }.sort_by { |s| s.to_s.length }.last
-        prefix ? self.abs_path[prefix.chomp(File::SEPARATOR).length+1..-1] : self.abs_path
+        prefix ? self.abs_path[prefix.to_s.chomp(File::SEPARATOR).length+1..-1] : self.abs_path
       end
 
       def to_hash(*args)

data/lib/raven/processors/sanitizedata.rb

@@ -1,4 +1,5 @@
 require 'raven/processor'
+require 'json'
 
 module Raven
   module Processor
@@ -24,6 +25,16 @@ module Raven
           value.map do |value_|
             apply(value_, key, visited, &block)
           end
+        elsif value.is_a?(String) && json_hash = JSON.parse(value) rescue nil
+          return "[...]" if visited.include?(value.__id__)
+          visited += [value.__id__]
+
+          json_hash = json_hash.each.reduce({}) do |memo, (k, v)|
+            memo[k] = apply(v, k, visited, &block)
+            memo
+          end
+
+          json_hash.to_json
         else
           block.call(key, value)
         end

data/lib/raven/rack.rb

@@ -21,8 +21,8 @@ module Raven
   # Use a standard Raven.configure call to configure your server credentials.
   class Rack
     def self.capture_exception(exception, env, options = {})
-      if env[:requested_at]
-        options[:time_spent] = Time.now - env[:requested_at]
+      if env['requested_at']
+        options[:time_spent] = Time.now - env['requested_at']
       end
       Raven.capture_exception(exception, options) do |evt|
         evt.interface :http do |int|
@@ -32,8 +32,8 @@ module Raven
     end
 
     def self.capture_message(message, env, options = {})
-      if env[:requested_at]
-        options[:time_spent] = Time.now - env[:requested_at]
+      if env['requested_at']
+        options[:time_spent] = Time.now - env['requested_at']
       end
       Raven.capture_message(message, options) do |evt|
         evt.interface :http do |int|
@@ -52,7 +52,7 @@ module Raven
 
       # store the current environment in our local context for arbitrary
       # callers
-      env[:requested_at] = Time.now
+      env['requested_at'] = Time.now
       Raven.rack_context(env)
 
       begin
@@ -60,6 +60,7 @@ module Raven
       rescue Error
         raise # Don't capture Raven errors
       rescue Exception => e
+        Raven.logger.debug "Collecting %p: %s" % [ e.class, e.message ]
         Raven::Rack.capture_exception(e, env)
         raise
       end

data/lib/raven/railtie.rb

@@ -20,12 +20,14 @@ module Raven
         config.project_root ||= ::Rails.root
       end
 
-      if defined?(::ActionDispatch::DebugExceptions)
-        require 'raven/rails/middleware/debug_exceptions_catcher'
-        ::ActionDispatch::DebugExceptions.send(:include, Raven::Rails::Middleware::DebugExceptionsCatcher)
-      elsif defined?(::ActionDispatch::ShowExceptions)
-        require 'raven/rails/middleware/debug_exceptions_catcher'
-        ::ActionDispatch::ShowExceptions.send(:include, Raven::Rails::Middleware::DebugExceptionsCatcher)
+      if Raven.configuration.catch_debugged_exceptions
+        if defined?(::ActionDispatch::DebugExceptions)
+          require 'raven/rails/middleware/debug_exceptions_catcher'
+          ::ActionDispatch::DebugExceptions.send(:include, Raven::Rails::Middleware::DebugExceptionsCatcher)
+        elsif defined?(::ActionDispatch::ShowExceptions)
+          require 'raven/rails/middleware/debug_exceptions_catcher'
+          ::ActionDispatch::ShowExceptions.send(:include, Raven::Rails::Middleware::DebugExceptionsCatcher)
+        end
       end
     end
 

data/lib/raven/sidekiq.rb

@@ -22,6 +22,6 @@ if Sidekiq::VERSION < '3'
   end
 else
   Sidekiq.configure_server do |config|
-    config.error_handlers << Proc.new {|ex,context| Raven.capture_exception(ex, context) }
+    config.error_handlers << Proc.new {|ex,context| Raven.capture_exception(ex, :extra => {:sidekiq => context}) }
   end
 end

data/lib/raven/version.rb

@@ -1,3 +1,3 @@
 module Raven
-  VERSION = "0.9.4"
+  VERSION = "0.10.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.10.1
 platform: ruby
 authors:
 - Noah Kantrowitz
@@ -9,62 +9,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-09 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.7.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.7.6
 - !ruby/object:Gem::Dependency
   name: uuidtools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -73,14 +59,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -99,14 +85,28 @@ dependencies:
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -118,12 +118,9 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
-- LICENSE
-- README.md
-- bin/raven
-- lib/raven.rb
 - lib/raven/backtrace.rb
 - lib/raven/base.rb
+- lib/raven/better_attr_accessor.rb
 - lib/raven/cli.rb
 - lib/raven/client.rb
 - lib/raven/configuration.rb
@@ -131,11 +128,11 @@ files:
 - lib/raven/error.rb
 - lib/raven/event.rb
 - lib/raven/integrations/delayed_job.rb
-- lib/raven/interfaces.rb
 - lib/raven/interfaces/exception.rb
 - lib/raven/interfaces/http.rb
 - lib/raven/interfaces/message.rb
 - lib/raven/interfaces/stack_trace.rb
+- lib/raven/interfaces.rb
 - lib/raven/linecache.rb
 - lib/raven/logger.rb
 - lib/raven/okjson.rb
@@ -147,11 +144,15 @@ files:
 - lib/raven/railtie.rb
 - lib/raven/sidekiq.rb
 - lib/raven/tasks.rb
-- lib/raven/transports.rb
 - lib/raven/transports/http.rb
 - lib/raven/transports/udp.rb
+- lib/raven/transports.rb
 - lib/raven/version.rb
+- lib/raven.rb
 - lib/sentry-raven.rb
+- README.md
+- LICENSE
+- bin/raven
 homepage: http://github.com/getsentry/raven-ruby
 licenses:
 - Apache-2.0
@@ -162,17 +163,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for the Sentry error logger