Merge pull request #262 from opentok/devx-6817-auto-archive-improvements

DEVX-6817: Auto Archive Improvements

Author: superchilled

lib/opentok/opentok.rb

@@ -144,6 +144,16 @@ def initialize(api_key, api_secret, opts={})
     #     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`.
@@ -153,7 +163,7 @@ def initialize(api_key, api_secret, opts={})
     def create_session(opts={})
 
       # normalize opts so all keys are symbols and only include valid_opts
-      valid_opts = [ :media_mode, :location, :archive_mode, :e2ee ]
+      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
@@ -187,6 +197,7 @@ def create_session(opts={})
       # 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
 
       response = client.create_session(params)

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 @@ class Session
       :session_id => ->(instance) { instance.session_id }
     })
 
-    attr_reader :session_id, :media_mode, :location, :archive_mode, :e2ee, :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 @@ def self.belongs_to_api_key?(session_id, api_key)
     # @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, @e2ee = opts.fetch(:media_mode, :relayed), opts[:location], opts.fetch(:archive_mode, :manual), opts.fetch(:e2ee, :false)
+      @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

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

@@ -106,6 +106,34 @@
         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
@@ -114,11 +142,6 @@
         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 }
-      # end
-
       context "with relayed media mode and always archive mode" do
         it "raises an error" do
           expect {
@@ -127,6 +150,22 @@
         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 {