internetdata 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5319d9c11ea38c2debe6a794a88675b15a1fa859b143aff8038494a6dcaed084
+  data.tar.gz: 919e43190131f93f1e125883d02cbb9aed1d701444bd35becad968ee50104008
+SHA512:
+  metadata.gz: aed277c219dfd96a398f53de465dd74cacc2c767e48d8cccb6fde98c6a2db3de69a89e1ea3652b1922fa247ac2b56c12d6c99a824011b941daf130f3df0d0ad6
+  data.tar.gz: 6efaab8bd604991aaf06e6db95c18e7391d4f36a65adc41f1345a6ae53f26eca35a3af56dc1a354ead0ff68b9a15f654842b9be3cb3af569a06fa8a2d9f435a3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mslm Dev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,125 @@
+# [<img src="https://s3.internetdata.io/internetdata-public/brand/mark.svg" alt="InternetData" width="24"/>](https://internetdata.io/) InternetData Ruby Client Library
+
+[![gem](https://img.shields.io/gem/v/internetdata.svg)](https://rubygems.org/gems/internetdata)
+[![license](https://img.shields.io/github/license/internetdata/sdk-ruby.svg)](LICENSE)
+
+The official Ruby client library for the [InternetData](https://internetdata.io) API.
+
+InternetData publishes IP and ASN databases: VPN and proxy address space, hosting and CDN ranges, provider catalogs, bogons and more, as gzipped CSV and as MMDB. This library lists the databases your organization is licensed for, tells you what is inside one before you fetch it, downloads it, and verifies the bytes you got.
+
+## Getting Started
+
+```bash
+gem install internetdata
+```
+
+Or add it to your Gemfile:
+
+```ruby
+gem 'internetdata'
+```
+
+Requires Ruby 3.1 or newer.
+
+## Usage
+
+Every database published today needs an API key carrying the `db.download` scope. Access is granted by contract, one family at a time, so there is no self-serve tier: write to [dev@internetdata.io](mailto:dev@internetdata.io) to be licensed and issued a key. `api_key:` is nevertheless optional - a client built without one sends no `Authorization` header at all, ready for a database served without a licence.
+
+```ruby
+require 'internetdata'
+
+client = InternetData::Client.new(api_key: ENV['INTERNETDATA_API_KEY'])
+
+client.database.list.each do |database|
+  puts [database.base, database.standing, database.versions.map(&:id).join(', ')].join(' ')
+end
+```
+
+`list` returns one entry per database FAMILY, because a license is held against the family while a download names a specific version. `standing` is `licensed` if the family is yours today, `expired` if the term has ended, and `unlicensed` if it is published but has never been bought. `versions` carries the ids you pass everywhere else, oldest first, and the formats each one is actually built in.
+
+**This listing is not the same for every key.** A database commissioned for a single customer is absent from the catalog for every other organization, rather than being listed as unlicensed. So a listing is only ever an answer about the key that asked. This library never caches one, and you should not carry an answer from one key over to another or treat it as the published catalog.
+
+### What is inside a database
+
+```ruby
+meta = client.database.metadata('bogon_ip_v1')
+
+meta.updated              # => '2026-09-04', the day this build was generated
+meta.entries              # => rows in the build
+meta.size['csvgz']        # => bytes you are about to move
+meta.schema['csvgz']      # => [#<DatabaseMetadataColumn name="ip" type="string" ...>, ...]
+meta.sample['mmdb']       # => a few real rows
+```
+
+Poll `updated` and `entries` to decide whether today's build is worth fetching; both are free of the transfer. `size` is also the honest way to budget a download before starting one.
+
+### Downloading
+
+`download` streams a file to a path and returns the number of bytes written. Nothing larger than a chunk is ever held in memory, whatever the database weighs:
+
+```ruby
+written = client.database.download('bogon_ip_v1', 'mmdb', './bogon_ip_v1.mmdb')
+```
+
+The bytes go to a neighboring `.part` file and the name only appears once the transfer completes, so an interruption cannot leave a truncated file that reads as a whole database, and a refresh that fails does not destroy the copy already there.
+
+Or take the link and run the transfer yourself. The API answers a redirect to time-limited object storage, and that URL authorizes itself, so it can be handed to something holding no API key:
+
+```ruby
+url = client.database.download_url('bogon_ip_v1', 'mmdb')
+```
+
+Or, for a small database, take the bytes directly:
+
+```ruby
+bytes = client.database.download_bytes('bogon_asn_v1', 'csvgz')
+```
+
+`download_bytes` holds the whole file in memory and the catalog spans seven orders of magnitude, from a few hundred bytes to over 5 GiB, so use `download` for anything you have not checked with `metadata` first.
+
+### Verifying what you got
+
+```ruby
+sums = client.database.checksums('bogon_ip_v1', 'mmdb')
+sums.sha256   # also md5, sha1, sha512
+```
+
+### Download history
+
+Your organization's recent attempts, newest first, refusals included, because a denial is what answers "it stopped working" and its absence answers nothing:
+
+```ruby
+client.database.downloads(limit: 20).each do |attempt|
+  puts [attempt.created, attempt.dataset_id, attempt.format, attempt.outcome].join(' ')
+end
+```
+
+### Errors
+
+Failures raise an `InternetData::Error` carrying a `kind` and a `retryable?` flag:
+
+```ruby
+begin
+  client.database.download('vpn_ip_v1', 'mmdb', './vpn_ip_v1.mmdb')
+rescue InternetData::Error => e
+  warn "#{e.kind} #{e.status} #{e.retryable?}: #{e.rc}"
+end
+```
+
+`kind` is one of `:bad_request`, `:unauthorized`, `:forbidden`, `:rate_limited`, `:quota_exceeded`, `:server_error` or `:network`. `rc` is the API's own result code, such as `NOT_LICENSED` or `LICENSE_EXPIRED`, which is usually the specific thing you want to read.
+
+Note that `:rate_limited` and `:quota_exceeded` both arrive as HTTP 429 and are not the same thing. A rate limit is the API facing a burst, so retrying later works; a spent quota needs your allowance raised or the window to roll over. The library retries the first for you and never the second.
+
+## Other Libraries
+
+There are official InternetData client libraries available for many languages including PHP, Python, Go, Java, Ruby, and many popular frameworks such as Django, Rails, and Laravel. See our GitHub at https://github.com/internetdata for more.
+
+## About InternetData
+
+IP intelligence databases: VPN, proxy, hosting, CDN and relay address space, provider catalogs and network metadata, published as CSV and MMDB.
+
+[<img src="https://s3.internetdata.io/internetdata-public/brand/mark.svg" alt="InternetData" width="96"/>](https://internetdata.io/)
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

data/lib/internetdata/api/database_v2_api.rb

@@ -0,0 +1,376 @@
+=begin
+#InternetData API
+
+#The InternetData API. Please see https://docs.internetdata.io/api for more details. 
+
+The version of the OpenAPI document: 2026.09.04
+Contact: dev@internetdata.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'cgi'
+
+module InternetData
+  class DatabaseV2Api
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Checksums for one published file, to verify a download
+    # @param id [String] Database identifier (e.g. `vpn_ip_v1`, `resproxy_provider_v1`).
+    # @param format [String] Database file format.
+    # @param [Hash] opts the optional parameters
+    # @return [DatabaseChecksumsResponse]
+    def database_checksum_v2(id, format, opts = {})
+      data, _status_code, _headers = database_checksum_v2_with_http_info(id, format, opts)
+      data
+    end
+
+    # Checksums for one published file, to verify a download
+    # @param id [String] Database identifier (e.g. `vpn_ip_v1`, `resproxy_provider_v1`).
+    # @param format [String] Database file format.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DatabaseChecksumsResponse, Integer, Hash)>] DatabaseChecksumsResponse data, response status code and response headers
+    def database_checksum_v2_with_http_info(id, format, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatabaseV2Api.database_checksum_v2 ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling DatabaseV2Api.database_checksum_v2"
+      end
+      pattern = Regexp.new(/^[a-zA-Z0-9_]+$/)
+      if @api_client.config.client_side_validation && id !~ pattern
+        fail ArgumentError, "invalid value for 'id' when calling DatabaseV2Api.database_checksum_v2, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'format' is set
+      if @api_client.config.client_side_validation && format.nil?
+        fail ArgumentError, "Missing the required parameter 'format' when calling DatabaseV2Api.database_checksum_v2"
+      end
+      # verify enum value
+      allowable_values = ["csvgz", "mmdb"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(format)
+        fail ArgumentError, "invalid value for \"format\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/v2/database/checksum'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'id'] = id
+      query_params[:'format'] = format
+
+      # 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] || 'DatabaseChecksumsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DatabaseV2Api.database_checksum_v2",
+        :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: DatabaseV2Api#database_checksum_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # What is inside one database - schema, sample rows, row count, sizes
+    # Poll this to decide whether today's build is worth fetching: it carries `updated` and `entries` without downloading anything.  No `format` parameter - one document describes every format the database is built in. 
+    # @param id [String] Database identifier (e.g. &#x60;vpn_ip_v1&#x60;, &#x60;resproxy_provider_v1&#x60;).
+    # @param [Hash] opts the optional parameters
+    # @return [DatabaseMetadata]
+    def database_metadata_v2(id, opts = {})
+      data, _status_code, _headers = database_metadata_v2_with_http_info(id, opts)
+      data
+    end
+
+    # What is inside one database - schema, sample rows, row count, sizes
+    # Poll this to decide whether today&#39;s build is worth fetching: it carries &#x60;updated&#x60; and &#x60;entries&#x60; without downloading anything.  No &#x60;format&#x60; parameter - one document describes every format the database is built in. 
+    # @param id [String] Database identifier (e.g. &#x60;vpn_ip_v1&#x60;, &#x60;resproxy_provider_v1&#x60;).
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DatabaseMetadata, Integer, Hash)>] DatabaseMetadata data, response status code and response headers
+    def database_metadata_v2_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatabaseV2Api.database_metadata_v2 ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling DatabaseV2Api.database_metadata_v2"
+      end
+      pattern = Regexp.new(/^[a-zA-Z0-9_]+$/)
+      if @api_client.config.client_side_validation && id !~ pattern
+        fail ArgumentError, "invalid value for 'id' when calling DatabaseV2Api.database_metadata_v2, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/v2/database/metadata'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'id'] = id
+
+      # 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] || 'DatabaseMetadata'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DatabaseV2Api.database_metadata_v2",
+        :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: DatabaseV2Api#database_metadata_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Redirect to a time-limited download URL for one database
+    # Answers `302`; the bytes come straight from object storage rather than through this API. Follow the redirect. 
+    # @param id [String] Database identifier (e.g. &#x60;vpn_ip_v1&#x60;, &#x60;resproxy_provider_v1&#x60;).
+    # @param format [String] Database file format.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def download_database_v2(id, format, opts = {})
+      download_database_v2_with_http_info(id, format, opts)
+      nil
+    end
+
+    # Redirect to a time-limited download URL for one database
+    # Answers &#x60;302&#x60;; the bytes come straight from object storage rather than through this API. Follow the redirect. 
+    # @param id [String] Database identifier (e.g. &#x60;vpn_ip_v1&#x60;, &#x60;resproxy_provider_v1&#x60;).
+    # @param format [String] Database file format.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def download_database_v2_with_http_info(id, format, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatabaseV2Api.download_database_v2 ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling DatabaseV2Api.download_database_v2"
+      end
+      pattern = Regexp.new(/^[a-zA-Z0-9_]+$/)
+      if @api_client.config.client_side_validation && id !~ pattern
+        fail ArgumentError, "invalid value for 'id' when calling DatabaseV2Api.download_database_v2, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'format' is set
+      if @api_client.config.client_side_validation && format.nil?
+        fail ArgumentError, "Missing the required parameter 'format' when calling DatabaseV2Api.download_database_v2"
+      end
+      # verify enum value
+      allowable_values = ["csvgz", "mmdb"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(format)
+        fail ArgumentError, "invalid value for \"format\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/v2/database/download'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'id'] = id
+      query_params[:'format'] = format
+
+      # 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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DatabaseV2Api.download_database_v2",
+        :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: DatabaseV2Api#download_database_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Every database your organization may see, and where each one stands
+    # The whole published catalog, with your organization's licence beside each entry, so `standing` says whether a database is yours today (`licensed`), was (`expired`), or has never been bought (`unlicensed`).  Databases commissioned for a single customer are not listed to anyone else. 
+    # @param [Hash] opts the optional parameters
+    # @return [DatabaseList]
+    def list_databases(opts = {})
+      data, _status_code, _headers = list_databases_with_http_info(opts)
+      data
+    end
+
+    # Every database your organization may see, and where each one stands
+    # The whole published catalog, with your organization&#39;s licence beside each entry, so &#x60;standing&#x60; says whether a database is yours today (&#x60;licensed&#x60;), was (&#x60;expired&#x60;), or has never been bought (&#x60;unlicensed&#x60;).  Databases commissioned for a single customer are not listed to anyone else. 
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatabaseV2Api.list_databases ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/database/list'
+
+      # 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] || 'DatabaseList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DatabaseV2Api.list_databases",
+        :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: DatabaseV2Api#list_databases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Your organization's recent download attempts, newest first
+    # Refusals are listed too: a denial is what answers \"it stopped working\", and its absence answers nothing. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit How many attempts to return. Clamped to 200. (default to 50)
+    # @return [DownloadList]
+    def list_downloads(opts = {})
+      data, _status_code, _headers = list_downloads_with_http_info(opts)
+      data
+    end
+
+    # Your organization&#39;s recent download attempts, newest first
+    # Refusals are listed too: a denial is what answers \&quot;it stopped working\&quot;, and its absence answers nothing. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit How many attempts to return. Clamped to 200. (default to 50)
+    # @return [Array<(DownloadList, Integer, Hash)>] DownloadList data, response status code and response headers
+    def list_downloads_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatabaseV2Api.list_downloads ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DatabaseV2Api.list_downloads, must be smaller than or equal to 200.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DatabaseV2Api.list_downloads, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/v2/database/downloads'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # 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] || 'DownloadList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DatabaseV2Api.list_downloads",
+        :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: DatabaseV2Api#list_downloads\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end