Merge pull request #116 from aoberoi/feat.layout-control

adds initial_layout_class_list feature to token generation

Author: aoberoi

README.md

@@ -77,7 +77,8 @@ Once a Session is created, you can start generating Tokens for clients to use wh
 You can generate a token either by calling the `opentok.generate_token(session_id, options)` method,
 or by calling the `Session#generate_token(options)` method on the an instance after creating it. The
 `options` parameter is an optional Hash used to set the role, expire time, and connection data of
-the Token.
+the Token. For layout control in archives and broadcasts, the initial layout class list of streams
+published from connections using this token can be set as well.
 
 ```ruby
 # Generate a Token from just a session_id (fetched from a database)
@@ -88,9 +89,10 @@ token = session.generate_token
 
 # Set some options in a token
 token = session.generate_token({
-    :role        => :moderator
-    :expire_time => Time.now.to_i+(7 * 24 * 60 * 60) # in one week
-    :data        => 'name=Johnny'
+    :role                   => :moderator
+    :expire_time            => Time.now.to_i+(7 * 24 * 60 * 60) # in one week
+    :data                   => 'name=Johnny',
+    :initial_layout_classes => ['focus', 'inactive']
 });
 ```
 

lib/opentok/token_generator.rb

@@ -81,6 +81,15 @@ def generate_token
         end
         data_params[:connection_data] = data
       end
+
+      if opts[:initial_layout_classes]
+        if opts[:initial_layout_classes].is_a?(Array)
+          data_params[:initial_layout_class_list] = opts[:initial_layout_classes].join(' ')
+        else
+          data_params[:initial_layout_class_list] = opts[:initial_layout_classes].to_s
+        end
+      end
+
       digest = OpenSSL::Digest.new('sha1')
       data_string = Addressable::URI.form_encode data_params
       meta_string = Addressable::URI.form_encode({

spec/matchers/token.rb

@@ -7,7 +7,8 @@
 RSpec::Matchers.define :carry_token_data do |input_data|
   option_to_token_key = {
     :api_key => :partner_id,
-    :data => :connection_data
+    :data => :connection_data,
+    :initial_layout_classes => :initial_layout_class_list
   }
   match do |token|
     decoded_token = Base64.decode64(token[4..token.length])

spec/shared/opentok_generates_tokens.rb

@@ -68,6 +68,31 @@
       expect(data_bearing_token).to carry_valid_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_classes => 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_classes => 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
+    end
+
+    it "generates tokens with one initial layout class" do
+      layout_class = "focus"
+      layout_class_bearing_token = opentok.generate_token session_id, :initial_layout_classes => 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_classes => 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
+    end
+
+
     # TODO a context about using a bad session_id
   end