devise-pwned_password 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7794b80de3b65f09c95f29c5cb907c9643d61bad
-  data.tar.gz: e76f856c88cb727d8b93d5df55ba69ddbd96ca32
+  metadata.gz: 4d25ddf45c7eddaf3e5334a1fc1dde9dfd0c1299
+  data.tar.gz: 105d467a316fd317e76abb0226b0debecac123cc
 SHA512:
-  metadata.gz: 1c3f388b3f4ba33481294492f318e5eecf8f45c790e12608fe3dfa7096b3e0c5526a7dc857d03f40e479ec37bceea5371d26e0768030fcc9e6eb83b00bb5eb7c
-  data.tar.gz: 741f99479411bdbaaa2d5eea56c68c10eaaa216aef2f295615bfe9fb91810b79f512665e14b01547496e5bc82142d13cdcc27c82c48b819bd303daf33b293a33
+  metadata.gz: cdad317bb782d686f9f0734dd5d519b0d1b0329e89d272466fe57ea9737d890b58f8a2e99951fa1c55af34088697ee0a0bb54796e9eb60c646048fbb7f8821dc
+  data.tar.gz: 005647a67db66a184ca7c53280c1743b985b15ca3a4968700de3c7e8aa549767d4880462219d7c02624f09887d58a299956f088c9399584fe9808ccf80b3f9d1

data/README.md

@@ -1,8 +1,27 @@
 # Devise::PwnedPassword
-Short description and motivation.
+Devise extension that checks user passwords against the PwnedPasswords dataset https://haveibeenpwned.com/Passwords
+
+Based on
+
+https://github.com/HCLarsen/devise-uncommon_password
+
 
 ## Usage
-How to use my plugin.
+Add the :pwned_password module to your existing Devise model.
+
+```ruby
+class AdminUser < ApplicationRecord
+  devise :database_authenticatable, 
+         :recoverable, :rememberable, :trackable, :validatable, :pwned_password
+end
+```
+
+
+Users will receive the following error message if they use a password from the PwnedPasswords dataset
+
+```
+This password has previously appeared in a data breach and should never be used. Please choose something harder to guess.
+```
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -13,16 +32,18 @@ gem 'devise-pwned_password'
 
 And then execute:
 ```bash
-$ bundle
-```
-
-Or install it yourself as:
-```bash
-$ gem install devise-pwned_password
+$ bundle install
 ```
 
 ## Contributing
-Contribution directions go here.
+
+To contribute
+
+* Check the [issue tracker](https://github.com/michaelbanfield/devise-pwned_password/issues) and [pull requests](https://github.com/michaelbanfield/devise-pwned_password/pulls) for anything similar
+* Fork the repository
+* Make your changes
+* Run bin/test to make sure the unit tests still run
+* Send a pull requests
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/devise/pwned_password/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module PwnedPassword
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise-pwned_password
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michael Banfield
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-04 00:00:00.000000000 Z
+date: 2017-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.1.2
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement