has_editable_password 0.1.1 → 0.2.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWY1Mjc0ZDJhZDQyNzA0ZWMxNDNhMDdkMjgwNDRmODY2ZTU2NmQ3Ng==
+    ZjYyMDNiNzRhNWQ2MjI0NGI3YWU1MGEwZWI3ZjZiZTg2MjkxNjFhNQ==
   data.tar.gz: !binary |-
-    Njg3MmE4ZjVhM2RkNmU3ZWQxMjE5OTYxZDU5MjRkMWMyOWJmZDQyNA==
+    NTIzMmE0ODliNzM4YjBhMTc3MjY5ZjI0NjViY2FiNDNkZjg5YTI5Mw==
 SHA512:
   metadata.gz: !binary |-
-    MzBmMWFjNjljY2Y1Y2IzNzU0NDcyYjc0OWY2NTJjNjU3ZjBlOWNkNzczNjM5
-    YzYyZWQxZDQ5NzQ2ZTZmZjg3NDM1M2Y5NzM3MDY2N2EzNDU3YjdhM2M1MTdm
-    ZTNhZmFkYzZiNzk3NWE0MTRiMmQ4OTE0ZDBlNTdkOGQwYThhOTU=
+    Y2Y4ODU1OTUzY2RhOTU1NjJkNzE0NDYzMTU5NmIwNmI2OTUyMjQ3ZjE3M2Q1
+    M2MzMjIzZWUxOGIyOTU0NmQwNzVhNmNiNmIyMjFlMTJmYzdjOGI2YmUzN2I1
+    ODg2MDM1YmE3OGE5MDc5MTEyYzM5OTBiZTcyOWQ3YmQ0ZmMwMmE=
   data.tar.gz: !binary |-
-    YzUwMjRjOTYzZmRlYzA1NWZlM2Y0OWZmMmM4MDFjZDM5ODA5MWNiMjVmNDE0
-    NTMwMDYwYTAwZjMyYTNlYWFkNjZmZjc3ZTlkYzRiYjkzMmNlMjY3NmZhYmZj
-    NjNmNjYxNTkzNjNlYWYzMjJjMmM5NGVhYzE4Yjk3YmViZjRjODg=
+    YzNhMzQ5YmQ2MTE5YWZiNGE2MzQzODMwZjEyMzc3YTNkNzg5NDNkZTJhM2Iz
+    NjBmMDFmNjI2ZjQ0YjczMmMzZWVjZmIyMDkwZjkzMDU4YmY3MjFhZWMzODZk
+    MzYxZmJmMDI4YzE5NjY4NWQ1ZDdhNjY3MzcxNWYzMTRkMzMwODg=

data/lib/has_editable_password.rb

@@ -2,6 +2,9 @@ require 'active_support/concern'
 require 'active_model/secure_password'
 require 'securerandom'
 
+##
+# Just include this module into your model to have all of its nice features
+# :)
 module HasEditablePassword
   extend ActiveSupport::Concern
   include ActiveModel::SecurePassword
@@ -14,17 +17,13 @@ module HasEditablePassword
 
     validate :password_change, on: :update, if: :password_digest_changed?
 
+    ##
+    # Overrides the has_secure_password implementation to provide nice features:
+    # * Password backup
+    # * Password update timestamp
     def password=(value)
       @old_password_digest = password_digest unless @old_password_digest or password_digest.blank?
-
-      unless password_digest.blank? or password_digest_changed?
-        self.previous_password_digest = password_digest if respond_to? :previous_password_digest=
-      end
-
-      unless password_digest_changed?
-        self.password_digest_updated = Time.now if respond_to? :password_digest_updated=
-      end
-
+      changing_password
       super(value)
     end
   end
@@ -36,11 +35,11 @@ module HasEditablePassword
   # +password_recovery_token_creation+ to the current time.
   # Unless specified it calls +save+ to store the token in the database.
   #
-  # options[:length] - this is the length of the SecureRandom string generated
-  #   as the token. Since the token is base64_encoded it will be longer than
-  #   that. Default is 32.
-  # options[:save] - you can use this if you don't want save to be called.
-  #   generate_recovery_token(save: false)
+  # * +:length+ - this is the length of the SecureRandom string generated
+  # as the token. Since the token is base64_encoded it will be longer than
+  # that. Default is 32.
+  # * +:save+ - you can use this if you don't want save to be called.
+  #     generate_recovery_token(save: false)
   #
   def generate_recovery_token(options = {})
     token = SecureRandom.urlsafe_base64(options.delete(:length) || 32)
@@ -51,11 +50,12 @@ module HasEditablePassword
   end
 
   ##
-  # Returns true if the +recovery_token+ matches with the stored one and the
+  # Returns true if the +token+ matches with the stored one and the
   # token creation time is less than 24 hours ago
   #
-  def valid_recovery_token?
-    recovery_token_match? and !recovery_token_expired?
+  # If +token+ is +nil+, the stored token is compared with +@recovery_token+
+  def valid_recovery_token?(token = nil)
+    recovery_token_match?(token) and !recovery_token_expired?
   end
 
   ##
@@ -75,22 +75,56 @@ module HasEditablePassword
   end
 
   private
+  # True if the token has been updated more than 24 hours ago
   def recovery_token_expired?
     # 86400 = seconds in a day
     (Time.now - self.password_recovery_token_creation).round >= 86400
   end
 
-  def recovery_token_match?
-    BCrypt::Password.new(self.password_recovery_token) == @recovery_token
+  ##
+  # Compares password_recovery_token with:
+  # * @recovery_token if +token+ is nil
+  # * +token+ otherwise
+  #
+  # True if password_recovery_token matches.
+  # False if password_recovery_token is nil
+  # False if @recovery_token (or +token+) do not match the stored token
+  def recovery_token_match?(token = nil)
+    BCrypt::Password.new(self.password_recovery_token) == (token || @recovery_token)
   rescue
     false
   end
 
+  ##
+  # True if a valid recovery token or current password have been set
+  #
   def allow_password_change?
     valid_recovery_token? or current_password_match?
   end
 
+  ##
+  # Validation called on :update when the password_digest is touched.
+  # Sets an error on password unless the current_password or a valid recovery_token is set
   def password_change
     errors[:password] << 'Unauthorized to change the password' unless allow_password_change?
   end
+
+  def changing_password
+    unless password_digest_changed?
+      update_previous_digest
+      update_digest_timestamp
+    end
+  end
+
+  def update_previous_digest
+    if respond_to?(:previous_password_digest=) and !password_digest.blank?
+      self.previous_password_digest = password_digest
+    end
+  end
+
+  def update_digest_timestamp
+    if respond_to? :password_digest_updated=
+      self.password_digest_updated = Time.now
+    end
+  end
 end

data/lib/version.rb

@@ -1 +1 @@
-VERSION = '0.1.1'
+VERSION = '0.2.1'

data/spec/has_editable_password_spec.rb

@@ -136,23 +136,37 @@ describe HasEditablePassword do
     end
 
     context 'the creation is less than 24 hours ago' do
-      it 'returns false if the token is a random string' do
-        user.generate_recovery_token
-        user.recovery_token = "deadbeef"
-        expect(user.valid_recovery_token?).to be_false
+      context 'the argument is nil' do
+        it 'returns false if the stored token is a random string' do
+          user.generate_recovery_token
+          user.recovery_token = "deadbeef"
+          expect(user.valid_recovery_token?).to be_false
+        end
+
+        context 'the stored token is a base64 string' do
+          it 'returns false if the token does not match' do
+            user.generate_recovery_token
+            user.recovery_token = SecureRandom.urlsafe_base64
+            expect(user.valid_recovery_token?).to be_false
+          end
+
+          it 'returns true if the token matches' do
+            token = user.generate_recovery_token
+            user.recovery_token = token
+            expect(user.valid_recovery_token?).to be_true
+          end
+        end
       end
 
-      context 'the token is a base64 string' do
+      context 'the argument is not nil' do
         it 'returns false if the token does not match' do
           user.generate_recovery_token
-          user.recovery_token = SecureRandom.urlsafe_base64
-          expect(user.valid_recovery_token?).to be_false
+          expect(user.valid_recovery_token?(SecureRandom.urlsafe_base64)).to be_false
         end
 
         it 'returns true if the token matches' do
           token = user.generate_recovery_token
-          user.recovery_token = token
-          expect(user.valid_recovery_token?).to be_true
+          expect(user.valid_recovery_token?(token)).to be_true
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: has_editable_password
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Francesco Boffa