livekit-server-sdk 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bb36af1d7e9069ca23d61a380d94da731d3cf8026fc8c3c18df4925d1bc2fa0
-  data.tar.gz: fd621f01e789ee6662a4e8b7aa1aa18d768aa925eb9cb5700c8054bd9de5a285
+  metadata.gz: df7cb873ae1dd034d26f58d9d678aeb0685aeb76aa582efe03c57aa662090388
+  data.tar.gz: decdabaf87c8f3eb04e7c30371482bc84bf93dc304c5b43581dcfaf8eb61485c
 SHA512:
-  metadata.gz: eaf4b7fbe37e0645720225331e656982ae78ff21ef4359882426839b6f281c6ee1feb429eabf3f559ca8128f5d8bb71e54586e2e70cd52ef3897e7b9e017eb6d
-  data.tar.gz: ccb9f015ab8a5e0f42927313f7fbbd2dcc8337aa0cf0999e1cacccf7a83cd373511035e723de4a2e444ae188da0aea3b9aaab97740fcf5dbb558fce2c5fd72cf
+  metadata.gz: e9c750d3c53fe896219fd80ef30435839af5c806a80407d17a6536aaa9106e0f300f9db8fdab1a03cb730794db927173fd8a26959a60bebab22a3147a12c8e2b
+  data.tar.gz: 20d6ee54faa5ad39c4155d1d5d62906926c5222e1a40ca1346c7a2ef6e15f6ade65eb54ea08d0e4303c3018b5b8e814b8e763d4211e6a1d35749799432ffe10d

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    livekit-server-sdk (0.2.1)
-      google-protobuf (~> 3.19.2)
+    livekit-server-sdk (0.3.0)
+      google-protobuf (~> 3.21.0)
       jwt (~> 2.2.3)
       twirp (~> 1.9.0)
 
@@ -10,8 +10,8 @@ GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.3)
-    diff-lcs (1.4.4)
-    faraday (1.9.3)
+    diff-lcs (1.5.0)
+    faraday (1.10.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -27,43 +27,44 @@ GEM
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
-    google-protobuf (3.19.2)
-    google-protobuf (3.19.2-x86_64-linux)
+    google-protobuf (3.21.1)
     jwt (2.2.3)
     method_source (1.0.0)
-    multipart-post (2.1.1)
+    multipart-post (2.2.3)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-doc (1.1.0)
+    pry-doc (1.3.0)
       pry (~> 0.11)
       yard (~> 0.9.11)
     rake (13.0.6)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     ruby2_keywords (0.0.5)
     twirp (1.9.0)
       faraday (< 2)
       google-protobuf (~> 3.0, >= 3.7.0)
-    yard (0.9.26)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   ruby

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,45 +1,124 @@
-[![Specs](https://github.com/livekit/server-sdk-ruby/actions/workflows/test.yml/badge.svg)](https://github.com/livekit/server-sdk-ruby/actions/workflows/test.yml)
+# LiveKit Server API for Ruby
 
-# LiveKit::Ruby
+Ruby API for server-side integrations with LiveKit. This gem provides the ability to create access tokens as well as access RoomService.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/livekit/ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This library is designed to work with Ruby 2.6.0 and above.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
+### Gemfile
+
 ```ruby
-gem 'livekit-ruby'
+gem 'livekit-server-sdk'
 ```
 
-And then execute:
+and then `bundle install`.
 
-    $ bundle install
+### Install system-wide
 
-Or install it yourself as:
-
-    $ gem install livekit-ruby
+```shell
+gem install livekit-server-sdk
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Creating Access Tokens
 
-## Development
+Creating a token for participant to join a room.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+require 'livekit'
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+token = LiveKit::AccessToken.new(api_key: 'yourkey', api_secret: 'yoursecret')
+token.identity = 'participant-identity'
+token.name = 'participant-name'
+token.add_grant(roomJoin: true, room: 'room-name')
 
-## Contributing
+puts token.to_jwt
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/livekit-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/livekit-ruby/blob/master/CODE_OF_CONDUCT.md).
+By default, a token expires after 6 hours. You may override this by passing in `ttl` when creating the token. `ttl` is expressed in seconds.
 
-## License
+### Setting Permissions with Access Tokens
+
+It's possible to customize the permissions of each participant. See more details at [access tokens guide](https://docs.livekit.io/guides/access-tokens#room-permissions).
+
+### Room Service
+
+`RoomServiceClient` is a Twirp-based client that provides management APIs to LiveKit. You can connect it to your LiveKit endpoint. See [service apis](https://docs.livekit.io/guides/server-api) for a list of available APIs.
+
+```ruby
+require 'livekit'
+
+client = LiveKit::RoomServiceClient.new('https://my.livekit.instance',
+    api_key: 'yourkey', api_secret: 'yoursecret')
+
+name = 'myroom'
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+client.list_rooms
 
-## Code of Conduct
+client.list_participants(room: name)
+
+client.mute_published_track(room: name, identity: 'participant',
+                            track_sid: 'track-id', muted: true)
+
+client.remove_participant(room: name, identity: 'participant')
+
+client.delete_room(room: name)
+```
+
+### Egress Service
+
+`EgressServiceClient` is a ruby client to EgressService. Refer to [docs](https://docs.livekit.io/guides/egress) for more usage examples
+
+```ruby
+require 'livekit'
+
+# starting a room composite to S3
+const egressClient = LiveKit::EgressServiceClient.new(
+    "https://your-url",
+    api_key: 'key',
+    api_secret: 'secret'
+);
+
+info = egressClient.start_room_composite_egress(
+    'room-name',
+    LiveKit::Proto::EncodedFileOutput.new(
+        file_type: LiveKit::Proto::EncodedFileType::MP4,
+        filepath: "my-recording.mp4",
+        s3: LiveKit::Proto::S3Upload.new(
+            access_key: 'access-key',
+            secret: 'secret',
+            region: 'bucket-region',
+            bucket: 'bucket'
+        )
+    )
+)
+puts info
+
+# starting a track composite to RTMP
+urls = Google::Protobuf::RepeatedField.new(:string, ['rtmp://url1', 'rtmps://url2'])
+info = egressClient.start_track_composite_egress(
+    'room-name',
+    LiveKit::Proto::StreamOutput.new(
+        protocol: LiveKit::Proto::StreamProtocol::RTMP,
+        urls: urls
+    ),
+    audio_track_id: 'TR_XXXXXXXXXXXX',
+    video_track_id: 'TR_XXXXXXXXXXXX'
+)
+puts info
+```
+
+### Environment Variables
+
+You may store credentials in environment variables. If api-key or api-secret is not passed in when creating a `RoomServiceClient` or `AccessToken`, the values in the following env vars will be used:
+
+- `LIVEKIT_API_KEY`
+- `LIVEKIT_API_SECRET`
+
+## License
 
-Everyone interacting in the Livekit::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/livekit-ruby/blob/master/CODE_OF_CONDUCT.md).
+The gem is available as open source under the terms of Apache 2.0 License.

data/Rakefile

@@ -12,8 +12,8 @@ task :proto do
          "--ruby_out=lib/livekit/proto",
          "--twirp_ruby_out=lib/livekit/proto",
          "-Iprotocol",
+         "./protocol/livekit_egress.proto",
          "./protocol/livekit_models.proto",
-         "./protocol/livekit_recording.proto",
          "./protocol/livekit_room.proto",
          "./protocol/livekit_webhook.proto")
 end

data/lib/livekit/auth_mixin.rb

@@ -6,6 +6,7 @@ module LiveKit
       t = ::LiveKit::AccessToken.new(api_key: @api_key, api_secret: @api_secret)
       t.add_grant(video_grant)
       headers["Authorization"] = "Bearer #{t.to_jwt}"
+      headers["User-Agent"] = "LiveKit Ruby SDK"
       headers
     end
   end

data/lib/livekit/egress_service_client.rb

@@ -0,0 +1,158 @@
+require "livekit/proto/livekit_egress_twirp"
+require "livekit/auth_mixin"
+
+module LiveKit
+  class EgressServiceClient < Twirp::Client
+    client_for Proto::EgressService
+    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
+
+    def start_room_composite_egress(
+      room_name,
+      # one of EncodedFileOutput or StreamOutput
+      output,
+      # EncodingOptionsPreset, only one of preset or advanced could be set
+      preset: nil,
+      # EncodingOptions, only one of preset or advanced could be set
+      advanced: nil,
+      # egress template url, otherwise uses default templates
+      custom_base_url: nil,
+      # egress layout
+      layout: nil,
+      # true to record only audio
+      audio_only: false,
+      # true to record only video
+      video_only: false
+    )
+      request = Proto::RoomCompositeEgressRequest.new(
+        room_name: room_name,
+        preset: preset,
+        advanced: advanced,
+        layout: layout,
+        custom_base_url: custom_base_url,
+        audio_only: audio_only,
+        video_only: video_only,
+      )
+      self.set_output(request, output)
+      self.rpc(
+        :StartRoomCompositeEgress,
+        request,
+        headers: auth_header(roomRecord: true),
+      )
+    end
+
+    def start_track_composite_egress(
+      room_name,
+      # one of EncodedFileOutput or StreamOutput
+      output,
+      # TrackID of an audio track
+      audio_track_id: nil,
+      # TrackID of a video track
+      video_track_id: nil,
+      # EncodingOptionsPreset, only one of preset or advanced could be set
+      preset: nil,
+      # EncodingOptions, only one of preset or advanced could be set
+      advanced: nil
+    )
+      request = Proto::TrackCompositeEgressRequest.new(
+        room_name: room_name,
+        preset: preset,
+        advanced: advanced,
+        audio_track_id: audio_track_id,
+        video_track_id: video_track_id,
+      )
+      self.set_output(request, output)
+      self.rpc(
+        :StartTrackCompositeEgress,
+        request,
+        headers: auth_header(roomRecord: true),
+      )
+    end
+
+    def start_track_egress(
+      room_name,
+      # either a DirectFileOutput - egress to storage or string - egress to WebSocket URL
+      output,
+      track_id
+    )
+      request = Proto::TrackEgressRequest.new(
+        room_name: room_name,
+        track_id: track_id,
+      )
+      if output.filepath
+        request.file = output
+      else
+        request.websocket_url = output
+      end
+      self.rpc(
+        :StartTrackEgress,
+        request,
+        headers: auth_header(roomRecord: true),
+      )
+    end
+
+
+    def update_layout(egress_id, layout)
+      self.rpc(
+        :UpdateLayout,
+        Proto::UpdateLayoutRequest.new(
+          egress_id: egress_id,
+          layout: layout,
+        ),
+        headers: auth_header(roomRecord: true),
+      )
+    end
+
+    def update_stream(egress_id,
+      add_output_urls: [],
+      remove_output_urls: []
+    )
+      self.rpc(
+        :UpdateStream,
+        Proto::UpdateStreamRequest.new(
+          egress_id: egress_id,
+          add_output_urls: Google::Protobuf::RepeatedField.new(:string, add_output_urls.to_a),
+          remove_output_urls: Google::Protobuf::RepeatedField.new(:string, remove_output_urls.to_a),
+        ),
+        headers: auth_header(roomRecord: true),
+      )
+    end
+
+    # list all egress or only egress for a room
+    def list_egress(room_name: nil)
+      self.rpc(
+        :ListEgress,
+        Proto::ListEgressRequest.new(room_name: room_name),
+        headers: auth_header(roomRecord: true),
+      )
+    end
+
+    def stop_egress(egress_id)
+      self.rpc(
+        :StopEgress,
+        Proto::StopEgressRequest.new(egress_id: egress_id),
+        headers: auth_header(roomRecord: true),
+      )
+    end
+
+    private
+
+    # helper that sets output to file or stream
+    def set_output(request, output)
+      if output.nil?
+        raise "output cannot be nil"
+      end
+      if output.filepath
+        request.file = output
+      else
+        request.stream = output
+      end
+    end
+  end
+end