errorapp_notifier 0.1.0

data/lib/errorapp_notifier/notifiers/tester.rb

@@ -0,0 +1,16 @@
+module ErrorappNotifier
+  module Integration
+    class OmgTestException < StandardError;
+    end
+
+    def self.test
+      begin
+        raise OmgTestException.new, 'Test exception'
+      rescue Exception => e
+        ErrorappNotifier::Notifier.notify_error(
+          ErrorappNotifier::FailureData.new(e, "Test Exception")
+        )
+      end
+    end
+  end
+end

data/lib/errorapp_notifier/notify.rb

@@ -0,0 +1,59 @@
+module ErrorappNotifier
+  class Notify
+    class << self
+      def notify_with_controller(exception, controller = nil, request = nil)
+        notify_exception(exception) do
+          if !ignore?(exception, request)
+            ControllerFailureData.new(exception, controller, request)
+          end
+        end
+      end
+
+      def notify_with_rack(exception, environment, request)
+        notify_exception(exception) do
+          RackFailureData.new(exception, environment, request)
+        end
+      end
+
+      def notify(exception, name = nil)
+        notify_exception(exception) do
+          FailureData.new(exception, name)
+        end
+      end
+
+      def ignore?(exception, request)
+        ignore_class?(exception) || ignore_user_agent?(request)
+      end
+
+      def ignore_class?(exception)
+        config.ignore_exceptions.flatten.any? do |exception_class|
+          exception_class === exception.class.to_s
+        end
+      end
+
+      def ignore_user_agent?(request)
+        config.ignore_user_agents.flatten.any? do |user_agent|
+          user_agent === request.user_agent.to_s
+        end
+      end
+
+      private
+
+      def notify_exception(exception, &block)
+        if config.should_send_to_api?
+          notify!(yield)
+        else
+          raise exception
+        end
+      end
+
+      def notify!(data)
+        Notifier.notify_error(data)
+      end
+
+      def config
+        ErrorappNotifier.configuration
+      end
+    end
+  end
+end

data/lib/errorapp_notifier/rack_failure_data.rb

@@ -0,0 +1,29 @@
+module ErrorappNotifier
+  class RackFailureData < FailureData
+    def initialize(exception, environment, request)
+      super(exception)
+      @environment = environment
+      @request = request
+    end
+
+    private
+
+    def framework
+      'rack'
+    end
+
+    def extra_stuff
+      return {} if @request.nil?
+      {
+        :request => {
+          :url => "#{@request.url}",
+          :parameters => @request.params,
+          :request_method => @request.request_method.to_s,
+          :remote_ip => @request.ip,
+          :headers => extract_http_headers(@environment),
+          :session => Sanitizer.sanitize_session(@request)
+        }
+      }
+    end
+  end
+end

data/lib/errorapp_notifier/railtie.rb

@@ -0,0 +1,48 @@
+require 'rails'
+require 'errorapp_notifier'
+require 'errorapp_notifier/notifiers/rack_rails'
+
+module ErrorappNotifier
+  class Railtie < Rails::Railtie
+     rake_tasks do
+      load "errorapp_notifier/tasks/errorapp_notifier.rake"
+    end
+
+    config.after_initialize do
+      ErrorappNotifier.configure do |config|
+        config.logger           ||= ::Rails.logger
+        config.environment_name ||= ::Rails.env
+        config.project_root     ||= ::Rails.root
+        config.params_filters += Rails.configuration.filter_parameters.map do |filter|
+          case filter
+          when String, Symbol
+            /\A#{filter}\z/
+          else
+            filter
+          end
+        end
+      end
+    end
+
+    initializer "errorapp.middleware" do |app|
+      if defined?(ActionController::Base)
+        ActionController::Base.send(:include, ErrorappNotifier::ActionControllerMethods)
+      end
+
+      ErrorappNotifier.logger.info("Loading ErrorappNotifier #{ErrorappNotifier::VERSION} for #{Rails::VERSION::STRING}")
+
+      middleware = if defined?(ActionDispatch::DebugExceptions)
+                     # rails 3.2.x
+                     "ActionDispatch::DebugExceptions"
+                   elsif defined?(ActionDispatch::ShowExceptions)
+                     # rails 3.0.x && 3.1.x
+                     "ActionDispatch::ShowExceptions"
+                   end
+      begin
+        app.config.middleware.insert_after middleware, "Rack::RailsErrorappNotifier"
+      rescue
+        app.config.middleware.use "Rack::RailsErrorappNotifier"
+      end
+    end
+  end
+end

data/lib/errorapp_notifier/sanitizer.rb

@@ -0,0 +1,56 @@
+module ErrorappNotifier
+  class Sanitizer
+    def self.sanitize_hash(hash)
+      case hash
+      when Hash
+        hash.inject({}) do |result, (key, value)|
+          result.update(key => sanitize_hash(value))
+        end
+      when Array
+        hash.collect{|value| sanitize_hash(value)}
+      when Fixnum, String, Bignum
+        hash
+      else
+        hash.to_s
+      end
+    end
+
+    def self.filter_hash(keys_to_filter, hash)
+      keys_to_filter.map!{ |key| key.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 self.sanitize_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_hash(session_hash)
+    end
+
+    private
+
+    def self.key_match?(key, keys_to_filter)
+      keys_to_filter.any? do |k|
+        regexp = k.is_a?(Regexp)? k : Regexp.new(k.to_s, true)
+        key =~ regexp
+      end
+    end
+  end
+end

data/lib/errorapp_notifier/tasks/errorapp_notifier.rake

@@ -0,0 +1,6 @@
+namespace :errorapp_notifier do
+  desc "Send a test exception to Errorapp."
+  task :test_exception => :environment do
+    ErrorappNotifier::Integration.test
+  end
+end

data/lib/errorapp_notifier/version.rb

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

data/lib/errorapp_notifier.rb

@@ -0,0 +1,74 @@
+require 'logger'
+
+require 'errorapp_notifier/config'
+require 'errorapp_notifier/failure_data'
+require 'errorapp_notifier/notify'
+require 'errorapp_notifier/controller_failure_data'
+require 'errorapp_notifier/rack_failure_data'
+require 'errorapp_notifier/notifier'
+require 'errorapp_notifier/sanitizer'
+require 'errorapp_notifier/version'
+require 'errorapp_notifier/action_controller_methods'
+require 'errorapp_notifier/notifiers/tester'
+
+require 'errorapp_notifier/railtie' if defined?(Rails::Railtie)
+
+module ErrorappNotifier
+  PROTOCOL_VERSION = 1
+  CLIENT_NAME = 'errorapp_notifier-gem'
+  ENVIRONMENT_FILTER = []
+  ENVIRONMENT_WHITELIST = %w(HOME PATH PWD RUBYOPT GEM_HOME RACK_ENV
+                             RAILS_ENV BUNDLE_GEMFILE BUNDLE_BIN_PATH)
+
+
+ class << self
+   def configure
+     yield(configuration)
+   end
+
+   def configuration
+     @configuration ||= ErrorappNotifier::Config.new
+   end
+
+   def logger
+     configuration.logger
+   end
+
+   def notify(exception, name=nil)
+     ErrorappNotifier::Notify.notify(exception, name)
+   end
+
+   def rescue(name=nil, context=nil, &block)
+     begin
+       context(context) unless context.nil?
+       block.call
+     rescue Exception => e
+       ErrorappNotifier::Notify.notify(e, name)
+     ensure
+       clear!
+     end
+   end
+
+   def rescue_and_reraise(name=nil, context=nil, &block)
+     begin
+       context(context) unless context.nil?
+       block.call
+     rescue Exception => e
+       ErrorappNotifier::Notify.notify(e, name)
+       raise(e)
+     ensure
+       clear!
+     end
+   end
+
+   def clear!
+     Thread.current[:notifier_context] = nil
+   end
+
+   def context(hash = {})
+     Thread.current[:notifier_context] ||= {}
+     Thread.current[:notifier_context].merge!(hash)
+     self
+   end
+ end
+end

data/lib/generators/errorapp_notifier/errorapp_notifier_generator.rb

@@ -0,0 +1,54 @@
+require 'rails/generators'
+
+class ErrorappNotifierGenerator < Rails::Generators::Base
+  desc "Creates the ErrorApp initializer file at config/errorapp_notifier.rb"
+
+  class_option :api_key, :aliases => "-k", :type => :string,
+    :desc => "Your ErrorApp API key"
+
+  def self.source_root
+    @_errorapp_source_root ||= File.expand_path("../templates", __FILE__)
+  end
+
+  def install
+    ensure_api_key_was_configured
+    generate_initializer unless api_key_configured?
+    test_errorapp
+  end
+
+  private
+
+  def ensure_api_key_was_configured
+    if !options[:api_key] && !api_key_configured?
+      puts "Must pass --api_key or create config/initializers/errorapp_notifier.rb"
+      exit
+    end
+  end
+
+  def api_key
+    if options[:api_key]
+      "'#{options[:api_key]}'"
+    end
+  end
+
+  def generate_initializer
+    template 'errorapp_notifier.rb', 'config/initializers/errorapp_notifier.rb'
+  end
+
+  def api_key_configured?
+    File.exists?('config/initializers/errorapp_notifier.rb')
+  end
+
+  def test_errorapp
+    puts run("rails runner ErrorappNotifier::Integration.test")
+  end
+
+  def configuration_output
+    output = <<-eos
+ErrorappNotifier.configure do|config|
+  config.api_key = '#{options[:api_key]}'
+end
+    eos
+    output
+  end
+end

data/lib/generators/errorapp_notifier/templates/errorapp_notifier.rb

@@ -0,0 +1,2 @@
+<%= configuration_output %>
+

data/spec/errorapp_notifier/config_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe ErrorappNotifier::Config, 'defaults' do
+  it "have sensible defaults" do
+    default_config.ssl.should == true
+    default_config.remote_host.should == 'errorapp.com'
+    default_config.remote_port.should == 443
+    default_config.application_root.should == Dir.pwd
+    default_config.http_proxy_host.should be_nil
+    default_config.http_proxy_port.should be_nil
+    default_config.http_proxy_username.should be_nil
+    default_config.http_proxy_password.should be_nil
+    default_config.http_open_timeout.should == 2
+    default_config.http_read_timeout.should == 4
+  end
+
+  it "have correct defaults when ssl" do
+    default_config.ssl = true
+    default_config.remote_host.should == 'errorapp.com'
+    default_config.remote_port.should == 443
+  end
+
+  it "be disabled based on environment by default" do
+    %w(development test).each do |env|
+      default_config.stub(:application_environment).and_return(env)
+      default_config.should_send_to_api?.should == false
+    end
+  end
+
+  it "be enabled based on environment by default" do
+    %w(production staging).each do |env|
+      default_config.stub(:application_environment).and_return(env)
+      default_config.should_send_to_api?.should == true
+    end
+  end
+
+  it "load api_key from environment variable" do
+    ENV.stub(:[]).with('ERRORAPP_API_KEY').and_return('env-api-key')
+    default_config.api_key.should == 'env-api-key'
+  end
+
+  context 'production environment' do
+    before :each do
+      default_config.stub(:application_environment).and_return('production')
+    end
+
+    it 'loads a errorapp_notifier config' do
+      override_default_value :api_key
+      override_default_value :ssl, true
+      override_default_value :remote_host, 'example.com'
+      override_default_value :remote_port, 3000
+      override_default_value :http_proxy_host, 'annoying-proxy.example.com'
+      override_default_value :http_proxy_port, 1066
+      override_default_value :http_proxy_username, 'username'
+      override_default_value :http_proxy_password, 'password'
+      override_default_value :http_open_timeout, 5
+      override_default_value :http_read_timeout, 10
+    end
+
+    it 'disable' do
+      default_config.api_key = "new-key"
+      default_config.disabled_by_default = %(production)
+      default_config.api_key.should == 'new-key'
+      default_config.should_send_to_api?.should == false
+    end
+  end
+end
+
+def default_config
+  @config||= ErrorappNotifier::Config.new
+end
+
+def override_default_value(option, value ="value")
+  default_config.send(:"#{option}=", value)
+  expect(default_config.send(option)).to eq(value)
+end