crashdesk-rails 0.1.0

data/crashdesk-rails.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/crashdesk-rails/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = 'crashdesk-rails'
+  gem.version = CrashdeskRails::VERSION
+  gem.authors = ["Ladislav Martincik"]
+  gem.summary = "Crashde.sk Rails Integration"
+  gem.description = "crashdesk-rails is the Rails gem for integration with crashde.sk servers"
+  gem.email = "info@crashde.sk"
+  gem.files =  Dir['lib/**/*'] + Dir['spec/**/*'] + Dir['*.rb'] + ["crashdesk-rails.gemspec"]
+  gem.homepage = "http://crashde.sk"
+  gem.require_paths = ["lib"]
+  gem.rubyforge_project = "crashdesk-rails"
+  gem.add_dependency('crashdesk', '~> 0')
+  gem.add_dependency('rails', '~> 3.0')
+end

data/lib/crashdesk-rails/action_controller_context.rb

@@ -0,0 +1,92 @@
+module CrashdeskRails
+
+  class ActionControllerContext < Crashdesk::ContextBase
+
+    def initialize(controller, request)
+      @controller = controller
+      @request = request
+    end
+
+    # Extract all meaningfull data from our controller.
+    def to_hash
+      {
+        'url' => request_url,
+        'controller_name' => controller_name,
+        'action_name' => action_name,
+        'parameters' => parameters,
+        'request_method' => request_method,
+        'remote_ip' => remote_ip,
+        'headers' => headers,
+        'session' => session
+      }
+    end
+
+    def framework
+      "rails"
+    end
+
+    def framework_version
+      Rails::VERSION::STRING
+    end
+
+    def request_url
+      @request.respond_to?(:url) ? @request.url : "#{@request.protocol}#{@request.host}#{@request.request_uri}"
+    end
+
+    def controller_name
+      @controller.class.to_s
+    end
+
+    def action_name
+      @request.respond_to?(:parameters) ? @request.parameters['action'] : @request.params['action']
+    end
+
+    def remote_ip
+      @request.respond_to?(:remote_ip) ? @request.remote_ip : @request.ip
+    end
+
+    def parameters
+      filter_parameters(@request.respond_to?(:parameters) ? @request.parameters : @request.params)
+    end
+
+    def request_method
+      @request.request_method.to_s
+    end
+
+    def headers
+      extract_http_headers(@request.env)
+    end
+
+    def session
+      extract_session(@request)
+    end
+
+    private
+
+    def filter_hash(keys_to_filter, hash)
+      keys_to_filter.map! {|x| x.to_s}
+      if keys_to_filter.is_a?(Array) && !keys_to_filter.empty?
+        hash.each do |key, value|
+          if key_match?(key, keys_to_filter)
+            hash[key] = "[FILTERED]"
+          elsif value.respond_to?(:to_hash)
+            filter_hash(keys_to_filter, hash[key])
+          end
+        end
+      end
+      hash
+    end
+
+    def filter_parameters(hash)
+      if @request.respond_to?(:env) && @request.env["action_dispatch.parameter_filter"]
+        filter_hash(@request.env["action_dispatch.parameter_filter"], hash)
+      elsif @controller.respond_to?(:filter_parameters)
+        @controller.send(:filter_parameters, hash)
+      else
+        hash
+      end
+    end
+
+  end
+
+end

data/lib/crashdesk-rails/debug_exceptions.rb

@@ -0,0 +1,21 @@
+module CrashdeskRails
+  module DebugExceptions
+
+    def self.included(base)
+      base.send(:alias_method_chain, :render_exception, :crashdesk)
+    end
+
+    # We are overriding this method as we don't want
+    # to write our own middleware yet.
+    def render_exception_with_crashdesk(env, exception)
+      request = Rack::Request.new(env)
+      context = ActionControllerContext.new(env['action_controller.instance'], request)
+
+      crashlog = Crashdesk.crashlog(exception, request, context)
+      crashlog.report
+
+      render_exception_without_crashdesk(env, exception)
+    end
+
+  end
+end

data/lib/crashdesk-rails/middleware.rb

@@ -0,0 +1,28 @@
+module CrashdeskRails
+  class Middleware
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      begin
+        status, headers, body = @app.call(env)
+      rescue Exception => exception
+
+        request = Rack::Request.new(env)
+        context = ActionControllerContext.new(env['action_controller.instance'], request)
+
+        crashlog = Crashdesk.crashlog(exception, request, context)
+        crashlog.report
+
+        env['crashdesk.crashlog_crc'] = crashlog.crc
+
+        raise
+      end
+
+      [status, headers, body]
+    end
+
+  end
+end

data/lib/crashdesk-rails/railtie.rb

@@ -0,0 +1,28 @@
+module CrashdeskRails
+  class Railtie < Rails::Railtie
+
+    config.after_initialize do |app|
+      Crashdesk.configure do |config|
+        config.logger           ||= ::Rails.logger
+        config.environment_name ||= ::Rails.env
+        config.project_root     ||= ::Rails.root
+      end
+
+      Crashdesk.logger.info 'Crahsdesk initializing.'
+
+      if defined? ::ActionDispatch::DebugExceptions
+        Crashdesk.logger.debug 'Crashdesk integrated via including DebugExceptions module.'
+        # DebugException is middleware inside Rails
+        # Would be nice to have our own with nice message rendering.
+        ::ActionDispatch::DebugExceptions.send(:include, CrashdeskRails::DebugExceptions)
+
+        # Also there's ShowException middleware we could override with much
+        # nicer default rendering.
+      else
+        Crashdesk.logger.debug 'Crashdesk integrated via middleware.'
+        app.config.middleware.use "CrashdeskRails::Middleware"
+      end
+    end
+
+  end
+end

data/lib/crashdesk-rails/version.rb

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

data/lib/crashdesk-rails.rb

@@ -0,0 +1,10 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'crashdesk'
+
+require 'crashdesk-rails/debug_exceptions'
+require 'crashdesk-rails/middleware'
+require 'crashdesk-rails/action_controller_context'
+require 'crashdesk-rails/version'
+
+require 'crashdesk-rails/railtie' if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: crashdesk-rails
+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:
+- !ruby/object:Gem::Dependency
+  name: crashdesk
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: crashdesk-rails is the Rails gem for integration with crashde.sk servers
+email: info@crashde.sk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/crashdesk-rails/action_controller_context.rb
+- lib/crashdesk-rails/debug_exceptions.rb
+- lib/crashdesk-rails/middleware.rb
+- lib/crashdesk-rails/railtie.rb
+- lib/crashdesk-rails/version.rb
+- lib/crashdesk-rails.rb
+- crashdesk-rails.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: []
+rubyforge_project: crashdesk-rails
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Crashde.sk Rails Integration
+test_files: []