sentry-raven 0.4.0 → 0.4.1

data/lib/raven/client.rb

@@ -1,10 +1,11 @@
 require 'openssl'
-require 'uri'
 require 'multi_json'
-require 'faraday'
+require 'zlib'
+require 'base64'
 
 require 'raven/version'
-require 'raven/error'
+require 'raven/transports/http'
+require 'raven/transports/udp'
 
 module Raven
 
@@ -12,7 +13,7 @@ module Raven
 
     PROTOCOL_VERSION = '2.0'
     USER_AGENT = "raven-ruby/#{Raven::VERSION}"
-    AUTH_HEADER_KEY = 'X-Sentry-Auth'
+    CONTENT_TYPE = 'application/json'
 
     attr_accessor :configuration
 
@@ -20,28 +21,44 @@ module Raven
       @configuration = configuration
     end
 
-    def conn
-      # Error checking
-      raise Error.new('No server specified') unless self.configuration[:server]
-      raise Error.new('No public key specified') unless self.configuration[:public_key]
-      raise Error.new('No secret key specified') unless self.configuration[:secret_key]
-      raise Error.new('No project ID specified') unless self.configuration[:project_id]
+    def send(event)
+      return unless configuration.send_in_current_environment?
 
-      Raven.logger.debug "Raven client connecting to #{self.configuration[:server]}"
+      # Set the project ID correctly
+      event.project = self.configuration.project_id
+      Raven.logger.debug "Sending event #{event.id} to Sentry"
+      content_type, encoded_data = encode(event)
+      transport.send(generate_auth_header(encoded_data), encoded_data,
+                     :content_type => content_type)
+    end
 
-      @conn ||=  Faraday.new(
-          :url => self.configuration[:server],
-          :ssl => {:verify => self.configuration.ssl_verification}
-        ) do |builder|
-          builder.adapter  Faraday.default_adapter
-          builder.options[:timeout] = self.configuration.timeout if self.configuration.timeout
-          builder.options[:open_timeout] = self.configuration.open_timeout if self.configuration.open_timeout
-        end
+  private
+
+    def encode(event)
+      encoded = MultiJson.encode(event.to_hash)
+      case self.configuration.encoding
+      when 'gzip'
+        gzipped = Zlib::Deflate.deflate(encoded)
+        b64_encoded = Base64.strict_encode64(gzipped)
+        return 'application/octet-stream', b64_encoded
+      else
+        return 'application/json', encoded
+      end
     end
 
+    def transport
+      @transport ||= case self.configuration.scheme
+        when 'udp'
+          Transports::UDP.new self.configuration
+        when 'http', 'https'
+          Transports::HTTP.new self.configuration
+        else
+          raise Error.new("Unknown transport scheme '#{self.configuration.scheme}'")
+        end
+    end
 
     def generate_signature(timestamp, data)
-      OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha1'), self.configuration[:secret_key], "#{timestamp} #{data}")
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha1'), self.configuration.secret_key, "#{timestamp} #{data}")
     end
 
     def generate_auth_header(data)
@@ -50,27 +67,12 @@ module Raven
         'sentry_version' => PROTOCOL_VERSION,
         'sentry_client' => USER_AGENT,
         'sentry_timestamp' => now,
-        'sentry_key' => self.configuration[:public_key],
+        'sentry_key' => self.configuration.public_key,
         'sentry_signature' => generate_signature(now, data)
       }
       'Sentry ' + fields.map{|key, value| "#{key}=#{value}"}.join(', ')
     end
 
-    def send(event)
-      return unless configuration.send_in_current_environment?
-
-      # Set the project ID correctly
-      event.project = self.configuration[:project_id]
-      Raven.logger.debug "Sending event #{event.id} to Sentry"
-      response = self.conn.post '/api/store/' do |req|
-        req.headers['Content-Type'] = 'application/json'
-        req.body = MultiJson.encode(event.to_hash)
-        req.headers[AUTH_HEADER_KEY] = self.generate_auth_header(req.body)
-      end
-      raise Error.new("Error from Sentry server (#{response.status}): #{response.body}") unless response.status == 200
-      response
-    end
-
   end
 
 end

data/lib/raven/configuration.rb

@@ -1,8 +1,8 @@
 module Raven
   class Configuration
 
-    # Base URL of the Sentry server
-    attr_accessor :server
+    # Simple server string (setter provided below)
+    attr_reader :server
 
     # Public key for authentication with the Sentry server
     attr_accessor :public_key
@@ -10,9 +10,18 @@ module Raven
     # Secret key for authentication with the Sentry server
     attr_accessor :secret_key
 
+    # Accessors for the component parts of the DSN
+    attr_accessor :scheme
+    attr_accessor :host
+    attr_accessor :port
+    attr_accessor :path
+
     # Project ID number to send to the Sentry server
     attr_accessor :project_id
 
+    # Encoding type for event bodies
+    attr_reader :encoding
+
     # Logger to use internally
     attr_accessor :logger
 
@@ -59,22 +68,36 @@ module Raven
       self.excluded_exceptions = IGNORE_DEFAULT
       self.processors = [Raven::Processor::SanitizeData]
       self.ssl_verification = true
+      self.encoding = 'json'
+      self.timeout = 1
+      self.open_timeout = 1
     end
 
     def server=(value)
       uri = URI::parse(value)
+      uri_path = uri.path.split('/')
+
       if uri.user
         # DSN-style string
-        uri_path = uri.path.split('/')
         @project_id = uri_path.pop
-        @server = "#{uri.scheme}://#{uri.host}"
-        @server << ":#{uri.port}" unless uri.port == {'http'=>80,'https'=>443}[uri.scheme]
-        @server << uri_path.join('/')
         @public_key = uri.user
         @secret_key = uri.password
-      else
-        @server = value
       end
+
+      @scheme = uri.scheme
+      @host = uri.host
+      @port = uri.port if uri.port
+      @path = uri_path.join('/')
+
+      # For anyone who wants to read the base server string
+      @server = "#{@scheme}://#{@host}"
+      @server << ":#{@port}" unless @port == {'http'=>80,'https'=>443}[@scheme]
+      @server << @path
+    end
+
+    def encoding=(encoding)
+      raise Error.new('Unsupported encoding') unless ['gzip', 'json'].include? encoding
+      @encoding = encoding
     end
 
     alias_method :dsn=, :server=

data/lib/raven/event.rb

@@ -20,6 +20,8 @@ module Raven
 
     BACKTRACE_RE = /^(.+?):(\d+)(?::in `(.+?)')?$/
 
+    PLATFORM = "ruby"
+
     attr_reader :id
     attr_accessor :project, :message, :timestamp, :level
     attr_accessor :logger, :culprit, :server_name, :modules, :extra, :tags
@@ -82,6 +84,7 @@ module Raven
         'level' => self.level,
         'project' => self.project,
         'logger' => self.logger,
+        'platform' => PLATFORM,
       }
       data['culprit'] = self.culprit if self.culprit
       data['server_name'] = self.server_name if self.server_name
@@ -115,18 +118,18 @@ module Raven
         if (exc.backtrace)
           evt.interface :stack_trace do |int|
             backtrace = Backtrace.parse(exc.backtrace)
-            int.frames = backtrace.lines.reverse.map do |line|
+            int.frames = backtrace.lines.reverse.map { |line|
               int.frame do |frame|
                 frame.abs_path = line.file
                 frame.function = line.method
                 frame.lineno = line.number
                 frame.in_app = line.in_app
-                if context_lines
+                if context_lines and frame.abs_path
                   frame.pre_context, frame.context_line, frame.post_context = \
                     evt.get_context(frame.abs_path, frame.lineno, context_lines)
                 end
               end
-            end
+            }.select{ |f| f.filename }
             evt.culprit = evt.get_culprit(int.frames)
           end
         end

data/lib/raven/interfaces/stack_trace.rb

@@ -43,6 +43,8 @@ module Raven
       end
 
       def filename
+        return nil if self.abs_path.nil?
+
         prefix = $:.select {|s| self.abs_path.start_with?(s)}.sort_by {|s| s.length}.last
         prefix ? self.abs_path[prefix.chomp(File::SEPARATOR).length+1..-1] : self.abs_path
       end

data/lib/raven/rack.rb

@@ -33,8 +33,10 @@ module Raven
         raise
       end
 
-      if env['rack.exception']
-        evt = Event.capture_rack_exception(env['rack.exception'], env)
+      error = env['rack.exception'] || env['sinatra.error']
+
+      if error
+        evt = Event.capture_rack_exception(error, env)
         Raven.send(evt) if evt
       end
 

data/lib/raven/transports.rb

@@ -0,0 +1,32 @@
+require 'raven/error'
+
+module Raven
+
+  module Transports
+
+    class Transport
+
+      attr_accessor :configuration
+
+      def initialize(configuration)
+        @configuration = configuration
+      end
+
+      def send(auth_header, data, options = {})
+        raise Error.new('Abstract method not implemented')
+      end
+
+    protected
+
+      def verify_configuration
+        raise Error.new('No server specified') unless self.configuration.server
+        raise Error.new('No public key specified') unless self.configuration.public_key
+        raise Error.new('No secret key specified') unless self.configuration.secret_key
+        raise Error.new('No project ID specified') unless self.configuration.project_id
+      end
+
+    end
+
+  end
+
+end

data/lib/raven/transports/http.rb

@@ -0,0 +1,44 @@
+require 'faraday'
+
+require 'raven/transports'
+require 'raven/error'
+
+module Raven
+
+  module Transports
+
+    class HTTP < Transport
+
+      def send(auth_header, data, options = {})
+        response = conn.post '/api/store/' do |req|
+          req.headers['Content-Type'] = options[:content_type]
+          req.headers['X-Sentry-Auth'] = auth_header
+          req.body = data
+        end
+        raise Error.new("Error from Sentry server (#{response.status}): #{response.body}") unless response.status == 200
+      end
+
+    private
+
+      def conn
+        @conn ||= begin
+          self.verify_configuration
+
+          Raven.logger.debug "Raven HTTP Transport connecting to #{self.configuration.server}"
+
+          Faraday.new(
+            :url => self.configuration[:server],
+            :ssl => {:verify => self.configuration.ssl_verification}
+          ) do |builder|
+            builder.adapter Faraday.default_adapter
+            builder.options[:timeout] = self.configuration.timeout if self.configuration.timeout
+            builder.options[:open_timeout] = self.configuration.open_timeout if self.configuration.open_timeout
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/raven/transports/udp.rb

@@ -0,0 +1,35 @@
+require 'socket'
+
+require 'raven/transports'
+require 'raven/error'
+
+module Raven
+
+  module Transports
+
+    class UDP < Transport
+
+      def send(auth_header, data, options = {})
+        conn.send "#{auth_header}\n\n#{data}", 0
+      end
+
+    private
+
+      def conn
+        @conn ||= begin
+          sock = UDPSocket.new
+          sock.connect(self.configuration.host, self.configuration.port)
+          sock
+        end
+      end
+
+      def verify_configuration
+        super
+        raise Error.new('No port specified') unless self.configuration.port
+      end
+
+    end
+
+  end
+
+end

data/lib/raven/version.rb

@@ -1,3 +1,3 @@
 module Raven
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,84 +1,90 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sentry-raven
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 0
-  version: 0.4.0
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Noah Kantrowitz
 - David Cramer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-01-04 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: faraday
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 7
-        - 6
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.7.6
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: uuidtools
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.6
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: multi_json
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: hashie
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: noah@coderanger.net
-executables: 
+executables:
 - raven
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
 - LICENSE
-files: 
+files:
 - lib/raven/backtrace.rb
 - lib/raven/client.rb
 - lib/raven/configuration.rb
@@ -97,40 +103,37 @@ files:
 - lib/raven/rails/middleware/debug_exceptions_catcher.rb
 - lib/raven/railtie.rb
 - lib/raven/sidekiq.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
-has_rdoc: true
+- bin/raven
 homepage: http://github.com/getsentry/raven-ruby
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A gem that provides a client interface for the Sentry error logger
 test_files: []
-