errorapp_notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73aabada015e5a366a71f919330dbda250a796b6
+  data.tar.gz: 81180c1a660b66aa8e2968245bef973665fdabb4
+SHA512:
+  metadata.gz: 454ba40d8c73c1cdd81a1081c77e221bf41884ccd3b3afa0024daecb15882199635ec80622338a0eb9e3bb64e383b27dc83b9e0ffd178381f188a5e63cb400c8
+  data.tar.gz: 7bf777670b0e10f70c8dfdb2ea1ba5ca29453f28b7ed35adbacf52b42b46e2758637042275d20de4a9a016fe3b3061fd7b90702ce7e569264336c87b96c7d58c

data/.gitignore

@@ -0,0 +1,4 @@
+tmp
+log
+Gemfile.lock
+pkg

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in errorapp_notifier.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2012-2013, ErrorApp
+
+NOTE: Few code ideas are copyright Exceptional DBA Airbrake.io was available
+under the MIT license (listed below) on or before May 1, 2013.
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+ErrorApp
+===============
+
+This is the notifier gem for integrating apps with ErrorApp.
+
+When an exception occurs, ErrorappNotifier will POST the relevant data to the ErrorApp server specified in your environment.
+
+## Rails Installation
+
+Add the ErrorappNotifier gem to your gemfile:
+
+```ruby
+gem 'errorapp_notifier'
+```
+Install the gem
+```ruby
+bundle install
+```
+Then run the our generator which will create a initializer file
+`errorapp_notifier.rb`
+```ruby
+rails generate errorapp_notifier --api_key <Your Project Api Key>
+```
+
+OR you can manually create initializer file and put below code snippet in that file
+```ruby
+ErrorappNotifier.configure do|config|
+  config.api_key = 'api key'
+end
+```
+
+##Testing Integration
+
+To test that errorapp_notifier is properly installed run below rake task
+```ruby
+rake errorapp_notifier:test_exception
+```
+A test exception will be sent to your ErrorApp dashboard if everything is configured correctly.
+
+## Contributing
+
+1. Fork it.
+2. Create a topic branch `git checkout -b my_branch`
+3. Commit your changes `git commit -am "Boom"`
+3. Push to your branch `git push origin my_branch`
+4. Send a [pull request](https://github.com/errorapp/errorapp_notifier/pulls)
+
+## Credits
+
+Idea from various Apps.
+
+Thanks to
+
+1. Airbrake
+2. Exceptional
+
+## License
+
+ErrorApp is Copyright 2014 © ErrorApp. It is free software, and
+may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/errorapp_notifier/**/*_spec.rb"
+end
+
+task :default => [:spec]

data/errorapp_notifier.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'errorapp_notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "errorapp_notifier"
+  spec.version       = ErrorappNotifier::VERSION
+  spec.authors       = ["Rashmi"]
+  spec.email         = ["rays.rashmi@gmail.com"]
+  spec.description   = %q{ Notifier for sending errors to ErrorApp }
+  spec.summary       = %q{ ErrorApp is a webapp for monitoring exceptions and other failures in your live applications. }
+  spec.homepage      = "http://errorapp.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "actionpack", "~> 3.2"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "2.14"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "json"
+
+  spec.add_dependency "rack"
+end

data/lib/errorapp_notifier/action_controller_methods.rb

@@ -0,0 +1,35 @@
+module ErrorappNotifier
+  module ActionControllerMethods
+    def rescue_with_errorapp(exception)
+      unless exception_handled_by_rescue_from?(exception)
+        notify_with_controller(exception)
+        ErrorappNotifier.context.clear!
+      end
+    end
+
+    def errorapp_rescue(context=nil, &block)
+      begin
+        ErrorappNotifier.context(context) unless context.nil?
+        block.call
+      rescue Exception => exception
+        notify_with_controller(exception)
+      ensure
+        ErrorappNotifier.context.clear!
+      end
+    end
+
+    private
+
+    def notify_with_controller(exception)
+      ErrorappNotifier::Notify.notify_with_controller(
+        exception,
+        self,
+        request
+      )
+    end
+
+    def exception_handled_by_rescue_from?(exception)
+      respond_to?(:handler_for_rescue) && handler_for_rescue(exception)
+    end
+  end
+end

data/lib/errorapp_notifier/application_environment_data.rb

@@ -0,0 +1,77 @@
+class ApplicationEnvironmentData
+  attr_reader :exception
+
+  def initialize(exception)
+    @exception = exception
+  end
+
+  def data
+    {
+      :application_environment =>
+      {
+        :environment => application_environment,
+        :env => extract_environment(ENV),
+        :host => get_hostname,
+        :run_as_user => get_username,
+        :application_root_directory => application_root_directory,
+        :language => 'ruby',
+        :language_version => language_version_string,
+        :libraries_loaded => libraries_loaded
+      }
+    }
+  end
+
+  private
+
+  def application_root_directory
+    (application_root.to_s.respond_to?(:force_encoding) ?
+     application_root.to_s.force_encoding("UTF-8") : application_root)
+  end
+
+  def application_environment
+    config.application_environment
+  end
+
+  def application_root
+    config.application_root
+  end
+
+  def config
+    ErrorappNotifier.configuration
+  end
+
+  def extract_environment(env)
+    env.reject do |k, v|
+      is_http_header = (k =~ /^HTTP_/)
+      is_filtered = ErrorappNotifier::ENVIRONMENT_FILTER.include?(k)
+      matches_whitelist = ErrorappNotifier::ENVIRONMENT_WHITELIST.
+        any? do |whitelist_filter|
+        whitelist_filter === k
+      end
+      is_http_header || is_filtered || !matches_whitelist
+    end
+  end
+
+  def get_hostname
+    require 'socket' unless defined?(Socket)
+    Socket.gethostname
+  rescue
+    'UNKNOWN'
+  end
+
+  def get_username
+    ENV['LOGNAME'] || ENV['USER'] || ENV['USERNAME'] || ENV['APACHE_RUN_USER'] || 'UNKNOWN'
+  end
+
+  def language_version_string
+    "#{RUBY_VERSION rescue '?.?.?'} p#{RUBY_PATCHLEVEL rescue '???'} #{RUBY_RELEASE_DATE rescue '????-??-??'} #{RUBY_PLATFORM rescue '????'}"
+  end
+
+  def libraries_loaded
+    begin
+      return Hash[*Gem.loaded_specs.map{|name, gem_specification| [name, gem_specification.version.to_s]}.flatten]
+    rescue
+    end
+    {}
+  end
+end

data/lib/errorapp_notifier/config.rb

@@ -0,0 +1,67 @@
+module ErrorappNotifier
+  class Config
+    attr_accessor :api_key
+    attr_accessor :disabled_by_default
+    attr_accessor :environment_name
+    attr_accessor :http_open_timeout
+    attr_accessor :http_proxy_host
+    attr_accessor :http_proxy_password
+    attr_accessor :http_proxy_port
+    attr_accessor :http_proxy_username
+    attr_accessor :http_read_timeout
+    attr_accessor :ignore_exceptions
+    attr_accessor :ignore_user_agents
+    attr_accessor :logger
+    attr_accessor :params_filters
+    attr_accessor :project_root
+    attr_accessor :remote_host
+    attr_accessor :remote_port
+    attr_accessor :ssl
+
+    DEFAULT_IGNORE_EXCEPTIONS = ['ActiveRecord::RecordNotFound',
+                                 'ActionController::RoutingError',
+                                 'ActionController::InvalidAuthenticityToken',
+                                 'CGI::Session::CookieStore::TamperedWithCookie',
+                                 'ActionController::UnknownAction',
+                                 'AbstractController::ActionNotFound',
+                                 'ActionController::UnknownFormat',
+                                 'Mongoid::Errors::DocumentNotFound',
+                                 'Sinatra::NotFound',
+                                 "SystemExit",
+                                 "SignalException"].freeze
+
+    DEFAULT_PARAMS_FILTERS = %w(password password_confirmation).freeze
+
+    alias_method :ssl?, :ssl
+
+    def initialize
+      @api_key             = ENV['ERRORAPP_API_KEY']
+      @disabled_by_default = %w(development test)
+      @http_open_timeout   = 2
+      @http_read_timeout   = 4
+      @ignore_exceptions   = DEFAULT_IGNORE_EXCEPTIONS
+      @ignore_user_agents  = []
+      @logger              = Logger.new(STDOUT)
+      @params_filters      = DEFAULT_PARAMS_FILTERS
+      @remote_host         = "errorapp.com"
+      @remote_port         = nil
+      @ssl                 = true
+    end
+
+    def should_send_to_api?
+      !disabled_by_default.include?(application_environment)
+    end
+
+    def application_root
+      @project_root || Dir.pwd
+    end
+
+    def remote_port
+      @remote_port ||= ssl? ? 443 : 80
+    end
+
+    def application_environment
+      @environment_name || ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
+    end
+  end
+end

data/lib/errorapp_notifier/controller_failure_data.rb

@@ -0,0 +1,96 @@
+module ErrorappNotifier
+  class ControllerFailureData < FailureData
+    def initialize(exception, controller = nil, request = nil)
+      super(exception)
+      @data = ControllerDataExtractor.new(controller, request) unless request.nil?
+    end
+
+    private
+
+    def extra_stuff
+      return {} if @data.nil?
+      {
+        :request =>
+        {
+          :url => @data.url,
+          :controller => @data.controller,
+          :action => @data.action,
+          :parameters => @data.parameters,
+          :request_method => @data.request_method,
+          :remote_ip => @data.remote_ip,
+          :headers => extract_http_headers(@data.env),
+          :session => Sanitizer.sanitize_session(@data.request)
+        }
+      }
+    end
+  end
+
+  class ControllerDataExtractor
+    def initialize(controller, request)
+      @request = request
+      @controller = controller
+    end
+
+    def controller
+      "#{@controller.class}"
+    end
+
+    def url
+      if @request.respond_to?(:url)
+        @request.url
+      else
+        "#{@request.protocol}#{@request.host}#{@request.request_uri}"
+      end
+    end
+
+    def action
+      if @request.respond_to?(:parameters)
+        @request.parameters['action']
+      else
+        @request.params['action']
+      end
+    end
+
+    def parameters
+      parameters = if @request.respond_to?(:parameters)
+                     @request.parameters
+                   else
+                     @request.params
+                   end
+
+      filter_parameters(parameters)
+    end
+
+    def request_method
+      "#{@request.request_method}"
+    end
+
+    def remote_ip
+      if @request.respond_to?(:remote_ip)
+        @request.remote_ip
+      else
+        @request.ip
+      end
+    end
+
+    def env
+      @request.env
+    end
+
+    def request
+      @request
+    end
+
+    private
+
+    def filter_parameters(hash)
+      if @request.respond_to?(:env) && @request.env["action_dispatch.parameter_filter"]
+        Sanitizer.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/errorapp_notifier/exception_data.rb

@@ -0,0 +1,19 @@
+class ExceptionData
+  attr_reader :exception
+
+  def initialize(exception)
+    @exception = exception
+  end
+
+  def data
+    {
+      :exception =>
+      {
+        :exception_class => exception.class.to_s,
+        :message => exception.message,
+        :backtrace => exception.backtrace,
+        :occurred_at => Time.now.utc.iso8601
+      }
+    }
+  end
+end

data/lib/errorapp_notifier/failure_data.rb

@@ -0,0 +1,87 @@
+require 'digest/md5'
+require 'time'
+require 'errorapp_notifier/exception_data'
+require 'errorapp_notifier/application_environment_data'
+
+module ErrorappNotifier
+  class FailureData
+    def initialize(exception, name = nil)
+      @exception = exception
+      @name = name
+    end
+
+    def to_hash
+      hash = {}
+      hash.merge!(ExceptionData.new(@exception).data)
+      hash.merge!(ApplicationEnvironmentData.new(@exception).data)
+      hash.merge!(extra_stuff)
+      hash.merge!(context_stuff)
+      hash.merge!(errorapp_client_data)
+      rescue_sanitize_hash do
+        Sanitizer.sanitize_hash(hash)
+      end
+    end
+
+    def to_json
+      begin
+        to_hash.to_json
+      rescue NoMethodError
+        begin
+          require 'json'
+          return to_hash.to_json
+        rescue StandardError => e
+          ErrorappNotifier.logger.error(e.message)
+          ErrorappNotifier.logger.error(e.backtrace)
+          raise StandardError.new("You need a json gem/library installed to send errors to ErrorApp (Object.to_json not defined). \nInstall json_pure, yajl-ruby, json-jruby, or the c-based json gem")
+        end
+      end
+    end
+
+    def uniq_key
+      return nil if (@exception.backtrace.nil? || @exception.backtrace.empty?)
+      Digest::MD5.hexdigest(@exception.backtrace.join)
+    end
+
+    private
+
+    def errorapp_client_data
+      {
+        :client =>
+        {
+          :name => ErrorappNotifier::CLIENT_NAME,
+          :version => ErrorappNotifier::VERSION,
+          :protocol_version => ErrorappNotifier::PROTOCOL_VERSION
+        }
+      }
+    end
+
+    def extra_stuff
+      { :rescue_block => {:name => @name} }
+    end
+
+    def context_stuff
+      context = Thread.current[:notifier_context]
+      (context.nil? || context.empty?) ? {} : {'context'=> context}
+    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 rescue_sanitize_hash
+      begin
+        yield
+      rescue Exception
+        {}
+      end
+    end
+  end
+end

data/lib/errorapp_notifier/monkeypatches.rb

@@ -0,0 +1,11 @@
+class Regexp
+  def to_json(options = {})
+    "\"#{self.to_s}\""
+  end
+end
+
+class Fixnum
+  def to_json(options = {})
+    to_s
+  end
+end

data/lib/errorapp_notifier/notifier.rb

@@ -0,0 +1,80 @@
+require 'net/http'
+require 'net/https'
+
+module ErrorappNotifier
+  class Notifier
+    def initialize(data, uniq_key = nil)
+      @uniq_key = uniq_key
+      @data = data
+    end
+
+    def self.notify_error(exception_data)
+      new(
+        exception_data.to_json,
+        exception_data.uniq_key
+      ).notify_error
+    end
+
+    def notify_error
+      log_and_send do
+        client.post(url, data)
+      end
+    end
+
+    private
+
+    attr_reader :data, :uniq_key
+
+    def url
+      "/api/projects/#{config.api_key}/fails?protocol_version=#{PROTOCOL_VERSION}#{hash_param}"
+    end
+
+    def hash_param
+      unless uniq_key.nil?
+        "&hash=#{uniq_key}"
+      end
+    end
+
+    def log_and_send
+      begin
+        response = yield
+        case response
+        when Net::HTTPSuccess
+          ErrorappNotifier.logger.info("Error reported to Errorapp")
+        else
+          log_error(response.message)
+        end
+      rescue Exception => e
+        log_error
+        ErrorappNotifier.logger.error(e)
+      end
+    end
+
+    def config
+      ErrorappNotifier.configuration
+    end
+
+    def log_error(message = '')
+      ErrorappNotifier.logger.error(
+        "Problem notifying Errorapp about the error #{message}"
+      )
+    end
+
+    def client
+      client = optional_proxy.new(config.remote_host, config.remote_port)
+      client.open_timeout = config.http_open_timeout
+      client.read_timeout = config.http_read_timeout
+      client.use_ssl = config.ssl?
+      client.verify_mode = OpenSSL::SSL::VERIFY_NONE if config.ssl?
+      client
+    end
+
+    def optional_proxy
+      Net::HTTP::Proxy(config.http_proxy_host,
+                       config.http_proxy_port,
+                       config.http_proxy_username,
+                       config.http_proxy_password
+                      )
+    end
+  end
+end

data/lib/errorapp_notifier/notifiers/rack_rails.rb

@@ -0,0 +1,32 @@
+require 'rack'
+
+module Rack
+  class RailsErrorappNotifier
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      begin
+        body = @app.call(env)
+      rescue Exception => e
+        ::ErrorappNotifier::Notify.notify_with_controller(
+          e,
+          env['action_controller.instance'],
+          Rack::Request.new(env)
+        )
+        raise
+      end
+
+      if env['rack.exception']
+        ::ErrorappNotifier::Notify.notify_with_controller(
+          env['rack.exception'],
+          env['action_controller.instance'],
+          Rack::Request.new(env)
+        )
+      end
+
+      body
+    end
+  end
+end

data/lib/errorapp_notifier/notifiers/rails.rb

@@ -0,0 +1,34 @@
+# force Rails < 2.0 to use quote keys as per the JSON standard...
+if defined?(ActiveSupport) &&
+    defined?(ActiveSupport::JSON) &&
+    ActiveSupport::JSON.respond_to?(:unquote_hash_key_identifiers)
+  ActiveSupport::JSON.unquote_hash_key_identifiers = false
+end
+
+if defined? ActionController
+  module ActionController
+    class Base
+      def rescue_action_with_errorapp(exception)
+        unless exception_handled_by_rescue_from?(exception)
+          ErrorappNotifier::Notify.notify_with_controller(
+            exception,
+            self,
+            request
+          )
+          ErrorappNotifier.context.clear!
+        end
+        rescue_action_without_errorapp exception
+      end
+
+      alias_method :rescue_action_without_errorapp, :rescue_action
+      alias_method :rescue_action, :rescue_action_with_errorapp
+      protected :rescue_action
+
+      private
+
+      def exception_handled_by_rescue_from?(exception)
+        respond_to?(:handler_for_rescue) && handler_for_rescue(exception)
+      end
+    end
+  end
+end