RubyGems - pwned - Versions diffs - 1.2.1 → 2.2.0 - Mend

pwned 1.2.1 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (35) hide show

checksums.yaml +4 -4
data/.github/FUNDING.yml +1 -0
data/.github/workflows/tests.yml +39 -0
data/CHANGELOG.md +75 -18
data/README.md +153 -10
data/bin/pwned +52 -0
data/lib/pwned.rb +22 -6
data/lib/pwned/hashed_password.rb +36 -0
data/lib/pwned/not_pwned_validator.rb +3 -3
data/lib/pwned/password.rb +12 -96
data/lib/pwned/password_base.rb +141 -0
data/lib/pwned/version.rb +1 -1
data/pwned.gemspec +11 -2
metadata +29 -34
data/.travis.yml +0 -23
data/docs/NotPwnedValidator.html +0 -488
data/docs/Pwned.html +0 -513
data/docs/Pwned/Error.html +0 -149
data/docs/Pwned/Password.html +0 -925
data/docs/Pwned/TimeoutError.html +0 -152
data/docs/PwnedValidator.html +0 -192
data/docs/_index.html +0 -162
data/docs/class_list.html +0 -51
data/docs/css/common.css +0 -1
data/docs/css/full_list.css +0 -58
data/docs/css/style.css +0 -499
data/docs/file.README.html +0 -294
data/docs/file_list.html +0 -56
data/docs/frames.html +0 -17
data/docs/index.html +0 -294
data/docs/js/app.js +0 -248
data/docs/js/full_list.js +0 -216
data/docs/js/jquery.js +0 -4
data/docs/method_list.html +0 -115
data/docs/top-level-namespace.html +0 -112

data/docs/Pwned.html DELETED Viewed

@@ -1,513 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Module: Pwned
-    &mdash; Documentation by YARD 0.9.12
-</title>
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  pathId = "Pwned";
-  relpath = '';
-</script>
-  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
-  </head>
-  <body>
-    <div class="nav_wrap">
-      <iframe id="nav" src="class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="_index.html">Index (P)</a> &raquo;
-    <span class="title">Pwned</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <div id="content"><h1>Module: Pwned
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/pwned.rb<span class="defines">,<br />
-  lib/pwned/error.rb,<br /> lib/pwned/version.rb,<br /> lib/pwned/password.rb</span>
-</dd>
-  </dl>
-</div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-<p>The main namespace for <code>Pwned</code>. Includes convenience methods for
-getting the results for a password.</p>
-  </div>
-</div>
-<div class="tags">
-</div><h2>Defined Under Namespace</h2>
-<p class="children">
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Pwned/Error.html" title="Pwned::Error (class)">Error</a></span>, <span class='object_link'><a href="Pwned/Password.html" title="Pwned::Password (class)">Password</a></span>, <span class='object_link'><a href="Pwned/TimeoutError.html" title="Pwned::TimeoutError (class)">TimeoutError</a></span>
-</p>
-  <h2>Constant Summary</h2>
-  <dl class="constants">
-      <dt id="VERSION-constant" class="">VERSION =
-        <div class="docstring">
-  <div class="discussion">
-<p>The current version of the <code>pwned</code> gem.</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-      </dt>
-      <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>
-    <h2>
-      Class Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#pwned%3F-class_method" title="pwned? (class method)">.<strong>pwned?</strong>(password, request_options = {})  &#x21d2; Boolean </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Returns <code>true</code> when the password has been pwned.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#pwned_count-class_method" title="pwned_count (class method)">.<strong>pwned_count</strong>(password, request_options = {})  &#x21d2; Integer </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Returns number of times the password has been pwned.</p>
-</div></span>
-</li>
-    </ul>
-  <div id="class_method_details" class="method_details_list">
-    <h2>Class Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="pwned?-class_method">
-    .<strong>pwned?</strong>(password, request_options = {})  &#x21d2; <tt>Boolean</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Returns <code>true</code> when the password has been pwned.</p>
-  </div>
-</div>
-<div class="tags">
-  <div class="examples">
-    <p class="tag_title">Examples:</p>
-      <pre class="example code"><code><span class='const'><span class='object_link'><a href="" title="Pwned (module)">Pwned</a></span></span><span class='period'>.</span><span class='id identifier rubyid_pwned?'>pwned?</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='rparen'>)</span> <span class='comment'>#=&gt; true
-</span><span class='const'><span class='object_link'><a href="" title="Pwned (module)">Pwned</a></span></span><span class='period'>.</span><span class='id identifier rubyid_pwned?'>pwned?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>pwned::password</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='comment'>#=&gt; false</span></code></pre>
-  </div>
-<p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>password</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>The password you want to check against the API.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>request_options</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        <em class="default">(defaults to: <tt>{}</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>Options that can be passed to <code>open</code> when calling the API</p>
-</div>
-    </li>
-</ul>
-    <p class="tag_title">Options Hash (<tt>request_options</tt>):</p>
-    <ul class="option">
-        <li>
-          <span class="name">'User-Agent'</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-              &mdash; default:
-              <tt>&quot;Ruby Pwned::Password #{Pwned::VERSION}&quot;</tt>
-          </span>
-            &mdash; <div class='inline'>
-<p>The user agent used when making an API request.</p>
-</div>
-        </li>
-    </ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Boolean</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>Whether the password appears in the data breaches or not.</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Since:</p>
-<ul class="since">
-    <li>
-        <div class='inline'>
-<p>1.1.0</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-38
-39
-40</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/pwned.rb', line 38</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_pwned?'>pwned?</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='const'><span class='object_link'><a href="" 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_password'>password</span><span class='comma'>,</span> <span class='id identifier rubyid_request_options'>request_options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_pwned?'>pwned?</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="pwned_count-class_method">
-    .<strong>pwned_count</strong>(password, request_options = {})  &#x21d2; <tt>Integer</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Returns number of times the password has been pwned.</p>
-  </div>
-</div>
-<div class="tags">
-  <div class="examples">
-    <p class="tag_title">Examples:</p>
-      <pre class="example code"><code><span class='const'><span class='object_link'><a href="" title="Pwned (module)">Pwned</a></span></span><span class='period'>.</span><span class='id identifier rubyid_pwned_count'>pwned_count</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='rparen'>)</span> <span class='comment'>#=&gt; 3303003
-</span><span class='const'><span class='object_link'><a href="" title="Pwned (module)">Pwned</a></span></span><span class='period'>.</span><span class='id identifier rubyid_pwned_count'>pwned_count</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>pwned::password</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='comment'>#=&gt; 0</span></code></pre>
-  </div>
-<p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>password</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>The password you want to check against the API.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>request_options</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        <em class="default">(defaults to: <tt>{}</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>Options that can be passed to <code>open</code> when calling the API</p>
-</div>
-    </li>
-</ul>
-    <p class="tag_title">Options Hash (<tt>request_options</tt>):</p>
-    <ul class="option">
-        <li>
-          <span class="name">'User-Agent'</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-              &mdash; default:
-              <tt>&quot;Ruby Pwned::Password #{Pwned::VERSION}&quot;</tt>
-          </span>
-            &mdash; <div class='inline'>
-<p>The user agent used when making an API request.</p>
-</div>
-        </li>
-    </ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Integer</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>The number of times the password has appeared in the data breaches.</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Since:</p>
-<ul class="since">
-    <li>
-        <div class='inline'>
-<p>1.1.0</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-57
-58
-59</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/pwned.rb', line 57</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_pwned_count'>pwned_count</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='const'><span class='object_link'><a href="" 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_password'>password</span><span class='comma'>,</span> <span class='id identifier rubyid_request_options'>request_options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_pwned_count'>pwned_count</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-      <div id="footer">
-  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>
-    </div>
-  </body>
-</html>