Module: CldProvisioning::Utils

Extended by:
T::Sig
Includes:
Kernel
Defined in:
lib/cld_provisioning/utils/url.rb,
lib/cld_provisioning/utils/forms.rb,
lib/cld_provisioning/utils/utils.rb,
lib/cld_provisioning/utils/headers.rb,
lib/cld_provisioning/utils/retries.rb,
lib/cld_provisioning/utils/security.rb,
lib/cld_provisioning/utils/query_params.rb,
lib/cld_provisioning/utils/request_bodies.rb

Defined Under Namespace

Classes: BackoffStrategy, RetryConfig

Constant Summary collapse

MIME_TYPES = 
{
  ".json" => "application/json",
  ".xml" => "application/xml",
  ".pdf" => "application/pdf",
  ".zip" => "application/zip",
  ".gz" => "application/gzip",
  ".csv" => "text/csv",
  ".txt" => "text/plain",
  ".html" => "text/html",
  ".htm" => "text/html",
  ".css" => "text/css",
  ".js" => "application/javascript",
  ".png" => "image/png",
  ".jpg" => "image/jpeg",
  ".jpeg" => "image/jpeg",
  ".gif" => "image/gif",
  ".svg" => "image/svg+xml",
  ".webp" => "image/webp",
  ".mp3" => "audio/mpeg",
  ".mp4" => "video/mp4",
  ".yaml" => "application/yaml",
  ".yml" => "application/yaml"
}.freeze
SERIALIZATION_METHOD_TO_CONTENT_TYPE = 
{
  'json': "application/json",
  'form': "application/x-www-form-urlencoded",
  'multipart': "multipart/form-data",
  'raw': "application/octet-stream",
  'string': "text/plain"
}.freeze

Class Method Summary collapse

Class Method Details

._encode_path_param(value) ⇒ Object 



105
106
107
 
# File 'lib/cld_provisioning/utils/url.rb', line 105

def self._encode_path_param(value)
  value.gsub(/[<>{}\[\]|\\^`\s?#%]/) { |c| format("%%%02X", c.ord) }
end

._get_deep_object_query_params(metadata, field_name, obj) ⇒ Object 



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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/cld_provisioning/utils/query_params.rb', line 98

def self._get_deep_object_query_params(metadata, field_name, obj)
  params = T.let({}, T::Hash[T.any(String, Symbol), T::Array[String]])

  return params if obj.nil?

  if obj.respond_to?(:fields)
    T.unsafe(obj).fields.each do |obj_field|
      obj_param_metadata = obj_field.metadata[:query_param]
      next if obj_param_metadata.nil?

      val = obj.send(obj_field.name)
      next if val.nil?

      key = "#{metadata.fetch(:field_name, field_name)}[#{obj_param_metadata.fetch(:field_name, obj_field.name)}]"
      if val.is_a?(Array)
        val.each do |v|
          next if v.nil?

          params[key] = [] if !params.include?(key)

          T.must(params[key]) << val_to_string(v)
        end
      else
        params[key] = [val_to_string(val)]
      end
    end
  elsif obj.is_a?(Hash)
    obj.each do |key, value|
      next if value.nil?

      param_key = "#{metadata.fetch(:field_name, field_name)}[#{key}]"
      if value.is_a?(Array)
        value.each do |val|
          next if val.nil?

          params[param_key] = [] if !params.include?(param_key)

          T.must(params[param_key]).append(val_to_string(val))
        end
      else
        params[param_key] = [val_to_string(value)]
      end
    end
  end

  params
end

._get_delimited_query_params(metadata, field_name, obj, delimiter) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/cld_provisioning/utils/query_params.rb', line 150

def self._get_delimited_query_params(metadata, field_name, obj, delimiter)
  get_query_param_field_name = lambda do |obj_field|
    obj_param_metadata = obj_field.metadata[:query_param]

    return {} if obj_param_metadata.nil?

    return obj_param_metadata.fetch(:field_name, obj_field.name)
  end

  _populate_form(
    field_name,
    T.cast(metadata.fetch(:explode, true), T::Boolean),
    obj,
    delimiter,
    &get_query_param_field_name
  )
end

._get_serialized_params(metadata, field_name, obj) ⇒ Object 



64
65
66
67
68
69
70
71
 
# File 'lib/cld_provisioning/utils/utils.rb', line 64

def self._get_serialized_params(metadata, field_name, obj)
  params = {}

  serialization = metadata.fetch(:serialization, "")
  params[metadata.fetch(:field_name, field_name)] = [obj.to_json] if serialization == "json"

  params
end

._parse_basic_auth_scheme(req, scheme) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/cld_provisioning/utils/security.rb', line 138

def self._parse_basic_auth_scheme(req, scheme)
  username = T.let("", String)
  password = T.let("", String)

  T.unsafe(scheme).fields.each do |scheme_field|
    metadata = scheme_field.metadata[:security]
    next if metadata.nil? || !metadata.include?(:field_name)

    field_name = metadata[:field_name]
    value = scheme.send(scheme_field.name)

    username = T.let(value, String) if field_name == "username"
    password = T.let(value, String) if field_name == "password"
  end

  data = "#{username}:#{password}".encode
  # Use strict_encode, because encode adds newlines after 60 chars
  # https://docs.ruby-lang.org/en/3.0/Base64.html#method-i-encode64
  req.headers["Authorization"] = "Basic #{Base64.strict_encode64(data)}"
end

._parse_security_option(req, option) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/cld_provisioning/utils/security.rb', line 52

def self._parse_security_option(req, option)
  # Check if this option uses basic auth (needs the whole object, not individual fields)
  first_field = T.unsafe(option).fields.first
  if first_field
    first_meta = first_field.metadata[:security]
    if first_meta && first_meta[:type] == "http" && first_meta[:sub_type] == "basic"
      _parse_security_scheme(req, first_meta, option)
      return
    end
  end

  T.unsafe(option).fields.each do |opt_field|
    metadata = opt_field.metadata[:security]
    next if metadata.nil? || !metadata.include?(:scheme)

    _parse_security_scheme(req, metadata, option.send(opt_field.name))
  end
end

._parse_security_scheme(req, scheme_metadata, scheme) ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/cld_provisioning/utils/security.rb', line 72

def self._parse_security_scheme(req, scheme_metadata, scheme)
  scheme_type = scheme_metadata[:type]
  sub_type = scheme_metadata[:sub_type]

  if scheme.respond_to?(:fields)
    if scheme_type == "http" && sub_type == "basic"
      _parse_basic_auth_scheme(req, scheme)
      return
    end

    T.unsafe(scheme).fields.each do |field|
      metadata = field.metadata[:security]
      next if metadata.nil? || metadata[:field_name].nil?

      value = scheme.send(field.name)
      _parse_security_scheme_value(req, scheme_metadata, metadata, T.cast(value, String))
    end
  else
    _parse_security_scheme_value(req, scheme_metadata, scheme_metadata, T.cast(scheme, String))
  end
end

._parse_security_scheme_value(req, scheme_metadata, security_metadata, value) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/cld_provisioning/utils/security.rb', line 103

def self._parse_security_scheme_value(req, scheme_metadata, security_metadata, value)
  scheme_type = scheme_metadata[:type]
  sub_type = scheme_metadata[:sub_type]

  header_name = security_metadata[:field_name]

  case scheme_type
  when "apiKey"
    case sub_type
    when "header"
      req.headers[header_name] = value
    when "query"
      req.params[header_name] = value
    when "cookie"
      req.headers["Cookie"][header_name] = value
    else
      raise StandardError, "not supported"
    end

  when "openIdConnect"
    req.headers[header_name] = value.downcase.start_with?("bearer ") ? value : "Bearer #{value}"
  when "oauth2"
    req.headers[header_name] = value.downcase.start_with?("bearer ") ? value : "Bearer #{value}"
  when "http"
    if sub_type == "bearer"
      req.headers[header_name] = value.downcase.start_with?("bearer ") ? value : "Bearer #{value}"
    elsif sub_type != "custom"
      raise StandardError, "not supported"
    end
  else
    raise StandardError, "not supported"
  end
end

._populate_form(field_name, explode, obj, delimiter, &get_field_name_lambda) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/cld_provisioning/utils/forms.rb', line 26

def self._populate_form(field_name, explode, obj, delimiter, &get_field_name_lambda)
  params = {}

  return params if obj.nil?

  if obj.respond_to?(:fields)
    items = []
    T.unsafe(obj).fields.each do |obj_field|
      obj_field_name = get_field_name_lambda.call(obj_field)
      next if obj_field_name == ""

      val = obj.send(obj_field.name.to_sym)
      next if val.nil?

      if explode
        params[obj_field_name] = [val_to_string(val)]
      else
        items.append("#{obj_field_name}#{delimiter}#{val_to_string(val)}")
      end
    end

    params[field_name] = [items.join(delimiter)] if !items.empty?
  elsif obj.is_a?(Hash)
    items = []
    obj.each do |key, value|
      next if value.nil?

      if explode
        params[key] = val_to_string(value)
      else
        items.append("#{key}#{delimiter}#{val_to_string(value)}")
      end
    end

    params[field_name] = [items.join(delimiter)] if !items.empty?

  elsif obj.is_a?(Array)
    items = []
    obj.each do |value|
      next if value.nil?

      if explode
        params[field_name] = [] if !params.key?(field_name)

        params[field_name].append(val_to_string(value))
      else
        items.append(val_to_string(value))
      end
    end

    params[field_name] = items.map(&:to_s).join(delimiter) if !items.empty?

  else
    params[field_name] = val_to_string(obj)
  end

  params
end

._populate_from_globals(param_name, value, param_type, gbls) ⇒ Object 



232
233
234
235
236
237
238
239
 
# File 'lib/cld_provisioning/utils/utils.rb', line 232

def self._populate_from_globals(param_name, value, param_type, gbls)
  if value.nil? && !gbls.nil?
    global_value = gbls.dig(:parameters, param_type.to_sym, param_name.to_sym)
    value = global_value if !global_value.nil?
  end

  value
end

._serialize_header(explode, obj) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/cld_provisioning/utils/headers.rb', line 38

def self._serialize_header(explode, obj)
  return "" if obj.nil?

  if obj.respond_to?(:fields)
    items = []
    T.unsafe(obj).fields.each do |obj_field|
      obj_param_metadata = obj_field.metadata[:header]
      next if obj_param_metadata.nil?

      obj_field_name = obj_param_metadata.fetch(:field_name, obj_field.name)
      next if obj_field_name == ""

      val = obj.send(obj_field.name)
      next if val.nil?

      if explode
        items.append("#{obj_field_name}=#{val_to_string(val)}")
      else
        items.append(obj_field_name)
        items.append(val_to_string(val))
      end
    end

    items.join(",") if !items.empty?
  elsif obj.is_a?(Hash)
    items = []
    obj.each do |key, value|
      next if value.nil?

      if explode
        items.append("#{key}=#{val_to_string(value)}")
      else
        items.append(key)
        items.append(val_to_string(value))
      end
    end

    items.join(",") if !items.empty?
  elsif obj.is_a?(Array)
    items = obj.filter { |v| !v.nil? }.map { |v| val_to_string(v) }.join(",")
  else
    val_to_string(obj)
  end
end

.configure_request_security(req, security, allowed_fields = nil) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/cld_provisioning/utils/security.rb', line 17

def self.configure_request_security(req, security, allowed_fields = nil)
  return if security.nil?

  sec_fields = if allowed_fields.nil?
    T.unsafe(security).fields
  else
    allowed_fields.filter_map { |name| T.unsafe(security).fields.find { |f| f.name == name } }
  end

  sec_fields.each do |sec_field|
    value = security.send(sec_field.name)
    next if value.nil?

    metadata = sec_field.metadata[:security]
    next if metadata.nil?

    if metadata[:option]
      _parse_security_option(req, value)
      break unless metadata[:composite]
    end

    next unless metadata[:scheme]

    # Special case for basic auth which could be a flattened struct
    if metadata[:sub_type] == "basic" && !value.respond_to?(:fields)
      _parse_security_scheme(req, metadata, security)
    else
      _parse_security_scheme(req, metadata, value)
    end

    break unless metadata[:composite]
  end
end

.date_from_iso_format(optional) ⇒ Object 



116
117
118
119
120
121
122
 
# File 'lib/cld_provisioning/utils/utils.rb', line 116

def self.date_from_iso_format(optional)
  Kernel.lambda do |s|
    return nil if optional && s.nil?

    return Date.iso8601(s)
  end
end

.datetime_from_iso_format(optional) ⇒ Object 



107
108
109
110
111
112
113
 
# File 'lib/cld_provisioning/utils/utils.rb', line 107

def self.datetime_from_iso_format(optional)
  Kernel.lambda do |s|
    return nil if optional && s.nil?

    return DateTime.strptime(s, "%Y-%m-%dT%H:%M:%S.%NZ")
  end
end

.encode_form(form) ⇒ Object 



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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/cld_provisioning/utils/utils.rb', line 168

def self.encode_form(form)
  payload = {}
  form.each do |field_name, field|
    field = T.must(field)
    if field.length == 2
      if field[0].nil?
        # Handle multiple values for the same field name (arrays)
        if payload.key?(field_name)
          # Convert to array if not already
          unless payload[field_name].is_a?(Array)
            payload[field_name] = [payload[field_name]]
          end

          payload[field_name] << field[1]
        else
          payload[field_name] = field[1]
        end
      else
        # Handle file uploads
        file_part = Faraday::Multipart::FilePart.new(
          StringIO.new(T.must(field[1])),
          mime_type_for_filename(T.must(field[0])),
          field[0]
        )

        # Handle multiple files for the same field name (arrays)
        if payload.key?(field_name)
          unless payload[field_name].is_a?(Array)
            payload[field_name] = [payload[field_name]]
          end

          payload[field_name] << file_part
        else
          payload[field_name] = file_part
        end
      end
    elsif field.length == 3
      param_part = Faraday::Multipart::ParamPart.new(field[1], field[2])

      # Handle multiple values for the same field name (arrays)
      if payload.key?(field_name)
        unless payload[field_name].is_a?(Array)
          payload[field_name] = [payload[field_name]]
        end

        payload[field_name] << param_part
      else
        payload[field_name] = param_part
      end
    end
  end

  payload
end

.enum_from_string(enum_type, optional) ⇒ Object 



128
129
130
131
132
133
134
 
# File 'lib/cld_provisioning/utils/utils.rb', line 128

def self.enum_from_string(enum_type, optional)
  Kernel.lambda do |s|
    return nil if optional && s.nil?

    return enum_type.deserialize(s)
  end
end

.error_status?(status) ⇒ Boolean

Returns:

  • (Boolean) 


74
75
76
77
78
79
80
 
# File 'lib/cld_provisioning/utils/utils.rb', line 74

def self.error_status?(status)
  status_major = status / 100
  return true if status_major == 4
  return true if status_major == 5

  false
end

.field_name(name) ⇒ Object 



149
150
151
 
# File 'lib/cld_provisioning/utils/utils.rb', line 149

def self.field_name(name)
  T.let(proc { name }, T.proc.returns(String))
end

.generate_url(clazz, server_url, path, path_params, gbls = nil) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/cld_provisioning/utils/url.rb', line 22

def self.generate_url(clazz, server_url, path, path_params, gbls = nil)
  T.unsafe(clazz).fields.each do |f|
    param_metadata = f.metadata[:path_param]
    next if param_metadata.nil?

    if param_metadata.fetch(:style, "simple") == "simple"
      param = path_params.send(f.name) if !path_params.nil?
      param = _populate_from_globals(f.name, param, "pathParam", gbls)
    end

    f_name = param_metadata.fetch(:field_name, f.name)
    serialization = param_metadata.fetch(:serialization, "")
    if serialization != ""
      serialized_params = _get_serialized_params(param_metadata, f_name, param)
      serialized_params.each do |k, v|
        path = path.gsub("{#{k}}", v.join(", "))
      end
    else
      if param.is_a?(Array)
        pp_vals = []
        param.each do |pp_val|
          pp_vals.append(pp_val.to_s)
        end

        path = path.gsub("{#{param_metadata.fetch(:field_name, f.name)}}", pp_vals.join(","))
      elsif param.is_a?(Hash)
        pp_vals = []
        param.each do |pp_key, pp_val|
          value = val_to_string(pp_val)

          if param_metadata.fetch(:explode, false)
            pp_vals.append("#{pp_key}=#{value}")
          else
            pp_vals.append("#{pp_key},#{value}")
          end
        end

        path = path.gsub("{#{param_metadata.fetch(:field_name, f.name)}}", pp_vals.join(","))
      elsif param.class.include?(::Crystalline::MetadataFields)
        pp_vals = []
        attrs = T
          .unsafe(param)
          .fields
          .filter { |field| field.name && param.respond_to?(field.name.to_sym) }
          .map(&:name)
        attrs.each do |attr|
          field = T.unsafe(param).field(attr)

          param_value_metadata = field.metadata[:path_param]

          next if param_value_metadata.nil?

          parm_name = param_value_metadata.fetch(:field_name, f.name)

          param_field_val = param.send(attr)

          if param_field_val.class.respond_to?(:enums)
            param_field_val = param_field_val.serialize
          elsif param_field_val.is_a?(DateTime)
            param_field_val = param_field_val.strftime("%Y-%m-%dT%H:%M:%S.%NZ")
          end

          if !field.nil? && ::Crystalline::Utils.nilable?(field.type) && param_field_val.nil?
            next
          elsif param_metadata.fetch(:explode, false)
            pp_vals.append("#{parm_name}=#{param_field_val}")
          else
            pp_vals.append("#{parm_name},#{param_field_val}")
          end
        end

        path = path.gsub("{#{param_metadata.fetch(:field_name, f.name)}}", pp_vals.join(","))
      else
        path = path.gsub("{#{param_metadata.fetch(:field_name, f.name)}}", _encode_path_param(val_to_string(param)))
      end
    end
  end

  server_url.delete_suffix("/") + path
end

.get_headers(headers_params, gbls = nil) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/cld_provisioning/utils/headers.rb', line 21

def self.get_headers(headers_params, gbls = nil)
  return {} if headers_params.nil?

  headers = {}
  T.unsafe(headers_params).fields.each do |f|
    metadata = f.metadata[:header]
    next if metadata.nil?

    value = _populate_from_globals(f.name, headers_params&.send(f.name), "header", gbls)
    value = _serialize_header(metadata.fetch(:explode, false), value)
    headers[metadata.fetch(:field_name, f.name)] = value if !T.must(value).empty?
  end

  headers
end

.get_query_params(clazz, query_params, url_override = nil, gbls = nil) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
90
91
92
 
# File 'lib/cld_provisioning/utils/query_params.rb', line 24

def self.get_query_params(clazz, query_params, url_override = nil, gbls = nil)
  parsed_params = T.let({}, T::Hash[T.any(String, Symbol), T::Array[String]])
  if !url_override.nil?
    parsed_url = URI.parse(url_override)
    URI.decode_www_form(parsed_url.query.to_s).each do |key, value|
      parsed_params[key] ||= []
      T.must(parsed_params[key]) << value
    end
  end

  params = T.let({}, T::Hash[T.any(String, Symbol), T::Array[String]])
  T.unsafe(clazz).fields.each do |f|
    request_metadata = f.metadata[:request]
    next if !request_metadata.nil?

    metadata = f.metadata[:query_param]
    next if metadata.nil?

    param_name = f.name
    value = query_params&.send(param_name.to_sym)
    value = _populate_from_globals(param_name, value, "queryParam", gbls)

    f_name = metadata[:field_name]
    serialization = metadata.fetch(:serialization, "")
    if serialization != ""
      params = params.merge(
        _get_serialized_params(
          metadata,
          f_name,
          value
        )
      )
    else
      style = metadata.fetch(:style, "form")
      case style
      when "deepObject"
        params = params.merge(
          _get_deep_object_query_params(
            metadata,
            f_name,
            value
          )
        )
      when "form"
        params = params.merge(
          _get_delimited_query_params(
            metadata,
            f_name,
            value,
            ","
          )
        )
      when "pipeDelimited"
        params = params.merge(
          _get_delimited_query_params(
            metadata,
            f_name,
            value,
            "|"
          )
        )
      else
        raise StandardError, "not yet implemented"
      end
    end
  end

  params.merge(parsed_params)
end

.match_content_type(content_type, pattern) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
 
# File 'lib/cld_provisioning/utils/utils.rb', line 83

def self.match_content_type(content_type, pattern)
  return true if content_type == pattern || ["*", "*/*"].include?(pattern)

  pieces = content_type.split(";")
  pieces.each do |piece|
    return true if pattern == piece.strip
  end

  false
end

.match_status_code(status_code, status_codes) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
 
# File 'lib/cld_provisioning/utils/utils.rb', line 95

def self.match_status_code(status_code, status_codes)
  return true if status_codes.include?("default")
  status_code = status_code.to_s
  status_codes.each do |code|
    return true if code == status_code
    return true if code.downcase.end_with?("xx") && status_code[0] == code[0]
  end

  false
end

.mime_type_for_filename(filename) ⇒ Object 



55
56
57
58
 
# File 'lib/cld_provisioning/utils/utils.rb', line 55

def self.mime_type_for_filename(filename)
  ext = File.extname(filename).downcase
  MIME_TYPES.fetch(ext, "application/octet-stream")
end

.open_enum_from_string(enum_type, optional) ⇒ Object 



140
141
142
143
144
145
146
 
# File 'lib/cld_provisioning/utils/utils.rb', line 140

def self.open_enum_from_string(enum_type, optional)
  Kernel.lambda do |s|
    return nil if optional && s.nil?

    return T.unsafe(enum_type).deserialize(s)
  end
end

.parse_field(field, data_class) ⇒ Object 



154
155
156
157
158
159
160
161
162
 
# File 'lib/cld_provisioning/utils/utils.rb', line 154

def self.parse_field(field, data_class)
  field_metadata = field.metadata[:metadata_string]
  return nil if field_metadata.nil?

  field_value = data_class.send(field.name)
  return nil if field_value.nil?

  field_value
end

.serialize_content_type(media_type, request) ⇒ Object

Raises:

  • (StandardError) 


68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/cld_provisioning/utils/request_bodies.rb', line 68

def self.serialize_content_type(media_type, request)
  if media_type.match("^(application|text)\\/([^+]+\\+)*json.*")
    return media_type, ::Crystalline.to_json(request), nil
  end

  return serialize_multipart_form(media_type, request) if media_type.match("^multipart\\/.*")
  return media_type, serialize_form_data(request), nil if media_type.match("^application\\/x-www-form-urlencoded.*")
  return media_type, request, nil if request.is_a?(String) || request.is_a?(Array)

  raise StandardError, "invalid request body type #{request.class} for mediaType #{media_type}"
end

.serialize_form_data(data) ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/cld_provisioning/utils/forms.rb', line 183

def self.serialize_form_data(data)
  get_form_field_name = lambda do |obj_field|
    obj_param_metadata = obj_field.metadata[:form]

    return T.let({}, T::Hash[T.any(String, Symbol), Object]) if obj_param_metadata.nil?

    return obj_param_metadata.fetch(:field_name, obj_field.name)
  end

  form = T.let({}, T::Hash[T.any(String, Symbol), Object])
  if data.respond_to?(:fields)
    T.unsafe(data).fields.each do |field|
      val = data.send(field.name)
      next if val.nil?

      metadata = field.metadata[:form]

      next if metadata.nil?

      field_name = metadata.fetch(:field_name, field.name)

      if metadata[:json]
        form[field_name] = ::Crystalline.to_json(val)
      else
        if metadata.fetch(:style, "form") == "form"
          form = form.merge(
            _populate_form(
              field_name,
              metadata.fetch(:explode, true),
              val,
              ",",
              &get_form_field_name
            )
          )
        else
          raise StandardError, "Invalid form style for field #{field.name}"
        end
      end
    end
  elsif data.is_a?(Hash)
    data.each do |key, value|
      form[key] = [val_to_string(value)]
    end
  else
    raise StandardError, "Invalid request body type #{data.class}"
  end

  form
end

.serialize_multipart_form(media_type, request) ⇒ Object 



90
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/cld_provisioning/utils/forms.rb', line 90

def self.serialize_multipart_form(media_type, request)
  form = []
  T.unsafe(request).fields.each do |field|
    val = request.send(field.name)
    next if val.nil?

    field_metadata = field.metadata[:multipart_form]
    next if field_metadata.nil?

    if field_metadata[:file] == true
      field_name = field_metadata[:field_name]

      # Handle arrays of files
      if val.is_a?(Array)
        val.each do |file_obj|
          file_name = T.let("", String)
          content = nil

          T.must(file_obj).fields.each do |file_field|
            file_metadata = file_field.metadata[:multipart_form]
            next if file_metadata.nil?

            if file_metadata[:content] == true
              content = T.let(file_obj.send(file_field.name), String)
            else
              file_name = T.let(file_obj.send(file_field.name), String)
            end
          end

          if T.unsafe(file_name) == "" || T.unsafe(content).nil?
            raise StandardError, "invalid multipart/form-data file"
          end

          form.append([field_name, [file_name, content]])
        end
      else
        # Handle single file
        file_name = T.let("", String)
        content = nil

        T.must(val).fields.each do |file_field|
          file_metadata = file_field.metadata[:multipart_form]
          next if file_metadata.nil?

          if file_metadata[:content] == true
            content = T.let(val.send(file_field.name), String)
          else
            file_name = T.let(val.send(file_field.name), String)
          end
        end

        if T.unsafe(file_name) == "" || T.unsafe(content).nil?
          raise StandardError, "invalid multipart/form-data file"
        end

        form.append([field_name, [file_name, content]])
      end
    elsif field_metadata[:json] == true
      to_append = [
        field_metadata.fetch(:field_name, field.name),
        [
          nil,
          ::Crystalline.to_json(val),
          "application/json"
        ]
      ]
      form.append(to_append)
    else
      field_name = field_metadata.fetch(
        :field_name,
        field.name
      )
      if val.is_a?(Array)
        val.each do |value|
          next if value.nil?

          form.append(
            [field_name, [nil, val_to_string(value)]]
          )
        end
      else
        form.append([field_name, [nil, val_to_string(val)]])
      end
    end
  end

  [media_type, nil, form]
end

.serialize_request_body(request, nullable, optional, request_field_name, serialization_method) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/cld_provisioning/utils/request_bodies.rb', line 34

def self.serialize_request_body(request, nullable, optional, request_field_name, serialization_method)
  return ["", nil, nil] if request.nil? && !nullable && optional

  if !request.respond_to?(:fields) || !request.respond_to?(request_field_name)
    return serialize_content_type(SERIALIZATION_METHOD_TO_CONTENT_TYPE[serialization_method], request)
  end

  request_metadata = T.let(nil, T.nilable(T::Array[T::Array[T.any(T::Array[T.nilable(String)], String)]]))
  T.unsafe(request).fields.each do |f|
    if f.name == request_field_name
      request_metadata = f.metadata[:request]
      break
    end
  end

  if request_metadata.nil?
    # Field name collision: model has a field matching request_field_name but without :request metadata.
    # Serialize the entire object as the request body.
    return serialize_content_type(SERIALIZATION_METHOD_TO_CONTENT_TYPE[serialization_method], request)
  end

  request_val = request.send(request_field_name)
  return ["", nil, nil] if request_val.nil?

  serialize_content_type(
    request_metadata.fetch(:media_type, "application/octet-stream"),
    request_val
  )
end

.template_url(url_with_params, params) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/cld_provisioning/utils/url.rb', line 110

def self.template_url(url_with_params, params)
  params.each do |key, value|
    if value.class.respond_to?(:enums)
      val_str = T.cast(value, T::Enum).serialize
    else
      val_str = value
    end

    url_with_params = url_with_params.gsub("{#{key}}", val_str)
  end

  url_with_params
end

.val_to_string(val) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
 
# File 'lib/cld_provisioning/utils/utils.rb', line 19

def self.val_to_string(val)
  if val.class.respond_to?(:enums)
    T.unsafe(val).serialize.to_s
  elsif val.is_a?(DateTime)
    val.strftime("%Y-%m-%dT%H:%M:%S.%NZ").sub(/(\.\d*[1-9])0+Z\z/, "\\1Z").sub(/\.0+Z\z/, "Z")
  else
    val.to_s

  end
end