livekit-server-sdk 0.2.0

data/lib/livekit/proto/livekit_room_pb.rb

@@ -0,0 +1,105 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: livekit_room.proto
+
+require 'google/protobuf'
+
+require 'livekit_models_pb'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("livekit_room.proto", :syntax => :proto3) do
+    add_message "livekit.CreateRoomRequest" do
+      optional :name, :string, 1
+      optional :empty_timeout, :uint32, 2
+      optional :max_participants, :uint32, 3
+      optional :node_id, :string, 4
+      optional :metadata, :string, 5
+    end
+    add_message "livekit.ListRoomsRequest" do
+      repeated :names, :string, 1
+    end
+    add_message "livekit.ListRoomsResponse" do
+      repeated :rooms, :message, 1, "livekit.Room"
+    end
+    add_message "livekit.DeleteRoomRequest" do
+      optional :room, :string, 1
+    end
+    add_message "livekit.DeleteRoomResponse" do
+    end
+    add_message "livekit.ListParticipantsRequest" do
+      optional :room, :string, 1
+    end
+    add_message "livekit.ListParticipantsResponse" do
+      repeated :participants, :message, 1, "livekit.ParticipantInfo"
+    end
+    add_message "livekit.RoomParticipantIdentity" do
+      optional :room, :string, 1
+      optional :identity, :string, 2
+    end
+    add_message "livekit.RemoveParticipantResponse" do
+    end
+    add_message "livekit.MuteRoomTrackRequest" do
+      optional :room, :string, 1
+      optional :identity, :string, 2
+      optional :track_sid, :string, 3
+      optional :muted, :bool, 4
+    end
+    add_message "livekit.MuteRoomTrackResponse" do
+      optional :track, :message, 1, "livekit.TrackInfo"
+    end
+    add_message "livekit.ParticipantPermission" do
+      optional :can_subscribe, :bool, 1
+      optional :can_publish, :bool, 2
+      optional :can_publish_data, :bool, 3
+    end
+    add_message "livekit.UpdateParticipantRequest" do
+      optional :room, :string, 1
+      optional :identity, :string, 2
+      optional :metadata, :string, 3
+      optional :permission, :message, 4, "livekit.ParticipantPermission"
+    end
+    add_message "livekit.UpdateSubscriptionsRequest" do
+      optional :room, :string, 1
+      optional :identity, :string, 2
+      repeated :track_sids, :string, 3
+      optional :subscribe, :bool, 4
+      repeated :participant_tracks, :message, 5, "livekit.ParticipantTracks"
+    end
+    add_message "livekit.UpdateSubscriptionsResponse" do
+    end
+    add_message "livekit.SendDataRequest" do
+      optional :room, :string, 1
+      optional :data, :bytes, 2
+      optional :kind, :enum, 3, "livekit.DataPacket.Kind"
+      repeated :destination_sids, :string, 4
+    end
+    add_message "livekit.SendDataResponse" do
+    end
+    add_message "livekit.UpdateRoomMetadataRequest" do
+      optional :room, :string, 1
+      optional :metadata, :string, 2
+    end
+  end
+end
+
+module LiveKit
+  module Proto
+    CreateRoomRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.CreateRoomRequest").msgclass
+    ListRoomsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.ListRoomsRequest").msgclass
+    ListRoomsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.ListRoomsResponse").msgclass
+    DeleteRoomRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.DeleteRoomRequest").msgclass
+    DeleteRoomResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.DeleteRoomResponse").msgclass
+    ListParticipantsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.ListParticipantsRequest").msgclass
+    ListParticipantsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.ListParticipantsResponse").msgclass
+    RoomParticipantIdentity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.RoomParticipantIdentity").msgclass
+    RemoveParticipantResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.RemoveParticipantResponse").msgclass
+    MuteRoomTrackRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.MuteRoomTrackRequest").msgclass
+    MuteRoomTrackResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.MuteRoomTrackResponse").msgclass
+    ParticipantPermission = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.ParticipantPermission").msgclass
+    UpdateParticipantRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.UpdateParticipantRequest").msgclass
+    UpdateSubscriptionsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.UpdateSubscriptionsRequest").msgclass
+    UpdateSubscriptionsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.UpdateSubscriptionsResponse").msgclass
+    SendDataRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.SendDataRequest").msgclass
+    SendDataResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.SendDataResponse").msgclass
+    UpdateRoomMetadataRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.UpdateRoomMetadataRequest").msgclass
+  end
+end

data/lib/livekit/proto/livekit_room_twirp.rb

@@ -0,0 +1,27 @@
+# Code generated by protoc-gen-twirp_ruby 1.9.0, DO NOT EDIT.
+require 'twirp'
+require_relative 'livekit_room_pb.rb'
+
+module LiveKit
+  module Proto
+    class RoomServiceService < Twirp::Service
+      package 'livekit'
+      service 'RoomService'
+      rpc :CreateRoom, CreateRoomRequest, Room, :ruby_method => :create_room
+      rpc :ListRooms, ListRoomsRequest, ListRoomsResponse, :ruby_method => :list_rooms
+      rpc :DeleteRoom, DeleteRoomRequest, DeleteRoomResponse, :ruby_method => :delete_room
+      rpc :ListParticipants, ListParticipantsRequest, ListParticipantsResponse, :ruby_method => :list_participants
+      rpc :GetParticipant, RoomParticipantIdentity, ParticipantInfo, :ruby_method => :get_participant
+      rpc :RemoveParticipant, RoomParticipantIdentity, RemoveParticipantResponse, :ruby_method => :remove_participant
+      rpc :MutePublishedTrack, MuteRoomTrackRequest, MuteRoomTrackResponse, :ruby_method => :mute_published_track
+      rpc :UpdateParticipant, UpdateParticipantRequest, ParticipantInfo, :ruby_method => :update_participant
+      rpc :UpdateSubscriptions, UpdateSubscriptionsRequest, UpdateSubscriptionsResponse, :ruby_method => :update_subscriptions
+      rpc :SendData, SendDataRequest, SendDataResponse, :ruby_method => :send_data
+      rpc :UpdateRoomMetadata, UpdateRoomMetadataRequest, Room, :ruby_method => :update_room_metadata
+    end
+
+    class RoomServiceClient < Twirp::Client
+      client_for RoomServiceService
+    end
+  end
+end

data/lib/livekit/proto/livekit_webhook_pb.rb

@@ -0,0 +1,26 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: livekit_webhook.proto
+
+require 'google/protobuf'
+
+require 'livekit_models_pb'
+require 'livekit_recording_pb'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("livekit_webhook.proto", :syntax => :proto3) do
+    add_message "livekit.WebhookEvent" do
+      optional :event, :string, 1
+      optional :room, :message, 2, "livekit.Room"
+      optional :participant, :message, 3, "livekit.ParticipantInfo"
+      optional :recording_info, :message, 5, "livekit.RecordingInfo"
+      optional :id, :string, 6
+      optional :created_at, :int64, 7
+    end
+  end
+end
+
+module LiveKit
+  module Proto
+    WebhookEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.WebhookEvent").msgclass
+  end
+end

data/lib/livekit/proto/livekit_webhook_twirp.rb

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

data/lib/livekit/room_service_client.rb

@@ -0,0 +1,128 @@
+require "livekit/proto/livekit_room_twirp"
+require "livekit/auth_mixin"
+
+module LiveKit
+  class RoomServiceClient < Twirp::Client
+    client_for Proto::RoomServiceService
+    include AuthMixin
+    attr_accessor :api_key, :api_secret
+
+    def initialize(base_url, api_key: nil, api_secret: nil)
+      super(File.join(base_url, "/twirp"))
+      @api_key = api_key
+      @api_secret = api_secret
+    end
+
+    # creates a new room with name
+    def create_room(name, empty_timeout: nil, max_participants: nil)
+      self.rpc(
+        :CreateRoom,
+        Proto::ListRoomsRequest(name: name, empty_timeout: empty_timeout, max_participants: max_participants),
+        headers: auth_header(roomCreate: true),
+      )
+    end
+
+    # Lists rooms, when names is set, only list matching rooms
+    def list_rooms(names: nil)
+      self.rpc(
+        :ListRooms,
+        Proto::ListRoomsRequest.new(names: names),
+        headers: auth_header(roomList: true),
+      )
+    end
+
+    def delete_room(room:)
+      self.rpc(
+        :DeleteRoom,
+        Proto::DeleteRoomRequest.new(room: room),
+        headers: auth_header(roomCreate: true),
+      )
+    end
+
+    def update_room_metadata(room:, metadata:)
+      self.rpc(
+        :UpdateRoomMetadata,
+        Proto::UpdateRoomMetadataRequest.new(room: room, metadata: metadata),
+        headers: auth_header(roomAdmin: true, room: room),
+      )
+    end
+
+    def list_participants(room:)
+      self.rpc(
+        :ListParticipants,
+        Proto::ListParticipantsRequest.new(room: room),
+        headers: auth_header(roomAdmin: true, room: room),
+      )
+    end
+
+    def get_participant(room:, identity:)
+      self.rpc(
+        :GetParticipant,
+        Proto::RoomParticipantIdentity.new(room: room, identity: identity),
+        headers: auth_header(roomAdmin: true, room: room),
+      )
+    end
+
+    def remove_participant(room:, identity:)
+      self.rpc(
+        :RemoveParticipant,
+        Proto::RoomParticipantIdentity.new(room: room, identity: identity),
+        headers: auth_header(roomAdmin: true, room: room),
+      )
+    end
+
+    def mute_published_track(room:, identity:, track_sid:, muted:)
+      self.rpc(
+        :MutePublishedTrack,
+        Proto::MuteRoomTrackRequest.new(
+          room: room,
+          identity: identity,
+          track_sid: track_sid,
+          muted: muted,
+        ),
+        headers: auth_header(roomAdmin: true, room: room),
+      )
+    end
+
+    def update_participant(room:, identity:, metadata: nil, permission: nil)
+      req = Proto::UpdateParticipantRequest.new(room: room, identity: identity)
+      if metadata
+        req.metadata = metadata
+      end
+      if permission
+        req.permission = permission
+      end
+      self.rpc(
+        :UpdateParticipant,
+        req,
+        headers: auth_header(roomAdmin: true, room: room),
+      )
+    end
+
+    def update_subscriptions(room:, identity:, track_sids:, subscribe:)
+      self.rpc(
+        :UpdateSubscriptions,
+        Proto::UpdateSubscriptionsRequest.new(
+          room: room,
+          identity: identity,
+          track_sids: track_sids,
+          subscribe: subscribe,
+        ),
+        headers: auth_header(roomAdmin: true, room: room),
+      )
+    end
+
+    def send_data(room:, data:, kind:, destination_sids: [])
+      self.rpc(
+        :SendData,
+        Proto::SendDataRequest.new(
+          room: room,
+          data: data,
+          kind: kind,
+          destination_sids: destination_sids,
+        ),
+        headers: auth_header(roomAdmin: true, room: room),
+      )
+    end
+  end
+end

data/lib/livekit/token_verifier.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "jwt"
+
+module LiveKit
+  class TokenVerifier
+    def initialize(api_key: nil, api_secret: nil)
+      @api_key = api_key
+      @api_secret = api_secret
+    end
+
+    def verify(token)
+      decoded_token = JWT.decode(token, @api_secret, true, algorithm: AccessToken::SIGNING_ALGORITHM)
+      decoded = decoded_token.first
+      if decoded["iss"] != @api_key
+        raise "Invalid issuer"
+      end
+      ClaimGrant.from_hash(decoded)
+    end
+  end
+end

data/lib/livekit/utils.rb

@@ -0,0 +1,29 @@
+class ::Hash
+  # via https://stackoverflow.com/a/25835016/2257038
+  def stringify_keys
+    h = self.map do |k, v|
+      v_str = if v.instance_of? Hash
+          v.stringify_keys
+        else
+          v
+        end
+
+      [k.to_s, v_str]
+    end
+    Hash[h]
+  end
+
+  # via https://stackoverflow.com/a/25835016/2257038
+  def symbol_keys
+    h = self.map do |k, v|
+      v_sym = if v.instance_of? Hash
+          v.symbol_keys
+        else
+          v
+        end
+
+      [k.to_sym, v_sym]
+    end
+    Hash[h]
+  end
+end

data/lib/livekit/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LiveKit
+  VERSION = '0.2.0'
+end

data/lib/livekit.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "livekit/access_token"
+require "livekit/grants"
+require "livekit/token_verifier"
+require "livekit/utils"
+require "livekit/version"
+
+# required since generated protobufs does use `require` instead of `require_relative`
+FOLDER = Pathname.new(File.expand_path("lib/livekit/proto"))
+$LOAD_PATH.unshift(FOLDER.to_s)
+require "livekit/room_service_client"

data/livekit_server_sdk.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/livekit/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "livekit-server-sdk"
+  spec.version = LiveKit::VERSION
+  spec.authors = ["Omri Gabay", "David Zhao"]
+  spec.email = ["omri@omrigabay.me", "dz@livekit.io"]
+
+  spec.summary = "LiveKit Server SDK for Ruby"
+  spec.homepage = "https://livekit.io"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.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."
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "protobuf", "~> 3.10.5"
+  spec.add_dependency "jwt", "~> 2.2.3"
+  spec.add_dependency "twirp", "~> 1.9.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: livekit-server-sdk
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Omri Gabay
+- David Zhao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.5
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: twirp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+description: 
+email:
+- omri@omrigabay.me
+- dz@livekit.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".gitmodules"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- ".tool-versions"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/bootstrap.sh
+- bin/bundle
+- bin/coderay
+- bin/console
+- bin/htmldiff
+- bin/ldiff
+- bin/pry
+- bin/rake
+- bin/rspec
+- bin/rubocop
+- bin/ruby-parse
+- bin/ruby-rewrite
+- bin/yard
+- bin/yardoc
+- bin/yri
+- lib/livekit.rb
+- lib/livekit/access_token.rb
+- lib/livekit/auth_mixin.rb
+- lib/livekit/grants.rb
+- lib/livekit/proto/livekit_models_pb.rb
+- lib/livekit/proto/livekit_models_twirp.rb
+- lib/livekit/proto/livekit_recording_pb.rb
+- lib/livekit/proto/livekit_recording_twirp.rb
+- lib/livekit/proto/livekit_room_pb.rb
+- lib/livekit/proto/livekit_room_twirp.rb
+- lib/livekit/proto/livekit_webhook_pb.rb
+- lib/livekit/proto/livekit_webhook_twirp.rb
+- lib/livekit/room_service_client.rb
+- lib/livekit/token_verifier.rb
+- lib/livekit/utils.rb
+- lib/livekit/version.rb
+- livekit_server_sdk.gemspec
+homepage: https://livekit.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: LiveKit Server SDK for Ruby
+test_files: []