zxcvbn-ruby 0.0.3 → 1.1.0

data/spec/support/matcher.rb

@@ -17,7 +17,7 @@ RSpec::Matchers.define :match_js_results do |expected_js_results|
     @missing.empty? && @extra.empty?
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "Matches missing from ruby results:\n#{@missing.inspect}\nMatches unique to ruby results:\n#{@extra.inspect}"
   end
 

data/spec/tester_spec.rb

@@ -0,0 +1,99 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Zxcvbn::Tester do
+  let(:tester) { Zxcvbn::Tester.new }
+
+  TEST_PASSWORDS.each do |password|
+    it "gives back the same score for #{password}" do
+      ruby_result = tester.test(password)
+      js_result = js_zxcvbn(password)
+
+      expect(ruby_result.calc_time).not_to be_nil
+      expect(ruby_result.password).to eq js_result["password"]
+      expect(ruby_result.entropy).to eq js_result["entropy"]
+      expect(ruby_result.crack_time).to eq js_result["crack_time"]
+      expect(ruby_result.crack_time_display).to eq js_result["crack_time_display"]
+      expect(ruby_result.score).to eq js_result["score"]
+      expect(ruby_result.pattern).to eq js_result["pattern"]
+      expect(ruby_result.match_sequence.count).to eq js_result["match_sequence"].count
+
+      # NOTE: feedback didn't exist in the version of the JS library this gem
+      #       is based on, so instead we just check that it put `Feedback` in
+      #       there. Real tests for its values go in `feedback_giver_spec.rb`.
+      expect(ruby_result.feedback).to be_a Zxcvbn::Feedback
+    end
+  end
+
+  context "with a custom user dictionary" do
+    it "scores them against the user dictionary" do
+      result = tester.test("themeforest", ["themeforest"])
+      expect(result.entropy).to eq 0
+      expect(result.score).to eq 0
+    end
+
+    it "matches l33t substitutions on this dictionary" do
+      result = tester.test("th3m3for3st", ["themeforest"])
+      expect(result.entropy).to eq 1
+      expect(result.score).to eq 0
+    end
+  end
+
+  context "with Unicode entries in the password" do
+    it "validates the password" do
+      result = tester.test("✅🐴🔋staple", %w[Theme Forest themeforest])
+      expect(result.entropy).to be_positive
+      expect(result.score).to be_positive
+    end
+  end
+
+  context "with Unicode entries in the dictionary" do
+    it "validates the password" do
+      result = tester.test("correct horse battery staple", %w[✅ 🐴 🔋])
+      expect(result.entropy).to be_positive
+      expect(result.score).to be_positive
+    end
+  end
+
+  context "with Unicode entries in the password and the dictionary" do
+    it "validates the password" do
+      result = tester.test("✅🐴🔋staple", %w[✅ 🐴 🔋])
+      expect(result.entropy).to be_positive
+      expect(result.score).to be_zero
+    end
+  end
+
+  context "with invalid entries in the dictionary" do
+    it "ignores those entries" do
+      result = tester.test("themeforest", [nil, 1, "themeforest"])
+      expect(result.entropy).to eq 0
+      expect(result.score).to eq 0
+    end
+  end
+
+  context "with a custom global dictionary" do
+    before { tester.add_word_lists("envato" => ["envato"]) }
+
+    it "scores them against the dictionary" do
+      result = tester.test("envato")
+      expect(result.entropy).to eq 0
+      expect(result.score).to eq 0
+    end
+
+    context "with invalid entries in a custom dictionary" do
+      before { tester.add_word_lists("themeforest" => [nil, 1, "themeforest"]) }
+
+      it "ignores those entries" do
+        expect(tester.test("themeforest")).to have_attributes(entropy: 0, score: 0, crack_time: 0)
+      end
+    end
+  end
+
+  context "nil password" do
+    specify do
+      expect(tester.test(nil)).to have_attributes(entropy: 0, score: 0, crack_time: 0)
+    end
+  end
+end

data/spec/zxcvbn_spec.rb

@@ -1,49 +1,24 @@
 require 'spec_helper'
 
-describe 'zxcvbn over a set of example passwords' do
-  TEST_PASSWORDS.each do |password|
-    it "gives back the same score for #{password}" do
-      ruby_result = Zxcvbn.test(password)
-      js_result = js_zxcvbn(password)
-
-      ruby_result.calc_time.should_not be_nil
-      ruby_result.password.should eq js_result['password']
-      ruby_result.entropy.should eq js_result['entropy']
-      ruby_result.crack_time.should eq js_result['crack_time']
-      ruby_result.crack_time_display.should eq js_result['crack_time_display']
-      ruby_result.score.should eq js_result['score']
-      ruby_result.pattern.should eq js_result['pattern']
-      ruby_result.match_sequence.count.should eq js_result['match_sequence'].count
+describe 'Zxcvbn.test' do
+  context 'with a password' do
+    it 'returns a result' do
+      result = Zxcvbn.test('password')
+      expect(result.entropy).to_not be_nil
     end
   end
 
-  context 'with a custom user dictionary' do
-    it 'scores them against the user dictionary' do
-      result = Zxcvbn.test('themeforest', ['themeforest'])
-      result.entropy.should eq 0
-      result.score.should eq 0
-    end
-
-    it 'matches l33t substitutions on this dictionary' do
-      result = Zxcvbn.test('th3m3for3st', ['themeforest'])
-      result.entropy.should eq 1
-      result.score.should eq 0
-    end
-  end
-
-  context 'with a custom global dictionary' do
-    before { Zxcvbn.add_word_list('envato', ['envato']) }
-
-    it 'scores them against the dictionary' do
-      result = Zxcvbn.test('envato')
-      result.entropy.should eq 0
-      result.score.should eq 0
+  context 'with a password and user input' do
+    it 'returns a result' do
+      result = Zxcvbn.test('password', ['inputs'])
+      expect(result.entropy).to_not be_nil
     end
   end
 
-  context 'nil password' do
-    specify do
-      expect { Zxcvbn.test(nil) }.to_not raise_error
+  context 'with a password, user input and custom word lists' do
+    it 'returns a result' do
+      result = Zxcvbn.test('password', ['inputs'], {'list' => ['words']})
+      expect(result.entropy).to_not be_nil
     end
   end
-end
+end

data/zxcvbn-ruby.gemspec

@@ -14,7 +14,18 @@ Gem::Specification.new do |gem|
   gem.name          = "zxcvbn-ruby"
   gem.require_paths = ["lib"]
   gem.version       = Zxcvbn::VERSION
+  gem.license       = 'MIT'
+
+  gem.required_ruby_version = '~> 2.5'
 
   gem.add_development_dependency 'therubyracer'
   gem.add_development_dependency 'rspec'
+
+  gem.metadata = {
+    "bug_tracker_uri" => "https://github.com/envato/zxcvbn-ruby/issues",
+    "changelog_uri" => "https://github.com/envato/zxcvbn-ruby/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://github.com/envato/zxcvbn-ruby/blob/master/README.md",
+    "homepage_uri" => "https://github.com/envato/zxcvbn-ruby",
+    "source_code_uri" => "https://github.com/envato/zxcvbn-ruby"
+  }
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zxcvbn-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -10,38 +9,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2020-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: therubyracer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby port of Dropboxs zxcvbn.js
@@ -52,10 +47,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
-- LICENSE
+- Guardfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - data/adjacency_graphs.json
@@ -66,8 +65,11 @@ files:
 - data/frequency_lists/surnames.txt
 - lib/zxcvbn.rb
 - lib/zxcvbn/crack_time.rb
+- lib/zxcvbn/data.rb
 - lib/zxcvbn/dictionary_ranker.rb
 - lib/zxcvbn/entropy.rb
+- lib/zxcvbn/feedback.rb
+- lib/zxcvbn/feedback_giver.rb
 - lib/zxcvbn/match.rb
 - lib/zxcvbn/matchers/date.rb
 - lib/zxcvbn/matchers/dictionary.rb
@@ -84,8 +86,10 @@ files:
 - lib/zxcvbn/password_strength.rb
 - lib/zxcvbn/score.rb
 - lib/zxcvbn/scorer.rb
+- lib/zxcvbn/tester.rb
 - lib/zxcvbn/version.rb
 - spec/dictionary_ranker_spec.rb
+- spec/feedback_giver_spec.rb
 - spec/matchers/date_spec.rb
 - spec/matchers/dictionary_spec.rb
 - spec/matchers/digits_spec.rb
@@ -111,40 +115,40 @@ files:
 - spec/support/js_source/scoring.coffee
 - spec/support/js_source/scoring.js
 - spec/support/matcher.rb
+- spec/tester_spec.rb
 - spec/zxcvbn_spec.rb
 - zxcvbn-ruby.gemspec
 homepage: http://github.com/envato/zxcvbn-ruby
-licenses: []
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/envato/zxcvbn-ruby/issues
+  changelog_uri: https://github.com/envato/zxcvbn-ruby/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/envato/zxcvbn-ruby/blob/master/README.md
+  homepage_uri: https://github.com/envato/zxcvbn-ruby
+  source_code_uri: https://github.com/envato/zxcvbn-ruby
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -1798543645320205772
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1798543645320205772
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 3.1.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: ''
 test_files:
 - spec/dictionary_ranker_spec.rb
+- spec/feedback_giver_spec.rb
 - spec/matchers/date_spec.rb
 - spec/matchers/dictionary_spec.rb
 - spec/matchers/digits_spec.rb
@@ -170,4 +174,5 @@ test_files:
 - spec/support/js_source/scoring.coffee
 - spec/support/js_source/scoring.js
 - spec/support/matcher.rb
+- spec/tester_spec.rb
 - spec/zxcvbn_spec.rb