restful_error 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9c9179f83c80510bc4d7a61c63f3bb73ec7767853a601063f3f407c07e8c12f
-  data.tar.gz: c3b69c8c5aeb55ebcff66c10825af68d4fec44f93af18e9588ae06edaff71542
+  metadata.gz: cf170d758ce3175fe4b56ec695fbf4be09569474e66b376df7395084b8babda5
+  data.tar.gz: df9042f7e3a5ab6d80b7c861e61f35604f894715226c2b2b87bd4ccbff610ad9
 SHA512:
-  metadata.gz: 93c65efd5ece3f8dffc6760086b17ac682ec7577583023deeedcb45565593d8c31cc9cb465a0de9bbc2c5c8de640655793e6e194138e7ff5423d7055b6c3f561
-  data.tar.gz: '09e8c789c9d89598f66cb00d3b21e8a526e5908c006893f5e920d81be07fb32f7d61d2745a18c5611bd9071dde261884f26f5a4d875422a762d54079ec6c04f3'
+  metadata.gz: 1b649d3d114cfc2dfb0eefd9c96a0e69be07715d3e2c9517dda75b0d80ad0d08e05f07ed968ecb5f74bb51da4b3d68dfdc512097d78c5d030a9343b16d922ad6
+  data.tar.gz: b9440442b318f6d64958c14e0252d26a628cb8545c03d716464f10493e016c9a6848b1636dd6f0321b0bcf605833e3bc20db0188da6096d64177f390a47f896b

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2025 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,124 @@
+[![Gem Version](https://badge.fury.io/rb/restful_error.svg)](https://badge.fury.io/rb/restful_error)
+
+# 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
+
+## Usage
+
+### Pure ruby
+```ruby
+ex = RestfulError[404].new
+ex.restful.code # => 404
+ex.restful.reason_phrase # => "Not Found"
+```
+
+#### your custom error by subclassing
+```ruby
+class ::NoSession < RestfulError[404]; end
+# or
+class ::NoSession < RestfulError::NotFound; end
+```
+#### your custom error with http_status
+```ruby
+class OAuthController < ApplicationController
+
+  # define http_status and include RestfulError::Helper
+  class PermissionError < StandardError
+    include RestfulError::Helper
+    def http_status = 401
+  end
+  # or
+  class PermissionError < StandardError
+    include RestfulError::Helper
+    def http_status; :unauthorized; end
+  end
+end
+PermissionError.new.restful.reason_phrase # => "Unauthorized"
+```
+
+### With Rails
+`config.exceptions_app` will automatically set.
+
+#### raise me in request
+```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_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
+
+```yaml
+ja:
+  restful_error:
+    unauthorized: ログインしてください #401
+    not_found: ページが存在しません #404
+```
+
+#### 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 response_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/app/views/restful_error/show.html.erb

@@ -0,0 +1,4 @@
+<div class="'page_header">
+  <h1><%= @status_code %> <%= @reason_phrase %></h1>
+  <p><%= @response_message %></p>
+</div>

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

@@ -0,0 +1,7 @@
+<%=
+  raw JSON.generate(
+    status_code: @status_code,
+    reason_phrase: @reason_phrase,
+    response_message: @response_message
+  )
+%>

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

@@ -0,0 +1,5 @@
+<error>
+  <status_code><%= @status_code %></status_code>
+  <reason_phrase><%= @reason_phrase %></reason_phrase>
+  <response_message><%= @response_message %></response_message>
+</error>

data/config/locales/en.restful_error.yml

@@ -0,0 +1,14 @@
+en:
+  restful_error:
+    active_record/record_not_found: Requested resource is not found
+    action_controller/routing_error: Requested resource is not found
+    can_can/unauthorized: Unauthorized
+    bad_request: Bad request #400
+    unauthorized: Unauthorized #401
+    forbidden: Forbidden #403
+    not_found: Page not found #404
+    method_not_allowed: Requested HTTP Method is not allowd #405
+    gone: Gone #410
+    unprocessable_content: Content is readable but unprocessable #422
+    internal_server_error: Internal server error #500
+    service_unavailable: Service unavailable #503

data/config/locales/ja.restful_error.yml

@@ -0,0 +1,13 @@
+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: その HTTP method は使用できません #405
+    gone: 要求されたリソースは消滅しました #410
+    unprocessable_content: コンテンツを読みましたが処理できません #422
+    internal_server_error: サーバエラーです #500
+    service_unavailable: サービスが一時的に利用不可能になっています。しばらく時間をおいて、再度ご確認願います。 #503

data/lib/restful_error/inflector.rb

@@ -12,6 +12,7 @@ module RestfulError
       word.gsub!(/(?<=[A-Z])(?=[A-Z][a-z])|(?<=[a-z\d])(?=[A-Z])/, "_")
       word.tr!("-", "_")
       word.downcase!
+      word
     end
 
     def camelize(word_)
@@ -21,6 +22,7 @@ module RestfulError
       word.sub!(/^[a-z\d]*/) { ::Regexp.last_match(0).capitalize }
       word.gsub!(%r{(?:_|(/))([a-z\d]*)}) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}" }
       word.gsub!("/", "::")
+      word
     end
   end
 end

data/lib/restful_error/railtie.rb

@@ -10,18 +10,14 @@ module RestfulError
 
     def show
       @exception = request.env["action_dispatch.exception"]
-      status = Status.new(request.path_info[1..].to_i)
+      code = request.path_info[1..].to_i
+      status = RestfulError.build_status_from_symbol_or_code(code)
       @status_code = status.code
       @reason_phrase = status.reason_phrase
-      @message = @exception.try(:response_message)
-      unless @message
-        class_name = @exception.class.name
-        class_key = RestfulError::Inflector.underscore(class_name)
-        @message = I18n.t class_key, default: [ status.symbol, @reason_phrase ], scope: :restful_error
-      end
+      @response_message = @exception.try(:response_message) || RestfulError.localized_phrase(@exception.class.name, status) || nil
 
       self.status = status.code
-      render "restful_error/show"
+      render "restful_error/show", formats: request.format.symbol
     end
   end
 

data/lib/restful_error/status.rb

@@ -4,34 +4,34 @@ require "restful_error/inflector"
 require "rack/utils"
 
 module RestfulError
+  Status = Data.define(:code, :reason_phrase, :symbol, :const_name)
+
   STATUS_CODE_TO_SYMBOL = Rack::Utils::SYMBOL_TO_STATUS_CODE.invert
-  def self.code_from(code_or_sym_or_const_name)
-    case code_or_sym_or_const_name
+
+  def self.build_status_from_const(const_sym)
+    const_name = const_sym.to_s
+    return unless /[A-Z]/.match?(const_name[0])
+    symbol = RestfulError::Inflector.underscore(const_name).to_sym
+    build_status_from_symbol_or_code(symbol)
+  end
+  def self.build_status_from_symbol_or_code(code_or_sym)
+    case code_or_sym
     when Integer
-      code_or_sym_or_const_name
+      code = code_or_sym
+      symbol = STATUS_CODE_TO_SYMBOL[code]
+      const_name = Inflector.camelize(symbol.to_s)
+      reason_phrase = Rack::Utils::HTTP_STATUS_CODES[code]
+      Status.new(code:, symbol:, const_name:, reason_phrase:)
     when Symbol
-      str = code_or_sym_or_const_name.to_s
-      sym = /[A-Z]/.match?(str[0]) ? RestfulError::Inflector.underscore(str).to_sym : code_or_sym_or_const_name
       begin
-        Rack::Utils.status_code(sym)
+        build_status_from_symbol_or_code Rack::Utils.status_code(code_or_sym)
       rescue ArgumentError
         nil
       end
     when /\A\d{3}\z/
-      code_from(code_or_sym_or_const_name.to_i)
+      build_status_from_symbol_or_code(code_or_sym.to_i)
     else
-      raise ArgumentError, "Invalid argument: #{code_or_sym_or_const_name.inspect}"
-    end
-  end
-
-  Status = Data.define(:code, :reason_phrase, :symbol, :const_name) do
-    def initialize(code:)
-      reason_phrase = Rack::Utils::HTTP_STATUS_CODES[code]
-      raise ArgumentError, "Invalid status code: #{code}" unless reason_phrase
-
-      symbol = STATUS_CODE_TO_SYMBOL[code]
-      const_name = Inflector.camelize(symbol.to_s)
-      super(code:, reason_phrase:, symbol:, const_name:)
+      raise ArgumentError, "Invalid argument: #{code_or_sym.inspect}"
     end
   end
 end

data/lib/restful_error/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RestfulError
-  VERSION = "1.0.2"
+  VERSION = "1.0.4"
 end

data/lib/restful_error.rb

@@ -3,43 +3,62 @@
 require "rack/utils"
 require "restful_error/railtie" if defined? ActionController
 require "restful_error/status"
-
-I18n.load_path += Dir["#{File.expand_path("../config/locales")}/*.yml"] if defined? I18n
+require "restful_error/version"
 
 module RestfulError
-  class BaseError < StandardError; end
-
   module Helper
     def restful
-      raise NotImplementedError, "http_status must be implemented by including class" unless respond_to?(:http_status)
+      @restful ||= begin
+        raise NotImplementedError, "http_status must be implemented by including class" unless respond_to?(:http_status)
+        RestfulError.build_status_from_symbol_or_code(http_status)
+      end
+    end
+    def response_message
+      return @response_message unless @response_message.nil?
+      @response_message = RestfulError.localized_phrase(self.class.name, restful)
+    end
+  end
 
-      @restful ||= Status.new(RestfulError.code_from(http_status))
+  class BaseError < StandardError
+    include RestfulError::Helper
+    def initialize(message = nil)
+      @response_message = message
+      super
     end
   end
 
   @cache = {}
   class << self
     def [](code_like)
-      code = RestfulError.code_from(code_like)
-      @cache[code] ||= build_error_class_for(code)
+      status = RestfulError.build_status_from_symbol_or_code(code_like)
+      @cache[status.code] ||= build_error_class_for(status)
     end
 
     def const_missing(const_name)
-      code = RestfulError.code_from(const_name)
-      return super unless code
+      status = RestfulError.build_status_from_const(const_name)
+      return super unless status
+
+      @cache[status.code] ||= build_error_class_for(status)
+    end
 
-      @cache[code] ||= build_error_class_for(code)
+    def init_i18n
+      return if @init_i18n
+      I18n.load_path += Dir["#{File.expand_path("./config/locales")}/*.yml"]
+      @init_i18n = true
+    end
+    def localized_phrase(class_name, status)
+      return false unless defined?(I18n)
+      init_i18n
+      class_key = RestfulError::Inflector.underscore(class_name)
+      I18n.t class_key, default: [status.symbol, false], scope: :restful_error
     end
 
     private
 
-    def build_error_class_for(code)
-      status = Status.new(code)
-      message = defined?(I18n) ? I18n.t(status.symbol, default: status.reason_phrase, scope: :restful_error) : status.reason_phrase
+    def build_error_class_for(status)
       klass = Class.new(BaseError) do
         define_method(:http_status) { status.code }
         define_method(:restful) { status }
-        define_method(:message) { message }
       end
       const_set(status.const_name, klass)
       if defined? ActionDispatch::ExceptionWrapper

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restful_error
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - kuboon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -38,16 +38,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
+- app/views/restful_error/show.html.erb
+- app/views/restful_error/show.json.erb
+- 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/inflector.rb
 - lib/restful_error/railtie.rb
 - lib/restful_error/status.rb
 - lib/restful_error/version.rb
-- spec/rack_spec.rb
-- spec/railtie_spec.rb
-- spec/restful_error_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/kuboon/restful_error
 licenses:
 - MIT

data/lib/restful_error/engine.rb

@@ -1,9 +0,0 @@
-begin
-  require 'rails'
-  module RestfulError #:nodoc:
-    class Engine < ::Rails::Engine #:nodoc:
-    end
-  end
-rescue LoadError
-  #do nothing
-end

data/spec/rack_spec.rb

@@ -1,20 +0,0 @@
-require 'action_controller'
-require 'spec_helper'
-
-describe 'RestfulError' do
-  describe RestfulError::ExceptionsController do
-    include Rack::Test::Methods
-    def app
-      RestfulError::ExceptionsController.action(:show)
-    end
-    describe '404' do
-      before do
-        env "action_dispatch.exception", RestfulError[404].new
-      end
-      it do
-        get '/404'
-        expect(last_response.status).to eq 404
-      end
-    end
-  end
-end

data/spec/railtie_spec.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "action_controller"
-require "spec_helper"
-
-RSpec.describe "RestfulError.exceptions_app" do
-  let(:app) { RestfulError.exceptions_app }
-  let(:env) { {} }
-  let(:request) { Rack::MockRequest.new(app) }
-
-  it "renders 404" do
-    env["action_dispatch.exception"] = ActionController::RoutingError.new("Not Found")
-    env["PATH_INFO"] = "/404"
-    response = request.get("/404", env)
-    expect(response.status).to eq 404
-    expect(response.body).to include "Not Found"
-  end
-end

data/spec/restful_error_spec.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-describe RestfulError do
-  describe "RestfullError[404]" do
-    subject { described_class[404].new }
-
-    it do
-      expect(subject.http_status).to eq 404
-      expect(subject.restful.reason_phrase).to eq "Not Found"
-    end
-  end
-
-  describe "RestfullError[:bad_request]" do
-    subject { described_class[:bad_request].new }
-
-    it do
-      expect(subject.http_status).to eq 400
-      expect(subject.restful.reason_phrase).to eq "Bad Request"
-    end
-  end
-
-  describe described_class::Forbidden do
-    subject { described_class.new }
-
-    it do
-      expect(subject.http_status).to eq 403
-      expect(subject.restful.reason_phrase).to eq "Forbidden"
-    end
-  end
-
-  describe "custom class" do
-    subject { klass.new }
-
-    let(:klass) do
-      Class.new(StandardError) do
-        include RestfulError::Helper
-        def http_status = 404
-      end
-    end
-
-    it do
-      expect(subject.restful.symbol).to eq :not_found
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-
-require "debug"
-require "restful_error"