restful_error 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4744dd451535b3d85e7ce8b47a76abee9fa33970a72d6748e553f89bb830e9e5
-  data.tar.gz: 6cfc09fbf86294c2453a3effeb1537f83a9c8fef8bed444f24916e3f45c2d470
+  metadata.gz: cf170d758ce3175fe4b56ec695fbf4be09569474e66b376df7395084b8babda5
+  data.tar.gz: df9042f7e3a5ab6d80b7c861e61f35604f894715226c2b2b87bd4ccbff610ad9
 SHA512:
-  metadata.gz: 6d339f3e39861bfdc9bf64fc983d9b03e15708f4323d3f9987da1ae70c7bc973b8cfecb7cc7568a1078957f7eef6ba9a8e1f5c533f50a734b2fcc0005f5c2170
-  data.tar.gz: cbbf4ee06b69b396f79cd351c2659458422090d927af7584f31eab4e8e4fe1bcc4019cb21b90f2695ddbfe2683199afd412a4f6bad11ddf61365cb182a26f55f
+  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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_error
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - kuboon
@@ -38,14 +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/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