devise_expirable 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0cf5e8c2ae99c23f5d64c2486721a2f160e2f911109c6745fb0c2a8d740977fc
+  data.tar.gz: 1588752214f1b2c808eb1f7f7b154d2ae37ce8f23ed94ae017434a8400f07593
+SHA512:
+  metadata.gz: efc64dfabbc4f8271d6c0243dad3f7d0d15b9f85cf2317eb53e376116bad6ffa5d717eef54382d1961f2397244cdaca455eb8fb4be963937d1576a260ea43afc
+  data.tar.gz: a46e3fc2d945f1a226d9ff8b4c926b9550075e94e25b7eb296aaac864ae8cc75b8ca32b7cfd5212bb390a73ac5ef34da98e3f3d08591545deb36dc08809ab786

data/.gitignore

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 20@4 Yanotec
+
+MIT License
+
+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,110 @@
+# DevisePasswordExpiratable
+
+This is a simple, however wonderful devise extension to expire user password after a period.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'devise_expirable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install devise_expirable
+
+## Usage
+
+    u = User.create(:name => 'John Doe', :password => "john.doe")
+    u.password_expired? # false
+    u.password_still_valid? # true
+    u.active_for_authentication? # true
+    u.inactive_message # nil
+
+    u.update(expiration_password_at: nil)
+    u.password_expired? # true
+    u.password_still_valid? # false
+    u.active_for_authentication? # false
+    u.inactive_message # :password_expired
+
+    u.update(expiration_password_at: 1.second.ago)
+    u.password_expired? # true
+    u.password_still_valid? # false
+    u.active_for_authentication? # false
+    u.inactive_message # :password_expired
+
+    u.update(expiration_password_at: 10.minutes.from_now)
+    u.password_expired? # false
+    u.password_still_valid? # true
+    u.active_for_authentication? # true
+    u.inactive_message # nil
+
+#### Using with ActiveRecord
+You need to create a migration, manually (there is no magic here):
+
+    class DeviseExpirableToUsers < ActiveRecord::Migration
+      def up
+        add_column :users, :expiration_password_at, :timestamp
+        add_index :users, :expiration_password_at
+      end
+
+      def down
+        remove_index :users, :expiration_password_at
+        remove_column :users, :expiration_password_at
+      end
+    end
+
+or
+
+    class DeviseExpirableToUsers < ActiveRecord::Migration
+      def change
+        change_table :users, bulk: true do |t|
+          t.datetime :expiration_password_at
+          t.index :expiration_password_at
+        end
+      end
+    end
+
+
+Include in your model:
+
+    class User < ActiveRecord::Base
+      devise :database_authentication, :expirable
+    end
+
+Adding two wonderful new public methods:
+
+- password_still_valid? : checks whether password still valid
+- password_expired? : checks whether password expired
+
+And modifications to two other methods:
+
+- active_for_authentication? : If password is expired returns false, else it preforms the super method
+- inactive_message : If password is expired returns :password_expired, else it performs the super method
+
+And add a before save callback and a auxiliar callback method:
+
+- change_expiration_password_at : Changes expiration_password_at field ever that encrypted_password field is changed
+- next_password_expiration_time : Returns a datetime with the moment that password will expires, based in password_expirate_in configuration of Devise
+
+And add a devise configuration:
+
+- password_expirate_in : The time you want to reach before any user's password expires. After this period, the user must change the password again. The default is 10 days.
+
+## License
+
+The devise_expirable is hosted on Github: https://github.com/jonathanccalixto/devise_expirable, where your contributions, forkings, comments and feedback are greatly welcomed.
+
+Copyright (c) 2024 Yanotec, released under the MIT license.
+
+
+## Contributing
+
+1. Fork it ( http://github.com/jonathanccalixto/devise_expirable/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run tests for all ORMs.'
+task default: :test
+
+desc 'Run Devise tests for all ORMs.'
+task :pre_commit do
+  Dir[File.join(File.dirname(__FILE__), 'test', 'orm', '*.rb')].each do |file|
+    orm = File.basename(file).split(".").first
+    # "Some day, my son, rake's inner wisdom will reveal itself.  Until then,
+    # take this `system` -- may its brute force protect you well."
+    exit 1 unless system "rake test DEVISE_ORM=#{orm}"
+  end
+end
+
+desc 'Run Devise unit tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+  t.warning = false
+end
+
+desc 'Generate documentation for Devise.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Devise'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  devise:
+    failure:
+      password_expired: "Invalid %{authentication_keys} or password."

data/devise_expirable.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'devise/expirable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "devise_expirable"
+  spec.version       = DeviseExpirable::VERSION
+  spec.authors       = ["Jonathan C. Calixto"]
+  spec.email         = ["jonathanccalixto@gmail.com"]
+  spec.summary       = %q{Expires user password after a period}
+  spec.description   = %q{This is a simple, however wonderful devise extension to expire user password.}
+  spec.homepage      = "https://github.com/jonathanccalixto/devise_expirable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "devise", ">= 2.0"
+end

data/lib/devise/configuration.rb

@@ -0,0 +1,5 @@
+module Devise
+  # Time interval to password expires
+  mattr_accessor :password_expirate_in
+  @@password_expirate_in = 10.days
+end

data/lib/devise/expirable/model.rb

@@ -0,0 +1,53 @@
+require 'devise/strategies/database_authenticatable'
+
+module Devise
+  module Models
+    module Expirable
+      extend ActiveSupport::Concern
+
+      included do
+        before_save :change_expiration_password_at
+      end
+
+      def password_expirate_in
+        self.class.password_expirate_in
+      end
+
+      def active_for_authentication?
+        password_still_valid? && super
+      end
+
+      def password_still_valid?
+        return false unless expiration_password_at
+
+        expiration_password_at >= Time.current
+      end
+
+      def password_expired?
+        !password_still_valid?
+      end
+
+      def inactive_message
+        password_expired? ? :password_expired : super
+      end
+
+      protected
+
+      def next_password_expiration_time
+        password_expirate_in.from_now
+      end
+
+      private
+
+      def change_expiration_password_at
+        return unless encrypted_password_changed?
+
+        self.expiration_password_at = next_password_expiration_time
+      end
+
+      module ClassMethods
+        Devise::Models.config(self, :password_expirate_in)
+      end
+    end
+  end
+end

data/lib/devise/expirable/module.rb

@@ -0,0 +1 @@
+Devise.add_module :expirable, :model => 'devise/expirable/model'

data/lib/devise/expirable/version.rb

@@ -0,0 +1,3 @@
+module DeviseExpirable
+  VERSION = "1.0.1"
+end

data/lib/devise_expirable.rb

@@ -0,0 +1,3 @@
+require 'devise/configuration'
+require 'devise/expirable/version'
+require 'devise/expirable/module'

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: devise_expirable
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Jonathan C. Calixto
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: This is a simple, however wonderful devise extension to expire user password.
+email:
+- jonathanccalixto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/locales/en.yml
+- devise_expirable.gemspec
+- lib/devise/configuration.rb
+- lib/devise/expirable/model.rb
+- lib/devise/expirable/module.rb
+- lib/devise/expirable/version.rb
+- lib/devise_expirable.rb
+homepage: https://github.com/jonathanccalixto/devise_expirable
+licenses:
+- MIT
+metadata: {}
+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.5.6
+signing_key:
+specification_version: 4
+summary: Expires user password after a period
+test_files: []