opentok 4.1.2 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74581fd2fb2645cd163ed9a979fcfbb8cfd13da7cf0530bd49364a8a63ce0164
-  data.tar.gz: 8a21fb081a3be5c24a3a321442af11a56ef960ea489b1482abd876adc4d09e44
+  metadata.gz: 9e2192eea0d5c896fc1251eb57055f59c1e057d62827177d6a60a7498ff30d68
+  data.tar.gz: d6d321140b14b5386da8431ddb4894a63b1c3a420d015d55adfbdc67e9fe67fb
 SHA512:
-  metadata.gz: dfbddec4e8e490a017817e05a1ec9c14b51b655a15f263ab15b2d461118330b34fb1296f8e614d76bbf480893856ad2b0d6202175de786499bbce001d5ce5943
-  data.tar.gz: 3cc40c6ba443524d7470ee2d331fe20cfb7f86b69067b56d22f957d2d01715334faa668d2e5121062cb5f393503924ce8cb73c5fe8be523cb1b1968d17ebaa2e
+  metadata.gz: 83dffe63858be64be98373afa2b8d3b68b8eb4dd659a65e96283dda20518bd7359bddc1e84ed9c3a892db6aacfe33600b6f8e892085597a09ddb1fccb45090e2
+  data.tar.gz: ba71675fd11e9bf767e06af79018774b74da072e701d806664bcb8dfffba59fcfa79fe9e5ef80fe0e45734601247fa0376f890ceca85cc543dfd097722b84bf1

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        ruby: [2.5, 2.6, 2.7, 3.0]
+        exclude:
+          - os: windows-latest
+            ruby: 3.0
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake spec
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

data/README.md

@@ -1,6 +1,8 @@
 # OpenTok Ruby SDK
 
-[![Build Status](https://travis-ci.org/opentok/OpenTok-Ruby-SDK.png)](https://travis-ci.org/opentok/OpenTok-Ruby-SDK) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
+![Coverage Status](https://github.com/opentok/OpenTok-Ruby-SDK/workflows/CI/badge.svg)
+[![codecov](https://codecov.io/gh/opentok/OpenTok-Ruby-SDK/branch/master/graph/badge.svg)](https://codecov.io/gh/opentok/opentok-ruby-sdk) 
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
 
 <img src="https://assets.tokbox.com/img/vonage/Vonage_VideoAPI_black.svg" height="48px" alt="Tokbox is now known as Vonage" />
 

data/lib/opentok/archive.rb

@@ -7,7 +7,7 @@ module OpenTok
     #   The time at which the archive was created, in milliseconds since the UNIX epoch.
     #
     # @attr [string] duration
-    #   The duration of the archive, in milliseconds.
+    #   The duration of the archive, in seconds.
     #
     # @attr [string] id
     #   The archive ID.

data/lib/opentok/archives.rb

@@ -49,12 +49,16 @@ module OpenTok
     #   this property and set the outputMode property to "individual", the call the method
     #   results in an error.
     # @option options [Hash] :layout Specify this to assign the initial layout type for
-    #   the archive. This applies only to composed archives. This is a hash containing two keys:
-    #   <code>:type</code> and <code>:stylesheet<code>. Valid values for <code>:type</code> are
-    #   "bestFit" (best fit), "custom" (custom), "horizontalPresentation" (horizontal presentation),
+    #   the archive. This applies only to composed archives. This is a hash containing three keys:
+    #   <code>:type</code>, <code>:stylesheet<code> and <code>:screenshare_type</code>. 
+    #   Valid values for <code>:type</code> are "bestFit" (best fit), "custom" (custom), 
+    #    "horizontalPresentation" (horizontal presentation),
     #   "pip" (picture-in-picture), and "verticalPresentation" (vertical presentation)).
     #   If you specify a "custom" layout type, set the <code>:stylesheet</code> key to the
     #   stylesheet (CSS). (For other layout types, do not set the <code>:stylesheet</code> key.)
+    #   Valid values for <code>:screenshare_type</code> are "bestFit", "pip",
+    #   "verticalPresentation", "horizontalPresentation". This property is optional.
+    #   If it is specified, then the <code>:type</code> property **must** be set to "bestFit".
     #   If you do not specify an initial layout type, the archive uses the best fit
     #   layout type. For more information, see
     #   {https://tokbox.com/developer/guides/archiving/layout-control.html Customizing
@@ -178,6 +182,11 @@ module OpenTok
     #   The stylesheet for a custom layout. Set this parameter
     #   if you set <code>type</code> to <code>"custom"</code>. Otherwise, leave it undefined.
     #
+    # @option options [String] :screenshare_type
+    #   The screenshare layout type. Set this to "bestFit", "pip", "verticalPresentation" or
+    #   "horizonalPresentation". If this is defined, then the <code>type</code> parameter
+    #   must be set to <code>"bestFit"</code>.
+    #
     # @raise [ArgumentError]
     #   The archive_id or options parameter is empty. Or the "custom"
     #   type was specified without a stylesheet option. Or a stylesheet was passed in for a
@@ -208,9 +217,12 @@ module OpenTok
       raise ArgumentError, "archive_id not provided" if archive_id.to_s.empty?
       type = options[:type]
       raise ArgumentError, "custom type must have a stylesheet" if (type.eql? "custom") && (!options.key? :stylesheet)
-      valid_non_custom_type = ["bestFit","horizontalPresentation","pip", "verticalPresentation", ""].include? type
+      valid_non_custom_layouts = ["bestFit","horizontalPresentation","pip", "verticalPresentation", ""]
+      valid_non_custom_type = valid_non_custom_layouts.include? type
       raise ArgumentError, "type is not valid" if !valid_non_custom_type && !(type.eql? "custom")
       raise ArgumentError, "type is not valid or stylesheet not needed" if valid_non_custom_type and options.key? :stylesheet
+      raise ArgumentError, "screenshare_type is not valid" if options[:screenshare_type] && !valid_non_custom_layouts.include?(options[:screenshare_type])
+      raise ArgumentError, "type must be set to 'bestFit' if screenshare_type is defined" if options[:screenshare_type] && type != 'bestFit'
       response = @client.layout_archive(archive_id, options)
       (200..300).include? response.code
     end

data/lib/opentok/broadcasts.rb

@@ -22,13 +22,20 @@ module OpenTok
     # @param [String] session_id The session ID of the OpenTok session to broadcast.
     #
     # @param [Hash] options A hash defining options for the broadcast.
-    # @option options [Hash] :layout Specify this to assign the initial layout  for the broadcast.
-    #   Valid values for the layout (<code>:type</code>) property are "bestFit" (best fit), "custom" (custom),
-    #   "horizontalPresentation" (horizontal presentation), "pip" (picture-in-picture), and
-    #   "verticalPresentation" (vertical presentation)).
-    #   If you specify a (<code>:custom</code>) layout type, set the (<code>:stylesheet</code>) property of the layout object
-    #   to the stylesheet. (For other layout types, do not set a stylesheet property.)
-    #   If you do not specify an initial layout type, the broadcast stream uses the Best Fit layout type.
+    #
+    # @option options [Hash] :layout Specify this to assign the initial layout type for
+    #   the broadcast. This is a hash containing three keys:
+    #   <code>:type</code>, <code>:stylesheet<code> and <code>:screenshare_type</code>. 
+    #   Valid values for <code>:type</code> are "bestFit" (best fit), "custom" (custom), 
+    #    "horizontalPresentation" (horizontal presentation),
+    #   "pip" (picture-in-picture), and "verticalPresentation" (vertical presentation)).
+    #   If you specify a "custom" layout type, set the <code>:stylesheet</code> key to the
+    #   stylesheet (CSS). (For other layout types, do not set the <code>:stylesheet</code> key.)
+    #   Valid values for <code>:screenshare_type</code> are "bestFit", "pip",
+    #   "verticalPresentation", "horizontalPresentation". This property is optional.
+    #   If it is specified, then the <code>:type</code> property **must** be set to "bestFit".
+    #   If you do not specify an initial layout type, the broadcast uses the best fit
+    #   layout type.
     #
     # @option options [int] maxDuration
     #   The maximum duration for the broadcast, in seconds. The broadcast will automatically stop when
@@ -112,6 +119,11 @@ module OpenTok
     #   The stylesheet for a custom layout. Set this parameter
     #   if you set <code>type</code> to <code>"custom"</code>. Otherwise, leave it undefined.
     #
+    # @option options [String] :screenshare_type
+    #   The screenshare layout type. Set this to "bestFit", "pip", "verticalPresentation" or
+    #   "horizonalPresentation". If this is defined, then the <code>type</code> parameter
+    #   must be set to <code>"bestFit"</code>.
+    #
     # @raise [OpenTokBroadcastError]
     #   The broadcast layout could not be updated.
     #
@@ -137,9 +149,12 @@ module OpenTok
       raise ArgumentError, "broadcast_id not provided" if broadcast_id.to_s.empty?
       type = options[:type]
       raise ArgumentError, "custom type must have a stylesheet" if (type.eql? "custom") && (!options.key? :stylesheet)
-      valid_non_custom_type = ["bestFit","horizontalPresentation","pip", "verticalPresentation", ""].include? type
+      valid_non_custom_layouts = ["bestFit","horizontalPresentation","pip", "verticalPresentation", ""]
+      valid_non_custom_type = valid_non_custom_layouts.include? type
       raise ArgumentError, "type is not valid" if !valid_non_custom_type && !(type.eql? "custom")
       raise ArgumentError, "stylesheet not needed" if valid_non_custom_type and options.key? :stylesheet
+      raise ArgumentError, "screenshare_type is not valid" if options[:screenshare_type] && !valid_non_custom_layouts.include?(options[:screenshare_type])
+      raise ArgumentError, "type must be set to 'bestFit' if screenshare_type is defined" if options[:screenshare_type] && type != 'bestFit'
       response = @client.layout_broadcast(broadcast_id, options)
       (200..300).include? response.code
     end

data/lib/opentok/version.rb

@@ -1,4 +1,4 @@
 module OpenTok
   # @private
-  VERSION = '4.1.2'
+  VERSION = '4.2.0'
 end

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/opentok/archives_spec.rb

@@ -67,6 +67,16 @@ describe OpenTok::Archives do
     expect(archive.session_id).to eq session_id
   end
 
+  it "should create layout archives with screenshare layout types", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
+    screenshare_layout = {
+      :type => "bestFit",
+      :screenshare_type => "verticalPresentation"
+    }
+    archive = archives.create session_id, :layout => screenshare_layout
+    expect(archive).to be_an_instance_of OpenTok::Archive
+    expect(archive.session_id).to eq session_id
+  end
+
   it "should stop archives", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
     archive = archives.stop_by_id started_archive_id
     expect(archive).to be_an_instance_of OpenTok::Archive
@@ -159,6 +169,25 @@ describe OpenTok::Archives do
       })
     }.to raise_error(ArgumentError)
   end
+
+  it "raise an error if invalid layout type with screenshare_type" do
+    expect {
+      archives.layout(started_archive_id, {
+          type: "pip",
+          screenshare_type: "bestFit"
+      })
+    }.to raise_error(ArgumentError)
+  end
+
+  it "raise an error if invalid layout screenshare_type" do
+    expect {
+      archives.layout(started_archive_id, {
+          type: "bestFit",
+          screenshare_type: "pip1"
+      })
+    }.to raise_error(ArgumentError)
+  end
+
   it "calls layout on archive object", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
     archive = archives.find findable_archive_id
     expect(archive).to be_an_instance_of OpenTok::Archive

data/spec/opentok/broadcasts_spec.rb

@@ -172,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
@@ -182,6 +201,7 @@ 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)
@@ -192,4 +212,15 @@ describe OpenTok::Broadcasts do
     expect(response).not_to be_nil
   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
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentok
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.2.0
 platform: ruby
 authors:
 - Stijn Mathysen
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2021-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,9 +170,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".github/workflows/metrics.yml"
 - ".gitignore"
-- ".travis.yml"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -239,6 +239,7 @@ files:
 - 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
@@ -305,7 +306,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.0
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby gem for the OpenTok API
@@ -318,6 +319,7 @@ test_files:
 - 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

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=