goalie 0.0.0 → 0.0.1

data/README.md

@@ -0,0 +1,93 @@
+## Goalie
+
+Goalie is a flexible dynamic error response renderer for Rails built
+on Rack and Rails Engines. It provides the same default error pages as
+Rails, but allows you to easily customize them with *dynamic*
+content. This means you can use your application layout, have
+different error pages for different subdomains, and do all sorts nice
+things.
+
+## Installation
+
+WARNING: at this point, Goalie is highly experimental and should not
+be used in production!! Everything can and probably will change before
+it is ready for production. Install it only if you want to play with
+and/or contribute to it.
+
+    gem install goalie
+
+After you install it and add it to your `Gemfile`, you have to require
+it together with Rails' frameworks at the top of your
+`config/application.rb` file:
+
+    require 'goalie/rails'
+
+This will remove Rails' default exception renderer middleware
+(`ShowExceptions`) and use Goalie's instead. Unless you have custom
+static pages in your `public` directory (which we plan to support
+later), this will be a drop-in replacement.
+
+## Customization
+
+### Controllers
+
+The public (production) rescuing of errors is done by the
+`PublicErrorsController` found in Goalie's `app/controllers`
+directory. If you create a controller with the same name, it will
+automatically be used instead of Goalie's. All it needs to do is
+support the following actions:
+
+ * `internal_server_error`
+ * `not_found`
+ * `unprocessable_entity`
+ * `conflict`
+ * `method_not_allowed`
+ * `not_implemented`
+
+If you don't actually need a separate action for each of these errors,
+you can redirect them to others, for example, with:
+
+    def unprocessable_entity
+      render :action => 'internal_server_error'
+    end
+
+### Views
+
+You can also customize only the views and use Goalie's default
+controller. All you need is to have inside `app/views/public_errors`
+views with the same names as the actions listed above. Besides the
+standard stuff that Rails makes available to views, you will also have
+access to the following instance variables:
+
+ * `@request`
+ * `@exception`
+ * `@application_trace`
+ * `@framework_trace`
+ * `@full_trace`
+
+Be VERY careful when using this in production, as you could expose
+sensitive information inside the request and exception. Generally, you
+probably shouldn't use these variables at all. The only place it makes
+sense is to have a more detailed error screen for admins or other
+high-level users.
+
+## Credit
+
+Goalie copies a lot of code and ideas from:
+ * Rails' `ShowExceptions` middleware
+ * Rails' default error views
+ * Rails' exception_notification plugin
+
+Which are mostly the work of [Joshua Peek](http://joshpeek.com), with
+help from various contributors. We're highly indebted to them and
+thank them a lot for their work.
+
+## Contributions
+
+Any form of feedback, patches, issues, and documentation are highly
+appreciated.
+
+## License
+
+MIT license. Copyright 2010 [Helder Ribeiro](http://helderribeiro.net).
+

data/app/controllers/local_errors_controller.rb

@@ -1,5 +1,4 @@
 class LocalErrorsController < ActionController::Base
-  self.append_view_path "#{File.dirname(__FILE__)}/../views"
 
   before_filter :set_error_instance_variables
 

data/app/controllers/public_errors_controller.rb

@@ -1,23 +1,32 @@
 class PublicErrorsController < ActionController::Base
-  self.append_view_path "#{File.dirname(__FILE__)}/../views"
 
-  def internal_server_error
+  # 403
+  def forbidden
   end
 
+  # 404
   def not_found
   end
 
-  def unprocessable_entity
+  # 405
+  def method_not_allowed
+    render :action => 'internal_server_error'
   end
 
+  # 409
   def conflict
     render :action => 'internal_server_error'
   end
 
-  def method_not_allowed
-    render :action => 'internal_server_error'
+  # 422
+  def unprocessable_entity
+  end
+
+  # 500
+  def internal_server_error
   end
 
+  # 501
   def not_implemented
     render :action => 'internal_server_error'
   end

data/app/views/public_errors/forbidden.html

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>You don't have permission to see this content (403)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <div class="dialog">
+    <h1>You don't have permission to see this content.</h1>
+    <p>You may need to acquire permission from the administrator first.</p>
+  </div>
+</body>
+</html>

data/app/views/public_errors/internal_server_error.html

@@ -17,7 +17,6 @@
 </head>
 
 <body>
-  <!-- This file lives in public/500.html -->
   <div class="dialog">
     <h1>We're sorry, but something went wrong.</h1>
     <p>We've been notified about this issue and we'll take a look at it shortly.</p>

data/app/views/public_errors/not_found.html

@@ -17,7 +17,6 @@
 </head>
 
 <body>
-  <!-- This file lives in public/404.html -->
   <div class="dialog">
     <h1>The page you were looking for doesn't exist.</h1>
     <p>You may have mistyped the address or the page may have moved.</p>

data/app/views/public_errors/unprocessable_entity.html

@@ -17,7 +17,6 @@
 </head>
 
 <body>
-  <!-- This file lives in public/422.html -->
   <div class="dialog">
     <h1>The change you wanted was rejected.</h1>
     <p>Maybe you tried to change something you didn't have access to.</p>

data/goalie.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{goalie}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Helder Ribeiro"]
+  s.date = %q{2010-08-11}
+  s.description = %q{Middleware to catch exceptions and Rails Engine to render them. Error-handling views and controllers can be easily overriden.}
+  s.email = %q{helder@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.md",
+     "Rakefile",
+     "app/controllers/local_errors_controller.rb",
+     "app/controllers/public_errors_controller.rb",
+     "app/views/layouts/local_errors.html.erb",
+     "app/views/local_errors/_request_and_response.html.erb",
+     "app/views/local_errors/_trace.html.erb",
+     "app/views/local_errors/diagnostics.html.erb",
+     "app/views/local_errors/missing_template.html.erb",
+     "app/views/local_errors/routing_error.html.erb",
+     "app/views/local_errors/template_error.html.erb",
+     "app/views/local_errors/unknown_action.html.erb",
+     "app/views/public_errors/forbidden.html",
+     "app/views/public_errors/internal_server_error.html",
+     "app/views/public_errors/not_found.html",
+     "app/views/public_errors/unprocessable_entity.html",
+     "goalie.gemspec",
+     "lib/goalie.rb",
+     "lib/goalie/exceptions.rb",
+     "lib/goalie/rails.rb",
+     "lib/goalie/version.rb",
+     "test/custom_error_pages_test.rb",
+     "todo.org"
+  ]
+  s.homepage = %q{http://github.com/obvio171/goalie}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Custom error pages for Rails}
+  s.test_files = [
+    "test/custom_error_pages_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/goalie/exceptions.rb

@@ -0,0 +1,6 @@
+module Goalie
+
+# 403 Forbidden
+  class ForbiddenAccess < StandardError; end # :nodoc
+
+end

data/lib/goalie/version.rb

@@ -1,3 +1,3 @@
 module Goalie
-  VERSION = "0.0.0".freeze
+  VERSION = "0.0.1".freeze
 end

data/lib/goalie.rb

@@ -11,25 +11,26 @@ module Goalie
     cattr_accessor :rescue_responses
     @@rescue_responses = Hash.new(:internal_server_error)
     @@rescue_responses.update({
-                                'ActionController::RoutingError'             => :not_found,
-                                'AbstractController::ActionNotFound'         => :not_found,
-                                'ActiveRecord::RecordNotFound'               => :not_found,
-                                'ActiveRecord::StaleObjectError'             => :conflict,
-                                'ActiveRecord::RecordInvalid'                => :unprocessable_entity,
-                                'ActiveRecord::RecordNotSaved'               => :unprocessable_entity,
-                                'ActionController::MethodNotAllowed'         => :method_not_allowed,
-                                'ActionController::NotImplemented'           => :not_implemented,
-                                'ActionController::InvalidAuthenticityToken' => :unprocessable_entity
-                              })
+      'ActionController::RoutingError'             => :not_found,
+      'AbstractController::ActionNotFound'         => :not_found,
+      'ActiveRecord::RecordNotFound'               => :not_found,
+      'ActiveRecord::StaleObjectError'             => :conflict,
+      'ActiveRecord::RecordInvalid'                => :unprocessable_entity,
+      'ActiveRecord::RecordNotSaved'               => :unprocessable_entity,
+      'ActionController::MethodNotAllowed'         => :method_not_allowed,
+      'ActionController::NotImplemented'           => :not_implemented,
+      'ActionController::InvalidAuthenticityToken' => :unprocessable_entity,
+      'Goalie::Forbidden'                          => :forbidden
+    })
 
     FAILSAFE_RESPONSE = [
-                         500,
-                         {'Content-Type' => 'text/html'},
-                         ["<html><body><h1>500 Internal Server Error</h1>" <<
-                          "If you are the administrator of this website, then please read " <<
-                          "this web application's log file and/or the web server's log " <<
-                          "file to find out what went wrong.</body></html>"]
-                        ]
+       500,
+       {'Content-Type' => 'text/html'},
+       ["<html><body><h1>500 Internal Server Error</h1>" <<
+        "If you are the administrator of this website, then please read " <<
+        "this web application's log file and/or the web server's log " <<
+        "file to find out what went wrong.</body></html>"]
+    ]
 
     def initialize(app, consider_all_requests_local = false)
       @app = app
@@ -77,11 +78,11 @@ module Goalie
       # controller handle different exception classes however it wants
       rescue_actions = Hash.new('diagnostics')
       rescue_actions.update({
-                              'ActionView::MissingTemplate'         => 'missing_template',
-                              'ActionController::RoutingError'      => 'routing_error',
-                              'AbstractController::ActionNotFound'  => 'unknown_action',
-                              'ActionView::Template::Error'         => 'template_error'
-                            })
+        'ActionView::MissingTemplate'         => 'missing_template',
+        'ActionController::RoutingError'      => 'routing_error',
+        'AbstractController::ActionNotFound'  => 'unknown_action',
+        'ActionView::Template::Error'         => 'template_error'
+      })
 
       error_params = {
         :request => request, :exception => exception,

data/todo.org

@@ -1,8 +0,0 @@
-
-* Make views overridable from inside app
-* Make controllers overridable from inside app
-* Give proper credit to author of Rails' ShowExceptions
-* Give proper credit ao author of Rails' exception_notification
-* Give proper credit to Rails' default error pages that were copied
-* Turn into a gem
-* Create Railtie

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: goalie
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 0
-  - 0
-  version: 0.0.0
+  - 1
+  version: 0.0.1
 platform: ruby
 authors: 
 - Helder Ribeiro
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-09 00:00:00 -03:00
+date: 2010-08-11 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -26,10 +26,10 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.md
 files: 
 - MIT-LICENSE
-- README
+- README.md
 - Rakefile
 - app/controllers/local_errors_controller.rb
 - app/controllers/public_errors_controller.rb
@@ -41,10 +41,13 @@ files:
 - app/views/local_errors/routing_error.html.erb
 - app/views/local_errors/template_error.html.erb
 - app/views/local_errors/unknown_action.html.erb
+- app/views/public_errors/forbidden.html
 - app/views/public_errors/internal_server_error.html
 - app/views/public_errors/not_found.html
 - app/views/public_errors/unprocessable_entity.html
+- goalie.gemspec
 - lib/goalie.rb
+- lib/goalie/exceptions.rb
 - lib/goalie/rails.rb
 - lib/goalie/version.rb
 - test/custom_error_pages_test.rb