pwned 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4661790082f543ba897baf211da660c7a4f654444121f4ff3ba08542c08c412b
-  data.tar.gz: f52a3f3cf36d461e8704a632f97829a5d9f871d9916a55687d4a0b2156b44b75
+  metadata.gz: 1790330e2068217b48ba0929c4b2409dfecd939e76f7d231acc872ef9802320a
+  data.tar.gz: afa13cc83a53df1be859a74876e00992b15eed757e571bec652168d85b3ab73e
 SHA512:
-  metadata.gz: c114c3ca6e7667d1760ad2ae5dabcc7bf8d14b91e42788f7e36bba716eecd9bef6e1847e93dd12df4f8afed19460d26a068dc22ffb2270ceef8dc342f81690e0
-  data.tar.gz: c19d20d765cd57e64468c27a3e8f134e53d8f6e9ae22497c2d94a315a584e2e19b1913d47b37e89c9525ce80d85d10d43437a623d211766aa7242dbe1144e906
+  metadata.gz: 23482aeeab95bb130ba04f1fdc57f769282d78c7c4c56c594f15652c472ffce9573967d8a31d539548a325c85f54aa038d65bb023aded41352147ad9a906534e
+  data.tar.gz: d31fb7ad5171adc4cc8ee28ed97d125fbd19c93bc68e65e7921076d1fb586748a1a4f12007e70cbfe6378e3c868effa756efaa08e627bfa82b2c73166e0b7dd1

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: philnash

data/.github/workflows/tests.yml

@@ -0,0 +1,39 @@
+name: tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7, 3.0, head]
+        rails: [4.2.11.3, 5.0.7.2, 5.1.7, 5.2.4.4, 6.0.3.4, 6.1.0]
+        exclude:
+          # Ruby 3.0 and Rails 5 do not get along together.
+          - ruby: 3.0
+            rails: 5.0.7.2
+          - ruby: 3.0
+            rails: 5.1.7
+          - ruby: 3.0
+            rails: 5.2.4.4
+          - ruby: head
+            rails: 5.0.7.2
+          - ruby: head
+            rails: 5.1.7
+          - ruby: head
+            rails: 5.2.4.4
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') }}
+    env:
+      RAILS_VERSION: ${{ matrix.rails }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: "Install dependencies (rails: ${{matrix.rails}})"
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Ongoing [☰](https://github.com/philnash/pwned/compare/v2.0.2...master)
 
+## 2.2.0 (March 27, 2021) [☰](https://github.com/philnash/pwned/compare/v2.1.0...v2.2.0)
+
+- Minor updates
+
+  - Adds `:proxy` option to `request_options` to directly set a proxy on the
+    request. Fixes #21, thanks [dparpyani](https://github.com/dparpyani).
+
 ## 2.1.0 (July 8, 2020) [☰](https://github.com/philnash/pwned/compare/v2.0.2...v2.1.0)
 
 - Minor 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) [![Inline docs](https://inch-ci.org/github/philnash/pwned.svg?branch=master)](https://inch-ci.org/github/philnash/pwned)
+[![Gem Version](https://badge.fury.io/rb/pwned.svg)](https://rubygems.org/gems/pwned) ![Build Status](https://github.com/philnash/pwned/workflows/tests/badge.svg) [![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://www.rubydoc.info/gems/pwned) | [GitHub repo](https://github.com/philnash/pwned)
 
@@ -22,7 +22,9 @@ An easy, Ruby way to use the Pwned Passwords API.
       - [Custom Request Options](#custom-request-options)
     - [Using Asynchronously](#using-asynchronously)
     - [Devise](#devise)
+    - [Rodauth](#rodauth)
     - [Command line](#command-line)
+    - [Unpwn](#unpwn)
   - [How Pwned is Pi?](#how-pwned-is-pi)
   - [Development](#development)
   - [Contributing](#contributing)
@@ -180,18 +182,22 @@ end
 #### Custom Request Options
 
 You can configure network requests made from the validator using `:request_options` (see [Net::HTTP.start](http://ruby-doc.org/stdlib-2.6.3/libdoc/net/http/rdoc/Net/HTTP.html#method-c-start) for the list of available options).
-In addition to these options, HTTP headers can be specified with the `:headers` key, e.g. `"User-Agent"`):
+In addition to these options, HTTP headers can be specified with the `:headers` key (e.g. `"User-Agent"`) and proxy can be specified with the `:proxy` key:
 
 ```ruby
   validates :password, not_pwned: {
-    request_options: { read_timeout: 5, open_timeout: 1, headers: { "User-Agent" => "Super fun user agent" } }
+    request_options: {
+      read_timeout: 5,
+      open_timeout: 1,
+      headers: { "User-Agent" => "Super fun user agent" },
+      proxy: "https://username:password@example.com:12345"
+    }
   }
 ```
 
 ### Using Asynchronously
 
-You may have a use case for hashing the password in advance, and then making the call to the Pwned api later
-(for example if you want to enqueue a job without storing the plaintext password):
+You may have a use case for hashing the password in advance, and then making the call to the Pwned Passwords API later (for example if you want to enqueue a job without storing the plaintext password). To do this, you can hash the password with the `Pwned.hash_password` method and then initialize the `Pwned::HashPassword` class with the hash, like this:
 
 ```ruby
 hashed_password = Pwned.hash_password(password)
@@ -201,7 +207,11 @@ Pwned::HashPassword.new(hashed_password, request_options).pwned?
 
 ### Devise
 
-If you are using Devise I recommend you use the [devise-pwned_password extension](https://github.com/michaelbanfield/devise-pwned_password) which is now powered by this gem.
+If you are using [Devise](https://github.com/heartcombo/devise) I recommend you use the [devise-pwned_password extension](https://github.com/michaelbanfield/devise-pwned_password) which is now powered by this gem.
+
+### Rodauth
+
+If you are using [Rodauth](https://github.com/jeremyevans/rodauth) then you can use the [rodauth-pwned](https://github.com/janko/rodauth-pwned) feature which is powered by this gem.
 
 ### Command line
 
@@ -221,6 +231,10 @@ $ pwned --secret
 
 You will be prompted for the password, but it won't be displayed.
 
+### Unpwn
+
+To cut down on unnecessary network requests, [the unpwn project](https://github.com/indirect/unpwn) uses a list of the top one million passwords to check passwords against. Only if a password is not included in the top million is it then checked against the Pwned Passwords API.
+
 ## How Pwned is Pi?
 
 [@daz](https://github.com/daz) [shared](https://twitter.com/dazonic/status/1074647842046660609) a fantastic example of using this gem to show how many times the digits of Pi have been used as passwords and leaked.

data/lib/pwned/hashed_password.rb

@@ -30,6 +30,7 @@ module Pwned
       @request_options = Hash(request_options).dup
       @request_headers = Hash(request_options.delete(:headers))
       @request_headers = DEFAULT_REQUEST_HEADERS.merge(@request_headers)
+      @request_proxy = URI(request_options.delete(:proxy)) if request_options.key?(:proxy)
     end
   end
 end

data/lib/pwned/password.rb

@@ -37,6 +37,7 @@ module Pwned
       @request_options = Hash(request_options).dup
       @request_headers = Hash(request_options.delete(:headers))
       @request_headers = DEFAULT_REQUEST_HEADERS.merge(@request_headers)
+      @request_proxy = URI(request_options.delete(:proxy)) if request_options.key?(:proxy)
     end
   end
 end

data/lib/pwned/password_base.rb

@@ -65,7 +65,7 @@ module Pwned
 
     private
 
-    attr_reader :request_options, :request_headers
+    attr_reader :request_options, :request_headers, :request_proxy
 
     def fetch_pwned_count
       for_each_response_line do |line|
@@ -108,7 +108,15 @@ module Pwned
       request.initialize_http_header(request_headers)
       request_options[:use_ssl] = true
 
-      Net::HTTP.start(uri.host, uri.port, request_options) do |http|
+      Net::HTTP.start(
+        uri.host,
+        uri.port,
+        request_proxy&.host,
+        request_proxy&.port,
+        request_proxy&.user,
+        request_proxy&.password,
+        request_options
+      ) do |http|
         http.request(request, &block)
       end
     end

data/lib/pwned/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwned
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Phil Nash
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2021-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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
@@ -125,7 +126,7 @@ metadata:
   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
@@ -140,8 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+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