Class: Zitadel::Client::ApiClient

Inherits:
Object
  • Object
show all
Defined in:
lib/zitadel/client/api_client.rb

Overview

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 })

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = Configuration.new) ⇒ ApiClient

Initializes the ApiClient default configuration.

Parameters:

  • config (Hash) (defaults to: Configuration.new) —

    a customizable set of options

Options Hash (config):

  • Configuration (Configuration) —

    for initializing the object, default to the



46
47
48
49
50
51
52
 
# File 'lib/zitadel/client/api_client.rb', line 46

def initialize(config = Configuration.new)
  @config = config
  @default_headers = {
    'Content-Type' => 'application/json',
    'User-Agent' => config.user_agent
  }
end

Instance Attribute Details

#config ⇒ Object

The Configuration object holding settings to be used in the API client.



36
37
38
 
# File 'lib/zitadel/client/api_client.rb', line 36

def config
  @config
end

#default_headers ⇒ Hash[String, String]

Defines the headers to be used in HTTP requests of all API calls by default.

Returns:

  • (Hash[String, String]) 


41
42
43
 
# File 'lib/zitadel/client/api_client.rb', line 41

def default_headers
  @default_headers
end

Class Method Details

.default ⇒ Zitadel::Client::ApiClient

noinspection RubyClassVariableUsageInspection,RbsMissingTypeSignature

Returns:



56
57
58
 
# File 'lib/zitadel/client/api_client.rb', line 56

def self.default
  @@default ||= ApiClient.new
end

Instance Method Details

#build_collection_param(param, collection_format) ⇒ Object

Build parameter value according to the given collection format. noinspection RbsMissingTypeSignature

Parameters:

  • collection_format (String) —

    one of :csv, :ssv, :tsv, :pipes and :multi



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/zitadel/client/api_client.rb', line 352

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

#build_request(http_method, path, opts = {}) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/zitadel/client/api_client.rb', line 91

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

#build_request_body(header_params, form_params, body) ⇒ String

Builds the HTTP request body

noinspection RubyMismatchedReturnType,RubyArgCount,RbsMissingTypeSignature

Parameters:

  • header_params (Hash) —

    Header parameters

  • form_params (Hash) —

    Query parameters

  • body (Object) —

    HTTP body (JSON/XML)

Returns:

  • (String) —

    HTTP body data in the form of string



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/zitadel/client/api_client.rb', line 133

def build_request_body(header_params, form_params, body)
  # http form
  if %w[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

#call_api(http_method, path, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Call an API with given options.

noinspection RbsMissingTypeSignature

Returns:

  • (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.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/zitadel/client/api_client.rb', line 65

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

#convert_to_type(data, return_type) ⇒ Mixed

Convert data to the given return type. noinspection RubyArgCount,RubyMismatchedArgumentType,RbsMissingTypeSignature

Parameters:

  • data (Object) —

    Data to be converted

  • return_type (String) —

    Return type

Returns:

  • (Mixed) —

    Data in a particular type



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/zitadel/client/api_client.rb', line 248

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

#deserialize(response, return_type) ⇒ Object

Deserialize the response to the given return type.

noinspection RbsMissingTypeSignature

Parameters:

  • response (Response) —

    HTTP response

  • return_type (String) —

    some examples: “User”, “Array<User>”, “Hash<String, Integer>”



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/zitadel/client/api_client.rb', line 220

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

#download_file(request) ⇒ Tempfile

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.

noinspection RbsMissingTypeSignature

Returns:

  • (Tempfile) —

    the tempfile generated

See Also:



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/zitadel/client/api_client.rb', line 164

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
    # noinspection RubyNilAnalysis
    @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

#ensure_tempfile(temp) ⇒ Object 



198
199
200
 
# File 'lib/zitadel/client/api_client.rb', line 198

def ensure_tempfile(temp)
  temp || (raise 'Tempfile not created')
end

#json_mime?(mime) ⇒ Boolean

Check if the given MIME is a JSON MIME. JSON MIME examples:

application/json
application/json; charset=UTF8
APPLICATION/JSON
*/*

noinspection RbsMissingTypeSignature

Parameters:

  • mime (String) —

    MIME

Returns:

  • (Boolean) —

    True if the MIME is application/json



211
212
213
 
# File 'lib/zitadel/client/api_client.rb', line 211

def json_mime?(mime)
  (mime == '*/*') || !(mime =~ %r{^Application/.*json(?!p)(;.*)?}i).nil?
end

#object_to_hash(obj) ⇒ String

Convert object(non-array) to hash. noinspection RubyMismatchedReturnType,RbsMissingTypeSignature

Parameters:

  • obj (Object) —

    object to be converted into JSON string

Returns:

  • (String) —

    JSON string representation of the object



341
342
343
344
345
346
347
 
# File 'lib/zitadel/client/api_client.rb', line 341

def object_to_hash(obj)
  if obj.respond_to?(:to_hash)
    obj.to_hash
  else
    obj
  end
end

#object_to_http_body(model) ⇒ String

Convert object (array, hash, object, etc.) to JSON string. noinspection RubyMismatchedReturnType,RbsMissingTypeSignature

Parameters:

  • model (Object) —

    object to be converted into JSON string

Returns:

  • (String) —

    JSON string representation of the object



326
327
328
329
330
331
332
333
334
335
 
# File 'lib/zitadel/client/api_client.rb', line 326

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

#sanitize_filename(filename) ⇒ String

Sanitize filename by removing path. e.g. ../../sun.gif becomes sun.gif

noinspection RubyMismatchedReturnType,RbsMissingTypeSignature

Parameters:

  • filename (String) —

    the filename to be sanitized

Returns:

  • (String) —

    the sanitized filename



293
294
295
 
# File 'lib/zitadel/client/api_client.rb', line 293

def sanitize_filename(filename)
  filename.split(%r{[/\\]}).last
end

#select_header_accept(accepts) ⇒ String

Return Accept header based on an array of accepts provided. noinspection RubyArgCount,RbsMissingTypeSignature

Parameters:

  • accepts (Array) —

    array for Accept

Returns:

  • (String) —

    the Accept header (e.g. application/json)



301
302
303
304
305
306
307
 
# File 'lib/zitadel/client/api_client.rb', line 301

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

#select_header_content_type(content_types) ⇒ String

Return Content-Type header based on an array of content types provided. noinspection RubyArgCount,RbsMissingTypeSignature

Parameters:

  • content_types (Array) —

    array for Content-Type

Returns:

  • (String) —

    the Content-Type header (e.g. application/json)



313
314
315
316
317
318
319
320
 
# File 'lib/zitadel/client/api_client.rb', line 313

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