pwned 2.0.1 → 2.3.0

data/lib/pwned/password_base.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require "digest"
+require "net/http"
+
+module Pwned
+  ##
+  # This class represents a password. It does all the work of talking to the
+  # Pwned Passwords API to find out if the password has been pwned.
+  # @see https://haveibeenpwned.com/API/v2#PwnedPasswords
+  module PasswordBase
+    ##
+    # The base URL for the Pwned Passwords API
+    API_URL = "https://api.pwnedpasswords.com/range/"
+
+    ##
+    # The number of characters from the start of the hash of the password that
+    # are used to search for the range of passwords.
+    HASH_PREFIX_LENGTH = 5
+
+    ##
+    # The total length of a SHA1 hash
+    SHA1_LENGTH = 40
+
+    ##
+    # The default request headers that are used to make HTTP requests to the
+    # API. A user agent is provided as requested in the documentation.
+    # @see https://haveibeenpwned.com/API/v2#UserAgent
+    DEFAULT_REQUEST_HEADERS = {
+      "User-Agent" => "Ruby Pwned::Password #{Pwned::VERSION}"
+    }.freeze
+
+    ##
+    # @example
+    #     password = Pwned::Password.new("password")
+    #     password.pwned? #=> true
+    #     password.pwned? #=> true
+    #
+    # @return [Boolean] +true+ when the password has been pwned.
+    # @raise [Pwned::Error] if there are errors with the HTTP request.
+    # @raise [Pwned::TimeoutError] if the HTTP request times out.
+    # @since 1.0.0
+    def pwned?
+      pwned_count > 0
+    end
+
+    ##
+    # @example
+    #     password = Pwned::Password.new("password")
+    #     password.pwned_count #=> 3303003
+    #
+    # @return [Integer] the number of times the password has been pwned.
+    # @raise [Pwned::Error] if there are errors with the HTTP request.
+    # @raise [Pwned::TimeoutError] if the HTTP request times out.
+    # @since 1.0.0
+    def pwned_count
+      @pwned_count ||= fetch_pwned_count
+    end
+
+    ##
+    # Returns the full SHA1 hash of the given password in uppercase.
+    # @return [String] The full SHA1 hash of the given password.
+    # @since 1.0.0
+    attr_reader :hashed_password
+
+    private
+
+    attr_reader :request_options, :request_headers, :request_proxy, :ignore_env_proxy
+
+    def fetch_pwned_count
+      for_each_response_line do |line|
+        next unless line.start_with?(hashed_password_suffix)
+        # Count starts after the suffix, followed by a colon
+        return line[(SHA1_LENGTH-HASH_PREFIX_LENGTH+1)..-1].to_i
+      end
+
+      # The hash was not found, we can assume the password is not pwned [yet]
+      0
+    end
+
+    def for_each_response_line(&block)
+      begin
+        with_http_response "#{API_URL}#{hashed_password_prefix}" do |response|
+          response.value # raise if request was unsuccessful
+          stream_response_lines(response, &block)
+        end
+      rescue Timeout::Error => e
+        raise Pwned::TimeoutError, e.message
+      rescue => e
+        raise Pwned::Error, e.message
+      end
+    end
+
+    def hashed_password_prefix
+      @hashed_password[0...HASH_PREFIX_LENGTH]
+    end
+
+    def hashed_password_suffix
+      @hashed_password[HASH_PREFIX_LENGTH..-1]
+    end
+
+    # Make a HTTP GET request given the url and headers.
+    # Yields a `Net::HTTPResponse`.
+    def with_http_response(url, &block)
+      uri = URI(url)
+
+      request = Net::HTTP::Get.new(uri)
+      request.initialize_http_header(request_headers)
+      request_options[:use_ssl] = true
+
+      environment_proxy = ignore_env_proxy ? nil : :ENV
+
+      Net::HTTP.start(
+        uri.host,
+        uri.port,
+        request_proxy&.host || environment_proxy,
+        request_proxy&.port,
+        request_proxy&.user,
+        request_proxy&.password,
+        request_options
+      ) do |http|
+        http.request(request, &block)
+      end
+    end
+
+    # Stream a Net::HTTPResponse by line, handling lines that cross chunks.
+    def stream_response_lines(response, &block)
+      last_line = ""
+
+      response.read_body do |chunk|
+        chunk_lines = (last_line + chunk).lines
+        # This could end with half a line, so save it for next time. If
+        # chunk_lines is empty, pop returns nil, so this also ensures last_line
+        # is always a string.
+        last_line = chunk_lines.pop || ""
+        chunk_lines.each(&block)
+      end
+
+      yield last_line unless last_line.empty?
+    end
+  end
+end

data/lib/pwned/version.rb

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

data/lib/pwned.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require "digest"
 require "pwned/version"
 require "pwned/error"
 require "pwned/password"
+require "pwned/hashed_password"
 
 begin
   # Load Rails and our custom validator
@@ -31,8 +33,11 @@ module Pwned
   # @param password [String] The password you want to check against the API.
   # @param [Hash] request_options Options that can be passed to +Net::HTTP.start+ when
   #   calling the API
-  # @option request_options [Symbol] :headers ({ "User-Agent" => '"Ruby Pwned::Password #{Pwned::VERSION}" })
+  # @option request_options [Symbol] :headers ({ "User-Agent" => "Ruby Pwned::Password #{Pwned::VERSION}" })
   #   HTTP headers to include in the request
+  # @option request_options [Symbol] :ignore_env_proxy (false) The library
+  #   will try to infer an HTTP proxy from the `http_proxy` environment
+  #   variable. If you do not want this behaviour, set this option to true.
   # @return [Boolean] Whether the password appears in the data breaches or not.
   # @since 1.1.0
   def self.pwned?(password, request_options={})
@@ -49,12 +54,29 @@ module Pwned
   # @param password [String] The password you want to check against the API.
   # @param [Hash] request_options Options that can be passed to +Net::HTTP.start+ when
   #   calling the API
-  # @option request_options [Symbol] :headers ({ "User-Agent" => '"Ruby Pwned::Password #{Pwned::VERSION}" })
+  # @option request_options [Symbol] :headers ({ "User-Agent" => "Ruby Pwned::Password #{Pwned::VERSION}" })
   #   HTTP headers to include in the request
+  # @option request_options [Symbol] :ignore_env_proxy (false) The library
+  #   will try to infer an HTTP proxy from the `http_proxy` environment
+  #   variable. If you do not want this behaviour, set this option to true.
   # @return [Integer] The number of times the password has appeared in the data
   #   breaches.
   # @since 1.1.0
   def self.pwned_count(password, request_options={})
     Pwned::Password.new(password, request_options).pwned_count
   end
+
+  ##
+  # Returns the full SHA1 hash of the given password in uppercase. This can be safely passed around your code
+  # before making the pwned request (e.g. dropped into a queue table).
+  #
+  # @example
+  #     Pwned.hash_password("password") #=> 5BAA61E4C9B93F3F0682250B6CF8331B7EE68FD8
+  #
+  # @param password [String] The password you want to check against the API
+  # @return [String] An uppercase SHA1 hash of the password
+  # @since 2.1.0
+  def self.hash_password(password)
+    Digest::SHA1.hexdigest(password).upcase
+  end
 end

data/pwned.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.metadata      = {
     "bug_tracker_uri"   => "https://github.com/philnash/pwned/issues",
     "change_log_uri"    => "https://github.com/philnash/pwned/blob/master/CHANGELOG.md",
-    "documentation_uri" => "https://philnash.github.io/pwned/",
+    "documentation_uri" => "https://www.rubydoc.info/gems/pwned",
     "homepage_uri"      => "https://github.com/philnash/pwned",
     "source_code_uri"   => "https://github.com/philnash/pwned"
   }
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.executables = ["pwned"]
 
   spec.add_development_dependency "bundler", ">= 1.16", "< 3.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 3.3"
   spec.add_development_dependency "yard", "~> 0.9.12"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwned
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Phil Nash
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-13 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,9 +94,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -107,31 +108,13 @@ files:
 - bin/console
 - bin/pwned
 - bin/setup
-- docs/NotPwnedValidator.html
-- docs/Pwned.html
-- docs/Pwned/Error.html
-- docs/Pwned/Password.html
-- docs/Pwned/TimeoutError.html
-- docs/PwnedValidator.html
-- docs/_index.html
-- docs/class_list.html
-- docs/css/common.css
-- docs/css/full_list.css
-- docs/css/style.css
-- docs/file.README.html
-- docs/file_list.html
-- docs/frames.html
-- docs/index.html
-- docs/js/app.js
-- docs/js/full_list.js
-- docs/js/jquery.js
-- docs/method_list.html
-- docs/top-level-namespace.html
 - lib/locale/en.yml
 - lib/pwned.rb
 - lib/pwned/error.rb
+- lib/pwned/hashed_password.rb
 - lib/pwned/not_pwned_validator.rb
 - lib/pwned/password.rb
+- lib/pwned/password_base.rb
 - lib/pwned/version.rb
 - pwned.gemspec
 homepage: https://github.com/philnash/pwned
@@ -140,10 +123,10 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/philnash/pwned/issues
   change_log_uri: https://github.com/philnash/pwned/blob/master/CHANGELOG.md
-  documentation_uri: https://philnash.github.io/pwned/
+  documentation_uri: https://www.rubydoc.info/gems/pwned
   homepage_uri: https://github.com/philnash/pwned
   source_code_uri: https://github.com/philnash/pwned
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,9 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Tools to use the Pwned Passwords API.
 test_files: []

data/.travis.yml

@@ -1,27 +0,0 @@
-sudo: false
-language: ruby
-
-env:
-  matrix:
-    - RAILS_VERSION=4.2.11.1
-    - RAILS_VERSION=5.0.7.2
-    - RAILS_VERSION=5.1.7
-    - RAILS_VERSION=5.2.3
-    - RAILS_VERSION=6.0.0
-
-rvm:
-  - 2.7
-  - 2.6
-  - 2.5
-  - 2.4
-  - jruby
-  - ruby-head
-
-before_install: gem install bundler
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-  exclude:
-    - rvm: 2.4
-      env: RAILS_VERSION=6.0.0

data/docs/NotPwnedValidator.html

@@ -1,494 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Class: NotPwnedValidator
-  
-    &mdash; Documentation by YARD 0.9.20
-  
-</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 = "NotPwnedValidator";
-  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 (N)</a> &raquo;
-    
-    
-    <span class="title">NotPwnedValidator</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>Class: NotPwnedValidator
-  
-  
-  
-</h1>
-<div class="box_info">
-  
-  <dl>
-    <dt>Inherits:</dt>
-    <dd>
-      <span class="inheritName">ActiveModel::EachValidator</span>
-      
-        <ul class="fullTree">
-          <li>Object</li>
-          
-            <li class="next">ActiveModel::EachValidator</li>
-          
-            <li class="next">NotPwnedValidator</li>
-          
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      
-    </dd>
-  </dl>
-  
-
-  
-  
-  
-  
-  
-
-  
-
-  
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/pwned/not_pwned_validator.rb</dd>
-  </dl>
-  
-</div>
-
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    
-<p>An <code>ActiveModel</code> validator to check passwords against the Pwned
-Passwords API.</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-  <div class="examples">
-    <p class="tag_title">Examples:</p>
-    
-      
-        <p class="example_title"><div class='inline'>
-<p>Validate a password on a <code>User</code> model with the default options.</p>
-</div></p>
-      
-      <pre class="example code"><code><span class='kw'>class</span> <span class='const'>User</span> <span class='op'>&lt;</span> <span class='const'>ApplicationRecord</span>
-  <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='kw'>true</span>
-<span class='kw'>end</span></code></pre>
-    
-      
-        <p class="example_title"><div class='inline'>
-<p>Validate a password on a <code>User</code> model with a custom error
-message.</p>
-</div></p>
-      
-      <pre class="example code"><code><span class='kw'>class</span> <span class='const'>User</span> <span class='op'>&lt;</span> <span class='const'>ApplicationRecord</span>
-  <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'>message:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>has been pwned %{count} times</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
-<span class='kw'>end</span></code></pre>
-    
-      
-        <p class="example_title"><div class='inline'>
-<p>Validate a password on a <code>User</code> model that allows the password
-to have been breached once.</p>
-</div></p>
-      
-      <pre class="example code"><code><span class='kw'>class</span> <span class='const'>User</span> <span class='op'>&lt;</span> <span class='const'>ApplicationRecord</span>
-  <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'>threshold:</span> <span class='int'>1</span> <span class='rbrace'>}</span>
-<span class='kw'>end</span></code></pre>
-    
-      
-        <p class="example_title"><div class='inline'>
-<p>Validate a password on a <code>User</code> model, handling API errors in
-various ways</p>
-</div></p>
-      
-      <pre class="example code"><code><span class='kw'>class</span> <span class='const'>User</span> <span class='op'>&lt;</span> <span class='const'>ApplicationRecord</span>
-  <span class='comment'># The record is marked as invalid on network errors
-</span>  <span class='comment'># (error message &quot;could not be verified against the past data breaches&quot;.)
-</span>  <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'>on_error:</span> <span class='symbol'>:invalid</span> <span class='rbrace'>}</span>
-
-  <span class='comment'># The record is marked as invalid on network errors with custom error.
-</span>  <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'>on_error:</span> <span class='symbol'>:invalid</span><span class='comma'>,</span> <span class='label'>error_message:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>might be pwned</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
-
-  <span class='comment'># An error is raised on network errors.
-</span>  <span class='comment'># This means that `record.valid?` will raise `Pwned::Error`.
-</span>  <span class='comment'># Not recommended to use in production.
-</span>  <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'>on_error:</span> <span class='symbol'>:raise_error</span> <span class='rbrace'>}</span>
-
-  <span class='comment'># Call custom proc on error. For example, capture errors in Sentry,
-</span>  <span class='comment'># but do not mark the record as invalid.
-</span>  <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'>on_error:</span> <span class='tlambda'>-&gt;</span><span class='lparen'>(</span><span class='id identifier rubyid_record'>record</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='rparen'>)</span> <span class='tlambeg'>{</span> <span class='const'>Raven</span><span class='period'>.</span><span class='id identifier rubyid_capture_exception'>capture_exception</span><span class='lparen'>(</span><span class='id identifier rubyid_error'>error</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
-  <span class='rbrace'>}</span>
-<span class='kw'>end</span></code></pre>
-    
-  </div>
-
-<p class="tag_title">Since:</p>
-<ul class="since">
-  
-    <li>
-      
-      
-      
-      
-        
-        <div class='inline'>
-<p>1.2.0</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-</div><div id="subclasses">
-  <h2>Direct Known Subclasses</h2>
-  <p class="children"><span class='object_link'><a href="PwnedValidator.html" title="PwnedValidator (class)">PwnedValidator</a></span></p>
-</div>
-
-  
-    <h2>
-      Constant Summary
-      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
-    </h2>
-
-    <dl class="constants">
-      
-        <dt id="DEFAULT_ON_ERROR-constant" class="">DEFAULT_ON_ERROR =
-          <div class="docstring">
-  <div class="discussion">
-    
-<p>The default behaviour of this validator in the case of an API failure. The
-default will mean that if the API fails the object will not be marked
-invalid.</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-<p class="tag_title">Since:</p>
-<ul class="since">
-  
-    <li>
-      
-      
-      
-      
-        
-        <div class='inline'>
-<p>1.2.0</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-</div>
-        </dt>
-        <dd><pre class="code"><span class='symbol'>:valid</span></pre></dd>
-      
-        <dt id="DEFAULT_THRESHOLD-constant" class="">DEFAULT_THRESHOLD =
-          <div class="docstring">
-  <div class="discussion">
-    
-<p>The default threshold for whether a breach is considered pwned. The default
-is 0, so any password that appears in a breach will mark the record as
-invalid.</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-<p class="tag_title">Since:</p>
-<ul class="since">
-  
-    <li>
-      
-      
-      
-      
-        
-        <div class='inline'>
-<p>1.2.0</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-</div>
-        </dt>
-        <dd><pre class="code"><span class='int'>0</span></pre></dd>
-      
-    </dl>
-  
-
-
-
-
-
-
-
-  
-    <h2>
-      Instance Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-
-    <ul class="summary">
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#validate_each-instance_method" title="#validate_each (instance method)">#<strong>validate_each</strong>(record, attribute, value)  &#x21d2; Object </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'>
-<p>Validates the <code>value</code> against the Pwned Passwords API.</p>
-</div></span>
-  
-</li>
-
-      
-    </ul>
-  
-
-
-  
-
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-
-    
-      <div class="method_details first">
-  <h3 class="signature first" id="validate_each-instance_method">
-  
-    #<strong>validate_each</strong>(record, attribute, value)  &#x21d2; <tt>Object</tt> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    
-<p>Validates the <code>value</code> against the Pwned Passwords API. If the
-<code>pwned_count</code> is higher than the optional <code>threshold</code>
-then the record is marked as invalid.</p>
-
-<p>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.</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">
-  
-    <li>
-      
-      
-      
-      
-        
-        <div class='inline'>
-<p>1.2.0</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-77
-78
-79
-80
-81
-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 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>
-      <span class='id identifier rubyid_record'>record</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='symbol'>:not_pwned</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>count:</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='rparen'>)</span><span class='rparen'>)</span>
-    <span class='kw'>end</span>
-  <span class='kw'>rescue</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/Error.html" title="Pwned::Error (class)">Error</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_error'>error</span>
-    <span class='kw'>case</span> <span class='id identifier rubyid_on_error'>on_error</span>
-    <span class='kw'>when</span> <span class='symbol'>:invalid</span>
-      <span class='id identifier rubyid_record'>record</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='symbol'>:pwned_error</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>message:</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:error_message</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='rparen'>)</span>
-    <span class='kw'>when</span> <span class='symbol'>:valid</span>
-      <span class='comment'># Do nothing, consider the record valid
-</span>    <span class='kw'>when</span> <span class='const'>Proc</span>
-      <span class='id identifier rubyid_on_error'>on_error</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_record'>record</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='rparen'>)</span>
-    <span class='kw'>else</span>
-      <span class='id identifier rubyid_raise'>raise</span>
-    <span class='kw'>end</span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-  </div>
-
-</div>
-
-      <div id="footer">
-  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.20 (ruby-2.5.5).
-</div>
-
-    </div>
-  </body>
-</html>