exception_handler 0.5.1 → 0.6.0

data/app/assets/stylesheets/styles/_exception.css.erb

@@ -0,0 +1,105 @@
+/* ---------------------------------------------------- */
+/* ---------------------------------------------------- */
+
+.exception {
+  display:         block;
+  color:           #fff;
+  position:        relative;
+  width:           30%;
+  top:             48%;
+  margin:          auto;
+  background:      rgba(255,255,255,0.15);
+  border:          1px solid rgba(0,0,0,1);
+  max-width:       450px;
+  min-width:       350px;
+  font-size:       0.85em;
+  border-radius:   5px;
+  box-sizing:      border-box;
+  box-shadow:      0px 0px 6px 0px rgba(0,0,0,0.8);
+  background-clip: border-box;
+  text-shadow:     0 1px 0 rgba(0,0,0,1);
+  overflow-x:      hidden;
+  overflow-y:      hidden;
+  transition:      background 0.1s ease-in-out;
+  transform:       translateY(-50%);
+}
+.exception::before {
+  content:           attr(data-status) " Error (" attr(data-response) ") …";
+  display:           block;
+  color:             #fff;
+  font-size:         1.75em;
+  font-weight:       bold;
+  text-transform:    capitalize;
+  background-color:  rgba(227,11,11,1);
+  padding:           1em;
+  box-sizing:        border-box;
+  background-color:  rgba(227,11,11,1);
+
+  border-bottom: 1px solid rgba(227,11,11,0.35);
+
+  background-image: url(<%= asset_url("exception_handler/noise.png") %>), -moz-linear-gradient(top,  rgba(227,11,11,0) 0%, rgba(0,0,0,0.55) 100%); /* FF3.6+ */
+  background-image: url(<%= asset_url("exception_handler/noise.png") %>), -webkit-gradient(linear, left top, left bottom, color-stop(0%,rgba(227,11,11,0)), color-stop(100%,rgba(0,0,0,0.55))); /* Chrome,Safari4+ */
+  background-image: url(<%= asset_url("exception_handler/noise.png") %>), -webkit-linear-gradient(top, rgba(227,11,11,0) 0%,rgba(0,0,0,0.55) 100%); /* Chrome10+,Safari5.1+ */
+  background-image: url(<%= asset_url("exception_handler/noise.png") %>), -o-linear-gradient(top,  rgba(227,11,11,0) 0%,rgba(0,0,0,0.55) 100%); /* Opera 11.10+ */
+  background-image: url(<%= asset_url("exception_handler/noise.png") %>), -ms-linear-gradient(top,  rgba(227,11,11,0) 0%,rgba(0,0,0,0.55) 100%); /* IE10+ */
+  background-image: url(<%= asset_url("exception_handler/noise.png") %>), linear-gradient(to bottom,  rgba(227,11,11,0) 0%,rgba(0,0,0,0.55) 100%); /* W3C */
+	filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#007a07ed', endColorstr='#000000',GradientType=0 ); /* IE6-9 */
+}
+.exception::after {
+  content:       attr(data-rails) " \203A\203A  Our developers have been notified. Click here to go home.";
+  display:       block;
+  padding:       1em;
+  font-size:     0.9em;
+  background:    rgba(0,0,0,0.5);
+}
+.exception:hover { cursor: pointer; }
+
+.exception span:before {
+  display: block;
+  content: url(<%= asset_url("exception_handler/alert.png") %>);
+  padding: 5em 0;
+  text-align: center;
+}
+.exception span:after {
+  content: "";
+  display: block;
+  position: absolute;
+  left: 0;
+  top: 0;
+  width: 100%;
+  height: 2px;
+
+  background: rgba(0,0,0,0.35);
+  background: -moz-linear-gradient(top, rgba(0,0,0,0.35) 0%, rgba(0,0,0,0) 100%);
+  background: -webkit-gradient(left top, left bottom, color-stop(0%, rgba(0,0,0,0.35)), color-stop(100%, rgba(0,0,0,0)));
+  background: -webkit-linear-gradient(top, rgba(0,0,0,0.35) 0%, rgba(0,0,0,0) 100%);
+  background: -o-linear-gradient(top, rgba(0,0,0,0.35) 0%, rgba(0,0,0,0) 100%);
+  background: -ms-linear-gradient(top, rgba(0,0,0,0.35) 0%, rgba(0,0,0,0) 100%);
+  background: linear-gradient(to bottom, rgba(0,0,0,0.35) 0%, rgba(0,0,0,0) 100%);
+  filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#000000', endColorstr='#000000', GradientType=0 );
+}
+.exception span {
+  position: relative;
+  display: block;
+  min-height: 288px;
+  padding: 0 2em 3.5em;
+  box-sizing: border-box;
+  background: #000 url(<%= asset_url("exception_handler/alert.jpg") %>) top center no-repeat;
+  background-size: cover;
+  text-align: center;
+
+  border-width: 0 1px;
+  border-style: solid;
+  border-color: rgba(255,255,255,0.065);
+}
+.exception span strong {
+  display: block;
+  margin-bottom: 0.5em;
+  margin-top: 0.25em;
+  font-size: 1.95em;
+  text-transform: uppercase;
+  text-decoration: underline;
+}
+
+/* ---------------------------------------------------- */
+/* ---------------------------------------------------- */

data/app/assets/stylesheets/styles/_footer.css.erb

@@ -0,0 +1,27 @@
+/* ---------------------------------------------------- */
+/* ---------------------------------------------------- */
+
+footer {
+  display:  block;
+  position: absolute;
+  bottom: 0;
+  width: 100%;
+  opacity: 0.75;
+  font-size: 2em;
+  text-align: center;
+  vertical-align: middle;
+  transition: opacity 0.15s ease-in-out;
+}
+footer:hover   { opacity: 1; }
+footer a       {
+  display: inline-block;
+  opacity: 0.45;
+  margin-right: -4px;
+  padding: 1.5em 0.3em;
+  transition: opacity 0.15s ease-in-out;
+}
+footer a:hover { opacity: 1; text-decoration: none; }
+footer a img   { width: 24px; vertical-align: middle; }
+
+/* ---------------------------------------------------- */
+/* ---------------------------------------------------- */

data/app/assets/stylesheets/styles/_responsive.css

@@ -0,0 +1,5 @@
+/* Responsive */
+@media screen and (max-width: 950px) {
+	html 				{ background-size: cover !important; }
+	.container .error	{ width: 55% !important; }
+}

data/app/controllers/exception_handler/exception_controller.rb

@@ -1,50 +1,45 @@
 module ExceptionHandler
   class ExceptionController < ApplicationController
 
-    #Response
-    #http://www.justinweiss.com/articles/respond-to-without-all-the-pain/
+    # => Response
+    # => http://www.justinweiss.com/articles/respond-to-without-all-the-pain/
     respond_to :html, :xml, :json
 
-    #Layout
-    layout :layout
-
-    #Helpers
-    helper ExceptionHandler::Engine.helpers      #-> HELPERS http://stackoverflow.com/questions/9809787/why-is-my-rails-mountable-engine-not-loading-helper-methods-correctly
-    include Rails.application.routes.url_helpers #-> ROUTES http://stackoverflow.com/a/6074911/1143732
-
-    ####################
-    #      Action      #
-    ####################
-
-    #Show
-    #Amend responses in tests
-    #Need to test validity of JSON responses etc
-    def show
-      @exception = ExceptionHandler::Exception.new request #-> Service Object
-      render status: @exception.status #-> Show apppropriate response
-    end
+    ##################################
+    ##################################
 
-    ####################
-    #   Dependencies   #
-    ####################
+    # => Definitions
+    # => Exception model (tied to DB)
+    before_action { |e| @exception = ExceptionHandler::Exception.new request: e.request }
+    before_action { @exception.save if @exception.valid? && ExceptionHandler.config.try(:db) }
 
-    protected
+    # => Routes
+    # => Removes need for "main_app" prefix in routes
+    # => http://stackoverflow.com/a/40251516/1143732
+    helper Rails.application.routes.url_helpers
 
-    # Status declarations moved to "show" w/ service object
-    # Details moved to "View Helper"
+    # => Layout
+    # => Layouts only 400 / 500 because they are the only error responses (300 is redirect)
+    # => http://guides.rubyonrails.org/layouts_and_rendering.html#the-status-option
+    # => Layout proc kills inheritance, needs to be method for now
+    layout :layout
 
     ####################
-    #      Layout      #
+    #      Action      #
     ####################
 
-    private
-
-    #Layout
-    def layout
-      (/^(5[0-9]{2})$/ !~ @exception.code.to_s) ? (ExceptionHandler.config.layouts["400"] || nil) : ExceptionHandler.config.layouts["500"] #-> if not 500, use predefined layout
+    def show
+      respond_with @exception, status: @exception.status
     end
 
-    ####################
+    ##################################
+    ##################################
+
+    private
+
+    def layout
+      ExceptionHandler.config.layouts[ @exception.status[0] + "00" ]
+    end
 
   end
 end

data/app/mailers/exception_handler/exception_mailer.rb

@@ -0,0 +1,17 @@
+module ExceptionHandler
+  class ExceptionMailer < ActionMailer::Base
+
+      # Layout
+      layout "mailers/layouts/mailer"
+
+      # Defaults
+      default from: 			    ExceptionHandler.config.email
+      default template_path: 	"exception_handler/mailers" # => http://stackoverflow.com/a/18579046/1143732
+
+      def new_exception e
+      	@exception = e
+        mail to: ExceptionHandler.config.email
+        Rails.logger.info "Exception Sent To → #{ExceptionHandler.config.email}"
+      end
+  end
+end

data/app/models/exception_handler/exception.rb

@@ -0,0 +1,191 @@
+module ExceptionHandler
+
+  ############################################################
+  ############################################################
+
+  # => Search Bots
+  # => Used in "Exception" class
+  BOTS = %w(Baidu Gigabot Googlebot libwww-per lwp-trivial msnbot SiteUptime Slurp Wordpress ZIBB ZyBorg Yandex Jyxobot Huaweisymantecspider ApptusBot)
+
+  # => Attributes
+  # => Determine schema size etc
+  ATTRS = %i(class_name status message trace target referrer params user_agent)
+
+  ############################################################
+  ############################################################
+
+    # => Class (inheritance dependent on whether db option is available)
+    self::Exception = Class.new (ExceptionHandler.config.try(:db) ? ActiveRecord::Base : Object) do
+
+      # => Include individual elements
+      # => Only required if no db present (no ActiveRecord)
+      if ExceptionHandler.config.try(:db)
+
+        # => Set Attrs
+        def initialize attributes={}
+            super
+            ATTRS.each do |type|
+              self[type] = eval type.to_s
+            end
+        end
+
+      else
+
+        # => AciveModel
+        include ActiveModel::Model
+        include ActiveModel::Validations
+
+        # => Callback Extension
+        extend ActiveModel::Callbacks
+        define_model_callbacks :initialize, only: :after
+
+        # => Initialize
+        # => http://api.rubyonrails.org/classes/ActiveModel/Callbacks.html
+        # => http://stackoverflow.com/a/17682228/1143732
+        def initialize attributes={}
+          super
+          run_callbacks :initialize do
+            # => Needed for after_initialize
+          end
+        end
+
+      end
+
+      ##################################
+      ##################################
+
+      ####################
+      #      Table       #
+      ####################
+
+          # Schema
+          ###################
+          # class_name      @exception.class.name
+          # status          ActionDispatch::ExceptionWrapper.new(@request.env, @exception).status_code
+          # message         @exception.message
+          # trace           @exception.backtrace.join("\n")
+          # target          @request.url
+          # referer         @request.referer
+          # params          @request.params.inspect
+          # user_agent      @request.user_agent
+          # created_at
+          # updated_at
+
+        # => Table is called "errors"
+        # => Dev needs to use migration to create db
+        if ExceptionHandler.config.try(:db)
+          def self.table_name
+            ExceptionHandler.config.db
+          end
+        end
+
+      ##################################
+      ##################################
+
+        ####################
+        #     Options      #
+        ####################
+
+        # => Email
+        # => after_initialize invoked after .new method called
+        # => Should have been after_create but user may not save
+        after_initialize Proc.new { |e| ExceptionHandler::ExceptionMailer.new_exception(e).deliver } if ExceptionHandler.config.try(:email) && ExceptionHandler.config.email.is_a?(String)
+
+        # => Attributes
+        attr_accessor :request, :klass, :exception, :description
+        attr_accessor *ATTRS unless ExceptionHandler.config.try(:db)
+
+        # => Validations
+        validates :klass, exclusion:    { in: [ActionController::RoutingError, AbstractController::ActionNotFound, ActiveRecord::RecordNotFound], message: "%{value}" }, if: "referer.blank?"
+        validates :user_agent, format:  { without: Regexp.new( BOTS.join("|"), Regexp::IGNORECASE ) }
+
+      ##################################
+      ##################################
+
+        ####################################
+        # Virtual
+        ####################################
+
+          # => Klass
+          # => Used for validation (needs to be cleaned up in 0.7.0)
+          def klass
+            exception.class
+          end
+
+          # => Exception (virtual)
+          def exception
+            request.env['action_dispatch.exception']
+          end
+
+          # => Description
+          def description
+            I18n.with_options scope: [:exception], message: message do |i18n|
+              i18n.t response, default: status
+            end
+          end
+
+        ####################################
+        # Exception
+        ####################################
+
+          # => Class Name
+          def class_name
+            exception.class.name
+          end
+
+          # => Message
+          def message
+            exception.message
+          end
+
+          # => Trace
+          def trace
+            exception.backtrace.join("\n")
+          end
+
+        ####################################
+        # Request
+        ####################################
+
+          # => Target URL
+          def target
+            request.url
+          end
+
+          # => Referrer URL
+          def referer
+            request.referer
+          end
+
+          # => Params
+          def params
+            request.params.inspect
+          end
+
+          # => User Agent
+          def user_agent
+            request.user_agent
+          end
+
+        ####################################
+        # Other
+        ####################################
+
+          # => Status code (404, 500 etc)
+          def status
+            ActionDispatch::ExceptionWrapper.new(request.env, exception).status_code.to_s
+          end
+
+          # => Server Response ("Not Found" etc)
+          def response
+            ActionDispatch::ExceptionWrapper.rescue_responses[class_name]
+          end
+
+      ##################################
+      ##################################
+
+    end
+  end
+
+  ############################################################
+  ############################################################

data/app/views/exception_handler/exception/show.html.erb

@@ -1,32 +1,3 @@
-<div class="error">
-	<% if /^(5[0-9]{2})$/ =~ @exception.status.to_s %>
-
-		<!--Message -->
-		<%= content_tag :div, class: "message" do %>
-			<%= content_tag :div, class: "title" do %>
-				<span><%= "#{@exception.status} Error - #{details[:name]}" %></span>
-				<%= link_to image_tag("exception_handler/close.png"), main_app.root_url, title: "Close (Go back home)", class: "close" %>
-			<% end %>
-
-			<%= content_tag :div, class: "details" do %>
-				<%= image_tag "exception_handler/alert.png", title: "#{@exception.status} Error" %>
-				<div class="status"><%= @exception.status %> Error</div>
-			<% end %>
-
-			<%= content_tag :div, class: "info" do %>
-				<span><%= details[:description] %></span>
-				<div class="notification">
-					<%= link_to image_tag("exception_handler/home.png", title: "Go Back Home"), main_app.root_url, class: "home" %>
-					<div class="version">v<%= Rails.version %></div>
-					<strong>Our developers have been notified - we're working on it!</strong>
-				</div>
-			<% end %>
-			
-		<% end %>
-
-	<% else %>
-
-		<%= content_tag :div, details[:description], class: "message" %>
-			
-	<% end %>
-</div>
+<%= content_tag :div, class: "exception", data: { status: @exception.status, response: @exception.response.to_s.humanize, rails: Rails.version }, onclick: "location.href=\"#{root_url}\";" do %>
+  <%= content_tag :span, @exception.description.html_safe %>
+<% end %>