pwned 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e197213ac23ae94598dbf91b7a09fadd740db379d5abefdb8ad7c9623d9514b
-  data.tar.gz: 960c6e4ab1d856480dbc236059abea531dc747f4a1d59a7e7db52534c2958866
+  metadata.gz: b6891bb23ef6923eaad6c5af0b4fa2d36471c9a6903fbb66940720c6a5a69c2b
+  data.tar.gz: d138630dcac1204a01adfa731cce9a52ca984b67544f4c0beabe3e51f56d28ed
 SHA512:
-  metadata.gz: dede2324974438b89612b443e50c8d7c06fe9b35d3e5c6f36661ad73d28513ebb62eedbc60f0a72d346c935141b96f30b98a6ad21cb2950f45a418c76d33c6b1
-  data.tar.gz: 32a0659ce0a7b80967ebf68809bf5881623f473ab561dfcba9f131eb86af60b9f0cb4031603c85c295d37f9d7aae10ce03ae3a580c3cc437c486cff099a4f962
+  metadata.gz: a89fca08322c92a4866d774dd5d2bce8d495326a99d7dfa8b2e8fe12b43ab3d57c0ed29f9aa8dab5d94ed5c002127701cd57daa43f9a621804232c02a4122d15
+  data.tar.gz: 67a0aaf46f9d84ee81b36e39e72d761aa7b08293246d7fec3abb35bb122d38cf2cd17519850b97573d16bbe346680de6478b1a569c47a1600085b4167e7faa51

data/.yardopts

@@ -0,0 +1 @@
+--output-dir docs

data/CHANGELOG.md

@@ -1,9 +1,14 @@
 # Changelog for `Pwned`
 
-## Ongoing [☰](https://github.com/philnash/pwned/compare/v1.1.0...master)
+## Ongoing [☰](https://github.com/philnash/pwned/compare/v1.2.1...master)
 
 ...
 
+## 1.2.1 (March 17, 2018) [☰](https://github.com/philnash/pwned/commits/v1.2.1)
+
+* Minor updates
+  * Validator no longer raises `TypeError` when password is `nil`
+
 ## 1.2.0 (March 15, 2018) [☰](https://github.com/philnash/pwned/commits/v1.2.0)
 
 * Major updates

data/README.md

@@ -2,7 +2,7 @@
 
 An easy, Ruby way to use the Pwned Passwords API.
 
-[![Gem Version](https://badge.fury.io/rb/pwned.svg)](https://rubygems.org/gems/pwned) [![Build Status](https://travis-ci.org/philnash/pwned.svg?branch=master)](https://travis-ci.org/philnash/pwned) [![Maintainability](https://codeclimate.com/github/philnash/pwned/badges/gpa.svg)](https://codeclimate.com/github/philnash/pwned/maintainability)
+[![Gem Version](https://badge.fury.io/rb/pwned.svg)](https://rubygems.org/gems/pwned) [![Build Status](https://travis-ci.org/philnash/pwned.svg?branch=master)](https://travis-ci.org/philnash/pwned) [![Maintainability](https://codeclimate.com/github/philnash/pwned/badges/gpa.svg)](https://codeclimate.com/github/philnash/pwned/maintainability) [![Inline docs](https://inch-ci.org/github/philnash/pwned.svg?branch=master)](https://inch-ci.org/github/philnash/pwned)
 
 [API docs](https://philnash.github.io/pwned/) | [GitHub repo](https://github.com/philnash/pwned)
 

data/docs/NotPwnedValidator.html

@@ -335,11 +335,72 @@ then the record is marked as invalid.</p>
 valid or invalid. Alternatively it will run an associated proc or re-raise
 the original error.</p>
 
+<p>The validation will short circuit and return with no errors added if the
+password is blank. The <code>Pwned::Password</code> initializer expects the
+password to be a string and will throw a <code>TypeError</code> if it is
+<code>nil</code>. Also, technically the empty string is not a password that
+is reported to be found in data breaches, so returns <code>false</code>,
+short circuiting that using <code>value.blank?</code> saves us a trip to
+the API.</p>
+
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>record</span>
+      
+      
+        <span class='type'>(<tt>ActiveModel::Validations</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The object being validated</p>
+</div>
+      
+    </li>
   
+    <li>
+      
+        <span class='name'>attribute</span>
+      
+      
+        <span class='type'>(<tt>Symbol</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The attribute on the record that is currently being validated.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>value</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The value of the attribute on the record that is the subject of the
+validation</p>
+</div>
+      
+    </li>
+  
+</ul>
+
 <p class="tag_title">Since:</p>
 <ul class="since">
   
@@ -363,30 +424,32 @@ the original error.</p>
       <pre class="lines">
 
 
-64
-65
-66
-67
-68
-69
-70
-71
-72
-73
-74
-75
-76
 77
 78
 79
 80
 81
-82</pre>
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/pwned/not_pwned_validator.rb', line 64</span>
+      <pre class="code"><span class="info file"># File 'lib/pwned/not_pwned_validator.rb', line 77</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_validate_each'>validate_each</span><span class='lparen'>(</span><span class='id identifier rubyid_record'>record</span><span class='comma'>,</span> <span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
+  <span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>
   <span class='kw'>begin</span>
     <span class='id identifier rubyid_pwned_check'>pwned_check</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Pwned.html" title="Pwned (module)">Pwned</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Pwned/Password.html" title="Pwned::Password (class)">Password</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Pwned/Password.html#initialize-instance_method" title="Pwned::Password#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_request_options'>request_options</span><span class='rparen'>)</span>
     <span class='kw'>if</span> <span class='id identifier rubyid_pwned_check'>pwned_check</span><span class='period'>.</span><span class='id identifier rubyid_pwned_count'>pwned_count</span> <span class='op'>&gt;</span> <span class='id identifier rubyid_threshold'>threshold</span>
@@ -415,7 +478,7 @@ the original error.</p>
 </div>
 
       <div id="footer">
-  Generated on Wed Mar 14 11:06:58 2018 by
+  Generated on Sat Mar 17 09:15:06 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.12 (ruby-2.5.0).
 </div>

data/docs/Pwned.html

@@ -125,7 +125,7 @@ getting the results for a password.</p>
 
 </div>
       </dt>
-      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.1.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.2.1</span><span class='tstring_end'>&quot;</span></span></pre></dd>
     
   </dl>
 
@@ -503,7 +503,7 @@ getting the results for a password.</p>
 </div>
 
       <div id="footer">
-  Generated on Wed Mar 14 11:06:58 2018 by
+  Generated on Sat Mar 17 09:15:06 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.12 (ruby-2.5.0).
 </div>

data/docs/Pwned/Error.html

@@ -139,7 +139,7 @@ requests to the Pwned Passwords API.</p>
 </div>
 
       <div id="footer">
-  Generated on Wed Mar 14 11:06:58 2018 by
+  Generated on Sat Mar 17 09:15:06 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.12 (ruby-2.5.0).
 </div>

data/docs/Pwned/Password.html

@@ -915,7 +915,7 @@ A user agent is provided as requested in the documentation.</p>
 </div>
 
       <div id="footer">
-  Generated on Wed Mar 14 11:06:58 2018 by
+  Generated on Sat Mar 17 09:15:06 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.12 (ruby-2.5.0).
 </div>

data/docs/Pwned/TimeoutError.html

@@ -142,7 +142,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Mar 14 11:06:58 2018 by
+  Generated on Sat Mar 17 09:15:06 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.12 (ruby-2.5.0).
 </div>

data/docs/PwnedValidator.html

@@ -182,7 +182,7 @@ removed</p>
 </div>
 
       <div id="footer">
-  Generated on Wed Mar 14 11:06:58 2018 by
+  Generated on Sat Mar 17 09:15:06 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.12 (ruby-2.5.0).
 </div>

data/docs/_index.html

@@ -152,7 +152,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Mar 14 11:06:57 2018 by
+  Generated on Sat Mar 17 09:15:05 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.12 (ruby-2.5.0).
 </div>

data/docs/file.README.html

@@ -67,7 +67,9 @@ src="https://badge.fury.io/rb/pwned.svg"></a> <a
 href="https://travis-ci.org/philnash/pwned"><img
 src="https://travis-ci.org/philnash/pwned.svg?branch=master"></a> <a
 href="https://codeclimate.com/github/philnash/pwned/maintainability"><img
-src="https://codeclimate.com/github/philnash/pwned/badges/gpa.svg"></a></p>
+src="https://codeclimate.com/github/philnash/pwned/badges/gpa.svg"></a> <a
+href="https://inch-ci.org/github/philnash/pwned"><img
+src="https://inch-ci.org/github/philnash/pwned.svg?branch=master"></a></p>
 
 <p><a href="https://philnash.github.io/pwned/">API docs</a> | <a
 href="https://github.com/philnash/pwned">GitHub repo</a></p>
@@ -282,7 +284,7 @@ of conduct</a>.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Wed Mar 14 11:06:58 2018 by
+  Generated on Sat Mar 17 09:15:05 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.12 (ruby-2.5.0).
 </div>

data/docs/index.html

@@ -67,7 +67,9 @@ src="https://badge.fury.io/rb/pwned.svg"></a> <a
 href="https://travis-ci.org/philnash/pwned"><img
 src="https://travis-ci.org/philnash/pwned.svg?branch=master"></a> <a
 href="https://codeclimate.com/github/philnash/pwned/maintainability"><img
-src="https://codeclimate.com/github/philnash/pwned/badges/gpa.svg"></a></p>
+src="https://codeclimate.com/github/philnash/pwned/badges/gpa.svg"></a> <a
+href="https://inch-ci.org/github/philnash/pwned"><img
+src="https://inch-ci.org/github/philnash/pwned.svg?branch=master"></a></p>
 
 <p><a href="https://philnash.github.io/pwned/">API docs</a> | <a
 href="https://github.com/philnash/pwned">GitHub repo</a></p>
@@ -282,7 +284,7 @@ of conduct</a>.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Wed Mar 14 11:06:58 2018 by
+  Generated on Sat Mar 17 09:15:05 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.12 (ruby-2.5.0).
 </div>

data/docs/top-level-namespace.html

@@ -102,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Mar 14 11:06:58 2018 by
+  Generated on Sat Mar 17 09:15:05 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.12 (ruby-2.5.0).
 </div>

data/lib/pwned/not_pwned_validator.rb

@@ -61,7 +61,21 @@ class NotPwnedValidator < ActiveModel::EachValidator
   # In the case of an API error the validator will either mark the
   # record as valid or invalid. Alternatively it will run an associated proc or
   # re-raise the original error.
+  #
+  # The validation will short circuit and return with no errors added if the
+  # password is blank. The +Pwned::Password+ initializer expects the password to
+  # be a string and will throw a +TypeError+ if it is +nil+. Also, technically
+  # the empty string is not a password that is reported to be found in data
+  # breaches, so returns +false+, short circuiting that using +value.blank?+
+  # saves us a trip to the API.
+  #
+  # @param record [ActiveModel::Validations] The object being validated
+  # @param attribute [Symbol] The attribute on the record that is currently
+  #   being validated.
+  # @param value [String] The value of the attribute on the record that is the
+  #   subject of the validation
   def validate_each(record, attribute, value)
+    return if value.blank?
     begin
       pwned_check = Pwned::Password.new(value, request_options)
       if pwned_check.pwned_count > threshold

data/lib/pwned/version.rb

@@ -3,5 +3,5 @@
 module Pwned
   ##
   # The current version of the +pwned+ gem.
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwned
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Phil Nash
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-15 00:00:00.000000000 Z
+date: 2018-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,6 +90,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile