restful_error 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4744dd451535b3d85e7ce8b47a76abee9fa33970a72d6748e553f89bb830e9e5
-  data.tar.gz: 6cfc09fbf86294c2453a3effeb1537f83a9c8fef8bed444f24916e3f45c2d470
+  metadata.gz: ed208c312dae52e3f02f31f16ee66ebe34b6a98f02195c6dae1178c8ae638aab
+  data.tar.gz: f28848072ce6af1819ccefce94b474c11d5eb92543698f5fb4478d80984cc6a4
 SHA512:
-  metadata.gz: 6d339f3e39861bfdc9bf64fc983d9b03e15708f4323d3f9987da1ae70c7bc973b8cfecb7cc7568a1078957f7eef6ba9a8e1f5c533f50a734b2fcc0005f5c2170
-  data.tar.gz: cbbf4ee06b69b396f79cd351c2659458422090d927af7584f31eab4e8e4fe1bcc4019cb21b90f2695ddbfe2683199afd412a4f6bad11ddf61365cb182a26f55f
+  metadata.gz: 833c5516e492850176e4321769fd2eb4060036b2948c9a9bcbbe40bace7c082bb4f473879713c02ba55a204509214bd57f50963128a384e16db23586c710519a
+  data.tar.gz: ed25e5a04a3ddb4761449d034b2457097c7d7aa2a4a684dfcaa9a4dccd211c9baecd7d54e1dc3460fac03501eb8a49c5ed32751a6bc96f6353336e7fa2f67e4e

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,133 @@
+[![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 (without Rails)
+#### Predefined errors
+```ruby
+ex = RestfulError[404].new
+
+StandardError === ex # => true # because inherit from StandardError
+RestfulError::BaseError === ex # => true
+
+RestfulError[404] == RestfulError::NotFound # => true # same class
+
+ex.status_data # returns Data about status code
+# => #<data RestfulError::Status
+#      code=404,
+#      reason_phrase="Not Found",
+#      symbol=:not_found,
+#      const_name="NotFound">
+ex.status_data.code # => 404
+```
+
+#### Custom error by subclassing
+```ruby
+class ::NoSession < RestfulError[404]; end
+# or
+class ::NoSession < RestfulError::NotFound; end
+```
+
+#### Custom error with http_status
+```ruby
+# define http_status and include RestfulError::Helper
+class User::PermissionError < StandardError
+  include RestfulError::Helper
+  def http_status = :unauthorized # or 401
+end
+User::PermissionError.new.status_data.reason_phrase # => "Unauthorized"
+```
+
+### With I18n
+`#response_message` returns i18nized message.
+```yaml
+ja:
+  restful_error:
+    unauthorized: ログインが必要です
+    not_found: ページが存在しません
+    user/permission_error: 権限がありません
+```
+```ruby
+# lookup class name first, then status symbol
+User::PermissionError.new.response_message # => "権限がありません"
+AnotherPermissionError.new.response_message # => "ログインが必要です"
+```
+
+### With Rails
+`config.exceptions_app` will automatically set to RestfulError::ExceptionsApp.
+
+If you want to disable it, you have two options.
+- `config.restful_error.exceptions_app.enable = false` (will not set exceptions_app)
+- `config.exceptions_app = ActionDispatch::PublicExceptions.new(Rails.public_path)` (set Rails default explicitly, or set your own)
+
+#### Raise me in request handling
+```ruby
+class PostsController < ApplicationController
+  before_action do
+    raise RestfulError[401] unless current_user
+    # or
+    raise RestfulError::Unauthorized unless current_user
+  end
+end
+```
+
+
+#### Render response
+Default view files are in https://github.com/kuboon/restful_error/tree/main/app/views/restful_error
+
+`html`, `json` and `xml` are supported.
+
+You can override them by creating view file `show.{format}.{handler}` under your `app/views/restful_error/` directory.
+
+`@status` `@status_code` `@reason_phrase` `@response_message` are available in the view.
+
+If you have `layouts/restful_error.*.*`, or `layouts/application.*.*`, it will be used as layout. This is done by inheriting `::ApplicationController`.
+
+To change superclass,
+set `config.restful_error.exceptions_app.inherit_from = 'AnotherBaseController'`
+
+#### Library defined error
+You can assign status code to error classes which are not yours. (This is Rails standard)
+
+```ruby
+config.action_dispatch.rescue_responses["Pundit::NotAuthorizedError"] = :unauthorized # or 401
+```
+
+RestfulError will use this configuration to lookup status code and
+`@response_message` will be set.
+
+```yaml
+ja:
+  restful_error:
+    pundit/not_authorized_error: アクセス権限がありません
+    active_record/record_not_found: 要求されたリソースが存在しません
+```
+
+## Why `response_message`, not `message`?
+`StandardError#message` is used for debugging purpose, not intended to be shown to users.
+Rails default behavior does not show `message` in production environment. So I decided to use `response_message` instead.
+
+You can `def response_message` or set `@resposne_message` in your error class to build dynamic message.
+
+
+## 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/layouts/application.html.erb

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <%= yield %>
+  </body>
+</html>

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.ruby

@@ -0,0 +1,5 @@
+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/application_controller.rb

@@ -0,0 +1,11 @@
+require "abstract_controller"
+require "action_controller/metal"
+
+module RestfulError
+  class ApplicationController < ::ActionController::Metal
+    abstract!
+    include AbstractController::Rendering
+    include ActionView::Layouts
+    include ActionController::Rendering
+  end
+end

data/lib/restful_error/exceptions_app.rb

@@ -0,0 +1,44 @@
+require "abstract_controller"
+require "action_controller/metal"
+
+module RestfulError
+  class ExceptionsApp
+    Config = Struct.new(:enable, :inherit_from, :fallback)
+    def self.config
+      @config ||= Config.new.tap do |config|
+        config.enable = true
+        config.inherit_from = "::ApplicationController"
+      end
+    end
+
+    def initialize(config = self.class.config)
+      @config = config
+    end
+    def call(env)
+      app.call(env)
+    rescue Exception => _e
+      raise unless @config.fallback
+      @config.fallback.call(env)
+    end
+
+    private
+
+    def app
+      @app ||= begin
+        # To use "layouts/application" we need inherit from ::ApplicationController
+        # It is not defined at config time, so we need to load it here
+        if @config.inherit_from && Object.const_defined?(@config.inherit_from)
+          inherit_from = @config.inherit_from.constantize
+        else
+          inherit_from = RestfulError::ApplicationController
+        end
+        const_set_without_warn(RestfulError, "SuperController", inherit_from)
+        ExceptionsController.action(:show)
+      end
+    end
+    def const_set_without_warn(klass, const_name, value)
+      klass.send(:remove_const, const_name) if klass.const_defined?(const_name)
+      klass.const_set(const_name, value)
+    end
+  end
+end

data/lib/restful_error/exceptions_controller.rb

@@ -0,0 +1,19 @@
+module RestfulError
+  class ExceptionsController < SuperController
+    def self.controller_path = "restful_error"
+    append_view_path File.join(File.dirname(__FILE__), "../../app/views")
+
+    layout nil
+
+    def show
+      @exception = request.env["action_dispatch.exception"]
+      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
+      @response_message = @exception.try(:response_message) || RestfulError.localized_phrase(@exception.class.name, status) || nil
+
+      render status: status.code, formats: request.format.symbol
+    end
+  end
+end

data/lib/restful_error/railtie.rb

@@ -1,27 +1,15 @@
-require "abstract_controller"
-require "action_controller/metal"
+require "restful_error/exceptions_app"
 
 module RestfulError
-  class ExceptionsController < ::ActionController::Metal
-    include AbstractController::Rendering
-    include ActionView::Layouts
-
-    append_view_path File.join(File.dirname(__FILE__), "../../app/views")
-
-    def show
-      @exception = request.env["action_dispatch.exception"]
-      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
-      @response_message = @exception.try(:response_message) || RestfulError.localized_phrase(@exception.class.name, status) || nil
-
-      self.status = status.code
-      render "restful_error/show", formats: request.format.symbol
+  class Railtie < Rails::Railtie
+    config.restful_error = ActiveSupport::OrderedOptions.new
+    config.restful_error.exceptions_app = RestfulError::ExceptionsApp.config
+
+    initializer "restful_error.exceptions_app", before: :build_middleware_stack do |app|
+      if app.config.restful_error.exceptions_app.enable
+        app.config.restful_error.exceptions_app.fallback ||= ActionDispatch::PublicExceptions.new(Rails.public_path)
+        app.config.exceptions_app ||= RestfulError::ExceptionsApp.new
+      end
     end
   end
-
-  def self.exceptions_app
-    ExceptionsController.action(:show)
-  end
 end

data/lib/restful_error/version.rb

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

data/lib/restful_error.rb

@@ -1,29 +1,29 @@
 # frozen_string_literal: true
 
 require "rack/utils"
-require "restful_error/railtie" if defined? ActionController
 require "restful_error/status"
 require "restful_error/version"
+require "restful_error/railtie" if defined? Rails::Railtie
 
 module RestfulError
+  autoload :ExceptionsApp, "restful_error/exceptions_app"
+  autoload :ApplicationController, "restful_error/application_controller"
+  autoload :ExceptionsController, "restful_error/exceptions_controller"
+
   module Helper
-    def restful
-      @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
+    def status_data
+      @status_data ||= RestfulError.build_status_from_symbol_or_code(http_status)
     end
     def response_message
       return @response_message unless @response_message.nil?
-      @response_message = RestfulError.localized_phrase(self.class.name, restful)
+      @response_message = RestfulError.localized_phrase(self.class.name, status_data)
     end
   end
 
   class BaseError < StandardError
     include RestfulError::Helper
-    def initialize(message = nil)
-      @response_message = message
-      super
+    def http_status
+      raise NotImplementedError, "http_status must be implemented"
     end
   end
 
@@ -58,7 +58,7 @@ module RestfulError
     def build_error_class_for(status)
       klass = Class.new(BaseError) do
         define_method(:http_status) { status.code }
-        define_method(:restful) { status }
+        define_method(:status_data) { status }
       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.3
+  version: 1.0.5
 platform: ruby
 authors:
 - kuboon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-31 00:00:00.000000000 Z
+date: 2025-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -38,14 +38,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
+- app/views/layouts/application.html.erb
+- app/views/restful_error/show.html.erb
+- app/views/restful_error/show.json.ruby
+- 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/application_controller.rb
+- lib/restful_error/exceptions_app.rb
+- lib/restful_error/exceptions_controller.rb
 - lib/restful_error/inflector.rb
 - lib/restful_error/railtie.rb
 - lib/restful_error/status.rb
 - lib/restful_error/version.rb
-- spec/restful_error_spec.rb
-- spec/spec_helper.rb
-- spec/with_rails/exceptions_app_spec.rb
 homepage: https://github.com/kuboon/restful_error
 licenses:
 - MIT

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"

data/spec/with_rails/exceptions_app_spec.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require "action_controller"
-require "i18n"
-require "spec_helper"
-require "restful_error/railtie" # require again for run after restful_error_spec
-
-RSpec.describe RestfulError::ExceptionsController do
-  include Rack::Test::Methods
-  def app = RestfulError.exceptions_app
-
-  shared_context "json" do
-    let(:request) { get "/#{status_code}", {}, 'HTTP_ACCEPT' => 'application/json' }
-    let(:json) { request; JSON.parse(last_response.body) }
-  end
-
-  before do
-    env "action_dispatch.exception", exception
-  end
-  describe RestfulError[404] do
-    let(:status_code) { 404 }
-    include_context "json" do
-      context 'default message' do
-        let(:exception) { described_class.new }
-        it do
-          expect(json).to eq({status_code: 404, reason_phrase: "Not Found", response_message: 'Page not found'}.stringify_keys)
-          expect(last_response.status).to eq status_code
-        end
-      end
-      context 'custom message' do
-        let(:exception) { described_class.new("custom message") }
-        it do
-          expect(json).to eq({status_code:, reason_phrase: "Not Found", response_message: "custom message"}.stringify_keys)
-        end
-      end
-    end
-  end
-  context ActionController::RoutingError do
-    let(:exception) { described_class.new("no route") }
-    let(:status_code) { 404 }
-    include_context "json" do
-      it do
-        expect(json).to eq({status_code:, reason_phrase: "Not Found", response_message: 'Requested resource is not found'}.stringify_keys)
-        expect(last_response.status).to eq status_code
-      end
-    end
-  end
-end