contingency-rails 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fff0c26026020274f41022104aa9f2cc9c1483e6
-  data.tar.gz: 902797c0c9a7d26dd4f4326fb1a205a546609d5d
+  metadata.gz: b2728293cf7d1fe106ad5a94e7f6875366b7bc68
+  data.tar.gz: 43f2b7ead9fda56a3b6a5e89aa3811e55b0b9984
 SHA512:
-  metadata.gz: d4ea67fc1aa3e952fdc495cd5435a3b0af7d9d22d1de5f944215d7913a4a3a6271aea06179cf271c8fc9ea03b134c4a068e33d2258b30edd61e09647aef4cc68
-  data.tar.gz: b360c673e243c5e60fddbff9ac233983aa8a3fe1439ead2ade3382c7d1e6635e5f1537058d11622ce567804f16839625f5b594946433bd2068f1476b25416036
+  metadata.gz: c6e0a2a2ae80cc9acb42f31717067e651da56fbe8c5385e63126db75eed926ca91b96680b14c994cb2e1c4b06757e32e58909ec527cbc98c37dfb597028291ee
+  data.tar.gz: 06f2dc823c1bed2cab20528c555ab86dead18dd354cb598e0ab6cd4ee7759a76c1a88eee0a09bf0c2301756fa683d600820f62f2bb87619dd9fd9eceb1c4ee68

data/README.md

@@ -1,29 +1,78 @@
-# Contingency::Rails
+<a name='contingency-rails-readme'>
+# Contingency-Rails
+</a>
 
-TODO: Write a gem description
+> "Freedom is the recognition of contingency."
 
+>   * *Richard M. Rorty*
+
+Contingency-Rails provides [Contingency](https://github.com/christhekeele/contingency) integration for [Rails](http://rubyonrails.org/).
+
+<a name='table-of-contents'>
+## Table of Contents
+</a>
+
+* [Installation](#installation)
+* [Configuration](#configuration)
+* [Extra Routes](#extra-routes)
+    * [Error Codes](#error-codes)
+    * [Catch-all Routes](#catch-alls)
+* [Contributing to Contingency-Rails](#contributing-to-contingency-rails)
+
+<a name='installation'>
 ## Installation
+</a>
 
 Add this line to your application's Gemfile:
 
-    gem 'contingency-rails'
+    gem 'contingency-rails', '~> 3.0'
 
-And then execute:
+Then, execute:
 
     $ bundle
 
-Or install it yourself as:
+Finally, add this to your `ApplicationController`:
+
+    include Contingency::Plan
+
+<a name='configuration'>
+## Configuration
+</a>
+
+Contingency-Rails uses the same configuration object as Contingency, but has different defaults. Run 'rake contingency:generate:rails:config' to get the example initializer. If you decide to skip this step, make sure you call `Contingency.configure` *somewhere* in your boot process, and that you have a view called `error` at `app/views/errors/`.
+
+<a name='extra-routes)'>
+## Extra Routes
+</a>
+
+Once you've configured your errors, you can get some additional features out of Contingency by adding a few routes to your `routes.rb`
+
+<a name='error-codes)'>
+### Error Codes
+</a>
+
+At the bottom of your routes, add this line:
+
+    match "/:code", to: 'application#error', as: :error, constraints: {code: /\d{3}/}
+
+This controller action allows you to access your custom error pages directly. This means in development mode you won't have to change `config.consider_all_requests_local` to true and intentionally raise an error in one of your controllers just to see if your two lines of CSS improved the feel of your error page.
+
+<a name='catch-alls)'>
+### Catch-all Routes
+</a>
 
-    $ gem install contingency-rails
+At the **VERY** bottom of your routes, add this line:
 
-## Usage
+    match '/*invalid_url', to: 'application#routing_error'
 
-TODO: Write usage instructions here
+This Rails-specific controller action enables Contingency to catch `ActionController::RoutingError` exceptions. Normally, invalid URLs in Rails are handled by Rack, so the Contingency Plan living in your controller can't rescue from it. Append this globbed route to the very end of your routes, and it can.
 
-## Contributing
+<a name='contributing-to-contingency-rails'>
+## Contributing to Contingency
+</a>
 
 1. Fork it
-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 new Pull Request
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create new Pull Request

data/contingency-rails.gemspec

@@ -1,16 +1,15 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'contingency/adapters/rails/version'
+require 'contingency/rails/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "contingency-rails"
   spec.version       = Contingency::Adapters::Rails::VERSION
   spec.authors       = ["Christopher Keele"]
   spec.email         = ["dev@chriskeele.com"]
-  spec.description   = "Integration with Rails for Contingency"
-  spec.summary       = "Contingency-Rails implements the simple interface defined by Contingency for easy custom Rails error pages."
-  # spec.homepage      = ""
+  spec.description   = "Contingency integration for Rails."
+  spec.summary       = "Contingency-Rails provides controller exception catching and routes to your custom error pages."
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -18,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  # spec.add_dependency "contingency", ">= 0.1.3"
+  spec.add_dependency "contingency", ">= 0.2.0"
   spec.add_dependency "rails",       "~> 3.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/lib/contingency/rails/configuration.rb

@@ -0,0 +1,62 @@
+module Contingency
+
+  module Adapters
+    module Rails
+      class Configuration < Contingency::Configuration
+
+        def initialize
+          @errors = {
+              500.to_s => [ Exception ],
+              404.to_s => [
+                ActiveRecord::RecordNotFound,
+                ActionController::UnknownController,
+                AbstractController::ActionNotFound,
+                ActionController::RoutingError,
+              ],
+            }
+
+          @error_messages = {
+              401.to_s => [
+                'Unauthorized',
+                'You should log in before you try that!'
+              ],
+              403.to_s => [
+                'Forbidden',
+                'You don\'t have permission to do that.'
+              ],
+              404.to_s => [
+                'Not Found',
+                'You may have mistyped the address or the page may have moved.'
+              ],
+              405.to_s => [
+                'Method Not Allowed',
+                'You may be trying to access our API with an invalid request method.'
+              ],
+              406.to_s => [
+                'Not Acceptable',
+                'You may be trying to access our API with invalid request headers.'
+              ],
+              500.to_s => [
+                'Internal Server Error',
+                'It looks like something went wrong. Don\'t worry, we\'re on it!'
+              ],
+              503.to_s => [
+                'Service Unavailable',
+                'We\'re down for maintainence right now.'
+              ],
+            }
+
+          @error_layout = 'application'
+          @error_template = 'errors/error'
+
+          @unknown_error_message = ['Server Error', 'It looks like something went wrong.']
+          @failure_message =  "Server Error: It looks like something went wrong."
+
+          @logger = ::Rails.logger
+        end
+
+      end
+    end
+  end
+
+end

data/lib/contingency/{adapters/rails → rails}/version.rb

@@ -1,7 +1,7 @@
 module Contingency
   module Adapters
     module Rails
-      VERSION = "3.0.1"
+      VERSION = "3.0.2"
     end
   end
 end

data/lib/contingency/rails.rb

@@ -0,0 +1,44 @@
+require 'contingency'
+
+module Contingency
+
+  module Adapters
+    module Rails
+
+      include Interface
+
+      module ClassMethods
+        def catch_errors?
+          !::Rails.application.config.action_dispatch.show_exceptions or !::Rails.application.config.consider_all_requests_local
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def error_renderer(code)
+        render Contingency.configuration.error_template,
+                status: code,
+                layout: Contingency.configuration.error_layout
+      end
+
+      def failure_renderer(code)
+        render status: code, text: Contingency.configuration.failure_message
+      end
+
+      # Custom controller action.
+      # Raises traditional Rack-level Rails RoutingError at Application-level instead,
+      # so it `rescue_from` in Contingency's error handler can catch it instead of Rack's.
+      # Works in conjunction with a catchall route pointed at this controller action.
+      def routing_error
+        raise ActionController::RoutingError, "No route matches [#{env['REQUEST_METHOD']}] #{env['PATH_INFO'].inspect}"
+      end
+
+    end
+  end
+end
+
+require 'contingency/rails/configuration'
+require 'contingency/rails/railtie'
+require "contingency/rails/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contingency-rails
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Christopher Keele
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2013-04-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: contingency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +52,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-description: Integration with Rails for Contingency
+description: Contingency integration for Rails.
 email:
 - dev@chriskeele.com
 executables: []
@@ -51,10 +65,10 @@ files:
 - README.md
 - Rakefile
 - contingency-rails.gemspec
-- lib/contingency/adapters/rails.rb
-- lib/contingency/adapters/rails/configuration.rb
-- lib/contingency/adapters/rails/railtie.rb
-- lib/contingency/adapters/rails/version.rb
+- lib/contingency/rails.rb
+- lib/contingency/rails/configuration.rb
+- lib/contingency/rails/railtie.rb
+- lib/contingency/rails/version.rb
 homepage: 
 licenses:
 - MIT
@@ -78,7 +92,7 @@ rubyforge_project:
 rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
-summary: Contingency-Rails implements the simple interface defined by Contingency
-  for easy custom Rails error pages.
+summary: Contingency-Rails provides controller exception catching and routes to your
+  custom error pages.
 test_files: []
 has_rdoc: 

data/lib/contingency/adapters/rails/configuration.rb

@@ -1,68 +0,0 @@
-module Contingency
-
-  module Adapters
-    module Rails
-      def default_configuration
-
-        config.error_layout = 'application'
-        config.error_template = 'errors/error'
-
-        ###
-        # A hash of errors mapped to status codes.
-        # `ActiveSupport::Rescuable#rescue_from` will catch these
-        # and pass them to `Contingency::ErrorHandler`.
-        # Ensure that your general case exception comes first in the list,
-        # otherwise it will catch everything. Not sure why, I think it's
-        # something about `ActiveSupport::Rescuable#rescue_from`.
-
-        config.errors = {
-          500.to_s => [ Exception ],
-          404.to_s => [
-            ActiveRecord::RecordNotFound,
-            ActionController::UnknownController,
-            AbstractController::ActionNotFound,
-            ActionController::RoutingError,
-          ],
-        }
-
-        ###
-        # A hash of error reports mapped to status codes.
-        # This should be under I18N and L10N instead of here, really.
-        # Takes an array of an error message and a description.
-        #
-        config.error_messages = {
-          401.to_s => [
-            'Unauthorized',
-            'You should log in before you try that!'
-          ],
-          403.to_s => [
-            'Forbidden',
-            'You don\'t have permission to do that.'
-          ],
-          404.to_s => [
-            'Not Found',
-            'You may have mistyped the address or the page may have moved.'
-          ],
-          405.to_s => [
-            'Method Not Allowed',
-            'You may be trying to access our API with an invalid request method.'
-          ],
-          406.to_s => [
-            'Not Acceptable',
-            'You may be trying to access our API with invalid request headers.'
-          ],
-          500.to_s => [
-            'Internal Server Error',
-            'It looks like something went wrong. Don\'t worry, we\'re on it!'
-          ],
-          503.to_s => [
-            'Service Unavailable',
-            'We\'re down for maintainence right now.'
-          ],
-        }
-
-      end
-    end
-  end
-
-end

data/lib/contingency/adapters/rails.rb

@@ -1,45 +0,0 @@
-# require 'contingency'
-      binding.pry
-
-module Contingency
-
-  module Adapters
-    module Rails
-      binding.pry
-
-      extend ActiveSupport::Concern
-      include Interface
-
-      module ClassMethods
-        def catch_errors?
-          !::Rails.application.config.action_dispatch.show_exceptions or !::Rails.application.config.consider_all_requests_local
-        end
-      end
-
-      module InstanceMethods
-        def error_renderer(code)
-          render Contingency.configuration.error_template,
-                  status: code,
-                  layout: Contingency.configuration.error_layout
-        end
-
-        def failure_renderer(code)
-          render status: code, text: Contingency.configuration.failure_message
-        end
-
-        # Custom controller action.
-        # Raises traditional Rack-level Rails RoutingError at Application-level instead,
-        # so it `rescue_from` in Contingency's error handler can catch it instead of Rack's.
-        # Works in conjunction with a catchall route pointed at this controller action.
-        def routing_error
-          raise ActionController::RoutingError, "No route matches [#{env['REQUEST_METHOD']}] #{env['PATH_INFO'].inspect}"
-        end
-      end
-
-    end
-  end
-end
-
-require 'contingency/adapters/rails/configuration'
-require 'contingency/adapters/rails/railtie'
-require "contingency/adapters/rails/version"