exception_handler 0.0.25 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3ecf6db313677575e4982d5feb980e84aaf6c1a
-  data.tar.gz: 04f89200bc55afdd98c2ee56a31576742d6d7a2b
+  metadata.gz: e1e32a60e6d820806fc19a72664d3713630b4986
+  data.tar.gz: 6ba577f2b71bc13222d2cfa88a970736c53fc089
 SHA512:
-  metadata.gz: 2f92d3453a3c1f2e51325d5edf12ab5dc1deaf54636f6f2607866893ed0fb3cb3ee4f4d09994df22de0156fe5d573b38f0f5ee177e334cac11061119b62eaceb
-  data.tar.gz: 3401ff97b938d7eef821f9796ac7a84f87eed0c06eebe7f7fe87ae6d6cd2509c8bef90157de8465167c1381b070d1958d65c4cee425db4bb62d42576f6d13447
+  metadata.gz: 1c9bc99f7043be2a6266afed2ecabca7f01927565f8098e85d607dd533df13eb3f8ca5a8b8e84f93d34586a2c942a08c4d2d9e00f3b13163c9cd6229242277ce
+  data.tar.gz: f13e51b07425ace2e5849859861f076d8b2c36c2f63be93b0853c399c7f1f13aa3e89b8a0ca18de9860a4c3b9958d161032078e1345e73b09d9443dcc95547f7

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+ - 2.0.0
+ - 2.1.1
+ - ruby-head

data/Gemfile

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

data/README.md

@@ -1,11 +1,18 @@
 # ExceptionHandler
 
-Exception Handler is a gem to help you better capture & handle exceptions in production Rails apps.
+[![Gem Version](https://badge.fury.io/rb/exception_handler.svg)](http://badge.fury.io/rb/exception_handler)
+[![Code Climate](https://codeclimate.com/github/richpeck/exception_handler.png)](https://codeclimate.com/github/richpeck/exception_handler)
+[![Coverage Status](https://coveralls.io/repos/richpeck/exception_handler/badge.png)](https://coveralls.io/r/richpeck/exception_handler)
+[![Build Status](https://travis-ci.org/richpeck/exception_handler.svg?branch=master)](https://travis-ci.org/richpeck/exception_handler)
 
-Firstly, the gem includes Middleware to save errors in your database.
-Second, it includes an `exception` controller to route your errors to specific pages.
+**ExceptionHandler** Rails Gem (adapted from [this tutorial](https://gist.github.com/wojtha/8433843))
 
-The gem is born out of our work at [frontline utilities](http://frontlineutilities.co.uk/ruby-on-rails/exception-handler)
+Works with the [`config.exceptions_app`](http://guides.rubyonrails.org/configuring.html#rails-general-configuration) hook in Rails' middleware stack:
+
+```config.exceptions_app sets the exceptions application invoked by the ShowException middleware when an exception happens. Defaults to ActionDispatch::PublicExceptions.new(Rails.public_path).```
+
+
+---------
 
 ## Installation
 
@@ -21,8 +28,30 @@ Or install it yourself as:
 
     $ gem install exception_handler
 
+---------
+
 ## Usage
 
-TODO: Write usage instructions here
+###Dev
+
+	#config/environments/development.rb
+	config.consider_all_requests_local = false # true
+
+`config.exceptions_app` is used in Rails' production environment. Therefore, if you wish to test the gem in dev,
+you'll need to make your app process requests as `production` for now. This is a temporary step, and will be
+resolved in a new version
+
+###Production
+
+    No action required
+
+
+--------
+
+## Contributing
 
-## Contributing
+1. Fork it ( https://github.com/richpeck/exception_handler/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/app/controllers/exception_handler/exception_controller.rb

@@ -0,0 +1,58 @@
+module ExceptionHandler
+  class ExceptionController < ApplicationController
+
+    #Response
+    respond_to :html, :xml, :json
+
+  	#Dependencies
+  	before_action :status
+
+    #Layout
+    layout :layout_status
+
+    ####################
+    #      Action      #
+    ####################
+
+  	#Show
+    def show
+      respond_with status: @status
+    end
+
+    ####################
+    #   Dependencies   #
+    ####################
+
+    protected
+
+    #Info
+    def status
+      @exception  = env['action_dispatch.exception']
+      @status     = ActionDispatch::ExceptionWrapper.new(env, @exception).status_code
+      @response   = ActionDispatch::ExceptionWrapper.rescue_responses[@exception.class.name]
+    end
+
+    #Format
+    def details
+      @details ||= {}.tap do |h|
+        I18n.with_options scope: [:exception, :show, @response], exception_name: @exception.class.name, exception_message: @exception.message do |i18n|
+          h[:name]    = i18n.t "#{@exception.class.name.underscore}.title", default: i18n.t(:title, default: @exception.class.name)
+          h[:message] = i18n.t "#{@exception.class.name.underscore}.description", default: i18n.t(:description, default: @exception.message)
+        end
+      end
+    end
+    helper_method :details
+
+    ####################
+    #      Layout      #
+    ####################
+
+    private
+
+    #Layout
+    def layout_status
+      @status.to_s == "404" ? "application" : "error"
+    end
+
+  end
+end

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

@@ -0,0 +1,5 @@
+.box
+	%h1
+		= details[:name]
+	%p
+		= details[:message]

data/app/views/layouts/error.html.haml

@@ -0,0 +1,57 @@
+!!!
+%html
+	%head
+
+		/Info
+		= meta_tags
+
+		/Styling
+		:sass
+			html 
+				height: 100%
+				background: #fff url(#{image_path "custom_error_pages/bg.png"}) bottom repeat-x
+			
+			body 
+				font-family: Helvetica, Arial, Sans-Serif
+				font-size: 14px
+
+			.error_container 
+				display: block
+				margin: auto
+				margin: 10% auto 0 auto
+				width: 40%
+			
+			.error_container .error 
+				display: block 
+				text-align: center
+			
+			.error_container .error img 
+				display: block
+				margin: 0 auto 15px auto
+			
+			.error_container .message > * 
+				display: block
+			
+			.error_container .message strong 
+				font-weight: bold
+				color: #f00
+			
+			.error_container .contact_info 
+				display: block
+				text-align: center
+				margin: 25px 0 0 0
+			
+			.error_container .contact_info a 
+				display: inline-block
+				margin: 0
+				opacity: 0.4
+				transition: opacity 0.15s ease
+			
+			.error_container .contact_info a:hover 
+				opacity: 0.8
+			
+
+	/Body
+	%body
+		.error_container
+			= yield

data/exception_handler.gemspec

@@ -6,21 +6,20 @@ require 'exception_handler/version'
 Gem::Specification.new do |spec|
   spec.name          = "exception_handler"
   spec.version       = ExceptionHandler::VERSION
-  spec.authors       = ["Richard Peck", "Joe Hilton"]
-  spec.email         = ["rpeck@frontlineutilities.co.uk", "jhilton@frontlineutilities.co.uk"]
-  spec.summary       = %q{Middleware & Controller To Handle Errors In Production Rails Apps}
-  spec.description   = %q{Exception Handler gives you middleware & an exception controller, to both capture exceptions & store them in your db; and to have custom error pages.}
-  spec.homepage      = "http://frontlineutilities.co.uk/ruby-on-rails/exception-handler"
+  spec.authors       = ["Richard Peck"]
+  spec.email         = ["rpeck@frontlineutilities.co.uk"]
+  spec.summary       = %q{Rails gem to show custom error pages in production. Also logs errors in "errors" db if required}
+  spec.description   = %q{Rails gem to create custom error pages. Captures exceptions using "exception_app" callback, routing to "Exception" controller, rendering the view as required.}
+  spec.homepage      = "http://frontlineutilities.co.uk/ror/custom_error_pages"
   spec.license       = "MIT"
-  spec.metadata      = { "source" => "https://github.com/richpeck/exception_handler" }
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.post_install_message = "Thank you for installing!"
-
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-end
+  spec.add_development_dependency "rails", "~> 4.0.0"
+  spec.add_development_dependency "haml", "~> 4.0.5"
+  spec.add_development_dependency "sass", "~> 3.3.7"
+end

data/lib/exception_handler.rb

@@ -1,48 +1,20 @@
-######################################################
+###########################################
 
 require "action_dispatch"
+
 require "exception_handler/version"
 require "exception_handler/parser"
 
-######################################################
+###########################################
 
 module ExceptionHandler
 
-	#Hook
-	class Engine < ::Rails::Engine
-		config.middleware.use 'ExceptionHandler::Message' 								#DB / Email
-		config.exceptions_app = ->(env) { ExceptionController.action(:show).call(env) } #Error Pages
-	end
-
-	#DB / Email
-	class Message
-
-		# Init
-		def initialize(app)
-			@app = app
-		end
-
-		#Error
-		def call(env)
-			@app.call(env)
-
-		rescue Exception => exception
-			request = ActionDispatch::Request.new(env)
-			controller = env['action_controller.instance']
-
-			ErrorHandler::Parser.new(exception, request, controller).save unless self.ignore?(exception, request)
-			raise exception
-		end
-
-		#Ignore
-		def ignore?(exception, request, ignored = {})
-			ignored[:errors] = [ActionController::RoutingError, AbstractController::ActionNotFound, ActiveRecord::RecordNotFound]
-			ignored[:bots]   = /\b(Baidu|Gigabot|Googlebot|libwww-per|lwp-trivial|msnbot|SiteUptime|Slurp|Wordpress|ZIBB|ZyBorg|Yandex|Jyxobot|Huaweisymantecspider|ApptusBot)\b/i
-
-			return true if ignored[:errors].include?(exception.class) && request.referer.blank?
-			return true if request.user_agent =~ ignored[:bots]
+	#Exception Handler
+	class Exceptions < Rails::Engine
+		initializer "exception_handler.configure_rails_initialization" do |app|
+			app.config.middleware.use "ExceptionHandler::Message" #Parser
+			app.config.exceptions_app = ->(env) { ExceptionHandler::ExceptionController.action(:show).call(env) } #Pages
 		end
-
 	end
 
 end

data/lib/exception_handler/parser.rb

@@ -1,4 +1,37 @@
-module ErrorHandler
+module ExceptionHandler
+
+	#Message
+	class Message
+
+		# Init
+		def initialize(app)
+			@app = app
+		end
+
+		#Error
+		def call(env)
+			@app.call(env)
+
+		rescue Exception => exception
+			request = ActionDispatch::Request.new(env)
+			controller = env['action_controller.instance']
+
+			ExceptionHandler::Parser.new(exception, request, controller).save unless self.ignore?(exception, request)
+			raise exception
+		end
+
+		#Ignore
+		def ignore?(exception, request, ignored = {})
+			ignored[:errors] = [ActionController::RoutingError, AbstractController::ActionNotFound, ActiveRecord::RecordNotFound]
+			ignored[:bots]   = /\b(Baidu|Gigabot|Googlebot|libwww-per|lwp-trivial|msnbot|SiteUptime|Slurp|Wordpress|ZIBB|ZyBorg|Yandex|Jyxobot|Huaweisymantecspider|ApptusBot)\b/i
+
+			return true if ignored[:errors].include?(exception.class) && request.referer.blank?
+			return true if request.user_agent =~ ignored[:bots]
+		end
+
+	end
+
+	#Parse
 	class Parser 
 
 		#Init
@@ -9,7 +42,7 @@ module ErrorHandler
 		#Save
 		def save
 			ActiveRecord::Base.logger.silence do
-				Error.create(relevant_info)
+				#ExceptionHandler::Error.create(relevant_info)
 			end
  			log(relevant_info)
 		end

data/lib/exception_handler/version.rb

@@ -1,3 +1,3 @@
 module ExceptionHandler
-  VERSION = "0.0.25"
-end
+  VERSION = "0.2.0"
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handler
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.2.0
 platform: ruby
 authors:
 - Richard Peck
-- Joe Hilton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-26 00:00:00.000000000 Z
+date: 2014-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -26,43 +25,74 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.5
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-description: Exception Handler gives you middleware & an exception controller, to
-  both capture exceptions & store them in your db; and to have custom error pages.
+        version: 3.3.7
+description: Rails gem to create custom error pages. Captures exceptions using "exception_app"
+  callback, routing to "Exception" controller, rendering the view as required.
 email:
 - rpeck@frontlineutilities.co.uk
-- jhilton@frontlineutilities.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/exception_handler/exception_controller.rb
+- app/views/exception_handler/exception/show.html.haml
+- app/views/layouts/error.html.haml
 - exception_handler.gemspec
 - lib/exception_handler.rb
 - lib/exception_handler/parser.rb
 - lib/exception_handler/version.rb
-homepage: http://frontlineutilities.co.uk/ruby-on-rails/exception-handler
+- vendor/assets/images/exception_handler/bg.png
+homepage: http://frontlineutilities.co.uk/ror/custom_error_pages
 licenses:
 - MIT
-metadata:
-  source: https://github.com/richpeck/exception_handler
-post_install_message: Thank you for installing!
+metadata: {}
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -81,5 +111,6 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: Middleware & Controller To Handle Errors In Production Rails Apps
+summary: Rails gem to show custom error pages in production. Also logs errors in "errors"
+  db if required
 test_files: []