dub 0.9.0 → 0.10.0

data/lib/open_api_sdk/utils/forms.rb

@@ -0,0 +1,206 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'cgi'
+require 'date'
+require 'base64'
+require 'sorbet-runtime'
+
+module OpenApiSDK
+  module Utils
+    extend T::Sig
+
+    sig do
+      params(field_name: String, explode: T::Boolean, obj: Object, delimiter: String,
+             get_field_name_lambda: T.proc.params(obj_field: ::Crystalline::MetadataFields::Field).returns(String))
+        .returns(T::Hash[String, T::Array[String]])
+    end
+    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
+
+    sig { params(media_type: String, request: Object).returns([String, Object, T::Array[T::Array[T.any(T::Array[T.nilable(String)], String)]]]) }
+    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
+              raise StandardError, 'invalid multipart/form-data file' if T.unsafe(file_name) == '' || T.unsafe(content).nil?
+
+              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
+            raise StandardError, 'invalid multipart/form-data file' if T.unsafe(file_name) == '' || T.unsafe(content).nil?
+
+            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
+
+
+    sig do
+      params(data: T.any(Object, T::Hash[String, String]))
+        .returns(T::Hash[T.any(String, Symbol), Object])
+    end
+    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
+  end
+end

data/lib/open_api_sdk/utils/headers.rb

@@ -0,0 +1,77 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'cgi'
+require 'date'
+require 'base64'
+require 'sorbet-runtime'
+
+module OpenApiSDK
+  module Utils
+    extend T::Sig
+
+    sig { params(headers_params: Object, gbls: T.nilable(T::Hash[Symbol, T::Hash[Symbol, T::Hash[Symbol, Object]]])).returns(T::Hash[Symbol, String]) }
+    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
+
+    sig { params(explode: T::Boolean, obj: Object).returns(T.nilable(String)) }
+    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
+  end
+end

data/lib/open_api_sdk/utils/query_params.rb

@@ -0,0 +1,131 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'cgi'
+require 'date'
+require 'base64'
+require 'sorbet-runtime'
+
+module OpenApiSDK
+  module Utils
+    extend T::Sig
+
+    sig { params(clazz: Object, query_params: Object, url_override: T.nilable(::String), gbls: T.nilable(T::Hash[Symbol, T::Hash[Symbol, T::Hash[Symbol, Object]]])).returns(T::Hash[T.any(String, Symbol), T::Array[String]]) }
+    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
+        parsed_params = CGI.parse parsed_url.query
+      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
+
+    sig do
+      params(metadata: T::Hash[Symbol, String], field_name: String, obj: Object)
+        .returns(T::Hash[T.any(String, Symbol), T::Array[String]])
+    end
+    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
+
+
+    sig do
+      params(metadata: T::Hash[Symbol, String], field_name: String, obj: Object, delimiter: String)
+        .returns(T::Hash[T.any(String, Symbol), T::Array[String]])
+    end
+    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
+  end
+end

data/lib/open_api_sdk/utils/request_bodies.rb

@@ -0,0 +1,61 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'cgi'
+require 'date'
+require 'base64'
+require 'sorbet-runtime'
+
+module OpenApiSDK
+  module Utils
+    extend T::Sig
+
+    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
+  
+    sig do
+      params(request: Object, nullable: T::Boolean, optional: T::Boolean, request_field_name: Symbol, serialization_method: Symbol)
+        .returns([String, Object, T.nilable(T::Array[T::Array[T.any(T::Array[T.nilable(String)], String)]])])
+    end
+    def self.serialize_request_body(request, nullable, optional, request_field_name, serialization_method)
+      return ['', nil, nil] if request.nil? && !nullable && optional
+
+      return serialize_content_type(SERIALIZATION_METHOD_TO_CONTENT_TYPE[serialization_method], request) if !request.respond_to?(:fields) || !request.respond_to?(request_field_name)
+
+      request_val = request.send(request_field_name)
+
+      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
+      raise StandardError, 'invalid request type' if request_metadata.nil?
+
+      serialize_content_type(
+        request_metadata.fetch(:media_type, 'application/octet-stream'), request_val
+      )
+    end
+
+    sig do
+      params(media_type: String, request: Object)
+        .returns([String, Object, T.nilable(T::Array[T::Array[T.any(T::Array[T.nilable(String)], String)]])])
+    end
+    def self.serialize_content_type(media_type, request)
+      return media_type, ::Crystalline.to_json(request), nil if media_type.match('(application|text)\/.*?\+*json.*')
+      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
+  end
+end

data/lib/open_api_sdk/utils/security.rb

@@ -0,0 +1,130 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'cgi'
+require 'date'
+require 'base64'
+require 'sorbet-runtime'
+
+module OpenApiSDK
+  module Utils
+    extend T::Sig
+
+    sig { params(req: Faraday::Request, security: Object).void }
+    def self.configure_request_security(req, security)
+      return if security.nil?
+      T.unsafe(security).fields.each do |sec_field|
+        value = security.send(sec_field.name)
+        next if value.nil?
+
+        metadata = sec_field.metadata[:security]
+        next if metadata.nil?
+
+        _parse_security_option(req, value) if metadata[:option]
+
+        if 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
+        end
+      end
+    end
+
+    sig { params(req: Faraday::Request, option: Object).void }
+    def self._parse_security_option(req, option)
+      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
+
+    sig { params(req: Faraday::Request, scheme_metadata: T::Hash[Symbol, String], scheme: Object).void }
+    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
+
+    sig do
+      params(req: Faraday::Request, scheme_metadata: T::Hash[Symbol, String],
+             security_metadata: T::Hash[Symbol, String], value: String).void
+    end
+    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
+
+    sig { params(req: Faraday::Request, scheme: Object).void }
+    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
+  end
+end