breath 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '00738e8ac9332e8c99ac5dc5e392836a393433ea3701a435e95ea4d0d16f9413'
+  data.tar.gz: ff403849fbcffcf621f92d3c58ca32148c3f25fee31609aa3bb310d07dc74f3a
+SHA512:
+  metadata.gz: ecc5d2e65d8b180a8894177925d9918b144f41f2daa60ec3cdafd24a476b50d1f82e1d7be715d56a128bec8d62dc327f80df99a67ee4c5f1feb76441d108f57b
+  data.tar.gz: eea3081deac0324cc3eb3fa890770c59532c8374e35e64b41f479f0e66c74f51baaa876261bb56c0946a735d9ccf967368b8bc9ea460149695eabf87ac44ce39

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 testCodeV01
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Breath
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "breath"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install breath
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/breath/config/route.rb

@@ -0,0 +1,11 @@
+class ActionDispatch::Routing::Mapper
+  def breath(routes_name, &resources)
+    namespace routes_name do
+      get "/login" => "sessions#new"
+      post "login" => "sessions#login"
+      delete "logout" => "sessions#logout"
+
+      resources.call if resources.present?
+    end
+  end
+end

data/lib/breath/controller/application_controller_helper.rb

@@ -0,0 +1,80 @@
+module Breath
+  module ApplicationControllerHelper
+    extend ActiveSupport::Concern
+
+    class AuthenticationError < StandardError; end
+
+    included do
+      target_class = to_s.split("::")[-2].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 current_target.nil?
+        raise AuthenticationError unless current_target.remember?(cookies[:remember_token])
+
+        target = target_class.enabled.find_by(id: cookies.signed["#{target_name}_id".to_sym])
+
+        raise AuthenticationError if target.nil?
+      rescue StandardError => e
+        send :render_401, e.to_s
+      end
+
+      define_method current_target do
+        @current_target ||= target_class.enabled.find_by(id: cookies.signed["#{target_name}_id".to_sym])
+      end
+    end
+
+    class_methods do
+      def crsf_protect(value)
+        if value
+          # include ActionController::HttpAuthentication::Token::ControllerMethods
+          include ActionController::RequestForgeryProtection
+          protect_from_forgery with: :exception
+          after_action :set_csrf_token_header
+
+          define_method :set_csrf_token_header do
+            response.header["X-CSRF-Token"] = form_authenticity_token
+          end
+        end
+      end
+    end
+
+    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_500(res)
+      Rails.logger.error error_message(res)
+  
+      render json: res, status: 500
+    end
+  
+    def error_message(error)
+      "[ERROR] #{error.to_s}"
+    end
+  end
+end

data/lib/breath/controller/sessions_controller_helper.rb

@@ -0,0 +1,61 @@
+module Breath
+  module SessionsControllerHelper
+    extend ActiveSupport::Concern
+
+    class InvalidPasswordConfirmation < StandardError; end
+    class TargetNotFound < StandardError; end
+    class InvalidPassword < StandardError; end
+
+    included do
+      target_class = to_s.split("::")[-2].singularize.constantize
+      target_name = target_class.to_s.underscore
+      current_target = "current_#{target_name}"
+
+      skip_before_action :authenticate!, only: %i[new login logout]
+
+      # GET /schedule_kun/target/login
+      define_method :new do
+        render status: 200
+      end
+
+      # POST /schedule_kun/target/login
+      define_method :login do
+        object = target_class.enabled.find_by(**{ "#{target_class.auth_attribute}": sessions_params[target_class.auth_attribute.to_sym] })
+        raise TargetNotFound if object.nil?
+        raise InvalidPassword unless object.authenticate(sessions_params[:password])
+
+        object.remember
+        write_cookie(target_name, object)
+
+        render status: 200
+      rescue StandardError => e
+        send :render_401, e.to_s
+      end
+
+      # DELETE /schedule_kun/target/logout
+      define_method :logout do
+        send(current_target)&.forget
+        @current_target = nil
+
+        cookies.delete("#{target_name}_id".to_sym)
+        cookies.delete(:remember_token)
+
+        render status: 200
+      end
+
+      define_method :sessions_params do
+        params.require(:sessions).permit(target_class.auth_attribute.to_sym, :password, :password_confirmation)
+      end
+    end
+
+    def write_cookie(target_name, object)
+      if Rails.application.config.respond_to? :breath_expires
+        cookies.signed["#{target_name}_id".to_sym] = { value: object.id, expires: Rails.application.config.breath_expires }
+        cookies[:remember_token] = { value: object.remember_token, expires: Rails.application.config.breath_expires }
+      else
+        cookies.permanent.signed["#{target_name}_id".to_sym] = object.id
+        cookies.permanent[:remember_token] = object.remember_token
+      end
+    end
+  end
+end

data/lib/breath/model/breath_model.rb

@@ -0,0 +1,48 @@
+module Breath::Model
+  extend ActiveSupport::Concern
+
+  attr_accessor :remember_token
+
+  class_methods do
+    # 与えられた文字列のハッシュ値を返す
+    def digest(string)
+      cost = ActiveModel::SecurePassword.min_cost ? BCrypt::Engine::MIN_COST :
+                                                    BCrypt::Engine.cost
+      BCrypt::Password.create(string, cost: cost)
+    end
+
+    # ランダムなトークンを返す
+    def new_token
+      SecureRandom.urlsafe_base64
+    end
+
+    def attr_breath(attribute)
+      class_attribute :auth_attribute, default: attribute
+    end
+
+    unless respond_to?(:enabled)
+      define_method :enabled do
+        self
+      end
+    end
+  end
+
+  included do
+    has_secure_password
+  end
+
+  # 永続的セッションで使用するユーザーをデータベースに記憶する
+  def remember
+    self.remember_token = self.class.new_token
+    update_attribute(:remember_digest, self.class.digest(remember_token))
+  end
+
+  # 渡されたトークンがダイジェストと一致したらtrueを返す
+  def remember?(remember_token)
+    BCrypt::Password.new(remember_digest).is_password?(remember_token)
+  end
+
+  def forget
+    update_attribute(:remember_digest, nil)
+  end
+end

data/lib/breath/railtie.rb

@@ -0,0 +1,4 @@
+module Breath
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/breath/version.rb

@@ -0,0 +1,3 @@
+module Breath
+  VERSION = "0.1.0"
+end

data/lib/breath.rb

@@ -0,0 +1,10 @@
+require "breath/version"
+require "breath/railtie"
+require "breath/controller/application_controller_helper.rb"
+require "breath/controller/sessions_controller_helper.rb"
+require "breath/config/route.rb"
+require "breath/model/breath_model.rb"
+
+module Breath
+  # Your code goes here...
+end

data/lib/tasks/breath_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :breath do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: breath
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- testCodeV01
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Breath is a simple authentication gem. Easy introduce login and logout.
+email:
+- qft-tk-1213@tk-labo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/breath.rb
+- lib/breath/config/route.rb
+- lib/breath/controller/application_controller_helper.rb
+- lib/breath/controller/sessions_controller_helper.rb
+- lib/breath/model/breath_model.rb
+- lib/breath/railtie.rb
+- lib/breath/version.rb
+- lib/tasks/breath_tasks.rake
+homepage: https://github.com/testCodeV01
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/testCodeV01
+  source_code_uri: https://github.com/testCodeV01/breath
+  changelog_uri: https://github.com/testCodeV01
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Simple authentication gem.
+test_files: []