breath 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2785b5ee6dbd2e81dad460ef63f97dcfcb481e93e72d1805019c12911766e55
-  data.tar.gz: 29c3bcfc6c28916d7a5dbf54bb9937688f008d938c2d27135219f4ec34c6dd72
+  metadata.gz: 76b40953cb6e71c98a7870cc2a90360ff11e7dbfeeacb38ba02ec212ac8995d3
+  data.tar.gz: 7324b79742b9329015d3e527a6ed5c0abe5402e999933626fb912c2b004e017f
 SHA512:
-  metadata.gz: 6749ed6e952b1da8a7e5074f33810293c63d1e1629df7390319f6d4e28fa79948df168c25abb1cc0b5d457c30648fd427a62b089c9b40eef6df2892bb9a4a517
-  data.tar.gz: fb538d0d914d31c9e693b64fe24bcc7d615b7c6bacb77fcb70b9c82d05b425614cb94d902fc8e8301383f3a6ea8705f2d5389895ee437489a2f5630d965b246a
+  metadata.gz: f9c1a788f8de0f6765fc943e721f6d468fc44a57174951c5b0a4e02b9fe93971bd194d835e407dcbc8dac905997a88b1bf22fbb8d6166cd8580ddba857b3af87
+  data.tar.gz: 53d89f967a23d992c47d9692f7c8cd9270a1f51422f9bfaf6b17b8a2d11d2cd53ba76eadc525ffd54d8b257e957910a3b089c913f1605dc2331e410dade80743

data/README.md

@@ -1,8 +1,7 @@
 # Breath
-Short description and motivation.
-
-## Usage
-How to use my plugin.
+Rails authentication plugin with API mode.<br />
+Easy introducing login, logout.<br/>
+Compact features set.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,6 +20,118 @@ Or install it yourself as:
 $ gem install breath
 ```
 
+## Usage
+### Introduce
+
+#### Model
+If you want to introduce a authentication to `User` model.<br/>
+Add these lines to `user.rb` like bellow.
+```ruby
+class User < ApplicationRecord
+  include Breath::Model
+
+  attr_breath :email
+end
+```
+Here, with `attr_breath`, you need to specify the user's attribute with authentication.
+
+#### Migration
+In migration file, you need to add `password_digest`, and `remember_digest` attributes.<br/>
+And if you specify the email attribute within `attr_breath`, you need to add `email` attribute in migration file.
+```ruby
+class CreateUsers < ActiveRecord::Migration[7.0]
+  def change
+    create_table :users do |t|
+      t.string :email
+      t.string :password_digest
+      t.string :remember_digest
+
+      t.timestamps
+    end
+  end
+end
+```
+After these lines you added, excute `bundle exec rails db:migrate`.
+
+
+#### Controller
+You need to construct the directory like bellow.
+```
+/app/controllers
+  - application_controller.rb
+
+  /users
+    - application_controller.rb
+    - sessions_controller.rb
+```
+
+- app/contorllers/users/application_controller.rb
+```ruby
+class Users::ApplicationController < ApplicationController
+  include Breath::ApplicationControllerHelper
+  before_action :authenticate!
+
+  crsf_protect true
+end
+```
+Here, if `csrf_protect` is `true`, CSRF protection is enabled.<br/>
+
+- app/controllers/users/sessions_controller.rb
+```ruby
+class Users::SessionsController < Users::ApplicationController
+  include Breath::SessionsControllerHelper
+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.
+```
+GET /users/login
+POST /users/login
+DELETE /users/logout
+```
+Or, nested users routes.
+
+#### Config
+This plugin need cookie, and you can configure the cookie expires like bellow.<br/>
+```ruby
+module YourApp
+  class Application < Rails::Application
+    ...
+
+    config.breath_expires = 3.days
+  end
+end
+```
+If you don't configure this, cookie is set permanently.
+
+#### Last Work
+You need to create view side.<br/>
+In view side, you have remaining works.<br/>
+if you `csrf_protect true`, you need to introduce `withCredentials: true` option in client side.<br/>
+And, write csrf token into the cookie with `csrf_token` key.
+
 ## Contributing
 Contribution directions go here.
 

data/lib/breath/controller/application_controller_helper.rb

@@ -20,7 +20,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 +66,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

@@ -7,6 +7,8 @@ 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}"
@@ -29,7 +31,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
@@ -44,7 +46,7 @@ module Breath
       end
 
       define_method :sessions_params do
-        params.require(:sessions).permit(target_class.auth_attribute.to_sym, :password, :password_confirmation)
+        params.require(:sessions).permit(target_class.auth_attribute.to_sym, :password)
       end
     end
 

data/lib/breath/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breath
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.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