devise_zxcvbn 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 526ac3123d0a837cce7bdda0d90ebbfa8692c761
-  data.tar.gz: 436b80dbb8c65bd293366e9164cc47d4259a57c4
+  metadata.gz: 791b541aa154d0db414fe1bca70493812f8ade6a
+  data.tar.gz: 6e4b67dcfdb05334fcd0bc7363e39226fd49cec1
 SHA512:
-  metadata.gz: 343598df3d3ecd33f55432687038abb212197c5df67b4b9d1a41a9ab2e8b7407143d643a8997711bd217be6b49c00837dde469361a5bc96689f96ebf6a0a06a6
-  data.tar.gz: 701baa70e9a24c088a5996fc524bae631806aff866dff26a306feb90bab54e651c70a8e27f7101e13f5b8682ed40ad35c261f5353a88f6983d2668d046263bc2
+  metadata.gz: f1d1fe199f8bbd077a31d34ad57c0db6fdef89a71c16082d41f8adea48eaf961ce491c93265f0441a8dace87f5a4bdd2f420e1b6287f7539c3953ad64a427f44
+  data.tar.gz: c5a5483ade3b0b88bdcabf8925f0af0cc22b9c8c9d414104a203cff65d853fabf0c55221e8eae3a0b33c000d2f4a226a5ba51b5d21cfe046b27829be72f6b710

data/README.md

@@ -1,8 +1,12 @@
 # devise_zxcvbn
 
+[![Gem Version](https://badge.fury.io/rb/devise_zxcvbn.png)](http://badge.fury.io/rb/devise_zxcvbn)
+
 Plugin for devise to reject weak passwords, using [zxcvbn-ruby](https://github.com/envato/zxcvbn-ruby) which is a ruby port of [zxcvbn: realistic password strength estimation](https://tech.dropbox.com/2012/04/zxcvbn-realistic-password-strength-estimation/). 
 The user's password will be rejected if the score is below 4 by default. It also uses the email as user input to zxcvbn, to downscore passwords containing the email.
 
+The scores 0, 1, 2, 3 or 4 are given when the estimated crack time (seconds) is less than 10**2, 10**4, 10**6, 10**8, Infinity.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,19 +20,23 @@ Add this line to your application's Gemfile:
       devise :database_authenticatable, :zxcvbnable
     end
 
-Default parameters
+### Default parameters
+
+A score of less than 3 is not recommended.
 
     Devise.setup do |config|
-      config.min_password_score = 4  # 0, 1, 2, 3 or 4
+      config.min_password_score = 4
     end
 
 ### Error Message
 
+Example error message, the `score` and `min_password_score` variables are also passed through if you need them.
+
     # config/locale/devise.en.yml
     en:
       errors:
         messages:
-          weak_password: "not strong enough. It scored %{score}. It must score at least %{min_password_score}."
+          weak_password: "not strong enough. Consider adding a number, symbols or more letters to make it stronger"
 
 
 ## Contributing

data/devise_zxcvbn.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["matt@bitzesty.com"]
   spec.description   = %q{It adds password strength checking via ruby-zxcvbn to reject weak passwords }
   spec.summary       = %q{Devise plugin to reject weak passwords}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/bitzesty/devise_zxcvbn"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/devise_zxcvbn.rb

@@ -3,8 +3,25 @@ require "devise"
 require "zxcvbn"
 
 module Devise
-  mattr_accessor :min_password_score
+
   @@min_password_score = 4
+
+  def self.min_password_score
+    @@min_password_score
+  end
+    
+  def self.min_password_score=(score)
+    if score.is_a?(Integer) && (score >= 0 && score <=4)
+      if score >= 3
+        @@min_password_score = score
+      else
+        ::Rails.logger.warn "[devise_zxcvbn] A score of less than 3 is not recommended." 
+        @@min_password_score = score
+      end
+    else
+      raise "The min_password_score must be an integer and between 0..4"
+    end
+  end
 end
 
 Devise.add_module :zxcvbnable, :model => "devise_zxcvbn/model"

data/lib/devise_zxcvbn/version.rb

@@ -1,3 +1,3 @@
 module DeviseZxcvbn
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise_zxcvbn
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Ford
@@ -82,7 +82,7 @@ files:
 - lib/devise_zxcvbn.rb
 - lib/devise_zxcvbn/model.rb
 - lib/devise_zxcvbn/version.rb
-homepage: ''
+homepage: https://github.com/bitzesty/devise_zxcvbn
 licenses:
 - MIT
 metadata: {}