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
Load the module in your controller:
class ApplicationController < ActionController::Base
include RestfulError::ActionControllerUsage
Simple
raise me
class PostsController < ApplicationController
before_action do
raise RestfulError[401] unless current_user
# or
raise RestfulError::Unauthorized unless current_user
end
endMulti format response
get '/posts/new'
#=> render 'restful_error/show.html' with @status_code and @message
post '/posts.json'
#=> { status_code: 401, message: "Sign in required"} or write your json at 'restful_error/show.json'
get '/session.xml'
#=> "<error><status_code type="integer">401</status_code><message>Sign in required</message></error>" or write your xml at 'restful_error/show.xml'I18n
ja:
restful_error:
unauthorized: ログインしてください #401
not_found: ページが存在しません #404Advanced
your custom error
class ::NoSession < RestfulError[404]; end
# or
class ::NoSession < RestfulError::NotFound; endduck typing
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
endlibrary defined error
config.action_dispatch.rescue_responses["CanCan::Unauthorized"] = 401
# or
config.action_dispatch.rescue_responses["CanCan::Unauthorized"] = :unauthorizedI18n
ja:
restful_error:
no_session: セッションがありません
oauth_controller/require_twitter_login: Twitterログインが必要です
can_can/unauthorized: 権限がありません
active_record/record_not_found: 要求されたリソースが存在しませんcustom message
class RequireLogin < StandardError
def initialize(provider = 'Unknown')
@provider = provider
end
def status_code
:unauthorized
end
def status_message
I18n.t('restful_error.require_login', provider: provider)
end
endContributing
- Fork it ( https://github.com/kuboon/restful_error/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request