sentry-raven 0.12.2 → 0.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa170cbdab1ee92ed1a5b471c2edd146e9d3f3c5
-  data.tar.gz: 4ca87cca729a05fbd1564a0e404b6bac57c47267
+  metadata.gz: f4d1ff44aab9878c7070e85ac6bac6a2573e5332
+  data.tar.gz: 7668ff7bdc645dc3d77305f0be63bd028696eee5
 SHA512:
-  metadata.gz: e5f7bef20983567b7b622b119587524a3423f623683b39b2224203fa3df4335ec9aaf3bdde122220e86ca01aa96201d12b34ca62f77381a6c0d3fe923633a506
-  data.tar.gz: ffb038d8c1a843c4458b0d7b21befacad00b14e43b32052db4054a4655e55fdde225482764b233adb8c93ae9d49f1b09b0a2f0d02b7bde654498204541847205
+  metadata.gz: ba3fb97a2c6a77adf1e8d5afcf00d7d94f14b3d5bf3851db165e0624afc1aa702efd61d2c3f24cf9195b8b9e2bedf72244219f7bd61a698e8d443732e227efec
+  data.tar.gz: e96788e536488bed998d179c9c752157044c5a703de5c479c9265966bde529f6d37dcba908478e9a292e4c149256f1ecb67ab748c2e89829ae73c8496c8d7e4a

data/README.md

@@ -13,7 +13,7 @@ We test on Ruby MRI 1.8.7/REE, 1.9.3, 2.0 and 2.1. JRuby support is experimental
 ## Getting Started
 ### Install
 ```ruby
-gem "sentry-raven", :require => 'raven' #, :github => "getsentry/raven-ruby"
+gem "sentry-raven" #, :github => "getsentry/raven-ruby"
 ```
 ### Set SENTRY_DSN
 ```bash

data/bin/raven

@@ -4,8 +4,6 @@ require "raven"
 require "raven/cli"
 require "optparse"
 
-options = {}
-
 parser = OptionParser.new do |opt|
   opt.banner = "Usage: raven COMMAND [OPTIONS]"
   opt.separator  ""

data/lib/raven/backports/uri.rb

@@ -0,0 +1,104 @@
+# :stopdoc:
+
+# Stolen from ruby core's uri/common.rb, with modifications to support 1.8.x
+#
+# https://github.com/ruby/ruby/blob/trunk/lib/uri/common.rb
+#
+#
+
+module URI
+  TBLENCWWWCOMP_ = {} # :nodoc:
+  256.times do |i|
+    TBLENCWWWCOMP_[i.chr] = '%%%02X' % i
+  end
+  TBLENCWWWCOMP_[' '] = '+'
+  TBLENCWWWCOMP_.freeze
+  TBLDECWWWCOMP_ = {} # :nodoc:
+  256.times do |i|
+    h, l = i>>4, i&15
+    TBLDECWWWCOMP_['%%%X%X' % [h, l]] = i.chr
+    TBLDECWWWCOMP_['%%%x%X' % [h, l]] = i.chr
+    TBLDECWWWCOMP_['%%%X%x' % [h, l]] = i.chr
+    TBLDECWWWCOMP_['%%%x%x' % [h, l]] = i.chr
+  end
+  TBLDECWWWCOMP_['+'] = ' '
+  TBLDECWWWCOMP_.freeze
+
+  # Encode given +s+ to URL-encoded form data.
+  #
+  # This method doesn't convert *, -, ., 0-9, A-Z, _, a-z, but does convert SP
+  # (ASCII space) to + and converts others to %XX.
+  #
+  # This is an implementation of
+  # http://www.w3.org/TR/html5/forms.html#url-encoded-form-data
+  #
+  # See URI.decode_www_form_component, URI.encode_www_form
+  def self.encode_www_form_component(s)
+    str = s.to_s
+    if RUBY_VERSION < "1.9" && $KCODE =~ /u/i
+      str.gsub(/([^ a-zA-Z0-9_.-]+)/) do
+        '%' + $1.unpack('H2' * Rack::Utils.bytesize($1)).join('%').upcase
+      end.tr(' ', '+')
+    else
+      str.gsub(/[^*\-.0-9A-Z_a-z]/) {|m| TBLENCWWWCOMP_[m]}
+    end
+  end
+
+  # Decode given +str+ of URL-encoded form data.
+  #
+  # This decodes + to SP.
+  #
+  # See URI.encode_www_form_component, URI.decode_www_form
+  def self.decode_www_form_component(str, enc=nil)
+    raise ArgumentError, "invalid %-encoding (#{str})" unless /\A(?:%[0-9a-fA-F]{2}|[^%])*\z/ =~ str
+    str.gsub(/\+|%[0-9a-fA-F]{2}/) {|m| TBLDECWWWCOMP_[m]}
+  end
+
+  # Generate URL-encoded form data from given +enum+.
+  #
+  # This generates application/x-www-form-urlencoded data defined in HTML5
+  # from given an Enumerable object.
+  #
+  # This internally uses URI.encode_www_form_component(str).
+  #
+  # This method doesn't convert the encoding of given items, so convert them
+  # before call this method if you want to send data as other than original
+  # encoding or mixed encoding data. (Strings which are encoded in an HTML5
+  # ASCII incompatible encoding are converted to UTF-8.)
+  #
+  # This method doesn't handle files.  When you send a file, use
+  # multipart/form-data.
+  #
+  # This is an implementation of
+  # http://www.w3.org/TR/html5/forms.html#url-encoded-form-data
+  #
+  #    URI.encode_www_form([["q", "ruby"], ["lang", "en"]])
+  #    #=> "q=ruby&lang=en"
+  #    URI.encode_www_form("q" => "ruby", "lang" => "en")
+  #    #=> "q=ruby&lang=en"
+  #    URI.encode_www_form("q" => ["ruby", "perl"], "lang" => "en")
+  #    #=> "q=ruby&q=perl&lang=en"
+  #    URI.encode_www_form([["q", "ruby"], ["q", "perl"], ["lang", "en"]])
+  #    #=> "q=ruby&q=perl&lang=en"
+  #
+  # See URI.encode_www_form_component, URI.decode_www_form
+  def self.encode_www_form(enum)
+    enum.map do |k,v|
+      if v.nil?
+        encode_www_form_component(k)
+      elsif v.respond_to?(:to_ary)
+        v.to_ary.map do |w|
+          str = encode_www_form_component(k)
+          unless w.nil?
+            str << '='
+            str << encode_www_form_component(w)
+          end
+        end.join('&')
+      else
+        str = encode_www_form_component(k)
+        str << '='
+        str << encode_www_form_component(v)
+      end
+    end.join('&')
+  end
+end

data/lib/raven/backtrace.rb

@@ -61,7 +61,7 @@ module Raven
       end
 
       def inspect
-        "<Line:#{to_s}>"
+        "<Line:#{self}>"
       end
 
       private
@@ -77,8 +77,8 @@ module Raven
 
       filters = opts[:filters] || []
       filtered_lines = ruby_lines.to_a.map do |line|
-        filters.reduce(line) do |line, proc|
-          proc.call(line)
+        filters.reduce(line) do |nested_line, proc|
+          proc.call(nested_line)
         end
       end.compact
 
@@ -86,7 +86,7 @@ module Raven
         Line.parse(unparsed_line)
       end
 
-      instance = new(lines)
+      new(lines)
     end
 
     def initialize(lines)

data/lib/raven/base.rb

@@ -14,6 +14,11 @@ require 'raven/processor/sanitizedata'
 require 'raven/processor/removecircularreferences'
 require 'raven/processor/utf8conversion'
 
+major, minor, patch = RUBY_VERSION.split('.').map(&:to_i)
+if (major == 1 && minor < 9) || (major == 1 && minor == 9 && patch < 2)
+  require 'raven/backports/uri'
+end
+
 module Raven
   class << self
     # The client object is responsible for delivering formatted data to the Sentry server.
@@ -101,7 +106,7 @@ module Raven
 
     def capture_exception(exception, options = {})
       send_or_skip(exception) do
-        if evt = Event.from_exception(exception, options)
+        if (evt = Event.from_exception(exception, options))
           yield evt if block_given?
           if configuration.async?
             configuration.async.call(evt)
@@ -114,7 +119,7 @@ module Raven
 
     def capture_message(message, options = {})
       send_or_skip(message) do
-        if evt = Event.from_message(message, options)
+        if (evt = Event.from_message(message, options))
           yield evt if block_given?
           if configuration.async?
             configuration.async.call(evt)
@@ -192,7 +197,7 @@ module Raven
     # Extra context shows up as Additional Data within Sentry, and is completely arbitrary.
     #
     # @example
-    #   Raven.tags_context('my_custom_data' => 'value')
+    #   Raven.extra_context('my_custom_data' => 'value')
     def extra_context(options = {})
       self.context.extra.merge!(options)
     end
@@ -208,7 +213,17 @@ module Raven
     def inject
       available_integrations = %w[delayed_job rails sidekiq rack rake]
       integrations_to_load = available_integrations & Gem.loaded_specs.keys
-      integrations_to_load.each { |integration| require "raven/integrations/#{integration}" }
+      # TODO(dcramer): integrations should have some additional checks baked-in
+      # or we should break them out into their own repos. Specifically both the
+      # rails and delayed_job checks are not always valid (i.e. Rails 2.3) and
+      # https://github.com/getsentry/raven-ruby/issues/180
+      integrations_to_load.each do |integration|
+        begin
+          require "raven/integrations/#{integration}"
+        rescue Exception => error
+          self.logger.warn "Unable to load raven/integrations/#{integration}: #{error}"
+        end
+      end
     end
 
     # For cross-language compat

data/lib/raven/cli.rb

@@ -7,7 +7,7 @@ module Raven
 
       logger = ::Logger.new(STDOUT)
       logger.level = ::Logger::ERROR
-      logger.formatter = proc do |severity, datetime, progname, msg|
+      logger.formatter = proc do |_severity, _datetime, _progname, msg|
         "-> #{msg}\n"
       end
 

data/lib/raven/client.rb

@@ -19,6 +19,7 @@ module Raven
     def initialize(configuration)
       @configuration = configuration
       @processors = configuration.processors.map { |v| v.new(self) }
+      @state = ClientState.new
     end
 
     def send(event)
@@ -29,18 +30,25 @@ module Raven
 
       # Set the project ID correctly
       event.project = self.configuration.project_id
+
+      if !@state.should_try?
+        Raven.logger.error("Not sending event due to previous failure(s): #{get_log_message(event)}")
+        return
+      end
+
       Raven.logger.debug "Sending event #{event.id} to Sentry"
 
       content_type, encoded_data = encode(event)
       begin
-        transport.send(generate_auth_header(encoded_data), encoded_data,
+        transport.send(generate_auth_header, encoded_data,
                        :content_type => content_type)
       rescue => e
-        Raven.logger.error "Unable to record event with remote Sentry server (#{e.class} - #{e.message})"
-        e.backtrace[0..10].each { |line| Raven.logger.error(line) }
+        failed_send(e, event)
         return
       end
 
+      successful_send
+
       event
     end
 
@@ -66,6 +74,10 @@ module Raven
       end
     end
 
+    def get_log_message(event)
+      (event && event.message) || '<no message value>'
+    end
+
     def transport
       @transport ||=
         case self.configuration.scheme
@@ -78,7 +90,7 @@ module Raven
         end
     end
 
-    def generate_auth_header(data)
+    def generate_auth_header
       now = Time.now.to_i.to_s
       fields = {
         'sentry_version' => PROTOCOL_VERSION,
@@ -100,5 +112,53 @@ module Raven
       end
     end
 
+    def successful_send
+      @state.success
+    end
+
+    def failed_send(e, event)
+      @state.failure
+      Raven.logger.error "Unable to record event with remote Sentry server (#{e.class} - #{e.message})"
+      e.backtrace[0..10].each { |line| Raven.logger.error(line) }
+      Raven.logger.error("Failed to submit event: #{get_log_message(event)}")
+    end
+
+  end
+
+  class ClientState
+    def initialize
+      reset
+    end
+
+    def should_try?
+      return true if @status == :online
+
+      interval = @retry_after || [@retry_number, 6].min ** 2
+      return true if Time.now - @last_check >= interval
+
+      false
+    end
+
+    def failure(retry_after = nil)
+      @status = :error
+      @retry_number += 1
+      @last_check = Time.now
+      @retry_after = retry_after
+    end
+
+    def success
+      reset
+    end
+
+    def reset
+      @status = :online
+      @retry_number = 0
+      @last_check = nil
+      @retry_after = nil
+    end
+
+    def failed?
+      @status == :error
+    end
   end
 end

data/lib/raven/configuration.rb

@@ -55,9 +55,12 @@ module Raven
     # Should the SSL certificate of the server be verified?
     attr_accessor :ssl_verification
 
-    # Ssl settings passed direactly to faraday's ssl option
+    # SSl settings passed direactly to faraday's ssl option
     attr_accessor :ssl
 
+    # Proxy information to pass to the HTTP adapter
+    attr_accessor :proxy
+
     attr_reader :current_environment
 
     # The Faraday adapter to be used. Will default to Net::HTTP when not set.
@@ -106,6 +109,7 @@ module Raven
       self.encoding = 'gzip'
       self.timeout = 1
       self.open_timeout = 1
+      self.proxy = nil
       self.tags = {}
       self.async = false
       self.catch_debugged_exceptions = true
@@ -160,11 +164,7 @@ module Raven
     end
 
     def send_in_current_environment?
-      if environments
-        environments.include?(current_environment)
-      else
-        true
-      end
+      !!server && (!environments || environments.include?(current_environment))
     end
 
     def log_excluded_environment_message

data/lib/raven/event.rb

@@ -59,11 +59,9 @@ module Raven
 
       block.call(self) if block
 
-      if @configuration.send_in_current_environment?
-        if !self[:http] && context.rack_env
-          self.interface :http do |int|
-            int.from_rack(context.rack_env)
-          end
+      if !self[:http] && context.rack_env
+        self.interface :http do |int|
+          int.from_rack(context.rack_env)
         end
       end
 
@@ -76,7 +74,7 @@ module Raven
     def get_hostname
       # Try to resolve the hostname to an FQDN, but fall back to whatever the load name is
       hostname = Socket.gethostname
-      hostname = Socket.gethostbyname(hostname).first rescue hostname
+      Socket.gethostbyname(hostname).first rescue hostname
     end
 
     def get_modules
@@ -140,7 +138,7 @@ module Raven
       context_lines = configuration[:context_lines]
 
       new(options) do |evt|
-        evt.message = "#{exc.class.to_s}: #{exc.message}"
+        evt.message = "#{exc.class}: #{exc.message}"
         evt.level = options[:level] || :error
 
         evt.interface(:exception) do |int|
@@ -186,7 +184,7 @@ module Raven
     end
 
     # Because linecache can go to hell
-    def self._source_lines(path, from, to)
+    def self._source_lines(_path, _from, _to)
     end
 
     def get_file_context(filename, lineno, context)

data/lib/raven/integrations/sidekiq.rb

@@ -3,10 +3,10 @@ require 'sidekiq'
 
 module Raven
   class Sidekiq
-    def call(worker, msg, queue)
+    def call(_worker, msg, _queue)
       started_at = Time.now
       yield
-    rescue => ex
+    rescue Exception => ex
       Raven.capture_exception(ex, :extra => { :sidekiq => msg },
                                   :time_spent => Time.now-started_at)
       raise

data/lib/raven/integrations/tasks.rb

@@ -4,7 +4,7 @@ require 'raven/cli'
 
 namespace :raven do
   desc "Send a test event to the remote Sentry server"
-  task :test, [:dsn] do |t, args|
+  task :test, [:dsn] do |_t, args|
     Rake::Task["environment"].invoke if defined? Rails
 
     Raven::CLI.test(args.dsn)

data/lib/raven/okjson.rb

@@ -81,7 +81,7 @@ module OkJson
     when false   then "false"
     when nil     then "null"
     else
-      raise Error, "cannot encode #{x.class}: #{x.inspect}"
+      strenc((x.inspect rescue $!.to_s))
     end
   end
 

data/lib/raven/processor/sanitizedata.rb

@@ -3,7 +3,7 @@ module Raven
     STRING_MASK = '********'
     INT_MASK = 0
     DEFAULT_FIELDS = %w(authorization password passwd secret ssn social(.*)?sec)
-    VALUES_RE = /^\d{16}$/
+    CREDIT_CARD_RE = /^(?:\d[ -]*?){13,16}$/
 
     def process(value)
       value.inject(value) { |memo,(k,v)|  memo[k] = sanitize(k,v); memo }
@@ -13,13 +13,15 @@ module Raven
       if v.is_a?(Hash)
         process(v)
       elsif v.is_a?(Array)
-        v.map{|a| sanitize(nil, a)}
+        v.map{|a| sanitize(k, a)}
+      elsif k == 'query_string'
+        sanitize_query_string(v)
       elsif v.is_a?(String) && (json = parse_json_or_nil(v))
         #if this string is actually a json obj, convert and sanitize
         json.is_a?(Hash) ? process(json).to_json : v
-      elsif v.is_a?(Integer) && (VALUES_RE.match(v.to_s) || fields_re.match(k.to_s))
+      elsif v.is_a?(Integer) && (CREDIT_CARD_RE.match(v.to_s) || fields_re.match(k.to_s))
         INT_MASK
-      elsif v.is_a?(String)  && (VALUES_RE.match(v.to_s) || fields_re.match(k.to_s))
+      elsif v.is_a?(String)  && (CREDIT_CARD_RE.match(v.to_s) || fields_re.match(k.to_s))
         STRING_MASK
       else
         v
@@ -28,6 +30,12 @@ module Raven
 
     private
 
+    def sanitize_query_string(query_string)
+      query_hash = CGI::parse(query_string)
+      processed_query_hash = process(query_hash)
+      URI.encode_www_form(processed_query_hash)
+    end
+
     def fields_re
       @fields_re ||= /(#{(DEFAULT_FIELDS + @sanitize_fields).join("|")})/i
     end

data/lib/raven/processor/utf8conversion.rb

@@ -3,9 +3,9 @@ module Raven
 
     def process(value)
       if value.is_a? Array
-        value.map { |v_| process v_ }
+        value.map { |v| process v }
       elsif value.is_a? Hash
-        value.merge(value) { |k, v_| process v_ }
+        value.merge(value) { |_, v| process v }
       else
         clean_invalid_utf8_bytes(value)
       end

data/lib/raven/transports.rb

@@ -10,8 +10,8 @@ module Raven
         @configuration = configuration
       end
 
-      def send(auth_header, data, options = {})
-        raise Error.new('Abstract method not implemented')
+      def send#(auth_header, data, options = {})
+        raise NotImplementedError.new('Abstract method not implemented')
       end
 
       protected

data/lib/raven/transports/http.rb

@@ -9,7 +9,7 @@ module Raven
 
       def send(auth_header, data, options = {})
         project_id = self.configuration[:project_id]
-        path = self.configuration[:path].gsub('/sentry', '') + "/"
+        path = self.configuration[:path] + "/"
 
         response = conn.post "#{path}api/#{project_id}/store/" do |req|
           req.headers['Content-Type'] = options[:content_type]
@@ -37,6 +37,10 @@ module Raven
             builder.adapter(*adapter)
           end
 
+          if self.configuration.proxy
+            conn.options[:proxy] = self.configuration.proxy
+          end
+
           if self.configuration.timeout
             conn.options[:timeout] = self.configuration.timeout
           end

data/lib/raven/transports/udp.rb

@@ -7,7 +7,7 @@ module Raven
   module Transports
     class UDP < Transport
 
-      def send(auth_header, data, options = {})
+      def send(auth_header, data, _options = {})
         conn.send "#{auth_header}\n\n#{data}", 0
       end
 

data/lib/raven/version.rb

@@ -1,3 +1,3 @@
 module Raven
-  VERSION = "0.12.2"
+  VERSION = "0.12.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.12.3
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2015-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: A gem that provides a client interface for the Sentry error logger
 email: getsentry@googlegroups.com
 executables:
@@ -107,6 +121,7 @@ files:
 - README.md
 - bin/raven
 - lib/raven.rb
+- lib/raven/backports/uri.rb
 - lib/raven/backtrace.rb
 - lib/raven/base.rb
 - lib/raven/better_attr_accessor.rb