pwned 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4b8270eaf162b50ef112371c2e35dd41141dec39e4e11d5a76936119e2ca569
-  data.tar.gz: fdec9b67cc6465fa64062697253e6cf078ddb2b2deb71cf829a919dca7953f48
+  metadata.gz: f655789ebeb4d8fc8cdd1a105960358b8995ecb2d65d50542c124dd025add187
+  data.tar.gz: 32b7024253941258a9d93e3fd556c25d7dc5f1d91b55c414d547bce7cd81f042
 SHA512:
-  metadata.gz: 7ec757852674e3e44ac71a71ed5c31d3503b5f0547871f940d56e8e2d8838b0b89e36742c0e10108f1c00fddc54016454d3ba77348cddd7be659d1ed4fdaf71a
-  data.tar.gz: 304b59ce60639f57c7a3a81c5e0f172dc8de9a2128018abe636be7f6d88074af59ac193d2538f86c298d4f8a537b0152bdcab6efb8cf4a27d5c6a13c64b9e311
+  metadata.gz: f298ab9734b71e795cb014986b93c37642539c45225add31f55a105a4238b0dcd57ae298682df0ad2ed69203d42f13181715dbcfeb1fe8f188a497e51f82cab9
+  data.tar.gz: c494a1fd491608e0bee4d47a97b356ae22887b2a041e33348a8784c14fbe68d5ab78451eb2b2e255e0b2f1702d41424b5a2e0b83549a93a3a9a2dd86abd1ad39

data/.github/workflows/tests.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.5, 2.6, 2.7, 3.0, head]
+        ruby: [2.6, 2.7, 3.0, 3.1, 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.
@@ -18,6 +18,12 @@ jobs:
             rails: 5.1.7
           - ruby: 3.0
             rails: 5.2.4.4
+          - ruby: 3.1
+            rails: 5.0.7.2
+          - ruby: 3.1
+            rails: 5.1.7
+          - ruby: 3.1
+            rails: 5.2.4.4
           - ruby: head
             rails: 5.0.7.2
           - ruby: head

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog for `Pwned`
 
-## Ongoing [☰](https://github.com/philnash/pwned/compare/v2.2.0...master)
+## Ongoing [☰](https://github.com/philnash/pwned/compare/v2.4.0...master)
+
+## 2.4.0 (February 23, 2022) [☰](https://github.com/philnash/pwned/compare/v2.3.0...v2.4.0)
+
+- Minor updates
+
+  - Adds `default_request_options` to set global defaults for the gem
+  - Adds Ruby 3.1 to the test matrix
 
 ## 2.3.0 (August 30, 2021) [☰](https://github.com/philnash/pwned/compare/v2.2.0...v2.3.0)
 

data/README.md

@@ -110,12 +110,20 @@ Pwned.pwned_count("password")
 
 #### Custom request options
 
-You can set http request options to be used with `Net::HTTP.start` when making the request to the API. These options are documented in the [`Net::HTTP.start` documentation](https://ruby-doc.org/stdlib-3.0.0/libdoc/net/http/rdoc/Net/HTTP.html#method-c-start). For example:
+You can set HTTP request options to be used with `Net::HTTP.start` when making the request to the API. These options are documented in the [`Net::HTTP.start` documentation](https://ruby-doc.org/stdlib-3.0.0/libdoc/net/http/rdoc/Net/HTTP.html#method-c-start).
+
+You can pass the options to the constructor:
 
 ```ruby
 password = Pwned::Password.new("password", read_timeout: 10)
 ```
 
+You can also specify global defaults:
+
+```ruby
+Pwned.default_request_options = { read_timeout: 10 }
+```
+
 ##### HTTP Headers
 
 The `:headers` option defines defines HTTP headers. These headers must be string keys.
@@ -220,7 +228,7 @@ 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). 
+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).
 
 ```ruby
   validates :password, not_pwned: {
@@ -231,6 +239,8 @@ You can configure network requests made from the validator using `:request_optio
   }
 ```
 
+These options override the globally defined default options (see above).
+
 In addition to these options, you can also set the following:
 
 ##### HTTP Headers
@@ -278,15 +288,15 @@ If you don't want to set a proxy and you don't want a proxy to be inferred from
 
 ### Using Asynchronously
 
-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:
+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::HashedPassword` class with the hash, like this:
 
 ```ruby
 hashed_password = Pwned.hash_password(password)
 # some time later
-Pwned::HashPassword.new(hashed_password, request_options).pwned?
+Pwned::HashedPassword.new(hashed_password, request_options).pwned?
 ```
 
-The `Pwned::HashPassword` constructor takes all the same options as the regular `Pwned::Password` contructor.
+The `Pwned::HashedPassword` constructor takes all the same options as the regular `Pwned::Password` contructor.
 
 ### Devise
 

data/lib/pwned/deep_merge.rb

@@ -0,0 +1,13 @@
+module DeepMerge
+  refine Hash do
+    def deep_merge(other)
+      self.merge(other) do |key, this_val, other_val|
+        if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+          this_val.deep_merge(other_val)
+        else
+          other_val
+        end
+      end
+    end
+  end
+end

data/lib/pwned/hashed_password.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "pwned/password_base"
+require "pwned/deep_merge"
+
 
 module Pwned
   ##
@@ -9,6 +11,7 @@ module Pwned
   # @see https://haveibeenpwned.com/API/v2#PwnedPasswords
   class HashedPassword
     include PasswordBase
+    using DeepMerge
     ##
     # Creates a new hashed password object.
     #
@@ -19,7 +22,7 @@ module Pwned
     #
     # @param hashed_password [String] The hash of 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
+    #   calling the API. This overrides any keys specified in +Pwned.default_request_options+.
     # @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
@@ -30,11 +33,11 @@ module Pwned
     def initialize(hashed_password, request_options={})
       raise TypeError, "hashed_password must be of type String" unless hashed_password.is_a? String
       @hashed_password = hashed_password.upcase
-      @request_options = Hash(request_options).dup
-      @request_headers = Hash(request_options.delete(:headers))
+      @request_options = Pwned.default_request_options.deep_merge(request_options)
+      @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)
-      @ignore_env_proxy = request_options.delete(:ignore_env_proxy) || false
+      @request_proxy = URI(@request_options.delete(:proxy)) if @request_options.key?(:proxy)
+      @ignore_env_proxy = @request_options.delete(:ignore_env_proxy) || false
     end
   end
 end

data/lib/pwned/password.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "pwned/password_base"
+require "pwned/deep_merge"
 
 module Pwned
   ##
@@ -9,6 +10,7 @@ module Pwned
   # @see https://haveibeenpwned.com/API/v2#PwnedPasswords
   class Password
     include PasswordBase
+    using DeepMerge
     ##
     # @return [String] the password that is being checked.
     # @since 1.0.0
@@ -24,7 +26,7 @@ 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
+    #   calling the API. This overrides any keys specified in +Pwned.default_request_options+.
     # @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
@@ -36,11 +38,11 @@ module Pwned
       raise TypeError, "password must be of type String" unless password.is_a? String
       @password = password
       @hashed_password = Pwned.hash_password(password)
-      @request_options = Hash(request_options).dup
-      @request_headers = Hash(request_options.delete(:headers))
+      @request_options = Pwned.default_request_options.deep_merge(request_options)
+      @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)
-      @ignore_env_proxy = request_options.delete(:ignore_env_proxy) || false
+      @request_proxy = URI(@request_options.delete(:proxy)) if @request_options.key?(:proxy)
+      @ignore_env_proxy = @request_options.delete(:ignore_env_proxy) || false
     end
   end
 end

data/lib/pwned/version.rb

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

data/lib/pwned.rb

@@ -23,6 +23,29 @@ end
 # results for a password.
 
 module Pwned
+  @default_request_options = {}
+
+  ##
+  # The default request options passed to +Net::HTTP.start+ when calling the API.
+  #
+  # @return [Hash]
+  # @see Pwned::Password#initialize
+  def self.default_request_options
+    @default_request_options
+  end
+
+  ##
+  # Sets the default request options passed to +Net::HTTP.start+ when calling
+  # the API.
+  #
+  # The default options may be overridden in +Pwned::Password#new+.
+  #
+  # @param [Hash] request_options
+  # @see Pwned::Password#initialize
+  def self.default_request_options=(request_options)
+    @default_request_options = request_options
+  end
+
   ##
   # Returns +true+ when the password has been pwned.
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwned
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Phil Nash
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2022-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,6 +110,7 @@ files:
 - bin/setup
 - lib/locale/en.yml
 - lib/pwned.rb
+- lib/pwned/deep_merge.rb
 - lib/pwned/error.rb
 - lib/pwned/hashed_password.rb
 - lib/pwned/not_pwned_validator.rb