opentok 4.7.1 → 4.8.1

data/lib/opentok/exceptions.rb

@@ -18,4 +18,6 @@ module OpenTok
   class OpenTokWebSocketError < OpenTokError; end
   # Defines errors raised when you perform Experience Composer render operations.
   class OpenTokRenderError < OpenTokError; end
+  # Defines errors raised when you perform Captions operations.
+  class OpenTokCaptionsError < OpenTokError; end
 end

data/lib/opentok/opentok.rb

@@ -12,6 +12,7 @@ require "opentok/streams"
 require "opentok/signals"
 require "opentok/broadcasts"
 require "opentok/renders"
+require "opentok/captions"
 
 module OpenTok
   # Contains methods for creating OpenTok sessions and generating tokens. It also includes
@@ -214,6 +215,16 @@ module OpenTok
       @broadcasts ||= Broadcasts.new client
     end
 
+    # A Captions object, which lets you start and stop live captions for an OpenTok session.
+    def captions
+      @captions ||= Captions.new client
+    end
+
+    # A Connections object, which lets you disconnect clients from an OpenTok session.
+    def connections
+      @connections ||= Connections.new client
+    end
+
     # A Renders object, which lets you work with OpenTok Experience Composer renders.
     def renders
       @renders ||= Renders.new client
@@ -234,11 +245,6 @@ module OpenTok
       @signals ||= Signals.new client
     end
 
-    # A Connections object, which lets you disconnect clients from an OpenTok session.
-    def connections
-      @connections ||= Connections.new client
-    end
-
     # A WebSocket object, which lets you connect OpenTok streams to a WebSocket URI.
     def websocket
       @websocket ||= WebSocket.new client

data/lib/opentok/version.rb

@@ -1,4 +1,4 @@
 module OpenTok
   # @private
-  VERSION = '4.7.1'
+  VERSION = '4.8.1'
 end

data/spec/cassettes/OpenTok_Archives/should_create_an_archive_with_matching_multi_archive_tag_when_multiArchiveTag_is_specified.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api.opentok.com/v2/project/123456/archive
     body:
       encoding: UTF-8
-      string: '{"sessionId":"SESSIONID"}'
+      string: '{"sessionId":"SESSIONID","multiArchiveTag":"archive-1"}'
     headers:
       User-Agent:
       - OpenTok-Ruby-SDK/<%= version %>

data/spec/cassettes/OpenTok_Archives/should_create_an_archive_with_streamMode_set_to_specified_stream_mode_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","streamMode":"manual"}'
+    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:
+      - Wed, 03 Jan 2024 14:32:20 GMT
+      Content-Type:
+      - application/json
+      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,
+          "streamMode":"manual"
+        }
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 6.0.0

data/spec/cassettes/OpenTok_Archives/should_create_an_archives_with_a_specified_multiArchiveTag.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api.opentok.com/v2/project/123456/archive
     body:
       encoding: UTF-8
-      string: '{"sessionId":"SESSIONID"}'
+      string: '{"sessionId":"SESSIONID","multiArchiveTag":"archive-1"}'
     headers:
       User-Agent:
       - OpenTok-Ruby-SDK/<%= version %>

data/spec/cassettes/OpenTok_Captions/receives_a_valid_response_when_starting_captions.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/v2/project/123456/captions
+    body:
+      encoding: UTF-8
+      string: '{"sessionId":"SESSIONID","token":"TOKENID"}'
+    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: 202
+      message: Accepted
+    headers:
+      Date:
+      - Tue, 05 Sep 2023 11:32:49 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - AWSALBTG=V0iIksb77idvUqENJbP7kHbxorCidH5rXzTdrmAq244qBgmkoAZJ+QZE0gPn/fKjmIEtO29S43zhxzH3X5Ao8Nf/8KMvioOduANad0cg6/rMMbSKhWdxNJkcePyrYLO/6voP37Lk8LamlXqv3QK6lj9SCvA+/wyUB6CV+i1JY8XSc1ba/+s=;
+        Expires=Tue, 12 Sep 2023 11:32:49 GMT; Path=/
+      - AWSALBTGCORS=V0iIksb77idvUqENJbP7kHbxorCidH5rXzTdrmAq244qBgmkoAZJ+QZE0gPn/fKjmIEtO29S43zhxzH3X5Ao8Nf/8KMvioOduANad0cg6/rMMbSKhWdxNJkcePyrYLO/6voP37Lk8LamlXqv3QK6lj9SCvA+/wyUB6CV+i1JY8XSc1ba/+s=;
+        Expires=Tue, 12 Sep 2023 11:32:49 GMT; Path=/; SameSite=None; Secure
+      X-Opentok-Trace:
+      - f=unknown&s=cerberus&u=B8FAC1E2-3DCE-40A9-9CC3-866750E7C7A5
+    body:
+      encoding: UTF-8
+      string: '{ "captionsId": "7c0680fc-6274-4de5-a66f-d0648e8d3ac2" }'
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 6.0.0

data/spec/cassettes/OpenTok_Captions/receives_a_valid_response_when_starting_captions_with_options.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/v2/project/123456/captions
+    body:
+      encoding: UTF-8
+      string: '{"sessionId":"SESSIONID","token":"TOKENID","languageCode":"en-GB","maxDuration":5000,"partialCaptions":false,"statusCallbackUrl":"https://example.com/captions/status"}'
+    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: 202
+      message: Accepted
+    headers:
+      Date:
+      - Tue, 05 Sep 2023 12:05:23 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - AWSALBTG=Qam0XgGzqhEaBC7TB9UprWCTZ6omkQZDorQLpkU8Kb3+iSIJsINH6Rh13nWnaLryAUc08wZEEc0VAi6ZXVa5gVLE/5YeIvMT9WP8VzJLFyvQ/bMe7TIDvp/QronHO4tohNGpvrFQxCC5LElWX5JnN3sCr5WpUHqEPQr0jz9TtUmKJYIh0So=;
+        Expires=Tue, 12 Sep 2023 12:05:23 GMT; Path=/
+      - AWSALBTGCORS=Qam0XgGzqhEaBC7TB9UprWCTZ6omkQZDorQLpkU8Kb3+iSIJsINH6Rh13nWnaLryAUc08wZEEc0VAi6ZXVa5gVLE/5YeIvMT9WP8VzJLFyvQ/bMe7TIDvp/QronHO4tohNGpvrFQxCC5LElWX5JnN3sCr5WpUHqEPQr0jz9TtUmKJYIh0So=;
+        Expires=Tue, 12 Sep 2023 12:05:23 GMT; Path=/; SameSite=None; Secure
+      X-Opentok-Trace:
+      - f=unknown&s=cerberus&u=5DB017B0-6FC7-444F-BDE9-20D3CBA7B2EA
+    body:
+      encoding: UTF-8
+      string: '{ "captionsId": "7c0680fc-6274-4de5-a66f-d0648e8d3ac2" }'
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 6.0.0

data/spec/cassettes/OpenTok_Captions/receives_a_valid_response_when_stopping_captions.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/v2/project/123456/captions/CAPTIONSID/stop
+    body:
+      encoding: UTF-8
+      string: ''
+    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: 202
+      message: Accepted
+    headers:
+      Date:
+      - Tue, 05 Sep 2023 11:30:55 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - AWSALBTG=LJIybl0y9LXphBJqNdoYf94M2EQTLnT/IhYp4UD+lzvSSZfKfdshtXSXDJ+gplgMuZ+3zg7mtnQoUF7ZhM2IRiL6VYJq88ltUPP075OdNgDwWRpYLq+doFLXeee4skbljcUpgTAWkCp1MReHhYdiTO8G36cgW9hPyWE9/jIMcfhN6HzVv5Q=;
+        Expires=Tue, 12 Sep 2023 11:30:55 GMT; Path=/
+      - AWSALBTGCORS=LJIybl0y9LXphBJqNdoYf94M2EQTLnT/IhYp4UD+lzvSSZfKfdshtXSXDJ+gplgMuZ+3zg7mtnQoUF7ZhM2IRiL6VYJq88ltUPP075OdNgDwWRpYLq+doFLXeee4skbljcUpgTAWkCp1MReHhYdiTO8G36cgW9hPyWE9/jIMcfhN6HzVv5Q=;
+        Expires=Tue, 12 Sep 2023 11:30:55 GMT; Path=/; SameSite=None; Secure
+      X-Opentok-Trace:
+      - f=unknown&s=cerberus&u=22ECEF08-1EBD-4554-BF7B-04857DE8616A
+    body:
+      encoding: UTF-8
+      string: ''
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 6.0.0

data/spec/opentok/archives_spec.rb

@@ -44,7 +44,7 @@ describe OpenTok::Archives do
 
   it "should create an archives with a specified multiArchiveTag", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
     archive_tag = 'archive-1'
-    archive = archives.create session_id, :multiArchiveTag => archive_tag
+    archive = archives.create session_id, :multi_archive_tag => archive_tag
     expect(archive).to be_an_instance_of OpenTok::Archive
     expect(archive.session_id).to eq session_id
     expect(archive.multiArchiveTag).to eq archive_tag
@@ -52,7 +52,7 @@ describe OpenTok::Archives do
 
   it "should create an archive with matching multi_archive_tag when multiArchiveTag is specified", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
     archive_tag = 'archive-1'
-    archive = archives.create session_id, :multiArchiveTag => archive_tag
+    archive = archives.create session_id, :multi_archive_tag => archive_tag
     expect(archive).to be_an_instance_of OpenTok::Archive
     expect(archive.multi_archive_tag).to eq archive_tag
   end
@@ -63,6 +63,13 @@ describe OpenTok::Archives do
     expect(archive.multi_archive_tag).to be_nil
   end
 
+  it "should create an archive with streamMode set to specified stream_mode value", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    stream_mode = 'manual'
+    archive = archives.create session_id, :stream_mode => stream_mode
+    expect(archive).to be_an_instance_of OpenTok::Archive
+    expect(archive.stream_mode).to eq stream_mode
+  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/captions_spec.rb

@@ -0,0 +1,44 @@
+require "opentok/opentok"
+require "opentok/captions"
+require "opentok/version"
+require "spec_helper"
+
+describe OpenTok::Captions do
+  before(:each) do
+    now = Time.parse("2017-04-18 20:17:40 +1000")
+    allow(Time).to receive(:now) { now }
+  end
+
+  let(:api_key) { "123456" }
+  let(:api_secret) { "1234567890abcdef1234567890abcdef1234567890" }
+  let(:session_id) { "SESSIONID" }
+  let(:captions_id) { "CAPTIONSID" }
+  let(:expiring_token) { "TOKENID" }
+  let(:status_callback_url) { "https://example.com/captions/status" }
+  let(:opentok) { OpenTok::OpenTok.new api_key, api_secret }
+  let(:captions) { opentok.captions }
+  subject { captions }
+
+  it "receives a valid response when starting captions", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    response = captions.start(session_id, expiring_token)
+    expect(response).not_to be_nil
+    expect(response.code).to eq(202)
+  end
+
+  it "receives a valid response when starting captions with options", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    opts = { "language_code" => "en-GB",
+             "max_duration" => 5000,
+             "partial_captions" => false,
+             "status_callback_url" => status_callback_url
+           }
+
+    response = captions.start(session_id, expiring_token, opts)
+    expect(response).not_to be_nil
+    expect(response.code).to eq(202)
+  end
+
+  it "receives a valid response when stopping captions", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    response = captions.stop(captions_id)
+    expect(response.code).to eq(202)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentok
 version: !ruby/object:Gem::Version
-  version: 4.7.1
+  version: 4.8.1
 platform: ruby
 authors:
 - Stijn Mathysen
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-17 00:00:00.000000000 Z
+date: 2024-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -189,6 +189,7 @@ files:
 - lib/opentok/broadcast.rb
 - lib/opentok/broadcast_list.rb
 - lib/opentok/broadcasts.rb
+- lib/opentok/captions.rb
 - lib/opentok/client.rb
 - lib/opentok/connections.rb
 - lib/opentok/constants.rb
@@ -245,6 +246,7 @@ files:
 - spec/cassettes/OpenTok_Archives/removes_a_stream_from_an_archive.yml
 - 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_multi_archive_tag_value_of_nil_when_multiArchiveTag_not_specified.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
 - spec/cassettes/OpenTok_Archives/should_create_audio_only_archives.yml
@@ -280,6 +282,9 @@ files:
 - spec/cassettes/OpenTok_Broadcasts/starts_a_broadcast_with_a_specified_multiBroadcastTag.yml
 - spec/cassettes/OpenTok_Broadcasts/starts_a_rtmp_broadcast.yml
 - spec/cassettes/OpenTok_Broadcasts/stops_a_broadcast.yml
+- spec/cassettes/OpenTok_Captions/receives_a_valid_response_when_starting_captions.yml
+- spec/cassettes/OpenTok_Captions/receives_a_valid_response_when_starting_captions_with_options.yml
+- spec/cassettes/OpenTok_Captions/receives_a_valid_response_when_stopping_captions.yml
 - spec/cassettes/OpenTok_Connections/forces_a_connection_to_be_terminated.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_always_archived_sessions.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_always_archived_sessions_with_a_set_archive_name.yml
@@ -317,6 +322,7 @@ files:
 - spec/matchers/token.rb
 - spec/opentok/archives_spec.rb
 - spec/opentok/broadcasts_spec.rb
+- spec/opentok/captions_spec.rb
 - spec/opentok/client_spec.rb
 - spec/opentok/connection_spec.rb
 - spec/opentok/opentok_spec.rb
@@ -349,7 +355,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Ruby gem for the OpenTok API
@@ -361,6 +367,7 @@ test_files:
 - spec/cassettes/OpenTok_Archives/removes_a_stream_from_an_archive.yml
 - 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_multi_archive_tag_value_of_nil_when_multiArchiveTag_not_specified.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
 - spec/cassettes/OpenTok_Archives/should_create_audio_only_archives.yml
@@ -396,6 +403,9 @@ test_files:
 - spec/cassettes/OpenTok_Broadcasts/starts_a_broadcast_with_a_specified_multiBroadcastTag.yml
 - spec/cassettes/OpenTok_Broadcasts/starts_a_rtmp_broadcast.yml
 - spec/cassettes/OpenTok_Broadcasts/stops_a_broadcast.yml
+- spec/cassettes/OpenTok_Captions/receives_a_valid_response_when_starting_captions.yml
+- spec/cassettes/OpenTok_Captions/receives_a_valid_response_when_starting_captions_with_options.yml
+- spec/cassettes/OpenTok_Captions/receives_a_valid_response_when_stopping_captions.yml
 - spec/cassettes/OpenTok_Connections/forces_a_connection_to_be_terminated.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_always_archived_sessions.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_always_archived_sessions_with_a_set_archive_name.yml
@@ -433,6 +443,7 @@ test_files:
 - spec/matchers/token.rb
 - spec/opentok/archives_spec.rb
 - spec/opentok/broadcasts_spec.rb
+- spec/opentok/captions_spec.rb
 - spec/opentok/client_spec.rb
 - spec/opentok/connection_spec.rb
 - spec/opentok/opentok_spec.rb