password_blacklist 0.1.0.pre → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d74390348d89b51e90729e34cf15e6fd3a2abfb
-  data.tar.gz: ccc14c0242edfd5e606d847b5c7cff9cd6949345
+  metadata.gz: 7cbc24007a130de4700e9a13e8b87142830ac604
+  data.tar.gz: b5d7a449fa973a9d7abbf4f72b55df37f2bc8196
 SHA512:
-  metadata.gz: cad900b9af3114d1470533bb64eb4f852d9760a508d4fc86998c3d49d4b4bbca40425b531dde5fffa13938db24f1de9147bf2b68bb2fe41d36eb5dcdc40b4a3e
-  data.tar.gz: 93368324f2b37db450d741c4fadd1cbb4e3bfafd6dca60c34900102a6694d4cab75d1b51e49d596d42ea9adf543d87d809e9f2948ac97f4147b38dde97e9a4f1
+  metadata.gz: '0499da091e425f0cfd8bebf651b2b780146420575cd9030a9cddd22f48b95e13af402447dd2b087600c67b2160b3e67666c4265326233e2d860551c611c37473'
+  data.tar.gz: 379f316e74f556756689f7c58562ae901789e9c3400c129ff01106455ccb5fcc00809cf516d647ca07c97e364a20aa14859a83fbd31a4ca6baa448efb52c9661

data/CHANGELOG.md

@@ -1,7 +1,10 @@
-Unreleased
+0.1.0 / 2017-02-01
 ------
-No changes
+Rename `test` methods to `blacklisted?`.
+Rename `PasswordBlacklist::Tester` to `PasswordBlacklist::Checker`.
+Update README.
+Minor changes to resolve Rubcop violations.
 
-0.1.0 / 2017-01-20
+0.1.0.pre / 2017-01-20
 ------
 First release

data/README.md

@@ -5,7 +5,7 @@
 
 Check the presence of a string in a blacklist of the top 100,000 commonly used passwords (sourced from Mark Burnett's [ten million password release](https://xato.net/today-i-am-releasing-ten-million-passwords-b6278bbe7495)).
 
-This very simple Ruby library that can be integrated into your registration/authentication system to prevent users from setting commonly used (and easy to guess) passwords.
+This very simple Ruby library can be integrated into your registration/authentication system to prevent users from setting commonly used (and easy to guess) passwords.
 
 This gem has an insignificant memory footprint with an execution cost of approximately 1 ms. A memory persistence option is available to further reduce execution time.
 
@@ -31,33 +31,33 @@ Or install it yourself:
 $ irb
 require 'password_blacklist'
 
-PasswordBlacklist.test("pokemon")
+PasswordBlacklist.blacklisted?("pokemon")
 => true
 
-PasswordBlacklist.test("AccurateUnicornCoalPaperclip")
+PasswordBlacklist.blacklisted?("AccurateUnicornCoalPaperclip")
 => false
 ```
 
 ### Test multiple passwords
 
-The blacklist file is loaded on every call to `PasswordBlacklist.test`. Use `PasswordBlacklist::Tester` to persist the blacklist in memory (approximately 0.8MB) if you would like to perform lots of password tests in quick succession.
+The blacklist file is loaded on every call to `PasswordBlacklist.blacklisted?`. Use `PasswordBlacklist::Checker` to persist the blacklist in memory (approximately 0.8MB) if you would like to perform lots of password tests in quick succession.
 
 ```ruby
 require 'password_blacklist'
 
-tester = PasswordBlacklist::Tester.new
-=> #<PasswordBlacklist::Tester:0x3ff979c41758>
+checker = PasswordBlacklist::Checker.new
+=> #<PasswordBlacklist::Checker:0x3ff979c41758>
 
-tester.test("pokemon")
+checker.blacklisted?("pokemon")
 => true
 
-tester.test("AccurateUnicornCoalPaperclip")
+checker.blacklisted?("AccurateUnicornCoalPaperclip")
 => false
 ```
 
 ## Supported Ruby versions
 
-password_blacklist supports MRI Ruby 1.9+ and the JRuby equivalent. The specific Ruby versions we build and test on can be found at [TravisCI](https://travis-ci.org/gchan/password_blacklist).
+password_blacklist supports MRI Ruby 2.x. The specific Ruby versions we build and test on can be found at [TravisCI](https://travis-ci.org/gchan/password_blacklist).
 
 ## Development
 

data/lib/password_blacklist/checker.rb

@@ -0,0 +1,17 @@
+module PasswordBlacklist
+  class Checker
+    def initialize
+      file_path = File.expand_path('../../../data/100k_passwords.txt', __FILE__)
+
+      @data = File.read(file_path)
+    end
+
+    def blacklisted?(password)
+      !@data.match(/#{password}/).nil?
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{__id__.to_s(16)}>"
+    end
+  end
+end

data/lib/password_blacklist/version.rb

@@ -1,3 +1,3 @@
 module PasswordBlacklist
-  VERSION = "0.1.0.pre"
+  VERSION = '0.1.0'.freeze
 end

data/lib/password_blacklist.rb

@@ -1,10 +1,10 @@
-require "password_blacklist/version"
-require "password_blacklist/tester"
+require 'password_blacklist/version'
+require 'password_blacklist/checker'
 
 module PasswordBlacklist
-  extend self
+  module_function
 
-  def test(password)
-    Tester.new.test(password)
+  def blacklisted?(password)
+    Checker.new.blacklisted?(password)
   end
 end

data/password_blacklist.gemspec

@@ -4,27 +4,30 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'password_blacklist/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "password_blacklist"
+  spec.name          = 'password_blacklist'
   spec.version       = PasswordBlacklist::VERSION
-  spec.authors       = ["Gordon Chan"]
-  spec.email         = ["developer.gordon+github@gmail.com"]
+  spec.authors       = ['Gordon Chan']
+  spec.email         = ['developer.gordon+github@gmail.com']
 
   spec.summary       = 'Checks a password against a 100k blacklist.'
   spec.description   = 'A simple Ruby library to check if a given string is
     present in a blacklist of 100,000 common passwords'
-  spec.homepage      = "https://www.github.com/gchan/password_blacklist"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://www.github.com/gchan/password_blacklist'
+  spec.license       = 'MIT'
 
-  spec.files         = Dir['lib/**/*.rb'] + Dir['data/*']
-  spec.files         += %w(CHANGELOG.md LICENSE.txt README.md password_blacklist.gemspec)
-  spec.bindir        = "bin"
-  spec.require_paths = ["lib"]
+  spec.files = Dir['lib/**/*.rb'] + Dir['data/*'] +
+               %w(password_blacklist.gemspec CHANGELOG.md LICENSE.txt README.md)
+
+  spec.bindir        = 'bin'
+  spec.require_paths = ['lib']
   spec.platform      = Gem::Platform::RUBY
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 12.0.0'
 
-  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency 'rspec', '~> 3.5'
   spec.add_development_dependency 'simplecov', '~> 0.12.0'
   spec.add_development_dependency 'rubocop', '~> 0.47.1'
   spec.add_development_dependency 'coveralls', '~> 0.8.18'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: password_blacklist
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.0
 platform: ruby
 authors:
 - Gordon Chan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-19 00:00:00.000000000 Z
+date: 2017-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +136,7 @@ files:
 - README.md
 - data/100k_passwords.txt
 - lib/password_blacklist.rb
-- lib/password_blacklist/tester.rb
+- lib/password_blacklist/checker.rb
 - lib/password_blacklist/version.rb
 - password_blacklist.gemspec
 homepage: https://www.github.com/gchan/password_blacklist
@@ -149,14 +149,14 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8

data/lib/password_blacklist/tester.rb

@@ -1,17 +0,0 @@
-module PasswordBlacklist
-  class Tester
-    def initialize
-      file_path = File.expand_path("../../../data/100k_passwords.txt", __FILE__)
-
-      @data = File.read(file_path)
-    end
-
-    def test(password)
-      !!@data.match(/#{password}/)
-    end
-
-    def inspect
-      "#<#{self.class}:0x#{self.__id__.to_s(16)}>"
-    end
-  end
-end