public_rescue 0.2.3

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "rails", "~> 3.0.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,82 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.7)
+      actionpack (= 3.0.7)
+      mail (~> 2.2.15)
+    actionpack (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+    activesupport (3.0.7)
+    arel (2.0.9)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.7)
+      actionmailer (= 3.0.7)
+      actionpack (= 3.0.7)
+      activerecord (= 3.0.7)
+      activeresource (= 3.0.7)
+      activesupport (= 3.0.7)
+      bundler (~> 1.0)
+      railties (= 3.0.7)
+    railties (3.0.7)
+      actionpack (= 3.0.7)
+      activesupport (= 3.0.7)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.27)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rails (~> 3.0.0)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Cyril Picard
+
+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/README.rdoc

@@ -0,0 +1,59 @@
+= PublicRescue
+
+PublicRescue is a gem for rails application who want to display dynamic error pages.
+It creates a new Rack middleware which replaces <tt>ActionDispatch::ShowExceptions</tt> and overwrites the rescue_action_in_public method. 
+
+== Requirements
+
+* Rails ~> 3.0.0
+
+== Installation
+
+This library is intended to be installed as a gem
+	
+	$ gem install public_rescue
+
+After you installed PublicRescue, you need to add it to your Gemfile and you're done ! It will use the default views included with PublicRescue.
+
+== Customization
+
+PublicRescue comes with 2 generators.
+
+	$ rails g public_rescue:views
+	
+This will install all views into app/view/public_rescue/public_errors. You can now customize your views.
+
+If you need to have access to the controller, you can run :
+
+	$ rails g public_rescue NAME
+	
+This will generate a controller that inherits from PublicRescue::PublicErrorsController and install the views into app/views/NAME. In the controller you have access to the <tt>env['public_rescue.exception_details']</tt> variable which contains additional information about the exception :
+
+	env['public_rescue.exception_details'] =	{
+		:request,
+  	:exception,
+  	:status,
+  	:application_trace,
+  	:framework_trace,
+  	:full_trace
+	}
+
+== TODO
+
+I should probably write some true tests...
+
+== Contributing to public_rescue
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Cyril Picard. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "public_rescue"
+  gem.homepage = "http://github.com/cyrilpic/public_rescue"
+  gem.license = "MIT"
+  gem.summary = %Q{Rails3 gem for displaying dynamic error pages.}
+  gem.description = %Q{PublicRescue is a gem for rails application who want to display dynamic error pages. It creates a new Rack middleware which replaces ActionDispatch::ShowExceptions and overwrites the rescue_action_in_public method.}
+  gem.email = "Cyril@picard.ch"
+  gem.authors = ["Cyril Picard"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "errorlogic #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.3

data/app/controllers/public_rescue/public_errors_controller.rb

@@ -0,0 +1,38 @@
+class PublicRescue::PublicErrorsController < ApplicationController
+  # This is just a very basic controller
+  # For custom methods just create our own PublicErrorsController which subclasses this one
+  
+  # env['errorlogic.exception_details'] variable contains additional information on the exception
+  # {
+  #  :request,
+  #  :exception,
+  #  :status,
+  #  :application_trace,
+  #  :framework_trace,
+  #  :full_trace
+  # }
+  
+  # 404
+  def not_found
+  end
+  
+  # 500
+  def internal_server_error
+  end
+  
+  def conflict
+    render :action => :internal_server_error
+  end
+  
+  def not_implemented
+    render :action => :internal_server_error
+  end
+  
+  def method_not_allowed
+    render :action => :internal_server_error
+  end
+  
+  # 422
+  def unprocessable_entity
+  end
+end

data/app/views/public_rescue/public_errors/internal_server_error.html.erb

@@ -0,0 +1,4 @@
+<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>
+</div>

data/app/views/public_rescue/public_errors/not_found.html.erb

@@ -0,0 +1,4 @@
+<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>
+</div>

data/app/views/public_rescue/public_errors/unprocessable_entity.html.erb

@@ -0,0 +1,4 @@
+<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>
+</div>

data/lib/generators/public_rescue/public_rescue_generator.rb

@@ -0,0 +1,17 @@
+module PublicRescue
+  module Generators
+    class PublicRescueGenerator < Rails::Generators::Base
+      namespace 'public_rescue'
+      source_root File.expand_path("../../../../", __FILE__)
+      
+      desc "Creates a controller that inherits from PublicRescue::PublicErrorsController."
+
+      def create_controller_files
+        template 'lib/generators/template/controller.rb', File.join('app/controllers', class_path, "#{file_name}_controller.rb")
+        directory "app/views/public_rescue/public_errors", File.join('app/views', class_path, "#{file_name}")
+      end
+      
+      hook_for :test_framework, :as => :controller
+    end
+  end
+end

data/lib/generators/public_rescue/views_generator.rb

@@ -0,0 +1,14 @@
+module PublicRescue
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../app/views", __FILE__)
+      desc "Copies all PublicRescue views to your application."
+
+      argument :scope, :required => false, :default => nil,
+                       :desc => "The scope to copy views to"
+      def copy_views
+        directory "public_rescue", "app/views/#{scope || :public_rescue}"
+      end
+    end
+  end
+end

data/lib/generators/template/controller.rb

@@ -0,0 +1,25 @@
+class <%= class_name %>Controller < PublicRescue::PublicErrorsController
+  # 404
+  def not_found
+  end
+
+  # 500
+  def internal_server_error
+  end
+
+  def conflict
+    render :action => :internal_server_error
+  end
+
+  def not_implemented
+    render :action => :internal_server_error
+  end
+
+  def method_not_allowed
+    render :action => :internal_server_error
+  end
+
+  # 422
+  def unprocessable_entity
+  end
+end

data/lib/public_rescue/rails.rb

@@ -0,0 +1,15 @@
+require 'public_rescue'
+
+module PublicRescue
+    class Engine < Rails::Engine
+      
+        config.public_rescue = ActiveSupport::OrderedOptions.new
+        config.public_rescue.controller = :public_errors
+        
+        initializer "devise.add_middleware" do |app|
+            app.middleware.swap ActionDispatch::ShowExceptions, Errorlogic::ShowExceptions
+        end
+        
+        
+    end
+end

data/lib/public_rescue/show_exceptions.rb

@@ -0,0 +1,40 @@
+module PublicRescue
+  # We subclass this middleware to render nice dynamic error pages instead of classical 404.html,... files
+  class ShowExceptions < ActionDispatch::ShowExceptions
+    private
+    # By default render_exception doesn't send the request object to rescue_action_in_public.
+    # Here we just store the env variable in a class variable so we can retrieve it later.
+    def render_exception(env, exception)
+      @env = env
+      # Original rails code is always best
+      super
+    end
+    
+    def rescue_action_in_public(exception)
+      request = ActionDispatch::Request.new(@env)
+      status = status_code(exception)
+      exception_details = {
+              :request => request, :exception => exception,
+              :status => status,
+              :application_trace => application_trace(exception),
+              :framework_trace => framework_trace(exception),
+              :full_trace => full_trace(exception)
+      }
+      request.env['public_rescue.exception_details'] = exception_details
+      action = @@rescue_responses[exception.class.name]
+      controller_name = Rails.configuration.public_rescue.controller.to_s.camelize << 'Controller'
+      begin
+        controller = Rails.const_get(controller_name)
+      rescue NameError => n_E
+        controller = PublicErrorsController
+      end
+      response = controller.action(action).call(request.env).last
+      render(status, response.body)
+        
+    # Any exceptions results in calling the parent method
+    rescue Exception => e
+      log_error(e)
+      super(exception)
+    end
+  end
+end

data/lib/public_rescue.rb

@@ -0,0 +1,12 @@
+#PublicRecscue.rb
+require 'rails'
+require 'active_support/dependencies/autoload'
+require 'action_dispatch'
+
+module PublicRescue
+  extend ActiveSupport::Autoload
+  autoload :ShowExceptions
+  autoload :PublicErrorsController
+end
+
+require 'public_rescue/rails'

data/public_rescue.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{public_rescue}
+  s.version = "0.2.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Cyril Picard"]
+  s.date = %q{2011-05-04}
+  s.description = %q{PublicRescue is a gem for rails application who want to display dynamic error pages. It creates a new Rack middleware which replaces ActionDispatch::ShowExceptions and overwrites the rescue_action_in_public method.}
+  s.email = %q{Cyril@picard.ch}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "app/controllers/public_rescue/public_errors_controller.rb",
+    "app/views/public_rescue/public_errors/internal_server_error.html.erb",
+    "app/views/public_rescue/public_errors/not_found.html.erb",
+    "app/views/public_rescue/public_errors/unprocessable_entity.html.erb",
+    "lib/generators/public_rescue/public_rescue_generator.rb",
+    "lib/generators/public_rescue/views_generator.rb",
+    "lib/generators/template/controller.rb",
+    "lib/public_rescue.rb",
+    "lib/public_rescue/rails.rb",
+    "lib/public_rescue/show_exceptions.rb",
+    "public_rescue.gemspec",
+    "test/helper.rb",
+    "test/test_public_rescue.rb"
+  ]
+  s.homepage = %q{http://github.com/cyrilpic/public_rescue}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.7.2}
+  s.summary = %q{Rails3 gem for displaying dynamic error pages.}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_public_rescue.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, ["~> 3.0.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, ["~> 3.0.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["~> 3.0.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'public_rescue'
+
+class Test::Unit::TestCase
+end

data/test/test_public_rescue.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestPublicRescue < Test::Unit::TestCase
+  should 'create some test' do
+    assert(true)
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification 
+name: public_rescue
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 3
+  version: 0.2.3
+platform: ruby
+authors: 
+- Cyril Picard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: PublicRescue is a gem for rails application who want to display dynamic error pages. It creates a new Rack middleware which replaces ActionDispatch::ShowExceptions and overwrites the rescue_action_in_public method.
+email: Cyril@picard.ch
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- app/controllers/public_rescue/public_errors_controller.rb
+- app/views/public_rescue/public_errors/internal_server_error.html.erb
+- app/views/public_rescue/public_errors/not_found.html.erb
+- app/views/public_rescue/public_errors/unprocessable_entity.html.erb
+- lib/generators/public_rescue/public_rescue_generator.rb
+- lib/generators/public_rescue/views_generator.rb
+- lib/generators/template/controller.rb
+- lib/public_rescue.rb
+- lib/public_rescue/rails.rb
+- lib/public_rescue/show_exceptions.rb
+- public_rescue.gemspec
+- test/helper.rb
+- test/test_public_rescue.rb
+homepage: http://github.com/cyrilpic/public_rescue
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Rails3 gem for displaying dynamic error pages.
+test_files: 
+- test/helper.rb
+- test/test_public_rescue.rb