token_authenticate_me 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2b5c60c44ccbe339c703e42d76de4136c11e3a6
-  data.tar.gz: ad45ef4018814f35c501f61589a445aa87f28b7e
+  metadata.gz: 16b050299a5e83a371b6596731db8805b0169167
+  data.tar.gz: ab29a662e9370df7e734b6e7365572fdb1adc53f
 SHA512:
-  metadata.gz: 5288acbf84d8217ff85bcf5c8ff79fa9ad0780ec79b195943a1e7537df68f4c79b7328da753969c1ed731504702833eb3106dfe62358c21ddea12891e5b1c77b
-  data.tar.gz: 4311270529652292415ab2bea7b2728464fac4f32e2a106d0316654feaa8d086491b65536ea886c9b932516c49fdca40ed9313eaec2c74da6965fdca2a568abb
+  metadata.gz: 162b004dfbd0dd4e414d99ac0001e00a3be2abe8e21aed19c783dd28df441a7bc5630062aebd3f38a94ade911b1af2288331d2d465e6b1b5e65fcb9463dda95f
+  data.tar.gz: 1f378bd64f4576573e5cf8aea9986de4d5bf0af419a4945ea41aea0f2e5bd80c0b643432e5b20060bd58a0c5be94139fafc8014792f7dbd1edb65f134b820a2a

data/README.md

@@ -43,6 +43,25 @@ class Api::V1::UsersController < Api::BaseController
 end
 ````
 
+## Authentication Model
+The model that is used for authentication will need to have `include TokenAuthenticateMe::Models::Authenticatable`. This will automatically happen if you use the generator.
+
+If you did not use the generator, this module expects the model to have the following attributes:
+* `email:string`
+* `password_digest:string`
+* `username:string`
+* `reset_password_token:string`
+* `reset_password_token_exp:datetime`
+
+This model will have a set of [validators](https://github.com/inigo-llc/token_authenticate_me/blob/master/lib/token_authenticate_me/models/authenticatable.rb#L11) added to it. 
+
+*tl;dr*:
+* `email` is required, can't be blank, is unique (case insensitive), and must look like an email address.
+* `password` is required, can not be blank, it must be confirmed (`password_confirmation`), and must be between 8 and 72 characters long. If the model has been persisted `password` can be blank or `nil` which indicates that it should not be changed and will be ignored.
+* `username` is required, can't be blank, is unique (case insensitive), and only allows alphanumeric values.
+* To change the `password` or `email` after the model has been persisted, you will need to provide the current password as `current_password`.
+
 #### TODO:
 - [ ] Make it so any resource name can be used for authentication (initial thought is either specify the default or pass resource name in token string?).
 - [ ] Allow users to specify the API namespace default.
+- [ ] Add a way to override/change/configure validations.

data/lib/token_authenticate_me/models/authenticatable.rb

@@ -6,12 +6,17 @@ module TokenAuthenticateMe
       extend ActiveSupport::Concern
 
       included do
-        has_secure_password
+        has_secure_password validations: false
+        attr_accessor :current_password
 
         validates(
           :email,
           presence: true,
-          uniqueness: { case_sensitive: false }
+          uniqueness: { case_sensitive: false },
+          format: {
+            with: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i,
+            message: "invalid e-mail address"
+          }
         )
 
         validates(
@@ -21,6 +26,19 @@ module TokenAuthenticateMe
           uniqueness: { case_sensitive: false }
         )
 
+        validates(
+          :password,
+          presence: true,
+          length: { in: 8..72 },
+          confirmation: true,
+          if: :password_required?
+        )
+
+        validate(
+          :current_password_correct,
+          if: :current_password_required?
+        )
+
         def attributes
           {
             'id' => id,
@@ -44,6 +62,27 @@ module TokenAuthenticateMe
         def password_expiration_hours
           8
         end
+
+        def password=(unencrypted_password)
+          super(unencrypted_password) unless unencrypted_password.blank? && !password_required?
+        end
+
+        def current_password_correct
+          errors.add(:current_password, 'is required to change email and/or password') if current_password.blank?
+          errors.add(:current_password, 'is incorrect') unless authenticate(current_password)
+        end
+
+        def current_password_required?
+          email_changed? || attempting_to_change_password?
+        end
+
+        def password_required?
+          attempting_to_change_password? || new_record?
+        end
+
+        def attempting_to_change_password?
+          !password.blank? || !password_confirmation.blank?
+        end
       end
     end
   end

data/lib/token_authenticate_me/version.rb

@@ -1,3 +1,3 @@
 module TokenAuthenticateMe
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: token_authenticate_me
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Sam Clopton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord