internetdata 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e82fb5eb7859d275fc2afd049004a7c81bb1011414d233f48e2be9a76743e82e
-  data.tar.gz: 164f190384cc89c588b20ab86702db0d3d5f563c2c7dc8b2c764b5783eda56d3
+  metadata.gz: 53157834d0e85447843c18f5d10576a062df513f1f04f2d16b65f80eb59c7bc7
+  data.tar.gz: e48e8161d4bc0ae3221fdcb0077c7096e313e8ae8bfb5c0a1ef368afc57037dd
 SHA512:
-  metadata.gz: 5ce2ae19a89030b3d6a84556b23a747369540dc9d2c9d036f34f278fbe4495a18c7011a88fb73b8b693ff852a73fbe01d3d12bb3f24887558e238634eb2ea36a
-  data.tar.gz: cdb7fdd1bb252a72b7a6e1b7ff01407c579813451c20f47b094b03afe46baddf631d83fc16bd2b7cb3898f1538c31f37bb8bbcb127d30e176d2e3ea03803e1c5
+  metadata.gz: 42a0b3bc5ac34cfb412a378bedf9c84a95c328b0805d4fad161ac53b0041b478a384787f8863323a78d1eb8b68b694071ef389acf7bd3e0f9e1ae83e526578ef
+  data.tar.gz: d4038ce5a7d0b51678d17349c7c856231b171b54f6d155017efb47fa7ec7cf2a5d71a491cddc27db98caae33a348c008bf24e9e2c5d763443eb5879247ee43ac

data/README.md

@@ -154,6 +154,18 @@ token = client.oauth.exchange_authorization_code('your-client-id', code, pkce.ve
 
 Check that `state` came back as you sent it before you exchange `code`, which works once. The client ID can also be the https URL of a client metadata document your app serves, and such an app is never handed a key, so `token.apikey` stays `nil`.
 
+### Register a client
+
+An app with no client ID, and no client metadata document to use as one, registers itself and signs in with the `client_id` it gets back:
+
+```ruby
+client = InternetData::Client.new
+registration = client.oauth.register(['http://127.0.0.1:8765/callback'], client_name: 'Your App')
+# registration.client_id is the client ID for authorization_url and exchange_authorization_code.
+```
+
+Each redirect URI must be https on a public host name, or http on a loopback address, which then matches any port. Nothing is kept until a person approves the client, so an app with no client ID saved can simply register again.
+
 ## Other Libraries
 
 There are official InternetData client libraries available for many languages including PHP, Python, Go, Java, and Ruby. See our GitHub at https://github.com/internetdata for more.

data/lib/internetdata/models/client_registration.rb

@@ -0,0 +1,306 @@
+=begin
+#InternetData API
+
+#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.10.16
+Contact: support@internetdata.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module InternetData
+  class ClientRegistration < ApiModelBase
+    attr_accessor :client_id
+
+    # Unix seconds.
+    attr_accessor :client_id_issued_at
+
+    # As the person will see it.
+    attr_accessor :client_name
+
+    attr_accessor :redirect_uris
+
+    # `authorization_code` and `refresh_token`.
+    attr_accessor :grant_types
+
+    attr_accessor :response_types
+
+    # Always `none`.
+    attr_accessor :token_endpoint_auth_method
+
+    # The most this client may be granted: `apikeys.use`.
+    attr_accessor :scope
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'client_id' => :'client_id',
+        :'client_id_issued_at' => :'client_id_issued_at',
+        :'client_name' => :'client_name',
+        :'redirect_uris' => :'redirect_uris',
+        :'grant_types' => :'grant_types',
+        :'response_types' => :'response_types',
+        :'token_endpoint_auth_method' => :'token_endpoint_auth_method',
+        :'scope' => :'scope'
+      }
+    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
+      {
+        :'client_id' => :'String',
+        :'client_id_issued_at' => :'Integer',
+        :'client_name' => :'String',
+        :'redirect_uris' => :'Array<String>',
+        :'grant_types' => :'Array<String>',
+        :'response_types' => :'Array<String>',
+        :'token_endpoint_auth_method' => :'String',
+        :'scope' => :'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 `InternetData::ClientRegistration` 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 `InternetData::ClientRegistration`. 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?(:'client_id')
+        self.client_id = attributes[:'client_id']
+      else
+        self.client_id = nil
+      end
+
+      if attributes.key?(:'client_id_issued_at')
+        self.client_id_issued_at = attributes[:'client_id_issued_at']
+      else
+        self.client_id_issued_at = nil
+      end
+
+      if attributes.key?(:'client_name')
+        self.client_name = attributes[:'client_name']
+      else
+        self.client_name = nil
+      end
+
+      if attributes.key?(:'redirect_uris')
+        if (value = attributes[:'redirect_uris']).is_a?(Array)
+          self.redirect_uris = value
+        end
+      else
+        self.redirect_uris = nil
+      end
+
+      if attributes.key?(:'grant_types')
+        if (value = attributes[:'grant_types']).is_a?(Array)
+          self.grant_types = value
+        end
+      end
+
+      if attributes.key?(:'response_types')
+        if (value = attributes[:'response_types']).is_a?(Array)
+          self.response_types = value
+        end
+      end
+
+      if attributes.key?(:'token_endpoint_auth_method')
+        self.token_endpoint_auth_method = attributes[:'token_endpoint_auth_method']
+      else
+        self.token_endpoint_auth_method = nil
+      end
+
+      if attributes.key?(:'scope')
+        self.scope = attributes[:'scope']
+      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 @client_id.nil?
+        invalid_properties.push('invalid value for "client_id", client_id cannot be nil.')
+      end
+
+      if @client_id_issued_at.nil?
+        invalid_properties.push('invalid value for "client_id_issued_at", client_id_issued_at cannot be nil.')
+      end
+
+      if @client_name.nil?
+        invalid_properties.push('invalid value for "client_name", client_name cannot be nil.')
+      end
+
+      if @redirect_uris.nil?
+        invalid_properties.push('invalid value for "redirect_uris", redirect_uris cannot be nil.')
+      end
+
+      if @token_endpoint_auth_method.nil?
+        invalid_properties.push('invalid value for "token_endpoint_auth_method", token_endpoint_auth_method 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 @client_id.nil?
+      return false if @client_id_issued_at.nil?
+      return false if @client_name.nil?
+      return false if @redirect_uris.nil?
+      return false if @token_endpoint_auth_method.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] client_id Value to be assigned
+    def client_id=(client_id)
+      if client_id.nil?
+        fail ArgumentError, 'client_id cannot be nil'
+      end
+
+      @client_id = client_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] client_id_issued_at Value to be assigned
+    def client_id_issued_at=(client_id_issued_at)
+      if client_id_issued_at.nil?
+        fail ArgumentError, 'client_id_issued_at cannot be nil'
+      end
+
+      @client_id_issued_at = client_id_issued_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] client_name Value to be assigned
+    def client_name=(client_name)
+      if client_name.nil?
+        fail ArgumentError, 'client_name cannot be nil'
+      end
+
+      @client_name = client_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] redirect_uris Value to be assigned
+    def redirect_uris=(redirect_uris)
+      if redirect_uris.nil?
+        fail ArgumentError, 'redirect_uris cannot be nil'
+      end
+
+      @redirect_uris = redirect_uris
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] token_endpoint_auth_method Value to be assigned
+    def token_endpoint_auth_method=(token_endpoint_auth_method)
+      if token_endpoint_auth_method.nil?
+        fail ArgumentError, 'token_endpoint_auth_method cannot be nil'
+      end
+
+      @token_endpoint_auth_method = token_endpoint_auth_method
+    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 &&
+          client_id == o.client_id &&
+          client_id_issued_at == o.client_id_issued_at &&
+          client_name == o.client_name &&
+          redirect_uris == o.redirect_uris &&
+          grant_types == o.grant_types &&
+          response_types == o.response_types &&
+          token_endpoint_auth_method == o.token_endpoint_auth_method &&
+          scope == o.scope
+    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
+      [client_id, client_id_issued_at, client_name, redirect_uris, grant_types, response_types, token_endpoint_auth_method, scope].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/internetdata/oauth_api.rb

@@ -36,6 +36,7 @@ module InternetData
     TOKEN_PATH = '/oauth/token'
     REVOKE_PATH = '/oauth/revoke'
     AUTHORIZE_PATH = '/oauth/authorize'
+    REGISTER_PATH = '/oauth/register'
     DEVICE_CODE_GRANT = 'urn:ietf:params:oauth:grant-type:device_code'
     # The longest single `sleep` the poll asks Ruby for, in seconds.
     LONGEST_SLEEP = 2**31 - 1
@@ -45,6 +46,7 @@ module InternetData
       OauthMetadata => %i[issuer authorization_endpoint token_endpoint],
       DeviceAuthorization => %i[device_code user_code verification_uri expires_in interval],
       TokenResponse => %i[access_token token_type expires_in],
+      ClientRegistration => %i[client_id client_id_issued_at client_name redirect_uris token_endpoint_auth_method],
     }.freeze
 
     def initialize(transport, retries:)
@@ -151,6 +153,31 @@ module InternetData
       [Digest::SHA256.digest(verifier)].pack('m0').tr('+/', '-_').delete('=')
     end
 
+    # Register a client for the authorization code flow, for an app that cannot
+    # serve a Client ID Metadata Document, and get its `client_id` for
+    # {#authorization_url} and {#exchange_authorization_code}.
+    #
+    # Each redirect URI must be https on a public host name, or http on a
+    # loopback address, which then matches on any port; the server refuses any
+    # other with {OauthRequestError} coded `invalid_redirect_uri`. Nothing is kept
+    # until a person approves the client, so registering again costs nothing, and
+    # this is retried like a read. No URI at all, or one that is empty or not
+    # UTF-8, raises ArgumentError before anything is sent.
+    #
+    # @param client_name [String, nil] shown to the person as the client's own
+    #   claim; left out when empty.
+    # @return [ClientRegistration]
+    def register(redirect_uris, client_name: nil, timeout: nil)
+      raise ArgumentError, 'redirect_uris must list at least one URI' unless redirect_uris.is_a?(Array) && !redirect_uris.empty?
+
+      body = { 'redirect_uris' => redirect_uris.each_with_index.map { |uri, i| utf8!("redirect_uris[#{i}]", uri) } }
+      name = client_name.nil? ? '' : utf8!('client_name', client_name, empty: true)
+      body['client_name'] = name unless name.empty?
+      Retries.with_retries(@retries) do
+        decode(ClientRegistration, @transport.oauth_request(:POST, REGISTER_PATH, json: body, timeout: timeout).run)
+      end
+    end
+
     # Revoke an access or refresh token. A refresh token ends the whole grant and
     # every token it issued, which is how a machine signs out.
     #
@@ -226,6 +253,18 @@ module InternetData
       raise ArgumentError, "#{name} is not valid UTF-8"
     end
 
+    def utf8!(name, value, empty: false)
+      raise ArgumentError, "#{name} must be a String" unless value.is_a?(String)
+      raise ArgumentError, "#{name} must not be empty" if value.empty? && !empty
+
+      utf8 = value.encode(Encoding::UTF_8)
+      raise ArgumentError, "#{name} is not valid UTF-8" unless utf8.valid_encoding?
+
+      utf8
+    rescue EncodingError
+      raise ArgumentError, "#{name} is not valid UTF-8"
+    end
+
     def exchange(form, timeout)
       decode(TokenResponse, @transport.oauth_request(:POST, TOKEN_PATH, form: form, timeout: timeout).run)
     end

data/lib/internetdata/transport.rb

@@ -141,11 +141,13 @@ module InternetData
     #
     # The form is encoded here rather than by curl, so a `+` in a value leaves as
     # `%2B` and never arrives as a space.
-    def oauth_request(http_method, path, form: nil, timeout: nil)
+    def oauth_request(http_method, path, form: nil, json: nil, timeout: nil)
       headers = { 'Accept' => 'application/json' }
       headers['Content-Type'] = 'application/x-www-form-urlencoded' unless form.nil?
+      headers['Content-Type'] = 'application/json' unless json.nil?
       request = build_request(http_method, path, header_params: headers, auth_names: [], timeout: timeout)
       request.options[:body] = URI.encode_www_form(form) unless form.nil?
+      request.options[:body] = JSON.generate(json) unless json.nil?
       request
     end
 

data/lib/internetdata/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InternetData
-  VERSION = '2.7.0'
+  VERSION = '2.8.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: internetdata
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Mslm Dev
@@ -42,6 +42,7 @@ files:
 - lib/internetdata/configuration.rb
 - lib/internetdata/database_api.rb
 - lib/internetdata/errors.rb
+- lib/internetdata/models/client_registration.rb
 - lib/internetdata/models/database.rb
 - lib/internetdata/models/database_checksums_response.rb
 - lib/internetdata/models/database_format.rb