rescue-dog 0.1.0 → 0.2.0

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.coveralls.yml
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+bundler_args: --without development
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+branches:
+  only:
+    - master
+after_success:
+  - cover -report coveralls
+notifications:
+  recipients:
+    - yuliinfo@gmail.com
+

data/Gemfile

@@ -1,2 +1,8 @@
 source 'https://rubygems.org'
 gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'capybara'
+  gem 'coveralls', :require => false
+end

data/README.md

@@ -1,4 +1,7 @@
 # Rescue Dog
+[![Gem Version](https://badge.fury.io/rb/rescue-dog.png)](http://badge.fury.io/rb/rescue-dog)
+[![Coverage Status](https://coveralls.io/repos/yulii/rescue-dog/badge.png?branch=master)](https://coveralls.io/r/yulii/rescue-dog)
+[![Build Status](https://travis-ci.org/yulii/rescue-dog.png)](https://travis-ci.org/yulii/rescue-dog)
 
 The Rescue-Dog responds HTTP status (the code and message) when raise the exception.
 
@@ -6,15 +9,21 @@ The Rescue-Dog responds HTTP status (the code and message) when raise the except
 
 Add this line to your application's Gemfile:
 
-    gem 'rescue-dog'
+```ruby
+gem 'rescue-dog'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install rescue-dog
+```bash
+$ gem install rescue-dog
+```
 
 ## Usage
 
@@ -25,35 +34,51 @@ Or install it yourself as:
 ### Render Static Files
 Render /public/400(.:format) if you raise BadRequest exception.
 
-    $ vim app/controllers/application_controller.rb
-    class ApplicationController
+```bash
+$ vim app/controllers/application_controller.rb
+```
+
+```ruby
+class ApplicationController
    
-      include Rescue::Controller::Static
-      rescue_associate :BadRequest   ,with: 400
-      rescue_associate :Unauthorized ,with: 401
-      rescue_associate :NotFound     ,with: 404
-      rescue_associate :ServerError  ,with: 500
+  include Rescue::Controller::Static
+  rescue_associate :BadRequest   ,with: 400
+  rescue_associate :Unauthorized ,with: 401
+  rescue_associate :NotFound     ,with: 404
+  rescue_associate :ServerError  ,with: 500
+```
 
 ### Render Template
 Render app/views/errors/404(.:format) if you raise NotFound exception.
 
-    $ vim app/controllers/application_controller.rb
-    class ApplicationController
+```bash
+$ vim app/controllers/application_controller.rb
+```
+
+```ruby
+class ApplicationController
    
-      include Rescue::Controller::Dynamic
-      rescue_associate :BadRequest   ,with: 400
-      rescue_associate :Unauthorized ,with: 401
-      rescue_associate :NotFound     ,with: 404
-      rescue_associate :ServerError  ,with: 500
+  include Rescue::Controller::Dynamic
+  rescue_associate :BadRequest   ,with: 400
+  rescue_associate :Unauthorized ,with: 401
+  rescue_associate :NotFound     ,with: 404
+  rescue_associate :ServerError  ,with: 500
+```
 
 ### Associated with the exceptions 
 Call the response method when raise an exception.
 
 #### for ActiveRecord
-    rescue_associate ActiveRecord::RecordNotFound ,with: 404
+
+```ruby
+rescue_associate ActiveRecord::RecordNotFound ,with: 404
+```
+
 #### for Mongoid
-    rescue_associate Mongoid::Errors::DocumentNotFound, BSON::InvalidObjectId, with: 404
 
+```ruby
+rescue_associate Mongoid::Errors::DocumentNotFound, BSON::InvalidObjectId, with: 404
+```
 
 ## Contributing
 
@@ -67,11 +92,4 @@ Call the response method when raise an exception.
 ## LICENSE
 (The MIT License)
 
-Copyright © 2013 yulii
-
-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.
-
+Copyright © 2013 yulii. See LICENSE.txt for further details.

data/Rakefile

@@ -1 +1,4 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/deploy_gem.sh

@@ -8,8 +8,11 @@ fi
 GEMSPEC="${LIB_NAME}.gemspec"
 PKG_FILE="${LIB_NAME}-$1.gem"
 
-echo "[RUN] rspec"
-rspec
+echo "[RUN] gem install"
+bundle install
+echo "[RUN] rake"
+bundle exec rake
+
 if [ $? -eq 1 ]
 then
 	exit 1

data/lib/rescue/config.rb

@@ -0,0 +1,32 @@
+require 'active_support/configurable'
+
+module Rescue
+
+  def self.configure(&block)
+    yield @config ||= Rescue::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  class Configuration #:nodoc:
+    include ActiveSupport::Configurable
+    config_accessor :respond_name
+    config_accessor :suppress_response_codes
+
+    def param_name
+      config.param_name.respond_to?(:call) ? config.param_name.call : config.param_name
+    end
+
+    # define param_name writer (copied from AS::Configurable)
+    writer, line = 'def param_name=(value); config.param_name = value; end', __LINE__
+    singleton_class.class_eval writer, __FILE__, line
+    class_eval writer, __FILE__, line
+  end
+
+  configure do |config|
+    config.respond_name            = :respond_status
+    config.suppress_response_codes = false
+  end
+end

data/lib/rescue/controller.rb

@@ -1,6 +1,4 @@
 # coding: UTF-8
-require File.join(File.dirname(__FILE__), "controller/static.rb")
-require File.join(File.dirname(__FILE__), "controller/dynamic.rb")
 
 module Rescue
   module Controller
@@ -13,7 +11,7 @@ module Rescue
         unless block_given?
           if options.has_key?(:with)
             if options[:with].is_a?(Integer)
-              block = lambda {|e| send(Rescue::Bind.respond_name, options[:with], e) }
+              block = lambda {|e| send(Rescue.config.respond_name, options[:with], e) }
             elsif options[:with].is_a?(Proc)
               block = options[:with]
             end
@@ -26,7 +24,11 @@ module Rescue
           key = if klass.is_a?(Class) && klass <= Exception
             klass.name
           elsif klass.is_a?(String) || klass.is_a?(Symbol)
-            Rescue::Bind.define_error_class klass, StandardError
+            if options.has_key?(:superclass)
+              Rescue::Bind.define_error_class klass, options[:superclass]
+            else
+              Rescue::Bind.define_error_class klass, StandardError
+            end
             klass
           else
             raise ArgumentError, "#{klass} is neither an Exception nor a String"

data/lib/rescue/{controller → controllers}/dynamic.rb

@@ -6,11 +6,15 @@ module Rescue
 
       def self.included(base)
         base.class_eval do
-          define_method Rescue::Bind.respond_name do |code, exception = nil|
+          define_method Rescue.config.respond_name do |code, exception = nil|
             e = {}
-            e[:code]    = code
-            e[:status]  = Rack::Utils::HTTP_STATUS_CODES[code]
-            e[:message] = exception.message if exception
+            if e.is_a? Rescue::ApplicationError
+              e = { code: e.code, status: e.status, message: e.message }
+            else
+              e[:code]    = code
+              e[:status]  = Rack::Utils::HTTP_STATUS_CODES[code]
+              e[:message] = exception.message if exception
+            end
   
             respond_to do |format|
               format.html { render status: code, template: "/errors/#{code}" }

data/lib/rescue/{controller → controllers}/static.rb

@@ -6,7 +6,7 @@ module Rescue
 
       def self.included(base)
         base.class_eval do
-          define_method Rescue::Bind.respond_name do |code, exception = nil|
+          define_method Rescue.config.respond_name do |code, exception = nil|
             render status: code, file: "#{Rails.root}/public/#{code}", layout: false and return
           end
         end

data/lib/rescue/exceptions/application_error.rb

@@ -0,0 +1,27 @@
+module Rescue
+  class ApplicationError < StandardError
+
+    STATUS_CODES = {
+      40  => { http: 400, status: 'Invalid Request'     },
+      49  => { http: 400, status: 'Unsupported'         },
+      81  => { http: 401, status: 'Access Denied'       },
+      83  => { http: 401, status: 'Expired Token'       },
+      98  => { http: 403, status: 'Not Permitted'       },
+      99  => { http: 403, status: 'Suspended Account'   },
+      121 => { http: 410, status: 'Deleted Resources'   },
+      140 => { http: 429, status: 'Rate Limit Exceeded' },
+      210 => { http: 500, status: 'Internal Error'      },
+      230 => { http: 503, status: 'Over Capacity'       },
+    }
+
+    attr_accessor :code
+    attr_accessor :stauts
+
+    def initialize code, status, message = nil
+      @code    = code
+      @status  = (message ? status : STATUS_CODES[code][:status])
+      @message = message
+    end
+
+  end
+end

data/lib/rescue/exceptions/respond_error.rb

@@ -0,0 +1,21 @@
+module Rescue
+  module RespondError
+
+    def self.included(base)
+      Rescue::ApplicationError::STATUS_CODES.each do |code, e|
+        status_code = (Rescue.config.suppress_response_codes ? 200 : e[:http])
+        class_name = e[:status].gsub(' ', '')
+        next if Object.const_defined?(class_name)
+
+        exception_class = Class.new(Rescue::ApplicationError) do
+          define_method :initialize do |message = nil|
+            super code, e[:status], message
+          end
+        end
+        Object.const_set class_name, exception_class
+        base.rescue_associate class_name, with: status_code
+      end
+    end
+
+  end
+end

data/lib/rescue/version.rb

@@ -1,3 +1,3 @@
 module Rescue
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/rescue-dog.rb

@@ -1,15 +1,14 @@
-require "rescue/version"
+require 'rescue/config.rb'
+require 'rescue/controller.rb'
+require "rescue/controllers/static.rb"
+require "rescue/controllers/dynamic.rb"
+require 'rescue/exceptions/application_error.rb'
+require 'rescue/exceptions/respond_error.rb'
 
-require File.join(File.dirname(__FILE__),'rescue/controller.rb')
 module Rescue
-
   class Bind
     class << self
 
-      def respond_name
-        :respond_status
-      end
-
       def define_error_class class_name, superclass = nil
         return if Object.const_defined?(class_name)
         Object.const_set(class_name, Class.new(superclass||StandardError))

data/spec/rails_spec_app.rb

@@ -9,7 +9,24 @@ STATUSES = {
   :server_error => 500,
 }
 
+# dummy module
+module ActiveRecord
+  class RecordNotFound < StandardError ; end
+end
+module Mongoid
+  module Errors
+    class DocumentNotFound < StandardError ; end
+  end
+end
+module BSON
+  class InvalidObjectId < RuntimeError ; end
+end
+
 # config
+Rescue.configure do |config|
+  config.suppress_response_codes = true
+end
+
 app = Class.new Rails::Application
 app.config.active_support.deprecation = :log
 app.config.secret_token = 'ccedfce890492dd9fe2908a69a8732104ae133f1e2488bf6a1e96685b05a96d7e11aeaa3da5ade27604a50c3b2c7cc8323dd03ad11bb2e52e95256fb67ef9c8a'
@@ -24,6 +41,10 @@ app.routes.draw do
     get "/static/#{name}"  =>"static##{name}"  ,as: name
     get "/dynamic/#{name}" =>"dynamic##{name}" ,as: name
   end
+
+  Rescue::ApplicationError::STATUS_CODES.each do |code, e|
+    get "/status/#{code}" =>"status#error_#{code}" ,as: "status_#{code}"
+  end
 end
 
 # controllers
@@ -33,7 +54,7 @@ class StaticController < ApplicationController
   include Rescue::Controller::Static
   rescue_associate :BadRequest   ,with: 400
   rescue_associate :Unauthorized ,with: 401
-  rescue_associate :NotFound     ,with: 404
+  rescue_associate :NotFound, Mongoid::Errors::DocumentNotFound, BSON::InvalidObjectId, with: 404
   rescue_associate :ServerError  ,with: 500
 
   STATUSES.each do |name, code|
@@ -48,7 +69,7 @@ class DynamicController < ApplicationController
   include Rescue::Controller::Dynamic
   rescue_associate :BadRequest   ,with: 400
   rescue_associate :Unauthorized ,with: 401
-  rescue_associate :NotFound     ,with: 404
+  rescue_associate :NotFound, ActiveRecord::RecordNotFound, with: 404
   rescue_associate :ServerError  ,with: 500
 
   STATUSES.each do |name, code|
@@ -59,4 +80,15 @@ class DynamicController < ApplicationController
   end
 end
 
+class StatusController < ApplicationController
+  include Rescue::Controller::Dynamic
+  include Rescue::RespondError
+
+  Rescue::ApplicationError::STATUS_CODES.each do |code, e|
+    define_method "error_#{code}" do
+      raise e[:status].gsub(' ', '').constantize.new "This is an explanation of what caused the error."
+    end
+  end
+end
+
 Object.const_set(:ApplicationHelper,Module.new)

data/spec/rescue/controller_spec.rb

@@ -3,12 +3,17 @@ require 'spec_helper'
 
 describe Rescue::Controller do
 
-  let(:dynamic) do
-    clazz = Class.new ApplicatoinController do
-      include Rescue::Controller
-      define_errors :dynamic, BadRequest: 400, Unauthorized: 401, NotFound: 404, ServerError: 500
+  let(:object) do
+    clazz = Class.new ApplicationController do
+      include Rescue::Controller::ClassMethods
     end
     clazz.new
   end
 
+  describe "include ClassMethods module" do
+    it "expects to be call `rescue_associate` method" do
+      expect(object.methods.include? :rescue_associate).to be_true
+    end
+  end
+
 end

data/spec/rescue/{controller → controllers}/dynamic_spec.rb

@@ -6,9 +6,8 @@ describe Rescue::Controller::Dynamic do
   let(:object) { DynamicController.new }
 
   describe "respond method" do
-    subject { object.methods.include?(:respond_status) }
-    it "should be called in a subclass of ApplicationController" do
-      should be_true
+    it "expects to be called in a subclass of ApplicationController" do
+      expect(object.methods.include? Rescue.config.respond_name).to be_true
     end
   end
 
@@ -21,10 +20,9 @@ describe Rescue::Controller::Dynamic do
             visit "/dynamic/#{name.to_s.underscore}.#{format.to_sym}"
           end
 
-          subject { page }
-          it { should have_content name.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1 \2').gsub(/([a-z\d])([A-Z])/,'\1 \2') }
-          it { should have_content "This is an explanation of what caused the error." } unless format.to_sym == :html
-          it { response_headers["Content-Type"].should include(format.to_s) }
+          it { expect(page).to have_content name.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1 \2').gsub(/([a-z\d])([A-Z])/,'\1 \2') }
+          it { expect(page).to have_content "This is an explanation of what caused the error." } unless format.to_sym == :html
+          it { expect(response_headers["Content-Type"]).to include(format.to_s) }
         end
       end
     end

data/spec/rescue/{controller → controllers}/static_spec.rb

@@ -6,9 +6,8 @@ describe Rescue::Controller::Static do
   let(:object) { StaticController.new }
 
   describe "respond method" do
-    subject { object.methods.include?(:respond_status) }
-    it "should be called in a subclass of ApplicationController" do
-      should be_true
+    it "expects to be called in a subclass of ApplicationController" do
+      expect(object.methods.include? Rescue.config.respond_name).to be_true
     end
   end
 
@@ -21,9 +20,8 @@ describe Rescue::Controller::Static do
             visit "/static/#{name.to_s.underscore}.#{format.to_sym}"
           end
 
-          subject { page }
-          it { should have_content name.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1 \2').gsub(/([a-z\d])([A-Z])/,'\1 \2') }
-          it { response_headers["Content-Type"].should include(format.to_s) }
+          it { expect(page).to have_content name.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1 \2').gsub(/([a-z\d])([A-Z])/,'\1 \2') }
+          it { expect(response_headers["Content-Type"]).to include(format.to_s) }
         end
       end
     end

data/spec/rescue/exceptions/respond_error_spec.rb

@@ -0,0 +1,36 @@
+# coding: UTF-8
+require 'spec_helper'
+
+describe Rescue::RespondError do
+
+  Rescue::ApplicationError::STATUS_CODES.each do |code, e|
+    describe "#{code} #{e[:status]}" do
+      let(:name) { e[:status].gsub(' ', '') }
+
+      it "expects to define an exception class of #{e[:status]}" do
+        expect(Object.const_defined? name).to be_true
+      end
+
+      it "expects to define an exception class that is a kind of Rescue::ApplicationError" do
+        expect(Object.const_get(name).new).to be_a_kind_of Rescue::ApplicationError
+      end
+    end
+  end
+
+  describe "HTTP Status Code" do
+    context "Suppress Response code is #{Rescue.config.suppress_response_codes}" do
+      Rescue::ApplicationError::STATUS_CODES.each do |code, e|
+        describe "#{code} #{e[:status]}" do
+          before do
+            visit "/status//#{code}.json"
+          end
+
+          it "expects to return #{Rescue.config.suppress_response_codes ? 200 : e[:http]}" do
+            expect(page.status_code).to eq (Rescue.config.suppress_response_codes ? 200 : e[:http])
+          end
+        end
+      end
+    end
+  end
+
+end

data/spec/rescue_spec.rb

@@ -7,14 +7,12 @@ describe Rescue do
     let(:name) { :RescueStandardError }
     before     { Rescue::Bind.define_error_class name }
 
-    subject { Object.const_defined? name }
-    it "should define an exception class" do
-      should be_true
+    it "expects to define an exception class" do
+      expect(Object.const_defined? name).to be_true
     end
 
-    subject { Object.const_get(name).new }
-    it "should define an exception class that is a kind of StandardError" do
-      should be_a_kind_of StandardError
+    it "expects to define an exception class that is a kind of StandardError" do
+      expect(Object.const_get(name).new).to be_a_kind_of StandardError
     end
   end
 
@@ -22,14 +20,12 @@ describe Rescue do
     let(:name) { :RescueScriptError }
     before     { Rescue::Bind.define_error_class name, ScriptError }
 
-    subject { Object.const_defined? name }
-    it "should define an exception class" do
-      should be_true
+    it "expects to define an exception class" do
+      expect(Object.const_defined? name).to be_true
     end
 
-    subject { Object.const_get(name).new }
-    it "should define an exception class that is a kind of StandardError" do
-      should be_a_kind_of ScriptError
+    it "expects to define an exception class that is a kind of StandardError" do
+      expect(Object.const_get(name).new).to be_a_kind_of ScriptError
     end
   end
 

data/spec/spec_helper.rb

@@ -1,11 +1,17 @@
 # encoding: utf-8
 require 'rubygems'
 require 'rescue-dog'
+require 'coveralls'
 
 require File.join(File.dirname(__FILE__), 'rails_spec_app')
 require File.join(File.dirname(__FILE__), 'test_case')
 require 'capybara/rails'
+
+Coveralls.wear!('rails')
 RSpec.configure do |config|
   config.mock_with :rspec
+  config.expect_with :rspec do |c|
+    c.syntax = :expect    # disables `should`
+  end
   config.include Capybara::DSL
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rescue-dog
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-23 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,6 +36,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -47,9 +48,12 @@ files:
 - app/views/layouts/application.html.erb
 - deploy_gem.sh
 - lib/rescue-dog.rb
+- lib/rescue/config.rb
 - lib/rescue/controller.rb
-- lib/rescue/controller/dynamic.rb
-- lib/rescue/controller/static.rb
+- lib/rescue/controllers/dynamic.rb
+- lib/rescue/controllers/static.rb
+- lib/rescue/exceptions/application_error.rb
+- lib/rescue/exceptions/respond_error.rb
 - lib/rescue/version.rb
 - public/400.html
 - public/400.json
@@ -61,9 +65,10 @@ files:
 - public/500.json
 - rescue-dog.gemspec
 - spec/rails_spec_app.rb
-- spec/rescue/controller/dynamic_spec.rb
-- spec/rescue/controller/static_spec.rb
 - spec/rescue/controller_spec.rb
+- spec/rescue/controllers/dynamic_spec.rb
+- spec/rescue/controllers/static_spec.rb
+- spec/rescue/exceptions/respond_error_spec.rb
 - spec/rescue_spec.rb
 - spec/spec_helper.rb
 - spec/test_case.rb
@@ -93,9 +98,10 @@ specification_version: 3
 summary: define respond methods
 test_files:
 - spec/rails_spec_app.rb
-- spec/rescue/controller/dynamic_spec.rb
-- spec/rescue/controller/static_spec.rb
 - spec/rescue/controller_spec.rb
+- spec/rescue/controllers/dynamic_spec.rb
+- spec/rescue/controllers/static_spec.rb
+- spec/rescue/exceptions/respond_error_spec.rb
 - spec/rescue_spec.rb
 - spec/spec_helper.rb
 - spec/test_case.rb