rambulance 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 371368ef15c8a2428abac262161e5d591a3b1e21
+  data.tar.gz: a4b52cc04381d65a5b787a88241d0c8268376955
+SHA512:
+  metadata.gz: 85182daad34f54b4c63ecc95984dc4b94047bb47b058dd9c596d23593ec399c60b152b242b43eeb8050af2fdfc5feecf272702abade061e2857a717b20df4bc8
+  data.tar.gz: ec70b4eb6b526bc4e9ba6532a90f39fa9c9e67ca072ab50e358896166558c44966be276a51de1db345acd8657065e78da2ba936c154f04a75dbe4d5f846d2eec

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+gemfiles/*.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.log

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format=d

data/.travis.yml

@@ -0,0 +1,21 @@
+script: "bundle install && bundle exec rake spec:all"
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - ruby-head
+  - jruby
+  - rbx-2
+
+gemfile:
+  - gemfiles/rails_32.gemfile
+  - gemfiles/rails_40.gemfile
+  - gemfiles/rails_41.gemfile
+  - gemfiles/rails_edge.gemfile
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - gemfile: gemfiles/rails_edge.gemfile
+  fast_finish: true

data/Appraisals

@@ -0,0 +1,28 @@
+appraise "rails_32" do
+  gem "activesupport", "~> 3.2.0"
+  gem "actionpack", "~> 3.2.0"
+  gem "railties", "~> 3.2.0"
+end
+
+appraise "rails_40" do
+  gem "activesupport", "~> 4.0.0"
+  gem "actionpack", "~> 4.0.0"
+  gem "railties", "~> 4.0.0"
+end
+
+appraise "rails_41" do
+  gem "activesupport", "~> 4.1.0"
+  gem "actionpack", "~> 4.1.0"
+  gem "railties", "~> 4.1.0"
+end
+
+appraise "rails_edge" do
+  git 'git://github.com/rails/rails.git' do
+    gem "activesupport", require: 'active_support'
+    gem "actionpack", require: 'action_pack'
+    gem "railties"
+  end
+
+  gem 'minitest', '~> 5.3.4'
+  gem 'rspec-rails', '2.99.0.beta1'
+end

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yuki Nishijima
+
+MIT License
+
+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.md

@@ -0,0 +1,114 @@
+# Rambulance [![Build Status](https://travis-ci.org/yuki24/rambulance.svg?branch=master)](https://travis-ci.org/yuki24/rambulance)
+
+Rambulance provides a simple and safe way to dynamically render error pages for Rails apps.
+
+## Features
+
+### Simple and Safe
+
+Rambulance's exceptions app is simple, skinny and well-tested. It  inherits `ActionController::Base`, so it works fine even if your `ApplicationController` has an issue.
+
+### Flexible
+
+You have full control of what error page to display for a specific exception. It can also render json responses. It even provides a way to create a custom exceptions app.
+
+### Easy installation and development
+
+You don't have to configure things that every single person has to do and Rambulance does everything for you.
+
+## Installation and Usage
+
+Add this line to your application's Gemfile:
+
+```
+gem 'rambulance'
+```
+
+And then execute:
+
+```
+$ rails g rambulance:install
+```
+
+Now you can start editing templates like `app/views/errors/not_found.html.erb`. Edit, run `rails server` and open [`localhost:3000/rambulance/not_found`](http://localhost:3000/rambulance/404)!
+
+## Setting Pairs of Exceptions and HTTP Statuses
+
+Open `config/initializers/rambulance.rb` and to configure the list of pairs of exception/corresponding http status.
+For example, if you want to display:
+
+ * 422(unprocessable entity) for `ActiveRecord::RecordNotUnique`
+ * 403(forbidden) for `CanCan::AccessDenied`
+ * 404(not found) for `YourCustomException`
+
+Then do the following:
+
+```ruby
+# config/initializers/rambulance.rb
+config.rescue_responses = {
+  "ActiveRecord::RecordNotUnique" => :unprocessable_entity,
+  "CanCan::AccessDenied"          => :forbidden,
+  "YourCustomException"           => :not_found
+}
+```
+
+## Local Development
+
+There are 2 ways of editing the templates.
+
+<!---
+### Open [`localhost:3000/rambulance`](http://localhost:3000/rambulance) in Your Browser
+
+This page tells all the error pages as well as all the pairs of exceptions/corresponding http status. This is useful when you want to edit templates without changing Rails configuration. Click on one of the links in the page to see what the error page looks like.
+
+**This feature hasn't been implemented yet.**
+-->
+
+### Open `localhost:3000/rambulance/***` in Your Browser
+
+Just go to one of the error pages via Rambulance:
+ * [`localhost:3000/rambulance/not_found`](http://localhost:3000/rambulance/404) or
+ * [`localhost:3000/rambulance/internal_server_error`](http://localhost:3000/rambulance/500)
+
+This is useful when you want to edit templates without changing Rails configuration.
+
+### Set `consider_all_requests_local` to _false_
+
+Change `config.consider_all_requests_local` to _false_ in `config/environments/development.rb`.
+
+```
+config.consider_all_requests_local = false
+```
+
+This simulates how your production app displays error pages so you can actually raise an exception in your app and see how it works. Don't forget to change `consider_all_requests_local` back to _true_ after you tried this strategy.
+
+## Custom Exceptions App
+
+If you want to do some more things in a exceptions app, you can also write your own custom exceptions app:
+
+```
+$ rails g rambulance:exceptions_app
+```
+
+It'll generate your own custom exceptions app. You can use whatever techniques you use in controllers like `before_filter` and `flash[:notice] = "message..."` since it's a grandchild of `ActionController::Base`!
+
+**Keep in mind that you shouldn't do too many things because something already went wrong with your application!**
+
+## Supported Versions
+
+* Ruby 1.9.3, 2.0.0, 2.1.2, JRuby 1.7.11, Rubinius 2.2.6
+* Rails 3.2, 4.0, 4.1
+
+Rambulance doesn't work with Rails 3.1 and below since they don't provide any way to use a custom exceptions app.
+
+## Contributing
+
+1. Fork it ( https://github.com/yuki24/rambulance/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
+
+## License
+
+Copyright (c) 2014 Yuki Nishijima. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+require "rspec/core"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: "spec:all"
+
+namespace :spec do
+  desc "Run Tests with the default exceptions app"
+  task :default do
+    sh "bundle exec rake -t spec"
+  end
+
+  desc "Run Tests with a custom exceptions app"
+  task :custom do
+    sh "bundle exec rake -t spec CUSTOM_EXCEPTIONS_APP=1"
+  end
+
+  desc "Run tests with both of the default and custom apps"
+  task(:all).enhance(%w(default custom))
+end

data/gemfiles/rails_32.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 3.2.0"
+gem "actionpack", "~> 3.2.0"
+gem "railties", "~> 3.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails_40.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 4.0.0"
+gem "actionpack", "~> 4.0.0"
+gem "railties", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_41.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 4.1.0"
+gem "actionpack", "~> 4.1.0"
+gem "railties", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_edge.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+git "git://github.com/rails/rails.git" do
+  gem "activesupport", :require => "active_support"
+  gem "actionpack", :require => "action_pack"
+  gem "railties"
+end
+
+gem "minitest", "~> 5.3.4"
+gem "rspec-rails", "2.99.0.beta1"
+
+gemspec :path => "../"

data/lib/generators/rambulance/exceptions_app_generator.rb

@@ -0,0 +1,20 @@
+module Rambulance
+  module Generators
+    class ExceptionsAppGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def self.banner #:nodoc:
+        <<-BANNER.chomp
+rails g rambulance:exceptions_app
+
+    Creates a custom exceptions app.
+BANNER
+      end
+
+      desc ''
+      def copy_exceptions_app #:nodoc:
+        copy_file "exceptions_app.rb", "app/handlers/exceptions_app.rb"
+      end
+    end
+  end
+end

data/lib/generators/rambulance/install_generator.rb

@@ -0,0 +1,47 @@
+module Rambulance
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      class_option :template_engine, type: :string, aliases: '-e', desc: 'Template engine for the views. Available options are "erb" and "haml".'
+
+      def self.banner #:nodoc:
+        <<-BANNER.chomp
+rails g rambulance:install
+
+    Copies all error partial templates and an initializer to your application.
+BANNER
+      end
+
+      desc ''
+      def copy_templates #:nodoc:
+        say "generating templates:"
+        filename_pattern = File.join(self.class.source_root, "views", "*.html.#{template_engine}")
+        Dir.glob(filename_pattern).map {|f| File.basename f }.each do |f|
+          copy_file "views/#{f}", "app/views/errors/#{f}"
+        end
+
+        filename_pattern = File.join(self.class.source_root, "views", "*.json.jbuilder")
+        Dir.glob(filename_pattern).map {|f| File.basename f }.each do |f|
+          copy_file "views/#{f}", "app/views/errors/#{f}"
+        end
+      end
+
+      def copy_layout #:nodoc:
+        say "\ncopying app/views/layouts/application.html.#{template_engine} to app/views/layouts/error.html.#{template_engine}:"
+        copy_file Rails.root.join("app/views/layouts/application.html.#{template_engine}"), "app/views/layouts/error.html.#{template_engine}"
+      end
+
+      def copy_initializer #:nodoc:
+        say "\ngenerating initializer:"
+        copy_file "rambulance.rb", "config/initializers/rambulance.rb"
+      end
+
+      private
+
+      def template_engine
+        options[:template_engine].try(:to_s).try(:downcase) || 'erb'
+      end
+    end
+  end
+end

data/lib/generators/rambulance/templates/exceptions_app.rb

@@ -0,0 +1,13 @@
+class ExceptionsApp < Rambulance::ExceptionsApp
+  def bad_request
+  end
+
+  def forbidden
+  end
+
+  def not_found
+  end
+
+  def internal_server_error
+  end
+end

data/lib/generators/rambulance/templates/rambulance.rb

@@ -0,0 +1,43 @@
+Rambulance.setup do |config|
+
+  # List of pairs of exception/corresponding http status. In Rails, the default
+  # mappings are below:
+  #
+  #   "ActionController::RoutingError"             => :not_found,
+  #   "AbstractController::ActionNotFound"         => :not_found,
+  #   "ActionController::MethodNotAllowed"         => :method_not_allowed,
+  #   "ActionController::UnknownHttpMethod"        => :method_not_allowed,
+  #   "ActionController::NotImplemented"           => :not_implemented,
+  #   "ActionController::UnknownFormat"            => :not_acceptable,
+  #   "ActionController::InvalidAuthenticityToken" => :unprocessable_entity,
+  #   "ActionDispatch::ParamsParser::ParseError"   => :bad_request,
+  #   "ActionController::BadRequest"               => :bad_request,
+  #   "ActionController::ParameterMissing"         => :bad_request,
+  #   "ActiveRecord::RecordNotFound"               => :not_found,
+  #   "ActiveRecord::StaleObjectError"             => :conflict,
+  #   "ActiveRecord::RecordInvalid"                => :unprocessable_entity,
+  #   "ActiveRecord::RecordNotSaved"               => :unprocessable_entity
+  #
+  # If you add exceptions in this config, Rambulance uses the pairs you defined
+  # here *in addition* to the default maddings. You can also override the default
+  # mappings although you don't have to in most cases.
+  # If Rambulance receives an exception that is not listed here, it'll render
+  # the internal server error template and return 500 as http status.
+  config.rescue_responses = {
+    # "ActiveRecord::RecordNotUnique" => :unprocessable_entity,
+    # "CanCan::AccessDenied"          => :forbidden,
+    # "Pundit::NotAuthorizedError"    => :forbidden,
+    # "YourCustomException"           => :not_found
+  }
+
+  # The template name for the layout of the error pages. The default value is
+  # 'error'. For exmaple, if this value is set to "error_page", Rambulance uses
+  # 'app/views/layout/error_page.html.erb' as a layout for all the error pages.
+  config.layout_name = "error"
+
+  # The directry name to organize error page templates. The default value is
+  # 'errors'. For exmaple, if this value is set to "error_pages", Rambulance
+  # uses e.g. 'app/views/error_pages/not_found.html.erb'.
+  config.view_path = "errors"
+
+end

data/lib/generators/rambulance/templates/views/bad_request.html.erb

@@ -0,0 +1,58 @@
+<style>
+  div.dialog {
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto;
+  }
+
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+    margin: 10px 0;
+  }
+
+  div.dialog p {
+    margin: 16px 0;
+  }
+
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+</style>
+
+<!-- This file lives in app/views/errors/bad_request.html.erb -->
+<div class="dialog">
+  <div>
+    <h1>Bad request</h1>
+  </div>
+  <p>The service received a incomplete request.</p>
+</div>