devise_password_history 0.1.2 → 0.2.0

data/Gemfile

@@ -1,4 +1,10 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in devise_password_history.gemspec
 gemspec
+
+group :test do
+  gem "rake"
+  gem "turn"
+  gem "mocha"
+  gem "minitest"
+end

data/README.md

@@ -30,6 +30,7 @@ That generator will do three things:
 1. Modifies the `config/initializers/devise.rb` file with two new config options:
     - `config.deny_old_passwords`: turns the validations on/off
     - `config.password_history_count`: the threshold of how many passwords to store
+    - `config.password_age`: ability to force password expiration (ex: `90.days`)
 2. Creates an `OldPassword` polymorphic model in `app/models`
 3. Creates the migration for the `old_passwords` table
 
@@ -44,6 +45,30 @@ any of the other extensions:
       devise :database_authenticatable, :password_history
     end
 
+## Notes on Password Age/Expiration
+
+By default, the `password_age` is set to `nil` (which turns this feature off).
+If you want to use it, set it to how often you want passwords to expire, an
+example might be `90.days`.
+
+If a password has expired, the user will be redirected to a 
+`update_password_path` route, which defaults to `edit_admin_user_path(current_user)`.
+You can override this in `ApplicationController` as needed.
+
+    class ApplicationController
+      # ...
+
+    protected
+      def update_password_path
+        your_custom_route_goes_here_path
+      end
+    end
+
+Additionally, the filter that runs to check expired passwords is
+`check_password_expiration`. To prevent this filter from running on the
+controller that does the password updates, you should
+`skip_before_filter :check_password_expiration`.
+
 ## Contributing
 
 1. Fork it

data/devise_password_history.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["ryan@rpheath.com"]
   gem.description   = %q{Maintains password history and ensures old passwords aren't reused}
   gem.summary       = %q{Password history support for devise}
-  gem.homepage      = ""
+  gem.homepage      = "http://github.com/rpheath/devise_password_history"
 
   gem.add_dependency("devise", ["~> 2.2.0"])
 

data/lib/devise_password_history/controllers/helpers.rb

@@ -0,0 +1,41 @@
+module DevisePasswordHistory
+  module Controllers
+    module Helpers
+      extend ActiveSupport::Concern
+
+      included do
+        append_before_filter :check_password_expiration
+      end
+
+    protected  
+      def check_password_expiration
+        # skip if we don't have a user
+        return if current_user.blank?
+        # skip if we're on the controller that needs
+        # to update the passwords (infinite loop otherwise)
+        return if self.class.to_s == update_password_controller.to_s
+
+        if current_user.has_password_expired?
+          flash[:alert] = expired_password_message
+          redirect_to update_password_path 
+        end
+      end
+
+      # path to update passwords (can be overridden)
+      def update_password_path
+        edit_admin_user_path(current_user)        
+      end
+
+      # the controller that handles password 
+      # updating (can be overridden)
+      def update_password_controller
+        "Admin::UsersController"
+      end
+
+      # flash message
+      def expired_password_message
+        "Your password has expired, please choose a new one"
+      end
+    end
+  end
+end

data/lib/devise_password_history/generators/install_generator.rb

@@ -20,6 +20,8 @@ module DevisePasswordHistory
           "  config.password_history_count = 8\n\n" +
           "  # Toggles behavior for Deny/Allow old passwords\n" +
           "  config.deny_old_passwords = true\n\n" +        
+          "  # Repeatedly forces a new password based on this age\n" +
+          "  # config.password_age = 90.days\n\n" +        
           "", :before => /end[\s|\n|]+\Z/
       end
 

data/lib/devise_password_history/models/password_history.rb

@@ -6,7 +6,7 @@ module Devise
       extend ActiveSupport::Concern
 
       module ClassMethods
-        Devise::Models.config(self, :password_history_count, :deny_old_passwords)
+        Devise::Models.config(self, :password_history_count, :deny_old_passwords, :password_age)
       end
 
       included do
@@ -45,6 +45,32 @@ module Devise
         false
       end
 
+      def has_password_expired?
+        # make sure this feature is turned on
+        return false if self.class.password_age.nil?
+
+        # initializing to ensure expired_stamp
+        # exists in case conditions fail below
+        expired_stamp = Time.now
+
+        if self.old_passwords.present?          
+          # since we are tracking old passwords, we can get the 
+          # last time the password was changed
+          password_changed_at = self.old_passwords.order(:created_at).last.created_at
+          # our expired stamp is the password age past the last password change
+          expired_stamp = password_changed_at + self.class.password_age
+        else
+          # if no old passwords exist yet, we can check against
+          # when the user was created and use that timestamp
+          if self.respond_to?(:created_at)
+            expired_stamp = self.created_at + self.class.password_age            
+          end
+        end
+
+        # are we expired?
+        !!(Time.now > expired_stamp)
+      end
+
     protected
       # make sure this is turned on in the Devise config
       def should_deny_old_passwords?

data/lib/devise_password_history/rails.rb

@@ -0,0 +1,7 @@
+module DevisePasswordHistory
+  class Engine < Rails::Engine
+    ActiveSupport.on_load(:action_controller) do
+      include DevisePasswordHistory::Controllers::Helpers
+    end
+  end
+end

data/lib/devise_password_history/version.rb

@@ -1,3 +1,3 @@
 module DevisePasswordHistory
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/devise_password_history.rb

@@ -14,9 +14,19 @@ module Devise
   # Toggles the behavior of denying/allowing old passwords
   mattr_accessor :deny_old_passwords
   @@deny_old_passwords = true
+
+  # Repeatedly forces a new password based on this age
+  mattr_accessor :password_age
+  @@password_age = nil
 end
 
-module DevisePasswordHistory; end
+module DevisePasswordHistory
+  module Controllers
+    autoload :Helpers, "devise_password_history/controllers/helpers"
+  end
+end
 
 # makes this module available to the `devise` command
-Devise.add_module :password_history, :model => "devise_password_history/models/password_history"
+Devise.add_module :password_history, :model => "devise_password_history/models/password_history"
+
+require "devise_password_history/rails"

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require "test/unit"
+require "mocha/setup"
+require "turn"
+
+Test::Unit::TestCase.class_eval do
+  def self.test(name, &block)
+    define_method("test_#{name.to_s.gsub(/\W/,'_')}", &block) if block_given?
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_password_history
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ryan Heath
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-01-14 00:00:00 -05:00
+date: 2014-01-25 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,13 +51,16 @@ files:
 - Rakefile
 - devise_password_history.gemspec
 - lib/devise_password_history.rb
+- lib/devise_password_history/controllers/helpers.rb
 - lib/devise_password_history/generators/install_generator.rb
 - lib/devise_password_history/generators/templates/migrations/create_old_passwords.rb
 - lib/devise_password_history/generators/templates/models/old_password.rb
 - lib/devise_password_history/models/password_history.rb
+- lib/devise_password_history/rails.rb
 - lib/devise_password_history/version.rb
+- test/test_helper.rb
 has_rdoc: true
-homepage: ""
+homepage: http://github.com/rpheath/devise_password_history
 licenses: []
 
 post_install_message: 
@@ -90,5 +93,5 @@ rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Password history support for devise
-test_files: []
-
+test_files: 
+- test/test_helper.rb