Contents

require "active_support"
require "password_strength/base"
require "password_strength/active_record"
require "password_strength/validators/windows2008"

module PasswordStrength
  # Test the password strength by applying several rules.
  # The username is required to match its substring in passwords.
  #
  #   strength = PasswordStrength.test("johndoe", "mypass")
  #   strength.weak?
  #   #=> true
  #
  # You can provide an options hash.
  #
  #   strength = PasswordStrength.test("johndoe", "^Str0ng P4ssw0rd$", :exclude => /\s/)
  #   strength.status
  #   #=> :invalid
  #
  #   strength.invalid?
  #   #=> true
  #
  # You can also provide an array.
  #
  #   strength = PasswordStrength.test("johndoe", "^Str0ng P4ssw0rd$", :exclude => [" ", "asdf", "123"])
  #
  def self.test(username, password, options = {})
    strength = Base.new(username, password, options)
    strength.test
    strength
  end

  class << self
    # You can disable PasswordStrength without having to change a single line of code. This is
    # specially great on development environment.
    attr_accessor :enabled
  end

  # Enable verification by default.
  self.enabled = true
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
password_strength-0.3.2	lib/password_strength.rb
password_strength-0.3.1	lib/password_strength.rb
password_strength-0.3.0	lib/password_strength.rb