opentok 4.8.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc3a44c807492ac56f39fe6abed609c15c1627c3e2651f5d9a01cb8745dafa07
-  data.tar.gz: 6970f77ecb445dae4096bfbd440a9beebf3047b5a7fa0de6ff7343a726fb4c1f
+  metadata.gz: bf1e7d0f61794792bf98909f86601643c30df2cb2343297dcca0e8df7397d93a
+  data.tar.gz: 2c336b28cd586be0f082770b8854fd7f222d4c7047ba060a2fe300c31bf2417f
 SHA512:
-  metadata.gz: 47fd19211b5616ce0d0862c69096a42c5de69285f2ee02be6873bcb84ace57a8c4631479bdef1420675c23283e834c353bcefc1a712984d1e639287c11b83e41
-  data.tar.gz: 93ce88395b8133e9d3d2cbb0e32740cd520827450987e278ba901234d18f49fdfb3197506f72fbadd981b303fb0c215b16b2c25ceaf361f3c3b2933d78dee360
+  metadata.gz: 2730c26df934c6fb413f177db04bdc048ea58285bf2dbd640d90873a9f2670f31264141f08280cf393860eb8b11f7b525f2ef61e5d450d5c15d0fe0437addc5d
+  data.tar.gz: 3c6570e28e20be4c471ca6313fe1f6da293927637d78594288da2043fcde7b4a810113df5038c2aa8f836c30e8045c47fe6dd48ee3123dfad1df4db67058839e

data/CHANGES.md

@@ -1,3 +1,11 @@
+# 4.9.0
+
+* Adds the `publisheronly` role for client token creation. See [#272](https://github.com/opentok/OpenTok-Ruby-SDK/pull/272)
+
+# 4.8.1
+
+* Fixes a bug with the `Archives#create` method. See [#269](https://github.com/opentok/OpenTok-Ruby-SDK/pull/269) and [#270](https://github.com/opentok/OpenTok-Ruby-SDK/pull/270)
+
 # 4.8.0
 
 * Add support for Captions API [#267](https://github.com/opentok/OpenTok-Ruby-SDK/pull/267)

data/README.md

@@ -20,6 +20,16 @@ The OpenTok Ruby SDK provides methods for:
 * Working with OpenTok [Experience Composers](https://tokbox.com/developer/guides/experience-composer)
 * Working with OpenTok [Audio Connector](https://tokbox.com/developer/guides/audio-connector)
 
+## Note!
+
+This library is designed to work with the Tokbox/OpenTok platform, part of the Vonage Video API. If you are looking to use the Vonage Video API and using the Vonage Customer Dashboard, you will want to install the [Vonage Server SDK for Ruby](https://github.com/Vonage/vonage-ruby-sdk), which includes support for the Vonage Video API.
+
+Not sure which exact platform you are using? Take a look at [this guide](https://api.support.vonage.com/hc/en-us/articles/10817774782492).
+
+If you are using the Tokbox platform, do not worry! The Tokbox platform is not going away, and this library will continue to be updated. While we encourage customers to check out the new Unified platform, there is no rush to switch. Both platforms run the exact same infrastructure and capabilities, with the main difference is a unified billing interface and easier access to [Vonage’s other CPaaS APIs](https://www.vonage.com/communications-apis/).
+
+If you are new to the Vonage Video API, head on over to the [Vonage Customer Dashboard](https://dashboard.vonage.com) to sign up for a developer account and check out the [Vonage Server SDK for Ruby](https://github.com/Vonage/vonage-ruby-sdk). 
+
 ## Installation
 
 ### Bundler (recommended):

data/lib/opentok/archive.rb

@@ -72,13 +72,14 @@ module OpenTok
     #   set to null. The download URL is obfuscated, and the file is only available from the URL for
     #   10 minutes. To generate a new URL, call the Archive.listArchives() or OpenTok.getArchive() method.
   class Archive
-    attr_reader :multi_archive_tag
+    attr_reader :multi_archive_tag, :stream_mode
     # @private
     def initialize(interface, json)
       @interface = interface
       # TODO: validate json fits schema
       @json = json
       @multi_archive_tag = @json['multiArchiveTag']
+      @stream_mode = @json['streamMode']
     end
 
     # A JSON-encoded string representation of the archive.

data/lib/opentok/archives.rb

@@ -39,11 +39,11 @@ module OpenTok
     #   (a video track is included). If you set both  <code>has_audio</code> and
     #   <code>has_video</code> to <code>false</code>, the call to the <code>create()</code>
     #   method results in an error.
-    # @option options [String] :multiArchiveTag (Optional) Set this to support recording multiple archives for the same session simultaneously. 
+    # @option options [String] :multi_archive_tag (Optional) Set this to support recording multiple archives for the same session simultaneously. 
     #    Set this to a unique string for each simultaneous archive of an ongoing session. You must also set this option when manually starting an archive 
     #    that is {https://tokbox.com/developer/guides/archiving/#automatic automatically archived}. Note that the `multiArchiveTag` value is not included
     #    in the response for the methods to {https://tokbox.com/developer/rest/#listing_archives list archives} and 
-    #    {https://tokbox.com/developer/rest/#retrieve_archive_info retrieve archive information}. If you do not specify a unique `multiArchiveTag`, 
+    #    {https://tokbox.com/developer/rest/#retrieve_archive_info retrieve archive information}. If you do not specify a unique `multi_archive_tag`, 
     #    you can only record one archive at a time for a given session. 
     #    {https://tokbox.com/developer/guides/archiving/#simultaneous-archives See Simultaneous archives}.
     # @option options [String] :output_mode Whether all streams in the archive are recorded
@@ -56,7 +56,7 @@ module OpenTok
     #  (HD portrait), or "1080x1920" (FHD portrait). This property only applies to composed archives. If you set
     #  this property and set the outputMode property to "individual", a call to the method
     #  results in an error.
-    # @option options [String] :streamMode (Optional) Whether streams included in the archive are selected
+    # @option options [String] :stream_mode (Optional) Whether streams included in the archive are selected
     #   automatically ("auto", the default) or manually ("manual"). When streams are selected automatically ("auto"),
     #   all streams in the session can be included in the archive. When streams are selected manually ("manual"),
     #   you specify streams to be included based on calls to the {Archives#add_stream} method. You can specify whether a
@@ -97,7 +97,16 @@ module OpenTok
         "Resolution cannot be supplied for individual output mode" if options.key?(:resolution) and options[:output_mode] == :individual
 
       # normalize opts so all keys are symbols and only include valid_opts
-      valid_opts = [ :name, :has_audio, :has_video, :output_mode, :resolution, :layout ]
+      valid_opts = [
+        :name,
+        :has_audio,
+        :has_video,
+        :output_mode,
+        :resolution,
+        :layout,
+        :multi_archive_tag,
+        :stream_mode
+      ]
       opts = options.inject({}) do |m,(k,v)|
         if valid_opts.include? k.to_sym
           m[k.to_sym] = v

data/lib/opentok/constants.rb

@@ -2,7 +2,7 @@ module OpenTok
   require "set"
   API_URL = "https://api.opentok.com"
   TOKEN_SENTINEL = "T1=="
-  ROLES = { subscriber: "subscriber", publisher: "publisher", moderator: "moderator" }
+  ROLES = { subscriber: "subscriber", publisher: "publisher", moderator: "moderator", publisheronly: "publisheronly" }
   ARCHIVE_MODES = ::Set.new([:manual, :always])
   AUTH_EXPIRE = 300
 end

data/lib/opentok/version.rb

@@ -1,4 +1,4 @@
 module OpenTok
   # @private
-  VERSION = '4.8.0'
+  VERSION = '4.9.0'
 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/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/shared/opentok_generates_tokens.rb

@@ -50,7 +50,29 @@ shared_examples "opentok generates tokens" do
       expect(expiring_token).to carry_valid_token_signature api_secret
     end
 
-    it "generates tokens with a role" do
+    it "generates tokens with a publisher role" do
+      role = :publisher
+      role_token = opentok.generate_token session_id, :role => role
+      expect(role_token).to be_an_instance_of String
+      expect(role_token).to carry_token_data :session_id => session_id
+      expect(role_token).to carry_token_data :api_key => api_key
+      expect(role_token).to carry_token_data :role => role
+      expect(role_token).to carry_token_data [:nonce, :create_time]
+      expect(role_token).to carry_valid_token_signature api_secret
+    end
+
+    it "generates tokens with a subscriber role" do
+      role = :subscriber
+      role_token = opentok.generate_token session_id, :role => role
+      expect(role_token).to be_an_instance_of String
+      expect(role_token).to carry_token_data :session_id => session_id
+      expect(role_token).to carry_token_data :api_key => api_key
+      expect(role_token).to carry_token_data :role => role
+      expect(role_token).to carry_token_data [:nonce, :create_time]
+      expect(role_token).to carry_valid_token_signature api_secret
+    end
+
+    it "generates tokens with a moderator role" do
       role = :moderator
       role_token = opentok.generate_token session_id, :role => role
       expect(role_token).to be_an_instance_of String
@@ -61,6 +83,17 @@ shared_examples "opentok generates tokens" do
       expect(role_token).to carry_valid_token_signature api_secret
     end
 
+    it "generates tokens with a publisheronly role" do
+      role = :publisheronly
+      role_token = opentok.generate_token session_id, :role => role
+      expect(role_token).to be_an_instance_of String
+      expect(role_token).to carry_token_data :session_id => session_id
+      expect(role_token).to carry_token_data :api_key => api_key
+      expect(role_token).to carry_token_data :role => role
+      expect(role_token).to carry_token_data [:nonce, :create_time]
+      expect(role_token).to carry_valid_token_signature api_secret
+    end
+
     it "generates tokens with data" do
       data = "name=Johnny"
       data_bearing_token = opentok.generate_token session_id, :data => data
@@ -97,6 +130,11 @@ shared_examples "opentok generates tokens" do
       expect(layout_class_bearing_token).to carry_valid_token_signature api_secret
     end
 
+    context "when the role is invalid" do
+      it "raises an error" do
+        expect {  opentok.generate_token session_id, :role => :invalid_role }.to raise_error
+      end
+    end
 
     # TODO a context about using a bad session_id
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentok
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Stijn Mathysen
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-06 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -246,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
@@ -354,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.4
 signing_key: 
 specification_version: 4
 summary: Ruby gem for the OpenTok API
@@ -366,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