token_authenticate_me 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1179658e1f3af9a1c58e9efa48cd22d09ec7ce0e
-  data.tar.gz: 0158eb3611283336d1bf41199fd1a006e6f98bc7
+  metadata.gz: e7b2ede59ef0d8683ee691ef1ac5385a97ce4f26
+  data.tar.gz: e5d3060d4b33899c235436eae1ac414e248eae1b
 SHA512:
-  metadata.gz: 4fbd92b0823c33cb55de9dd3950e56ddf2001470a0122db892b4aeb28fa75fa3bb862384ba91482321f74718fbd42da7401c90566496d3ed3b7942701b500339
-  data.tar.gz: 887601bc335ab5602eb1c6f9cd34be8697a7dc9e69891d048cbc32119e2fe538719c3351e95d747f82307394608cb97b931ac8738a3ae844a5b76e94700026ae
+  metadata.gz: f0d97695c2086c03a87fc94307418e715aa6a1a56289e5ee7effb7479004a9c956509ca7b192563a290282aecc040507472808f2dcced574cb2e79b2a9af6888
+  data.tar.gz: 5c34ad2d849f2b69d29a32a0dc64b8e5351c1602b3f385b710d3848dca8e8d942b24b22da70c258ac17c975883a85cd54a30545a19f6d7392c07423f4b72fd9a

data/README.md

@@ -58,14 +58,66 @@ The model has 4 concerns:
 * [Authenticatable](https://github.com/wildland/token_authenticate_me/blob/master/lib/token_authenticate_me/concerns/models/authenticatable.rb)
 * [Invitable](https://github.com/wildland/token_authenticate_me/blob/master/lib/token_authenticate_me/concerns/models/invitable.rb)
 * [Sessionable](https://github.com/wildland/token_authenticate_me/blob/master/lib/token_authenticate_me/concerns/models/sessionable.rb)
-*
-[Passwordable](https://github.com/wildland/token_authenticate_me/blob/master/lib/token_authenticate_me/concerns/models/passwordable.rb)
+* [Passwordable](https://github.com/wildland/token_authenticate_me/blob/master/lib/token_authenticate_me/concerns/models/passwordable.rb)
 
-*tl;dr*:
+## Usage
+```rb
+class MyUser
+  include TokenAuthenticateMe::Concerns::Models::Authenticatable
+end
+```
+### Default rules and behavior.
 * `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`.
+* To change the `email` after the model has been persisted, you will need to be confirmed (`email_confirmation`) to change.
+
+### Custom Validation Rules
+If you don't like the validation rules you can customize some of them by using the following override methods and/or writing your own rules. Note that they are additive with the existing rules.
+
+```ruby
+class MyUser
+  def ignore_password_length_validations?
+    true # defaults to false
+  end
+
+  def ignore_username_format_validation?
+    true # defaults to false
+  end
+
+  def ignore_email_format_validation?
+    true # defaults to false
+  end
+
+  def ignore_email_confirmation_on_change?
+    false # defaults to true
+  end
+end
+```
+
+Custom Validation Rules Example
+```Ruby
+class MyUser
+  ### Other Code
+  validates(
+    :password,
+    format: {
+      with: /\A[a-zA-Z0-9]+\Z/,
+      message: 'only letters and numbers are allowed.'
+    } # We wanted to have alphanumeric passwords.
+    if: :password_required? # This triggers the requirements when token_authenticate_me requires them
+  )
+  ### More Code
+  def ignore_password_length_validations? # We didn't want a password length constraints, but wanted only alphanumeric characters.
+    true
+  end
+
+  def ignore_email_confirmation_on_change? # We want users to have to confirm emails to reduce mistakes.
+    false
+  end
+end
+```
 
 ## Code Of Conduct
 Wildland Open Source [Code Of Conduct](https://github.com/wildland/code-of-conduct)

data/lib/token_authenticate_me/concerns/models/authenticatable.rb

@@ -19,19 +19,34 @@ module TokenAuthenticateMe
             :email,
             presence: true,
             uniqueness: { case_sensitive: false },
+          )
+
+          with_options if: :email_confirmation_required? do |model|
+            model.validates :email, confirmation: true
+            model.validates :email_confirmation, presence: true
+          end
+
+          validates(
+            :email,
             format: {
               with: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i,
               message: 'invalid e-mail address'
-            }
+            },
+            unless: :ignore_email_format_validation?
           )
 
           validates(
             :username,
-            format: { with: /\A[a-zA-Z0-9]+\Z/ },
             presence: true,
             uniqueness: { case_sensitive: false }
           )
 
+          validates(
+            :username,
+            format: { with: /\A[a-zA-Z0-9]+\Z/ },
+            unless: :ignore_username_format_validation?
+          )
+
           def attributes
             {
               'id' => id,
@@ -46,8 +61,28 @@ module TokenAuthenticateMe
             { user: super(options) }
           end
 
+          def ignore_username_format_validation?
+            false
+          end
+
+          def ignore_email_format_validation?
+            false
+          end
+
+          def ignore_email_confirmation_on_change?
+            true
+          end
+
           protected
 
+          def email_confirmation_required?
+            !ignore_email_confirmation_on_change? && attempting_to_change_email?
+          end
+
+          def attempting_to_change_email?
+            email_changed? && persisted?
+          end
+
           def downcase_email_and_username
             self.email = email.downcase
             self.username = username.downcase

data/lib/token_authenticate_me/concerns/models/passwordable.rb

@@ -7,18 +7,29 @@ module TokenAuthenticateMe
         extend ActiveSupport::Concern
 
         included do
-
           has_secure_password validations: false
           attr_accessor :current_password
 
           validates(
             :password,
             presence: true,
-            length: { in: 8..72 },
             confirmation: true,
             if: :password_required?
           )
 
+          validates(
+            :password_confirmation,
+            presence: true,
+            if: :password_required?
+          )
+
+          validates(
+            :password,
+            length: { in: 8..72 },
+            if: :password_required?,
+            unless: :ignore_password_length_validations?
+          )
+
           validate(
             :current_password_correct,
             if: :current_password_required?
@@ -56,6 +67,10 @@ module TokenAuthenticateMe
             reset_password_token_changed? && reset_password_token_exp_changed?
           end
 
+          def ignore_password_length_validations?
+            false
+          end
+
           def password_required?
             attempting_to_change_password? || new_record?
           end

data/lib/token_authenticate_me/version.rb

@@ -1,3 +1,3 @@
 module TokenAuthenticateMe
-  VERSION = '0.8.0'.freeze
+  VERSION = '0.9.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: token_authenticate_me
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Sam Clopton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -165,7 +165,6 @@ files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config/secrets.yml
-- test/dummy/log/development.log
 - test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
@@ -200,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: This gem adds simple token authentication to users.
@@ -233,7 +232,6 @@ test_files:
 - test/dummy/config/routes.rb
 - test/dummy/config/secrets.yml
 - test/dummy/config.ru
-- test/dummy/log/development.log
 - test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html