breath 0.1.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cf89b5445e113d7198d4a9a9aa4ddfc1af8a09c0faec9eb4af344ad151b2af1
-  data.tar.gz: 3efb2e128154bc6e7c0ecbfad3997d338f15d871f7c898d3ab943d53e7aecd91
+  metadata.gz: f7a68cdfbe3fc69697178c18e1d8f73d62028a2a3d659334daaa06724333f568
+  data.tar.gz: ad43f74a1fedfaf4c900c5b78f8d99f59098c1a516bb87ab08b19447dcf3a2e3
 SHA512:
-  metadata.gz: 1e267a0b8ec0aee65ad28e47d3c3e58daceddb9f37e019c6ea548e61906af86d413ab266c64b35a444c3bac4876c67cb27578a737984d79b8e9161dfdbc9f4d8
-  data.tar.gz: 1b2d1fbbb58ac30cd6e7a3dd3283ba33f807724cf962e96f1cbc1b0c228bb7fcda18854ee27a368173616fc5bb46b373ab0162e3f3e401ee4e31c32c7ff88efc
+  metadata.gz: df992b967d1f6ec8e5ef6339323c5a42a6b680b4e819b6a7c15eb046971e4c000c4ff9569705fd277dc2201be3711988b6b8ea3c70a2e77b6c2f3e760dfa6886
+  data.tar.gz: 6e206371189f9c6aea5651daa5fcf75c6341948b7f6ff9ee996314c8a9584f3ebaef87db6bedde7cdaf6960801897d85ca542cc80e675f03d92194a3af5db98a

data/README.md

@@ -86,6 +86,24 @@ end
 `Breath::ApplicationControllerHelper` intoroduce the user's authorization.<br/>
 `Breath::SessionsControllerHelper` introduce the actions `login`, and `logout`.
 
+Then, you don't need write the codes to introduce authorizations.<br/>
+
+You can use `current_user` method which is current logined user.
+
+#### Route
+Write `route.rb`
+```ruby
+Rails.application.routes.draw do
+  breath :users
+
+  ...or...
+
+  breath :users do
+    get "test" => "sessions#test"
+  end
+end
+```
+
 After you added these lines, show `bundle exec rails routes` command.<br/>
 You can see these routes are added.
 ```
@@ -93,8 +111,7 @@ GET /users/login
 POST /users/login
 DELETE /users/logout
 ```
-
-Then, you don't need write the codes to introduce authorizations.
+Or, nested users routes.
 
 #### Config
 This plugin need cookie, and you can configure the cookie expires like bellow.<br/>
@@ -109,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}"
@@ -20,7 +24,7 @@ module Breath
 
         raise AuthenticationError if target.nil?
       rescue StandardError => e
-        send :render_401, e.to_s
+        send :render_401, e
       end
 
       define_method current_target do
@@ -66,6 +70,12 @@ module Breath
   
       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)

data/lib/breath/controller/sessions_controller_helper.rb

@@ -29,7 +29,7 @@ module Breath
 
         render status: 200
       rescue StandardError => e
-        send :render_401, e.to_s
+        send :render_401, e
       end
 
       # DELETE /schedule_kun/target/logout

data/lib/breath/version.rb

@@ -1,3 +1,3 @@
 module Breath
-  VERSION = "0.1.3"
+  VERSION = "0.3.1"
 end

metadata

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