zitadel-client 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ba72fde25fb11f42219067c11a39ba60175aba7de916e0454a5f4b995c9f85a
-  data.tar.gz: 29681b27b77059b6d36c3d6c9f2189395624b8234db9d933f00467637b57fa2b
+  metadata.gz: b139e11a711d0ca6bcc4934ab7c1590d364fc51fc2ad268f999171902b22e3a1
+  data.tar.gz: f2daf1d2b4442562bddaa5a580e814ca957cec630e387effa4b732ec925c6eab
 SHA512:
-  metadata.gz: 8abadfd2f80885e364051e381325506bd9c90f7e9e5bcd7760f820b1935b3a0b64e8c082f63269929db0f1c9b56235a9c21ff084120dc04dbddae9dac98b5c71
-  data.tar.gz: c699233ffca73d630fadef4d8b557e8a53f669e87217df0a0f6d67067e4dd342eeee2953cfd00d0b41389e8bcab5795e77ba519b45b7a473b546bdb1042aea2a
+  metadata.gz: 2896cb91da3700d1718a6b43c18538cc9b28e2d569d1a5a0ea307157b0bf3d8ea35711df5d7eab3ebabfaf18daba52cd115e314585b4b22bb6f2919c286aeebb
+  data.tar.gz: b684c59f939b8fabf774fb4611ee3dabb2f29c95097460597c3ae912d6ac39faa989dee5564cfec48766b577bbe5ceac556c49b77f1c0ca3ca1a44001162a1eb

data/README.md

@@ -39,13 +39,13 @@ Ensure you have Ruby 3 or higher installed.
 Install the SDK by running one of the following commands:
 
 ```
-gem install zitadel_client
+gem install zitadel-client
 ```
 
 If you're using Bundler use,
 
 ```
-bundle add zitadel_client
+bundle add zitadel-client
 ```
 
 ## Authentication Methods
@@ -72,20 +72,20 @@ JSON file. This process creates a secure token.
 **Example:**
 
 ```ruby
-require 'zitadel_client'
+require 'zitadel-client'
 require 'securerandom'
 
-client = ZitadelClient::Zitadel.with_private_key("https://example.us1.zitadel.cloud", "path/to/jwt-key.json")
+client = Zitadel::Client::Zitadel.with_private_key("https://example.us1.zitadel.cloud", "path/to/jwt-key.json")
 
 begin
   response = client.users.user_service_add_human_user(
-    ZitadelClient::UserServiceAddHumanUserRequest.new(
+    Zitadel::Client::UserServiceAddHumanUserRequest.new(
       username: SecureRandom.hex,
-      profile: ZitadelClient::UserServiceSetHumanProfile.new(
+      profile: Zitadel::Client::UserServiceSetHumanProfile.new(
         given_name: 'John',
         family_name: 'Doe'
       ),
-      email: ZitadelClient::UserServiceSetHumanEmail.new(
+      email: Zitadel::Client::UserServiceSetHumanEmail.new(
         email: "john.doe@example.com"
       )
     )
@@ -115,20 +115,20 @@ which is then used to authenticate.
 **Example:**
 
 ```ruby
-require 'zitadel_client'
+require 'zitadel-client'
 require 'securerandom'
 
-client = ZitadelClient::Zitadel.with_client_credentials("https://example.us1.zitadel.cloud", "id", "secret")
+client = Zitadel::Client::Zitadel.with_client_credentials("https://example.us1.zitadel.cloud", "id", "secret")
 
 begin
   response = client.users.user_service_add_human_user(
-    ZitadelClient::UserServiceAddHumanUserRequest.new(
+    Zitadel::Client::UserServiceAddHumanUserRequest.new(
       username: SecureRandom.hex,
-      profile: ZitadelClient::UserServiceSetHumanProfile.new(
+      profile: Zitadel::Client::UserServiceSetHumanProfile.new(
         given_name: 'John',
         family_name: 'Doe'
       ),
-      email: ZitadelClient::UserServiceSetHumanEmail.new(
+      email: Zitadel::Client::UserServiceSetHumanEmail.new(
         email: "john.doe@example.com"
       )
     )
@@ -158,20 +158,20 @@ authenticate without exchanging credentials every time.
 **Example:**
 
 ```ruby
-require 'zitadel_client'
+require 'zitadel-client'
 require 'securerandom'
 
-client = ZitadelClient::Zitadel.with_access_token("https://example.us1.zitadel.cloud", "token")
+client = Zitadel::Client::Zitadel.with_access_token("https://example.us1.zitadel.cloud", "token")
 
 begin
   response = client.users.user_service_add_human_user(
-    ZitadelClient::UserServiceAddHumanUserRequest.new(
+    Zitadel::Client::UserServiceAddHumanUserRequest.new(
       username: SecureRandom.hex,
-      profile: ZitadelClient::UserServiceSetHumanProfile.new(
+      profile: Zitadel::Client::UserServiceSetHumanProfile.new(
         given_name: 'John',
         family_name: 'Doe'
       ),
-      email: ZitadelClient::UserServiceSetHumanEmail.new(
+      email: Zitadel::Client::UserServiceSetHumanEmail.new(
         email: "john.doe@example.com"
       )
     )

data/lib/{zitadel-client → zitadel/client}/api/feature_service_api.rb

@@ -12,8 +12,7 @@ Generator version: 7.12.0
 
 require 'cgi'
 
-module ZitadelClient
-module Api # Added Api module
+module Zitadel::Client::Api
   class FeatureServiceApi
   attr_accessor :api_client
 
@@ -781,5 +780,4 @@ module Api # Added Api module
     return data, status_code, headers
     end
   end
-end # End of Api module
 end

data/lib/{zitadel-client → zitadel/client}/api/identity_provider_service_api.rb

@@ -12,8 +12,7 @@ Generator version: 7.12.0
 
 require 'cgi'
 
-module ZitadelClient
-module Api # Added Api module
+module Zitadel::Client::Api
   class IdentityProviderServiceApi
   attr_accessor :api_client
 
@@ -83,5 +82,4 @@ module Api # Added Api module
     return data, status_code, headers
     end
   end
-end # End of Api module
 end

data/lib/{zitadel-client → zitadel/client}/api/o_i_d_c_service_api.rb

@@ -12,8 +12,7 @@ Generator version: 7.12.0
 
 require 'cgi'
 
-module ZitadelClient
-module Api # Added Api module
+module Zitadel::Client::Api
   class OIDCServiceApi
   attr_accessor :api_client
 
@@ -294,5 +293,4 @@ module Api # Added Api module
     return data, status_code, headers
     end
   end
-end # End of Api module
 end

data/lib/{zitadel-client → zitadel/client}/api/organization_service_api.rb

@@ -12,8 +12,7 @@ Generator version: 7.12.0
 
 require 'cgi'
 
-module ZitadelClient
-module Api # Added Api module
+module Zitadel::Client::Api
   class OrganizationServiceApi
   attr_accessor :api_client
 
@@ -156,5 +155,4 @@ module Api # Added Api module
     return data, status_code, headers
     end
   end
-end # End of Api module
 end

data/lib/{zitadel-client → zitadel/client}/api/s_a_m_l_service_api.rb

@@ -12,8 +12,7 @@ Generator version: 7.12.0
 
 require 'cgi'
 
-module ZitadelClient
-module Api # Added Api module
+module Zitadel::Client::Api
   class SAMLServiceApi
   attr_accessor :api_client
 
@@ -157,5 +156,4 @@ module Api # Added Api module
     return data, status_code, headers
     end
   end
-end # End of Api module
 end

data/lib/{zitadel-client → zitadel/client}/api/session_service_api.rb

@@ -12,8 +12,7 @@ Generator version: 7.12.0
 
 require 'cgi'
 
-module ZitadelClient
-module Api # Added Api module
+module Zitadel::Client::Api
   class SessionServiceApi
   attr_accessor :api_client
 
@@ -370,5 +369,4 @@ module Api # Added Api module
     return data, status_code, headers
     end
   end
-end # End of Api module
 end

data/lib/{zitadel-client → zitadel/client}/api/settings_api.rb

@@ -12,8 +12,7 @@ Generator version: 7.12.0
 
 require 'cgi'
 
-module ZitadelClient
-module Api # Added Api module
+module Zitadel::Client::Api
   class SettingsApi
   attr_accessor :api_client
 
@@ -145,5 +144,4 @@ module Api # Added Api module
     return data, status_code, headers
     end
   end
-end # End of Api module
 end

data/lib/{zitadel-client → zitadel/client}/api/settings_service_api.rb

@@ -12,8 +12,7 @@ Generator version: 7.12.0
 
 require 'cgi'
 
-module ZitadelClient
-module Api # Added Api module
+module Zitadel::Client::Api
   class SettingsServiceApi
   attr_accessor :api_client
 
@@ -593,5 +592,4 @@ module Api # Added Api module
     return data, status_code, headers
     end
   end
-end # End of Api module
 end

data/lib/{zitadel-client → zitadel/client}/api/user_service_api.rb

@@ -12,8 +12,7 @@ Generator version: 7.12.0
 
 require 'cgi'
 
-module ZitadelClient
-module Api # Added Api module
+module Zitadel::Client::Api
   class UserServiceApi
   attr_accessor :api_client
 
@@ -3208,5 +3207,4 @@ module Api # Added Api module
     return data, status_code, headers
     end
   end
-end # End of Api module
 end

data/lib/zitadel/client/api_client.rb

@@ -0,0 +1,378 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/ClassVars
+# rubocop:disable Metrics/AbcSize
+# rubocop:disable Metrics/CyclomaticComplexity
+# rubocop:disable Metrics/MethodLength
+# rubocop:disable Metrics/PerceivedComplexity
+# rubocop:disable Metrics/ClassLength
+
+require 'date'
+require 'json'
+require 'logger'
+require 'tempfile'
+require 'time'
+require 'typhoeus'
+require 'uri'
+
+module Zitadel
+  module Client
+    # ApiClient handles all HTTP interactions with the Zitadel API.
+    #
+    # It is responsible for:
+    # - Constructing and signing requests via the configured authenticator
+    # - Executing HTTP calls and handling errors (timeouts, non-2xx responses)
+    # - Streaming file downloads into temporary files
+    # - Deserializing JSON responses into Ruby types and model objects
+    #
+    # === Usage Example:
+    #   config = Zitadel::Client::Configuration.new do |c|
+    #     c.authenticator = Zitadel::Client::ClientCredentialsAuthenticator.builder(base_url, id, secret).build
+    #   end
+    #   client = Zitadel::Client::ApiClient.new(config)
+    #   data, status, headers = client.call_api(:get, '/users', query_params: { limit: 10 })
+    class ApiClient
+      # The Configuration object holding settings to be used in the API client.
+      attr_accessor :config
+
+      # Defines the headers to be used in HTTP requests of all API calls by default.
+      #
+      # @return [Hash[String, String]]
+      attr_accessor :default_headers
+
+      # Initializes the ApiClient
+      # @option config [Configuration] Configuration for initializing the object, default to the
+      # default configuration.
+      def initialize(config = Configuration.new)
+        @config = config
+        @default_headers = {
+          'Content-Type' => 'application/json',
+          'User-Agent' => config.user_agent
+        }
+      end
+
+      # noinspection RubyClassVariableUsageInspection,RbsMissingTypeSignature
+      # @return [Zitadel::Client::ApiClient]
+      def self.default
+        @@default ||= ApiClient.new
+      end
+
+      # Call an API with given options.
+      #
+      # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
+      #   the data deserialized from response body (which may be a Tempfile or nil), response status code and response headers.
+      # noinspection RbsMissingTypeSignature
+      def call_api(http_method, path, opts = {})
+        request = build_request(http_method, path, opts)
+        tempfile = nil
+        (download_file(request) { tempfile = _1 }) if opts[:return_type] == 'File'
+        response = request.run
+
+        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n" if @config.debugging
+
+        unless response.success?
+          if response.timed_out?
+            raise 'Connection timed out'
+          elsif response.return_code != :ok
+            raise "Network error (#{response.return_code}): #{response.return_message}"
+          else
+            raise ApiError.new(response.code, response.headers, response.body)
+          end
+        end
+
+        data = if opts[:return_type] == 'File'
+                 tempfile
+               elsif opts[:return_type]
+                 deserialize(response, opts[:return_type])
+               end
+        [data, response.code, response.headers]
+      end
+
+      def build_request(http_method, path, opts = {})
+        url = URI.join("#{@config.authenticator.send(:host).chomp('/')}/", path).to_s
+        http_method = http_method.to_sym.downcase
+
+        query_params = opts[:query_params] || {}
+        form_params = opts[:form_params] || {}
+        follow_location = opts[:follow_location] || true
+        header_params = @default_headers.merge(opts[:header_params] || {}).merge(@config.authenticator.send(:auth_headers))
+
+        req_opts = {
+          method: http_method,
+          headers: header_params,
+          params: query_params,
+          params_encoding: @config.params_encoding,
+          timeout: @config.timeout,
+          ssl_verifypeer: @config.verify_ssl,
+          ssl_verifyhost: (@config.verify_ssl_host ? 2 : 0),
+          sslcert: @config.cert_file,
+          sslkey: @config.key_file,
+          verbose: @config.debugging,
+          followlocation: follow_location
+        }
+
+        # set custom cert, if provided
+        req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
+
+        if %i[post patch put delete].include?(http_method)
+          req_body = build_request_body(header_params, form_params, opts[:body])
+          req_opts.update body: req_body
+          @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n" if @config.debugging
+        end
+
+        Typhoeus::Request.new(url, req_opts)
+      end
+
+      # Builds the HTTP request body
+      #
+      # @param [Hash] header_params Header parameters
+      # @param [Hash] form_params Query parameters
+      # @param [Object] body HTTP body (JSON/XML)
+      # @return [String] HTTP body data in the form of string
+      # noinspection RubyMismatchedReturnType,RubyArgCount,RbsMissingTypeSignature
+      def build_request_body(header_params, form_params, body)
+        # http form
+        if ['application/x-www-form-urlencoded',
+            'multipart/form-data'].include?(header_params['Content-Type'])
+          data = {}
+          form_params.each do |key, value|
+            data[key] = case value
+                        when ::File, ::Array, nil
+                          # let typhoeus handle File, Array and nil parameters
+                          value
+                        else
+                          value.to_s
+                        end
+          end
+        elsif body
+          data = body.is_a?(String) ? body : body.to_json
+        else
+          data = nil
+        end
+        data
+      end
+
+      # Save response body into a file in (the defined) temporary folder, using the filename
+      # from the "Content-Disposition" header if provided, otherwise a random filename.
+      # The response body is written to the file in chunks in order to handle files which
+      # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
+      # process can use.
+      #
+      # @see Configuration#temp_folder_path
+      #
+      # @return [Tempfile] the tempfile generated
+      # noinspection RbsMissingTypeSignature
+      def download_file(request)
+        tempfile = nil
+        encoding = nil
+
+        request.on_headers do |response|
+          content_disposition = response.headers['Content-Disposition']
+          if content_disposition && content_disposition =~ /filename=/i
+            filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+            prefix = sanitize_filename(filename)
+          else
+            prefix = 'download-'
+          end
+          prefix += '-' unless prefix.end_with?('-')
+          encoding = response.body.encoding
+          tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+        end
+
+        request.on_body do |chunk|
+          chunk.force_encoding(encoding) if encoding
+          ensure_tempfile(tempfile).write(chunk)
+        end
+
+        request.on_complete do
+          t = ensure_tempfile(tempfile)
+          t.close
+          @config.logger.info "Temp file written to #{t.path}, please copy the file to a proper folder " \
+                              "with e.g. `FileUtils.cp(t.path, '/new/file/path')` otherwise the temp file " \
+                              "will be deleted automatically with GC. It's also recommended to delete the temp file " \
+                              'explicitly with `t.delete`'
+          yield t if block_given?
+        end
+      end
+
+      def ensure_tempfile(temp)
+        temp || (raise 'Tempfile not created')
+      end
+
+      # Check if the given MIME is a JSON MIME.
+      # JSON MIME examples:
+      #   application/json
+      #   application/json; charset=UTF8
+      #   APPLICATION/JSON
+      #   */*
+      # @param [String] mime MIME
+      # @return [Boolean] True if the MIME is application/json
+      # noinspection RbsMissingTypeSignature
+      def json_mime?(mime)
+        (mime == '*/*') || !(mime =~ %r{^Application/.*json(?!p)(;.*)?}i).nil?
+      end
+
+      # Deserialize the response to the given return type.
+      #
+      # @param [Response] response HTTP response
+      # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
+      # noinspection RbsMissingTypeSignature
+      def deserialize(response, return_type)
+        body = response.body
+        return nil if body.nil? || body.empty?
+
+        # return response body directly for String return type
+        return body.to_s if return_type == 'String'
+
+        # ensuring a default content type
+        content_type = response.headers['Content-Type'] || 'application/json'
+
+        raise "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
+
+        begin
+          data = JSON.parse("[#{body}]", symbolize_names: true)[0]
+        rescue JSON::ParserError => e
+          raise e unless %w[String Date Time].include?(return_type)
+
+          data = body
+        end
+
+        convert_to_type data, return_type
+      end
+
+      # Convert data to the given return type.
+      # @param [Object] data Data to be converted
+      # @param [String] return_type Return type
+      # @return [Mixed] Data in a particular type
+      # noinspection RubyArgCount,RubyMismatchedArgumentType,RbsMissingTypeSignature
+      def convert_to_type(data, return_type)
+        return nil if data.nil?
+
+        # noinspection RegExpRedundantEscape
+        case return_type
+        when 'String'
+          data.to_s
+        when 'Integer'
+          data.to_i
+        when 'Float'
+          data.to_f
+        when 'Boolean'
+          data == true
+        when 'Time'
+          # parse date time (expecting ISO 8601 format)
+          Time.parse data
+        when 'Date'
+          # parse date time (expecting ISO 8601 format)
+          Date.parse data
+        when 'Object'
+          # generic object (usually a Hash), return directly
+          data
+        when /\AArray<(.+)>\z/
+          # e.g. Array<Pet>
+          sub_type = ::Regexp.last_match(1)
+          data.map { |item| convert_to_type(item, sub_type) }
+        when /\AHash<String, (.+)>\z/
+          # e.g. Hash<String, Integer>
+          sub_type = ::Regexp.last_match(1)
+          {}.tap do |hash|
+            data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
+          end
+        else
+          # models (e.g. Pet) or oneOf
+          klass = Models.const_get(return_type)
+          klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
+        end
+      end
+
+      # Sanitize filename by removing path.
+      # e.g. ../../sun.gif becomes sun.gif
+      #
+      # @param [String] filename the filename to be sanitized
+      # @return [String] the sanitized filename
+      # noinspection RubyMismatchedReturnType,RbsMissingTypeSignature
+      def sanitize_filename(filename)
+        filename.split(%r{[/\\]}).last
+      end
+
+      # Return Accept header based on an array of accepts provided.
+      # @param [Array] accepts array for Accept
+      # @return [String] the Accept header (e.g. application/json)
+      # noinspection RubyArgCount,RbsMissingTypeSignature
+      def select_header_accept(accepts)
+        return nil if accepts.nil? || accepts.empty?
+
+        # use JSON when present, otherwise use all the provided
+        json_accept = accepts.find { |s| json_mime?(s) }
+        json_accept || accepts.join(',')
+      end
+
+      # Return Content-Type header based on an array of content types provided.
+      # @param [Array] content_types array for Content-Type
+      # @return [String] the Content-Type header  (e.g. application/json)
+      # noinspection RubyArgCount,RbsMissingTypeSignature
+      def select_header_content_type(content_types)
+        # return nil by default
+        return if content_types.nil? || content_types.empty?
+
+        # use JSON when present, otherwise use the first one
+        json_content_type = content_types.find { |s| json_mime?(s) }
+        json_content_type || content_types.first
+      end
+
+      # Convert object (array, hash, object, etc.) to JSON string.
+      # @param [Object] model object to be converted into JSON string
+      # @return [String] JSON string representation of the object
+      # noinspection RubyMismatchedReturnType,RbsMissingTypeSignature
+      def object_to_http_body(model)
+        return model if model.nil? || model.is_a?(String)
+
+        local_body = if model.is_a?(Array)
+                       model.map { |m| object_to_hash(m) }
+                     else
+                       object_to_hash(model)
+                     end
+        local_body.to_json
+      end
+
+      # Convert object(non-array) to hash.
+      # @param [Object] obj object to be converted into JSON string
+      # @return [String] JSON string representation of the object
+      # noinspection RubyMismatchedReturnType,RbsMissingTypeSignature
+      def object_to_hash(obj)
+        if obj.respond_to?(:to_hash)
+          obj.to_hash
+        else
+          obj
+        end
+      end
+
+      # Build parameter value according to the given collection format.
+      # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
+      # noinspection RbsMissingTypeSignature
+      def build_collection_param(param, collection_format)
+        case collection_format
+        when :csv
+          param.join(',')
+        when :ssv
+          param.join(' ')
+        when :tsv
+          param.join("\t")
+        when :pipes
+          param.join('|')
+        when :multi
+          # return the array directly as typhoeus will handle it as expected
+          param
+        else
+          raise "unknown collection format: #{collection_format.inspect}"
+        end
+      end
+    end
+  end
+end
+
+# rubocop:enable Style/ClassVars
+# rubocop:enable Metrics/AbcSize
+# rubocop:enable Metrics/CyclomaticComplexity
+# rubocop:enable Metrics/MethodLength
+# rubocop:enable Metrics/PerceivedComplexity
+# rubocop:enable Metrics/ClassLength

data/lib/zitadel/client/api_error.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Zitadel
+  module Client
+    ##
+    # Represents an HTTP error returned from the Zitadel API.
+    #
+    # Exposes the HTTP status code, response headers, and response body.
+    class ApiError < ZitadelError
+      # @return [Integer] HTTP status code
+      attr_reader :code
+
+      # @return [Hash{String=>Array<String>}] HTTP response headers
+      attr_reader :response_headers
+
+      # @return [String, Typhoeus::Response] HTTP response body
+      attr_reader :response_body
+
+      ##
+      # @param code             [Integer]                     HTTP status code
+      # @param response_headers [Hash{String=>Array<String>}] HTTP response headers
+      # @param response_body    [String, Typhoeus::Response]  HTTP response body
+      def initialize(code, response_headers, response_body)
+        super("Error #{code}")
+        @code = code
+        @response_headers = response_headers
+        @response_body = response_body
+      end
+    end
+  end
+end