nobspw 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff0a9b36d196559340b528cee7aa35bec281e37e
-  data.tar.gz: f44cf6a9c9824448cf6cb5ecf0377bc12ce6a965
+  metadata.gz: 391e780d690175f0dd19aec4f70506b81c587632
+  data.tar.gz: 164a2ed02a9041eeb5f46c0db2e13f1f7965b832
 SHA512:
-  metadata.gz: 19b6e2193005dff2b3af38ffa83c78fce9dcb1ff159e63c13028085c8f4ae283628e6453081ab2041ea31277afb8e2bddc52f7109d738e05a1875be33f12cb50
-  data.tar.gz: 344471dfe8e33acd0e7b82cdbc59f719e3b67b1071727129b5e196397d5c1e2ab858a641072f0a8748d96635f1d45cb3b130ddb7db2e5a502b4396a93c7793d2
+  metadata.gz: 138e85ae7d22ff15af74e4fcaa646b237d671a5746a9e3b957fc793e3ed99ed1e4e8f752856c34c75dc18b64b3e0f6023c72849c1a6382573f80aeea1f411646
+  data.tar.gz: '09ab32aa868f3afe7505fb378b67375cc0413a87f4600cf37a5f641e88d029911a4d29114245c429b4346a0442fe4e743e2d31837f55a8fc40809b55fa3f505f'

data/README.md

@@ -36,7 +36,72 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Vanilla Ruby
+
+```ruby
+  pwc = NOBSPW::PasswordChecker.new password: 'mystrongpassword',
+                                    name: 'John Smith',           # optional but recommended
+                                    username: 'bigjohn43',        # optional but recommended
+                                    email: 'john@example.org'     # optional but recommended
+  pwc.strong?
+  pwc.weak?
+  pwd.weak_password_reasons  # returns an array of Symbols with reasons why password is weak
+  pwd.reasons                # short alias of weak_password_reasons
+```
+
+Optionally, you can configure some options:
+
+```ruby
+  NOBSPW.configure do |config|
+    config.min_password_length = 10
+    config.max_password_length = 256
+    config.min_unique_characters = 5
+    config.dictionary_path = 'path/to/dictionary.txt'
+    config.grep_path = '/usr/bin/grep'
+    config.domain_name = 'mywebsitedomain.com' # it is recommended you configure this
+    config.blacklist = ['this_password_is_not_allowed']
+  end
+```
+
+### Ruby on Rails
+
+I included `PasswordValidator` for Rails. Validating passwords in your model couldn't be easier:
+
+```ruby
+validates :password, presence: true, password: true, if: -> { new_record? || changes[:password] }
+```
+
+PasswordValidator will try to guess the correct field name for each `PasswordChecker` argument as follow:
+
+- `username`: `username user_name user screenname screen_name`
+- `name`: `name full_name first_name+last_name`
+- `email`: `email email_address`
+
+If you have field names different than above, you can tell `PasswordValidator` which fields to use for specific attributes:
+
+```ruby
+validates :password, presence: true,
+                     password: { :name => :customer_name,
+                                 :email => :electronic_address },
+          if: -> { new_record? || changes[:password] }
+```
+
+# Checks
+
+NOBSPW currently checks for the following, in this order:
+
+```ruby
+:name_included_in_password
+:email_included_in_password
+:domain_included_in_password
+:password_too_short
+:password_too_long
+:not_enough_unique_characters
+:password_blacklisted
+:password_too_common
+```
+
+If any of these tests fail, they'll be returned by `#reasons`, or with Rails, they'll be added to `errors[:password]`.
 
 ## License
 

data/lib/active_model/validations/password_validator.rb

@@ -0,0 +1,82 @@
+class ActiveModel::Validations::PasswordValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    pc = NOBSPW::PasswordChecker.new password: record.send(attribute),
+                                     email:    email_value(record),
+                                     name:     name_value(record),
+                                     username: username_value(record)
+
+    pc.weak_password_reasons.each do |reason|
+      record.errors[attribute] << get_message(reason)
+    end
+    pc.strong?
+  end
+
+  private
+
+  def email_value(record)
+    if options.keys.include?(:email)
+      return nil if options[:email].nil?
+      return record.send(options[:email])
+    end
+
+    %i(email email_address).each do |f|
+      return record.send(f) if record.respond_to?(f)
+    end
+
+    nil
+  end
+
+  def username_value(record)
+    if options.keys.include?(:username)
+      return nil if options[:username].nil?
+      return record.send(options[:username])
+    end
+
+    %i(username user_name user screenname screen_name).each do |f|
+      return record.send(f) if record.respond_to?(f)
+    end
+
+    nil
+  end
+
+  def name_value(record)
+    if options.keys.include?(:name)
+      return nil if options[:name].nil?
+      return record.send(options[:name])
+    end
+
+    %i(name full_name).each do |f|
+      return record.send(f) if record.respond_to?(f)
+    end
+
+    if record.respond_to?(:first_name) && record.respond_to?(:last_name)
+      return "#{record.send(:first_name)} #{record.send(:last_name)}"
+    end
+
+    nil
+  end
+
+  def get_message(reason)
+    case reason
+    when :name_included_in_password
+      I18n.t 'password_validator.is_too_similar_to_your_name', default: 'is too similar to your name'
+    when :email_included_in_password
+      I18n.t 'password_validator.is_too_similar_to_your_email', default: 'is too similar to your email'
+    when :domain_included_in_password
+      I18n.t 'password_validator.is_too_similar_to_this_domain_name', default: 'is too similar to this domain name'
+    when :password_too_short
+      I18n.t 'password_validator.is_too_short', default: 'is too short'
+    when :password_too_long
+      I18n.t 'password_validator.is_too_long', default: 'is too long'
+    when :password_blacklisted
+      I18n.t 'password_validator.is_not_allowed', default: 'is not allowed'
+    when :password_too_common
+      I18n.t 'password_validator.is_too_common', default: 'is too common'
+    when :not_enough_unique_characters
+      I18n.t 'password_validator.does_not_have_enough_unique_chars', default: 'does not have enough unique characters'
+    else
+      I18n.t 'password_validator.is_not_valid', default: 'is not valid'
+    end
+  end
+
+end

data/lib/nobspw.rb

@@ -4,12 +4,20 @@ module NOBSPW
   autoload :PasswordChecker, 'nobspw/password_checker'
   autoload :Configuration, 'nobspw/configuration'
 
+  if (defined?(::ActiveModel) && ActiveModel::VERSION::MAJOR >= 4) && defined?(I18n)
+    require_relative 'active_model/validations/password_validator'
+  end
+
   class << self
-    attr_accessor :configuration
+    attr_writer :configuration
   end
 
   def self.configure
     self.configuration ||= Configuration.new
     yield(configuration)
   end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
 end

data/lib/nobspw/password_checker.rb

@@ -11,7 +11,9 @@ module NOBSPW
 
     def initialize(name: nil, username: nil, email: nil, password:)
       @name, @username, @email, @password = \
-        name.strip, username.strip, email.strip, password.strip
+        name&.strip, username&.strip, email&.strip, password&.strip
+
+      raise ArgumentError.new("Password was not specified.") if password.nil? || password.strip.length == 0
     end
 
     def strong?
@@ -19,10 +21,15 @@ module NOBSPW
       @strong
     end
 
+    def weak?
+      !strong?
+    end
+
     def weak_password_reasons
       check_password if @weak_password_reasons.nil?
       @weak_password_reasons
     end
+    alias_method :reasons, :weak_password_reasons
 
     private
 
@@ -51,9 +58,9 @@ module NOBSPW
     def domain_included_in_password?
       domain = NOBSPW.configuration.domain_name
       return nil unless domain
-
-      words_included_in_password?(domain) ||
-      remove_word_separators(words_included_in_password?(domain)).gsub(' ', '')
+      domain = strip_extension_from_domain(domain)
+      domain_without_separator = remove_word_separators(domain).gsub(' ', '')
+      words_included_in_password?([domain, domain_without_separator])
     end
 
     def password_blacklisted?
@@ -103,7 +110,11 @@ module NOBSPW
 
     def email_without_extension(email)
       name, domain, whatev = email.split("@", 3)
-      "#{name}@#{domain}"
+      "#{name}@#{strip_extension_from_domain(domain)}"
+    end
+
+    def strip_extension_from_domain(domain)
+      domain.split(".").first
     end
 
     def remove_word_separators(str)

data/lib/nobspw/version.rb

@@ -1,3 +1,3 @@
 module NOBSPW
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/nobspw.gemspec

@@ -27,6 +27,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov", "~> 0.13"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7.3"
+  spec.add_development_dependency "activemodel", "~> 5.0"
+  spec.add_development_dependency "i18n", "~> 0.8.1"
 
   if RUBY_PLATFORM =~ /darwin/
     spec.add_development_dependency 'ruby_gntp', "~> 0.3.4"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nobspw
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Carl Mercier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-11 00:00:00.000000000 Z
+date: 2017-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: ruby_gntp
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +168,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/active_model/validations/password_validator.rb
 - lib/db/dictionary.txt
 - lib/nobspw.rb
 - lib/nobspw/configuration.rb