zitadel-client 1.4.0 → 1.4.1

data/lib/zitadel-client/auth/web_token_authenticator.rb

@@ -4,155 +4,157 @@ require 'time'
 require 'openssl'
 
 module ZitadelClient
-  # -----------------------------------------------------------------------------
-  # WebTokenAuthenticator
-  # -----------------------------------------------------------------------------
-
-  # OAuth authenticator implementing the JWT bearer flow.
-  #
-  # This implementation builds a JWT assertion dynamically in get_grant().
-  class WebTokenAuthenticator < ZitadelClient::OAuthAuthenticator
-    # Constructs a WebTokenAuthenticator.
-    #
-    # @param open_id [OpenId] The OpenId instance with OAuth endpoint information.
-    # @param auth_scopes [Set<String>] The scope(s) for the token request.
-    # @param jwt_issuer [String] The JWT issuer.
-    # @param jwt_subject [String] The JWT subject.
-    # @param jwt_audience [String] The JWT audience.
-    # @param private_key [String] The private key used to sign the JWT.
-    # @param jwt_lifetime [Integer] Lifetime of the JWT in seconds (default 3600 seconds).
-    # @param jwt_algorithm [String] The JWT signing algorithm (default "RS256").
-    # @param key_id [String, nil] Optional key identifier for the JWT header (default: nil).
-    # rubocop:disable Metrics/ParameterLists,Metrics/MethodLength
-    def initialize(open_id, auth_scopes, jwt_issuer, jwt_subject, jwt_audience, private_key,
-                   jwt_lifetime: 3600, jwt_algorithm: 'RS256', key_id: nil)
-      # noinspection RubyArgCount,RubyMismatchedArgumentType
-      super(open_id, auth_scopes, OAuth2::Client.new('zitadel', 'zitadel', {
-                                                       site: open_id.host_endpoint,
-                                                       token_url: open_id.token_endpoint
-                                                     }))
-      @jwt_issuer = jwt_issuer
-      @jwt_subject = jwt_subject
-      @jwt_audience = jwt_audience
-      @private_key = private_key
-      @jwt_lifetime = jwt_lifetime
-      @jwt_algorithm = jwt_algorithm
-      @key_id = key_id
-    end
-
-    # rubocop:enable Metrics/ParameterLists,Metrics/MethodLength
-
-    # Creates a WebTokenAuthenticator instance from a JSON configuration file.
-    #
-    # The JSON file must be formatted as follows:
-    #
-    #   {
-    #     "type": "serviceaccount",
-    #     "keyId": "<key-id>",
-    #     "key": "<private-key>",
-    #     "userId": "<user-id>"
-    #   }
-    #
-    # @param host [String] Base URL for the API endpoints.
-    # @param json_path [String] File path to the JSON configuration file.
-    # @return [WebTokenAuthenticator] A new instance of WebTokenAuthenticator.
-    # @raise [RuntimeError] If the file cannot be read, the JSON is invalid, or required keys are missing.
-    def self.from_json(host, json_path)
-      config = JSON.parse(File.read(json_path))
-    rescue Errno::ENOENT => e
-      raise "Unable to read JSON file at #{json_path}: #{e.message}"
-    rescue JSON::ParserError => e
-      raise "Invalid JSON in file at #{json_path}: #{e.message}"
-    else
-      raise "Expected a JSON object, got #{config.class}" unless config.is_a?(Hash)
-
-      user_id, private_key, key_id = config.values_at('userId', 'key', 'keyId')
-      raise "Missing required keys 'userId', 'keyId' or 'key'" unless user_id && key_id && private_key
-
-      WebTokenAuthenticator.builder(host, user_id, private_key).key_identifier(key_id).build
-    end
-
-    # Returns a builder for constructing a WebTokenAuthenticator.
-    #
-    # @param host [String] The base URL for the OAuth provider.
-    # @param user_id [String] The user identifier (used as both the issuer and subject).
-    # @param private_key [String] The private key used to sign the JWT.
-    # @return [WebTokenAuthenticatorBuilder] A builder instance.
-    def self.builder(host, user_id, private_key)
-      WebTokenAuthenticatorBuilder.new(host, user_id, user_id, host, private_key)
-    end
-
-    protected
-
-    # Overrides the base get_grant to return client credentials grant parameters.
-    #
-    # @return [OAuth2::AccessToken] A hash containing the grant type.
-    # rubocop:disable Metrics/MethodLength
-    def get_grant(client, auth_scopes)
-      client.assertion.get_token(
-        { iss: @jwt_issuer,
-          sub: @jwt_subject,
-          aud: @jwt_audience,
-          iat: Time.now.utc.to_i,
-          exp: (Time.now.utc + @jwt_lifetime).to_i },
-        {
-          algorithm: @jwt_algorithm,
-          key: OpenSSL::PKey::RSA.new(@private_key),
-          kid: @key_id
-        },
-        {
-          scope: auth_scopes
-        }
-      )
-    end
-
-    # rubocop:enable Metrics/MethodLength
-
+  module Auth
     # -----------------------------------------------------------------------------
-    # WebTokenAuthenticatorBuilder
+    # WebTokenAuthenticator
     # -----------------------------------------------------------------------------
 
-    # Builder for WebTokenAuthenticator.
+    # OAuth authenticator implementing the JWT bearer flow.
     #
-    # Provides a fluent API for configuring and constructing a WebTokenAuthenticator instance.
-    class WebTokenAuthenticatorBuilder < OAuthAuthenticatorBuilder
-      # Initializes the WebTokenAuthenticatorBuilder with required parameters.
+    # This implementation builds a JWT assertion dynamically in get_grant().
+    class WebTokenAuthenticator < ZitadelClient::Auth::OAuthAuthenticator
+      # Constructs a WebTokenAuthenticator.
       #
-      # @param host [String] The base URL for API endpoints.
-      # @param jwt_issuer [String] The issuer claim for the JWT.
-      # @param jwt_subject [String] The subject claim for the JWT.
-      # @param jwt_audience [String] The audience claim for the JWT.
-      # @param private_key [String] The PEM-formatted private key used for signing the JWT.
-      def initialize(host, jwt_issuer, jwt_subject, jwt_audience, private_key)
-        # noinspection RubyArgCount
-        super(host)
+      # @param open_id [OpenId] The OpenId instance with OAuth endpoint information.
+      # @param auth_scopes [Set<String>] The scope(s) for the token request.
+      # @param jwt_issuer [String] The JWT issuer.
+      # @param jwt_subject [String] The JWT subject.
+      # @param jwt_audience [String] The JWT audience.
+      # @param private_key [String] The private key used to sign the JWT.
+      # @param jwt_lifetime [Integer] Lifetime of the JWT in seconds (default 3600 seconds).
+      # @param jwt_algorithm [String] The JWT signing algorithm (default "RS256").
+      # @param key_id [String, nil] Optional key identifier for the JWT header (default: nil).
+      # rubocop:disable Metrics/ParameterLists,Metrics/MethodLength
+      def initialize(open_id, auth_scopes, jwt_issuer, jwt_subject, jwt_audience, private_key,
+                     jwt_lifetime: 3600, jwt_algorithm: 'RS256', key_id: nil)
+        # noinspection RubyArgCount,RubyMismatchedArgumentType
+        super(open_id, auth_scopes, OAuth2::Client.new('zitadel', 'zitadel', {
+                                                         site: open_id.host_endpoint,
+                                                         token_url: open_id.token_endpoint
+                                                       }))
         @jwt_issuer = jwt_issuer
         @jwt_subject = jwt_subject
         @jwt_audience = jwt_audience
         @private_key = private_key
-        @jwt_lifetime = 3600
+        @jwt_lifetime = jwt_lifetime
+        @jwt_algorithm = jwt_algorithm
+        @key_id = key_id
       end
 
-      # Sets the JWT token lifetime in seconds.
+      # rubocop:enable Metrics/ParameterLists,Metrics/MethodLength
+
+      # Creates a WebTokenAuthenticator instance from a JSON configuration file.
       #
-      # @param seconds [Integer] Lifetime of the JWT in seconds.
-      # @return [WebTokenAuthenticatorBuilder] The builder instance.
-      def token_lifetime_seconds(seconds)
-        @jwt_lifetime = seconds
-        self
+      # The JSON file must be formatted as follows:
+      #
+      #   {
+      #     "type": "serviceaccount",
+      #     "keyId": "<key-id>",
+      #     "key": "<private-key>",
+      #     "userId": "<user-id>"
+      #   }
+      #
+      # @param host [String] Base URL for the API endpoints.
+      # @param json_path [String] File path to the JSON configuration file.
+      # @return [WebTokenAuthenticator] A new instance of WebTokenAuthenticator.
+      # @raise [RuntimeError] If the file cannot be read, the JSON is invalid, or required keys are missing.
+      def self.from_json(host, json_path)
+        config = JSON.parse(File.read(json_path))
+      rescue Errno::ENOENT => e
+        raise "Unable to read JSON file at #{json_path}: #{e.message}"
+      rescue JSON::ParserError => e
+        raise "Invalid JSON in file at #{json_path}: #{e.message}"
+      else
+        raise "Expected a JSON object, got #{config.class}" unless config.is_a?(Hash)
+
+        user_id, private_key, key_id = config.values_at('userId', 'key', 'keyId')
+        raise "Missing required keys 'userId', 'keyId' or 'key'" unless user_id && key_id && private_key
+
+        WebTokenAuthenticator.builder(host, user_id, private_key).key_identifier(key_id).build
       end
 
-      def key_identifier(key_id)
-        @key_id = key_id
-        self
+      # Returns a builder for constructing a WebTokenAuthenticator.
+      #
+      # @param host [String] The base URL for the OAuth provider.
+      # @param user_id [String] The user identifier (used as both the issuer and subject).
+      # @param private_key [String] The private key used to sign the JWT.
+      # @return [WebTokenAuthenticatorBuilder] A builder instance.
+      def self.builder(host, user_id, private_key)
+        WebTokenAuthenticatorBuilder.new(host, user_id, user_id, host, private_key)
       end
 
-      # Constructs and returns a new WebTokenAuthenticator instance using the configured parameters.
+      protected
+
+      # Overrides the base get_grant to return client credentials grant parameters.
+      #
+      # @return [OAuth2::AccessToken] A hash containing the grant type.
+      # rubocop:disable Metrics/MethodLength
+      def get_grant(client, auth_scopes)
+        client.assertion.get_token(
+          { iss: @jwt_issuer,
+            sub: @jwt_subject,
+            aud: @jwt_audience,
+            iat: Time.now.utc.to_i,
+            exp: (Time.now.utc + @jwt_lifetime).to_i },
+          {
+            algorithm: @jwt_algorithm,
+            key: OpenSSL::PKey::RSA.new(@private_key),
+            kid: @key_id
+          },
+          {
+            scope: auth_scopes
+          }
+        )
+      end
+
+      # rubocop:enable Metrics/MethodLength
+
+      # -----------------------------------------------------------------------------
+      # WebTokenAuthenticatorBuilder
+      # -----------------------------------------------------------------------------
+
+      # Builder for WebTokenAuthenticator.
       #
-      # @return [WebTokenAuthenticator] A configured instance.
-      def build
-        WebTokenAuthenticator.new(open_id, auth_scopes, @jwt_issuer, @jwt_subject, @jwt_audience,
-                                  @private_key, jwt_lifetime: @jwt_lifetime, key_id: @key_id)
+      # Provides a fluent API for configuring and constructing a WebTokenAuthenticator instance.
+      class WebTokenAuthenticatorBuilder < OAuthAuthenticatorBuilder
+        # Initializes the WebTokenAuthenticatorBuilder with required parameters.
+        #
+        # @param host [String] The base URL for API endpoints.
+        # @param jwt_issuer [String] The issuer claim for the JWT.
+        # @param jwt_subject [String] The subject claim for the JWT.
+        # @param jwt_audience [String] The audience claim for the JWT.
+        # @param private_key [String] The PEM-formatted private key used for signing the JWT.
+        def initialize(host, jwt_issuer, jwt_subject, jwt_audience, private_key)
+          # noinspection RubyArgCount
+          super(host)
+          @jwt_issuer = jwt_issuer
+          @jwt_subject = jwt_subject
+          @jwt_audience = jwt_audience
+          @private_key = private_key
+          @jwt_lifetime = 3600
+        end
+
+        # Sets the JWT token lifetime in seconds.
+        #
+        # @param seconds [Integer] Lifetime of the JWT in seconds.
+        # @return [WebTokenAuthenticatorBuilder] The builder instance.
+        def token_lifetime_seconds(seconds)
+          @jwt_lifetime = seconds
+          self
+        end
+
+        def key_identifier(key_id)
+          @key_id = key_id
+          self
+        end
+
+        # Constructs and returns a new WebTokenAuthenticator instance using the configured parameters.
+        #
+        # @return [WebTokenAuthenticator] A configured instance.
+        def build
+          WebTokenAuthenticator.new(open_id, auth_scopes, @jwt_issuer, @jwt_subject, @jwt_audience,
+                                    @private_key, jwt_lifetime: @jwt_lifetime, key_id: @key_id)
+        end
       end
     end
   end

data/lib/zitadel-client/configuration.rb

@@ -149,7 +149,7 @@ module ZitadelClient
     attr_accessor :user_agent
 
     # rubocop:disable Metrics/MethodLength
-    def initialize(authenticator = NoAuthAuthenticator.new)
+    def initialize(authenticator = Auth::NoAuthAuthenticator.new)
       @authenticator = authenticator
       @client_side_validation = true
       @verify_ssl = true

data/lib/zitadel-client/models/feature_service_details.rb

@@ -13,7 +13,7 @@ Generator version: 7.12.0
 require 'date'
 require 'time'
 
-module ZitadelClient
+module ZitadelClient::Models
   class FeatureServiceDetails
     # on read: the sequence of the last event reduced by the projection  on manipulation: the timestamp of the event(s) added by the manipulation
     attr_accessor :sequence
@@ -62,17 +62,19 @@ module ZitadelClient
     end
 
     # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
+    # @param [Hash] attributes Models 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 `ZitadelClient::FeatureServiceDetails` initialize method"
+        # MODIFIED: Updated class name in error message
+        fail ArgumentError, "The input argument (attributes) must be a hash in `ZitadelClient::Models::FeatureServiceDetails` 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 `ZitadelClient::FeatureServiceDetails`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          # MODIFIED: Updated class name in error message
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ZitadelClient::Models::FeatureServiceDetails`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -132,117 +134,125 @@ module ZitadelClient
       [sequence, change_date, resource_owner, creation_date].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
-
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def self._deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = ZitadelClient.const_get(type)
-        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+# Builds the object from hash
+# @param [Hash] attributes Models 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) # `new` will call the initialize method of the specific model class.
+end
 
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
+# Deserializes the data based on type
+# @param string type Data type
+# @param string value Value to be deserialized
+# @return [Object] Deserialized data
+def self._deserialize(type, value)
+  case type.to_sym
+  when :Time
+    Time.parse(value)
+  when :Date
+    Date.parse(value)
+  when :String
+    value.to_s
+  when :Integer
+    value.to_i
+  when :Float
+    value.to_f
+  when :Boolean
+    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+      true
+    else
+      false
+    end
+  when :Object
+    # generic object (usually a Hash), return directly
+    value
+  when /\AArray<(?<inner_type>.+)>\z/
+    inner_type = Regexp.last_match[:inner_type]
+    value.map { |v| _deserialize(inner_type, v) }
+  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+    k_type = Regexp.last_match[:k_type]
+    v_type = Regexp.last_match[:v_type]
+    {}.tap do |hash|
+      value.each do |k, v|
+        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+      end
     end
+  else # model
+    # models (e.g. Pet) or oneOf/anyOf constructs that resolve to a model name
+    # MODIFIED: Ensure model is looked up in the Models namespace
+    # 'type' here is expected to be the simple class name (e.g., "User", "OrderDetails")
+    klass = ZitadelClient::Models.const_get(type)
+    # The `klass.build` method is for oneOf/anyOf types (defined in partial_oneof_module.mustache / partial_anyof_module.mustache)
+    # The `klass.build_from_hash` is for regular model types (defined in this base_object.mustache itself)
+    if klass.respond_to?(:openapi_one_of) || klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_allOf)
+      klass.build(value) # For oneOf/anyOf/allOf, delegate to their specific build method
+    else
+      klass.build_from_hash(value) # For regular models
+    end
+  end
+end
 
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
+# Returns the string representation of the object
+# @return [String] String presentation of the object
+def to_s
+  to_hash.to_s
+end
+
+# to_body is an alias to to_hash (backward compatibility)
+# @return [Hash] Returns the object in the form of hash
+def to_body
+  to_hash
+end
+
+# Returns the object in the form of hash
+# @return [Hash] Returns the object in the form of hash
+def to_hash
+  hash = {} # Calls super.to_hash if parent exists
+  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
 
-    # 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
 
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
+# Outputs non-array value in the form of hash
+# For object, use to_hash. Otherwise, just return the value
+# @param [Object] value Any valid value
+# @return [Hash] Returns the value in the form of hash
+def _to_hash(value)
+  if value.is_a?(Array)
+    value.compact.map { |v| _to_hash(v) }
+  elsif value.is_a?(Hash)
+    {}.tap do |hash|
+      value.each { |k, v| hash[k] = _to_hash(v) }
     end
+  elsif value.respond_to? :to_hash
+    value.to_hash
+  else
+    value
+  end
+end
 
   end