pwned 1.2.1 → 2.0.0

data/docs/Pwned/Error.html

@@ -6,7 +6,7 @@
 <title>
   Exception: Pwned::Error
   
-    &mdash; Documentation by YARD 0.9.12
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -139,9 +139,9 @@ requests to the Pwned Passwords API.</p>
 </div>
 
       <div id="footer">
-  Generated on Sat Mar 17 09:15:06 2018 by
+  Generated on Tue Oct  1 21:19:37 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.5.0).
+  0.9.20 (ruby-2.5.5).
 </div>
 
     </div>

data/docs/Pwned/Password.html

@@ -6,7 +6,7 @@
 <title>
   Class: Pwned::Password
   
-    &mdash; Documentation by YARD 0.9.12
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -119,11 +119,16 @@ Pwned Passwords API to find out if the password has been pwned.</p>
   </ul>
 
 </div>
-  <h2>Constant Summary</h2>
-  <dl class="constants">
-    
-      <dt id="API_URL-constant" class="">API_URL =
-        <div class="docstring">
+  
+    <h2>
+      Constant Summary
+      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+    </h2>
+
+    <dl class="constants">
+      
+        <dt id="API_URL-constant" class="">API_URL =
+          <div class="docstring">
   <div class="discussion">
     
 <p>The base URL for the Pwned Passwords API</p>
@@ -135,11 +140,11 @@ Pwned Passwords API to find out if the password has been pwned.</p>
   
 
 </div>
-      </dt>
-      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://api.pwnedpasswords.com/range/</span><span class='tstring_end'>&quot;</span></span></pre></dd>
-    
-      <dt id="HASH_PREFIX_LENGTH-constant" class="">HASH_PREFIX_LENGTH =
-        <div class="docstring">
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://api.pwnedpasswords.com/range/</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+      
+        <dt id="HASH_PREFIX_LENGTH-constant" class="">HASH_PREFIX_LENGTH =
+          <div class="docstring">
   <div class="discussion">
     
 <p>The number of characters from the start of the hash of the password that
@@ -152,11 +157,11 @@ are used to search for the range of passwords.</p>
   
 
 </div>
-      </dt>
-      <dd><pre class="code"><span class='int'>5</span></pre></dd>
-    
-      <dt id="SHA1_LENGTH-constant" class="">SHA1_LENGTH =
-        <div class="docstring">
+        </dt>
+        <dd><pre class="code"><span class='int'>5</span></pre></dd>
+      
+        <dt id="SHA1_LENGTH-constant" class="">SHA1_LENGTH =
+          <div class="docstring">
   <div class="discussion">
     
 <p>The total length of a SHA1 hash</p>
@@ -168,14 +173,14 @@ are used to search for the range of passwords.</p>
   
 
 </div>
-      </dt>
-      <dd><pre class="code"><span class='int'>40</span></pre></dd>
-    
-      <dt id="DEFAULT_REQUEST_OPTIONS-constant" class="">DEFAULT_REQUEST_OPTIONS =
-        <div class="docstring">
+        </dt>
+        <dd><pre class="code"><span class='int'>40</span></pre></dd>
+      
+        <dt id="DEFAULT_REQUEST_HEADERS-constant" class="">DEFAULT_REQUEST_HEADERS =
+          <div class="docstring">
   <div class="discussion">
     
-<p>The default request options that are used to make HTTP requests to the API.
+<p>The default request headers that are used to make HTTP requests to the API.
 A user agent is provided as requested in the documentation.</p>
 
 
@@ -192,12 +197,13 @@ A user agent is provided as requested in the documentation.</p>
   </ul>
 
 </div>
-      </dt>
-      <dd><pre class="code"><span class='lbrace'>{</span>
+        </dt>
+        <dd><pre class="code"><span class='lbrace'>{</span>
   <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Ruby Pwned::Password </span><span class='embexpr_beg'>#{</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.html#VERSION-constant" title="Pwned::VERSION (constant)">VERSION</a></span></span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
 <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
-    
-  </dl>
+      
+    </dl>
+  
 
 
 
@@ -382,10 +388,10 @@ A user agent is provided as requested in the documentation.</p>
     
       
         <p class="example_title"><div class='inline'>
-<p>Setting the user agent and the read timeout of the reques</p>
+<p>Setting the user agent and the read timeout of the request</p>
 </div></p>
       
-      <pre class="example code"><code><span class='id identifier rubyid_password'>password</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="" title="Pwned::Password (class)">Password</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>password</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>My user agent</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:read_timout</span> <span class='op'>=&gt;</span> <span class='int'>10</span><span class='rparen'>)</span></code></pre>
+      <pre class="example code"><code><span class='id identifier rubyid_password'>password</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="" title="Pwned::Password (class)">Password</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>password</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>My user agent</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>read_timout:</span> <span class='int'>10</span><span class='rparen'>)</span></code></pre>
     
   </div>
 <p class="tag_title">Parameters:</p>
@@ -420,7 +426,8 @@ A user agent is provided as requested in the documentation.</p>
       
         &mdash;
         <div class='inline'>
-<p>Options that can be passed to <code>open</code> when calling the API</p>
+<p>Options that can be passed to <code>Net::HTTP.start</code> when calling the
+API</p>
 </div>
       
     </li>
@@ -436,17 +443,17 @@ A user agent is provided as requested in the documentation.</p>
     <ul class="option">
       
         <li>
-          <span class="name">'User-Agent'</span>
-          <span class="type">(<tt>String</tt>)</span>
+          <span class="name">:headers</span>
+          <span class="type">(<tt>Symbol</tt>)</span>
           <span class="default">
             
               &mdash; default:
-              <tt>&quot;Ruby Pwned::Password #{Pwned::VERSION}&quot;</tt>
+              <tt>{ &quot;User-Agent&quot; =&gt; &#39;&quot;Ruby Pwned::Password #{Pwned::VERSION}&quot; }</tt>
             
           </span>
           
             &mdash; <div class='inline'>
-<p>The user agent used when making an API request.</p>
+<p>HTTP headers to include in the request</p>
 </div>
           
         </li>
@@ -499,7 +506,9 @@ A user agent is provided as requested in the documentation.</p>
 55
 56
 57
-58</pre>
+58
+59
+60</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/pwned/password.rb', line 54</span>
@@ -507,7 +516,9 @@ A user agent is provided as requested in the documentation.</p>
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_password'>password</span><span class='comma'>,</span> <span class='id identifier rubyid_request_options'>request_options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_raise'>raise</span> <span class='const'>TypeError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>password must be of type String</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_password'>password</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span>
   <span class='ivar'>@password</span> <span class='op'>=</span> <span class='id identifier rubyid_password'>password</span>
-  <span class='ivar'>@request_options</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#DEFAULT_REQUEST_OPTIONS-constant" title="Pwned::Password::DEFAULT_REQUEST_OPTIONS (constant)">DEFAULT_REQUEST_OPTIONS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_request_options'>request_options</span><span class='rparen'>)</span>
+  <span class='ivar'>@request_options</span> <span class='op'>=</span> <span class='const'>Hash</span><span class='lparen'>(</span><span class='id identifier rubyid_request_options'>request_options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
+  <span class='ivar'>@request_headers</span> <span class='op'>=</span> <span class='const'>Hash</span><span class='lparen'>(</span><span class='id identifier rubyid_request_options'>request_options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:headers</span><span class='rparen'>)</span><span class='rparen'>)</span>
+  <span class='ivar'>@request_headers</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#DEFAULT_REQUEST_HEADERS-constant" title="Pwned::Password::DEFAULT_REQUEST_HEADERS (constant)">DEFAULT_REQUEST_HEADERS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='ivar'>@request_headers</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -663,12 +674,12 @@ A user agent is provided as requested in the documentation.</p>
       <pre class="lines">
 
 
-64
-65
-66</pre>
+66
+67
+68</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/pwned/password.rb', line 64</span>
+      <pre class="code"><span class="info file"># File 'lib/pwned/password.rb', line 66</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_hashed_password'>hashed_password</span>
   <span class='ivar'>@hashed_password</span> <span class='op'>||=</span> <span class='const'>Digest</span><span class='op'>::</span><span class='const'>SHA1</span><span class='period'>.</span><span class='id identifier rubyid_hexdigest'>hexdigest</span><span class='lparen'>(</span><span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_upcase'>upcase</span>
@@ -779,12 +790,12 @@ A user agent is provided as requested in the documentation.</p>
       <pre class="lines">
 
 
-77
-78
-79</pre>
+79
+80
+81</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/pwned/password.rb', line 77</span>
+      <pre class="code"><span class="info file"># File 'lib/pwned/password.rb', line 79</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_pwned?'>pwned?</span>
   <span class='id identifier rubyid_pwned_count'>pwned_count</span> <span class='op'>&gt;</span> <span class='int'>0</span>
@@ -895,12 +906,12 @@ A user agent is provided as requested in the documentation.</p>
       <pre class="lines">
 
 
-90
-91
-92</pre>
+92
+93
+94</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/pwned/password.rb', line 90</span>
+      <pre class="code"><span class="info file"># File 'lib/pwned/password.rb', line 92</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_pwned_count'>pwned_count</span>
   <span class='ivar'>@pwned_count</span> <span class='op'>||=</span> <span class='id identifier rubyid_fetch_pwned_count'>fetch_pwned_count</span>
@@ -915,9 +926,9 @@ A user agent is provided as requested in the documentation.</p>
 </div>
 
       <div id="footer">
-  Generated on Sat Mar 17 09:15:06 2018 by
+  Generated on Tue Oct  1 21:19:37 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.5.0).
+  0.9.20 (ruby-2.5.5).
 </div>
 
     </div>

data/docs/Pwned/TimeoutError.html

@@ -6,7 +6,7 @@
 <title>
   Exception: Pwned::TimeoutError
   
-    &mdash; Documentation by YARD 0.9.12
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -142,9 +142,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Mar 17 09:15:06 2018 by
+  Generated on Tue Oct  1 21:19:37 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.5.0).
+  0.9.20 (ruby-2.5.5).
 </div>
 
     </div>

data/docs/PwnedValidator.html

@@ -6,7 +6,7 @@
 <title>
   Class: PwnedValidator
   
-    &mdash; Documentation by YARD 0.9.12
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -182,9 +182,9 @@ removed</p>
 </div>
 
       <div id="footer">
-  Generated on Sat Mar 17 09:15:06 2018 by
+  Generated on Tue Oct  1 21:19:37 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.5.0).
+  0.9.20 (ruby-2.5.5).
 </div>
 
     </div>

data/docs/_index.html

@@ -4,7 +4,7 @@
     <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <title>
-  Documentation by YARD 0.9.12
+  Documentation by YARD 0.9.20
   
 </title>
 
@@ -52,7 +52,7 @@
         <div class="clear"></div>
       </div>
 
-      <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.12</h1>
+      <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.20</h1>
 <div id="listing">
   <h1 class="alphaindex">Alphabetic Index</h1>
   
@@ -152,9 +152,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Mar 17 09:15:05 2018 by
+  Generated on Tue Oct  1 21:19:35 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.5.0).
+  0.9.20 (ruby-2.5.5).
 </div>
 
     </div>

data/docs/css/style.css

@@ -245,6 +245,7 @@ ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
 
 dl.constants { margin-left: 10px; }
 dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
+dl.constants.compact dt { display: inline-block; font-weight: normal }
 dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-bottom: 18px; }
 dl.constants .docstring .note:first-child { margin-top: 5px; }
 
@@ -326,13 +327,9 @@ ul.summary a, ul.summary a:visited {
   text-decoration: none; font-size: 1.1em;
 }
 ul.summary li { margin-bottom: 5px; }
-.summary .summary_signature {
-  padding: 4px 8px;
-  background: #f8f8f8;
-  border: 1px solid #f0f0f0;
-  border-radius: 5px;
-}
+.summary_signature { padding: 4px 8px; background: #f8f8f8; border: 1px solid #f0f0f0; border-radius: 5px; }
 .summary_signature:hover { background: #CFEBFF; border-color: #A4CCDA; cursor: pointer; }
+.summary_signature.deprecated { background: #ffe5e5; border-color: #e9dada; }
 ul.summary.compact li { display: inline-block; margin: 0px 5px 0px 0px; line-height: 2.6em;}
 ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; }
 #content .summary_signature:hover a,
@@ -485,7 +482,7 @@ pre.code .rubyid_nth_ref { color: #6D79DE; }
 pre.code .regexp, .dregexp { color: #036A07; }
 pre.code a { border-bottom: 1px dotted #bbf; }
 /* inline code */
-p > code {
+*:not(pre) > code {
 	padding: 1px 3px 1px 3px;
 	border: 1px solid #E1E1E8;
 	background: #F7F7F9;

data/docs/file.README.html

@@ -6,7 +6,7 @@
 <title>
   File: README
   
-    &mdash; Documentation by YARD 0.9.12
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -74,6 +74,33 @@ 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>
 
+<h2 id="label-Table+of+Contents">Table of Contents</h2>
+<ul><li>
+<p><a href="#about">About</a></p>
+</li><li>
+<p><a href="#installation">Installation</a></p>
+</li><li>
+<p><a href="#usage">Usage</a></p>
+</li><li>
+<p><a href="#plain-ruby">Plain Ruby</a></p>
+</li><li>
+<p><a href="#activerecord-validator">Rails (ActiveRecord)</a></p>
+</li><li>
+<p><a href="#devise">Devise</a></p>
+</li><li>
+<p><a href="#command-line">Command line</a></p>
+</li><li>
+<p><a href="#how-pwned-is-pi">How Pwned is Pi?</a></p>
+</li><li>
+<p><a href="#development">Development</a></p>
+</li><li>
+<p><a href="#contributing">Contributing</a></p>
+</li><li>
+<p><a href="#license">License</a></p>
+</li><li>
+<p><a href="#code-of-conduct">Code of Conduct</a></p>
+</li></ul>
+
 <h2 id="label-About">About</h2>
 
 <p>Troy Hunt&#39;s <a
@@ -93,6 +120,11 @@ API, please check <a
 href="https://haveibeenpwned.com/API/v2#AcceptableUse">the acceptable uses
 and license of the API</a>.</p>
 
+<p>Here is a blog post I wrote on <a
+href="https://www.twilio.com/blog/2018/03/better-passwords-in-ruby-applications-pwned-passwords-api.html">how
+to use this gem in your Ruby applications to make your users’ passwords
+better</a>.</p>
+
 <h2 id="label-Installation">Installation</h2>
 
 <p>Add this line to your application&#39;s Gemfile:</p>
@@ -112,6 +144,17 @@ and license of the API</a>.</p>
 
 <h2 id="label-Usage">Usage</h2>
 
+<p>There are a few ways you can use this gem:</p>
+<ol><li>
+<p><a href="#plain-ruby">Plain Ruby</a></p>
+</li><li>
+<p><a href="#activerecord-validator">Rails</a></p>
+</li><li>
+<p><a href="#devise">Rails and Devise</a></p>
+</li></ol>
+
+<h3 id="label-Plain+Ruby">Plain Ruby</h3>
+
 <p>To test a password against the API, instantiate a
 <code>Pwned::Password</code> object and then ask if it is
 <code>pwned?</code>.</p>
@@ -154,12 +197,14 @@ been pwned, or how many times it was pwned:</p>
 
 <h4 id="label-Advanced">Advanced</h4>
 
-<p>You can set options and headers to be used with <code>open-uri</code> when
-making the request to the API. HTTP headers must be string keys and the <a
-href="https://ruby-doc.org/stdlib-2.5.0/libdoc/open-uri/rdoc/OpenURI/OpenRead.html#method-i-open">other
-options are available in the OpenURI::OpenRead module</a>.</p>
+<p>You can set http request options to be used with
+<code>Net::HTTP.start</code> when making the request to the API. These
+options are documented in the <a
+href="http://ruby-doc.org/stdlib-2.6.3/libdoc/net/http/rdoc/Net/HTTP.html#method-c-start">Net::HTTP.start
+documentation</a>. The <code>:headers</code> option defines defines HTTP
+headers. These headers must be string keys.</p>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_password'>password</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='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>password</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Super fun new user agent</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_password'>password</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='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>password</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Super fun new user agent</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>read_timeout:</span> <span class='int'>10</span><span class='rparen'>)</span>
 </code></pre>
 
 <h3 id="label-ActiveRecord+Validator">ActiveRecord Validator</h3>
@@ -198,7 +243,7 @@ whether the <code>pwned_count</code> is greater than the threshold.</p>
 <span class='kw'>end</span>
 </code></pre>
 
-<h4 id="label-Network+Errors+Handling">Network Errors Handling</h4>
+<h4 id="label-Network+Error+Handling">Network Error Handling</h4>
 
 <p>By default the record will be treated as valid when we cannot reach the <a
 href="https://haveibeenpwned.com/">haveibeenpwned.com</a> servers. This can
@@ -233,19 +278,104 @@ be changed with the <code>:on_error</code> validator parameter:</p>
 
 <p>You can configure network requests made from the validator using
 <code>:request_options</code> (see <a
-href="http://ruby-doc.org/stdlib-2.5.0/libdoc/open-uri/rdoc/OpenURI/OpenRead.html#method-i-open">OpenURI::OpenRead#open</a>
-for the list of available options, string keys represent custom network
-request headers, e.g. <code>&quot;User-Agent&quot;</code>):</p>
+href="http://ruby-doc.org/stdlib-2.6.3/libdoc/net/http/rdoc/Net/HTTP.html#method-c-start">Net::HTTP.start</a>
+for the list of available options). In addition to these options, HTTP
+headers can be specified with the <code>:headers</code> key, e.g.
+<code>&quot;User-Agent&quot;</code>):</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_validates'>validates</span> <span class='symbol'>:password</span><span class='comma'>,</span> <span class='label'>not_pwned:</span> <span class='lbrace'>{</span>
-    <span class='label'>request_options:</span> <span class='lbrace'>{</span> <span class='label'>read_timeout:</span> <span class='int'>5</span><span class='comma'>,</span> <span class='label'>open_timeout:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Super fun user agent</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
+    <span class='label'>request_options:</span> <span class='lbrace'>{</span> <span class='label'>read_timeout:</span> <span class='int'>5</span><span class='comma'>,</span> <span class='label'>open_timeout:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Super fun user agent</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span> <span class='rbrace'>}</span>
   <span class='rbrace'>}</span>
 </code></pre>
 
-<h2 id="label-TODO">TODO</h2>
-<ul><li>
-<p>[ ] Devise plugin</p>
-</li></ul>
+<h3 id="label-Devise">Devise</h3>
+
+<p>If you are using Devise I recommend you use the <a
+href="https://github.com/michaelbanfield/devise-pwned_password">devise-pwned_password
+extension</a> which is now powered by this gem.</p>
+
+<h3 id="label-Command+line">Command line</h3>
+
+<p>The gem provides a command line utility for checking passwords. You can
+call it from your terminal application like this:</p>
+
+<pre class="code ruby"><code class="ruby">$ pwned password
+Pwned!
+The password has been found in public breaches 3645804 times.
+</code></pre>
+
+<p>If you don&#39;t want the password you are checking to be visible, call:</p>
+
+<pre class="code ruby"><code class="ruby">$ pwned --secret
+</code></pre>
+
+<p>You will be prompted for the password, but it won&#39;t be displayed.</p>
+
+<h2 id="label-How+Pwned+is+Pi-3F">How Pwned is Pi?</h2>
+
+<p><a href="https://github.com/daz">@daz</a> <a
+href="https://twitter.com/dazonic/status/1074647842046660609">shared</a> a
+fantastic example of using this gem to show how many times the digits of Pi
+have been used as passwords and leaked.</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>pwned</span><span class='tstring_end'>&#39;</span></span>
+
+<span class='const'>PI</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>3.14159265358979323846264338327950288419716939937510582097494459230781640628620899862803482534211706798214808651328230664709384460955058223172535940812848111</span><span class='tstring_end'>&#39;</span></span>
+
+<span class='kw'>for</span> <span class='id identifier rubyid_n'>n</span> <span class='kw'>in</span> <span class='int'>1</span><span class='op'>..</span><span class='int'>40</span>
+  <span class='id identifier rubyid_password'>password</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='const'>PI</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>..</span><span class='lparen'>(</span><span class='id identifier rubyid_n'>n</span> <span class='op'>+</span> <span class='int'>1</span><span class='rparen'>)</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_n'>n</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_rjust'>rjust</span><span class='lparen'>(</span><span class='int'>2</span><span class='rparen'>)</span> <span class='rbracket'>]</span>
+  <span class='id identifier rubyid_str'>str</span> <span class='op'>&lt;&lt;</span> <span class='lparen'>(</span><span class='id identifier rubyid_password'>password</span><span class='period'>.</span><span class='id identifier rubyid_pwned?'>pwned?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>😡</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>😃</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_str'>str</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_password'>password</span><span class='period'>.</span><span class='id identifier rubyid_pwned_count'>pwned_count</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_rjust'>rjust</span><span class='lparen'>(</span><span class='int'>4</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_str'>str</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_password'>password</span><span class='period'>.</span><span class='id identifier rubyid_password'>password</span>
+
+  <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'> </span><span class='tstring_end'>&#39;</span></span>
+<span class='kw'>end</span>
+</code></pre>
+
+<p>The results may, or may not, surprise you.</p>
+
+<pre class="code ruby"><code class="ruby">1 😡   16 3.1
+ 2 😡  238 3.14
+ 3 😡   34 3.141
+ 4 😡 1345 3.1415
+ 5 😡 2552 3.14159
+ 6 😡  791 3.141592
+ 7 😡 9582 3.1415926
+ 8 😡 1591 3.14159265
+ 9 😡  637 3.141592653
+10 😡  873 3.1415926535
+11 😡  137 3.14159265358
+12 😡  103 3.141592653589
+13 😡   65 3.1415926535897
+14 😡  201 3.14159265358979
+15 😡   41 3.141592653589793
+16 😡   57 3.1415926535897932
+17 😡   28 3.14159265358979323
+18 😡   29 3.141592653589793238
+19 😡    1 3.1415926535897932384
+20 😡    7 3.14159265358979323846
+21 😡    5 3.141592653589793238462
+22 😡    2 3.1415926535897932384626
+23 😡    2 3.14159265358979323846264
+24 😃    0 3.141592653589793238462643
+25 😡    3 3.1415926535897932384626433
+26 😃    0 3.14159265358979323846264338
+27 😃    0 3.141592653589793238462643383
+28 😃    0 3.1415926535897932384626433832
+29 😃    0 3.14159265358979323846264338327
+30 😃    0 3.141592653589793238462643383279
+31 😃    0 3.1415926535897932384626433832795
+32 😃    0 3.14159265358979323846264338327950
+33 😃    0 3.141592653589793238462643383279502
+34 😃    0 3.1415926535897932384626433832795028
+35 😃    0 3.14159265358979323846264338327950288
+36 😃    0 3.141592653589793238462643383279502884
+37 😃    0 3.1415926535897932384626433832795028841
+38 😃    0 3.14159265358979323846264338327950288419
+39 😃    0 3.141592653589793238462643383279502884197
+40 😃    0 3.1415926535897932384626433832795028841971
+</code></pre>
 
 <h2 id="label-Development">Development</h2>
 
@@ -284,9 +414,9 @@ of conduct</a>.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Sat Mar 17 09:15:05 2018 by
+  Generated on Tue Oct  1 21:19:37 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.5.0).
+  0.9.20 (ruby-2.5.5).
 </div>
 
     </div>