penny_wise 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be5cb9705fdf79a6b448285a6bcdbb9e9e7b8500
+  data.tar.gz: b80260251a8fc79ab341f3ec813975b4623755cb
+SHA512:
+  metadata.gz: 6f5a69cc0800a7c017ec00f0414ad7435ee8a8a790d38db08cfe72d1f02cbc0be23d187e330711a45bdad418de4e98455c834b8f63054c7d7b487203b1c55bc1
+  data.tar.gz: 2dcc5a1ec2e722b4205442edccd34b616988e3ae321884579d77cebf22f36a8b714bbca4dec4b6853c934ab02654daf0049679a50c052b9952e143d8525f0e20

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Christopher Keele
+
+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,29 @@
+# PennyWise
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'penny_wise'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install penny_wise
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/penny_wise.rb

@@ -0,0 +1,41 @@
+require 'active_support/inflector'
+require 'active_support/concern'
+require 'active_support/rescuable'
+require 'active_support/core_ext/object/try'
+require 'logger'
+require "penny_wise/exceptions"
+
+
+module PennyWise
+
+  class << self
+    alias :configure :initialize
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+    require "penny_wise/integration"
+    require "penny_wise/error_handler"
+    configuration
+  end
+
+  def self.root
+    Pathname.new(File.expand_path("../..", __FILE__))
+  end
+
+  # To be overriden by integrations
+  def self.render_errors?
+    true
+  end
+
+  def self.logger
+    @logger ||= configuration.logger
+  end
+
+end
+
+require "penny_wise/configuration"
+require "penny_wise/integrations/rails/railtie.rb" if defined?(Rails)
+require "penny_wise/version"

data/lib/penny_wise/configuration.rb

@@ -0,0 +1,23 @@
+module PennyWise
+  class Configuration
+
+    attr_accessor :require_integration, :errors, :error_messages, :error_layout,
+                  :error_template, :failure_message, :unknown_error_message, :logger
+
+    def initialize
+      @require_integration = true
+      @errors = {}
+      @error_messages = {}
+      @unknown_error_message = ['Unexpected Error', 'It looks like something went wrong.']
+      @error_layout = 'application'
+      @error_template = '/errors/error'
+      @failure_message =  "While handling an error, our error handler encountered an error;" \
+                          " which is why we built this second one." \
+                          "\nThis issue has been registered as critical." \
+                          "\nYou can imagine fixing it is now our top priority," \
+                          " thank you for discovering it!"
+      @logger = Logger.new(STDERR)
+    end
+
+  end
+end

data/lib/penny_wise/error_handler.rb

@@ -0,0 +1,42 @@
+module PennyWise
+
+  module ErrorHandler
+    extend ActiveSupport::Concern
+    extend ActiveSupport::Rescuable
+
+    include PennyWise::Integration
+
+    included do
+      if PennyWise.render_errors?
+        PennyWise.configuration.errors.each do |code, exceptions|
+          rescue_from *exceptions, with: ->(exception){ render_error code, exception }
+        end
+      end
+    end
+
+    def error
+      render_error(params[:code], PennyWise::Exceptions::RenderedErrorPageException.new)
+    end
+
+    def error_report(exception)
+      "#{exception.class} raised on #{request.fullpath}:" \
+      "\n#{exception.message}" \
+      "\nBacktrace:" \
+      "\n#{exception.backtrace.join("\n")}"
+    end
+
+    def render_error(code, exception)
+      message, description = PennyWise.configuration.error_messages.fetch(code, PennyWise.configuration.unknown_error_message)
+      error_logger = logger.method(code.to_i < 500 ? :info : :error)
+      error_logger.call "#{code}: #{description}.\n" + error_report(exception)
+      @code = code
+      @message = message
+      @description = description
+      error_renderer(code)
+    rescue Exception => handler_exception
+      logger.fatal error_report(PennyWise::Exceptions::ErrorHandlerException.new(exception, handler_exception))
+      failure_renderer(500)
+    end
+  end
+
+end

data/lib/penny_wise/example_initializer.rb

@@ -0,0 +1,57 @@
+PennyWise.configure do |config|
+
+    ###
+    # A hash of errors mapped to status codes.
+    # `ActiveSupport::Rescuable#rescue_from` will catch these
+    # and pass them to `PennyWise::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

data/lib/penny_wise/exceptions.rb

@@ -0,0 +1,21 @@
+module PennyWise
+  module Exceptions
+    class PennyWiseError < Exception
+      attr_accessor :message, :backtrace
+    end
+    class RenderedErrorPageException < PennyWiseError
+      def initialize
+        @message = 'An error page was explicitly requested.'
+        @backtrace = ['None. No real error occured.']
+      end
+    end
+    class ErrorHandlerException < PennyWiseError
+      def initialize(original_exception, handler_exception)
+        @message =  "`ErrorHandler` encountered exception `#{handler_exception.class.name}`" \
+                    " while trying to handle exception `#{original_exception.class.name}`:" \
+                    "\n#{handler_exception.message}"
+        @backtrace = handler_exception.backtrace
+      end
+    end
+  end
+end

data/lib/penny_wise/integration.rb

@@ -0,0 +1,36 @@
+Dir.glob( "#{PennyWise.root}/lib/penny_wise/integrations/*.rb", &method(:require) )
+module PennyWise
+
+  class << self
+    attr_accessor :integrations
+  end
+  PennyWise.integrations = %w[::Rails ::Padrino]
+
+  class IntegrationNotFoundException < PennyWise::Exceptions::PennyWiseError
+    @message = "PennyWise could not find a framework to automatically integrate with." \
+               "\nTried: #{PennyWise.integrations.join(', ')}"
+  end
+
+  module Integration
+    found = nil
+    PennyWise.integrations.each do |integration|
+      begin
+        if defined?(PennyWise.const_get integration)
+          include "PennyWise::Integration#{integration}".constantize
+          found = integration
+          break
+        end
+      rescue NameError
+      end
+    end
+    unless found
+      if PennyWise.configuration.require_integration
+        raise PennyWise::IntegrationNotFoundException
+      else
+        PennyWise.logger.warn "PennyWise did not find a framework to automatically integrate with." \
+                              "\nTried: #{PennyWise.integrations.join(', ')}." \
+                              "\nRefer to the README to learn how to use PennyWise without integration." \
+      end
+    end
+  end
+end

data/lib/penny_wise/integrations/rails.rb

@@ -0,0 +1,29 @@
+module PennyWise
+
+  def self.render_errors?
+    !Rails.application.config.action_dispatch.show_exceptions or !Rails.application.config.consider_all_requests_local
+  end
+
+  module Integration
+    module Rails
+
+      def error_renderer(code)
+        return render PennyWise.configuration.error_template,
+                      status: code,
+                      layout: PennyWise.configuration.error_layout
+      end
+
+      def failure_renderer(code)
+        render status: code, text: PennyWise.configuration.failure_message
+      end
+
+
+      def routing_error
+        # Raise traditional Rack-level Rails RoutingError at Application-level instead,
+        # so it `rescue_from` in PennyWise's error handler can catch it instead of Rack's.
+        # Works in conjunction with a catchall route pointed at this method.
+        raise ActionController::RoutingError, "No route matches [#{env['REQUEST_METHOD']}] #{env['PATH_INFO'].inspect}"
+      end
+    end
+  end
+end

data/lib/penny_wise/integrations/rails/railtie.rb

@@ -0,0 +1,12 @@
+module PennyWise
+  module Integration
+    module Rails
+      class Railtie < ::Rails::Railtie
+        initializer "penny_wise.error_handler" do
+          # Not defined at initializer runtime
+          # ApplicationController.send(:include, PennyWise::ErrorHandler) if defined?(ApplicationController)
+        end
+      end
+    end
+  end
+end

data/lib/penny_wise/version.rb

@@ -0,0 +1,3 @@
+module PennyWise
+  VERSION = "0.1.0"
+end

data/penny_wise.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'penny_wise/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "penny_wise"
+  spec.version       = PennyWise::VERSION
+  spec.authors       = ["Christopher Keele"]
+  spec.email         = ["dev@chriskeele.com"]
+  spec.description   = "Easily render customized error pages."
+  spec.summary       = "Don't let pennies on the track derail your user experience. Handle all exceptions, big or small, with your own beautiful customized error pages. Framework agnostic with several integrations, supports i18n."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport",  ">= 3.0.0"
+  spec.add_dependency "i18n",           ">= 0.6.0"
+  spec.add_dependency "rake",           ">= 0.8.0"
+
+  spec.add_development_dependency "bundler",  "~> 1.3"
+  spec.add_development_dependency "rspec",    "~> 2.13"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: penny_wise
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher Keele
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: Easily render customized error pages.
+email:
+- dev@chriskeele.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/penny_wise.rb
+- lib/penny_wise/configuration.rb
+- lib/penny_wise/error_handler.rb
+- lib/penny_wise/example_initializer.rb
+- lib/penny_wise/exceptions.rb
+- lib/penny_wise/integration.rb
+- lib/penny_wise/integrations/rails.rb
+- lib/penny_wise/integrations/rails/railtie.rb
+- lib/penny_wise/version.rb
+- penny_wise.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Don't let pennies on the track derail your user experience. Handle all exceptions,
+  big or small, with your own beautiful customized error pages. Framework agnostic
+  with several integrations, supports i18n.
+test_files: []
+has_rdoc: