breath 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76b40953cb6e71c98a7870cc2a90360ff11e7dbfeeacb38ba02ec212ac8995d3
-  data.tar.gz: 7324b79742b9329015d3e527a6ed5c0abe5402e999933626fb912c2b004e017f
+  metadata.gz: f7a68cdfbe3fc69697178c18e1d8f73d62028a2a3d659334daaa06724333f568
+  data.tar.gz: ad43f74a1fedfaf4c900c5b78f8d99f59098c1a516bb87ab08b19447dcf3a2e3
 SHA512:
-  metadata.gz: f9c1a788f8de0f6765fc943e721f6d468fc44a57174951c5b0a4e02b9fe93971bd194d835e407dcbc8dac905997a88b1bf22fbb8d6166cd8580ddba857b3af87
-  data.tar.gz: 53d89f967a23d992c47d9692f7c8cd9270a1f51422f9bfaf6b17b8a2d11d2cd53ba76eadc525ffd54d8b257e957910a3b089c913f1605dc2331e410dade80743
+  metadata.gz: df992b967d1f6ec8e5ef6339323c5a42a6b680b4e819b6a7c15eb046971e4c000c4ff9569705fd277dc2201be3711988b6b8ea3c70a2e77b6c2f3e760dfa6886
+  data.tar.gz: 6e206371189f9c6aea5651daa5fcf75c6341948b7f6ff9ee996314c8a9584f3ebaef87db6bedde7cdaf6960801897d85ca542cc80e675f03d92194a3af5db98a

data/README.md

@@ -126,6 +126,67 @@ 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
+    render_409 e
+  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.
+```ruby
+class Users::ApplicationController < ApplicationController
+  ...
+
+  def render_500(e)
+    ...
+    super
+  end
+
+  ...
+end
+```
+
 #### 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,6 +5,10 @@ module Breath
     class AuthenticationError < StandardError; end
 
     included do
+      rescue_from StandardError, with: :render_500
+      rescue_from ActionController::InvalidAuthenticityToken, with: :render_422
+
+
       target_class = to_s.split("::")[-2].singularize.constantize
       target_name = target_class.to_s.underscore
       current_target = "current_#{target_name}"

data/lib/breath/controller/sessions_controller_helper.rb

@@ -7,8 +7,6 @@ module Breath
     class InvalidPassword < StandardError; end
 
     included do
-      rescue_from ActionController::InvalidAuthenticityToken, with: :render_422
-
       target_class = to_s.split("::")[-2].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.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: breath
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - testCodeV01