moderation_api 2.41.0 → 3.0.0

data/lib/moderation_api/sdk_hooks/types.rb

@@ -0,0 +1,180 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require_relative "../sdkconfiguration"
+
+module ModerationApi
+  module SDKHooks
+    class HookContext
+      extend T::Sig
+
+      sig { returns(SDKConfiguration) }
+      attr_accessor :config
+
+      sig { returns(String) }
+      attr_accessor :base_url
+
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :oauth2_scopes
+
+      sig { returns(String) }
+      attr_accessor :operation_id
+
+      sig { returns(T.nilable(T.proc.returns(T.untyped))) }
+      attr_accessor :security_source
+
+      sig do
+        params(
+          config: SDKConfiguration,
+          base_url: String,
+          oauth2_scopes: T.nilable(T::Array[String]),
+          operation_id: String,
+          security_source: T.nilable(T.proc.returns(T.untyped))
+        )
+          .void
+      end
+      def initialize(config:, base_url:, oauth2_scopes:, operation_id:, security_source:)
+        @config = T.let(config, SDKConfiguration)
+        @base_url = T.let(base_url, String)
+        @oauth2_scopes = T.let(oauth2_scopes, T.nilable(T::Array[String]))
+        @operation_id = T.let(operation_id, String)
+        @security_source = T.let(security_source, T.nilable(T.proc.returns(T.untyped)))
+      end
+    end
+
+    class BeforeRequestHookContext < HookContext
+      extend T::Sig
+
+      sig do
+        params(
+          hook_ctx: HookContext
+        )
+          .void
+      end
+      def initialize(hook_ctx:)
+        super(
+          config: hook_ctx.config,
+          base_url: hook_ctx.base_url,
+          operation_id: hook_ctx.operation_id,
+          oauth2_scopes: hook_ctx.oauth2_scopes,
+          security_source: hook_ctx.security_source
+        )
+      end
+    end
+
+    class AfterSuccessHookContext < HookContext
+      extend T::Sig
+
+      sig do
+        params(
+          hook_ctx: HookContext
+        )
+          .void
+      end
+      def initialize(hook_ctx:)
+        super(
+          config: hook_ctx.config,
+          base_url: hook_ctx.base_url,
+          operation_id: hook_ctx.operation_id,
+          oauth2_scopes: hook_ctx.oauth2_scopes,
+          security_source: hook_ctx.security_source
+        )
+      end
+    end
+
+    class AfterErrorHookContext < HookContext
+      extend T::Sig
+
+      sig do
+        params(
+          hook_ctx: HookContext
+        )
+          .void
+      end
+      def initialize(hook_ctx:)
+        super(
+          config: hook_ctx.config,
+          base_url: hook_ctx.base_url,
+          operation_id: hook_ctx.operation_id,
+          oauth2_scopes: hook_ctx.oauth2_scopes,
+          security_source: hook_ctx.security_source
+        )
+      end
+    end
+
+    module AbstractSDKInitHook
+      extend T::Sig
+      extend T::Helpers
+      abstract!
+
+      sig { overridable.params(config: SDKConfiguration).returns(SDKConfiguration) }
+      def sdk_init(config:)
+        Kernel.raise NotImplementedError.new
+      end
+    end
+
+    module AbstractBeforeRequestHook
+      extend T::Sig
+      extend T::Helpers
+      abstract!
+
+      sig do
+        overridable
+          .params(
+            hook_ctx: BeforeRequestHookContext,
+            request: Faraday::Request
+          )
+          .returns(Faraday::Request)
+      end
+      def before_request(hook_ctx:, request:)
+        Kernel.raise NotImplementedError.new
+      end
+    end
+
+    module AbstractAfterSuccessHook
+      extend T::Sig
+      extend T::Helpers
+      abstract!
+
+      sig do
+        overridable
+          .params(
+            hook_ctx: AfterSuccessHookContext,
+            response: Faraday::Response
+          )
+          .returns(Faraday::Response)
+      end
+      def after_success(hook_ctx:, response:)
+        Kernel.raise NotImplementedError.new
+      end
+    end
+
+    module AbstractAfterErrorHook
+      extend T::Sig
+      extend T::Helpers
+      abstract!
+
+      sig do
+        overridable
+          .params(
+            error: T.nilable(StandardError),
+            hook_ctx: AfterErrorHookContext,
+            response: T.nilable(Faraday::Response)
+          )
+          .returns(T.nilable(Faraday::Response))
+      end
+      def after_error(error:, hook_ctx:, response:)
+        Kernel.raise NotImplementedError.new
+      end
+    end
+
+    class AbstractSDKHook
+      include AbstractSDKInitHook
+      include AbstractBeforeRequestHook
+      include AbstractAfterSuccessHook
+      include AbstractAfterErrorHook
+    end
+  end
+end

data/lib/moderation_api/sdkconfiguration.rb

@@ -0,0 +1,108 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/multipart"
+require "faraday/retry"
+require "sorbet-runtime"
+
+require_relative "sdk_hooks/hooks"
+require_relative "utils/retries"
+
+module ModerationApi
+  extend T::Sig
+
+  SERVERS = T.let(
+    [
+      "https://moderationapi.com/api/v1"
+    ].freeze,
+    T::Array[String]
+  )
+  # Contains the list of servers available to the SDK
+
+  class SDKConfiguration
+    extend T::Sig
+
+    sig { returns(T.nilable(Faraday::Connection)) }
+    attr_accessor :client
+
+    sig { returns(::ModerationApi::SDKHooks::Hooks) }
+    attr_accessor :hooks
+
+    sig { returns(T.nilable(::ModerationApi::Utils::RetryConfig)) }
+    attr_accessor :retry_config
+
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    sig { returns(T.nilable(T.proc.returns(T.nilable(Models::Components::Security)))) }
+    attr_accessor :security_source
+
+    sig { returns(T.nilable(String)) }
+    attr_accessor :server_url
+
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :server_idx
+
+    sig { returns(String) }
+    attr_accessor :language
+
+    sig { returns(String) }
+    attr_accessor :openapi_doc_version
+
+    sig { returns(String) }
+    attr_accessor :sdk_version
+
+    sig { returns(String) }
+    attr_accessor :gen_version
+
+    sig { returns(String) }
+    attr_accessor :user_agent
+
+    sig do
+      params(
+        client: T.nilable(Faraday::Connection),
+        hooks: ::ModerationApi::SDKHooks::Hooks,
+        retry_config: T.nilable(::ModerationApi::Utils::RetryConfig),
+        timeout_ms: T.nilable(Integer),
+        secret_key: T.nilable(::String),
+        security_source: T.nilable(T.proc.returns(Models::Components::Security)),
+        server_url: T.nilable(String),
+        server_idx: T.nilable(Integer)
+      )
+        .void
+    end
+    def initialize(client, hooks, retry_config, timeout_ms, secret_key, security_source, server_url, server_idx)
+      @client = client
+      @hooks = hooks
+      @retry_config = retry_config
+      @server_url = server_url
+      @timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      @server_idx = server_idx.nil? ? 0 : server_idx
+      if @server_idx.negative? || @server_idx >= SERVERS.length
+        raise StandardError, "Invalid server index #{server_idx}"
+      end
+
+      if !security_source.nil?
+        @security_source = security_source
+      elsif !secret_key.nil?
+        @security_source = -> { Models::Components::Security.new(secret_key: secret_key) }
+      end
+
+      @language = "ruby"
+      @openapi_doc_version = "1.1.0"
+      @sdk_version = "3.0.0"
+      @gen_version = "internal"
+      @user_agent = "speakeasy-sdk/ruby 3.0.0 internal 1.1.0 moderation_api"
+    end
+
+    sig { returns([String, T::Hash[Symbol, String]]) }
+    def get_server_details
+      return [@server_url.delete_suffix("/"), {}] if !@server_url.nil?
+      @server_idx = T.must(@server_idx)
+      [T.must(SERVERS[@server_idx]), {}]
+    end
+  end
+end

data/lib/moderation_api/sdkconfiguration.rbi

@@ -0,0 +1,83 @@
+# typed: true
+
+class ModerationApi::SDKConfiguration
+  extend ::Crystalline::MetadataFields::ClassMethods
+
+  def client
+  end
+
+  def client=(client)
+  end
+
+  def gen_version
+  end
+
+  def gen_version=(gen_version)
+  end
+
+  def hooks
+  end
+
+  def hooks=(hooks)
+  end
+
+  def language
+  end
+
+  def language=(language)
+  end
+
+  def openapi_doc_version
+  end
+
+  def openapi_doc_version=(openapi_doc_version)
+  end
+
+  def retry_config
+  end
+
+  def retry_config=(retry_config)
+  end
+
+  def sdk_version
+  end
+
+  def sdk_version=(sdk_version)
+  end
+
+  def security_source
+  end
+
+  def security_source=(security_source)
+  end
+
+  def server_idx
+  end
+
+  def server_idx=(server_idx)
+  end
+
+  def server_params
+  end
+
+  def server_params=(server_params)
+  end
+
+  def server_url
+  end
+
+  def server_url=(server_url)
+  end
+
+  def timeout
+  end
+
+  def timeout=(timeout)
+  end
+
+  def user_agent
+  end
+
+  def user_agent=(user_agent)
+  end
+end

data/lib/moderation_api/utils/forms.rb

@@ -0,0 +1,232 @@
+# 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 ModerationApi
+  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
+
+              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
+
+    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/moderation_api/utils/headers.rb

@@ -0,0 +1,82 @@
+# 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 ModerationApi
+  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