breath 0.2.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76b40953cb6e71c98a7870cc2a90360ff11e7dbfeeacb38ba02ec212ac8995d3
-  data.tar.gz: 7324b79742b9329015d3e527a6ed5c0abe5402e999933626fb912c2b004e017f
+  metadata.gz: b446e626bff570c9558dae487d91f2ba44ab0fabbfa7fe0638eb087ce49024d7
+  data.tar.gz: 601d49d45595acead536bdc6f9d29fa2821b9960f3664c44a6bb324058c87315
 SHA512:
-  metadata.gz: f9c1a788f8de0f6765fc943e721f6d468fc44a57174951c5b0a4e02b9fe93971bd194d835e407dcbc8dac905997a88b1bf22fbb8d6166cd8580ddba857b3af87
-  data.tar.gz: 53d89f967a23d992c47d9692f7c8cd9270a1f51422f9bfaf6b17b8a2d11d2cd53ba76eadc525ffd54d8b257e957910a3b089c913f1605dc2331e410dade80743
+  metadata.gz: 9c2dff25c5747ddb48469548c8bc0ac7b7ab5e18fd90586097f89f09f50c1648059545fd2c2ea3e8b9c6a780cb5e6f13ac8b30b99e8f1ab62de670c39360f67d
+  data.tar.gz: 4fc570dfabf9638035bf55404585143df9e39a23c185b6c7f32ba7f2faa661bd4df51585484d7b7a3e49b6f73b8c4e29d168b24b89b5751e4ce932daa870f22d

data/README.md

@@ -126,6 +126,57 @@ end
 ```
 If you don't configure this, cookie is set permanently.
 
+#### Error
+When an error occurs when trying to log in or authorize, rescue from the error automatically.
+Otherwise, you can also overwrite rescue method like bellow.<br/>
+`app/controllers/users/application_controller.rb`
+```ruby
+class Users::ApplicationController < ApplicationController
+  ...
+
+  def render_401(e)
+    # Write your programs. Here, e is error class.
+    # e.g. Rails.logger.error(e.to_s)
+
+    super({ error: 111, message: "error occur." })
+  end
+
+  ...
+end
+```
+An argument you pass to super is returned to the client side as JSON value.<br/>
+In addition, breath plugin provides bellow rescue methods.
+```ruby
+render_400
+render_401 # Unauthorized.
+render_404 # Not Found.
+render_409 # Conflict.
+render_422 # Unprocessable Entity.
+render_500 # Internal Server Error.
+```
+You can use these rescue methods in controllers like bellow.
+```ruby
+class Users::HogeController < Users::ApplicationController
+  def index
+    ...
+    render status: 200
+  rescue => e
+    render_404 e
+  end
+
+  def update
+    ...
+    render status: 201
+  rescue => e
+    response_body = { error_code: 100, message: "error" }
+
+    render_409 response_body
+  end
+end
+```
+Breath plugin automatically rescues from CSRF token error which is status 422, and Internal Server Error with status code 500.<br/>
+And you can overwrite these rescue methods.
+
 #### Last Work
 You need to create view side.<br/>
 In view side, you have remaining works.<br/>

data/lib/breath/controller/application_controller_helper.rb

@@ -5,12 +5,15 @@ module Breath
     class AuthenticationError < StandardError; end
 
     included do
-      target_class = to_s.split("::")[-2].singularize.constantize
+      rescue_from StandardError, with: :render_500
+      rescue_from ActionController::InvalidAuthenticityToken, with: :render_422
+
+      target_class = to_s.deconstantize.demodulize.singularize.constantize
       target_name = target_class.to_s.underscore
       current_target = "current_#{target_name}"
 
       include ActionController::Cookies
-    
+
       define_method :authenticate! do
         raise AuthenticationError unless cookies.key?("#{target_name}_id".to_sym)
         raise AuthenticationError if send(current_target).nil?
@@ -45,40 +48,40 @@ module Breath
 
     def render_400(res)
       Rails.logger.error error_message(res)
-  
+
       render json: res, status: 400
     end
-  
+
     def render_401(res)
       Rails.logger.error error_message(res)
-  
+
       render json: res, status: 401
     end
-  
+
     def render_404(res)
       Rails.logger.error error_message(res)
-  
+
       render json: res, status: 404
     end
-  
+
     def render_409(res)
       Rails.logger.error error_message(res)
-  
+
       render json: res, status: 409
     end
 
     def render_422(res)
       Rails.logger.error error_message(res)
-  
+
       render json: res, status: 422
     end
-  
+
     def render_500(res)
       Rails.logger.error error_message(res)
-  
+
       render json: res, status: 500
     end
-  
+
     def error_message(error)
       "[ERROR] #{error.to_s}"
     end

data/lib/breath/controller/sessions_controller_helper.rb

@@ -7,9 +7,7 @@ module Breath
     class InvalidPassword < StandardError; end
 
     included do
-      rescue_from ActionController::InvalidAuthenticityToken, with: :render_422
-
-      target_class = to_s.split("::")[-2].singularize.constantize
+      target_class = to_s.deconstantize.demodulize.singularize.constantize
       target_name = target_class.to_s.underscore
       current_target = "current_#{target_name}"
 

data/lib/breath/version.rb

@@ -1,3 +1,3 @@
 module Breath
-  VERSION = "0.2.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breath
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.2
 platform: ruby
 authors:
 - testCodeV01
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 2023-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails