internetdata 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d77f47da1f724a65e9e3828b0061fd29fb7fdd2f477ea98d6eef1ea2414d984
-  data.tar.gz: daa5914d08baad300a1aeafacdc958229ac6558c1111187f2ae7d71684e53c53
+  metadata.gz: 7297574e75072216b4bc6de21ae97563873d2a8aac243f8f83961e84f3832cb7
+  data.tar.gz: 19f7135e1781940562401dc64d94f9238264d00c8597f17b18102bbe649da32a
 SHA512:
-  metadata.gz: 0a16432460423aedc0a2393d89d1f9139fa278e9dd3bed772af489464b356e6f1f811004a34ee50a5573a4b23af9df527067c3fb4e45dd2093cc403e4badb591
-  data.tar.gz: a5268df757d9115d94092ddd47ad124c7fa0d27b90b7cb4f1b2b02d67c64d50653dc60a2fb916733d43f5257bd2c66c0e57757fa25d4d8976e02793fe19864cf
+  metadata.gz: 763bea6cada7ee68b35da1268a0b267397b414a900d3771275bdcd86f27a73c2fb66802a4568e4d60a15c4cee224c755dc53cb4fdcf3d4c8fc5475f10f2ced4c
+  data.tar.gz: 4dada1a18466fee2d4cb2d0426a0eb897debcb1684e721f1cecce596eefd079f3fed35d0759ecf2cdf34ee688bc564a16fc3175a033701e983f494014e3a0662

data/README.md

@@ -120,6 +120,23 @@ end
 
 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.
 
+### Sign in with OAuth (device flow)
+
+A program running on a person's own machine can let them sign in with their browser and pick one of their API keys, instead of asking them to paste one.
+
+```ruby
+client = InternetData::Client.new
+device = client.oauth.device_authorization('your-client-id', scope: 'account.read apikeys.read apikeys.reveal')
+puts "Open #{device.verification_uri} and enter #{device.user_code}"
+
+token = client.oauth.poll_device_token('your-client-id', device)
+raise 'no API key was picked' if token.apikey.nil?
+
+keyed = InternetData::Client.new(api_key: token.apikey)
+```
+
+`poll_device_token` raises `InternetData::OauthAccessDeniedError` when the person refuses and `InternetData::OauthExpiredTokenError` when the code expires first. Client IDs are issued on request from support@internetdata.io, and `client.oauth.revoke('your-client-id', token.refresh_token)` signs the machine out.
+
 ## 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.

data/lib/internetdata/api/database_v2_api.rb

@@ -1,10 +1,10 @@
 =begin
 #InternetData API
 
-#The InternetData API. Please see https://docs.internetdata.io/api for more details. 
+#The InternetData API: download the databases your organization is licensed for, and manage the account behind them.  See https://docs.internetdata.io for guides and https://github.com/internetdata for the official client libraries. 
 
-The version of the OpenAPI document: 2026.09.13
-Contact: dev@internetdata.io
+The version of the OpenAPI document: 2026.09.21
+Contact: support@internetdata.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0
 
@@ -241,7 +241,7 @@ module InternetData
     end
 
     # List
-    # 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`). 
+    # The whole published catalog, with your organization's license beside each entry, so `standing` says whether a database is yours today (`licensed`), was (`expired`), or has never been bought (`unlicensed`). 
     # @param [Hash] opts the optional parameters
     # @return [DatabaseList]
     def list_databases(opts = {})
@@ -250,7 +250,7 @@ module InternetData
     end
 
     # List
-    # 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`). 
+    # The whole published catalog, with your organization's license beside each entry, so `standing` says whether a database is yours today (`licensed`), was (`expired`), or has never been bought (`unlicensed`). 
     # @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/internetdata/api_client.rb

@@ -1,10 +1,10 @@
 =begin
 #InternetData API
 
-#The InternetData API. Please see https://docs.internetdata.io/api for more details. 
+#The InternetData API: download the databases your organization is licensed for, and manage the account behind them.  See https://docs.internetdata.io for guides and https://github.com/internetdata for the official client libraries. 
 
-The version of the OpenAPI document: 2026.09.13
-Contact: dev@internetdata.io
+The version of the OpenAPI document: 2026.09.21
+Contact: support@internetdata.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0
 

data/lib/internetdata/api_error.rb

@@ -1,10 +1,10 @@
 =begin
 #InternetData API
 
-#The InternetData API. Please see https://docs.internetdata.io/api for more details. 
+#The InternetData API: download the databases your organization is licensed for, and manage the account behind them.  See https://docs.internetdata.io for guides and https://github.com/internetdata for the official client libraries. 
 
-The version of the OpenAPI document: 2026.09.13
-Contact: dev@internetdata.io
+The version of the OpenAPI document: 2026.09.21
+Contact: support@internetdata.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0
 

data/lib/internetdata/api_model_base.rb

@@ -1,10 +1,10 @@
 =begin
 #InternetData API
 
-#The InternetData API. Please see https://docs.internetdata.io/api for more details. 
+#The InternetData API: download the databases your organization is licensed for, and manage the account behind them.  See https://docs.internetdata.io for guides and https://github.com/internetdata for the official client libraries. 
 
-The version of the OpenAPI document: 2026.09.13
-Contact: dev@internetdata.io
+The version of the OpenAPI document: 2026.09.21
+Contact: support@internetdata.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0
 

data/lib/internetdata/client.rb

@@ -12,13 +12,15 @@ module InternetData
   # Every database published today needs an API key carrying the `db.download`
   # scope, granted by contract one family at a time. The key is still OPTIONAL:
   # a client built without one sends no `Authorization` header at all, which is
-  # what a database served without a license would need.
+  # what a database served without a license would need, and `oauth` needs none.
   class Client
     # The licensed database downloads, and everything about them.
     attr_reader :database
+    # Signing a person in with OAuth, which needs no API key at all.
+    attr_reader :oauth
 
     # @param api_key [String, nil] a key carrying the `db.download` scope. Omit
-    #   it and no credential is sent; every endpoint published today answers 401.
+    #   it and no credential is sent; every database published today answers 401.
     # @param retries [Integer] extra attempts for a transient failure.
     # @param timeout [Numeric] seconds allowed for one API call. It also bounds the
     #   CONNECT phase of a transfer, which is otherwise unlimited.
@@ -29,6 +31,7 @@ module InternetData
         Transport::Config.new(api_key: api_key, base_url: base_url, timeout: timeout),
       )
       @database = DatabaseApi.new(@transport, retries: retries)
+      @oauth = OauthApi.new(@transport, retries: retries)
     end
   end
 end

data/lib/internetdata/configuration.rb

@@ -1,10 +1,10 @@
 =begin
 #InternetData API
 
-#The InternetData API. Please see https://docs.internetdata.io/api for more details. 
+#The InternetData API: download the databases your organization is licensed for, and manage the account behind them.  See https://docs.internetdata.io for guides and https://github.com/internetdata for the official client libraries. 
 
-The version of the OpenAPI document: 2026.09.13
-Contact: dev@internetdata.io
+The version of the OpenAPI document: 2026.09.21
+Contact: support@internetdata.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0
 

data/lib/internetdata/errors.rb

@@ -43,25 +43,26 @@ module InternetData
       rc = rc_of(body)
       message ||= rc || "request failed with status #{status}"
       retry_after = parse_retry_after(header(headers, 'retry-after'))
+      kind = kind_for(status, headers)
 
+      new(kind, message, status: status, rc: rc, retry_after_seconds: kind == :rate_limited ? retry_after : nil)
+    end
+
+    # What a response with this status is, whatever its body says.
+    def self.kind_for(status, headers)
       case status
-      when 429
-        # Present means transient, absent means an allowance is spent. Nothing
-        # else in the response separates the two.
-        if retry_after.nil?
-          new(:quota_exceeded, message, status: status, rc: rc)
-        else
-          new(:rate_limited, message, status: status, rc: rc, retry_after_seconds: retry_after)
-        end
-      when 400 then new(:bad_request, message, status: status, rc: rc)
-      when 401 then new(:unauthorized, message, status: status, rc: rc)
-      when 403 then new(:forbidden, message, status: status, rc: rc)
+      # Present means transient, absent means an allowance is spent. Nothing
+      # else in the response separates the two.
+      when 429 then parse_retry_after(header(headers, 'retry-after')).nil? ? :quota_exceeded : :rate_limited
+      when 400 then :bad_request
+      when 401 then :unauthorized
+      when 403 then :forbidden
       # Every other 4xx is a CLIENT error. Classifying on the RANGE rather than
       # on an enumerated list is what keeps a 404 from an unknown database id
       # falling through to the retryable server_error default and being retried
       # twice before it fails.
-      when 400..499 then new(:bad_request, message, status: status, rc: rc)
-      else new(:server_error, message, status: status, rc: rc)
+      when 400..499 then :bad_request
+      else :server_error
       end
     end
 
@@ -107,4 +108,45 @@ module InternetData
 
     private_class_method :header, :rc_of, :parse_retry_after
   end
+
+  # The authorization server refusing an OAuth request: a 4xx whose body names an
+  # RFC 6749 `error` code. Never retryable, whatever the status, because every
+  # code it can carry answers the request as it was made.
+  #
+  # Not `OauthError`, the name the spec gives the error body, so the class keeps
+  # the same name in both brands' gems.
+  class OauthRequestError < Error
+    # The `error` code, such as `slow_down` or `invalid_grant`.
+    attr_reader :error_code
+    # `error_description` when the server sent one as a string, otherwise nil.
+    attr_reader :error_description
+
+    # The refusal a response carries, as the most specific class its code has.
+    def self.for_code(error_code, error_description, status:, headers: {})
+      klass = case error_code
+              when 'access_denied' then OauthAccessDeniedError
+              when 'expired_token' then OauthExpiredTokenError
+              else OauthRequestError
+              end
+      klass.new(error_code, error_description, kind: Error.kind_for(status, headers), status: status)
+    end
+
+    def initialize(error_code, error_description = nil, kind: :bad_request, status: nil)
+      super(kind, error_description.nil? ? error_code : "#{error_code}: #{error_description}", status: status)
+      @error_code = error_code
+      @error_description = error_description
+    end
+
+    def retryable?
+      false
+    end
+  end
+
+  # The person refused the sign-in. Their device code is spent.
+  class OauthAccessDeniedError < OauthRequestError; end
+
+  # The device code is no longer valid: it expired, or was already exchanged or
+  # refused. Raised with no status when {OauthApi#poll_device_token} reaches the
+  # code's lifetime before the server says so.
+  class OauthExpiredTokenError < OauthRequestError; end
 end

data/lib/internetdata/models/database.rb

@@ -1,10 +1,10 @@
 =begin
 #InternetData API
 
-#The InternetData API. Please see https://docs.internetdata.io/api for more details. 
+#The InternetData API: download the databases your organization is licensed for, and manage the account behind them.  See https://docs.internetdata.io for guides and https://github.com/internetdata for the official client libraries. 
 
-The version of the OpenAPI document: 2026.09.13
-Contact: dev@internetdata.io
+The version of the OpenAPI document: 2026.09.21
+Contact: support@internetdata.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0
 
@@ -14,9 +14,9 @@ require 'date'
 require 'time'
 
 module InternetData
-  # One database FAMILY, with your organization's licence beside it. A licence covers the family, while a download names a specific version, so the ids passed to `download` and `checksum` come from `versions`. 
+  # One database FAMILY, with your organization's license beside it. A license covers the family, while a download names a specific version, so the ids passed to `download` and `checksum` come from `versions`. 
   class Database < ApiModelBase
-    # The family, e.g. `vpn_ip`. What a licence is held against.
+    # The family, e.g. `vpn_ip`. What a license is held against.
     attr_accessor :base
 
     attr_accessor :name
@@ -26,15 +26,15 @@ module InternetData
 
     attr_accessor :standing
 
-    # What your licence permits you to do with the data. Null when there is no licence, which is every family with standing `unlicensed`. 
+    # What your license permits you to do with the data. Null when there is no license, which is every family with standing `unlicensed`. 
     attr_accessor :license_type
 
     attr_accessor :starts
 
-    # A hard stop. Null when the licence has no end date, which is the normal case for a rolling agreement, and when there is no licence. A rolling licence reports its turnover date in renews_at instead.
+    # A hard stop. Null when the license has no end date, which is the normal case for a rolling agreement, and when there is no license. A rolling license reports its turnover date in renews_at instead.
     attr_accessor :expires
 
-    # When a rolling licence next renews. Null when the licence has no defined term, when expires sets a hard stop instead, and when there is no licence.
+    # When a rolling license next renews. Null when the license has no defined term, when expires sets a hard stop instead, and when there is no license.
     attr_accessor :renews_at
 
     # The last day notice of non-renewal can be given for the term ending at renews_at. Null whenever renews_at is, and when the agreement records no notice period.

data/lib/internetdata/models/database_checksums_response.rb

@@ -1,10 +1,10 @@
 =begin
 #InternetData API
 
-#The InternetData API. Please see https://docs.internetdata.io/api for more details. 
+#The InternetData API: download the databases your organization is licensed for, and manage the account behind them.  See https://docs.internetdata.io for guides and https://github.com/internetdata for the official client libraries. 
 
-The version of the OpenAPI document: 2026.09.13
-Contact: dev@internetdata.io
+The version of the OpenAPI document: 2026.09.21
+Contact: support@internetdata.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0
 

data/lib/internetdata/models/database_format.rb

@@ -1,10 +1,10 @@
 =begin
 #InternetData API
 
-#The InternetData API. Please see https://docs.internetdata.io/api for more details. 
+#The InternetData API: download the databases your organization is licensed for, and manage the account behind them.  See https://docs.internetdata.io for guides and https://github.com/internetdata for the official client libraries. 
 
-The version of the OpenAPI document: 2026.09.13
-Contact: dev@internetdata.io
+The version of the OpenAPI document: 2026.09.21
+Contact: support@internetdata.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0
 

data/lib/internetdata/models/database_list.rb

@@ -1,10 +1,10 @@
 =begin
 #InternetData API
 
-#The InternetData API. Please see https://docs.internetdata.io/api for more details. 
+#The InternetData API: download the databases your organization is licensed for, and manage the account behind them.  See https://docs.internetdata.io for guides and https://github.com/internetdata for the official client libraries. 
 
-The version of the OpenAPI document: 2026.09.13
-Contact: dev@internetdata.io
+The version of the OpenAPI document: 2026.09.21
+Contact: support@internetdata.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0
 

data/lib/internetdata/models/database_metadata.rb

@@ -1,10 +1,10 @@
 =begin
 #InternetData API
 
-#The InternetData API. Please see https://docs.internetdata.io/api for more details. 
+#The InternetData API: download the databases your organization is licensed for, and manage the account behind them.  See https://docs.internetdata.io for guides and https://github.com/internetdata for the official client libraries. 
 
-The version of the OpenAPI document: 2026.09.13
-Contact: dev@internetdata.io
+The version of the OpenAPI document: 2026.09.21
+Contact: support@internetdata.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0
 

data/lib/internetdata/models/database_metadata_column.rb

@@ -1,10 +1,10 @@
 =begin
 #InternetData API
 
-#The InternetData API. Please see https://docs.internetdata.io/api for more details. 
+#The InternetData API: download the databases your organization is licensed for, and manage the account behind them.  See https://docs.internetdata.io for guides and https://github.com/internetdata for the official client libraries. 
 
-The version of the OpenAPI document: 2026.09.13
-Contact: dev@internetdata.io
+The version of the OpenAPI document: 2026.09.21
+Contact: support@internetdata.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0
 

data/lib/internetdata/models/database_version.rb

@@ -1,10 +1,10 @@
 =begin
 #InternetData API
 
-#The InternetData API. Please see https://docs.internetdata.io/api for more details. 
+#The InternetData API: download the databases your organization is licensed for, and manage the account behind them.  See https://docs.internetdata.io for guides and https://github.com/internetdata for the official client libraries. 
 
-The version of the OpenAPI document: 2026.09.13
-Contact: dev@internetdata.io
+The version of the OpenAPI document: 2026.09.21
+Contact: support@internetdata.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0
 

data/lib/internetdata/models/db_checksums.rb

@@ -1,10 +1,10 @@
 =begin
 #InternetData API
 
-#The InternetData API. Please see https://docs.internetdata.io/api for more details. 
+#The InternetData API: download the databases your organization is licensed for, and manage the account behind them.  See https://docs.internetdata.io for guides and https://github.com/internetdata for the official client libraries. 
 
-The version of the OpenAPI document: 2026.09.13
-Contact: dev@internetdata.io
+The version of the OpenAPI document: 2026.09.21
+Contact: support@internetdata.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0