restful_error 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a0b6ecf7b2b0850d7ba6f851e133a14956e14ba
+  data.tar.gz: e13b73de0f1cd601fa9e9625e88947d6f4a5c778
+SHA512:
+  metadata.gz: c724eaf4017d222802139f57968badb47ddbbf9449e1fa28d274dc1504fd52944286bea4fa984e308664830f0afc69ed377c3c435135c6b5b3e4fe7715b45604
+  data.tar.gz: a97290cf9558f780b32dde51e76ebd01353a1451303a60fd39dc89aec061dd97f32a216f8a2e5d74c8962d82e052579fc9a72da252c473f0cd143e05f63e6c91

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ohkubo KOHEI
+
+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,113 @@
+# RestfulError
+
+Define your error with status code. Raise it and you will get formatted response with i18nized message.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'restful_error'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restful_error
+
+## Usage
+
+### Simple
+#### raise me
+```ruby
+class PostsController < ApplicationController
+  before_action do
+    raise RestfulError[401] unless current_user
+    # or
+    raise RestfulError::Unauthorized unless current_user
+  end
+end
+```
+#### Multi format response
+
+```ruby
+get '/posts/new'
+#=> render 'restful_error/show.html' with @status_code and @message
+
+post '/posts.json'
+#=> { status: 401, message: "Sign in required"} or write your json at 'restful_error/show.json'
+
+get '/session.xml'
+#=> "<error><status type="integer">401</status><message>Sign in required</message></error>" or write your xml at 'restful_error/show.xml'
+```
+
+#### I18n
+
+```yaml
+ja:
+  restful_error:
+    unauthorized: ログインしてください #401
+    not_found: ページが存在しません #404
+```
+
+### Advanced
+#### your custom error
+```ruby
+class ::NoSession < RestfulError[404]; end
+# or
+class ::NoSession < RestfulError::NotFound; end
+```
+#### duck typing
+```ruby
+class OAuthController < ApplicationController
+
+  # all you need is status_code
+  class RequireTwitterLogin < StandardError
+    def status_code; 401; end
+  end
+  # or
+  class RequireTwitterLogin < StandardError
+    def status_code; :unauthorized; end
+  end
+end
+```
+
+#### library defined error
+``` ruby
+config.action_dispatch.rescue_responses["CanCan::Unauthorized"] = 401
+# or
+config.action_dispatch.rescue_responses["CanCan::Unauthorized"] = :unauthorized
+```
+#### I18n
+```yaml
+ja:
+  restful_error:
+    no_session: セッションがありません
+    oauth_controller/require_twitter_login: Twitterログインが必要です
+    can_can/unauthorized: 権限がありません
+    active_record/record_not_found: 要求されたリソースが存在しません
+```
+#### custom message
+```ruby
+class RequireLogin < StandardError
+  def initialize(provider = 'Unknown')
+    @provider = provider
+  end
+  def status_code
+    :unauthorized
+  end
+  def message
+    I18n.t('restful_error.require_login', provider: provider)
+  end
+end
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/kuboon/restful_error/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

data/Rakefile

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

data/app/views/restful_error/show.html.haml

@@ -0,0 +1,4 @@
+.page_header
+  %h1
+    = @message
+    %small= @status_code

data/app/views/restful_error/show.json.jbuilder

@@ -0,0 +1,2 @@
+json.status_code @status_code
+json.message @message

data/app/views/restful_error/show.xml.erb

@@ -0,0 +1 @@
+<error><status_code><%= @status_code %></status_code><message><%= @message %></message></error>

data/config/locales/en.restful_error.yml

@@ -0,0 +1,12 @@
+ja:
+  restful_error:
+    active_record/record_not_found: Requested resource is not found
+    can_can/unauthorized: Unauthorized
+    bad_request: Bad request #400
+    unauthorized: Unauthorized #401
+    forbidden: Forbidden #403
+    not_found: Not found #404
+    method_not_allowed: Method not allowd #405
+    gone: Gone #410
+    internal_server_error: Internal server error #500
+    service_unavailable: Service unavailable #503

data/config/locales/ja.restful_error.yml

@@ -0,0 +1,12 @@
+ja:
+  restful_error:
+    active_record/record_not_found: 要求されたリソースが存在しません!
+    can_can/unauthorized: 権限がありません
+    bad_request: 不正なリクエストです #400
+    unauthorized: 権限がありません #401
+    forbidden: そのURLへのアクセスは禁止されています #403
+    not_found: そのURLは存在しません #404
+    method_not_allowed: メソッドは使用できません #405
+    gone: 要求されたリソースは消滅しました #410
+    internal_server_error: サーバエラーです。 #500
+    service_unavailable: サービスが一時的に利用不可能になっています。しばらく時間をおいて、再度ご確認願います。 #503

data/lib/restful_error.rb

@@ -0,0 +1,40 @@
+require 'webrick/httpstatus'
+require 'webrick/accesslog'
+
+RestfulError = WEBrick::HTTPStatus
+
+require "restful_error/version"
+require "restful_error/engine"
+
+module RestfulError
+  CodeToError.each do |_, klass|
+    code = klass::code
+    reason_phrase = klass::reason_phrase
+    klass.class_exec do
+      define_method(:status_code, ->{ code })
+      define_method(:reason_phrase, ->{ reason_phrase })
+    end
+  end
+
+  module ActionController
+    def self.included(base)
+      base.rescue_from StandardError do |ex|
+        @exception   = ex
+        @status_code = Rack::Utils.status_code(@exception.try(:status_code)).nonzero? || ActionDispatch::ExceptionWrapper.new(env, @exception).status_code
+        raise if @status_code == 500 && Rails.configuration.consider_all_requests_local
+
+        @message = @exception.message
+        default_message = @exception.class.new.message rescue nil
+
+        if @message == default_message
+          reason_phrase_key = RestfulError.reason_phrase(@status_code).downcase.gsub(/\s|-/, '_').to_sym
+          @message = I18n.t @exception.class.name.underscore, default: [reason_phrase_key, @exception.class.name], scope: :restful_error
+        end
+
+        respond_to do |format|
+          format.any(:json, :xml, :html){ render 'restful_error/show', status: @status_code }
+        end
+      end
+    end
+  end
+end

data/lib/restful_error/engine.rb

@@ -0,0 +1,4 @@
+module RestfulError #:nodoc:
+  class Engine < ::Rails::Engine #:nodoc:
+  end
+end

data/lib/restful_error/version.rb

@@ -0,0 +1,3 @@
+module RestfulError
+  VERSION = "0.0.1"
+end

data/restful_error.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'restful_error/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "restful_error"
+  spec.version       = RestfulError::VERSION
+  spec.authors       = ["kuboon"]
+  spec.email         = ["ohkubo@magician.jp"]
+  spec.summary       = %q{Define your error with status code. Raise it and you will get formatted response with i18nized message.}
+  spec.description   = %q{Define your error with status code. Raise it and you will get formatted response with i18nized message.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 'rails', "> 3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/restful_error_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe RestfulError do
+  it 'has a version number' do
+    expect(RestfulError::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'restful_error'

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: restful_error
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kuboon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Define your error with status code. Raise it and you will get formatted
+  response with i18nized message.
+email:
+- ohkubo@magician.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/restful_error/show.html.haml
+- app/views/restful_error/show.json.jbuilder
+- app/views/restful_error/show.xml.erb
+- config/locales/en.restful_error.yml
+- config/locales/ja.restful_error.yml
+- lib/restful_error.rb
+- lib/restful_error/engine.rb
+- lib/restful_error/version.rb
+- restful_error.gemspec
+- spec/restful_error_spec.rb
+- spec/spec_helper.rb
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Define your error with status code. Raise it and you will get formatted response
+  with i18nized message.
+test_files:
+- spec/restful_error_spec.rb
+- spec/spec_helper.rb