opentok 4.1.0 → 4.3.0

data/spec/opentok/broadcasts_spec.rb

@@ -144,6 +144,27 @@ describe OpenTok::Broadcasts do
     }.to raise_error(ArgumentError)
   end
 
+  it "raise an error for non valid type" do
+    expect {
+      broadcast.layout(started_broadcast_id, {
+          type: "not-valid",
+          stylesheet: "stream {}"
+      })
+    }.to raise_error(ArgumentError)
+  end
+
+  it "change the layout to custom type with custom stylesheet" do
+    stub_request(:put, "https://api.opentok.com/v2/project/#{api_key}/broadcast/#{started_broadcast_id}/layout").
+      with(body: {type: 'custom', stylesheet: 'stream {float: left; height: 100%; width: 33.33%;}'}).
+      to_return(status: 200)
+
+    response  = broadcast.layout(started_broadcast_id, {
+        type: "custom",
+        stylesheet: "stream {float: left; height: 100%; width: 33.33%;}"
+    })
+    expect(response).not_to be_nil
+  end
+
   it "raise an error if invalid layout type" do
     expect {
       broadcast.layout(started_broadcast_id, {
@@ -151,6 +172,25 @@ describe OpenTok::Broadcasts do
       })
     }.to raise_error(ArgumentError)
   end
+
+  it "raise an error if invalid layout type with screenshare_type" do
+    expect {
+      broadcast.layout(started_broadcast_id, {
+          type: "pip",
+          screenshare_type: "bestFit"
+      })
+    }.to raise_error(ArgumentError)
+  end
+
+  it "raise an error if invalid layout screenshare_type" do
+    expect {
+      broadcast.layout(started_broadcast_id, {
+          type: "bestFit",
+          screenshare_type: "pip1"
+      })
+    }.to raise_error(ArgumentError)
+  end
+
   it "calls layout on broadcast object", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
     b = broadcast.find started_broadcast_id
     expect(b).to be_an_instance_of OpenTok::Broadcast
@@ -161,11 +201,73 @@ describe OpenTok::Broadcasts do
           )
     }.to raise_error(ArgumentError)
   end
+
   it "changes the layout of a broadcast", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
+    stub_request(:put, "https://api.opentok.com/v2/project/#{api_key}/broadcast/#{started_broadcast_id}/layout").
+      to_return(status: 200)
+
     response = broadcast.layout(started_broadcast_id, {
         :type => "verticalPresentation"
     })
     expect(response).not_to be_nil
   end
 
-end
+  it "changes the screenshare option in the layout of a broadcast", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
+    stub_request(:put, "https://api.opentok.com/v2/project/#{api_key}/broadcast/#{started_broadcast_id}/layout").
+      to_return(status: 200)
+
+    response = broadcast.layout(started_broadcast_id, {
+        :type => "bestFit",
+        :screenshare_type => "bestFit"
+    })
+    expect(response).not_to be_nil
+  end
+
+  it "adds a stream to a broadcast", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
+    opts = {}
+    response = broadcast.add_stream(started_broadcast_id, '12312312-3811-4726-b508-e41a0f96c68f', opts)
+    expect(response.code).to eq(204)
+  end
+
+  it "removes a stream from a broadcast", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
+    response = broadcast.remove_stream(started_broadcast_id, '12312312-3811-4726-b508-e41a0f96c68f')
+    expect(response.code).to eq(204)
+  end
+
+  context "for many broadcasts" do
+    it "should return all broadcasts", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+      broadcast_list = broadcast.all
+      expect(broadcast_list).to be_an_instance_of OpenTok::BroadcastList
+      expect(broadcast_list.total).to eq 6
+      expect(broadcast_list.count).to eq 6
+    end
+
+    it "should return broadcasts with an offset", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+      broadcast_list = broadcast.all :offset => 3
+      expect(broadcast_list).to be_an_instance_of OpenTok::BroadcastList
+      expect(broadcast_list.total).to eq 3
+      expect(broadcast_list.count).to eq 3
+    end
+
+    it "should return count number of broadcasts", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+      broadcast_list = broadcast.all :count => 2
+      expect(broadcast_list).to be_an_instance_of OpenTok::BroadcastList
+      expect(broadcast_list.count).to eq 2
+      expect(broadcast_list.count).to eq 2
+    end
+
+    it "should return part of the broadcasts when using offset and count", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+      broadcast_list = broadcast.all :count => 4, :offset => 2
+      expect(broadcast_list).to be_an_instance_of OpenTok::BroadcastList
+      expect(broadcast_list.count).to eq 4
+      expect(broadcast_list.count).to eq 4
+    end
+
+    it "should return session broadcasts", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+      broadcast_list = broadcast.all :sessionId => session_id
+      expect(broadcast_list).to be_an_instance_of OpenTok::BroadcastList
+      expect(broadcast_list.total).to eq 3
+      expect(broadcast_list.count).to eq 3
+    end
+  end
+end

data/spec/opentok/connection_spec.rb

@@ -35,4 +35,4 @@ describe OpenTok::Connections do
     response = connection.forceDisconnect(session_id, connection_id)
     expect(response).not_to be_nil
   end
-end
+end

data/spec/opentok/opentok_spec.rb

@@ -152,6 +152,12 @@ describe OpenTok::OpenTok do
       it "should have an timeout_length property" do
         expect(opentok.timeout_length).to eq timeout_length
       end
+
+      it "should send the custom timeout_length to new instances of OpenTok::Client" do
+        streams = opentok.streams
+
+        expect(streams.instance_variable_get(:@client).timeout_length).to eq timeout_length
+      end
     end
 
     context "with an addendum to the user agent string" do

data/spec/opentok/sip_spec.rb

@@ -12,20 +12,51 @@ describe OpenTok::Sip do
   let(:api_key) { "123456" }
   let(:api_secret) { "1234567890abcdef1234567890abcdef1234567890" }
   let(:session_id) { "SESSIONID" }
+  let(:connection_id) { "CONNID" }
   let(:expiring_token) { "TOKENID" }
   let(:sip_uri) { "sip:+15128675309@acme.pstn.example.com;transport=tls" }
   let(:sip_username) { "bob" }
   let(:sip_password) { "abc123" }
   let(:opentok) { OpenTok::OpenTok.new api_key, api_secret }
   let(:sip) { opentok.sip }
+  let(:valid_dtmf_digits) { "0123456789*#p" }
+  let(:invalid_dtmf_digits) { "0123456789*#pabc" }
   subject { sip }
 
   it "receives a valid response", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
     opts = { "auth" => { "username" => sip_username,
                          "password" => sip_password },
-             "secure" => "true"
+             "secure" => "true",
+             "video" => "true",
+             "observe_force_mute" => "true"
     }
     response = sip.dial(session_id, expiring_token, sip_uri, opts)
     expect(response).not_to be_nil
   end
+
+  describe "#play_dtmf_to_connection" do
+    it "raises an ArgumentError when passed an invalid dtmf digit string" do
+      expect {
+        sip.play_dtmf_to_connection(session_id, connection_id, invalid_dtmf_digits)
+      }.to raise_error(ArgumentError)
+    end
+
+    it "returns a 200 response code when passed a valid dtmf digit string", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+      response = sip.play_dtmf_to_connection(session_id, connection_id, valid_dtmf_digits)
+      expect(response.code).to eq(200)
+    end
+  end
+
+  describe "#play_dtmf_to_session" do
+    it "raises an ArgumentError when passed an invalid dtmf digit string" do
+      expect {
+        sip.play_dtmf_to_session(session_id, invalid_dtmf_digits)
+      }.to raise_error(ArgumentError)
+    end
+
+    it "returns a 200 response code when passed a valid dtmf digit string", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+      response = sip.play_dtmf_to_session(session_id, valid_dtmf_digits)
+      expect(response.code).to eq(200)
+    end
+  end
 end

data/spec/opentok/streams_spec.rb

@@ -72,4 +72,24 @@ describe OpenTok::Streams do
     response = streams.layout(session_id, streams_list)
     expect(response).not_to be_nil
   end
-end
+
+  it "forces the specified stream to be muted", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    response = streams.force_mute(session_id, stream_id)
+    expect(response.code).to eq(200)
+  end
+
+  it "forces all current and future streams in a session to be muted", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    response = streams.force_mute_all(session_id)
+    expect(response.code).to eq(200)
+  end
+
+  it "forces all current and future streams in a session to be muted except specified excluded streams", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    response = streams.force_mute_all(session_id, { "excludedStreams" => ["b1963d15-537f-459a-be89-e00fc310b82b"] })
+    expect(response.code).to eq(200)
+  end
+
+  it "disables the 'mute state' of a session", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    response = streams.disable_force_mute(session_id)
+    expect(response.code).to eq(200)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentok
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Stijn Mathysen
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -34,14 +34,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -170,9 +170,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/metrics.yml"
 - ".gitignore"
-- ".travis.yml"
 - ".yardopts"
+- CHANGES.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - DEVELOPING.md
@@ -185,6 +187,7 @@ files:
 - lib/opentok/archive_list.rb
 - lib/opentok/archives.rb
 - lib/opentok/broadcast.rb
+- lib/opentok/broadcast_list.rb
 - lib/opentok/broadcasts.rb
 - lib/opentok/client.rb
 - lib/opentok/connections.rb
@@ -221,6 +224,7 @@ files:
 - sample/Broadcast/public/css/sample.css
 - sample/Broadcast/public/js/host.js
 - sample/Broadcast/public/js/participant.js
+- sample/Broadcast/views/all.erb
 - sample/Broadcast/views/host.erb
 - sample/Broadcast/views/index.erb
 - sample/Broadcast/views/layout.erb
@@ -230,14 +234,17 @@ files:
 - sample/HelloWorld/hello_world.rb
 - sample/HelloWorld/public/js/helloworld.js
 - sample/HelloWorld/views/index.erb
+- spec/cassettes/OpenTok_Archives/adds_a_stream_to_an_archive.yml
 - spec/cassettes/OpenTok_Archives/calls_layout_on_archive_object.yml
 - spec/cassettes/OpenTok_Archives/changes_the_layout_of_an_archive.yml
 - spec/cassettes/OpenTok_Archives/http_client_errors/.yml
+- spec/cassettes/OpenTok_Archives/removes_a_stream_from_an_archive.yml
 - spec/cassettes/OpenTok_Archives/should_create_archives.yml
 - spec/cassettes/OpenTok_Archives/should_create_audio_only_archives.yml
 - spec/cassettes/OpenTok_Archives/should_create_custom_layout_archives.yml
 - spec/cassettes/OpenTok_Archives/should_create_hd_archives.yml
 - spec/cassettes/OpenTok_Archives/should_create_individual_archives.yml
+- spec/cassettes/OpenTok_Archives/should_create_layout_archives_with_screenshare_layout_types.yml
 - spec/cassettes/OpenTok_Archives/should_create_named_archives.yml
 - spec/cassettes/OpenTok_Archives/should_delete_an_archive_by_id.yml
 - spec/cassettes/OpenTok_Archives/should_find_archives_by_id.yml
@@ -250,10 +257,17 @@ files:
 - spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_count_number_of_archives.yml
 - spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_part_of_the_archives_when_using_offset_and_count.yml
 - spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_session_archives.yml
+- spec/cassettes/OpenTok_Broadcasts/adds_a_stream_to_a_broadcast.yml
 - spec/cassettes/OpenTok_Broadcasts/calls_layout_on_broadcast_object.yml
 - spec/cassettes/OpenTok_Broadcasts/changes_the_layout_of_a_broadcast.yml
 - spec/cassettes/OpenTok_Broadcasts/fetches_a_hls_broadcast_url.yml
 - spec/cassettes/OpenTok_Broadcasts/finds_a_broadcast.yml
+- spec/cassettes/OpenTok_Broadcasts/for_many_broadcasts/should_return_all_broadcasts.yml
+- spec/cassettes/OpenTok_Broadcasts/for_many_broadcasts/should_return_broadcasts_with_an_offset.yml
+- spec/cassettes/OpenTok_Broadcasts/for_many_broadcasts/should_return_count_number_of_broadcasts.yml
+- spec/cassettes/OpenTok_Broadcasts/for_many_broadcasts/should_return_part_of_the_broadcasts_when_using_offset_and_count.yml
+- spec/cassettes/OpenTok_Broadcasts/for_many_broadcasts/should_return_session_broadcasts.yml
+- spec/cassettes/OpenTok_Broadcasts/removes_a_stream_from_a_broadcast.yml
 - spec/cassettes/OpenTok_Broadcasts/starts_a_rtmp_broadcast.yml
 - spec/cassettes/OpenTok_Broadcasts/stops_a_broadcast.yml
 - spec/cassettes/OpenTok_Connections/forces_a_connection_to_be_terminated.yml
@@ -268,7 +282,13 @@ files:
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/with_an_addendum_to_the_user_agent_string/should_append_the_addendum_to_the_user_agent_header.yml
 - spec/cassettes/OpenTok_Signals/receives_a_valid_response_for_a_connection.yml
 - spec/cassettes/OpenTok_Signals/receives_a_valid_response_for_all_connections.yml
+- spec/cassettes/OpenTok_Sip/_play_dtmf_to_connection/returns_a_200_response_code_when_passed_a_valid_dtmf_digit_string.yml
+- spec/cassettes/OpenTok_Sip/_play_dtmf_to_session/returns_a_200_response_code_when_passed_a_valid_dtmf_digit_string.yml
 - spec/cassettes/OpenTok_Sip/receives_a_valid_response.yml
+- spec/cassettes/OpenTok_Streams/disables_the_mute_state_of_a_session.yml
+- spec/cassettes/OpenTok_Streams/forces_all_current_and_future_streams_in_a_session_to_be_muted.yml
+- spec/cassettes/OpenTok_Streams/forces_all_current_and_future_streams_in_a_session_to_be_muted_except_specified_excluded_streams.yml
+- spec/cassettes/OpenTok_Streams/forces_the_specified_stream_to_be_muted.yml
 - spec/cassettes/OpenTok_Streams/get_all_streams_information.yml
 - spec/cassettes/OpenTok_Streams/get_specific_stream_information.yml
 - spec/cassettes/OpenTok_Streams/layout_working_on_two_stream_list.yml
@@ -304,19 +324,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.0
+rubygems_version: 3.3.6
 signing_key: 
 specification_version: 4
 summary: Ruby gem for the OpenTok API
 test_files:
+- spec/cassettes/OpenTok_Archives/adds_a_stream_to_an_archive.yml
 - spec/cassettes/OpenTok_Archives/calls_layout_on_archive_object.yml
 - spec/cassettes/OpenTok_Archives/changes_the_layout_of_an_archive.yml
 - spec/cassettes/OpenTok_Archives/http_client_errors/.yml
+- spec/cassettes/OpenTok_Archives/removes_a_stream_from_an_archive.yml
 - spec/cassettes/OpenTok_Archives/should_create_archives.yml
 - spec/cassettes/OpenTok_Archives/should_create_audio_only_archives.yml
 - spec/cassettes/OpenTok_Archives/should_create_custom_layout_archives.yml
 - spec/cassettes/OpenTok_Archives/should_create_hd_archives.yml
 - spec/cassettes/OpenTok_Archives/should_create_individual_archives.yml
+- spec/cassettes/OpenTok_Archives/should_create_layout_archives_with_screenshare_layout_types.yml
 - spec/cassettes/OpenTok_Archives/should_create_named_archives.yml
 - spec/cassettes/OpenTok_Archives/should_delete_an_archive_by_id.yml
 - spec/cassettes/OpenTok_Archives/should_find_archives_by_id.yml
@@ -329,10 +352,17 @@ test_files:
 - spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_count_number_of_archives.yml
 - spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_part_of_the_archives_when_using_offset_and_count.yml
 - spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_session_archives.yml
+- spec/cassettes/OpenTok_Broadcasts/adds_a_stream_to_a_broadcast.yml
 - spec/cassettes/OpenTok_Broadcasts/calls_layout_on_broadcast_object.yml
 - spec/cassettes/OpenTok_Broadcasts/changes_the_layout_of_a_broadcast.yml
 - spec/cassettes/OpenTok_Broadcasts/fetches_a_hls_broadcast_url.yml
 - spec/cassettes/OpenTok_Broadcasts/finds_a_broadcast.yml
+- spec/cassettes/OpenTok_Broadcasts/for_many_broadcasts/should_return_all_broadcasts.yml
+- spec/cassettes/OpenTok_Broadcasts/for_many_broadcasts/should_return_broadcasts_with_an_offset.yml
+- spec/cassettes/OpenTok_Broadcasts/for_many_broadcasts/should_return_count_number_of_broadcasts.yml
+- spec/cassettes/OpenTok_Broadcasts/for_many_broadcasts/should_return_part_of_the_broadcasts_when_using_offset_and_count.yml
+- spec/cassettes/OpenTok_Broadcasts/for_many_broadcasts/should_return_session_broadcasts.yml
+- spec/cassettes/OpenTok_Broadcasts/removes_a_stream_from_a_broadcast.yml
 - spec/cassettes/OpenTok_Broadcasts/starts_a_rtmp_broadcast.yml
 - spec/cassettes/OpenTok_Broadcasts/stops_a_broadcast.yml
 - spec/cassettes/OpenTok_Connections/forces_a_connection_to_be_terminated.yml
@@ -347,7 +377,13 @@ test_files:
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/with_an_addendum_to_the_user_agent_string/should_append_the_addendum_to_the_user_agent_header.yml
 - spec/cassettes/OpenTok_Signals/receives_a_valid_response_for_a_connection.yml
 - spec/cassettes/OpenTok_Signals/receives_a_valid_response_for_all_connections.yml
+- spec/cassettes/OpenTok_Sip/_play_dtmf_to_connection/returns_a_200_response_code_when_passed_a_valid_dtmf_digit_string.yml
+- spec/cassettes/OpenTok_Sip/_play_dtmf_to_session/returns_a_200_response_code_when_passed_a_valid_dtmf_digit_string.yml
 - spec/cassettes/OpenTok_Sip/receives_a_valid_response.yml
+- spec/cassettes/OpenTok_Streams/disables_the_mute_state_of_a_session.yml
+- spec/cassettes/OpenTok_Streams/forces_all_current_and_future_streams_in_a_session_to_be_muted.yml
+- spec/cassettes/OpenTok_Streams/forces_all_current_and_future_streams_in_a_session_to_be_muted_except_specified_excluded_streams.yml
+- spec/cassettes/OpenTok_Streams/forces_the_specified_stream_to_be_muted.yml
 - spec/cassettes/OpenTok_Streams/get_all_streams_information.yml
 - spec/cassettes/OpenTok_Streams/get_specific_stream_information.yml
 - spec/cassettes/OpenTok_Streams/layout_working_on_two_stream_list.yml

data/.travis.yml

@@ -1,17 +0,0 @@
-# Get container-based infrastructure
-sudo: false
-language: ruby
-# Travis bug, see https://github.com/bundler/bundler/pull/3559
-cache: bundler
-before_install: gem update bundler
-rvm:
-- 2.1
-- 2.2
-- 2.3
-- 2.4
-- 2.5
-- 2.6
-- 2.7
-notifications:
-  slack:
-    secure: agVll2R9PTPvJMcUgbvOh9eGt60zGDc8kPUwEsiQr828rCgXh/ZxD5irYDyKQg3ZsS8+f3MjFCwzU7uQALkia2pDrie9d8g8m1dt4Q5U7Qm6QecshvE0U9JwbB5Ngxaftbqyf0XEFrE7CKs7RI1BzFRpe8m+fdZgfwccX8Gb7pc=