vpndetection 3.2.1 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 968cc7e17b2c94d267e03fe6110e7780fc6c2f8a5710b1f642ce433013ecce65
-  data.tar.gz: e3d165e53eb9e0aaffb73cf35710970727f9e0e5c163c1ac7132dfbb694b63de
+  metadata.gz: 164314052bfd32f74acb272ff59c077ab1a841395c9818954ea83f6b167464ce
+  data.tar.gz: e41ccca025ec996d64861e26ba7fc6c3bbcca85628d9c402dedc35f372f96f6d
 SHA512:
-  metadata.gz: 463de94ed352de2c514a1614ae59b37021ec28faa33c5c664b11c33124c551ba00f30fc457e4f1a3c1864b5d8d6dd0ae630c86598629af79e50d818c89952aac
-  data.tar.gz: fc051a127d33bff9c8bd5cac109807f493baf4876c9fc5b673ba6d22e485fab026f8ef81a2d66ea0714233d004c4af6cddf4a7b85b5e8964707113ef2d051f88
+  metadata.gz: 7b65573bf40eed189922a26a7131225bf1ba805a671404dd506a23d948e4ca98b2b4bf774dbeb3bcffdc1b7821fad819c3d9d19e75dbcf8ab46470c4a8a2f26d
+  data.tar.gz: c9685a07643394cd7eef10034b740fb119bf1d16d89be927baf80f8db342e99fb0aa5ba073614196ba31d32e84c4e3ddebdf594e9d919afac193e38c78326e1b

data/lib/vpndetection/api/account_wire_api.rb

@@ -0,0 +1,79 @@
+=begin
+#VPNDetection API
+
+#The VPNDetection API: classify any IP address, and download the databases behind the answers.  See https://docs.vpndetection.io for guides and https://github.com/vpndetection-io for the official client libraries. 
+
+The version of the OpenAPI document: 2026.09.13
+Contact: support@vpndetection.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'cgi'
+
+module VPNDetection
+  class AccountWireApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Your key, plan and usage
+    # Answers what the presented key is, what plan is behind it, and what has been spent against that plan's allowance in the current window. 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountMe]
+    def account_me(opts = {})
+      data, _status_code, _headers = account_me_with_http_info(opts)
+      data
+    end
+
+    # Your key, plan and usage
+    # Answers what the presented key is, what plan is behind it, and what has been spent against that plan's allowance in the current window. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountMe, Integer, Hash)>] AccountMe data, response status code and response headers
+    def account_me_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountWireApi.account_me ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/account/me'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountMe'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyQuery', 'bearerAuth', 'apiKeyHeader']
+
+      new_options = opts.merge(
+        :operation => :"AccountWireApi.account_me",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountWireApi#account_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/vpndetection/api/database_wire_api.rb

@@ -226,7 +226,7 @@ module VPNDetection
     end
 
     # List
-    # Every database this organization holds a licence for, with the term and the license_type right beside each one. 
+    # Every database this organization may SEE, with where its licence stands. Not just the ones you hold: a customer with one grant should be able to tell what else is published without asking. `standing` is the difference - `licensed`, `expired`, or `unlicensed` for one never bought. 
     # @param [Hash] opts the optional parameters
     # @return [DatabaseList]
     def list_databases(opts = {})
@@ -235,7 +235,7 @@ module VPNDetection
     end
 
     # List
-    # Every database this organization holds a licence for, with the term and the license_type right beside each one. 
+    # Every database this organization may SEE, with where its licence stands. Not just the ones you hold: a customer with one grant should be able to tell what else is published without asking. `standing` is the difference - `licensed`, `expired`, or `unlicensed` for one never bought. 
     # @param [Hash] opts the optional parameters
     # @return [Array<(DatabaseList, Integer, Hash)>] DatabaseList data, response status code and response headers
     def list_databases_with_http_info(opts = {})

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

@@ -177,10 +177,6 @@ module VPNDetection
       @ignore_operation_servers = false
       @inject_format = false
       @force_ending_format = false
-      # `::Rails`, not `Rails`: this file is inside `module VPNDetection`, so a
-      # bare constant resolves to `VPNDetection::Rails` first if one exists -
-      # and one does, as soon as the vpndetection-rails gem is loaded. The
-      # intent has always been the top-level Rails.
       @logger = defined?(::Rails) ? ::Rails.logger : Logger.new(STDOUT)
 
       yield(self) if block_given?
@@ -278,10 +274,6 @@ module VPNDetection
         {
           url: "https://api.vpndetection.io",
           description: "Production",
-        },
-        {
-          url: "https://api-staging.vpndetection.io",
-          description: "Staging",
         }
       ]
     end

data/lib/vpndetection/models/account_apikey.rb

@@ -0,0 +1,207 @@
+=begin
+#VPNDetection API
+
+#The VPNDetection API: classify any IP address, and download the databases behind the answers.  See https://docs.vpndetection.io for guides and https://github.com/vpndetection-io for the official client libraries. 
+
+The version of the OpenAPI document: 2026.09.13
+Contact: support@vpndetection.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module VPNDetection
+  # The credential itself. The key is never echoed - only its id, which is what the console shows and what you can act on. 
+  class AccountApikey < ApiModelBase
+    attr_accessor :id
+
+    # Null for a key with no end date, which is the normal case.
+    attr_accessor :expires
+
+    # The source addresses this key may be used from. EMPTY means unrestricted, never \"deny all\". 
+    attr_accessor :allowed_cidrs
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'expires' => :'expires',
+        :'allowed_cidrs' => :'allowed_cidrs'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'expires' => :'Time',
+        :'allowed_cidrs' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'expires',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `VPNDetection::AccountApikey` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `VPNDetection::AccountApikey`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'expires')
+        self.expires = attributes[:'expires']
+      else
+        self.expires = nil
+      end
+
+      if attributes.key?(:'allowed_cidrs')
+        if (value = attributes[:'allowed_cidrs']).is_a?(Array)
+          self.allowed_cidrs = value
+        end
+      else
+        self.allowed_cidrs = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @allowed_cidrs.nil?
+        invalid_properties.push('invalid value for "allowed_cidrs", allowed_cidrs cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @allowed_cidrs.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] allowed_cidrs Value to be assigned
+    def allowed_cidrs=(allowed_cidrs)
+      if allowed_cidrs.nil?
+        fail ArgumentError, 'allowed_cidrs cannot be nil'
+      end
+
+      @allowed_cidrs = allowed_cidrs
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          expires == o.expires &&
+          allowed_cidrs == o.allowed_cidrs
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, expires, allowed_cidrs].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/vpndetection/models/account_error.rb

@@ -0,0 +1,164 @@
+=begin
+#VPNDetection API
+
+#The VPNDetection API: classify any IP address, and download the databases behind the answers.  See https://docs.vpndetection.io for guides and https://github.com/vpndetection-io for the official client libraries. 
+
+The version of the OpenAPI document: 2026.09.13
+Contact: support@vpndetection.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module VPNDetection
+  class AccountError < ApiModelBase
+    attr_accessor :error
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'error' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `VPNDetection::AccountError` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `VPNDetection::AccountError`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      else
+        self.error = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @error.nil?
+        invalid_properties.push('invalid value for "error", error cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @error.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] error Value to be assigned
+    def error=(error)
+      if error.nil?
+        fail ArgumentError, 'error cannot be nil'
+      end
+
+      @error = error
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          error == o.error
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [error].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end