livekit-server-sdk 0.8.3 → 1.0.0

data/lib/livekit/proto/livekit_webhook_pb.rb

@@ -9,7 +9,7 @@ require 'livekit_egress_pb'
 require 'livekit_ingress_pb'
 
 
-descriptor_data = "\n\x15livekit_webhook.proto\x12\x07livekit\x1a\x14livekit_models.proto\x1a\x14livekit_egress.proto\x1a\x15livekit_ingress.proto\"\x97\x02\n\x0cWebhookEvent\x12\r\n\x05\x65vent\x18\x01 \x01(\t\x12\x1b\n\x04room\x18\x02 \x01(\x0b\x32\r.livekit.Room\x12-\n\x0bparticipant\x18\x03 \x01(\x0b\x32\x18.livekit.ParticipantInfo\x12(\n\x0b\x65gress_info\x18\t \x01(\x0b\x32\x13.livekit.EgressInfo\x12*\n\x0cingress_info\x18\n \x01(\x0b\x32\x14.livekit.IngressInfo\x12!\n\x05track\x18\x08 \x01(\x0b\x32\x12.livekit.TrackInfo\x12\n\n\x02id\x18\x06 \x01(\t\x12\x12\n\ncreated_at\x18\x07 \x01(\x03\x12\x13\n\x0bnum_dropped\x18\x0b \x01(\x05\x42\x46Z#github.com/livekit/protocol/livekit\xaa\x02\rLiveKit.Proto\xea\x02\x0eLiveKit::Protob\x06proto3"
+descriptor_data = "\n\x15livekit_webhook.proto\x12\x07livekit\x1a\x14livekit_models.proto\x1a\x14livekit_egress.proto\x1a\x15livekit_ingress.proto\"\x9b\x02\n\x0cWebhookEvent\x12\r\n\x05\x65vent\x18\x01 \x01(\t\x12\x1b\n\x04room\x18\x02 \x01(\x0b\x32\r.livekit.Room\x12-\n\x0bparticipant\x18\x03 \x01(\x0b\x32\x18.livekit.ParticipantInfo\x12(\n\x0b\x65gress_info\x18\t \x01(\x0b\x32\x13.livekit.EgressInfo\x12*\n\x0cingress_info\x18\n \x01(\x0b\x32\x14.livekit.IngressInfo\x12!\n\x05track\x18\x08 \x01(\x0b\x32\x12.livekit.TrackInfo\x12\n\n\x02id\x18\x06 \x01(\t\x12\x12\n\ncreated_at\x18\x07 \x01(\x03\x12\x17\n\x0bnum_dropped\x18\x0b \x01(\x05\x42\x02\x18\x01\x42\x46Z#github.com/livekit/protocol/livekit\xaa\x02\rLiveKit.Proto\xea\x02\x0eLiveKit::Protob\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
 pool.add_serialized_file(descriptor_data)

data/lib/livekit/proto/livekit_webhook_twirp.rb

@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.14.1, DO NOT EDIT.
 require 'twirp'
 require_relative 'livekit_webhook_pb.rb'
 

data/lib/livekit/proto/logger/options_pb.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: logger/options.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/descriptor_pb'
+
+
+descriptor_data = "\n\x14logger/options.proto\x12\x06logger\x1a google/protobuf/descriptor.proto*W\n\x0bSensitivity\x12\x1b\n\x17SENSITIVITY_UNSPECIFIED\x10\x00\x12\x13\n\x0fSENSITIVITY_PII\x10\x01\x12\x16\n\x12SENSITIVITY_SECRET\x10\x02:5\n\rredact_format\x12\x1d.google.protobuf.FieldOptions\x18\x86\n \x01(\t:,\n\x04name\x12\x1d.google.protobuf.FieldOptions\x18\x87\n \x01(\t:H\n\x0bsensitivity\x12\x1d.google.protobuf.FieldOptions\x18\x88\n \x01(\x0e\x32\x13.logger.SensitivityBMZ*github.com/livekit/protocol/livekit/logger\xaa\x02\rLiveKit.Proto\xea\x02\x0eLiveKit::Protob\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module LiveKit
+  module Proto
+    Sensitivity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("logger.Sensitivity").enummodule
+  end
+end

data/lib/livekit/proto/logger/options_twirp.rb

@@ -0,0 +1,8 @@
+# Code generated by protoc-gen-twirp_ruby 1.14.1, DO NOT EDIT.
+require 'twirp'
+require_relative 'options_pb.rb'
+
+module LiveKit
+  module Proto
+  end
+end

data/lib/livekit/room_service_client.rb

@@ -4,6 +4,7 @@ require 'securerandom'
 require "livekit/proto/livekit_room_twirp"
 require "livekit/auth_mixin"
 require 'livekit/utils'
+require 'livekit/failover'
 
 
 module LiveKit
@@ -12,10 +13,11 @@ module LiveKit
     include AuthMixin
     attr_accessor :api_key, :api_secret
 
-    def initialize(base_url, api_key: nil, api_secret: nil)
-      super(File.join(Utils.to_http_url(base_url), "/twirp"))
+    def initialize(base_url, api_key: nil, api_secret: nil, token: nil, failover: true, connection: nil)
+      super(connection || LiveKit::Failover.connection(base_url, failover))
       @api_key = api_key
       @api_secret = api_secret
+      @token = token
     end
 
     def create_room(name,
@@ -28,7 +30,7 @@ module LiveKit
         sync_streams: nil,
         departure_timeout: nil
       )
-      self.rpc(
+      rpc!(
         :CreateRoom,
         Proto::CreateRoomRequest.new(
           name: name,
@@ -46,7 +48,7 @@ module LiveKit
     end
 
     def list_rooms(names: nil)
-      self.rpc(
+      rpc!(
         :ListRooms,
         Proto::ListRoomsRequest.new(names: names),
         headers:auth_header(video_grant: VideoGrant.new(roomList: true)),
@@ -54,7 +56,7 @@ module LiveKit
     end
 
     def delete_room(room:)
-      self.rpc(
+      rpc!(
         :DeleteRoom,
         Proto::DeleteRoomRequest.new(room: room),
         headers:auth_header(video_grant: VideoGrant.new(roomCreate: true)),
@@ -62,7 +64,7 @@ module LiveKit
     end
 
     def update_room_metadata(room:, metadata:)
-      self.rpc(
+      rpc!(
         :UpdateRoomMetadata,
         Proto::UpdateRoomMetadataRequest.new(room: room, metadata: metadata),
         headers:auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room)),
@@ -70,7 +72,7 @@ module LiveKit
     end
 
     def list_participants(room:)
-      self.rpc(
+      rpc!(
         :ListParticipants,
         Proto::ListParticipantsRequest.new(room: room),
         headers:auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room)),
@@ -78,7 +80,7 @@ module LiveKit
     end
 
     def get_participant(room:, identity:)
-      self.rpc(
+      rpc!(
         :GetParticipant,
         Proto::RoomParticipantIdentity.new(room: room, identity: identity),
         headers:auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room)),
@@ -86,15 +88,31 @@ module LiveKit
     end
 
     def remove_participant(room:, identity:)
-      self.rpc(
+      rpc!(
         :RemoveParticipant,
         Proto::RoomParticipantIdentity.new(room: room, identity: identity),
         headers:auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room)),
       )
     end
 
+    def forward_participant(room:, identity:, destination_room:)
+      rpc!(
+        :ForwardParticipant,
+        Proto::ForwardParticipantRequest.new(room: room, identity: identity, destination_room: destination_room),
+        headers:auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room, destinationRoom: destination_room)),
+      )
+    end
+
+    def move_participant(room:, identity:, destination_room:)
+      rpc!(
+        :MoveParticipant,
+        Proto::MoveParticipantRequest.new(room: room, identity: identity, destination_room: destination_room),
+        headers:auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room, destinationRoom: destination_room)),
+      )
+    end
+
     def mute_published_track(room:, identity:, track_sid:, muted:)
-      self.rpc(
+      rpc!(
         :MutePublishedTrack,
         Proto::MuteRoomTrackRequest.new(
           room: room,
@@ -131,7 +149,7 @@ module LiveKit
         end
         req.attributes = attr_map
       end
-      self.rpc(
+      rpc!(
         :UpdateParticipant,
         req,
         headers:auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room)),
@@ -139,7 +157,7 @@ module LiveKit
     end
 
     def update_subscriptions(room:, identity:, track_sids:, subscribe:)
-      self.rpc(
+      rpc!(
         :UpdateSubscriptions,
         Proto::UpdateSubscriptionsRequest.new(
           room: room,
@@ -155,7 +173,7 @@ module LiveKit
         destination_sids: [],
         destination_identities: []
       )
-      self.rpc(
+      rpc!(
         :SendData,
         Proto::SendDataRequest.new(
           room: room,

data/lib/livekit/sip_service_client.rb

@@ -1,6 +1,8 @@
 require "livekit/proto/livekit_sip_twirp"
 require "livekit/auth_mixin"
 require 'livekit/utils'
+require 'livekit/failover'
+require 'livekit/dial_timeout'
 
 module LiveKit
   class SIPServiceClient < Twirp::Client
@@ -8,10 +10,11 @@ module LiveKit
     include AuthMixin
     attr_accessor :api_key, :api_secret
 
-    def initialize(base_url, api_key: nil, api_secret: nil)
-      super(File.join(Utils.to_http_url(base_url), "/twirp"))
+    def initialize(base_url, api_key: nil, api_secret: nil, token: nil, failover: true, connection: nil)
+      super(connection || LiveKit::Failover.connection(base_url, failover))
       @api_key = api_key
       @api_secret = api_secret
+      @token = token
     end
 
     def create_sip_inbound_trunk(
@@ -52,7 +55,7 @@ module LiveKit
           krisp_enabled: krisp_enabled
         )
       )
-      self.rpc(
+      rpc!(
         :CreateSIPInboundTrunk,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -91,7 +94,7 @@ module LiveKit
           headers_to_attributes: headers_to_attributes
         )
       )
-      self.rpc(
+      rpc!(
         :CreateSIPOutboundTrunk,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -100,7 +103,7 @@ module LiveKit
 
     def list_sip_inbound_trunk
       request = Proto::ListSIPInboundTrunkRequest.new
-      self.rpc(
+      rpc!(
         :ListSIPInboundTrunk,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -109,7 +112,7 @@ module LiveKit
 
     def list_sip_outbound_trunk
       request = Proto::ListSIPOutboundTrunkRequest.new
-      self.rpc(
+      rpc!(
         :ListSIPOutboundTrunk,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -120,7 +123,7 @@ module LiveKit
       request = Proto::DeleteSIPTrunkRequest.new(
         sip_trunk_id: sip_trunk_id,
       )
-      self.rpc(
+      rpc!(
         :DeleteSIPTrunk,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -147,7 +150,7 @@ module LiveKit
         attributes: attributes,
         room_config: room_config,
       )
-      self.rpc(
+      rpc!(
         :CreateSIPDispatchRule,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -156,7 +159,7 @@ module LiveKit
 
     def list_sip_dispatch_rule
       request = Proto::ListSIPDispatchRuleRequest.new
-      self.rpc(
+      rpc!(
         :ListSIPDispatchRule,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -167,7 +170,7 @@ module LiveKit
       request = Proto::DeleteSIPDispatchRuleRequest.new(
         sip_dispatch_rule_id: sip_dispatch_rule_id,
       )
-      self.rpc(
+      rpc!(
         :DeleteSIPDispatchRule,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -178,8 +181,13 @@ module LiveKit
       sip_trunk_id,
       sip_call_to,
       room_name,
+      # Optional inline outbound trunk configuration (SIPOutboundConfig). Use
+      # instead of a stored sip_trunk_id to configure the trunk per call.
+      trunk: nil,
       # Optional SIP From number to use. If empty, trunk number is used.
       from_number: nil,
+      # Optional custom caller ID shown to the callee. Requires provider support.
+      display_name: nil,
       # Optional identity of the participant in LiveKit room
       participant_identity: nil,
       # Optional name of the participant in LiveKit room
@@ -198,12 +206,22 @@ module LiveKit
       # Optional, max call duration in seconds
       max_call_duration: nil,
       # Optional, enable Krisp for this call
-      krisp_enabled: false
+      krisp_enabled: false,
+      # Optional, wait for the call to be answered before returning
+      wait_until_answered: false,
+      # Optional, request timeout in seconds. Defaults to a longer value when
+      # wait_until_answered is set (dialing takes time).
+      timeout: nil
     )
+      # When waiting for an answer, pin the ring window explicitly so our request
+      # timeout doesn't depend on the server's default (which could change).
+      ringing_timeout = DialTimeout::DEFAULT_RINGING_TIMEOUT if wait_until_answered && ringing_timeout.nil?
       request = Proto::CreateSIPParticipantRequest.new(
         sip_trunk_id: sip_trunk_id,
+        trunk: trunk,
         sip_call_to: sip_call_to,
         sip_number: from_number,
+        display_name: display_name,
         room_name: room_name,
         participant_identity: participant_identity,
         participant_name: participant_name,
@@ -213,32 +231,140 @@ module LiveKit
         hide_phone_number: hide_phone_number,
         ringing_timeout: ringing_timeout,
         max_call_duration: max_call_duration,
-        krisp_enabled: krisp_enabled
-      )
-      self.rpc(
-        :CreateSIPParticipant,
-        request,
-        headers: auth_header(sip_grant: SIPGrant.new(call: true)),
+        krisp_enabled: krisp_enabled,
+        wait_until_answered: wait_until_answered
       )
+      headers = auth_header(sip_grant: SIPGrant.new(call: true))
+      # When waiting for an answer, dialing takes longer than a normal request
+      # and the request must outlast ringing; otherwise honor any user timeout.
+      effective_timeout = wait_until_answered ? DialTimeout.resolve(timeout, ringing_timeout) : timeout
+      headers[Failover::TIMEOUT_HEADER] = effective_timeout.to_s if effective_timeout
+      rpc!(:CreateSIPParticipant, request, headers: headers)
     end
 
     def transfer_sip_participant(
       room_name,
       participant_identity,
       transfer_to,
-      play_dialtone: nil
+      play_dialtone: nil,
+      # Optional, max time for the transfer destination to answer, in seconds.
+      ringing_timeout: nil,
+      # Optional, request timeout in seconds. Defaults to a longer value since
+      # transferring dials a phone.
+      timeout: nil
     )
 
+      # Transferring a call dials a phone and must outlast ringing. Pin the ring
+      # window explicitly so our request timeout doesn't depend on the server default.
+      ringing_timeout ||= DialTimeout::DEFAULT_RINGING_TIMEOUT
       request = Proto::TransferSIPParticipantRequest.new(
         room_name: room_name,
         participant_identity: participant_identity,
         transfer_to: transfer_to,
         play_dialtone: play_dialtone,
+        ringing_timeout: ringing_timeout,
+      )
+      headers = auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room_name), sip_grant: SIPGrant.new(call: true))
+      headers[Failover::TIMEOUT_HEADER] = DialTimeout.resolve(timeout, ringing_timeout).to_s
+      rpc!(:TransferSIPParticipant, request, headers: headers)
+    end
+
+    # Updates an existing SIP inbound trunk, replacing it entirely.
+    #
+    # @param sip_trunk_id [String] ID of the SIP inbound trunk to update
+    # @param trunk [Proto::SIPInboundTrunkInfo] the full trunk definition to replace it with
+    def update_sip_inbound_trunk(sip_trunk_id, trunk)
+      request = Proto::UpdateSIPInboundTrunkRequest.new(
+        sip_trunk_id: sip_trunk_id,
+        replace: trunk,
+      )
+      rpc!(
+        :UpdateSIPInboundTrunk,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    # Updates specific fields of an existing SIP inbound trunk. Only the fields
+    # set in +update+ are changed.
+    #
+    # @param sip_trunk_id [String] ID of the SIP inbound trunk to update
+    # @param update [Proto::SIPInboundTrunkUpdate] the fields to update
+    def update_sip_inbound_trunk_fields(sip_trunk_id, update)
+      request = Proto::UpdateSIPInboundTrunkRequest.new(
+        sip_trunk_id: sip_trunk_id,
+        update: update,
+      )
+      rpc!(
+        :UpdateSIPInboundTrunk,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    # Updates an existing SIP outbound trunk, replacing it entirely.
+    #
+    # @param sip_trunk_id [String] ID of the SIP outbound trunk to update
+    # @param trunk [Proto::SIPOutboundTrunkInfo] the full trunk definition to replace it with
+    def update_sip_outbound_trunk(sip_trunk_id, trunk)
+      request = Proto::UpdateSIPOutboundTrunkRequest.new(
+        sip_trunk_id: sip_trunk_id,
+        replace: trunk,
       )
-      self.rpc(
-        :TransferSIPParticipant,
+      rpc!(
+        :UpdateSIPOutboundTrunk,
         request,
-        headers: auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room_name), sip_grant: SIPGrant.new(call: true)),
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    # Updates specific fields of an existing SIP outbound trunk. Only the fields
+    # set in +update+ are changed.
+    #
+    # @param sip_trunk_id [String] ID of the SIP outbound trunk to update
+    # @param update [Proto::SIPOutboundTrunkUpdate] the fields to update
+    def update_sip_outbound_trunk_fields(sip_trunk_id, update)
+      request = Proto::UpdateSIPOutboundTrunkRequest.new(
+        sip_trunk_id: sip_trunk_id,
+        update: update,
+      )
+      rpc!(
+        :UpdateSIPOutboundTrunk,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    # Updates an existing SIP dispatch rule, replacing it entirely.
+    #
+    # @param sip_dispatch_rule_id [String] ID of the SIP dispatch rule to update
+    # @param rule [Proto::SIPDispatchRuleInfo] the full dispatch rule definition to replace it with
+    def update_sip_dispatch_rule(sip_dispatch_rule_id, rule)
+      request = Proto::UpdateSIPDispatchRuleRequest.new(
+        sip_dispatch_rule_id: sip_dispatch_rule_id,
+        replace: rule,
+      )
+      rpc!(
+        :UpdateSIPDispatchRule,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    # Updates specific fields of an existing SIP dispatch rule. Only the fields
+    # set in +update+ are changed.
+    #
+    # @param sip_dispatch_rule_id [String] ID of the SIP dispatch rule to update
+    # @param update [Proto::SIPDispatchRuleUpdate] the fields to update
+    def update_sip_dispatch_rule_fields(sip_dispatch_rule_id, update)
+      request = Proto::UpdateSIPDispatchRuleRequest.new(
+        sip_dispatch_rule_id: sip_dispatch_rule_id,
+        update: update,
+      )
+      rpc!(
+        :UpdateSIPDispatchRule,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
       )
     end
   end

data/lib/livekit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LiveKit
-  VERSION = "0.8.3"
+  VERSION = "1.0.0"
 end

data/lib/livekit.rb

@@ -3,6 +3,7 @@
 require "livekit/access_token"
 require "livekit/utils"
 require "livekit/grants"
+require "livekit/errors"
 require "livekit/token_verifier"
 require "livekit/version"
 
@@ -13,3 +14,5 @@ require "livekit/egress_service_client"
 require "livekit/ingress_service_client"
 require "livekit/sip_service_client"
 require "livekit/agent_dispatch_service_client"
+require "livekit/connector_service_client"
+require "livekit/livekit_api"

data/livekit_server_sdk.gemspec

@@ -11,11 +11,12 @@ Gem::Specification.new do |spec|
   spec.summary = "LiveKit Server SDK for Ruby"
   spec.homepage = "https://livekit.io"
   spec.license = "Apache-2.0"
-  spec.required_ruby_version = ">= 2.6.0"
+  # google-protobuf 4.x requires Ruby >= 3.1; Ruby 3.0 is EOL.
+  spec.required_ruby_version = ">= 3.1.0"
 
-  # spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/livekit/server-sdk-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/livekit/server-sdk-ruby/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -26,11 +27,10 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "google-protobuf", ">= 3.21.0", "< 4.0"
+  spec.add_dependency "faraday", ">= 2.0", "< 3.0"
+  spec.add_dependency "google-protobuf", "~> 4.30", ">= 4.30.2"
   spec.add_dependency "jwt", ">= 2.2.3", "< 3.0"
-  # workaround for twirp 1.10.0 missing it
-  spec.add_dependency 'rack', '>= 2.2.3'
-  spec.add_dependency "twirp", ">= 1.10.0", "< 2.0"
+  spec.add_dependency "twirp", "~> 1.13", ">= 1.13.1"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html