vpndetection 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5e55f291802dac250f1170cbc48751d463f5fb2a0c182a69301fe1627c245a5
-  data.tar.gz: c8dc05902e2c94bc9a843897717684883bdc9429e36682c9c20b5486862da66a
+  metadata.gz: 164314052bfd32f74acb272ff59c077ab1a841395c9818954ea83f6b167464ce
+  data.tar.gz: e41ccca025ec996d64861e26ba7fc6c3bbcca85628d9c402dedc35f372f96f6d
 SHA512:
-  metadata.gz: '0186489fad83fb671a47344cf3a5c63dbfaa05cab0b905c8dbeaa4c70c7305f36c3062828f747532b92be13f185659aa4fb282f6a4245557fc1b0328d757d42c'
-  data.tar.gz: e2cec75355df5c8d328939857e6249c22980bf8e4d90210297aa4b78ceb3e4c7491a53f37dfa41657b982c046a900ee379ff99cc8f10cf1ad8a68f07b31fd7e5
+  metadata.gz: 7b65573bf40eed189922a26a7131225bf1ba805a671404dd506a23d948e4ca98b2b4bf774dbeb3bcffdc1b7821fad819c3d9d19e75dbcf8ab46470c4a8a2f26d
+  data.tar.gz: c9685a07643394cd7eef10034b740fb119bf1d16d89be927baf80f8db342e99fb0aa5ba073614196ba31d32e84c4e3ddebdf594e9d919afac193e38c78326e1b

data/lib/vpndetection/client.rb

@@ -67,6 +67,47 @@ module VPNDetection
       result
     end
 
+    # Classify the address this client is calling from.
+    #
+    # The same answer {#lookup} would give for that address, at the same cost
+    # against your allowance. The address is the one our edge observed, so a
+    # call made through a proxy or a VPN reports the exit it left through -
+    # usually the point of asking.
+    #
+    # Deliberately NOT cached. The cache is keyed by address, and which address
+    # 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)
+      Retries.with_retries(retries || @retries) do
+        Transport.lookup_result(@transport.myip_request.run)
+      end
+    end
+
+    # What this client's key is entitled to, and how much of it has been used.
+    #
+    # Named for what it answers rather than `me`, which sits one letter from
+    # {#my_ip} and means something quite different: one is which address you are
+    # calling FROM, the other is which account you are calling AS.
+    #
+    # Unlike a lookup there is no useful unauthenticated answer, so a client
+    # built without an API key gets an unauthorized error rather than a partial
+    # one.
+    #
+    # Usage counts against the ALLOWANCE WINDOW - the anniversary of the
+    # subscription, not the calendar month and not the billing period - and it
+    # is the same number a lookup is gated on. It can lag by a few seconds,
+    # because requests are counted in memory and flushed in aggregate.
+    #
+    # Deliberately NOT cached: the whole point is what has been spent, and a
+    # cached answer is a wrong one within seconds of the next request.
+    #
+    # @return [AccountMe]
+    def my_account(retries: nil)
+      Retries.with_retries(retries || @retries) do
+        Transport.account_result(@transport.account_request.run)
+      end
+    end
+
     # Classify many addresses in parallel.
     #
     # Keyed by address rather than positional, so duplicates in the input

data/lib/vpndetection/configuration.rb

@@ -274,10 +274,6 @@ module VPNDetection
         {
           url: "https://api.vpndetection.io",
           description: "Production",
-        },
-        {
-          url: "https://api-staging.vpndetection.io",
-          description: "Staging",
         }
       ]
     end

data/lib/vpndetection/transport.rb

@@ -13,6 +13,8 @@ module VPNDetection
     # requests to queue them on a hydra and cannot go through the generated
     # method, which runs each request as it builds it.
     LOOKUP_PATH = '/{ip}'
+    MYIP_PATH = '/myip'
+    ACCOUNT_ME_PATH = '/api/v1/account/me'
 
     # The generated Configuration applies EVERY security scheme the spec lists,
     # so a keyless client would send `Authorization: Bearer `, an empty
@@ -89,6 +91,29 @@ module VPNDetection
       )
     end
 
+    def myip_request
+      build_request(
+        :GET, MYIP_PATH,
+        header_params: { 'Accept' => 'application/json' },
+        auth_names: %w[bearerAuth apiKeyHeader apiKeyQuery],
+      )
+    end
+
+    def account_request
+      build_request(
+        :GET, ACCOUNT_ME_PATH,
+        header_params: { 'Accept' => 'application/json' },
+        auth_names: %w[bearerAuth apiKeyHeader apiKeyQuery],
+      )
+    end
+
+    def self.account_result(response)
+      raise Error.from_transport(response) if transport_failure?(response)
+      raise Error.from_status(response.code, response.headers, response.body) unless response.success?
+
+      AccountMe.build_from_hash(parse_object(response))
+    end
+
     def self.lookup_result(response)
       raise Error.from_transport(response) if transport_failure?(response)
       raise Error.from_status(response.code, response.headers, response.body) unless response.success?

data/lib/vpndetection/version.rb

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

metadata

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