opentok 4.12.0 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 454d2a2b89a14ec5af2ccb56e10c8a52d15eda5df4bf2f0f3274c4838499c8b4
-  data.tar.gz: d89e3eec35b639b3af4cc859291a4f1e464f197b5381333778112909ef1e11a7
+  metadata.gz: 8856de6eda311f8036e05575702122ba484553a7899cbeecc5246be2551fe1bf
+  data.tar.gz: 6c9caa43050de91eaf2fc4fa1cc2793844cb0c81f90400de4add8037ace88f86
 SHA512:
-  metadata.gz: 38f6b630ff8ad46fb07ebf47093adb418174afd4c2917bd9cf0ce1514090d4e3c9c0d9f9f4e9165ffe059e004e4eb724b4ad028e29c419d33006d326595c1da4
-  data.tar.gz: d66dce967d068ade1412c2b2fc23b80ba2a71eb528be1c8dab33dcf04813db2d0dbdb81b85a82b5c512dd0c5f4e777be61009422e51c4bf02e1d946adac00e1f
+  metadata.gz: 174cced0d88b55c47b5d2e478ad4b77d9ae0905a3f48470b59f203f982395a83eb9e29e8bcf2ec9fa0f6e9cc15c49babd2371ca27b69052e60d1de2d053de46f
+  data.tar.gz: 640c7dabed0a31e9e32194fe99914e3ab296fe04f4009cc561ef764d5c4b28e1a53c935fc2bf2ceff2d4f68def44527c75a919fc527bcf30efa7828cc884106b

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 4.13.0
+
+* Updating the `Archives#create` method to allow `quantization_parameter` as an option, and the `WebSocket#connect`  method to allow `bidirectional` as an option. See [#290](https://github.com/opentok/OpenTok-Ruby-SDK/pull/290)
+
 # 4.12.0
 
 * Updating the `Archives#create` method to allow `max_bitrate` as an option. See [#288](https://github.com/opentok/OpenTok-Ruby-SDK/pull/288)

data/lib/opentok/archives.rb

@@ -84,6 +84,11 @@ module OpenTok
     #   to control the size of the composed archive. This maximum bitrate applies to the video bitrate only. If the output archive has
     #   audio, those bits will be excluded from the limit.
     #
+    # @option options [Integer] :quantization_parameter (Optional) The quantization parameter (QP) is an optional video encoding value allowed for composed archiving,
+    #   smaller values generate higher quality and larger archives, larger values generate lower quality and smaller archives, QP uses variable bitrate (VBR). The minimum
+    #   value is 15 and the maximum is 40.
+    #   This parameter is mutually exclusive with the max_bitrate parameter.
+    #
     # @return [Archive] The Archive object, which includes properties defining the archive,
     #   including the archive ID.
     #
@@ -110,7 +115,8 @@ module OpenTok
         :layout,
         :multi_archive_tag,
         :stream_mode,
-        :max_bitrate
+        :max_bitrate,
+        :quantization_parameter
       ]
       opts = options.inject({}) do |m,(k,v)|
         if valid_opts.include? k.to_sym

data/lib/opentok/opentok.rb

@@ -36,7 +36,6 @@ module OpenTok
   #     the token.
   #
   #   @param [Hash] options A hash defining options for the token.
-  #   @option options [String] :token_type The type of token to generate. Must be one of 'T1' or 'JWT'. 'JWT' is the default.
   #   @option options [Symbol] :role The role for the token. Set this to one of the following
   #     values:
   #     * <code>:subscriber</code> -- A subscriber can only subscribe to streams.
@@ -60,6 +59,7 @@ module OpenTok
   #     published by the client. Layout classes are used in customizing the layout of videos in
   #     {https://tokbox.com/developer/guides/broadcast/live-streaming/ live streaming broadcasts}
   #     and {https://tokbox.com/developer/guides/archiving/layout-control.html composed archives}.
+  #   @option options [String] :token_type The type of token to generate. Must be one of 'T1' or 'JWT'. 'JWT' is the default.
   #   @return [String] The token string.
   class OpenTok
 

data/lib/opentok/session.rb

@@ -36,6 +36,9 @@ module OpenTok
   #     * <code>:publisher</code> -- A publisher can publish streams, subscribe to
   #       streams, and signal. (This is the default value if you do not specify a role.)
   #
+  #     * <code>:publisheronly</code> -- A client connected with a publisheronly token
+  #       can publish streams but cannot subscribe to streams.
+  #
   #     * <code>:moderator</code> -- n addition to the privileges granted to a
   #       publisher, a moderator can perform moderation functions, such as forcing clients
   #       to disconnect, to stop publishing streams, or to mute audio in published streams. See the

data/lib/opentok/version.rb

@@ -1,4 +1,4 @@
 module OpenTok
   # @private
-  VERSION = '4.12.0'
+  VERSION = '4.13.0'
 end

data/lib/opentok/websocket.rb

@@ -26,6 +26,7 @@ module OpenTok
     #       If you omit this property, all streams in the session will be included.
     # @option opts [Hash] :headers (optional) A hash of key-value pairs of headers to be sent to your WebSocket server with each message,
     #        with a maximum length of 512 bytes.
+    # @option opts [Boolean] :bidirectional (optional) Whether the WebSocket connection should be bidirectional.
     def connect(session_id, token, websocket_uri, opts  = {})
       response = @client.connect_websocket(session_id, token, websocket_uri, opts)
     end

data/spec/cassettes/OpenTok_Archives/should_create_an_archive_with_quantizationParameter_set_to_specified_value.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/v2/project/123456/archive
+    body:
+      encoding: UTF-8
+      string: '{"sessionId":"SESSIONID","quantizationParameter":40}'
+    headers:
+      User-Agent:
+      - OpenTok-Ruby-SDK/<%= version %>
+      X-Opentok-Auth:
+      - eyJpc3QiOiJwcm9qZWN0IiwiYWxnIjoiSFMyNTYifQ.eyJpc3MiOiIxMjM0NTYiLCJpYXQiOjE0OTI1MTA2NjAsImV4cCI6MTQ5MjUxMDk2MH0.BplMVhJWx4ld7KLKXqEmow6MjNPPFw9W8IHCMfeb120
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 06 Oct 2025 08:48:17 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "createdAt" : 1395183243556,
+          "duration" : 0,
+          "id" : "30b3ebf1-ba36-4f5b-8def-6f70d9986fe9",
+          "name" : "",
+          "partnerId" : 123456,
+          "reason" : "",
+          "sessionId" : "SESSIONID",
+          "size" : 0,
+          "status" : "started",
+          "url" : null,
+          "quantizationParameter": 40
+        }
+  recorded_at: Mon, 06 Oct 2025 08:48:17 GMT
+recorded_with: VCR 6.3.1

data/spec/cassettes/OpenTok_WebSocket/receives_a_valid_response_with_opts.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/v2/project/123456/connect
+    body:
+      encoding: UTF-8
+      string: '{"sessionId":"SESSIONID","token":"TOKENID","websocket":{"uri":"ws://service.com/wsendpoint","streams":["123456"],"headers":{"foo":"bar"},"bidirectional":true}}'
+    headers:
+      User-Agent:
+      - OpenTok-Ruby-SDK/<%= version %>
+      X-Opentok-Auth:
+      - eyJpc3QiOiJwcm9qZWN0IiwiYWxnIjoiSFMyNTYifQ.eyJpc3MiOiIxMjM0NTYiLCJpYXQiOjE0OTI1MTA2NjAsImV4cCI6MTQ5MjUxMDk2MH0.BplMVhJWx4ld7KLKXqEmow6MjNPPFw9W8IHCMfeb120
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 06 Oct 2025 09:42:20 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Opentok-Trace:
+      - f=unknown&s=cerberus&u=3E467A7C-6130-469D-BD7B-10308CD0D395
+    body:
+      encoding: UTF-8
+      string: '{"id":"2299ba24-a6de-417c-88f7-28da54a441cf","connectionId":"833a7182-61a5-49d4-baae-c324b09953af"}'
+  recorded_at: Mon, 06 Oct 2025 09:42:20 GMT
+recorded_with: VCR 6.3.1

data/spec/opentok/archives_spec.rb

@@ -77,6 +77,13 @@ describe OpenTok::Archives do
     expect(archive.max_bitrate).to eq max_bitrate
   end
 
+  it "should create an archive with quantizationParameter set to specified value", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    quantization_parameter = 40
+    archive = archives.create session_id, :quantization_parameter => quantization_parameter
+    expect(archive).to be_an_instance_of OpenTok::Archive
+    expect(archive.quantization_parameter).to eq quantization_parameter
+  end
+
   it "should create audio only archives", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
     archive = archives.create session_id, :has_video => false
     expect(archive).to be_an_instance_of OpenTok::Archive

data/spec/opentok/websocket_spec.rb

@@ -23,4 +23,15 @@ describe OpenTok::WebSocket do
     response = websocket.connect(session_id, expiring_token, websocket_uri)
     expect(response).not_to be_nil
   end
+
+  it "receives a valid response with opts", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    opts = {
+      "streams" => ["123456"],
+      "headers" => {"foo" => "bar"},
+      "bidirectional" => true
+    }
+
+    response = websocket.connect(session_id, expiring_token, websocket_uri, opts)
+    expect(response).not_to be_nil
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentok
 version: !ruby/object:Gem::Version
-  version: 4.12.0
+  version: 4.13.0
 platform: ruby
 authors:
 - Stijn Mathysen
@@ -9,10 +9,10 @@ authors:
 - Song Zheng
 - Patrick Quinn-Graham
 - Ankur Oberoi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 2025-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -247,6 +247,7 @@ files:
 - spec/cassettes/OpenTok_Archives/should_create_an_archive_with_matching_multi_archive_tag_when_multiArchiveTag_is_specified.yml
 - spec/cassettes/OpenTok_Archives/should_create_an_archive_with_maxBitrate_set_to_specified_max_bitrate_value.yml
 - spec/cassettes/OpenTok_Archives/should_create_an_archive_with_multi_archive_tag_value_of_nil_when_multiArchiveTag_not_specified.yml
+- spec/cassettes/OpenTok_Archives/should_create_an_archive_with_quantizationParameter_set_to_specified_value.yml
 - spec/cassettes/OpenTok_Archives/should_create_an_archive_with_streamMode_set_to_specified_stream_mode_value.yml
 - spec/cassettes/OpenTok_Archives/should_create_an_archives_with_a_specified_multiArchiveTag.yml
 - spec/cassettes/OpenTok_Archives/should_create_archives.yml
@@ -320,6 +321,7 @@ files:
 - spec/cassettes/OpenTok_Streams/get_specific_stream_information.yml
 - spec/cassettes/OpenTok_Streams/layout_working_on_two_stream_list.yml
 - spec/cassettes/OpenTok_WebSocket/receives_a_valid_response.yml
+- spec/cassettes/OpenTok_WebSocket/receives_a_valid_response_with_opts.yml
 - spec/matchers/token.rb
 - spec/opentok/archives_spec.rb
 - spec/opentok/broadcasts_spec.rb
@@ -341,7 +343,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/opentok/OpenTok-Ruby-SDK
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -356,8 +358,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Ruby gem for the OpenTok API
 test_files:
@@ -369,6 +371,7 @@ test_files:
 - spec/cassettes/OpenTok_Archives/should_create_an_archive_with_matching_multi_archive_tag_when_multiArchiveTag_is_specified.yml
 - spec/cassettes/OpenTok_Archives/should_create_an_archive_with_maxBitrate_set_to_specified_max_bitrate_value.yml
 - spec/cassettes/OpenTok_Archives/should_create_an_archive_with_multi_archive_tag_value_of_nil_when_multiArchiveTag_not_specified.yml
+- spec/cassettes/OpenTok_Archives/should_create_an_archive_with_quantizationParameter_set_to_specified_value.yml
 - spec/cassettes/OpenTok_Archives/should_create_an_archive_with_streamMode_set_to_specified_stream_mode_value.yml
 - spec/cassettes/OpenTok_Archives/should_create_an_archives_with_a_specified_multiArchiveTag.yml
 - spec/cassettes/OpenTok_Archives/should_create_archives.yml
@@ -442,6 +445,7 @@ test_files:
 - spec/cassettes/OpenTok_Streams/get_specific_stream_information.yml
 - spec/cassettes/OpenTok_Streams/layout_working_on_two_stream_list.yml
 - spec/cassettes/OpenTok_WebSocket/receives_a_valid_response.yml
+- spec/cassettes/OpenTok_WebSocket/receives_a_valid_response_with_opts.yml
 - spec/matchers/token.rb
 - spec/opentok/archives_spec.rb
 - spec/opentok/broadcasts_spec.rb