exception_handler 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9910d9ea8a74498ce664a912a9615bed8e8c9ce1
-  data.tar.gz: 20e2b4badb0d3bab269375565f0b8e7141c9bca6
+  metadata.gz: dcd9b5923dc39f43b43beb02ee3004ea850f3103
+  data.tar.gz: f9c1174fe636735617607af47e51cf5b43eb178b
 SHA512:
-  metadata.gz: a2be4863eb8b102b2ecd78bd9d8895d08f2b276b31b7ecc9e497c76a7f1594efe1a5ddda192851b7a47173fca23137a3a786b0d376dcceed050d65693fdac6f0
-  data.tar.gz: f75a584b9264900b20d8af0f495318ca9a17db5c6b773526396838bad23898f4a4ec7de8902f22f3cd25c6dc874428040021d93433af6061ebbd542458b8f2ab
+  metadata.gz: b85c858abce97e7937823922a0981caae1b3dbdd0ae639a52431b4a3f139a7ee2661adf38307846829b4a6d7d293be26ada2546d15711f6632892d77f7fff69a
+  data.tar.gz: a3705b63eb93501674d6dd829c98bee369ef70911377177c742c7293d81e737cd4e409d4d22554076b79241eeaeafbcc74b2505b49acdc264504d4fd13d60c93

data/README.md

@@ -7,7 +7,7 @@
 [![Build Status](https://travis-ci.org/richpeck/exception_handler.svg?branch=master)](https://travis-ci.org/richpeck/exception_handler)
 
 
-[**ExceptionHandler** Rails Gem](https://rubygems.org/gems/exception_handler) (adapted from [this tutorial](https://gist.github.com/wojtha/8433843) & our own middleware)
+[**ExceptionHandler** Rails Gem](https://rubygems.org/gems/exception_handler) (adapted from [this tutorial](https://gist.github.com/wojtha/8433843) & [this tutorial](http://www.sharagoz.com/posts/1-rolling-your-own-exception-handler-in-rails-3))
 
 Works with the [`config.exceptions_app`](http://guides.rubyonrails.org/configuring.html#rails-general-configuration) hook in Rails' middleware stack:
 
@@ -18,13 +18,55 @@ Works with the [`config.exceptions_app`](http://guides.rubyonrails.org/configuri
 
 ####Custom Error Pages
 
-You can create *custom error pages*. These allow you to serve your own design error pages in production; showing both the error, and the problem. This is a big step forward from the standard Rails error reporting facility
+You can deploy *custom error pages*. These allow you to serve your own design error pages in production; showing both the error, and the problem. This is a big step forward from the standard Rails error reporting facility
 
+There are two types of error page: 
 
+	- 404 errors
+	- 500 errors (+ other)
 
-####Save Errors To DB
+The **`404`** error is standard (missing page) - we use your own `layout` for this. The **`500 & other errors`** are `server` issues, and so we have included an `errors` layout (`/views/layouts/errors.html.haml`).
 
-Sometimes, you want to save your errors to your database (admin areas, multi-tenant apps, etc). We've included some middleware which captures the routes 
+The `errors` layout in important. If you try and load your "standard" layout with an internal server error, all your
+"supporting" functionality is called too. Problem? You're likely going to cause even more errors.
+
+**Custom error pages** are included by default.
+You can change them by using the **`rails generate exception_handler:assets --views`**:
+
+ **500 Errors** | **404 Errors**
+--- | ---
+![500 Server Error Pages](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/500.png "500 Server Error Page") | ![404 Server Error Pages](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/500.png "404 Server Error Page") 
+
+-----------
+
+####Saving Errors To DB
+
+Adapted & refactored from [this tutorial](http://www.sharagoz.com/posts/1-rolling-your-own-exception-handler-in-rails-3)
+
+Sometimes, you want to save your errors to your database (admin areas, multi-tenant apps, etc). We've included some middleware which captures the exceptions & saves them to the db:
+
+	- Model (class) Name
+	- Error Message
+	- Stack trace
+	- Target URL
+	- Referrer URL
+	- Params
+	- User Agent (Browser Details)
+
+This db allows you to track, read & repair errors in your application on the fly. We deploy this in our admin areas, to help us
+appreciate any issues on our client apps.
+
+![500 Server Error Pages](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/db.png "500 Server Error Page")
+
+This functionality is **`disabled`** by default
+
+To enable, you need to do the following:
+
+	- rails generate exception_handler:install #-> will install config initializer
+	- rails generate exception_handler:migration #-> will create migration (for `errors` table)
+	- rake db:migrate #-> creates `errors` table
+
+	- config/initializers/exception_handler.rb
 
 ---------
 
@@ -42,21 +84,16 @@ Or install it yourself as:
 
     $ gem install exception_handler
 
-###Generators
+###Configuration
 
 	# General
 	$ rails generate exception_handler:install
 
-	#Config (for db)
-	$ rails generate exception_handler:config
+	# Migration
+	$ rails generate exception_handler:migrate
 
-	#Assets
-	$ rails generate exception_handler:assets:all
-	-
-	$ rails generate exception_handler:assets:views
-	$ rails generate exception_handler:assets:controllers
-	$ rails generate exception_handler:assets:models
-	$ rails generate exception_handler:assets:assets
+	# Files
+	$ rails generate exception_handler:assets
 
 
 

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

@@ -12,4 +12,4 @@
 	/Contact
 	.contact
 		- ExceptionHandler.config.social.each do |item, address|
-			%a{ href: address }> #{image_tag "exception_handler/contact/#{item}.png", title: item.to_s.titleize}
+			%a{ href: address, target: "_blank" }> #{image_tag "exception_handler/contact/#{item}.png", title: item.to_s.titleize}

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

@@ -19,8 +19,8 @@
 			.error_container 
 				display: block
 				margin: auto
-				margin: 15% auto 0 auto
-				width: 40%
+				margin: 10% auto 0 auto
+				width: 30%
 			
 			.error_container .error 
 				display: block 

data/lib/exception_handler/config.rb

@@ -13,7 +13,7 @@ module ExceptionHandler
 			twitter: 	"http://twitter.com/frontlineutils",
 			facebook: 	"https://facebook.com/frontline.utilities",
 			linkedin: 	"https://linkedin.com/company/frontline-utilities",
-			youtube: 	"http://youtube.com/frontlineutils",
+			youtube: 	"https://youtube.com/user/frontlineutils",
 			fusion: 	"http://frontlinefusion.com/frontlineutils"
 		}
     end

data/lib/exception_handler/version.rb

@@ -1,3 +1,3 @@
 module ExceptionHandler
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end

data/lib/generators/templates/exception_handler.rb

@@ -19,7 +19,7 @@ ExceptionHandler.setup do |config|
 		twitter: 	"http://twitter.com/frontlineutils",
 		facebook: 	"https://facebook.com/frontline.utilities",
 		linkedin: 	"https://linkedin.com/company/frontline-utilities",
-		youtube: 	"http://youtube.com/frontlineutils",
+		youtube: 	"https://youtube.com/user/frontlineutils",
 		fusion: 	"http://frontlinefusion.com/frontlineutils"
 	}
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_handler
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Richard Peck
@@ -124,11 +124,19 @@ files:
 - lib/generators/templates/create_errors.rb
 - lib/generators/templates/create_table.rb
 - lib/generators/templates/exception_handler.rb
+- readme/500.png
+- readme/db.png
 - readme/exception_handler.png
 - spec/exception_spec.rb
 - spec/installation_spec.rb
 - spec/spec_helper.rb
+- vendor/assets/images/exception_handler/alert.png
 - vendor/assets/images/exception_handler/bg.png
+- vendor/assets/images/exception_handler/contact/facebook.png
+- vendor/assets/images/exception_handler/contact/fusion.png
+- vendor/assets/images/exception_handler/contact/linkedin.png
+- vendor/assets/images/exception_handler/contact/twitter.png
+- vendor/assets/images/exception_handler/contact/youtube.png
 homepage: http://frontlineutilities.co.uk/ror/custom_error_pages
 licenses:
 - MIT