opentok 4.9.0 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf1e7d0f61794792bf98909f86601643c30df2cb2343297dcca0e8df7397d93a
-  data.tar.gz: 2c336b28cd586be0f082770b8854fd7f222d4c7047ba060a2fe300c31bf2417f
+  metadata.gz: 454d2a2b89a14ec5af2ccb56e10c8a52d15eda5df4bf2f0f3274c4838499c8b4
+  data.tar.gz: d89e3eec35b639b3af4cc859291a4f1e464f197b5381333778112909ef1e11a7
 SHA512:
-  metadata.gz: 2730c26df934c6fb413f177db04bdc048ea58285bf2dbd640d90873a9f2670f31264141f08280cf393860eb8b11f7b525f2ef61e5d450d5c15d0fe0437addc5d
-  data.tar.gz: 3c6570e28e20be4c471ca6313fe1f6da293927637d78594288da2043fcde7b4a810113df5038c2aa8f836c30e8045c47fe6dd48ee3123dfad1df4db67058839e
+  metadata.gz: 38f6b630ff8ad46fb07ebf47093adb418174afd4c2917bd9cf0ce1514090d4e3c9c0d9f9f4e9165ffe059e004e4eb724b4ad028e29c419d33006d326595c1da4
+  data.tar.gz: d66dce967d068ade1412c2b2fc23b80ba2a71eb528be1c8dab33dcf04813db2d0dbdb81b85a82b5c512dd0c5f4e777be61009422e51c4bf02e1d946adac00e1f

data/.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        ruby: [2.5, 2.6, 2.7, 3.0]
+        ruby: [3.0, 3.1, 3.2, 3.3]
         exclude:
           - os: windows-latest
             ruby: 3.0

data/CHANGES.md

@@ -1,3 +1,11 @@
+# 4.12.0
+
+* Updating the `Archives#create` method to allow `max_bitrate` as an option. See [#288](https://github.com/opentok/OpenTok-Ruby-SDK/pull/288)
+
+# 4.11.0
+
+* Updating client token creation to use JWTs by default. See [#287](https://github.com/opentok/OpenTok-Ruby-SDK/pull/274)
+
 # 4.9.0
 
 * Adds the `publisheronly` role for client token creation. See [#272](https://github.com/opentok/OpenTok-Ruby-SDK/pull/272)

data/Gemfile

@@ -1,4 +1,6 @@
 source "http://rubygems.org"
 
+gem "pry"
+
 # Specify your gem's dependencies in opentok.gemspec
 gemspec

data/lib/opentok/archives.rb

@@ -79,6 +79,10 @@ module OpenTok
     #   layout type. For more information, see
     #   {https://tokbox.com/developer/guides/archiving/layout-control.html Customizing
     #   the video layout for composed archives}.
+    # @option options [Integer] :max_bitrate (Optional) The maximum video bitrate for the archive, in bits per second. The minimum 
+    #   value is 100,000 and the maximum is 6,000,000. This option is only valid for composed archives. Set the maximum video bitrate
+    #   to control the size of the composed archive. This maximum bitrate applies to the video bitrate only. If the output archive has
+    #   audio, those bits will be excluded from the limit.
     #
     # @return [Archive] The Archive object, which includes properties defining the archive,
     #   including the archive ID.
@@ -105,7 +109,8 @@ module OpenTok
         :resolution,
         :layout,
         :multi_archive_tag,
-        :stream_mode
+        :stream_mode,
+        :max_bitrate
       ]
       opts = options.inject({}) do |m,(k,v)|
         if valid_opts.include? k.to_sym

data/lib/opentok/opentok.rb

@@ -36,6 +36,7 @@ module OpenTok
   #     the token.
   #
   #   @param [Hash] options A hash defining options for the token.
+  #   @option options [String] :token_type The type of token to generate. Must be one of 'T1' or 'JWT'. 'JWT' is the default.
   #   @option options [Symbol] :role The role for the token. Set this to one of the following
   #     values:
   #     * <code>:subscriber</code> -- A subscriber can only subscribe to streams.

data/lib/opentok/session.rb

@@ -28,6 +28,7 @@ module OpenTok
   #   Generates a token.
   #
   #   @param [Hash] options
+  #   @option options [String] :token_type The type of token to generate. Must be one of 'T1' or 'JWT'. 'JWT' is the default.
   #   @option options [Symbol] :role The role for the token. Set this to one of the following
   #     values:
   #     * <code>:subscriber</code> -- A subscriber can only subscribe to streams.

data/lib/opentok/token_generator.rb

@@ -6,10 +6,13 @@ require "addressable/uri"
 require "openssl"
 require "active_support"
 require "active_support/time"
+require "jwt"
 
 module OpenTok
   # @private
   module TokenGenerator
+    VALID_TOKEN_TYPES = ['T1', 'JWT'].freeze
+
     # this works when using include TokenGenerator
     def self.included(base)
       base.extend(ClassMethods)
@@ -33,7 +36,14 @@ module OpenTok
           end
           dynamic_args.compact!
           args = args.first(4-dynamic_args.length)
-          self.class.generate_token.call(*dynamic_args, *args)
+          token_type = if args.any? && args.last.is_a?(Hash) && args.last.has_key?(:token_type)
+            args.last[:token_type].upcase
+          else
+            "JWT"
+          end
+          raise "'#{token_type}' is not a valid token type. Must be one of: #{VALID_TOKEN_TYPES.join(', ')}" unless VALID_TOKEN_TYPES.include? token_type
+
+          self.class.generate_token(token_type).call(*dynamic_args, *args)
         end
       end
 
@@ -43,14 +53,14 @@ module OpenTok
       end
 
       # Generates a token
-      def generate_token
-        TokenGenerator::GENERATE_TOKEN_LAMBDA
+      def generate_token(token_type)
+        token_type == 'T1' ? TokenGenerator::GENERATE_T1_TOKEN_LAMBDA : TokenGenerator::GENERATE_JWT_LAMBDA
       end
 
     end
 
     # @private TODO: this probably doesn't need to be a constant anyone can read
-    GENERATE_TOKEN_LAMBDA = ->(api_key, api_secret, session_id, opts = {}) do
+    GENERATE_T1_TOKEN_LAMBDA = ->(api_key, api_secret, session_id, opts = {}) do
       # normalize required data params
       role = opts.fetch(:role, :publisher)
       unless ROLES.has_key? role
@@ -101,6 +111,52 @@ module OpenTok
       TOKEN_SENTINEL + Base64.strict_encode64(meta_string + ":" + data_string)
     end
 
+    GENERATE_JWT_LAMBDA = ->(api_key, api_secret, session_id, opts = {}) do
+      # normalize required data params
+      role = opts.fetch(:role, :publisher)
+      unless ROLES.has_key? role
+        raise "'#{role}' is not a recognized role"
+      end
+      unless Session.belongs_to_api_key? session_id.to_s, api_key
+        raise "Cannot generate token for a session_id that doesn't belong to api_key: #{api_key}"
+      end
+
+      # minimum data params
+      data_params = {
+        :iss => api_key,
+        :ist => "project",
+        :iat => Time.now.to_i,
+        :nonce => Random.rand,
+        :role => role,
+        :scope => "session.connect",
+        :session_id => session_id,
+      }
+
+      # normalize and add additional data params
+      unless (expire_time = opts[:expire_time].to_i) == 0
+        unless expire_time.between?(Time.now.to_i, (Time.now + 30.days).to_i)
+          raise "Expire time must be within the next 30 days"
+        end
+        data_params[:exp] = expire_time.to_i
+      end
+
+      unless opts[:data].nil?
+        unless (data = opts[:data].to_s).length < 1000
+          raise "Connection data must be less than 1000 characters"
+        end
+        data_params[:connection_data] = data
+      end
+
+      if opts[:initial_layout_class_list]
+        if opts[:initial_layout_class_list].is_a?(Array)
+          data_params[:initial_layout_class_list] = opts[:initial_layout_class_list].join(' ')
+        else
+          data_params[:initial_layout_class_list] = opts[:initial_layout_class_list].to_s
+        end
+      end
+
+      JWT.encode(data_params, api_secret, 'HS256', header_fields={typ: 'JWT'})
+    end
 
     # this works when using extend TokenGenerator
     # def generates_tokens(method_opts)

data/lib/opentok/version.rb

@@ -1,4 +1,4 @@
 module OpenTok
   # @private
-  VERSION = '4.9.0'
+  VERSION = '4.12.0'
 end

data/spec/cassettes/OpenTok_Archives/should_create_an_archive_with_maxBitrate_set_to_specified_max_bitrate_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","maxBitrate":200000}'
+    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, 07 Feb 2025 12:17: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,
+          "maxBitrate": 200000
+        }
+  recorded_at: Fri, 07 Feb 2025 12:17:20 GMT
+recorded_with: VCR 6.0.0

data/spec/matchers/token.rb

@@ -3,8 +3,9 @@ require "rspec/matchers"
 require "base64"
 require "openssl"
 require "addressable/uri"
+require "jwt"
 
-RSpec::Matchers.define :carry_token_data do |input_data|
+RSpec::Matchers.define :carry_t1_token_data do |input_data|
   option_to_token_key = {
     :api_key => :partner_id,
     :data => :connection_data,
@@ -37,7 +38,7 @@ RSpec::Matchers.define :carry_token_data do |input_data|
   end
 end
 
-RSpec::Matchers.define :carry_valid_token_signature do |api_secret|
+RSpec::Matchers.define :carry_valid_t1_token_signature do |api_secret|
   match do |token|
     decoded_token = Base64.decode64(token[4..token.length])
     metadata, data_string = decoded_token.split(':')
@@ -48,3 +49,34 @@ RSpec::Matchers.define :carry_valid_token_signature do |api_secret|
     signature == OpenSSL::HMAC.hexdigest(digest, api_secret, data_string)
   end
 end
+
+RSpec::Matchers.define :carry_jwt_token_data do |input_data|
+  match do |token|
+    decoded_token = JWT.decode(token, nil, false)
+    token_data = decoded_token.first.transform_keys {|k| k.to_sym}.transform_values {|v| v.to_s}
+    check_token_data = lambda { |key, value|
+      if token_data.has_key? key
+        unless value.nil?
+          return token_data[key] == value.to_s
+        end
+        return true
+      end
+      false
+    }
+    unless input_data.respond_to? :all?
+      return check_token_data.call(input_data, nil)
+    end
+    input_data.all? { |k, v| check_token_data.call(k, v) }
+  end
+end
+
+RSpec::Matchers.define :carry_valid_jwt_token_signature do |api_secret|
+  match do |token|
+    begin
+      JWT.decode(token, api_secret, true)
+    rescue
+      return false
+    end
+    true
+  end
+end

data/spec/opentok/archives_spec.rb

@@ -70,6 +70,13 @@ describe OpenTok::Archives do
     expect(archive.stream_mode).to eq stream_mode
   end
 
+  it "should create an archive with maxBitrate set to specified max_bitrate value", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    max_bitrate = 200000
+    archive = archives.create session_id, :max_bitrate => max_bitrate
+    expect(archive).to be_an_instance_of OpenTok::Archive
+    expect(archive.max_bitrate).to eq max_bitrate
+  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/session_spec.rb

@@ -72,5 +72,4 @@ describe OpenTok::Session do
     end
     include_examples "session generates tokens"
   end
-
 end

data/spec/shared/opentok_generates_tokens.rb

@@ -15,124 +15,284 @@ shared_examples "opentok generates tokens" do
     let(:api_secret) { "1234567890abcdef1234567890abcdef1234567890" }
     let(:session_id) { "1_MX4xMjM0NTZ-flNhdCBNYXIgMTUgMTQ6NDI6MjMgUERUIDIwMTR-MC40OTAxMzAyNX4" }
     let(:default_role) { :publisher }
+    let(:ist) { "project" }
+    let(:scope) { "session.connect" }
 
-    it "generates plain tokens" do
-      plain_token = opentok.generate_token session_id
-      expect(plain_token).to be_an_instance_of String
-      expect(plain_token).to carry_token_data :session_id => session_id
-      expect(plain_token).to carry_token_data :api_key => api_key
-      expect(plain_token).to carry_token_data :role => default_role
-      expect(plain_token).to carry_token_data [:nonce, :create_time]
-      expect(plain_token).to carry_valid_token_signature api_secret
-    end
+    context "when token type is T1" do
+      it "generates plain tokens" do
+        plain_token = opentok.generate_token session_id, :token_type => "T1"
+        expect(plain_token).to be_an_instance_of String
+        expect(plain_token).to carry_t1_token_data :session_id => session_id
+        expect(plain_token).to carry_t1_token_data :api_key => api_key
+        expect(plain_token).to carry_t1_token_data :role => default_role
+        expect(plain_token).to carry_t1_token_data [:nonce, :create_time]
+        expect(plain_token).to carry_valid_t1_token_signature api_secret
+      end
 
-    it "generates tokens with an expire time" do
-      expire_time = Time.now + (60*60*24)
-      expiring_token = opentok.generate_token session_id, :expire_time => expire_time
-      expect(expiring_token).to be_an_instance_of String
-      expect(expiring_token).to carry_token_data :session_id => session_id
-      expect(expiring_token).to carry_token_data :api_key => api_key
-      expect(expiring_token).to carry_token_data :role => default_role
-      expect(expiring_token).to carry_token_data :expire_time => expire_time.to_i
-      expect(expiring_token).to carry_token_data [:nonce, :create_time]
-      expect(expiring_token).to carry_valid_token_signature api_secret
-    end
+      it "generates tokens with an expire time" do
+        expire_time = Time.now + (60*60*24)
+        expiring_token = opentok.generate_token session_id, :expire_time => expire_time, :token_type => "T1"
+        expect(expiring_token).to be_an_instance_of String
+        expect(expiring_token).to carry_t1_token_data :session_id => session_id
+        expect(expiring_token).to carry_t1_token_data :api_key => api_key
+        expect(expiring_token).to carry_t1_token_data :role => default_role
+        expect(expiring_token).to carry_t1_token_data :expire_time => expire_time.to_i
+        expect(expiring_token).to carry_t1_token_data [:nonce, :create_time]
+        expect(expiring_token).to carry_valid_t1_token_signature api_secret
+      end
 
-    it "generates tokens with an integer expire time" do
-      expire_time = Time.now.to_i + (60*60*24)
-      expiring_token = opentok.generate_token session_id, :expire_time => expire_time
-      expect(expiring_token).to be_an_instance_of String
-      expect(expiring_token).to carry_token_data :session_id => session_id
-      expect(expiring_token).to carry_token_data :api_key => api_key
-      expect(expiring_token).to carry_token_data :role => default_role
-      expect(expiring_token).to carry_token_data :expire_time => expire_time
-      expect(expiring_token).to carry_token_data [:nonce, :create_time]
-      expect(expiring_token).to carry_valid_token_signature api_secret
-    end
+      it "generates tokens with an integer expire time" do
+        expire_time = Time.now.to_i + (60*60*24)
+        expiring_token = opentok.generate_token session_id, :expire_time => expire_time, :token_type => "T1"
+        expect(expiring_token).to be_an_instance_of String
+        expect(expiring_token).to carry_t1_token_data :session_id => session_id
+        expect(expiring_token).to carry_t1_token_data :api_key => api_key
+        expect(expiring_token).to carry_t1_token_data :role => default_role
+        expect(expiring_token).to carry_t1_token_data :expire_time => expire_time
+        expect(expiring_token).to carry_t1_token_data [:nonce, :create_time]
+        expect(expiring_token).to carry_valid_t1_token_signature api_secret
+      end
 
-    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 publisher role" do
+        role = :publisher
+        role_token = opentok.generate_token session_id, :role => role, :token_type => "T1"
+        expect(role_token).to be_an_instance_of String
+        expect(role_token).to carry_t1_token_data :session_id => session_id
+        expect(role_token).to carry_t1_token_data :api_key => api_key
+        expect(role_token).to carry_t1_token_data :role => role
+        expect(role_token).to carry_t1_token_data [:nonce, :create_time]
+        expect(role_token).to carry_valid_t1_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 subscriber role" do
+        role = :subscriber
+        role_token = opentok.generate_token session_id, :role => role, :token_type => "T1"
+        expect(role_token).to be_an_instance_of String
+        expect(role_token).to carry_t1_token_data :session_id => session_id
+        expect(role_token).to carry_t1_token_data :api_key => api_key
+        expect(role_token).to carry_t1_token_data :role => role
+        expect(role_token).to carry_t1_token_data [:nonce, :create_time]
+        expect(role_token).to carry_valid_t1_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
-      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, :token_type => "T1"
+        expect(role_token).to be_an_instance_of String
+        expect(role_token).to carry_t1_token_data :session_id => session_id
+        expect(role_token).to carry_t1_token_data :api_key => api_key
+        expect(role_token).to carry_t1_token_data :role => role
+        expect(role_token).to carry_t1_token_data [:nonce, :create_time]
+        expect(role_token).to carry_valid_t1_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 a publisheronly role" do
+        role = :publisheronly
+        role_token = opentok.generate_token session_id, :role => role, :token_type => "T1"
+        expect(role_token).to be_an_instance_of String
+        expect(role_token).to carry_t1_token_data :session_id => session_id
+        expect(role_token).to carry_t1_token_data :api_key => api_key
+        expect(role_token).to carry_t1_token_data :role => role
+        expect(role_token).to carry_t1_token_data [:nonce, :create_time]
+        expect(role_token).to carry_valid_t1_token_signature api_secret
+      end
 
-    it "generates tokens with data" do
-      data = "name=Johnny"
-      data_bearing_token = opentok.generate_token session_id, :data => data
-      expect(data_bearing_token).to be_an_instance_of String
-      expect(data_bearing_token).to carry_token_data :session_id => session_id
-      expect(data_bearing_token).to carry_token_data :api_key => api_key
-      expect(data_bearing_token).to carry_token_data :role => default_role
-      expect(data_bearing_token).to carry_token_data :data => data
-      expect(data_bearing_token).to carry_token_data [:nonce, :create_time]
-      expect(data_bearing_token).to carry_valid_token_signature api_secret
+      it "generates tokens with data" do
+        data = "name=Johnny"
+        data_bearing_token = opentok.generate_token session_id, :data => data, :token_type => "T1"
+        expect(data_bearing_token).to be_an_instance_of String
+        expect(data_bearing_token).to carry_t1_token_data :session_id => session_id
+        expect(data_bearing_token).to carry_t1_token_data :api_key => api_key
+        expect(data_bearing_token).to carry_t1_token_data :role => default_role
+        expect(data_bearing_token).to carry_t1_token_data :data => data
+        expect(data_bearing_token).to carry_t1_token_data [:nonce, :create_time]
+        expect(data_bearing_token).to carry_valid_t1_token_signature api_secret
+      end
+
+      it "generates tokens with initial layout classes" do
+        layout_classes = ["focus", "small"]
+        layout_class_bearing_token = opentok.generate_token session_id, :initial_layout_class_list => layout_classes, :token_type => "T1"
+        expect(layout_class_bearing_token).to be_an_instance_of String
+        expect(layout_class_bearing_token).to carry_t1_token_data :session_id => session_id
+        expect(layout_class_bearing_token).to carry_t1_token_data :api_key => api_key
+        expect(layout_class_bearing_token).to carry_t1_token_data :role => default_role
+        expect(layout_class_bearing_token).to carry_t1_token_data :initial_layout_class_list => layout_classes.join(' ')
+        expect(layout_class_bearing_token).to carry_t1_token_data [:nonce, :create_time]
+        expect(layout_class_bearing_token).to carry_valid_t1_token_signature api_secret
+      end
+
+      it "generates tokens with one initial layout class" do
+        layout_class = "focus"
+        layout_class_bearing_token = opentok.generate_token session_id, :initial_layout_class_list => layout_class, :token_type => "T1"
+        expect(layout_class_bearing_token).to be_an_instance_of String
+        expect(layout_class_bearing_token).to carry_t1_token_data :session_id => session_id
+        expect(layout_class_bearing_token).to carry_t1_token_data :api_key => api_key
+        expect(layout_class_bearing_token).to carry_t1_token_data :role => default_role
+        expect(layout_class_bearing_token).to carry_t1_token_data :initial_layout_class_list => layout_class
+        expect(layout_class_bearing_token).to carry_t1_token_data [:nonce, :create_time]
+        expect(layout_class_bearing_token).to carry_valid_t1_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, :token_type => "T1" }.to raise_error
+        end
+      end
     end
 
-    it "generates tokens with initial layout classes" do
-      layout_classes = ["focus", "small"]
-      layout_class_bearing_token = opentok.generate_token session_id, :initial_layout_class_list => layout_classes
-      expect(layout_class_bearing_token).to be_an_instance_of String
-      expect(layout_class_bearing_token).to carry_token_data :session_id => session_id
-      expect(layout_class_bearing_token).to carry_token_data :api_key => api_key
-      expect(layout_class_bearing_token).to carry_token_data :role => default_role
-      expect(layout_class_bearing_token).to carry_token_data :initial_layout_class_list => layout_classes.join(' ')
-      expect(layout_class_bearing_token).to carry_token_data [:nonce, :create_time]
-      expect(layout_class_bearing_token).to carry_valid_token_signature api_secret
+    context "when token type is JWT" do
+      it "generates plain tokens" do
+        plain_token = opentok.generate_token session_id, :token_type => "JWT"
+        expect(plain_token).to be_an_instance_of String
+        expect(plain_token).to carry_jwt_token_data :session_id => session_id
+        expect(plain_token).to carry_jwt_token_data :iss => api_key
+        expect(plain_token).to carry_jwt_token_data :ist => ist
+        expect(plain_token).to carry_jwt_token_data :scope => scope
+        expect(plain_token).to carry_jwt_token_data :role => default_role
+        expect(plain_token).to carry_jwt_token_data [:ist, :iat, :nonce]
+        expect(plain_token).to carry_valid_jwt_token_signature api_secret
+      end
+
+      it "generates tokens with a custom expire time" do
+        expire_time = Time.now + (60*60*24)
+        expiring_token = opentok.generate_token session_id, :expire_time => expire_time, :token_type => "JWT"
+        expect(expiring_token).to be_an_instance_of String
+        expect(expiring_token).to carry_jwt_token_data :session_id => session_id
+        expect(expiring_token).to carry_jwt_token_data :iss => api_key
+        expect(expiring_token).to carry_jwt_token_data :ist => ist
+        expect(expiring_token).to carry_jwt_token_data :scope => scope
+        expect(expiring_token).to carry_jwt_token_data :role => default_role
+        expect(expiring_token).to carry_jwt_token_data :exp => expire_time.to_i
+        expect(expiring_token).to carry_jwt_token_data [:ist, :iat, :nonce]
+        expect(expiring_token).to carry_valid_jwt_token_signature api_secret
+      end
+
+      it "generates tokens with an integer expire time" do
+        expire_time = Time.now.to_i + (60*60*24)
+        expiring_token = opentok.generate_token session_id, :expire_time => expire_time, :token_type => "JWT"
+        expect(expiring_token).to be_an_instance_of String
+        expect(expiring_token).to carry_jwt_token_data :session_id => session_id
+        expect(expiring_token).to carry_jwt_token_data :iss => api_key
+        expect(expiring_token).to carry_jwt_token_data :ist => ist
+        expect(expiring_token).to carry_jwt_token_data :scope => scope
+        expect(expiring_token).to carry_jwt_token_data :role => default_role
+        expect(expiring_token).to carry_jwt_token_data :exp => expire_time
+        expect(expiring_token).to carry_jwt_token_data [:ist, :iat, :nonce]
+        expect(expiring_token).to carry_valid_jwt_token_signature api_secret
+      end
+
+      it "generates tokens with a publisher role" do
+        role = :publisher
+        role_token = opentok.generate_token session_id, :role => role, :token_type => "JWT"
+        expect(role_token).to be_an_instance_of String
+        expect(role_token).to carry_jwt_token_data :session_id => session_id
+        expect(role_token).to carry_jwt_token_data :iss => api_key
+        expect(role_token).to carry_jwt_token_data :ist => ist
+        expect(role_token).to carry_jwt_token_data :scope => scope
+        expect(role_token).to carry_jwt_token_data :role => role
+        expect(role_token).to carry_jwt_token_data [:ist, :iat, :nonce]
+        expect(role_token).to carry_valid_jwt_token_signature api_secret
+      end
+
+      it "generates tokens with a subscriber role" do
+        role = :subscriber
+        role_token = opentok.generate_token session_id, :role => role, :token_type => "JWT"
+        expect(role_token).to be_an_instance_of String
+        expect(role_token).to carry_jwt_token_data :session_id => session_id
+        expect(role_token).to carry_jwt_token_data :iss => api_key
+        expect(role_token).to carry_jwt_token_data :ist => ist
+        expect(role_token).to carry_jwt_token_data :scope => scope
+        expect(role_token).to carry_jwt_token_data :role => role
+        expect(role_token).to carry_jwt_token_data [:ist, :iat, :nonce]
+        expect(role_token).to carry_valid_jwt_token_signature api_secret
+      end
+
+      it "generates tokens with a moderator role" do
+        role = :moderator
+        role_token = opentok.generate_token session_id, :role => role, :token_type => "JWT"
+        expect(role_token).to be_an_instance_of String
+        expect(role_token).to carry_jwt_token_data :session_id => session_id
+        expect(role_token).to carry_jwt_token_data :iss => api_key
+        expect(role_token).to carry_jwt_token_data :ist => ist
+        expect(role_token).to carry_jwt_token_data :scope => scope
+        expect(role_token).to carry_jwt_token_data :role => role
+        expect(role_token).to carry_jwt_token_data [:ist, :iat, :nonce]
+        expect(role_token).to carry_valid_jwt_token_signature api_secret
+      end
+
+      it "generates tokens with a publisheronly role" do
+        role = :publisheronly
+        role_token = opentok.generate_token session_id, :role => role, :token_type => "JWT"
+        expect(role_token).to be_an_instance_of String
+        expect(role_token).to carry_jwt_token_data :session_id => session_id
+        expect(role_token).to carry_jwt_token_data :iss => api_key
+        expect(role_token).to carry_jwt_token_data :ist => ist
+        expect(role_token).to carry_jwt_token_data :scope => scope
+        expect(role_token).to carry_jwt_token_data :role => role
+        expect(role_token).to carry_jwt_token_data [:ist, :iat, :nonce]
+        expect(role_token).to carry_valid_jwt_token_signature api_secret
+      end
+
+      it "generates tokens with data" do
+        data = "name=Johnny"
+        data_bearing_token = opentok.generate_token session_id, :data => data, :token_type => "JWT"
+        expect(data_bearing_token).to be_an_instance_of String
+        expect(data_bearing_token).to carry_jwt_token_data :session_id => session_id
+        expect(data_bearing_token).to carry_jwt_token_data :iss => api_key
+        expect(data_bearing_token).to carry_jwt_token_data :ist => ist
+        expect(data_bearing_token).to carry_jwt_token_data :scope => scope
+        expect(data_bearing_token).to carry_jwt_token_data :role => default_role
+        expect(data_bearing_token).to carry_jwt_token_data :connection_data => data
+        expect(data_bearing_token).to carry_jwt_token_data [:ist, :iat, :nonce]
+        expect(data_bearing_token).to carry_valid_jwt_token_signature api_secret
+      end
+
+      it "generates tokens with initial layout classes" do
+        layout_classes = ["focus", "small"]
+        layout_class_bearing_token = opentok.generate_token session_id, :initial_layout_class_list => layout_classes, :token_type => "JWT"
+        expect(layout_class_bearing_token).to be_an_instance_of String
+        expect(layout_class_bearing_token).to carry_jwt_token_data :session_id => session_id
+        expect(layout_class_bearing_token).to carry_jwt_token_data :iss => api_key
+        expect(layout_class_bearing_token).to carry_jwt_token_data :ist => ist
+        expect(layout_class_bearing_token).to carry_jwt_token_data :scope => scope
+        expect(layout_class_bearing_token).to carry_jwt_token_data :role => default_role
+        expect(layout_class_bearing_token).to carry_jwt_token_data :initial_layout_class_list => layout_classes.join(' ')
+        expect(layout_class_bearing_token).to carry_jwt_token_data [:ist, :iat, :nonce]
+        expect(layout_class_bearing_token).to carry_valid_jwt_token_signature api_secret
+      end
+
+      it "generates tokens with one initial layout class" do
+        layout_class = "focus"
+        layout_class_bearing_token = opentok.generate_token session_id, :initial_layout_class_list => layout_class, :token_type => "JWT"
+        expect(layout_class_bearing_token).to be_an_instance_of String
+        expect(layout_class_bearing_token).to carry_jwt_token_data :session_id => session_id
+        expect(layout_class_bearing_token).to carry_jwt_token_data :iss => api_key
+        expect(layout_class_bearing_token).to carry_jwt_token_data :ist => ist
+        expect(layout_class_bearing_token).to carry_jwt_token_data :scope => scope
+        expect(layout_class_bearing_token).to carry_jwt_token_data :role => default_role
+        expect(layout_class_bearing_token).to carry_jwt_token_data :initial_layout_class_list => layout_class
+        expect(layout_class_bearing_token).to carry_jwt_token_data [:ist, :iat, :nonce]
+        expect(layout_class_bearing_token).to carry_valid_jwt_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, :token_type => "JWT" }.to raise_error
+        end
+      end
     end
 
-    it "generates tokens with one initial layout class" do
-      layout_class = "focus"
-      layout_class_bearing_token = opentok.generate_token session_id, :initial_layout_class_list => layout_class
-      expect(layout_class_bearing_token).to be_an_instance_of String
-      expect(layout_class_bearing_token).to carry_token_data :session_id => session_id
-      expect(layout_class_bearing_token).to carry_token_data :api_key => api_key
-      expect(layout_class_bearing_token).to carry_token_data :role => default_role
-      expect(layout_class_bearing_token).to carry_token_data :initial_layout_class_list => layout_class
-      expect(layout_class_bearing_token).to carry_token_data [:nonce, :create_time]
-      expect(layout_class_bearing_token).to carry_valid_token_signature api_secret
+    context "when token type is not specified" do
+      it "generates a JWT token by default" do
+        default_token = opentok.generate_token session_id
+        expect(default_token).to be_an_instance_of String
+        expect(default_token).to carry_valid_jwt_token_signature api_secret
+      end
     end
 
-    context "when the role is invalid" do
+    context "when token type is invalid" do
       it "raises an error" do
-        expect {  opentok.generate_token session_id, :role => :invalid_role }.to raise_error
+        expect {  opentok.generate_token session_id, :token_type => "invalid_token_type" }.to raise_error
       end
     end
 

data/spec/shared/session_generates_tokens.rb

@@ -15,52 +15,124 @@ shared_examples "session generates tokens" do
     let(:api_secret) { "1234567890abcdef1234567890abcdef1234567890" }
     let(:session_id) { "1_MX4xMjM0NTZ-flNhdCBNYXIgMTUgMTQ6NDI6MjMgUERUIDIwMTR-MC40OTAxMzAyNX4" }
     let(:default_role) { :publisher }
+    let(:ist) { "project" }
+    let(:scope) { "session.connect" }
 
-    it "generates plain tokens" do
-      plain_token = session.generate_token
-      expect(plain_token).to be_an_instance_of String
-      expect(plain_token).to carry_token_data :session_id => session_id
-      expect(plain_token).to carry_token_data :api_key => api_key
-      expect(plain_token).to carry_token_data :role => default_role
-      expect(plain_token).to carry_token_data [:nonce, :create_time]
-      expect(plain_token).to carry_valid_token_signature api_secret
-    end
+    context "when token type is T1" do
+      it "generates plain tokens" do
+        plain_token = session.generate_token :token_type => "T1"
+        expect(plain_token).to be_an_instance_of String
+        expect(plain_token).to carry_t1_token_data :session_id => session_id
+        expect(plain_token).to carry_t1_token_data :api_key => api_key
+        expect(plain_token).to carry_t1_token_data :role => default_role
+        expect(plain_token).to carry_t1_token_data [:nonce, :create_time]
+        expect(plain_token).to carry_valid_t1_token_signature api_secret
+      end
+
+      it "generates tokens with an expire time" do
+        expire_time = Time.now + (60*60*24)
+        expiring_token = session.generate_token :expire_time => expire_time, :token_type => "T1"
+        expect(expiring_token).to be_an_instance_of String
+        expect(expiring_token).to carry_t1_token_data :session_id => session_id
+        expect(expiring_token).to carry_t1_token_data :api_key => api_key
+        expect(expiring_token).to carry_t1_token_data :role => default_role
+        expect(expiring_token).to carry_t1_token_data :expire_time => expire_time.to_i
+        expect(expiring_token).to carry_t1_token_data [:nonce, :create_time]
+        expect(expiring_token).to carry_valid_t1_token_signature api_secret
+      end
 
-    it "generates tokens with an expire time" do
-      expire_time = Time.now + (60*60*24)
-      expiring_token = session.generate_token :expire_time => expire_time
-      expect(expiring_token).to be_an_instance_of String
-      expect(expiring_token).to carry_token_data :session_id => session_id
-      expect(expiring_token).to carry_token_data :api_key => api_key
-      expect(expiring_token).to carry_token_data :role => default_role
-      expect(expiring_token).to carry_token_data :expire_time => expire_time.to_i
-      expect(expiring_token).to carry_token_data [:nonce, :create_time]
-      expect(expiring_token).to carry_valid_token_signature api_secret
+      it "generates tokens with a role" do
+        role = :moderator
+        role_token = session.generate_token :role => role, :token_type => "T1"
+        expect(role_token).to be_an_instance_of String
+        expect(role_token).to carry_t1_token_data :session_id => session_id
+        expect(role_token).to carry_t1_token_data :api_key => api_key
+        expect(role_token).to carry_t1_token_data :role => role
+        expect(role_token).to carry_t1_token_data [:nonce, :create_time]
+        expect(role_token).to carry_valid_t1_token_signature api_secret
+      end
+
+      it "generates tokens with data" do
+        data = "name=Johnny"
+        data_bearing_token = session.generate_token :data => data, :token_type => "T1"
+        expect(data_bearing_token).to be_an_instance_of String
+        expect(data_bearing_token).to carry_t1_token_data :session_id => session_id
+        expect(data_bearing_token).to carry_t1_token_data :api_key => api_key
+        expect(data_bearing_token).to carry_t1_token_data :role => default_role
+        expect(data_bearing_token).to carry_t1_token_data :data => data
+        expect(data_bearing_token).to carry_t1_token_data [:nonce, :create_time]
+        expect(data_bearing_token).to carry_valid_t1_token_signature api_secret
+      end
     end
 
-    it "generates tokens with a role" do
-      role = :moderator
-      role_token = session.generate_token :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
+    context "when token type is JWT" do
+      it "generates plain tokens" do
+        plain_token = session.generate_token :token_type => "JWT"
+        expect(plain_token).to be_an_instance_of String
+        expect(plain_token).to carry_jwt_token_data :session_id => session_id
+        expect(plain_token).to carry_jwt_token_data :iss => api_key
+        expect(plain_token).to carry_jwt_token_data :ist => ist
+        expect(plain_token).to carry_jwt_token_data :scope => scope
+        expect(plain_token).to carry_jwt_token_data :role => default_role
+        expect(plain_token).to carry_jwt_token_data [:ist, :iat, :nonce]
+        expect(plain_token).to carry_valid_jwt_token_signature api_secret
+      end
+
+      it "generates tokens with a custom expire time" do
+        expire_time = Time.now + (60*60*24)
+        expiring_token = session.generate_token :expire_time => expire_time, :token_type => "JWT"
+        expect(expiring_token).to be_an_instance_of String
+        expect(expiring_token).to carry_jwt_token_data :session_id => session_id
+        expect(expiring_token).to carry_jwt_token_data :iss => api_key
+        expect(expiring_token).to carry_jwt_token_data :ist => ist
+        expect(expiring_token).to carry_jwt_token_data :scope => scope
+        expect(expiring_token).to carry_jwt_token_data :role => default_role
+        expect(expiring_token).to carry_jwt_token_data :exp => expire_time.to_i
+        expect(expiring_token).to carry_jwt_token_data [:ist, :iat, :nonce]
+        expect(expiring_token).to carry_valid_jwt_token_signature api_secret
+      end
+
+      it "generates tokens with a non-default role" do
+        role = :moderator
+        role_token = session.generate_token :role => role, :token_type => "JWT"
+        expect(role_token).to be_an_instance_of String
+        expect(role_token).to carry_jwt_token_data :session_id => session_id
+        expect(role_token).to carry_jwt_token_data :iss => api_key
+        expect(role_token).to carry_jwt_token_data :ist => ist
+        expect(role_token).to carry_jwt_token_data :scope => scope
+        expect(role_token).to carry_jwt_token_data :role => role
+        expect(role_token).to carry_jwt_token_data [:ist, :iat, :nonce]
+        expect(role_token).to carry_valid_jwt_token_signature api_secret
+      end
+
+      it "generates tokens with data" do
+        data = "name=Johnny"
+        data_bearing_token = session.generate_token :data => data, :token_type => "JWT"
+        expect(data_bearing_token).to be_an_instance_of String
+        expect(data_bearing_token).to carry_jwt_token_data :session_id => session_id
+        expect(data_bearing_token).to carry_jwt_token_data :iss => api_key
+        expect(data_bearing_token).to carry_jwt_token_data :ist => ist
+        expect(data_bearing_token).to carry_jwt_token_data :scope => scope
+        expect(data_bearing_token).to carry_jwt_token_data :role => default_role
+        expect(data_bearing_token).to carry_jwt_token_data :connection_data => data
+        expect(data_bearing_token).to carry_jwt_token_data [:ist, :iat, :nonce]
+        expect(data_bearing_token).to carry_valid_jwt_token_signature api_secret
+      end
     end
 
-    it "generates tokens with data" do
-      data = "name=Johnny"
-      data_bearing_token = session.generate_token :data => data
-      expect(data_bearing_token).to be_an_instance_of String
-      expect(data_bearing_token).to carry_token_data :session_id => session_id
-      expect(data_bearing_token).to carry_token_data :api_key => api_key
-      expect(data_bearing_token).to carry_token_data :role => default_role
-      expect(data_bearing_token).to carry_token_data :data => data
-      expect(data_bearing_token).to carry_token_data [:nonce, :create_time]
-      expect(data_bearing_token).to carry_valid_token_signature api_secret
+    context "when token type is not specified" do
+      it "generates a JWT token by default" do
+        default_token = session.generate_token
+        expect(default_token).to be_an_instance_of String
+        expect(default_token).to carry_valid_jwt_token_signature api_secret
+      end
     end
 
+    context "when token type is invalid" do
+      it "raises an error" do
+        expect {  session.generate_token :token_type => "invalid_token_type" }.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.9.0
+  version: 4.12.0
 platform: ruby
 authors:
 - Stijn Mathysen
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-22 00:00:00.000000000 Z
+date: 2025-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -245,6 +245,7 @@ files:
 - 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_an_archive_with_matching_multi_archive_tag_when_multiArchiveTag_is_specified.yml
+- spec/cassettes/OpenTok_Archives/should_create_an_archive_with_maxBitrate_set_to_specified_max_bitrate_value.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
@@ -366,6 +367,7 @@ test_files:
 - 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_an_archive_with_matching_multi_archive_tag_when_multiArchiveTag_is_specified.yml
+- spec/cassettes/OpenTok_Archives/should_create_an_archive_with_maxBitrate_set_to_specified_max_bitrate_value.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