crashdesk 0.1.0

data/crashdesk.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/crashdesk/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = 'crashdesk'
+  gem.version = Crashdesk::VERSION
+  gem.authors = ["Ladislav Martincik"]
+  gem.summary = "Crashde.sk is helping you track crashes of your application online"
+  gem.description = "crashdesk is the Ruby gem for containing core functionality for communication with crashde.sk servers"
+  gem.email = "info@crashde.sk"
+  gem.files =  Dir['lib/**/*'] + Dir['spec/**/*'] + Dir['*.rb'] + ["crashdesk.gemspec"]
+  gem.homepage = "http://crashde.sk"
+  gem.require_paths = ["lib"]
+  gem.rubyforge_project = "crashdesk"
+  gem.requirements << "json_pure, json-jruby or json gem required"
+end

data/lib/crashdesk/backtrace.rb

@@ -0,0 +1,102 @@
+require 'digest/md5'
+require 'zlib'
+
+module Crashdesk
+
+  class Backtrace
+
+    class Line
+      # regexp taken from Airbrake
+      INPUT_FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$}.freeze
+
+      attr_reader :file, :number, :method
+
+      def self.parse(unparsed_line)
+        _, file, number, method = unparsed_line.match(INPUT_FORMAT).to_a
+        new(file, number, method)
+      end
+
+      def initialize(file, number, method)
+        self.file   = file
+        self.number = number
+        self.method = method
+      end
+
+      def to_s
+        "#{file}:#{number}:in `#{method}'"
+      end
+
+      def ==(other)
+        to_s == other.to_s
+      end
+
+      def inspect
+        "<Line:#{to_s}>"
+      end
+
+      private
+        attr_writer :file, :number, :method
+    end
+
+    attr_reader :lines
+
+    def self.parse(backtrace, opts = {})
+      code_lines = split_multiline_backtrace(backtrace)
+
+      lines = unless code_lines.nil?
+        code_lines.collect do |unparsed_line|
+          Line.parse(unparsed_line)
+        end
+      else
+        []
+      end
+
+      instance = new(lines)
+    end
+
+    def initialize(lines)
+      self.lines = lines
+    end
+
+    def inspect
+      "<Backtrace: " + lines.collect { |line| line.inspect }.join(", ") + ">"
+    end
+
+    def to_s
+      lines.join("\n\s")
+    end
+
+    def to_a
+      lines.map { |l| l.to_s }
+    end
+
+    def ==(other)
+      if other.respond_to?(:lines)
+        lines == other.lines
+      else
+        false
+      end
+    end
+
+    def hash_id
+      Digest::MD5.hexdigest(to_s)
+    end
+
+    def crc
+      Zlib::crc32(to_s).to_s
+    end
+
+    private
+
+      attr_writer :lines
+
+      def self.split_multiline_backtrace(backtrace)
+        if (a = Array(backtrace)).size == 1
+          a.first.split(/\n\s*/)
+        else
+          backtrace
+        end
+      end
+
+  end
+end

data/lib/crashdesk/configuration.rb

@@ -0,0 +1,53 @@
+module Crashdesk
+
+  class Configuration
+
+    # Basic connection settings
+    attr_accessor :api_key
+
+    # Proxy server
+    attr_accessor :proxy_host, :proxy_port, :proxy_user, :proxy_pass
+
+    # HTTP
+    attr_accessor :host, :port
+
+    # Where to log Crashdesk output?
+    attr_accessor :logger
+
+    # Framework is string representing framework
+    # @example
+    #   Crashdesk.configure do |config|
+    #     config.api_key = 'YOUR API KEY HERE'
+    #     config.project_root = ::Rails.root
+    #     config.environment_name = ::Rails.env
+    #     config.logger = ::Rails.logger
+    #   end
+    #
+    attr_accessor :environment_name, :project_root
+
+    def initialize
+      @host                      = 'crashde.sk'
+    end
+
+    # Hash like access
+    def [](option)
+      send(option)
+    end
+
+    def port
+      @port || default_port
+    end
+
+    def protocol
+      'http'
+    end
+
+    private
+
+    def default_port
+      80
+    end
+
+  end
+
+end

data/lib/crashdesk/context_base.rb

@@ -0,0 +1,57 @@
+module Crashdesk
+
+  class ContextBase
+    MAX_DATA_LENGTH = 2048
+
+    def to_hash
+      { 'context' => {} }
+    end
+
+    private
+
+    def sanitize_unserializable_data(data, stack = [])
+      return "[recursion halted]" if stack.any? { |item| item == data.object_id }
+
+      if data.respond_to?(:to_hash)
+        data.to_hash.inject({}) do |result, (key, value)|
+          result.merge(key => sanitize_unserializable_data(value, stack + [data.object_id]))
+        end
+      elsif data.respond_to?(:to_ary)
+        data.to_ary.collect do |value|
+          sanitize_unserializable_data(value, stack + [data.object_id])
+        end
+      else
+        data.to_s.slice(0, MAX_DATA_LENGTH)
+      end
+    end
+
+    def extract_http_headers(env)
+      headers = {}
+      env.select{|k, v| k =~ /^HTTP_/}.each do |name, value|
+        proper_name = name.sub(/^HTTP_/, '').split('_').map{|upper_case| upper_case.capitalize}.join('-')
+        headers[proper_name] = value
+      end
+      unless headers['Cookie'].nil?
+        headers['Cookie'] = headers['Cookie'].sub(/_session=\S+/, '_session=[FILTERED]')
+      end
+      headers
+    end
+
+    def extract_session(request)
+      session_hash = {'session_id' => "", 'data' => {}}
+
+      if request.respond_to?(:session)
+        session = request.session
+        session_hash['session_id'] = request.session_options ? request.session_options[:id] : nil
+        session_hash['session_id'] ||= session.respond_to?(:session_id) ? session.session_id : session.instance_variable_get("@session_id")
+        session_hash['data'] = session.respond_to?(:to_hash) ? session.to_hash : session.instance_variable_get("@data") || {}
+        session_hash['session_id'] ||= session_hash['data'][:session_id]
+        session_hash['data'].delete(:session_id)
+      end
+
+      sanitize_unserializable_data(session_hash)
+    end
+
+  end
+
+end

data/lib/crashdesk/crashlog.rb

@@ -0,0 +1,61 @@
+module Crashdesk
+
+  class Crashlog
+
+    attr_accessor :options, :exception, :backtrace, :environment, :exception_class,
+      :exception_message, :context, :occurred_at,
+      :reporter
+
+    def initialize(exception, request, context, options = {})
+      self.options = options
+
+      # Anatomy of Exception
+      self.exception = exception
+      self.backtrace = Crashdesk::Backtrace.parse(exception.backtrace || caller)
+      self.exception_class = exception.class.name
+      self.exception_message = exception.message
+
+      # Environment
+      self.environment = Crashdesk::Environment.new(
+        :environment_name => options[:environment_name],
+        :project_root => Crashdesk.configure.project_root)
+
+      # Context
+      self.context = context
+      self.occurred_at = Time.now.utc.iso8601
+
+      # How to report?
+      self.reporter = options[:reporter] ||
+        Crashdesk::Reporter::Remote.new(:host => 'localhost',
+                                        :port => 4567) # Need to pass HTTP params
+    end
+
+    def to_hash
+      {
+        :api_key => Crashdesk.configuration.api_key,
+        :hash_id => backtrace.hash_id,
+        :crc => backtrace.crc,
+        :occurred_at => occurred_at,
+
+        :environment => environment.to_hash,
+
+        :backtrace => backtrace.to_a,
+        :exception_class => self.exception_class,
+        :exception_message => self.exception_message,
+
+        :context => context.to_hash
+      }
+    end
+
+    def report
+      json = Crashdesk::Serializer::Json.new(self.to_hash).process
+      reporter.run(json)
+    end
+
+    def crc
+      session_data.crc
+    end
+
+  end
+
+end

data/lib/crashdesk/environment.rb

@@ -0,0 +1,31 @@
+require 'socket'
+
+module Crashdesk
+
+  class Environment
+
+    attr_reader :project_root, :environment_name, :framework_string
+
+    def initialize(args)
+      self.project_root = args[:project_root]
+      self.environment_name = args[:environment_name]
+    end
+
+    def to_hash
+      {
+        :project_root => project_root,
+        :environment_name => environment_name,
+        :hostname => Socket.gethostname,
+        :language => 'ruby',
+        :language_version => RUBY_VERSION,
+        :language_platform => RUBY_PLATFORM
+      }
+    end
+
+    private
+
+    attr_writer :project_root, :environment_name
+
+  end
+
+end

data/lib/crashdesk/reporters/remote.rb

@@ -0,0 +1,137 @@
+require 'net/http'
+require 'net/https'
+
+module Crashdesk
+  module Reporter
+
+    module QueryParams
+      def self.encode(value, key = nil)
+        case value
+        when Hash  then value.map { |k,v| encode(v, append_key(key,k)) }.join('&')
+        when Array then value.map { |v| encode(v, "#{key}[]") }.join('&')
+        when nil   then ''
+        else
+          "#{key}=#{CGI.escape(value.to_s)}" 
+        end
+      end
+
+      private
+      def self.append_key(root_key, key)
+        root_key.nil? ? key : "#{root_key}[#{key.to_s}]"
+      end
+    end
+
+    class Remote
+      NOTICES_URI = '/v1/crashes'.freeze
+      HTTP_ERRORS = [Timeout::Error,
+                    Errno::EINVAL,
+                    Errno::ECONNRESET,
+                    EOFError,
+                    Net::HTTPBadResponse,
+                    Net::HTTPHeaderSyntaxError,
+                    Net::ProtocolError,
+                    Errno::ECONNREFUSED].freeze
+      HEADERS = {
+        'Content-type' => 'application/json',
+        'Accept'       => 'application/json'
+      }
+
+      def initialize(options = {})
+        [ :proxy_host,
+          :proxy_port,
+          :proxy_user,
+          :proxy_pass,
+          :protocol,
+          :host,
+          :port,
+          :secure,
+          :use_system_ssl_cert_chain,
+          :http_open_timeout,
+          :http_read_timeout
+        ].each do |option|
+          instance_variable_set("@#{option}", options[option])
+        end
+      end
+
+      def run(data)
+        http = setup_http_connection
+        headers = HEADERS.merge('X-Crashdesk-ApiKey' => Crashdesk.configuration.api_key)
+
+        response = begin
+                    http.post(url.path, data, headers)
+                  rescue *HTTP_ERRORS => e
+                    logger.error "Unable to connect the Creashdesk server. HTTP Error=#{e}"
+                    nil
+                  end
+
+        case response
+        when Net::HTTPSuccess then
+          logger.info "Success: #{response.class} #{response}"
+        else
+          logger.info "Failure: #{response.class} #{response}"
+        end
+      rescue => e
+        logger.error "Error sending: #{e.class} - #{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
+        nil
+      end
+
+      attr_reader :proxy_host,
+                  :proxy_port,
+                  :proxy_user,
+                  :proxy_pass,
+                  :protocol,
+                  :host,
+                  :port,
+                  :secure,
+                  :use_system_ssl_cert_chain,
+                  :http_open_timeout,
+                  :http_read_timeout
+
+      alias_method :secure?, :secure
+      alias_method :use_system_ssl_cert_chain?, :use_system_ssl_cert_chain
+
+      private
+
+      def logger
+        Crashdesk.logger
+      end
+
+      def url
+        URI.parse("#{protocol}://#{host}:#{port}").merge(NOTICES_URI)
+      end
+
+      def protocol
+        'http'
+      end
+
+      def host
+        @host || 'crashde.sk'
+      end
+
+      def port
+        @port || 80
+      end
+
+      def setup_http_connection
+        http =
+          Net::HTTP::Proxy(proxy_host, proxy_port, proxy_user, proxy_pass).
+          new(url.host, url.port)
+
+        http.read_timeout = http_read_timeout
+        http.open_timeout = http_open_timeout
+
+        if secure?
+          http.use_ssl     = true
+          http.ca_file      = Crashdesk.configuration.ca_bundle_path
+          http.verify_mode  = OpenSSL::SSL::VERIFY_PEER
+        else
+          http.use_ssl     = false
+        end
+
+        http
+      end
+    end
+
+  end
+end
+

data/lib/crashdesk/reporters/screen.rb

@@ -0,0 +1,16 @@
+module Crashdesk
+  module Reporter
+
+    class Screen
+
+      def initialize()
+      end
+
+      def run(data)
+        data.to_json.to_s
+      end
+
+    end
+
+  end
+end

data/lib/crashdesk/serializers/json.rb

@@ -0,0 +1,25 @@
+module Crashdesk
+  module Serializer
+
+    class Json
+
+      def initialize(data)
+        unless data.respond_to? :to_json
+          require 'json'
+          unless data.respond_to? :to_json
+            raise StandardError.new("You need a json gem/library installed to send errors to as JSON (Object.to_json not defined).
+                                    \nInstall json_pure, yajl-ruby, json-jruby, or the c-based json gem")
+          end
+        end
+
+        @data = data
+      end
+
+      def process
+        @data.to_json
+      end
+
+    end
+
+  end
+end

data/lib/crashdesk/version.rb

@@ -0,0 +1,3 @@
+module Crashdesk
+  VERSION = "0.1.0"
+end

data/lib/crashdesk.rb

@@ -0,0 +1,51 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'time'
+require 'digest/md5'
+
+require 'crashdesk/version'
+require 'crashdesk/configuration'
+
+require 'crashdesk/context_base'
+require 'crashdesk/crashlog'
+require 'crashdesk/backtrace'
+require 'crashdesk/environment'
+require 'crashdesk/reporters/remote'
+require 'crashdesk/serializers/json'
+
+module Crashdesk
+
+  class << self
+    LOG_PREFIX = "[Crashdesk] "
+
+    attr_writer :configuration
+
+    # Call this method to modify defaults for Crashdesk.
+    #
+    # @example
+    #   Crashdesk.configure do |config|
+    #     config.api_key = 'someapikey'
+    #   end
+    def configure(silent = false)
+      yield(configuration) if block_given?
+      configuration
+    end
+
+    # The configuration object.
+    # @see Crashdesk.configure
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def log(message)
+      configuration.logger.info(LOG_PREFIX + message) if configuration.logger
+    end
+
+    # Main method how to build crashlog from exception, context, and environment
+    # @see Craslog.initialize
+    def crashlog(exception, request, context, options = {})
+      Crashlog.new(exception, request, context, options)
+    end
+  end
+
+end

data/spec/backtrace_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Crashdesk::Backtrace do
+
+  before do
+    @backtrace_basic = File.read(File.join(File.dirname(__FILE__), 'stubs', 'backtrace_basic.txt'))
+  end
+
+  context "parsing raw backtrace to Backtrace object composed of Lines" do
+    it "backtrace as string" do
+      backtrace = Crashdesk::Backtrace.parse(@backtrace_basic)
+
+      backtrace.lines.length.should == 17
+    end
+
+    it "backtrace as array" do
+      backtrace = Array(@backtrace_basic.split(/\n\s*/))
+      backtrace = Crashdesk::Backtrace.parse(backtrace)
+
+      backtrace.lines.length.should == 17
+    end
+
+    it "backtrace with caller object" do
+      backtrace = Crashdesk::Backtrace.parse(caller)
+      backtrace.lines.should_not be_empty
+      backtrace.hash_id.should_not == 'd41d8cd98f00b204e9800998ecf8427e'
+      backtrace.crc.should_not == '0'
+    end
+
+    it "backtrace with nil object" do
+      backtrace = Crashdesk::Backtrace.parse(nil)
+      backtrace.lines.should be_empty
+      backtrace.to_s.should be_empty
+      backtrace.hash_id.should == 'd41d8cd98f00b204e9800998ecf8427e'
+      backtrace.crc.should == '0'
+    end
+  end
+
+  context "stripping backtrace from project root path" do
+    it "generate 2 hashes" do
+      backtrace = Crashdesk::Backtrace.parse(@backtrace_basic)
+
+      backtrace.hash_id.should == '00912f3bc04ea70cc305951c43c48332'
+      backtrace.crc.should == '2467818820'
+    end
+
+    it "generate 2 hashes that must be unique" do
+      backtrace = Crashdesk::Backtrace.parse(@backtrace_basic)
+      backtrace_modified = Crashdesk::Backtrace.parse(@backtrace_basic + "1")
+
+      backtrace.should_not == backtrace_modified
+      backtrace.hash_id.should_not == backtrace_modified.hash_id
+      backtrace.crc.should_not == backtrace_modified.crc
+    end
+  end
+
+  context "serialization" do
+    it "should generate as array of lines" do
+      backtrace = Crashdesk::Backtrace.parse(@backtrace_basic)
+      backtrace.to_a.length.should == 17
+    end
+  end
+
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Crashdesk::Configuration do
+
+  context "with defaults" do
+    before do
+      @config = Crashdesk.configure
+    end
+
+    it "point to crashdes.sk host" do
+      @config[:host].should == 'crashde.sk'
+      @config.host.should == 'crashde.sk'
+    end
+
+    it "port is 80" do
+      @config[:port].should == 80
+      @config.port.should == 80
+    end
+
+    it "protocol is HTTP" do
+      @config[:protocol].should == 'http'
+      @config.protocol.should == 'http'
+    end
+  end
+
+  context "with modifications" do
+    before do
+      @config = Crashdesk.configure do |c|
+        c.host = 'api.crashde.sk'
+        c.port = 443
+      end
+    end
+
+    it "point to crashdes.sk host" do
+      @config[:host].should == 'api.crashde.sk'
+      @config.host.should == 'api.crashde.sk'
+    end
+
+    it "port is 80" do
+      @config[:port].should == 443
+      @config.port.should == 443
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end
+
+require 'crashdesk'

data/spec/stubs/backtrace_basic.txt

@@ -0,0 +1,17 @@
+/Users/ladislav/Projects/personal/crashdesk-rails-test/spec/lib/crashdesk/backtrace_spec.rb:11:in `block (2 levels) in <top (required)>'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/example.rb:80:in `instance_eval'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/example.rb:80:in `block in run'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/example.rb:173:in `with_around_hooks'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/example.rb:77:in `run'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/example_group.rb:355:in `block in run_examples'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/example_group.rb:351:in `map'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/example_group.rb:351:in `run_examples'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/example_group.rb:337:in `run'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/command_line.rb:28:in `block (2 levels) in run'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/command_line.rb:28:in `map'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/command_line.rb:28:in `block in run'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/reporter.rb:34:in `report'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/command_line.rb:25:in `run'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/runner.rb:80:in `run_in_process'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/runner.rb:69:in `run'
+/Users/ladislav/.rvm/gems/ruby-1.9.3-p194/gems/rspec-core-2.8.0/lib/rspec/core/runner.rb:10:in `block in autorun'

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: crashdesk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ladislav Martincik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-26 00:00:00.000000000 Z
+dependencies: []
+description: crashdesk is the Ruby gem for containing core functionality for communication
+  with crashde.sk servers
+email: info@crashde.sk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/crashdesk/backtrace.rb
+- lib/crashdesk/configuration.rb
+- lib/crashdesk/context_base.rb
+- lib/crashdesk/crashlog.rb
+- lib/crashdesk/environment.rb
+- lib/crashdesk/reporters/remote.rb
+- lib/crashdesk/reporters/screen.rb
+- lib/crashdesk/serializers/json.rb
+- lib/crashdesk/version.rb
+- lib/crashdesk.rb
+- spec/backtrace_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
+- spec/stubs/backtrace_basic.txt
+- crashdesk.gemspec
+homepage: http://crashde.sk
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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:
+- json_pure, json-jruby or json gem required
+rubyforge_project: crashdesk
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Crashde.sk is helping you track crashes of your application online
+test_files: []