pangea-sdk 0.0.0

data/rbi/lib/pangea/internal/type/array_of.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Pangea
+  module Internal
+    module Type
+      # @api private
+      #
+      # Array of items of a given type.
+      class ArrayOf
+        include Pangea::Internal::Type::Converter
+
+        abstract!
+
+        Elem = type_member(:out)
+
+        sig do
+          params(
+            type_info: T.any(
+              T::Hash[Symbol, T.anything],
+              T.proc.returns(Pangea::Internal::Type::Converter::Input),
+              Pangea::Internal::Type::Converter::Input
+            ),
+            spec: T::Hash[Symbol, T.anything]
+          )
+            .returns(T.attached_class)
+        end
+        def self.[](type_info, spec = {}); end
+
+        sig { params(other: T.anything).returns(T::Boolean) }
+        def ===(other); end
+
+        sig { params(other: T.anything).returns(T::Boolean) }
+        def ==(other); end
+
+        sig { returns(Integer) }
+        def hash; end
+
+        # @api private
+        sig { returns(Elem) }
+        protected def item_type; end
+
+        # @api private
+        sig { returns(T::Boolean) }
+        protected def nilable?; end
+
+        # @api private
+        sig do
+          params(
+            type_info: T.any(
+              T::Hash[Symbol, T.anything],
+              T.proc.returns(Pangea::Internal::Type::Converter::Input),
+              Pangea::Internal::Type::Converter::Input
+            ),
+            spec: T::Hash[Symbol, T.anything]
+          )
+            .void
+        end
+        def initialize(type_info, spec = {}); end
+
+        # @api private
+        sig { params(depth: Integer).returns(String) }
+        def inspect(depth: 0); end
+      end
+    end
+  end
+end

data/rbi/lib/pangea/internal/type/base_model.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Pangea
+  module Internal
+    module Type
+      class BaseModel
+        abstract!
+
+        KnownFieldShape = T.type_alias do
+          {mode: T.nilable(Symbol), required: T::Boolean, nilable: T::Boolean}
+        end
+
+        sig { params(keys: T.nilable(T::Array[Symbol])).returns(T::Hash[Symbol, T.anything]) }
+        def deconstruct_keys(keys); end
+
+        class << self
+          sig do
+            returns(
+              T::Hash[
+                Symbol,
+                T.all(
+                  Pangea::Internal::Type::BaseModel::KnownFieldShape,
+                  {type_fn: T.proc.returns(Pangea::Internal::Type::Converter::Input)}
+                )
+              ]
+            )
+          end
+          def known_fields; end
+        end
+      end
+    end
+  end
+end

data/rbi/lib/pangea/internal/type/boolean.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Pangea
+  module Internal
+    module Type
+      # @api private
+      class Boolean
+        extend Pangea::Internal::Type::Converter
+
+        abstract!
+
+        sig { params(other: T.anything).returns(T::Boolean) }
+        def self.===(other); end
+
+        sig { params(other: T.anything).returns(T::Boolean) }
+        def self.==(other); end
+
+        class << self
+          # @api private
+          sig do
+            override
+              .params(value: T.any(
+                T::Boolean,
+                T.anything
+              ),
+                      state: Pangea::Internal::Type::Converter::CoerceState)
+              .returns(T.any(T::Boolean, T.anything))
+          end
+          def coerce(value, state:); end
+
+          # @api private
+          sig do
+            override
+              .params(value: T.any(
+                T::Boolean,
+                T.anything
+              ),
+                      state: Pangea::Internal::Type::Converter::DumpState)
+              .returns(T.any(T::Boolean, T.anything))
+          end
+          def dump(value, state:); end
+        end
+      end
+    end
+  end
+end

data/rbi/lib/pangea/internal/type/converter.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Pangea
+  module Internal
+    module Type
+      module Converter
+        Input = T.type_alias { T.any(Pangea::Internal::Type::Converter, T::Class[T.anything]) }
+
+        CoerceState =
+          T.type_alias do
+            {
+              strictness: T.any(T::Boolean, Symbol),
+              exactness: {yes: Integer, no: Integer, maybe: Integer},
+              branched: Integer
+            }
+          end
+
+        DumpState = T.type_alias { {can_retry: T::Boolean} }
+
+        # @api private
+        sig do
+          overridable
+            .params(value: T.anything, state: Pangea::Internal::Type::Converter::CoerceState)
+            .returns(T.anything)
+        end
+        def coerce(value, state:); end
+
+        # @api private
+        sig do
+          overridable
+            .params(value: T.anything, state: Pangea::Internal::Type::Converter::DumpState)
+            .returns(T.anything)
+        end
+        def dump(value, state:); end
+      end
+    end
+  end
+end

data/rbi/lib/pangea/internal/type/request_parameters.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module Pangea
+  module Internal
+    module Type
+      # @api private
+      module RequestParameters
+        sig { returns(T.any(Pangea::RequestOptions, T::Hash[Symbol, T.anything])) }
+        attr_accessor :request_options
+
+        # @api private
+        module Converter
+          # @api private
+          sig { params(params: T.anything).returns([T.anything, T::Hash[Symbol, T.anything]]) }
+          def dump_request(params); end
+        end
+      end
+    end
+  end
+end

data/rbi/lib/pangea/internal/type/union.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module Pangea
+  module Internal
+    module Type
+      module Union
+        include Pangea::Internal::Type::Converter
+
+        # @api private
+        sig do
+          params(
+            key: T.any(Symbol, T::Hash[Symbol, T.anything], T.proc.returns(T.anything), T.anything),
+            spec: T.any(T::Hash[Symbol, T.anything], T.proc.returns(T.anything), T.anything)
+          )
+            .void
+        end
+        private def variant(key, spec = nil); end
+      end
+    end
+  end
+end

data/rbi/lib/pangea/internal/type/unknown.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module Pangea
+  module Internal
+    module Type
+      # @api private
+      class Unknown
+        extend Pangea::Internal::Type::Converter
+
+        abstract!
+
+        sig { params(other: T.anything).returns(T::Boolean) }
+        def self.===(other); end
+
+        sig { params(other: T.anything).returns(T::Boolean) }
+        def self.==(other); end
+      end
+    end
+  end
+end

data/rbi/lib/pangea/internal.rbi

@@ -0,0 +1,7 @@
+# typed: strong
+
+module Pangea
+  module Internal
+    OMIT = T.let(Object.new.freeze, T.anything)
+  end
+end

data/rbi/lib/pangea/models/ai_guard/text_guard_message_param.rbi

@@ -0,0 +1,15 @@
+# typed: strong
+
+module Pangea
+  module Models
+    module AiGuard
+      class TextGuardMessageParam < Pangea::Internal::Type::BaseModel
+        sig { returns(T.nilable(String)) }
+        attr_reader :role
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :content
+      end
+    end
+  end
+end

data/rbi/lib/pangea/models/ai_guard/text_guard_result.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Pangea
+  module Models
+    module AiGuard
+      class TextGuardResult < Pangea::Internal::Type::BaseModel
+        # Updated prompt text, if applicable.
+        sig { returns(T.nilable(String)) }
+        attr_reader :prompt_text
+      end
+    end
+  end
+end

data/rbi/lib/pangea/models/pangea_response.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Pangea
+  module Models
+    class PangeaResponse < Pangea::Internal::Type::BaseModel
+      Result = type_member(:out)
+
+      # @api private
+      sig { returns(Result) }
+      protected def item_type; end
+
+      # @api private
+      sig { returns(T::Boolean) }
+      protected def nilable?; end
+
+      # @api private
+      sig do
+        params(
+          type_info: T.any(
+            T::Hash[Symbol, T.anything],
+            T.proc.returns(Pangea::Internal::Type::Converter::Input),
+            Pangea::Internal::Type::Converter::Input
+          ),
+          spec: T::Hash[Symbol, T.anything]
+        )
+          .void
+      end
+      def initialize(type_info, spec = {}); end
+    end
+  end
+end

data/rbi/lib/pangea/request_options.rbi

@@ -0,0 +1,17 @@
+# typed: strong
+
+module Pangea
+  class RequestOptions < Pangea::Internal::Type::BaseModel
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig { params(values: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
+    def self.new(values = {}); end
+  end
+end

data/rbi/lib/pangea/services/ai_guard.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Pangea
+  module Services
+    class AiGuard
+      sig do
+        params(
+          text: T.nilable(String),
+          messages: T.nilable(T::Array[Pangea::Models::AiGuard::TextGuardMessageParam]),
+          recipe: T.nilable(String),
+          debug: T.nilable(T::Boolean),
+          request_options: T.nilable(T.any(Pangea::RequestOptions, T::Hash[Symbol, T.anything]))
+        )
+          .returns(Pangea::Models::PangeaResponse[Pangea::Models::AiGuard::TextGuardResult])
+      end
+      def guard_text(
+        text:,
+        messages:,
+        recipe:,
+        debug:,
+        request_options: {}
+      ); end
+      # @api private
+      sig { params(api_token: T.nilable(String), base_url: T.nilable(String), domain: T.nilable(String)).returns(T.attached_class) }
+      def self.new(api_token: nil, base_url: nil, domain: nil); end
+    end
+  end
+end

data/rbi/lib/pangea/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module Pangea
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/pangea/client.rbs

@@ -0,0 +1,12 @@
+module Pangea
+  class Client < Pangea::Internal::Transport::BaseClient
+    attr_reader api_token: String
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?api_token: String?,
+      ?base_url: String?
+    ) -> void
+  end
+end

data/sig/pangea/internal/transport/base_client.rbs

@@ -0,0 +1,14 @@
+module Pangea
+  module Internal
+    module Transport
+      class BaseClient
+        def initialize: (
+            base_url: String,
+            ?headers: ::Hash[String, (String
+            | Integer
+            | ::Array[(String | Integer)?])?],
+          ) -> void
+      end
+    end
+  end
+end

data/sig/pangea/internal/type/base_model.rbs

@@ -0,0 +1,12 @@
+module Pangea
+  module Internal
+    module Type
+      class BaseModel
+        extend Pangea::Internal::Type::Converter
+
+        type known_field =
+          { mode: (:coerce | :dump)?, required: bool, nilable: bool }
+      end
+    end
+  end
+end

data/sig/pangea/internal/type/boolean.rbs

@@ -0,0 +1,10 @@
+module Pangea
+  module Internal
+    module Type
+      # @api private
+      class Boolean
+        extend Pangea::Internal::Type::Converter
+      end
+    end
+  end
+end

data/sig/pangea/internal/type/converter.rbs

@@ -0,0 +1,9 @@
+module Pangea
+  module Internal
+    module Type
+      module Converter
+        type input = Pangea::Internal::Type::Converter | Class
+      end
+    end
+  end
+end

data/sig/pangea/internal/type/request_parameters.rbs

@@ -0,0 +1,15 @@
+module Pangea
+  module Internal
+    module Type
+      type request_parameters = { request_options: Pangea::request_opts }
+
+      module RequestParameters
+        attr_accessor request_options: Pangea::request_opts
+
+        module Converter
+          def dump_request: (top params) -> [top, ::Hash[Symbol, top]]
+        end
+      end
+    end
+  end
+end

data/sig/pangea/models/pangea_response.rbs

@@ -0,0 +1,12 @@
+module Pangea
+  module Models
+    class PangeaResponse[Result]
+      attr_accessor request_id: String
+      attr_accessor request_time: String
+      attr_accessor response_time: String
+      attr_accessor status: String
+      attr_accessor summary: String
+      attr_accessor result: Result
+    end
+  end
+end

data/sig/pangea/models/text_guard_result.rbs

@@ -0,0 +1,19 @@
+module Pangea
+  module Models
+    module AiGuard
+      type text_guard_result = {
+        prompt_text: String?,
+        blocked: Pangea::Internal::Type::Boolean?,
+        recipe: String?,
+        fpe_context: String?,
+      }
+
+      class TextGuardResult < Pangea::Internal::Type::BaseModel
+        attr_accessor prompt_text: String?
+        attr_accessor blocked: Pangea::Internal::Type::Boolean?
+        attr_accessor recipe: String?
+        attr_accessor fpe_context: String?
+      end
+    end
+  end
+end

data/sig/pangea/request_options.rbs

@@ -0,0 +1,34 @@
+module Pangea
+  type request_opts =
+    Pangea::RequestOptions | Pangea::request_options | ::Hash[Symbol, top]
+
+  type request_options =
+    {
+      idempotency_key: String?,
+      extra_query: ::Hash[String, (::Array[String] | String)?]?,
+      extra_headers: ::Hash[String, String?]?,
+      extra_body: top?,
+      max_retries: Integer?,
+      timeout: Float?
+    }
+
+  class RequestOptions < Pangea::Internal::Type::BaseModel
+    def self.validate!: (self | ::Hash[Symbol, top] opts) -> void
+
+    attr_accessor idempotency_key: String?
+
+    attr_accessor extra_query: ::Hash[String, (::Array[String] | String)?]?
+
+    attr_accessor extra_headers: ::Hash[String, String?]?
+
+    attr_accessor extra_body: top?
+
+    attr_accessor max_retries: Integer?
+
+    attr_accessor timeout: Float?
+
+    def initialize: (
+      ?Pangea::request_options | ::Hash[Symbol, top] values
+    ) -> void
+  end
+end

data/sig/pangea/services/ai_guard.rbs

@@ -0,0 +1,12 @@
+module Pangea
+  module Services
+    module AiGuard
+      def initialize: (?api_token: String, ?base_url: String, ?domain: String) -> void
+
+      def guard_text: (
+        ?text: String,
+        ?request_options: Pangea::request_opts
+      ) -> Pangea::Models::PangeaResponse[Pangea::Models::AiGuard::TextGuardResult]
+    end
+  end
+end

data/sig/pangea/version.rbs

@@ -0,0 +1,3 @@
+module Pangea
+  VERSION: String
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: pangea-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Pangea
+autorequire:
+bindir: bin
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.3
+description:
+email: support@pangea.cloud
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".ignore"
+- README.md
+- lib/pangea.rb
+- lib/pangea/client.rb
+- lib/pangea/errors.rb
+- lib/pangea/internal.rb
+- lib/pangea/internal/transport/base_client.rb
+- lib/pangea/internal/transport/pooled_net_requester.rb
+- lib/pangea/internal/type/array_of.rb
+- lib/pangea/internal/type/base_model.rb
+- lib/pangea/internal/type/boolean.rb
+- lib/pangea/internal/type/converter.rb
+- lib/pangea/internal/type/hash_of.rb
+- lib/pangea/internal/type/request_parameters.rb
+- lib/pangea/internal/type/union.rb
+- lib/pangea/internal/type/unknown.rb
+- lib/pangea/internal/util.rb
+- lib/pangea/models/ai_guard/classification_result.rb
+- lib/pangea/models/ai_guard/hardening_result.rb
+- lib/pangea/models/ai_guard/language_result.rb
+- lib/pangea/models/ai_guard/malicious_entity_result.rb
+- lib/pangea/models/ai_guard/prompt_injection_result.rb
+- lib/pangea/models/ai_guard/redact_entity_result.rb
+- lib/pangea/models/ai_guard/single_entity_result.rb
+- lib/pangea/models/ai_guard/text_guard_message_param.rb
+- lib/pangea/models/ai_guard/text_guard_params.rb
+- lib/pangea/models/ai_guard/text_guard_result.rb
+- lib/pangea/models/ai_guard/topic_result.rb
+- lib/pangea/models/pangea_response.rb
+- lib/pangea/request_options.rb
+- lib/pangea/services/ai_guard.rb
+- lib/pangea/version.rb
+- manifest.yaml
+- rbi/lib/pangea/client.rbi
+- rbi/lib/pangea/internal.rbi
+- rbi/lib/pangea/internal/internal.rbi
+- rbi/lib/pangea/internal/transport/base_client.rbi
+- rbi/lib/pangea/internal/type/array_of.rbi
+- rbi/lib/pangea/internal/type/base_model.rbi
+- rbi/lib/pangea/internal/type/boolean.rbi
+- rbi/lib/pangea/internal/type/converter.rbi
+- rbi/lib/pangea/internal/type/request_parameters.rbi
+- rbi/lib/pangea/internal/type/union.rbi
+- rbi/lib/pangea/internal/type/unknown.rbi
+- rbi/lib/pangea/models/ai_guard/text_guard_message_param.rbi
+- rbi/lib/pangea/models/ai_guard/text_guard_result.rbi
+- rbi/lib/pangea/models/pangea_response.rbi
+- rbi/lib/pangea/request_options.rbi
+- rbi/lib/pangea/services/ai_guard.rbi
+- rbi/lib/pangea/version.rbi
+- sig/pangea/client.rbs
+- sig/pangea/internal/transport/base_client.rbs
+- sig/pangea/internal/type/base_model.rbs
+- sig/pangea/internal/type/boolean.rbs
+- sig/pangea/internal/type/converter.rbs
+- sig/pangea/internal/type/request_parameters.rbs
+- sig/pangea/models/pangea_response.rbs
+- sig/pangea/models/text_guard_result.rbs
+- sig/pangea/request_options.rbs
+- sig/pangea/services/ai_guard.rbs
+- sig/pangea/version.rbs
+homepage: https://gemdocs.org/gems/pangea-sdk
+licenses: []
+metadata:
+  homepage_uri: https://gemdocs.org/gems/pangea-sdk
+  source_code_uri: https://github.com/pangeacyber/pangea-ruby
+  rubygems_mfa_required: 'false'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Ruby library to access the Pangea API
+test_files: []