devise-uncommon_password 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f78e8bdf28ec7c16226aa6446549f8d5f21d237
-  data.tar.gz: d517c4599b99fdcb2a13f5c95fe77359ea76b58e
+  metadata.gz: 3c3f797d9849ec73517edd495907e80fa81897e0
+  data.tar.gz: 66903d74de1376c74e9bc8027140d9f0ecf2acd2
 SHA512:
-  metadata.gz: 898c6720415820b742534e5e740db80871b85364698b0b10d4016fbaef797cdbb585c1f9a98f83a4da0386e5303fff890a1e7c51f05cee478a8869fddb5a1c03
-  data.tar.gz: 4b2f57ad38c49aab0cc6e117e066104a3ffb5761b685a278588704494b33b3b7a34545b322ec158ad5d4335255de24d64fcef5b0671d94db14edf010ae78d3f8
+  metadata.gz: '061827281b8fc9c91b88ab29b1c466057d8f0a387f8f702fb12ff9e86f9e5e77679540f8e11e971691706a9224409634c3a0fab9bafc3e4037203f750e1bc510'
+  data.tar.gz: bda011eebb6c2ae2e5141d09396b07d167a1dc375095a877cbd23c65a3011eb9c4a99e3812fce39bf6206bf49d7148ba8c931d23e7ada3bb225fc55b2597f964

data/README.md

@@ -3,7 +3,25 @@
 [![Build Status](https://travis-ci.org/HCLarsen/devise-uncommon_password.svg?branch=master)](https://travis-ci.org/HCLarsen/devise-uncommon_password)
 [![Code Climate](https://codeclimate.com/github/HCLarsen/devise-uncommon_password.svg)](https://codeclimate.com/github/HCLarsen/devise-uncommon_password)
 
-Devise::UncommonPassword is an extension for the devise gem, which prevents users from signing up using one of the 100 most common passwords. The list is derived from the darkweb2017_top10K.txt found at: https://github.com/danielmiessler/SecLists/tree/master/Passwords. Since the Devise gem allows developers to set the minimum and maximum lengths for passwords, this gem uses that information to provide only the top 100 passwords that fit into that length.
+Devise::UncommonPassword is an extension for the devise gem, which prevents users from signing up using one of the 100 most common passwords. The list is derived from the darkweb2017_top10K.txt found at: https://github.com/danielmiessler/SecLists/tree/master/Passwords.
+
+## Usage
+
+Add the ':uncommon_password' module to your model:
+
+```ruby
+class AdminUser < ApplicationRecord
+  devise :database_authenticatable,
+         :recoverable, :rememberable, :trackable, :validatable, :uncommon_password
+end
+```
+
+By default, the password is checked against the 100 most common passwords that fit within the minimum and maximum lengths specified in the /config/initializers/devise.rb file. However, if a developer wants to check against a larger list, they may override this default by adding the following line to that same file:
+
+```ruby
+# Number of common passwords to check entered password against.
+config.password_matches = 1000
+```
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -17,16 +35,6 @@ And then execute:
 $ bundle install
 ```
 
-Then add the ':uncommon_password' module to your model:
-```
-class User < ActiveRecord::Base
-devise :database_authenticatable, :registerable,
-       :recoverable, :rememberable, :trackable, :validatable, :uncommon_password
-end
-```
-
-And you're ready to go.
-
 ## Contributing
 
 You can contribute by doing the following:

data/lib/devise/uncommon_password/model.rb

@@ -16,13 +16,18 @@ module Devise
           file.each { |password| passwords << password.chomp.downcase }
         end
         passwords.select! {|password| Devise.password_length.include? password.length }
-        passwords[0..99]
+        #passwords[0..99]
+        passwords[0..Devise.password_matches-1]
       end
 
       included do
         validate :not_common_password, if: :password_required?
       end
 
+      module ClassMethods
+        Devise::Models.config(self, :password_matches)
+      end
+
       private
 
       def not_common_password

data/lib/devise/uncommon_password/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module UncommonPassword
-    VERSION = '0.2.2'
+    VERSION = '0.3.0'
   end
 end

data/lib/devise/uncommon_password.rb

@@ -2,6 +2,8 @@ require 'devise'
 require 'devise/uncommon_password/model'
 
 module Devise
+  mattr_accessor :password_matches
+  @@password_matches = 100
   module UncommonPassword
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise-uncommon_password
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Larsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails