opentok 4.5.1 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78dc7ec3b0d8d3097e687cc0e7b76d2c9d18e3969372c54a00e3c4f3c95846ed
-  data.tar.gz: e8c10144c89329205734d7d0dd5c8fb37197c2af0a50401a1d97ec1cbfe9e837
+  metadata.gz: '019bb7945d8571c4805cab88854fd49914fac7fbb7169b2b1351fa393237ea46'
+  data.tar.gz: 9f167173216875bbc1b52bd2239c7fff7e9ff49c4aa92c28e6541d9fb178782d
 SHA512:
-  metadata.gz: 9b481dc1985ffa39e3c371c2d67fc3b6e7b1cdc696db7e21274bea45e0784984facb5cdfdda92bc14f3366af243e8c01f448bc5ddb7cba52e935a8c97bd15694
-  data.tar.gz: f776558162063de46f8e7e4da99032ec771171098f7cc2e4a2c260374061ec0c840d479e530b2efb24f8ad3754f0da95a27c12a24cdd97c0013680ac31e5b5f7
+  metadata.gz: e24be36a973fd9fe2ed63a620dbff3f0cb2fa24939318fd0f353a76374c8c09e4e46c8c920e223015c6b536dfbeddc2d94e75909f6cc3fbb54e6b39f85077402
+  data.tar.gz: 29b06c9529e61f19208d0c875ddf0caba12652afaaa4f87f59760a3c664a69b6a1686f200f1793a730b8518ec1d2f99cbd0ea7a29ee7ab2c5bcc7d42cb2b2af6

data/CHANGES.md

@@ -1,3 +1,13 @@
+# 4.7.0
+
+* Adds support for the End-to-end encryption (E2EE) feature [#259](https://github.com/opentok/OpenTok-Ruby-SDK/pull/259)
+* Implements Auto-archive improvements [#262](https://github.com/opentok/OpenTok-Ruby-SDK/pull/262)
+* Updates the README to explain appending a custom value to the `UserAgent` header [#263](https://github.com/opentok/OpenTok-Ruby-SDK/pull/263)
+
+# 4.6.0
+
+* Adds functionality for working with the Audio Connector feature [#247](https://github.com/opentok/OpenTok-Ruby-SDK/pull/247)
+
 # 4.5.1
 
 * Fixes issue with uninitialized constant by adding missing `require` statement [#256](https://github.com/opentok/OpenTok-Ruby-SDK/pull/256)

data/README.md

@@ -18,6 +18,7 @@ The OpenTok Ruby SDK provides methods for:
 * [Disconnecting clients from sessions](https://tokbox.com/developer/guides/moderation/rest/)
 * [Forcing clients in a session to disconnect or mute published audio](https://tokbox.com/developer/guides/moderation/)
 * Working with OpenTok [Experience Composers](https://tokbox.com/developer/guides/experience-composer)
+* Working with OpenTok [Audio Connector](https://tokbox.com/developer/guides/audio-connector)
 
 ## Installation
 
@@ -58,6 +59,8 @@ opentok = OpenTok::OpenTok.new api_key, api_secret
 
 #### Initialization Options
 
+**Custom Timeout**
+
 You can specify a custom timeout value for HTTP requests when initializing a new `OpenTok::OpenTok`
 object:
 
@@ -70,6 +73,23 @@ opentok = OpenTok::OpenTok.new api_key, api_secret, :timeout_length => 10
 The value for `:timeout_length` is an integer representing the number of seconds to wait for an HTTP
 request to complete. The default is set to 2 seconds.
 
+**UA Addendum**
+
+You can also append a custom string to the `User-Agent` header value for HTTP requests when initializing a new `OpenTok::OpenTok`
+object:
+
+```ruby
+require "opentok"
+
+opentok = OpenTok::OpenTok.new api_key, api_secret, :ua_addendum => 'FOO'
+```
+
+The above would generate a `User-Agent` header something like this:
+
+```
+User-Agent: OpenTok-Ruby-SDK/4.6.0-Ruby-Version-3.1.2-p20 FOO
+```
+
 ### Creating Sessions
 
 To create an OpenTok Session, use the `OpenTok#create_session(properties)` method.
@@ -100,6 +120,9 @@ session = opentok.create_session :location => '12.34.56.78'
 # A session with automatic archiving (must use the routed media mode):
 session = opentok.create_session :archive_mode => :always, :media_mode => :routed
 
+# A session with end-to-end encryption (must use the routed media mode):
+session = opentok.create_session :e2ee => true, :media_mode => :routed
+
 # Store this sessionId in the database for later use:
 session_id = session.session_id
 ```
@@ -188,7 +211,10 @@ archive = opentok.archives.create session_id :output_mode => :individual
 The `:output_mode => :composed` setting (the default) causes all streams in the archive to be
 recorded to a single (composed) file.
 
-For composed archives you can set the resolution of the archive, either "640x480" (SD landscape, the default), "1280x720" (HD landscape), "1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" (FHD portrait).. The `resolution` parameter is optional and could be included in the options
+For composed archives you can set the resolution of the archive, either "640x480"
+(SD landscape, the default), "1280x720" (HD landscape), "1920x1080" (FHD landscape),
+"480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" (FHD portrait).
+The `resolution` parameter is optional and could be included in the options
 hash (second argument) of the `opentok.archives.create()` method.
 
 ```ruby
@@ -322,7 +348,7 @@ For more information on archiving, see the
 
 ### Signaling
 
-You can send a signal using the `opentok.signals.send(session_id, connection_id, opts)` method.  
+You can send a signal using the `opentok.signals.send(session_id, connection_id, opts)` method.
 If `connection_id` is nil or an empty string, then the signal is send to all valid connections in
 the session.
 
@@ -457,7 +483,7 @@ You can cause a client to be forced to disconnect from a session by using the
 
 ### Forcing clients in a session to mute published audio
 
-You can force the publisher of a specific stream to stop publishing audio using the 
+You can force the publisher of a specific stream to stop publishing audio using the
 `opentok.streams.force_mute(session_id, stream_id)` method.
 
 You can force the publisher of all streams in a session (except for an optional list of streams)
@@ -495,6 +521,11 @@ You can stop an Experience Composer by calling the `opentok.renders.stop(render_
 You can get information about Experience Composers by calling the `opentok.renders.find(render_id)`
 and `opentok.renders.list(options)` methods.
 
+### Working with Audio Connector
+
+You can start an [Audio Connector](https://tokbox.com/developer/guides/audio-connector) WebSocket
+by calling the `opentok.websocket.connect()` method.
+
 ## Samples
 
 There are three sample applications included in this repository. To get going as fast as possible, clone the whole

data/lib/opentok/client.rb

@@ -298,6 +298,35 @@ module OpenTok
       raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
     end
 
+    def connect_websocket(session_id, token, websocket_uri, opts)
+      opts.extend(HashExtensions)
+      body = { "sessionId" => session_id,
+               "token" => token,
+               "websocket" => { "uri" => websocket_uri }.merge(opts.camelize_keys!)
+      }
+
+      response = self.class.post("/v2/project/#{@api_key}/connect", {
+        :body => body.to_json,
+        :headers => generate_headers("Content-Type" => "application/json")
+      })
+      case response.code
+      when 200
+        response
+      when 400
+        raise ArgumentError, "One of the properties is invalid."
+      when 403
+        raise OpenTokAuthenticationError, "You are not authorized to start the call, check your authentication information."
+      when 409
+        raise OpenTokWebSocketError, "Conflict. Only routed sessions are allowed to initiate Connect Calls."
+      when 500
+        raise OpenTokError, "OpenTok server error."
+      else
+        raise OpenTokWebSocketError, "The WebSocket could not be connected"
+      end
+    rescue StandardError => e
+      raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
+    end
+
     def dial(session_id, token, sip_uri, opts)
       opts.extend(HashExtensions)
       body = { "sessionId" => session_id,

data/lib/opentok/exceptions.rb

@@ -14,7 +14,8 @@ module OpenTok
   class OpenTokStreamLayoutError < OpenTokError; end
   # Defines errors raised when you perform Broadcast operations.
   class OpenTokBroadcastError < OpenTokError; end
+  # Defines errors raised when connecting to WebSocket URIs.
+  class OpenTokWebSocketError < OpenTokError; end
   # Defines errors raised when you perform Experience Composer render operations.
   class OpenTokRenderError < OpenTokError; end
-  
 end

data/lib/opentok/opentok.rb

@@ -144,11 +144,26 @@ module OpenTok
     #     automatically (<code>:always</code>) or not (<code>:manual</code>). When using automatic
     #     archiving, the session must use the <code>:routed</code> media mode.
     #
+    # @option opts [Symbol] :archive_name The name to use for archives in auto-archived sessions.
+    #     When setting this option, the :archive_mode option must be set to :always or an error will result.
+    #     The length of the archive name can be up to 80 chars.
+    #     Due to encoding limitations the following special characters are translated to a colon (:) character: ~, -, _.
+    #     If you do not set a name and the archiveMode option is set to always, the archive name will be empty.
+    #
+    # @option opts [Symbol] :archive_resolution The resolution of archives in an auto-archived session.
+    #     Valid values are "480x640", "640x480" (the default), "720x1280", "1280x720", "1080x1920", and "1920x1080".
+    #     When setting this option, the :archive_mode option must be set to :always or an error will result.
+    #
+    # @option opts [true, false] :e2ee
+    #     (Boolean, optional) — Whether the session uses end-to-end encryption from client to client (default: false).
+    #     This should not be set to `true` if `:media_mode` is `:relayed`.
+    #     See the {https://tokbox.com/developer/guides/end-to-end-encryption/ documentation} for more information.
+    #
     # @return [Session] The Session object. The session_id property of the object is the session ID.
     def create_session(opts={})
 
       # normalize opts so all keys are symbols and only include valid_opts
-      valid_opts = [ :media_mode, :location, :archive_mode ]
+      valid_opts = [ :media_mode, :location, :archive_mode, :archive_name, :archive_resolution, :e2ee ]
       opts = opts.inject({}) do |m,(k,v)|
         if valid_opts.include? k.to_sym
           m[k.to_sym] = v
@@ -159,6 +174,13 @@ module OpenTok
       # keep opts around for Session constructor, build REST params
       params = opts.clone
 
+      # validate input combinations
+      raise ArgumentError, "A session with always archive mode must also have the routed media mode." if (params[:archive_mode] == :always && params[:media_mode] == :relayed)
+
+      raise ArgumentError, "A session with relayed media mode should not have e2ee set to true." if (params[:media_mode] == :relayed && params[:e2ee] == true)
+
+      raise ArgumentError, "A session with always archive mode must not have e2ee set to true." if (params[:archive_mode] == :always && params[:e2ee] == true)
+
       # anything other than :relayed sets the REST param to "disabled", in which case we force
       # opts to be :routed. if we were more strict we could raise an error when the value isn't
       # either :relayed or :routed
@@ -175,10 +197,9 @@ module OpenTok
       # archive mode is optional, but it has to be one of the valid values if present
       unless params[:archive_mode].nil?
         raise "archive mode must be either always or manual" unless ARCHIVE_MODES.include? params[:archive_mode].to_sym
+        raise ArgumentError, "archive name and/or archive resolution must not be set if archive mode is manual" if params[:archive_mode] == :manual && (params[:archive_name] || params[:archive_resolution])
       end
 
-      raise "A session with always archive mode must also have the routed media mode." if (params[:archive_mode] == :always && params[:media_mode] == :relayed)
-
       response = client.create_session(params)
       Session.new api_key, api_secret, response['sessions']['Session']['session_id'], opts
     end
@@ -218,6 +239,11 @@ module OpenTok
       @connections ||= Connections.new client
     end
 
+    # A WebSocket object, which lets you connect OpenTok streams to a WebSocket URI.
+    def websocket
+      @websocket ||= WebSocket.new client
+    end
+
     protected
     def client
       @client ||= Client.new api_key, api_secret, api_url, ua_addendum, timeout_length: @timeout_length

data/lib/opentok/session.rb

@@ -20,6 +20,10 @@ module OpenTok
   # @attr_reader [String] archive_mode Whether the session will be archived automatically
   #  (<code>:always</code>) or not (<code>:manual</code>).
   #
+  # @attr_reader [String] archive_name The name to use for archives in auto-archived sessions.
+  #
+  # @attr_reader [String] :archive_resolution The resolution of archives in an auto-archived session.
+  #
   # @!method generate_token(options)
   #   Generates a token.
   #
@@ -57,7 +61,7 @@ module OpenTok
       :session_id => ->(instance) { instance.session_id }
     })
 
-    attr_reader :session_id, :media_mode, :location, :archive_mode, :api_key, :api_secret
+    attr_reader :session_id, :media_mode, :location, :archive_mode, :archive_name, :archive_resolution, :e2ee, :api_key, :api_secret
 
     # @private
     # this implementation doesn't completely understand the format of a Session ID
@@ -73,7 +77,12 @@ module OpenTok
     # @private
     def initialize(api_key, api_secret, session_id, opts={})
       @api_key, @api_secret, @session_id = api_key, api_secret, session_id
-      @media_mode, @location, @archive_mode = opts.fetch(:media_mode, :relayed), opts[:location], opts.fetch(:archive_mode, :manual)
+      @media_mode = opts.fetch(:media_mode, :relayed)
+      @location = opts[:location]
+      @archive_mode = opts.fetch(:archive_mode, :manual)
+      @archive_name = opts.fetch(:archive_name, '') if archive_mode == :always
+      @archive_resolution = opts.fetch(:archive_resolution, "640x480") if archive_mode == :always
+      @e2ee = opts.fetch(:e2ee, :false)
     end
 
     # @private

data/lib/opentok/version.rb

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

data/lib/opentok/websocket.rb

@@ -0,0 +1,37 @@
+require "opentok/client"
+
+# An object that lets you work with Audio Connector WebSocket connections.
+module OpenTok
+  class WebSocket
+    # Starts an Audio Connector WebSocket connection to send audio from a Vonage Video API session to a WebSocket URI.
+    # See the {https://tokbox.com/developer/guides/audio-connector/ OpenTok Audio Connector developer guide}.
+    #
+    # @example
+    #    opts = {
+    #      "streams" => ["STREAMID1", "STREAMID2"],
+    #      "headers" => {
+    #        "key1" => "val1",
+    #        "key2" => "val2"
+    #      }
+    #    }
+    #    response = opentok.websocket.connect(SESSIONID, TOKEN, "ws://service.com/wsendpoint", opts)
+    #
+    # @param [String] session_id (required) The OpenTok session ID that includes the OpenTok streams you want to include in
+    #       the WebSocket stream.
+    # @param [String] token (required) The OpenTok token to be used for the Audio Connector connection to the. OpenTok session.
+    # @param [String] websocket_uri (required) A publicly reachable WebSocket URI to be used for the destination of the audio
+    #       stream (such as "wss://service.com/ws-endpoint").
+    # @param [Hash] opts (optional) A hash defining options for the Audio Connector WebSocket connection. For example:
+    # @option opts [Array] :streams (optional) An array of stream IDs for the OpenTok streams you want to include in the WebSocket stream.
+    #       If you omit this property, all streams in the session will be included.
+    # @option opts [Hash] :headers (optional) A hash of key-value pairs of headers to be sent to your WebSocket server with each message,
+    #        with a maximum length of 512 bytes.
+    def connect(session_id, token, websocket_uri, opts  = {})
+      response = @client.connect_websocket(session_id, token, websocket_uri, opts)
+    end
+
+    def initialize(client)
+      @client = client
+    end
+  end
+end

data/spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_always_archived_sessions_with_a_set_archive_name.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/session/create
+    body:
+      encoding: UTF-8
+      string: archiveMode=always&archiveName=foo&p2p.preference=disabled
+    headers:
+      User-Agent:
+      - OpenTok-Ruby-SDK/<%= version %>
+      X-Opentok-Auth:
+      - eyJpc3QiOiJwcm9qZWN0IiwiYWxnIjoiSFMyNTYifQ.eyJpc3MiOiIxMjM0NTYiLCJpYXQiOjE0OTI1MTA2NjAsImV4cCI6MTQ5MjUxMDk2MH0.BplMVhJWx4ld7KLKXqEmow6MjNPPFw9W8IHCMfeb120
+      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, 12 Jun 2023 16:17:36 GMT
+      Content-Type:
+      - text/xml
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - '*'
+      X-Tb-Host:
+      - fms503-nyc.tokbox.com
+      Content-Length:
+      - '282'
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><sessions><Session><session_id>1_MX4xMjM0NTZ-fk1vbiBNYXIgMTcgMDA6NDE6MzEgUERUIDIwMTR-MC42ODM3ODk1MzQ0OTQyODA4fg</session_id><partner_id>123456</partner_id><create_dt>Mon
+        Jun 12 16:17:36 GMT 2023</create_dt></Session></sessions>
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 6.0.0

data/spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_always_archived_sessions_with_a_set_archive_name_and_resolution.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/session/create
+    body:
+      encoding: UTF-8
+      string: archiveMode=always&archiveName=foo&archiveResolution=720x1280&p2p.preference=disabled
+    headers:
+      User-Agent:
+      - OpenTok-Ruby-SDK/<%= version %>
+      X-Opentok-Auth:
+      - eyJpc3QiOiJwcm9qZWN0IiwiYWxnIjoiSFMyNTYifQ.eyJpc3MiOiIxMjM0NTYiLCJpYXQiOjE0OTI1MTA2NjAsImV4cCI6MTQ5MjUxMDk2MH0.BplMVhJWx4ld7KLKXqEmow6MjNPPFw9W8IHCMfeb120
+      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, 12 Jun 2023 16:17:36 GMT
+      Content-Type:
+      - text/xml
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - '*'
+      X-Tb-Host:
+      - fms503-nyc.tokbox.com
+      Content-Length:
+      - '282'
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><sessions><Session><session_id>1_MX4xMjM0NTZ-fk1vbiBNYXIgMTcgMDA6NDE6MzEgUERUIDIwMTR-MC42ODM3ODk1MzQ0OTQyODA4fg</session_id><partner_id>123456</partner_id><create_dt>Mon
+        Jun 12 16:17:36 GMT 2023</create_dt></Session></sessions>
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 6.0.0

data/spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_always_archived_sessions_with_a_set_archive_resolution.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/session/create
+    body:
+      encoding: UTF-8
+      string: archiveMode=always&archiveResolution=720x1280&p2p.preference=disabled
+    headers:
+      User-Agent:
+      - OpenTok-Ruby-SDK/<%= version %>
+      X-Opentok-Auth:
+      - eyJpc3QiOiJwcm9qZWN0IiwiYWxnIjoiSFMyNTYifQ.eyJpc3MiOiIxMjM0NTYiLCJpYXQiOjE0OTI1MTA2NjAsImV4cCI6MTQ5MjUxMDk2MH0.BplMVhJWx4ld7KLKXqEmow6MjNPPFw9W8IHCMfeb120
+      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, 12 Jun 2023 16:17:36 GMT
+      Content-Type:
+      - text/xml
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - '*'
+      X-Tb-Host:
+      - fms503-nyc.tokbox.com
+      Content-Length:
+      - '282'
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><sessions><Session><session_id>1_MX4xMjM0NTZ-fk1vbiBNYXIgMTcgMDA6NDE6MzEgUERUIDIwMTR-MC42ODM3ODk1MzQ0OTQyODA4fg</session_id><partner_id>123456</partner_id><create_dt>Mon
+        Jun 12 16:17:36 GMT 2023</create_dt></Session></sessions>
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 6.0.0

data/spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_e2ee_sessions.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/session/create
+    body:
+      encoding: UTF-8
+      string: e2ee=true&p2p.preference=disabled
+    headers:
+      User-Agent:
+      - OpenTok-Ruby-SDK/<%= version %>
+      X-Opentok-Auth:
+      - eyJpc3QiOiJwcm9qZWN0IiwiYWxnIjoiSFMyNTYifQ.eyJpc3MiOiIxMjM0NTYiLCJpYXQiOjE0OTI1MTA2NjAsImV4cCI6MTQ5MjUxMDk2MH0.BplMVhJWx4ld7KLKXqEmow6MjNPPFw9W8IHCMfeb120
+      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:
+      - Tue, 18 Apr 2023 16:17:40 GMT
+      Content-Type:
+      - text/xml
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - '*'
+      X-Tb-Host:
+      - mantis503-nyc.tokbox.com
+      Content-Length:
+      - '304'
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><sessions><Session><session_id>1_MX4xMjM0NTZ-MTIuMzQuNTYuNzh-TW9uIE1hciAxNyAwMTo0ODo1NSBQRFQgMjAxNH4wLjM0MTM0MzE0MDIyOTU4Mjh-</session_id><partner_id>123456</partner_id><create_dt>Tue
+        Apr 18 08:17:40 PDT 2023</create_dt></Session></sessions>
+  recorded_at: Tue, 18 Apr 2023 16:17:40 GMT
+recorded_with: VCR 6.0.0

data/spec/cassettes/OpenTok_WebSocket/receives_a_valid_response.yml

@@ -0,0 +1,37 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/v2/project/123456/connect
+    body:
+      encoding: UTF-8
+      string: '{"sessionId":"SESSIONID","token":"TOKENID","websocket":{"uri":"ws://service.com/wsendpoint"}}'
+    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:
+      Date:
+      - Sat, 06 Aug 2022 18:10:28 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '73'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"id":"2299ba24-a6de-417c-88f7-28da54a441cf","connectionId":"833a7182-61a5-49d4-baae-c324b09953af"}'
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 6.0.0

data/spec/opentok/opentok_spec.rb

@@ -97,6 +97,7 @@ describe OpenTok::OpenTok do
         expect(session.media_mode).to eq :relayed
         expect(session.location).to eq nil
       end
+
       it "creates always archived sessions", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
         session = opentok.create_session :media_mode => :routed, :archive_mode => :always
         expect(session).to be_an_instance_of OpenTok::Session
@@ -105,9 +106,80 @@ describe OpenTok::OpenTok do
         expect(session.location).to eq nil
       end
 
+      it "creates always archived sessions with a set archive name", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+        session = opentok.create_session :media_mode => :routed, :archive_mode => :always, :archive_name => 'foo'
+        expect(session).to be_an_instance_of OpenTok::Session
+        expect(session.session_id).to be_an_instance_of String
+        expect(session.archive_mode).to eq :always
+        expect(session.archive_name).to eq 'foo'
+        expect(session.location).to eq nil
+      end
+
+      it "creates always archived sessions with a set archive resolution", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+        session = opentok.create_session :media_mode => :routed, :archive_mode => :always, :archive_resolution => "720x1280"
+        expect(session).to be_an_instance_of OpenTok::Session
+        expect(session.session_id).to be_an_instance_of String
+        expect(session.archive_mode).to eq :always
+        expect(session.archive_resolution).to eq "720x1280"
+        expect(session.location).to eq nil
+      end
+
+      it "creates always archived sessions with a set archive name and resolution", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+        session = opentok.create_session :media_mode => :routed, :archive_mode => :always, :archive_name => 'foo', :archive_resolution => "720x1280"
+        expect(session).to be_an_instance_of OpenTok::Session
+        expect(session.session_id).to be_an_instance_of String
+        expect(session.archive_mode).to eq :always
+        expect(session.archive_name).to eq 'foo'
+        expect(session.archive_resolution).to eq "720x1280"
+        expect(session.location).to eq nil
+      end
+
+      it "creates e2ee sessions", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+        session = opentok.create_session :media_mode => :routed, :e2ee => :true
+        expect(session).to be_an_instance_of OpenTok::Session
+        expect(session.session_id).to be_an_instance_of String
+        expect(session.e2ee).to eq :true
+        expect(session.location).to eq nil
+      end
+
       context "with relayed media mode and always archive mode" do
-        subject { -> { session = opentok.create_session :archive_mode => :always, :media_mode => :relayed }}
-        it { should raise_error }
+        it "raises an error" do
+          expect {
+            opentok.create_session :archive_mode => :always, :media_mode => :relayed
+          }.to raise_error ArgumentError
+        end
+      end
+
+      context "with archive name set and manual archive mode" do
+        it "raises an error" do
+          expect {
+            opentok.create_session :archive_mode => :manual, :archive_name => 'foo'
+          }.to raise_error ArgumentError
+        end
+      end
+
+      context "with archive resolution set and manual archive mode" do
+        it "raises an error" do
+          expect {
+            opentok.create_session :archive_mode => :manual, :archive_resolution => "720x1280"
+          }.to raise_error ArgumentError
+        end
+      end
+
+      context "with relayed media mode and e2ee set to true" do
+        it "raises an error" do
+          expect {
+            opentok.create_session :media_mode => :relayed, :e2ee => true
+          }.to raise_error ArgumentError
+        end
+      end
+
+      context "with always archive mode and e2ee set to true" do
+        it "raises an error" do
+          expect {
+            opentok.create_session :archive_mode => :always, :e2ee => true
+          }.to raise_error ArgumentError
+        end
       end
 
     end

data/spec/opentok/websocket_spec.rb

@@ -0,0 +1,26 @@
+require "opentok/opentok"
+require "opentok/websocket"
+require "opentok/version"
+require "spec_helper"
+
+describe OpenTok::WebSocket do
+  before(:each) do
+    now = Time.parse("2017-04-18 20:17:40 +1000")
+    allow(Time).to receive(:now) { now }
+  end
+
+  let(:api_key) { "123456" }
+  let(:api_secret) { "1234567890abcdef1234567890abcdef1234567890" }
+  let(:session_id) { "SESSIONID" }
+  let(:connection_id) { "CONNID" }
+  let(:expiring_token) { "TOKENID" }
+  let(:websocket_uri) { "ws://service.com/wsendpoint" }
+  let(:opentok) { OpenTok::OpenTok.new api_key, api_secret }
+  let(:websocket) { opentok.websocket }
+  subject { websocket }
+
+  it "receives a valid response", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    response = websocket.connect(session_id, expiring_token, websocket_uri)
+    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.5.1
+  version: 4.7.0
 platform: ruby
 authors:
 - Stijn Mathysen
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-28 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -206,6 +206,7 @@ files:
 - lib/opentok/streams.rb
 - lib/opentok/token_generator.rb
 - lib/opentok/version.rb
+- lib/opentok/websocket.rb
 - opentok.gemspec
 - sample/Archiving/Gemfile
 - sample/Archiving/README.md
@@ -281,7 +282,11 @@ files:
 - spec/cassettes/OpenTok_Broadcasts/stops_a_broadcast.yml
 - spec/cassettes/OpenTok_Connections/forces_a_connection_to_be_terminated.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_always_archived_sessions.yml
+- spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_always_archived_sessions_with_a_set_archive_name.yml
+- spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_always_archived_sessions_with_a_set_archive_name_and_resolution.yml
+- spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_always_archived_sessions_with_a_set_archive_resolution.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_default_sessions.yml
+- spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_e2ee_sessions.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_relayed_media_sessions.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_relayed_media_sessions_for_invalid_media_modes.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_relayed_media_sessions_with_a_location_hint.yml
@@ -308,6 +313,7 @@ files:
 - spec/cassettes/OpenTok_Streams/get_all_streams_information.yml
 - spec/cassettes/OpenTok_Streams/get_specific_stream_information.yml
 - spec/cassettes/OpenTok_Streams/layout_working_on_two_stream_list.yml
+- spec/cassettes/OpenTok_WebSocket/receives_a_valid_response.yml
 - spec/matchers/token.rb
 - spec/opentok/archives_spec.rb
 - spec/opentok/broadcasts_spec.rb
@@ -319,6 +325,7 @@ files:
 - spec/opentok/signal_spec.rb
 - spec/opentok/sip_spec.rb
 - spec/opentok/streams_spec.rb
+- spec/opentok/websocket_spec.rb
 - spec/shared/opentok_generates_tokens.rb
 - spec/shared/session_generates_tokens.rb
 - spec/spec_helper.rb
@@ -391,7 +398,11 @@ test_files:
 - spec/cassettes/OpenTok_Broadcasts/stops_a_broadcast.yml
 - spec/cassettes/OpenTok_Connections/forces_a_connection_to_be_terminated.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_always_archived_sessions.yml
+- spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_always_archived_sessions_with_a_set_archive_name.yml
+- spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_always_archived_sessions_with_a_set_archive_name_and_resolution.yml
+- spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_always_archived_sessions_with_a_set_archive_resolution.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_default_sessions.yml
+- spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_e2ee_sessions.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_relayed_media_sessions.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_relayed_media_sessions_for_invalid_media_modes.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_relayed_media_sessions_with_a_location_hint.yml
@@ -418,6 +429,7 @@ test_files:
 - spec/cassettes/OpenTok_Streams/get_all_streams_information.yml
 - spec/cassettes/OpenTok_Streams/get_specific_stream_information.yml
 - spec/cassettes/OpenTok_Streams/layout_working_on_two_stream_list.yml
+- spec/cassettes/OpenTok_WebSocket/receives_a_valid_response.yml
 - spec/matchers/token.rb
 - spec/opentok/archives_spec.rb
 - spec/opentok/broadcasts_spec.rb
@@ -429,6 +441,7 @@ test_files:
 - spec/opentok/signal_spec.rb
 - spec/opentok/sip_spec.rb
 - spec/opentok/streams_spec.rb
+- spec/opentok/websocket_spec.rb
 - spec/shared/opentok_generates_tokens.rb
 - spec/shared/session_generates_tokens.rb
 - spec/spec_helper.rb