restful_error 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf170d758ce3175fe4b56ec695fbf4be09569474e66b376df7395084b8babda5
-  data.tar.gz: df9042f7e3a5ab6d80b7c861e61f35604f894715226c2b2b87bd4ccbff610ad9
+  metadata.gz: ed208c312dae52e3f02f31f16ee66ebe34b6a98f02195c6dae1178c8ae638aab
+  data.tar.gz: f28848072ce6af1819ccefce94b474c11d5eb92543698f5fb4478d80984cc6a4
 SHA512:
-  metadata.gz: 1b649d3d114cfc2dfb0eefd9c96a0e69be07715d3e2c9517dda75b0d80ad0d08e05f07ed968ecb5f74bb51da4b3d68dfdc512097d78c5d030a9343b16d922ad6
-  data.tar.gz: b9440442b318f6d64958c14e0252d26a628cb8545c03d716464f10493e016c9a6848b1636dd6f0321b0bcf605833e3bc20db0188da6096d64177f390a47f896b
+  metadata.gz: 833c5516e492850176e4321769fd2eb4060036b2948c9a9bcbbe40bace7c082bb4f473879713c02ba55a204509214bd57f50963128a384e16db23586c710519a
+  data.tar.gz: ed25e5a04a3ddb4761449d034b2457097c7d7aa2a4a684dfcaa9a4dccd211c9baecd7d54e1dc3460fac03501eb8a49c5ed32751a6bc96f6353336e7fa2f67e4e

data/README.md

@@ -16,41 +16,65 @@ And then execute:
 
 ## Usage
 
-### Pure ruby
+### Pure ruby (without Rails)
+#### Predefined errors
 ```ruby
 ex = RestfulError[404].new
-ex.restful.code # => 404
-ex.restful.reason_phrase # => "Not Found"
+
+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
 ```
 
-#### your custom error by subclassing
+#### 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
+#### 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
-PermissionError.new.restful.reason_phrase # => "Unauthorized"
+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.
+`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
+#### Raise me in request handling
 ```ruby
 class PostsController < ApplicationController
   before_action do
@@ -62,58 +86,43 @@ end
 ```
 
 
-#### Multi format response
+#### Render response
+Default view files are in https://github.com/kuboon/restful_error/tree/main/app/views/restful_error
 
-```ruby
-get '/posts/new'
-#=> render 'restful_error/show.html' with @status_code and @message
+`html`, `json` and `xml` are supported.
 
-post '/posts.json'
-#=> { status_code: 401, message: "Sign in required" } or write your json at 'restful_error/show.json'
+You can override them by creating view file `show.{format}.{handler}` under your `app/views/restful_error/` directory.
 
-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'
-```
+`@status` `@status_code` `@reason_phrase` `@response_message` are available in the view.
 
-#### I18n
+If you have `layouts/restful_error.*.*`, or `layouts/application.*.*`, it will be used as layout. This is done by inheriting `::ApplicationController`.
 
-```yaml
-ja:
-  restful_error:
-    unauthorized: ログインしてください #401
-    not_found: ページが存在しません #404
-```
+To change superclass,
+set `config.restful_error.exceptions_app.inherit_from = 'AnotherBaseController'`
 
-#### library defined error
-``` ruby
-config.action_dispatch.rescue_responses["CanCan::Unauthorized"] = 401
-# or
-config.action_dispatch.rescue_responses["CanCan::Unauthorized"] = :unauthorized
+#### 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
 ```
-#### I18n
+
+RestfulError will use this configuration to lookup status code and
+`@response_message` will be set.
+
 ```yaml
 ja:
   restful_error:
-    no_session: セッションがありません
-    oauth_controller/require_twitter_login: Twitterログインが必要です
-    can_can/unauthorized: 権限がありません
+    pundit/not_authorized_error: アクセス権限がありません
     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
-```
+## 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
 

data/app/views/layouts/application.html.erb

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

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/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.4"
+  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.4
+  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
@@ -40,12 +40,16 @@ 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.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

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

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