have-i-been-pwned 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4499b60218687b62e447a57c6942bd86f1d924ed2d330dea67382357de80a0c5
-  data.tar.gz: 37392cbb2e17412aa5baf742feb998a1c885e40457f310a163b3caa24b8e04f6
+  metadata.gz: e9d56f443e6331cf28ca775790d2e3ea43251fa7c9ec40202905a11a76617d57
+  data.tar.gz: ef622b864bcd4af8453bc7fd7fb342dba3bbb94e684505676f76af333e75cae1
 SHA512:
-  metadata.gz: bfec05fb4004c1ed692c9be17c794b5c877ae93701a61582f197ba9494e03e9bd8a104be971306d8b404138918759a9654bd44770a03140d5d82313f18d67077
-  data.tar.gz: 4ef2fbe0eeca0901c3aee39e92c49887b0ca7c287b6f88f3380a9274fef1b2cf653c273c54de2756822076a779ecf1e6c020320b63215a5af5799f12b6a11e5e
+  metadata.gz: a574c04219b911e6fb9939ad5c7c5121a5db93eef415db4a12266e3d1a0281fe56d7d52af45111fb7f3e74b1c998fce59088f5e1b6f25ff8767a5c1e49adc118
+  data.tar.gz: cdc0066ea1b6a9678372a44d22cc57b5018014277459df6934882f3f68a5940227b3244164977b5092df39a68a0068476256810b20c2edae5cd09dcf7e9eb2de

data/.travis.yml

@@ -18,7 +18,4 @@ deploy:
 notification:
   slack:
     rooms:
-      secure: YtIdbbN6Fflga3zJI9mN6OLmz6+8fxcJuvHlQO77NIea2CvBUP9jvJ5b2nc2aBxw8MJjJtVwvc0p5DlnA2w3tMSrk5KTJuoGNQa83LgzZEBNZOrvwSTwXoHRVWP+KoSnMwdhzknzZqC7dbskku/1MAfVnEvgpJxdrjeGF4z6/lDMb2GPHhRyYOaIiTLM8Ig/j8TeGAB5Javt4MbrQOgmhl76lNzNb6BhHUgVice4HNAEJKnYB+aKElGdVC1L+gy1Qqf7bGBpciz0omODo0UXxADV+KA2NzApFctEiElarvb2MN+K9PAu70ouz5q9GQ97KbGuVQzzpNJ2R5WHxrYTj4tRsAkhjHeUnv1Otues6Uhnc6jYLGZZHtQs5qyC3sFJz2bVMqJd0VIUl9BLnBPhRaZ2pOHYHJoLpVgNUX2WurEDew46MwnvojBnxOQ1A4/PLttH/n8ApYSQVM2Ynrgr7ZRdPCm14YfCrG6jDZylL6RqX5NsJFUKLP5wl5q8siESDVgecyMBFcTSitKI+BF7asIAth4Mw/Q3IUEPT8LwcQqVvvzssYbMUsJayhOC5aNXBQbadJeFRDZBdMeL1buNuZnITtBQTOdkkTxnf2DbK3eb5rBz9MDaUICm01QArADbANDrIl8qugnKta7o7xgn3yxa8FghmoklC9z+QCyYHSM=
-env:
-  matrix:
-    secure: N8raPga/MVy7t/QTxGpgYCqS8DzeDZxIkVa2jovcaHDc0Ul3v1oPnmlMbeE5dOHi2K9iiLnIH3Pe+u62Km4Vxp4xx7zS7Vm6yeMQyswUSkBGnMU75h3kaXGoaCIXR9b8yuJZajmME3fm5QH/rXBIOFQOCYEqLRpQzJgrGnHdgUGXm+QRL/anfFLcQGlH44Oyv1R4dAs0SFWZRcap3bnZLp04sSmvV5vG3pmca1YqSmMnUpptwP3UxIyTofwGbcDBHr86wxnaeUQYY/6ql52Di/yGhaswszJiKlQbI59beLhO/CGWQBrvjKyQR6Zk7YpX1pzfksQy/JWL8GW4ayB3qqifohRNChLH0/vD/EX219Cd02YXAXVVCAFvcAxRMab1Fct7rv/QHhzMfpsR6xazcFS+w6GBGcx1HtUvnPQXvt6kZ7oaQ1bTJ+5s02pz3BAJe5NoAYvxls12ou/ca6/B8pmCNDwwLzzO1XeiztKt0xE8tPpCYROeI4nel99i4nnYMMpoSUWqjwR4YKmoqkXlvMcKSCznHV7PhfXLF3h8vlK6dJWxJAo7iYcjcT2gRVt7biRt0K61zBRa/HF1zVSSfF/xpDkhSfV3nqu+UFlm9YIOri+2YSpvH4Az7sJPq8M2gaCasQUSevNEQ9BII/ouVvZK77vzUM+8LHo/X43fi0s=
+      secure: YtIdbbN6Fflga3zJI9mN6OLmz6+8fxcJuvHlQO77NIea2CvBUP9jvJ5b2nc2aBxw8MJjJtVwvc0p5DlnA2w3tMSrk5KTJuoGNQa83LgzZEBNZOrvwSTwXoHRVWP+KoSnMwdhzknzZqC7dbskku/1MAfVnEvgpJxdrjeGF4z6/lDMb2GPHhRyYOaIiTLM8Ig/j8TeGAB5Javt4MbrQOgmhl76lNzNb6BhHUgVice4HNAEJKnYB+aKElGdVC1L+gy1Qqf7bGBpciz0omODo0UXxADV+KA2NzApFctEiElarvb2MN+K9PAu70ouz5q9GQ97KbGuVQzzpNJ2R5WHxrYTj4tRsAkhjHeUnv1Otues6Uhnc6jYLGZZHtQs5qyC3sFJz2bVMqJd0VIUl9BLnBPhRaZ2pOHYHJoLpVgNUX2WurEDew46MwnvojBnxOQ1A4/PLttH/n8ApYSQVM2Ynrgr7ZRdPCm14YfCrG6jDZylL6RqX5NsJFUKLP5wl5q8siESDVgecyMBFcTSitKI+BF7asIAth4Mw/Q3IUEPT8LwcQqVvvzssYbMUsJayhOC5aNXBQbadJeFRDZBdMeL1buNuZnITtBQTOdkkTxnf2DbK3eb5rBz9MDaUICm01QArADbANDrIl8qugnKta7o7xgn3yxa8FghmoklC9z+QCyYHSM=

data/README.md

@@ -40,6 +40,13 @@ else
 end
 ```
 
+#### Timeout
+
+With both the pwned and pwned_account methods you can also introduce a custom timeout. By default the timeout is 30 seconds. You can customize is to your needs like so:
+```
+HaveIBeenPwned.pwned 'abc123', timeout: 10
+```
+
 ## Contributing
 - Open an issue about your change
 - Fork it, DL it

data/lib/have-i-been-pwned.rb

@@ -2,11 +2,15 @@ require 'httparty'
 require 'digest'
 
 module HaveIBeenPwned
+
+  DEFAULT_TIMEOUT = 30
+
   class << self
     # Check to see if a given password has been pwned/compromised by a breach.
     # @param [String] password The *password* you want to check.
+    # @param [Number] timeout Seconds until request timeout.
     # @return [Boolean] True if the password has been compromised, false otherwise
-    def pwned password
+    def pwned password, timeout: DEFAULT_TIMEOUT
       # if password is not nil
       if password
         # get a digest of the password
@@ -16,7 +20,7 @@ module HaveIBeenPwned
         # get the first 5 characters of the hash
         first_five = digest[0..4]
         # make the API call
-        results = HTTParty.get("https://api.pwnedpasswords.com/range/#{first_five}")
+        results = HTTParty.get("https://api.pwnedpasswords.com/range/#{first_five}", timeout: timeout)
 
         # guard: if we dont get something back
         return false unless results.code == 200
@@ -40,15 +44,16 @@ module HaveIBeenPwned
     # @param [String] email The email address you want to check
     # @param [String] api_key The v3 API required a paid key from haveibeenpwned.com. Can also be specified as a ENV VAR 'HIBP_API_KEY' {More Information}[https://www.troyhunt.com/authentication-and-the-have-i-been-pwned-api/]
     # @param [String] user_agent Provide a custom user agent. (default: haveibeenpwned-ruby-sdk)
+    # @param [Number] timeout Seconds until request timeout.
     # @return [[Hash], nil] Returns a array of hashes containing the [:name] of places the email was compromised by.
-    def pwned_account email, api_key = nil, user_agent = 'haveibeenpwned-ruby-sdk'
+    def pwned_account email, api_key = nil, user_agent = 'haveibeenpwned-ruby-sdk', timeout: DEFAULT_TIMEOUT
       api_key ||= ENV['HIBP_API_KEY'] # for testing
       throw 'You must provide a paid API key from haveibeenpwned.com to use this feature.' if api_key.nil?
       headers = {
         'user-agent' => user_agent,
         'Hibp-Api-Key' => api_key
       }
-      results = HTTParty.get("https://haveibeenpwned.com/api/v3/breachedaccount/#{email}", headers: headers)
+      results = HTTParty.get("https://haveibeenpwned.com/api/v3/breachedaccount/#{email}", headers: headers, timeout: timeout)
       return if results.nil?
       error_check = Hash[results.map { |(k, v)| [k.downcase.to_sym, v] }] rescue nil
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module HaveIBeenPwned
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/test/test_have_i_been_pwned_account.rb

@@ -6,6 +6,15 @@ class PwnedTest < Test::Unit::TestCase
     assert_not_nil HaveIBeenPwned.pwned_account('john@gmail.com') # just a very generic email that does fail
   end
 
+  def test_account_timeout
+    starting = Time.now
+    result = HaveIBeenPwned.pwned_account('major.monkey.ha.not.been.hacked@gmail.com', timeout: 1)
+    ending = Time.now
+    elapsed = (ending - starting).floor
+
+    assert_operator elapsed, :<=, 1
+  end
+
   def test_my_email_is_not_found
     assert_nil HaveIBeenPwned.pwned_account('major.monkey.ha.not.been.hacked@gmail.com')
   end

data/test/test_have_i_been_pwned_password.rb

@@ -2,24 +2,33 @@ require 'helper'
 
 class PwnedTest < Test::Unit::TestCase #Minitest::Test
   def test_abc123_is_found
-    assert_equal true, HaveIBeenPwned::pwned('abc123')
+    assert_equal true, HaveIBeenPwned.pwned('abc123')
+  end
+
+  def test_password_timeout
+    starting = Time.now
+    result = HaveIBeenPwned.pwned('abc123', timeout: 1)
+    ending = Time.now
+    elapsed = (ending - starting).floor
+
+    assert_operator elapsed, :<=, 1
   end
 
   def test_password_is_found
-    assert_equal true, HaveIBeenPwned::pwned('password')
+    assert_equal true, HaveIBeenPwned.pwned('password')
   end
 
   def test_crazy_long_password_is_not_found
-    assert_equal false, HaveIBeenPwned::pwned('dfsfk;lngfdsjlmkvsdlmjkvf8um54b89u5438mu0p435u0m5b409u54b09um5309um50u9m3b56u90m54jmgtrgv')
+    assert_equal false, HaveIBeenPwned.pwned('dfsfk;lngfdsjlmkvsdlmjkvf8um54b89u5438mu0p435u0m5b409u54b09um5309um50u9m3b56u90m54jmgtrgv')
   end
 
   def test_not_actually_providing_a_password_is_silly
-    assert_equal false, HaveIBeenPwned::pwned('')
+    assert_equal false, HaveIBeenPwned.pwned('')
   end
 
   def test_no_password_at_all_raises
     assert_raise("RuntimeError") {
-      HaveIBeenPwned::pwned
+      HaveIBeenPwned.pwned
     }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: have-i-been-pwned
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Dale Myszewski