passwd 0.1.3 → 0.4.0

data/Rakefile

@@ -1,9 +1,8 @@
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
-desc "Run all specs"
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = ["-c", "-fs"]
-end
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task :default => :spec
+task :default => %i(spec rubocop)

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "passwd"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --path .bundle
+
+# Do any other automated setup that you need to do here

data/lib/generators/passwd/install/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Create Passwd config file.
+
+Example:
+    rails generate passwd:install

data/lib/generators/passwd/install/install_generator.rb

@@ -0,0 +1,10 @@
+module Passwd::Generators
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    desc "Create Passwd config file"
+    def create_config_file
+      copy_file "passwd.rb", "config/initializers/passwd.rb"
+    end
+  end
+end

data/lib/generators/passwd/install/templates/passwd.rb

@@ -0,0 +1,21 @@
+Passwd.current.config.tap do |config|
+  # Number of hashed by stretching
+  # Minimum is 4, maximum is 31, default is 12.
+  # See also BCrypt::Engine
+  # config.stretching = 12
+
+  # Random generate password length
+  # config.length = 10
+
+  # Array of characters used for random password generation
+  # config.characters = [("a".."z"), ("A".."Z"), ("0".."9")].map(&:to_a).flatten
+end
+
+# Session key for authentication
+# Rails.application.config.passwd.session_key = :user_id
+
+# Authentication Model Class
+# Rails.application.config.passwd.auth_class = :User
+
+# Redirect path when not signin
+# Rails.application.config.passwd.signin_path = :signin_path

data/lib/passwd.rb

@@ -1,8 +1,35 @@
-# coding: utf-8
+require "bcrypt"
+require "passwd/version"
+require "passwd/errors"
+require "passwd/config"
+require "passwd/railtie" if defined?(Rails)
 
-require "digest/sha1"
+class Passwd
+  class << self
+    def current
+      @current ||= new
+    end
 
-require "passwd/version"
-require "passwd/base"
-require "passwd/password"
-require "passwd/active_record"
+    attr_writer :current
+  end
+
+  def initialize(conf = nil)
+    @config = conf
+  end
+
+  def password_hashing(plain)
+    BCrypt::Password.create(plain, cost: config.stretching.clamp(BCrypt::Engine::MIN_COST, BCrypt::Engine::MAX_COST))
+  end
+
+  def load_password(hashed_password)
+    BCrypt::Password.new(hashed_password)
+  end
+
+  def random(long = nil)
+    Array.new(long || config.length) { config.characters[rand(config.characters.size)] }.join
+  end
+
+  def config
+    @config ||= Config.new
+  end
+end

data/lib/passwd/config.rb

@@ -0,0 +1,27 @@
+class Passwd
+  class Config
+    VALID_OPTIONS = [
+      :stretching,
+      :length,
+      :characters,
+    ].freeze
+
+    attr_accessor(*VALID_OPTIONS)
+
+    def initialize(options = {})
+      reset
+      merge(options)
+    end
+
+    def merge(options)
+      options.each_key {|key| send("#{key}=", options[key]) }
+      self
+    end
+
+    def reset
+      @stretching = 12
+      @length     = 10
+      @characters = [("a".."z"), ("A".."Z"), ("0".."9")].map(&:to_a).flatten
+    end
+  end
+end

data/lib/passwd/errors.rb

@@ -0,0 +1,4 @@
+class Passwd
+  class UnauthorizedAccess < StandardError; end
+  class ContainsBinaryCharacter < StandardError; end
+end

data/lib/passwd/rails/action_controller_ext.rb

@@ -0,0 +1,78 @@
+module Passwd::Rails
+  module ActionControllerExt
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :current_user, :signin?
+    end
+
+    private
+
+      def current_user
+        return @current_user if instance_variable_defined?(:@current_user)
+
+        @current_user = _auth_class.find_by(id: session[_auth_key])
+      end
+
+      def signin?
+        current_user.present?
+      end
+
+      def signin(user)
+        if user.present?
+          @current_user = user
+          session[_auth_key] = user&.id
+        end
+
+        user.present?
+      end
+
+      def signout
+        session[_auth_key] = nil
+        @current_user = nil
+      end
+
+      def redirect_to_referer_or(path, options = {})
+        redirect_to session[:signin_referer].presence || path, **options
+      end
+
+      def require_signin
+        return if signin?
+
+        path = _signin_path
+        raise UnauthorizedAccess unless path
+
+        session[:signin_referer] = request.fullpath
+        redirect_to path
+      end
+
+      def passwd_auth_class
+        nil
+      end
+
+      def passwd_auth_key
+        nil
+      end
+
+      def passwd_signin_path
+        nil
+      end
+
+      def _auth_class
+        (Rails.application.config.passwd.auth_class || passwd_auth_class || :User).to_s.constantize
+      end
+
+      def _auth_key
+        Rails.application.config.passwd.session_key || passwd_auth_key || :user_id
+      end
+
+      def _signin_path
+        name = Rails.application.config.passwd.signin_path || passwd_signin_path || :signin_path
+        _url_helpers.respond_to?(name) ? _url_helpers.public_send(name) : nil
+      end
+
+      def _url_helpers
+        Rails.application.routes.url_helpers
+      end
+  end
+end

data/lib/passwd/rails/active_record_ext.rb

@@ -0,0 +1,35 @@
+module Passwd::Rails
+  module ActiveRecordExt
+    def with_authenticate(passwd: nil, user_id: :email, password: :password)
+      passwd ||= Passwd.current
+      define_singleton_auth_with_passwd(user_id)
+      define_instance_auth_with_passwd(passwd, password)
+      define_instance_set_password(passwd, password)
+    end
+
+    private
+
+      def define_singleton_auth_with_passwd(user_id_col)
+        define_singleton_method :authenticate do |user_id, plain|
+          user = find_by(user_id_col => user_id)
+          return nil unless user
+
+          user.authenticate(plain) ? user : nil
+        end
+      end
+
+      def define_instance_auth_with_passwd(passwd, password_col)
+        define_method :authenticate do |plain|
+          BCrypt::Password.new(send(password_col)) == plain
+        end
+      end
+
+      def define_instance_set_password(passwd, password_col)
+        define_method :set_password do |plain = nil|
+          plain ||= passwd.random
+          send("#{password_col}=", passwd.password_hashing(plain))
+          plain
+        end
+      end
+  end
+end

data/lib/passwd/railtie.rb

@@ -0,0 +1,18 @@
+class Passwd
+  class Railtie < ::Rails::Railtie
+    config.passwd = ActiveSupport::OrderedOptions.new
+
+    initializer "passwd" do
+      require "passwd/rails/action_controller_ext"
+      require "passwd/rails/active_record_ext"
+
+      ActiveSupport.on_load(:action_controller) do
+        ::ActionController::Base.include ::Passwd::Rails::ActionControllerExt
+      end
+
+      ActiveSupport.on_load(:active_record) do
+        ::ActiveRecord::Base.extend Passwd::Rails::ActiveRecordExt
+      end
+    end
+  end
+end

data/lib/passwd/version.rb

@@ -1,5 +1,3 @@
-# coding: utf-8
-
-module Passwd
-  VERSION = "0.1.3"
+class Passwd
+  VERSION = "0.4.0".freeze
 end

data/passwd.gemspec

@@ -1,23 +1,32 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'passwd/version'
+require "passwd/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "passwd"
   spec.version       = Passwd::VERSION
   spec.authors       = ["i2bskn"]
-  spec.email         = ["i2bskn@gmail.com"]
-  spec.description   = %q{The various utilities on password}
-  spec.summary       = %q{Password utility}
+  spec.email         = ["iiboshi@craftake.co.jp"]
+
+  spec.description   = "Passwd is provide hashed password creation and authentication."
+  spec.summary       = "Passwd is provide hashed password creation and authentication."
   spec.homepage      = "https://github.com/i2bskn/passwd"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.add_dependency "bcrypt", "~> 3.1.0"
+  spec.add_development_dependency "bundler", ">= 2.1.0"
+  spec.add_development_dependency "pry", "~> 0.14.0"
+  spec.add_development_dependency "rake", "~> 13.0.0"
+  spec.add_development_dependency "rspec", "~> 3.10.0"
+  spec.add_development_dependency "rubocop", "1.11.0"
 end

metadata

@@ -1,118 +1,148 @@
 --- !ruby/object:Gem::Specification
 name: passwd
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.4.0
 platform: ruby
 authors:
 - i2bskn
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2013-09-15 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
-description: The various utilities on password
+        version: 1.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+description: Passwd is provide hashed password creation and authentication.
 email:
-- i2bskn@gmail.com
+- iiboshi@craftake.co.jp
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .travis.yml
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
+- lib/generators/passwd/install/USAGE
+- lib/generators/passwd/install/install_generator.rb
+- lib/generators/passwd/install/templates/passwd.rb
 - lib/passwd.rb
-- lib/passwd/active_record.rb
-- lib/passwd/base.rb
-- lib/passwd/configuration/abstract_config.rb
-- lib/passwd/configuration/config.rb
-- lib/passwd/configuration/policy.rb
-- lib/passwd/configuration/tmp_config.rb
-- lib/passwd/password.rb
+- lib/passwd/config.rb
+- lib/passwd/errors.rb
+- lib/passwd/rails/action_controller_ext.rb
+- lib/passwd/rails/active_record_ext.rb
+- lib/passwd/railtie.rb
 - lib/passwd/version.rb
 - passwd.gemspec
-- samples/activerecord/user.rake
-- spec/passwd/active_record_spec.rb
-- spec/passwd/base_spec.rb
-- spec/passwd/configuration/config_spec.rb
-- spec/passwd/configuration/policy_spec.rb
-- spec/passwd/configuration/tmp_config_spec.rb
-- spec/passwd/password_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/i2bskn/passwd
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.0
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: Password utility
-test_files:
-- spec/passwd/active_record_spec.rb
-- spec/passwd/base_spec.rb
-- spec/passwd/configuration/config_spec.rb
-- spec/passwd/configuration/policy_spec.rb
-- spec/passwd/configuration/tmp_config_spec.rb
-- spec/passwd/password_spec.rb
-- spec/spec_helper.rb
+summary: Passwd is provide hashed password creation and authentication.
+test_files: []