breath 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2785b5ee6dbd2e81dad460ef63f97dcfcb481e93e72d1805019c12911766e55
-  data.tar.gz: 29c3bcfc6c28916d7a5dbf54bb9937688f008d938c2d27135219f4ec34c6dd72
+  metadata.gz: 1cf89b5445e113d7198d4a9a9aa4ddfc1af8a09c0faec9eb4af344ad151b2af1
+  data.tar.gz: 3efb2e128154bc6e7c0ecbfad3997d338f15d871f7c898d3ab943d53e7aecd91
 SHA512:
-  metadata.gz: 6749ed6e952b1da8a7e5074f33810293c63d1e1629df7390319f6d4e28fa79948df168c25abb1cc0b5d457c30648fd427a62b089c9b40eef6df2892bb9a4a517
-  data.tar.gz: fb538d0d914d31c9e693b64fe24bcc7d615b7c6bacb77fcb70b9c82d05b425614cb94d902fc8e8301383f3a6ea8705f2d5389895ee437489a2f5630d965b246a
+  metadata.gz: 1e267a0b8ec0aee65ad28e47d3c3e58daceddb9f37e019c6ea548e61906af86d413ab266c64b35a444c3bac4876c67cb27578a737984d79b8e9161dfdbc9f4d8
+  data.tar.gz: 1b2d1fbbb58ac30cd6e7a3dd3283ba33f807724cf962e96f1cbc1b0c228bb7fcda18854ee27a368173616fc5bb46b373ab0162e3f3e401ee4e31c32c7ff88efc

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,101 @@ 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`.
+
+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
+```
+
+Then, you don't need write the codes to introduce authorizations.
+
+#### 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/sessions_controller_helper.rb

@@ -44,7 +44,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.1.3"
 end

metadata

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