passwd 0.1.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fcb00a834c359109c28cbe26c845b8baa2ec93b7
-  data.tar.gz: 07cff7e7538f4f59889fecad96ab0715edd9ee05
+SHA256:
+  metadata.gz: f9a0399d0e6b478da6e96ad38e2806fb32199bae624d5bddf4abd5093d652cf8
+  data.tar.gz: 6b7a805295dcd19b924156838b24463cbdd9bf233280027cf3ce49d4abeeb9df
 SHA512:
-  metadata.gz: cc8ac70bace4de95e9ae1d9d6f05b16843b1c27d3c2af09b748c38100db9f79105a991da929a387b9bf76733b57a7885d98238fccc27f9b7b9b5ca5bd5af804b
-  data.tar.gz: b53e2c20abb856f932de3612a63f0cde50d6d7498ec233b7bc2a3652899c6420d63801ee5e1901c1adf7b32b0a9c6a5040f462d4ce3ab7ac21cce4dc0f20d1f9
+  metadata.gz: 99d186d8eb981e43d3ece62f8d96c74ec84cb328d5d5fc56338d322cd9e0cef8f626ef405647eaad01e5cb0fda7e1af3f077beed16ec2fe9adc2798bc3ad9fa7
+  data.tar.gz: 7498777e9c67f19b18be0e4c1119fa810551bc4a2fc01411ac1ada816879fce1c2b16d9f31635e1f0426aa2c1486af985dc5b47894529a3b31e657457b5ec748

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake spec
+    - name: Run rubocop
+      run: bundle exec rake rubocop

data/.gitignore

@@ -1,17 +1,11 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/Gemfile.lock
+/.rspec_status

data/.rubocop.yml

@@ -0,0 +1,168 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  Exclude:
+    - "node_modules/**/*"
+    - "vendor/**/*"
+
+# Private methods indent.
+Layout/IndentationConsistency:
+  EnforcedStyle: indented_internal_methods
+
+# Warning: 120 characters
+# Error:   160 characters
+# Make the library more restrictive.
+Layout/LineLength:
+  Max: 120
+
+# Multi-line indentation with receiver.
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+Layout/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+# May define constants within the block in spec.
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+Lint/InheritException:
+  EnforcedStyle: standard_error
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 24
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"
+    - "Gemfile"
+    - "*.gemspec"
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 20
+
+Security/YAMLLoad:
+  Enabled: false
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/CollectionMethods:
+  PreferredMethods:
+    detect: "detect"
+    find: "detect"
+    inject: "inject"
+    reduce: "inject"
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+# Do not use frozen_string_literal comment.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashSyntax:
+  Exclude:
+    - "Rakefile"
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/MixinUsage:
+  Exclude:
+    - "bin/setup"
+
+# Use _ when 7 digits or more.
+Style/NumericLiterals:
+  MinDigits: 7
+  Strict: true
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/OrAssignment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# `has_xxx?` is more readable.
+Style/PreferredHashMethods:
+  EnforcedStyle: verbose
+
+# Do not use unnecessary returns. (Allow to return multiple values.)
+Style/RedundantReturn:
+  AllowMultipleReturnValues: true
+
+# Do not specify error class when rescuing StandardError.
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+# String literals use double quotes.
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# String literal inside the string interpolation use double quotes too.
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+# Percent(`%i(a b)`) and brackets(`[:a, :b]`) are acceptable.
+Style/SymbolArray:
+  Enabled: false
+
+# Put a trailing comma in argument list.
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+# Put a trailing comma in Array literal.
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+# Put a trailing comma in Hash literal.
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+# Percent(`%w(a b)`) and brackets(`["a", "b"]`) are acceptable.
+Style/WordArray:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/Gemfile

@@ -1,9 +1,6 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in passwd.gemspec
 gemspec
-
-group :test do
-  gem 'coveralls', require: false
-  gem 'simplecov', require: false
-end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-2018 Ken Iiboshi
+
+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

@@ -1,207 +1,158 @@
 # Passwd
 
-[![Gem Version](https://badge.fury.io/rb/passwd.png)](http://badge.fury.io/rb/passwd)
-[![Build Status](https://travis-ci.org/i2bskn/passwd.png?branch=master)](https://travis-ci.org/i2bskn/passwd)
-[![Coverage Status](https://coveralls.io/repos/i2bskn/passwd/badge.png?branch=master)](https://coveralls.io/r/i2bskn/passwd?branch=master)
-[![Code Climate](https://codeclimate.com/github/i2bskn/passwd.png)](https://codeclimate.com/github/i2bskn/passwd)
+[![Gem Version](https://badge.fury.io/rb/passwd.svg)](http://badge.fury.io/rb/passwd)
 
-Password utilities.
+Passwd is provide hashed password creation and authentication.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'passwd'
+gem "passwd"
 ```
 
 And then execute:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install passwd
-
-## Usage
-
-```ruby
-require 'passwd'
 ```
-
-### Create random password
-
-```ruby
-password = Passwd.create
+$ bundle install
 ```
 
-### Hashing password
+Create config file(Only Rails) with:
 
-Hashing with SHA1.
-
-```ruby
-password_hash = Passwd.hashing(password)
 ```
-
-### Password settings
-
-Default config is stored in the class instance variable.
-Changing the default configs are as follows:
-
-```ruby
-Passwd.config # => Get config object.
-Passwd.config(length: 10) # => Change to the default length.
-
-Passwd.configure do |c|
-  c.length = 10
-end
+$ bundle exec rails generate passwd:install
 ```
 
-Options that can be specified:
+The following file will be created.  
+See [config](https://github.com/i2bskn/passwd/blob/master/lib/generators/passwd/install/templates/passwd.rb) if not Rails.
 
-* :length => Number of characters. default is 8.
-* :lower => Skip lower case if set false. default is true.
-* :upper => Skip upper case if set false. default is true.
-* :number => Skip numbers if set false. default is true.
-* :letters_lower => Define an array of lower case. default is ("a".."z").to_a
-* :letters_upper => Define an array of upper case. default is ("A".."Z").to_a
-* :letters_number => Define an array of numbers. default is ("0".."9").to_a
+- `config/initializers/passwd.rb`
 
-### Policy check
+## Usage
 
-Default policy is 8 more characters and require lower case and require number.
+### Ruby
 
 ```ruby
-Passwd.policy_check("secret") # => true or false
+passwd = Passwd.current
+passwd.random(10) # Create random password of 10 characters.
+password = passwd.password_hashing("secret") # Create hashed password from plain text.
+password == "secret" # => true
+load_password = passwd.load_password("hashed_password") # Load hashed password.
+load_password == "secret"
 ```
 
-### Policy settings
+### ActiveRecord with Rails
+
+Add authentication to your `User` model.  
+Model name is `User` by default, but can be changed in configuration file.
 
 ```ruby
-Passwd.policy_configure do |c|
-  c.min_length = 10
+class User < ActiveRecord::Base
+  with_authenticate
 end
 ```
 
-Options that can be specified:
+#### Options
 
-* :min_length => Number of minimum characters. default is 8.
-* :require_lower => Require lower case if set true. default is true.
-* :require_upper => Require upper case if set true. default is false.
-* :require_number => Require number if set true. default is true.
+User model The following column are required.  
+Column name can be changed with the specified options.
 
-### Password object
+- `:id => :email` Unique value to be used for authentication.
+- `:password => :password` Column of String to save the hashed password.
 
-Default password is randomly generated.
-Default salt is "#{Time.now.to_s}".
+Use the `name` column as id.
 
 ```ruby
-password = Passwd::Password.new
-password.text # return text password.
-password.salt_text # return text salt.
-password.salt_hash # return hash salt.
-password.hash # return hash password.
+class User < ActiveRecord::Base
+  with_authenticate id: :name
+end
 ```
 
-Options that can be specified:
+#### Authenticate
 
-* :password => Text password. default is random.
-* :salt_text => Text salt. default is #{Time.now.to_s}.
-
-Password authenticate:
+`authenticate` method is available in both instance and class.  
+Returns user object if the authentication successful.  
+Returns nil if authentication fails or doesn't exists user.  
+Instance method is not required `id`.
 
 ```ruby
-password = Passwd::Password.new
-Passwd.auth(password.text, password.salt_hash, password.hash) # => true
-Passwd.auth("invalid!!", password.salt_hash, password.hash) # => false
-
-password == password.text # => true
-password == "invalid!!" # => false
+user = User.authenticate(params[:email], params[:password]) # Returns user object or nil.
+user.authenticate(params[:password]) # Returns true if authentication succeeded.
 ```
 
-## For ActiveRecord
-
-### User model
-
-Include `Passwd::ActiveRecord` module and define id/salt/password column from `define_column` method.  
-`id` column is required uniqueness.
+`set_password` method will be set random password.  
+To specify password as an argument if you want to specify a password.  
 
 ```ruby
-class User < ActiveRecord::Base
-  include Passwd::ActiveRecord
-  # if not specified arguments for define_column => {id: :email, salt: :salt, password: :password}
-  define_column id: :id_colname, salt: :salt_colname, password: :password_colname
+current_user.set_password("secret") # Set random password if not specified a argument.
+current_user.save
 
-  ...
-end
+new_user = User.new
+random_plain_password = new_user.set_password
+UserMailer.register(new_user, random_plain_password).deliver!
 ```
 
-Available following method by defining id/salt/password column.
+### ActionController
 
-### Authentication
+Already several methods is available in your controller.
 
-`authenticate` method is available in both instance and class.  
-Return the user object if the authentication successful.  
-Return the nil if authentication fails or doesn't exists user.
+If you want to authenticate the application.  
+Unauthorized access is thrown exception.  
+Can be specified to redirect in configuration file.
 
 ```ruby
-user = User.authenticate("foo@example.com", "secret") # => return user object or nil.
-
-if user
-  puts "Hello #{user.name}!"
-else
-  puts "Authentication failed"
+class ApplicationController < ActionController::Base
+  before_action :require_signin
 end
 ```
 
-instance method is not required `id`.
+If you want to implement the session management.
 
 ```ruby
-user = User.find(params[:id])
-if user.authenticate("secret") # => return true or false
-  puts "Authentication is successful!"
-else
-  puts "Authentication failed!"
+class SessionsController < ApplicationController
+  # If you has been enabled `require_signin` in ApplicationController
+  skip_before_action :require_signin
+
+  # GET /signin
+  def new; end
+
+  # POST /signin
+  def create
+    # Returns nil or user
+    @user = User.authenticate(params[:email], params[:password])
+
+    if @user
+      # Save user_id to session
+      signin(@user)
+      redirect_to_referer_or some_path, notice: "Signin was successful. Hello #{current_user.name}"
+    else # Authentication fails
+      render action: :new
+    end
+  end
+
+  # DELETE /signout
+  def destroy
+    # Clear session (Only user_id)
+    signout
+    redirect_to some_path
+  end
 end
 ```
 
-### Change passowrd
-
-`set_password` method will be set random password.  
-Return value is plain text password.  
-To specify the password as an argument if you want to specify a password.  
-`salt` also set if salt is nil.
+`current_user` and `signin?` method available in controllers and views.
 
 ```ruby
-user = User.find(params[:id])
-password_text = user.set_password
-
-if user.save
-  NoticeMailer.change_mail(user, password_text).deliver
+def greet
+  name = signin? ? current_user.name : "Guest"
+  render text: "Hello #{name}!!"
 end
 ```
-`update_password` method will be set new password if the authentication successful.  
-Return the nil if authentication fails.  
-But `update_password` method doesn't call `save` method.
 
-```ruby
-@user = User.find(params[:id])
+## Contributing
 
-if Passwd.confirm_check(params[:new_pass], params[:new_pass_confirm])
-  if @user.update_password(old_pass, new_pass) && @user.save # => return new password(text) or false
-    NoticeMailer.change_mail(user, password_text).deliver
-  else
-    puts "Authentication failed!"
-  end
-else
-  puts "Password don't match!"
-end
-```
+Bug reports and pull requests are welcome on GitHub at https://github.com/i2bskn/passwd.
 
-## Contributing
+## License
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).