vpndetection 5.11.2 → 5.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1790fe45568e0bb346e2215405578d4b59201ed4ecff60fe742a47562c1d2c7e
-  data.tar.gz: 6ca815855814e7682b1411f6140855632260c47962441e122746be47998d6b08
+  metadata.gz: eb13e51eaae8cf5af6b2eed52cac37486bf9399727527f7afa3884d46b4853ca
+  data.tar.gz: 1bfccf0c65a221a3ea8858c29c2b9815378c3a3695ca919cb6df57b5a2613074
 SHA512:
-  metadata.gz: 0fcd4b52863e0ca78417823d7df8aad76d717fe097036d90d4e37ead2c42900c6c23e6798e36e35d2d99200f66171e65655c506a501cd8d9f7d089a0ade96732
-  data.tar.gz: 5dd04eca217c3f2df8a6bd11a439368d4bdcab9af9264e49222fccbbd496fb4a627ed423c372c3dff2de0e2e9fdb99e2ff89fd79d87b3275d3e566f87aac061f
+  metadata.gz: de0cbd1d51f8f72629daec0959d85384f30aa61567b882e377e9a05120bea4c92b48df6b216e98c24a9bf7dc2bb063fdb589783b3840915318ea272e49c1224a
+  data.tar.gz: dbc4652065381fa5d7df6eea1daa5d458047b69a42a015928306a9ddddb8aef81990d719107661cd9a5ac2f5301d01e75e6788e7b9a4fc1a5fef97d4737e5ab2

data/README.md

@@ -161,7 +161,7 @@ client = VPNDetection::Client.new(timeout: 10, retries: 4)
 result = client.lookup('45.83.91.1', timeout: 2, retries: 0)
 ```
 
-`timeout` is in seconds and bounds each attempt, body included, so a call that is retried can take longer in total. It defaults to 30 seconds, and 0 means no bound; before 5.2.0 the default was 10, so pass `timeout: 10` to keep that bound. The client's values are defaults: `lookup`, `lookup_batch`, `my_ip` and `my_entitlement` each take `timeout:` and `retries:` for that call alone, and every `client.oauth` method and every `client.database` call that is not a transfer takes `timeout:` (from 5.3.0). A database download bounds only its connection with it, because a whole transfer can take minutes. A negative value, anything that isn't a number, and anything past 2147483.647 seconds (the longest curl holds) raise `ArgumentError` where you pass them, before any request.
+`timeout` is in seconds and bounds each attempt, body included, so a call that is retried can take longer in total. It defaults to 30 seconds, and 0 means no bound; before 5.2.0 the default was 10, so pass `timeout: 10` to keep that bound. The client's values are defaults: `lookup`, `lookup_batch`, `my_ip` and `my_entitlement` each take `timeout:` and `retries:` for that call alone, and every `client.oauth` method and every `client.database` call that is not a transfer takes `timeout:` (from 5.3.0). A database download bounds only its connection with it, because a whole transfer can take minutes. A negative value, anything that isn't a number, and anything past 2147483.647 seconds (the longest curl holds) raise `ArgumentError` where you pass them, before any request. So does a `retries` that isn't an Integer from 0 (from 5.11.3).
 
 ### Database downloads
 

data/lib/vpndetection/client.rb

@@ -29,9 +29,9 @@ module VPNDetection
     # @param cache [Boolean] pass false to disable caching.
     # @param cache_ttl [Numeric] how long an answer stays fresh, in seconds.
     # @param concurrency [Integer] batch requests - chunks of up to 1000 addresses - in flight during a batch.
-    # @param retries [Integer] extra attempts for a transient failure. Each waits
-    #   the server's `Retry-After` when it sent one of at most about 24.8 days,
-    #   and otherwise a backoff of 250 ms that doubles per retry.
+    # @param retries [Integer] extra attempts for a transient failure, from 0. Each
+    #   waits the server's `Retry-After` when it sent one of at most about 24.8
+    #   days, and otherwise a backoff of 250 ms that doubles per retry.
     # @param timeout [Numeric] seconds one request may take before it is
     #   abandoned, 0 for no bound. Applies per ATTEMPT, so a retried call may take
     #   longer in total, and every call that takes `retries:` also takes
@@ -40,12 +40,14 @@ module VPNDetection
     # @raise [ArgumentError] for an `api_key` with a control character in it.
     # @raise [ArgumentError] for a `timeout`, here or on any call, that is
     #   negative, not a finite number, or past 2147483.647 seconds (2**31 - 1 ms),
-    #   the longest curl holds.
+    #   the longest curl holds, and for a `retries`, here or on any call, that is
+    #   not an Integer from 0.
     # @param transport [Transport, nil] override the HTTP layer, mostly for tests.
     def initialize(api_key: nil, base_url: DEFAULT_BASE_URL, cache: true,
                    cache_max_size: DEFAULT_CACHE_MAX_SIZE, cache_ttl: DEFAULT_CACHE_TTL,
                    concurrency: DEFAULT_CONCURRENCY, retries: DEFAULT_RETRIES,
                    timeout: DEFAULT_TIMEOUT, transport: nil)
+      retries = Retries.checked_count(retries)
       @transport = transport || Transport.new(
         Transport::Config.new(api_key: api_key, base_url: base_url, timeout: timeout),
       )
@@ -80,6 +82,7 @@ module VPNDetection
     def lookup(ip, retries: nil, timeout: nil)
       # Here as well as in the transport: a bogon or a cached answer returns before any request.
       Transport.checked_timeout(timeout) unless timeout.nil?
+      Retries.checked_count(retries) unless retries.nil?
       # Judged, cached and sent as the IPv4 address it carries, if it is mapped.
       ip = Bogon.unmapped(ip)
       return Bogon.result(ip) if Bogon.bogon?(ip)
@@ -117,6 +120,7 @@ module VPNDetection
     # this is IS the question: a machine that moves between networks would
     # otherwise be told where it used to be.
     def my_ip(retries: nil, timeout: nil)
+      Retries.checked_count(retries) unless retries.nil?
       Retries.with_retries(retries || @retries) do
         Transport.lookup_result(@transport.myip_request(timeout: timeout).run)
       end
@@ -142,6 +146,7 @@ module VPNDetection
     #
     # @return [Entitlement]
     def my_entitlement(retries: nil, timeout: nil)
+      Retries.checked_count(retries) unless retries.nil?
       Retries.with_retries(retries || @retries) do
         Transport.entitlement_result(@transport.entitlement_request(timeout: timeout).run)
       end
@@ -169,6 +174,7 @@ module VPNDetection
         raise Error.new(:bad_request, "concurrency must be at least 1, not #{limit.inspect}")
       end
       Transport.checked_timeout(timeout) unless timeout.nil?
+      Retries.checked_count(retries) unless retries.nil?
 
       # An IPv4-mapped address is sent as the address it carries, once however
       # many of its spellings were asked, and answered under each one asked.

data/lib/vpndetection/middleware/core.rb

@@ -40,6 +40,7 @@ module VPNDetection
         @skip = options[:skip]
         @on_warn = options[:on_warn]
         @retries = options.fetch(:retries, DEFAULT_RETRIES)
+        Retries.checked_count(@retries) unless @retries.nil?
         @warned = {}
         @client = options[:client] || Client.new(
           api_key: options[:api_key],

data/lib/vpndetection/retries.rb

@@ -15,6 +15,15 @@ module VPNDetection
 
     module_function
 
+    # `retries`, once it is a count. Refused where it is set: unchecked, -1 and
+    # NaN read as none, 1.5 as two, Infinity retried a failing call for good, and
+    # a String or nil raised a raw ArgumentError out of every failing call.
+    def checked_count(retries)
+      return retries if retries.is_a?(Integer) && retries >= 0
+
+      raise ArgumentError, "retries must be an Integer from 0, not #{retries.inspect}"
+    end
+
     # `retry_if`, when given, is asked after each retryable failure, and a false
     # answer ends the attempts there.
     def with_retries(retries, retry_if: nil)

data/lib/vpndetection/transport.rb

@@ -367,7 +367,9 @@ module VPNDetection
         when 'Integer' then value.is_a?(Integer)
         when 'Float' then value.is_a?(Numeric)
         when 'Boolean' then [true, false].include?(value)
-        when 'Object' then true
+        # The spec's `type: object`, a sample row: through 5.11.2 a row of 1, "x"
+        # or [] came back as the answer.
+        when 'Object' then value.is_a?(Hash)
         when /\AArray<(?<inner>.+)>\z/
           inner = Regexp.last_match(:inner)
           value.is_a?(Array) && value.each_with_index.all? { |v, i| check_type!(v, inner, "#{where}[#{i}]") }

data/lib/vpndetection/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VPNDetection
-  VERSION = '5.11.2'
+  VERSION = '5.11.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vpndetection
 version: !ruby/object:Gem::Version
-  version: 5.11.2
+  version: 5.11.3
 platform: ruby
 authors:
 - Mslm Dev