volcano-sdk 0.32.6 → 0.33.0

data/lib/volcano/sandboxes.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Volcano
+  # Create isolated sessions or execute a command to completion.
+  class Sandboxes
+    def initialize(client, transport)
+      @requests = SandboxRequests.new(client, transport)
+    end
+
+    def presets
+      response = @requests.call(SandboxRequest.new(operation: :list_sandbox_presets))
+      SandboxResponse.array(Transport.json_object(response)['data']).map { |value| SandboxResponse.preset(value) }
+    end
+
+    def inspect = '#<Volcano::Sandboxes>'
+
+    def create( # rubocop:disable Metrics/ParameterLists -- Preserve explicit typed facade keywords.
+      project_id, region:, preset: nil, sandbox_id: nil, memory_mb: nil,
+      max_duration_seconds: nil, idle_timeout_seconds: nil, request_id: nil
+    )
+      options = { region: region, preset: preset, sandbox_id: sandbox_id, memory_mb: memory_mb,
+                  max_duration_seconds: max_duration_seconds, idle_timeout_seconds: idle_timeout_seconds,
+                  request_id: request_id }.compact
+      body = SandboxRequests.selector(options).merge(options.slice(:max_duration_seconds, :idle_timeout_seconds))
+      request = SandboxRequest.new(operation: :create_sandbox_session,
+                                   resource_id: SandboxRequests.identifier(project_id), body: body,
+                                   request_id: SandboxRequests.request_id(options))
+      requests = @requests.service_scope
+      SandboxSession.new(requests, requests.call(request, status: 201))
+    end
+
+    def get(session_id)
+      request = SandboxRequest.new(operation: :get_sandbox_session, resource_id: SandboxRequests.identifier(session_id))
+      SandboxSession.new(@requests, @requests.call(request))
+    end
+
+    def exec( # rubocop:disable Metrics/ParameterLists -- Preserve explicit typed facade keywords.
+      project_id, command, region:, preset: nil, sandbox_id: nil, memory_mb: nil,
+      timeout_seconds: 60, environment: nil, request_id: nil
+    )
+      options = { region: region, preset: preset, sandbox_id: sandbox_id, memory_mb: memory_mb,
+                  timeout_seconds: timeout_seconds, environment: environment, request_id: request_id }.compact
+      body = SandboxRequests.selector(options).merge(SandboxRequests.command(command, options))
+      request = SandboxRequest.new(operation: :execute_sandbox, resource_id: SandboxRequests.identifier(project_id),
+                                   body: body, request_id: SandboxRequests.request_id(options),
+                                   timeout: SandboxResponse.integer(options.fetch(:timeout_seconds, 60)) + 120)
+      SandboxResponse.execution(@requests.call(request))
+    end
+
+    def grant(session_id, auth_user_id, expires_at:)
+      request = SandboxRequest.new(operation: :grant_sandbox_session,
+                                   resource_id: SandboxRequests.identifier(session_id),
+                                   subject_id: SandboxRequests.identifier(auth_user_id),
+                                   body: { expires_at: SandboxRequests.expiry(expires_at) })
+      @requests.call(request, status: 204)
+      nil
+    end
+
+    def revoke(session_id, auth_user_id)
+      request = SandboxRequest.new(operation: :revoke_sandbox_session,
+                                   resource_id: SandboxRequests.identifier(session_id),
+                                   subject_id: SandboxRequests.identifier(auth_user_id))
+      @requests.call(request, status: 204)
+      nil
+    end
+  end
+end

data/lib/volcano/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Volcano
-  VERSION = '0.32.6'
+  VERSION = '0.33.0'
 end

data/lib/volcano.rb

@@ -64,10 +64,17 @@ require_relative 'volcano/lock_response'
 require_relative 'volcano/locks'
 require_relative 'volcano/realtime/protocol'
 require_relative 'volcano/realtime'
+require_relative 'volcano/sandbox_models'
+require_relative 'volcano/sandbox_request'
+require_relative 'volcano/sandbox_response'
+require_relative 'volcano/sandbox_files'
+require_relative 'volcano/sandbox_session'
+require_relative 'volcano/sandboxes'
 require_relative 'volcano/client'
 
 # Public namespace for the Volcano Ruby SDK.
 module Volcano
+  private_constant :SandboxRequest, :SandboxRequests, :SandboxResponse
   private_constant :AuthRefresh, :AuthSignOut, :AuthProfile, :AuthProfileFields, :AuthUpdateUser, :AuthEmailChange,
                    :AuthSessions, :AuthSessionConstruction,
                    :GeneratedTransport, :LockAutoRenewal, :LockLeaseClock, :LockRenewer,

data/sig/client.rbs

@@ -1,5 +1,6 @@
 module Volcano
   class Client
+    attr_reader sandboxes: Sandboxes
     attr_reader auth: Auth
     attr_reader functions: Functions
     attr_reader durable: Durable

data/sig/sandboxes.rbs

@@ -0,0 +1,83 @@
+module Volcano
+  type sandbox_selector = { region: String, ?preset: String, ?sandbox_id: String, ?memory_mb: Integer }
+  type sandbox_create_options = { region: String, ?preset: String, ?sandbox_id: String, ?memory_mb: Integer, ?max_duration_seconds: Integer, ?idle_timeout_seconds: Integer, ?request_id: String }
+  type sandbox_exec_options = { region: String, ?preset: String, ?sandbox_id: String, ?memory_mb: Integer, ?timeout_seconds: Integer, ?environment: Hash[String, String], ?request_id: String }
+  type sandbox_command_options = { ?timeout_seconds: Integer, ?environment: Hash[String, String], ?request_id: String }
+
+  class SandboxCommandResult < Data
+    attr_reader stdout: String
+    attr_reader stderr: String
+    attr_reader exit_code: Integer
+    attr_reader timed_out: bool
+    attr_reader stdout_truncated: bool
+    attr_reader stderr_truncated: bool
+    def self.new: (stdout: String, stderr: String, exit_code: Integer, timed_out: bool, stdout_truncated: bool, stderr_truncated: bool) -> SandboxCommandResult
+    def initialize: (stdout: String, stderr: String, exit_code: Integer, timed_out: bool, stdout_truncated: bool, stderr_truncated: bool) -> void
+    def to_h: () -> { stdout: String, stderr: String, exit_code: Integer, timed_out: bool, stdout_truncated: bool, stderr_truncated: bool }
+  end
+
+  class SandboxExecutionResult < Data
+    attr_reader stdout: String
+    attr_reader stderr: String
+    attr_reader exit_code: Integer
+    attr_reader timed_out: bool
+    attr_reader stdout_truncated: bool
+    attr_reader stderr_truncated: bool
+    attr_reader session_id: String
+    attr_reader region: String
+    attr_reader duration_ms: Integer
+    def self.new: (stdout: String, stderr: String, exit_code: Integer, timed_out: bool, stdout_truncated: bool, stderr_truncated: bool, session_id: String, region: String, duration_ms: Integer) -> SandboxExecutionResult
+    def initialize: (stdout: String, stderr: String, exit_code: Integer, timed_out: bool, stdout_truncated: bool, stderr_truncated: bool, session_id: String, region: String, duration_ms: Integer) -> void
+    def to_h: () -> { stdout: String, stderr: String, exit_code: Integer, timed_out: bool, stdout_truncated: bool, stderr_truncated: bool, session_id: String, region: String, duration_ms: Integer }
+  end
+
+  class SandboxPreset < Data
+    attr_reader id: String
+    attr_reader memory_mb: Integer
+    attr_reader regions: Array[String]
+    def self.new: (id: String, memory_mb: Integer, regions: Array[String]) -> SandboxPreset
+    def initialize: (id: String, memory_mb: Integer, regions: Array[String]) -> void
+    def to_h: () -> { id: String, memory_mb: Integer, regions: Array[String] }
+  end
+
+  class SandboxAccess
+    attr_reader url: String
+    attr_reader token: String
+    attr_reader expires_at: Time
+    def initialize: (url: String, token: String, expires_at: Time) -> void
+    def inspect: () -> String
+  end
+
+  class Sandboxes
+    def inspect: () -> String
+    def presets: () -> Array[SandboxPreset]
+    def create: (String project_id, region: String, ?preset: String?, ?sandbox_id: String?, ?memory_mb: Integer?, ?max_duration_seconds: Integer?, ?idle_timeout_seconds: Integer?, ?request_id: String?) -> SandboxSession
+    def get: (String session_id) -> SandboxSession
+    def exec: (String project_id, String command, region: String, ?preset: String?, ?sandbox_id: String?, ?memory_mb: Integer?, ?timeout_seconds: Integer, ?environment: Hash[String, String]?, ?request_id: String?) -> SandboxExecutionResult
+    def grant: (String session_id, String auth_user_id, expires_at: (Time | String)) -> nil
+    def revoke: (String session_id, String auth_user_id) -> nil
+  end
+
+  class SandboxSession
+    def inspect: () -> String
+    attr_reader id: String
+    attr_reader project_id: String
+    attr_reader region: String
+    attr_reader state: String
+    attr_reader expires_at: Time
+    attr_reader files: SandboxFiles
+    def refresh: () -> SandboxSession
+    def suspend: () -> SandboxSession
+    def resume: () -> SandboxSession
+    def terminate: () -> SandboxSession
+    def exec: (String command, ?timeout_seconds: Integer, ?environment: Hash[String, String]?, ?request_id: String?) -> SandboxCommandResult
+    def access: (Integer port) -> SandboxAccess
+    def use: [T] () { (SandboxSession) -> T } -> T
+  end
+
+  class SandboxFiles
+    def inspect: () -> String
+    def read: (String path) -> String
+    def write: (String path, String data) -> nil
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: volcano-sdk
 version: !ruby/object:Gem::Version
-  version: 0.32.6
+  version: 0.33.0
 platform: ruby
 authors:
 - Kong
@@ -65,6 +65,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: io-event
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +198,7 @@ files:
 - lib/volcano/generated/lib/volcano-generated/api/project_imports_api.rb
 - lib/volcano/generated/lib/volcano-generated/api/projects_api.rb
 - lib/volcano/generated/lib/volcano-generated/api/realtime_api.rb
+- lib/volcano/generated/lib/volcano-generated/api/sandboxes_api.rb
 - lib/volcano/generated/lib/volcano-generated/api/service_keys_api.rb
 - lib/volcano/generated/lib/volcano-generated/api/storage_admin_api.rb
 - lib/volcano/generated/lib/volcano-generated/api/storage_buckets_api.rb
@@ -271,6 +286,8 @@ files:
 - lib/volcano/generated/lib/volcano-generated/models/create_function_scheduler_request.rb
 - lib/volcano/generated/lib/volcano-generated/models/create_o_auth_config_request.rb
 - lib/volcano/generated/lib/volcano-generated/models/create_project_request.rb
+- lib/volcano/generated/lib/volcano-generated/models/create_sandbox_session_request.rb
+- lib/volcano/generated/lib/volcano-generated/models/create_sandbox_template_request.rb
 - lib/volcano/generated/lib/volcano-generated/models/create_service_key_request.rb
 - lib/volcano/generated/lib/volcano-generated/models/create_storage_bucket_request.rb
 - lib/volcano/generated/lib/volcano-generated/models/create_storage_policy_request.rb
@@ -501,6 +518,7 @@ files:
 - lib/volcano/generated/lib/volcano-generated/models/project_source_export_skip.rb
 - lib/volcano/generated/lib/volcano-generated/models/project_source_export_state.rb
 - lib/volcano/generated/lib/volcano-generated/models/project_usage_response.rb
+- lib/volcano/generated/lib/volcano-generated/models/publish_sandbox_preset_request.rb
 - lib/volcano/generated/lib/volcano-generated/models/realtime_config.rb
 - lib/volcano/generated/lib/volcano-generated/models/realtime_plan_limits.rb
 - lib/volcano/generated/lib/volcano-generated/models/realtime_stats.rb
@@ -509,6 +527,27 @@ files:
 - lib/volcano/generated/lib/volcano-generated/models/reset_database_password200_response.rb
 - lib/volcano/generated/lib/volcano-generated/models/resolve_function_response.rb
 - lib/volcano/generated/lib/volcano-generated/models/resource_reference.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_access.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_access_request.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_capacity.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_capacity_list.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_command_request.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_command_result.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_deployment.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_deployment_page.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_execution_request.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_execution_result.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_file_read_request.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_file_result.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_file_write_request.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_pagination.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_preset.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_preset_list.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_session.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_session_page.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_subject_grant_request.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_template.rb
+- lib/volcano/generated/lib/volcano-generated/models/sandbox_template_page.rb
 - lib/volcano/generated/lib/volcano-generated/models/schedule_request.rb
 - lib/volcano/generated/lib/volcano-generated/models/service_key.rb
 - lib/volcano/generated/lib/volcano-generated/models/set_project_git_production_branch_request.rb
@@ -537,6 +576,7 @@ files:
 - lib/volcano/generated/lib/volcano-generated/models/update_project_git_deploy_settings_request.rb
 - lib/volcano/generated/lib/volcano-generated/models/update_project_request.rb
 - lib/volcano/generated/lib/volcano-generated/models/update_realtime_config_request.rb
+- lib/volcano/generated/lib/volcano-generated/models/update_sandbox_template_request.rb
 - lib/volcano/generated/lib/volcano-generated/models/update_storage_bucket_request.rb
 - lib/volcano/generated/lib/volcano-generated/models/update_variable_request.rb
 - lib/volcano/generated/lib/volcano-generated/models/upload_session_part.rb
@@ -555,6 +595,7 @@ files:
 - lib/volcano/generated_transport_functions.rb
 - lib/volcano/generated_transport_logs.rb
 - lib/volcano/generated_transport_oauth.rb
+- lib/volcano/generated_transport_sandbox.rb
 - lib/volcano/generated_transport_sessions.rb
 - lib/volcano/generated_transport_storage.rb
 - lib/volcano/generated_transport_support.rb
@@ -596,6 +637,12 @@ files:
 - lib/volcano/realtime/protocol_recovery_position.rb
 - lib/volcano/realtime/reconnect.rb
 - lib/volcano/redaction.rb
+- lib/volcano/sandbox_files.rb
+- lib/volcano/sandbox_models.rb
+- lib/volcano/sandbox_request.rb
+- lib/volcano/sandbox_response.rb
+- lib/volcano/sandbox_session.rb
+- lib/volcano/sandboxes.rb
 - lib/volcano/session.rb
 - lib/volcano/session_credentials.rb
 - lib/volcano/session_operations.rb
@@ -637,6 +684,7 @@ files:
 - sig/realtime.rbs
 - sig/realtime_contexts.rbs
 - sig/realtime_postgres_change.rbs
+- sig/sandboxes.rbs
 - sig/session.rbs
 - sig/sign_up_result.rbs
 - sig/storage.rbs
@@ -657,7 +705,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="