opentok 4.1.0 → 4.5.1

data/lib/opentok/streams.rb

@@ -4,7 +4,7 @@ require 'opentok/stream_list'
 
 module OpenTok
   # A class for working with OpenTok streams. It includes methods for getting info
-  # about OpenTok streams and for setting layout classes for streams.
+  # about OpenTok streams, for setting layout classes for streams, and for muting streams.
   class Streams
     # @private
     def initialize(client)
@@ -75,5 +75,52 @@ module OpenTok
       (200..300).include? response.code
     end
 
+    # Force a specific stream connected to an OpenTok session to mute itself.
+    #
+    # @param [String] session_id The session ID of the OpenTok session.
+    # @param [String] stream_id The stream ID of the stream in the session.
+    #
+    def force_mute(session_id, stream_id)
+      response = @client.force_mute_stream(session_id, stream_id)
+    end
+
+    # Force all streams connected to an OpenTok session (except for an optional list of streams),
+    # to mute published audio.
+    # 
+    # In addition to existing streams, any streams that are published after the call to
+    # this method are published with audio muted. You can remove the mute state of a session
+    # by calling the disable_force_mute() method.
+    #
+    # @param [String] session_id The session ID.
+    # @param [Hash] opts An optional hash defining options for the muting action. For example:
+    #   {
+    #     "excluded_streams" => [
+    #       "excludedStreamId1",
+    #       "excludedStreamId2"
+    #     ]
+    #   }
+    # @option opts [Array] :excluded_streams The stream IDs for streams that should not be muted.
+    # This is an optional property. If you omit this property, all streams in the session will be muted.
+    #
+    def force_mute_all(session_id, opts = {})
+      opts['active'] = 'true'
+      response = @client.force_mute_session(session_id, opts)
+    end
+
+    # Disables the active mute state of the session. After you call this method, new streams
+    # published to the session will no longer have audio muted.
+    #
+    # After you call the force_mute_all() method, any streams published after
+    # the call are published with audio muted. Call the disable_force_mute() method
+    # to remove the mute state of a session, so that new published streams are not
+    # automatically muted.
+    #
+    # @param [String] session_id The session ID.
+    #
+    def disable_force_mute(session_id)
+      opts = {'active' => 'false'}
+      response = @client.force_mute_session(session_id, opts)
+    end
+
   end
-end
+end

data/lib/opentok/token_generator.rb

@@ -4,6 +4,7 @@ require "opentok/session"
 require "base64"
 require "addressable/uri"
 require "openssl"
+require "active_support"
 require "active_support/time"
 
 module OpenTok

data/lib/opentok/version.rb

@@ -1,4 +1,4 @@
 module OpenTok
   # @private
-  VERSION = '4.1.0'
+  VERSION = '4.5.1'
 end

data/opentok.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |spec|
   spec.description = %q{OpenTok is an API from TokBox that enables websites to weave live group video communication into their online experience. With OpenTok you have the freedom and flexibility to create the most engaging web experience for your users. This gem lets you generate sessions and tokens for OpenTok applications. It also includes support for working with OpenTok 2.0 archives. See <http://tokbox.com/opentok/platform> for more details.}
   # TODO: this homepage isn't set up just yet
   spec.homepage    = "https://opentok.github.io/opentok-ruby-sdk"
+  spec.metadata    = { "source_code_uri" => "https://github.com/opentok/OpenTok-Ruby-SDK" }
   spec.license     = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,7 +19,7 @@ Gem::Specification.new do |spec|
 
   bundler_version = RUBY_VERSION < '2.1' ? '~> 1.5' : '>= 1.5'
   spec.add_development_dependency "bundler", bundler_version
-  spec.add_development_dependency "rake", "~> 12.0.0"
+  spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.9.0"
   spec.add_development_dependency "webmock", ">= 2.3.2"
   spec.add_development_dependency "vcr", ">= 2.8.0"

data/sample/Broadcast/README.md

@@ -168,6 +168,48 @@ You will now see the participant in the broadcast.
   end
 ```
 
+### All broadcasts
+
+Start by visiting the list page at <http://localhost:4567/all>. You will see a table that
+displays all the broadcasts created with your API Key. If there are more than five, the next ones
+can be seen by clicking the "Next →" link. Some basic information like
+when the broadcast was created, how long it is, and its status is also shown. You should see the
+broadcasts you created in the previous sections here.
+
+We begin to see how this page is created by looking at the route handler for this URL:
+
+```ruby
+  get '/all' do
+    page = (params[:page] || "1").to_i
+    offset = (page - 1) * 5
+    broadcasts = settings.opentok.broadcasts.all(:offset => offset, :count => 5)
+
+    show_previous = page > 1 ? '/all?page=' + (page-1).to_s : nil
+    show_next = broadcasts.total > (offset + 5) ? '/all?page=' + (page+1).to_s : nil
+
+    erb :all, :locals => {
+      :broadcasts => broadcasts,
+      :show_previous => show_previous,
+      :show_next => show_next
+    }
+  end
+```
+
+This view is paginated so that we don't potentially show hundreds of rows on the table, which would
+be difficult for the user to navigate. So this code starts by figuring out which page needs to be
+shown, where each page is a set of 5 broadcasts. The `page` number is read from the request's query
+string parameters as a string and then converted into an Integer. The `offset`, which represents how
+many broadcasts are being skipped is always calculated as five times as many pages that are less than
+the current page, which is `(page - 1) * 5`. Now there is enough information to ask for a list of
+broadcasts from OpenTok, which we do by calling the `broadcasts.all()` method of the `opentok` instance.
+The parameter is an optional Hash that contains the offset, the count (which is always 5 in this
+view). If we are not at the first page, we can pass the view a string that contains the relative URL
+for the previous page. Similarly, we can also include one for the next page. Now the application
+renders the view using that information and the partial list of broadcasts.
+
+At this point the template file `views/all.erb` handles looping over the array of broadcasts and
+outputting the proper information for each column in the table.
+
 ### Changing the layout classes for streams
 
 In the host page, if you click on either the host or a participant video, that video gets

data/sample/Broadcast/broadcast_sample.rb

@@ -46,6 +46,21 @@ class BroadcastSample < Sinatra::Base
     }
   end
 
+  get '/all' do
+    page = (params[:page] || "1").to_i
+    offset = (page - 1) * 5
+    broadcasts = settings.opentok.broadcasts.all(:offset => offset, :count => 5)
+
+    show_previous = page > 1 ? '/all?page=' + (page-1).to_s : nil
+    show_next = broadcasts.total > (offset + 5) ? '/all?page=' + (page+1).to_s : nil
+
+    erb :all, :locals => {
+      :broadcasts => broadcasts,
+      :show_previous => show_previous,
+      :show_next => show_next
+    }
+  end
+
   post '/start' do
     opts = {
         :maxDuration => params.key?("maxDuration") ? params[:maxDuration] : 7200,

data/sample/Broadcast/views/all.erb

@@ -0,0 +1,46 @@
+  <div class="container bump-me">
+
+    <div class="body-content">
+
+      <div class="panel panel-default">
+        <div class="panel-heading">
+          <h3 class="panel-title">Broadcasts List</h3>
+        </div>
+        <div class="panel-body">
+          <% if broadcasts.count > 0 %>
+          <table class="table">
+            <thead>
+              <tr>
+                <th>Created</th>
+                <th>Status</th>
+              </tr>
+            </thead>
+            <tbody>
+              <% for item in broadcasts %>
+
+              <tr data-item-id="<%= item.id %>">
+                <td><%= Time.at(item.created_at/1000).strftime("%B %e, %Y at %I:%M %p") %></td>
+                <td><%= item.status %></td>
+              </tr>
+
+              <% end %>
+            </tbody>
+          </table>
+          <% else %>
+          <p>
+            There are no broadcasts currently. Try making one in the <a href="/host">host view</a>.
+          </p>
+          <% end %>
+        </div>
+        <div class="panel-footer">
+          <% if show_previous %>
+            <a href="<%= show_previous %>" class="pull-left">&larr; Previous</a>
+          <% end %>
+          &nbsp;
+          <% if show_next %>
+            <a href="<%= show_next %>" class="pull-right">Next &rarr;</a>
+          <% end %>
+        </div>
+      </div>
+    </div>
+  </div>

data/sample/Broadcast/views/index.erb

@@ -25,8 +25,23 @@
           </div>
 
         </div>
+        <div class="col-lg-6 col-offset-1">
+
+          <div class="panel panel-default">
+            <div class="panel-heading">List of Broadcasts</div>
+            <div class="panel-body">
+              <p>
+                Click through to List of Broadcasts to see examples of using the
+                Broadcasting REST API to list broadcasts showing status (started,
+                stopped, available) and created at timestamp.
+              </p>
+            </div>
+            <div class="panel-footer">
+              <a class="btn btn-success" href="all">List of Broadcasts</a>
+            </div>
+          </div>
 
     </div>
 
   </div>
-</div>
+</div>

data/spec/cassettes/OpenTok_Archives/adds_a_stream_to_an_archive.yml

@@ -0,0 +1,37 @@
+---
+http_interactions:
+- request:
+    method: patch
+    uri: https://api.opentok.com/v2/project/123456/archive/30b3ebf1-ba36-4f5b-8def-6f70d9986fe9/streams
+    body:
+      encoding: UTF-8
+      string: '{"addStream":"12312312-3811-4726-b508-e41a0f96c68f"}'
+    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: 204
+      message: No Content
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 23 Nov 2021 20:55:02 GMT
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - AWSALBTG=DuFUMmWLYpV+WXygU/vIF2GeEgO0ltb32OLXKREBQ059UXSGx826MWScm3+Iba9R/DrIu8wi8puQQB6HMDNNA5twML8KpmSno/CfRqigVEW7z7njwLdBeIjKowkK2oDiRCpWwn35G08EcNtdzJZUUO+Cqt/7MLfakD0RjBHzn0k0H6uk8Y4=;
+        Expires=Tue, 30 Nov 2021 20:55:02 GMT; Path=/
+      - AWSALBTGCORS=DuFUMmWLYpV+WXygU/vIF2GeEgO0ltb32OLXKREBQ059UXSGx826MWScm3+Iba9R/DrIu8wi8puQQB6HMDNNA5twML8KpmSno/CfRqigVEW7z7njwLdBeIjKowkK2oDiRCpWwn35G08EcNtdzJZUUO+Cqt/7MLfakD0RjBHzn0k0H6uk8Y4=;
+        Expires=Tue, 30 Nov 2021 20:55:02 GMT; Path=/; SameSite=None; Secure
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 6.0.0

data/spec/cassettes/OpenTok_Archives/removes_a_stream_from_an_archive.yml

@@ -0,0 +1,37 @@
+---
+http_interactions:
+- request:
+    method: patch
+    uri: https://api.opentok.com/v2/project/123456/archive/30b3ebf1-ba36-4f5b-8def-6f70d9986fe9/streams
+    body:
+      encoding: UTF-8
+      string: '{"removeStream":"12312312-3811-4726-b508-e41a0f96c68f"}'
+    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: 204
+      message: No Content
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 23 Nov 2021 20:55:03 GMT
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - AWSALBTG=C8HtbnHIrXFPcTucK+6zVh2r0MMrr/1Jb/WUzPKk5rAEw3LbnvwxrsMlwebeHFPZUj+lcnVMLZU91OiujdiYEUH5eBovMivdAk9Gd/O9f4iPju70zwCPrRaoMZnH3sFK6a8lG3Q966pXth4vEsvTA12tADiC2emPHC51Z75R51aQMKUxFPc=;
+        Expires=Tue, 30 Nov 2021 20:55:03 GMT; Path=/
+      - AWSALBTGCORS=C8HtbnHIrXFPcTucK+6zVh2r0MMrr/1Jb/WUzPKk5rAEw3LbnvwxrsMlwebeHFPZUj+lcnVMLZU91OiujdiYEUH5eBovMivdAk9Gd/O9f4iPju70zwCPrRaoMZnH3sFK6a8lG3Q966pXth4vEsvTA12tADiC2emPHC51Z75R51aQMKUxFPc=;
+        Expires=Tue, 30 Nov 2021 20:55:03 GMT; Path=/; SameSite=None; Secure
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 6.0.0

data/spec/cassettes/OpenTok_Archives/should_create_an_archive_with_matching_multi_archive_tag_when_multiArchiveTag_is_specified.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/v2/project/123456/archive
+    body:
+      encoding: UTF-8
+      string: '{"sessionId":"SESSIONID"}'
+    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, 03 Oct 2022 10:19:16 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      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,
+          "multiArchiveTag":"archive-1"
+        }
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 6.0.0

data/spec/cassettes/OpenTok_Archives/should_create_an_archive_with_multi_archive_tag_value_of_nil_when_multiArchiveTag_not_specified.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/v2/project/123456/archive
+    body:
+      encoding: UTF-8
+      string: '{"sessionId":"SESSIONID"}'
+    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, 03 Oct 2022 10:19:17 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      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
+        }
+  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

@@ -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"}'
+    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, 07 Sep 2022 14:23:34 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,
+          "multiArchiveTag":"archive-1"
+        }
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 6.0.0

data/spec/cassettes/OpenTok_Archives/should_create_layout_archives_with_screenshare_layout_types.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/v2/project/123456/archive
+    body:
+      encoding: UTF-8
+      string: '{"sessionId":"SESSIONID","layout":{"type":"bestFit","screenshare_type":"verticalPresentation"}}'
+    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:
+      - Fri, 17 Jan 2020 21:15:36 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
+        }
+    http_version: 
+  recorded_at: Tue, 26 Jan 2021 09:01:36 GMT
+recorded_with: VCR 5.0.0

data/spec/cassettes/OpenTok_Broadcasts/adds_a_stream_to_a_broadcast.yml

@@ -0,0 +1,37 @@
+---
+http_interactions:
+- request:
+    method: patch
+    uri: https://api.opentok.com/v2/project/123456/broadcast/13dbcc23-af92-4862-9184-74b21815a814/streams
+    body:
+      encoding: UTF-8
+      string: '{"addStream":"12312312-3811-4726-b508-e41a0f96c68f"}'
+    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: 204
+      message: No Content
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 23 Nov 2021 20:44:18 GMT
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - AWSALBTG=Nj5lPQS/JnLA1JkA1AcUDSrn5vUxVtJ5srP+UHP/scSFLccYUClejVswu+NTMqGisdJi/7X/qdPMWBEq6ReBXCALUGz+NKunxs/WrIBFxBOz6EYgWkHXh8DY9Rtx2xEQmDzdCDqXIgr1aUzTv8J3taybWQm4yBpzHjFJFoUjpNYxS6+1zlI=;
+        Expires=Tue, 30 Nov 2021 20:44:18 GMT; Path=/
+      - AWSALBTGCORS=Nj5lPQS/JnLA1JkA1AcUDSrn5vUxVtJ5srP+UHP/scSFLccYUClejVswu+NTMqGisdJi/7X/qdPMWBEq6ReBXCALUGz+NKunxs/WrIBFxBOz6EYgWkHXh8DY9Rtx2xEQmDzdCDqXIgr1aUzTv8J3taybWQm4yBpzHjFJFoUjpNYxS6+1zlI=;
+        Expires=Tue, 30 Nov 2021 20:44:18 GMT; Path=/; SameSite=None; Secure
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 6.0.0