exception_logger 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3adf48e140b77393b73afd456d83d6aa4edafd35fc5aaf938b0af5f8f5a89133
+  data.tar.gz: 02310da2ad3bcc7ead37f4424c9a74f482ddb6161391f9a552c6acff7b6fbc5b
+SHA512:
+  metadata.gz: ddef079c384857ce0097e79330b20898d274f8b5569f1f633aeb4c00884ed81dcde3edbefe96877a5b0cfbbefe3c7b6616f589b66984fb0d0a3a7894e46ef9f4
+  data.tar.gz: 642e4072c86165c26823494ae6e964cc7891fc94cfcb5f847a82eea0c73f2d8bd002c3eaf78ca6a9ea04ff3f821d0e063a8ab414494a70adac67da477ceb3f2e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'

data/app/assets/javascripts/exception_logger/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/exception_logger/exception_logger.js

@@ -0,0 +1,69 @@
+$(function () {
+	function CSRFProtection(xhr) {
+	    var token = $('meta[name="csrf-token"]').attr('content');
+	    if (token) xhr.setRequestHeader('X-CSRF-Token', token);
+	};
+
+	function ajax_headers() {
+		if ('ajaxPrefilter' in $) $.ajaxPrefilter(function(options, originalOptions, xhr){ CSRFProtection(xhr) });
+		else $(document).ajaxSend(function(e, xhr){ CSRFProtection(xhr) });
+	};
+
+	ajax_headers();
+
+	$(document).on('click', '.show_link', function(event) {
+		$.get($(this).attr("href"));
+		return false;
+	});
+
+	$(document).on('click', '.close_link', function(event) {
+		$("#showpage").hide();
+		return false;
+	});
+
+	$(document).on('click', '.delete_link', function(event) {
+		$.ajax({
+			url: $(this).attr("href"),
+			type: 'DELETE'
+		});
+		return false;
+	});
+
+	$(document).on('click', '.delete_visible_link', function(event) {
+		var arr=$('tr.exception').map(function() { var id = $(this).attr("id"); return parseInt(id.replace(/^\w+_/, '')); }).get();
+		$.ajax({
+			url: $(this).attr("href"),
+			type: 'POST',
+			data: $.param({ids: arr}),
+			dataType: 'script'
+		});
+		return false;
+	});
+
+	$(document).on('click', '.filter_link', function(event) {
+		$('.filter_link').removeClass('selected');
+		$(this).addClass('selected');
+		$.ajax({
+			url: $(this).attr("href"),
+			type: 'POST',
+			dataType: 'script'
+		});
+		return false;
+	});
+
+	$(document).on('click', '#query-form :submit', function(event) {
+		$.ajax({
+			url: $("#query-form").attr("action"),
+			type: 'POST',
+			data: $("#query-form").serialize(),
+			dataType: 'script'
+		});
+		return false;
+	});
+
+	$(document).on('click', ".pagination a", function() {
+		$.getScript(this.href);
+		return false;
+	});
+});
+

data/app/assets/javascripts/exception_logger/logged_exceptions.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/exception_logger/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/

data/app/assets/stylesheets/exception_logger/exception_logger.css

@@ -0,0 +1,301 @@
+body
+{
+  margin:0;
+  padding:0;
+  background:#e8e8e8;
+  font-family: 'Lucida Grande', Arial, Helvetica, sans-serif;
+  font-size: 12px;
+  color:white;
+}
+
+#container
+{
+  margin:0 auto;
+  min-width:800px;
+}
+
+#left
+{
+  margin-right:235px;
+}
+
+#left .page
+{
+  background:#e8e8e8;
+  border:2px solid #999;
+  border-width:0 2px 2px 0;
+  padding:25px;
+  color:black;
+}
+
+#right
+{
+  margin-top:1em;
+  float:right;
+  xwidth:22%;
+  width:200px;
+  margin-right:1.25em;
+}
+
+#right hr
+{
+  border:0;
+  border-top:1px solid #222;
+}
+
+#search
+{
+  margin-top:2em;
+  background:#e8e8e8;
+  padding:10px 5px;
+  border:1px solid #222;
+  border-width:1px 0;
+}
+
+
+ul.filters
+{
+  list-style-type:none;
+  padding:0;
+  margin:0;
+}
+ul.filters li { margin-bottom:0.2em;}
+
+
+ul.filters a,
+ul.filters a:visited {
+  display:block;
+  padding:1px 7px;
+  color:#000;
+  text-decoration:none;
+}
+
+ul.filters a:hover
+{
+  background:#666;
+  color:white;
+}
+
+ul.filters a.selected,
+ul.filters a.selected:visited,
+ul.filters a:active {
+  color:gold;
+  background-color:#333;
+  text-decoration:none;
+  font-weight:bold;
+}
+
+
+onclick a:hover
+{
+  color:#fff;
+  text-decoration:none;
+}
+
+#exceptions table
+{
+  width:99%;
+  border-collapse:collapse;
+}
+
+td
+{
+  padding:5px 10px;
+  xborder:1px solid #ddd;
+}
+
+#backtrace
+{
+  overflow:auto;
+  margin-top:0.25em;
+}
+
+h2
+{
+  background-color:#ddd;
+  font-size:14px;
+  padding:3px 10px;
+}
+
+form {margin:0;}
+
+h3 {
+  font-size:14px;
+  color:#ddd;
+  background:#222;
+  padding:3px 7px;
+}
+
+div.date
+{
+  color:#666;
+}
+
+h1
+{
+  margin-top:0.25em;
+  font-size:18px;
+  padding-bottom:5px;
+  border-bottom:2px solid #ddd;
+}
+
+h1 span
+{
+  color:#aaa;
+  font-weight:normal;
+}
+
+a
+{
+  color:#369;
+  text-decoration:none;
+}
+a:hover
+{
+  color:blue;
+  text-decoration:underline;
+}
+
+th
+{
+  text-align:left;
+  xbackground:#333;
+  xcolor:gold;
+  padding:2px 10px;
+}
+
+tr { xcursor:pointer; }
+
+tr.eor td
+{
+  background:#e7e7e7;
+
+}
+
+/*
+tr:hover td,
+tr.eor:hover td
+{
+  background:#333;
+  color:white;
+}
+tr:hover td a,
+tr.eor:hover td a { color:gold; }
+*/
+
+.message
+{
+  color: #555;
+  font-size: 11px;
+}
+
+a.util
+{
+  color:#c00;
+}
+
+.pipe
+{
+  color:#999;
+}
+
+.tools { float:right; }
+
+.time
+{
+  color:#666;
+  xvertical-align:top;
+}
+
+
+.expclass
+{
+  xcolor:#999;
+}
+
+tr.deleted td {
+  color:#aaa;
+  text-decoration: line-through;
+}
+tr.deleted td a { color:#aaa; }
+
+.pages { float:right; margin-right:1em; }
+.pages a { text-decoration:underline; }
+.pages-bottom { border-top:2px solid #ddd; text-align:right; float:none;
+  padding-top:0.4em;
+  margin-top:0.4em;
+  padding-right:1em;
+  margin-right:0;
+}
+.pages nav { display: inline; }
+.pagination { display: inline; list-style: none; padding: 0; }
+.pagination > .page-item { display: inline; }
+
+/* right */
+
+#right h4
+{
+  xbackground:#171717;
+  xbackground:#333;
+  color:#999;
+  padding:3px 5px;
+  margin-bottom:0.5em;
+  font-weight:normal;
+}
+
+/* tabs */
+
+ul.tabs
+{
+  list-style-type:none;
+  padding:0;
+  margin:1em 0;
+  float:left;
+}
+ul.tabs li { float:left; display:inline; }
+ul.tabs li a
+{
+  padding:3px 7px;
+  margin-right:1em;
+  text-decoration:none;
+  color:black;
+}
+
+ul.tabs li a:hover
+{
+  background:#666;
+  color:white;
+}
+ul.tabs li.selected a
+{
+  background:black;
+  color:white;
+}
+
+#activity {
+  position:fixed;
+  top:0; right:18px;
+  width:200px;
+  padding:5px 0;
+  text-align:center;
+  background-color:#cf1313;
+  color:#fff;
+  opacity:.8;
+}
+
+#feed {
+  margin-top: 15px;
+}
+
+/* html5 changes */
+
+#exceptions table { border-collapse: separate; border-spacing: 0 8px; }
+#exceptions table thead { display: none; }
+#exceptions table tbody tr.exception td.time { white-space: nowrap }
+#exceptions table td { background: #ddd; box-shadow: 2px 2px 1px #ccc; padding: 10px 15px; }
+#exceptions table tr td:first-child { border-top-left-radius: 4px; }
+#exceptions table tr td:last-child { border-top-right-radius: 4px; }
+#exceptions table tr td:first-child { border-bottom-left-radius: 4px; }
+#exceptions table tr td:last-child { border-bottom-right-radius: 4px; }
+
+#container #left #showpage { margin-bottom:1em; }

data/app/assets/stylesheets/exception_logger/logged_exceptions.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/exception_logger/application_controller.rb

@@ -0,0 +1,4 @@
+module ExceptionLogger
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/exception_logger/logged_exceptions_controller.rb

@@ -0,0 +1,105 @@
+module ExceptionLogger
+  class LoggedExceptionsController < ApplicationController
+    layout 'exception_logger/application'
+
+    cattr_accessor :application_name
+
+    helper_method :params_filters
+
+    # ApplicationController.class_eval do
+    #   rescue_from Exception, with: :log_exception_handler
+    # end
+
+    def index
+      @exception_names    = LoggedException.class_names
+      @controller_actions = LoggedException.controller_actions
+      query
+    end
+
+    def query
+      exceptions = LoggedException.sorted
+      unless params[:id].blank?
+        exceptions = exceptions.where(id: params[:id])
+      end
+      unless params[:query].blank?
+        exceptions = exceptions.message_like(params[:query])
+      end
+      unless params[:date_ranges_filter].blank?
+        exceptions = exceptions.days_old(params[:date_ranges_filter])
+      end
+      unless params[:exception_names_filter].blank?
+        exceptions = exceptions.by_exception_class(params[:exception_names_filter])
+      end
+      unless params[:controller_actions_filter].blank?
+        c_a_params = params[:controller_actions_filter].split('/')
+        controller_filter = c_a_params.first.underscore
+        action_filter = c_a_params.last.downcase
+        exceptions = exceptions.by_controller(controller_filter)
+        exceptions = exceptions.by_action(action_filter)
+      end
+      @exceptions = exceptions.paginate(page: params[:page], per_page: 30)
+
+      respond_to do |format|
+        format.html { redirect_to action: 'index' unless action_name == 'index' }
+        format.js
+      end
+    end
+
+    def feed
+      @exceptions = LoggedException.all
+
+      respond_to do |format|
+        format.rss { render layout: false }
+      end
+    end
+
+    def show
+      @exception = LoggedException.where(id: params[:id]).first
+
+      respond_to do |format|
+        format.js
+        format.html
+      end
+    end
+
+    def destroy
+      @exception = LoggedException.where(id: params[:id]).first
+      @exception.destroy
+    end
+
+    def destroy_all
+      LoggedException.where(id: params[:ids]).delete_all unless params[:ids].blank?
+      query
+    end
+
+    def clear
+      LoggedException.delete_all
+      redirect_back fallback_location: request.referer
+    end
+
+    private
+
+    def params_filters
+      {
+        query: params[:query],
+        date_ranges_filter: params[:date_ranges_filter],
+        exception_names_filter: params[:exception_names_filter],
+        controller_actions_filter: params[:controller_actions_filter],
+      }
+    end
+
+    def access_denied_with_basic_auth
+      headers["Status"]           = "Unauthorized"
+      headers["WWW-Authenticate"] = %(Basic realm="Web Password")
+      render text: "Could't authenticate you", status: '401 Unauthorized'
+    end
+
+    @@http_auth_headers = %w(X-HTTP_AUTHORIZATION HTTP_AUTHORIZATION Authorization)
+    # gets BASIC auth info
+    def get_auth_data
+      auth_key  = @@http_auth_headers.detect { |h| request.env.has_key?(h) }
+      auth_data = request.env[auth_key].to_s.split unless auth_key.blank?
+      return auth_data && auth_data[0] == 'Basic' ? Base64.decode64(auth_data[1]).split(':')[0..1] : [nil, nil]
+    end
+  end
+end

data/app/helpers/exception_logger/application_helper.rb

@@ -0,0 +1,4 @@
+module ExceptionLogger
+  module ApplicationHelper
+  end
+end

data/app/helpers/exception_logger/logged_exceptions_helper.rb

@@ -0,0 +1,38 @@
+module ExceptionLogger
+  module LoggedExceptionsHelper
+    def pretty_exception_date(exception)
+      if Date.today == exception.created_at.to_date
+        "#{I18n.t('exception_logger.logged_exceptions.index.today')}, #{exception.created_at.strftime(Time::DATE_FORMATS[:exc_time])}"
+      else
+        exception.created_at.strftime(Time::DATE_FORMATS[:exc_date])
+      end
+    end
+
+    def filtered?
+      [:query, :date_ranges_filter, :exception_names_filter, :controller_actions_filter].any? { |p| params[p] }
+    end
+
+    def listify(text)
+      list_items = text.scan(/^\s*\* (.+)/).map {|match| content_tag(:li, match.first) }
+      content_tag(:ul, list_items)
+    end
+
+    def page_title(text)
+      title = ""
+      unless controller.application_name.blank?
+        title << "#{controller.application_name} :: "
+      end
+      title << text.to_s
+      content_for(:title, title.to_s)
+    end
+
+    # Rescue textilize call if RedCloth is not available.
+    def pretty_format(text)
+      begin
+        textilize(text).html_safe
+      rescue
+        simple_format(text).html_safe
+      end
+    end
+  end
+end

data/app/models/exception_logger/logged_exception.rb

@@ -0,0 +1,99 @@
+module ExceptionLogger
+  class LoggedException < ActiveRecord::Base
+    scope :by_exception_class, ->(exception_class) { where(exception_class: exception_class) }
+    scope :by_controller_and_action, lambda { |controller_name, action_name|
+                                       where(controller_name: controller_name, action_name: action_name)
+                                     }
+    scope :by_controller, ->(controller_name) { where(controller_name: controller_name) }
+    scope :by_action, ->(action_name) { where(action_name: action_name) }
+    scope :message_like, ->(query) {  where('message like ?', "%#{query}%") }
+    scope :days_old, ->(day_number) { where('created_at >= ?', day_number.to_f.days.ago.utc) }
+    scope :sorted, -> { order('created_at DESC') }
+
+    # Class methods
+
+    self.table_name = 'logged_exceptions'
+
+    def self.create_from_exception(controller, exception, data)
+      message = exception.message.inspect
+      message << "\n* Extra Data\n#{data}" unless data.blank?
+      if exception.class.name != 'ActiveRecord::RecordNotFound'
+        e = create!(
+          exception_class: exception.class.name,
+          controller_name: controller.controller_path,
+          action_name: controller.action_name,
+          message: message,
+          backtrace: exception.backtrace,
+          request: controller.request
+        )
+      else
+        self
+      end
+    end
+
+    def self.class_names
+      select('DISTINCT exception_class')
+        .order(:exception_class)
+        .collect(&:exception_class)
+    end
+
+    def self.controller_actions
+      select('DISTINCT controller_name, action_name')
+        .order(:controller_name, :action_name)
+        .collect(&:controller_action)
+    end
+
+    def self.host_name
+      `hostname -s`.chomp
+    end
+
+    # Instance methods
+
+    def name
+      "#{exception_class} in #{controller_action}"
+    end
+
+    def controller_action
+      @controller_action ||= "#{controller_name.camelcase}/#{action_name}"
+    end
+
+    # Setter methods
+
+    def backtrace=(trace)
+      trace = sanitize_backtrace(trace) * "\n" unless trace.is_a?(String)
+      write_attribute :backtrace, trace
+    end
+
+    def request=(request)
+      if request.is_a?(String)
+        write_attribute :request, request
+      else
+        max = request.env.keys.max { |a, b| a.length <=> b.length }
+        env = request.env.keys.sort.inject [] do |env, key|
+          env << '* ' + format('%-*s: %s', max.length, key, request.env[key].to_s.strip)
+        end
+        write_attribute(:environment, (env << "* Process: #{$$}" << "* Server : #{self.class.host_name}") * "\n")
+
+        write_attribute(:request, [
+          "* URL:#{unless request.get?
+                     " #{request.method.to_s.upcase}"
+                   end} #{request.protocol}#{request.env['HTTP_HOST']}#{request.fullpath}",
+          "* Format: #{request.format}",
+          "* Parameters: #{request.parameters.inspect}",
+          "* Rails Root: #{rails_root}"
+        ].join("\n"))
+      end
+    end
+
+    private
+
+    def sanitize_backtrace(trace)
+      backtrace_regex = /^#{Regexp.escape(rails_root)}/
+      trace.collect { |line| Pathname.new(line.gsub(backtrace_regex, '[RAILS_ROOT]')).cleanpath.to_s }
+    end
+
+    def rails_root
+      @rails_root ||= Pathname.new(Rails.root).cleanpath.to_s
+    end
+  end
+end