opentok 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a1348f9a120404e5fa6a5dd9710a7f7d44b2be8
-  data.tar.gz: 194a975415e454028ab738929df4462c5dd8213a
+  metadata.gz: 25c2985a61c6db455329b4cb491d573660acb9d0
+  data.tar.gz: e123cf51b9921306d2abec19a15a4dc6d1ce802c
 SHA512:
-  metadata.gz: 6870dd1f8e7dfb518fd1027f40605f1267c9d4aa740916aaf03828c87f1f019d90cc48389134a6b5a18cd3c1f5bcdd2c7a5c2fa1b010acd43b4a86a14f6192cc
-  data.tar.gz: b5f30aa15b3db675de70b97065ef8165830c89de6193af18dda0c99d3253f4e49e7025d14030c79d553eed26ea1b69d624532af07577a822d3a1e1e7a0356224
+  metadata.gz: e3e879ddd1f69bb0e03806fe0e2e594daadb8b11a964b3cd46ed26d7be161ab21df7d43af8d63803b8d0fe4aed9344f0eae2ae32245e144c99e0df00dddab51e
+  data.tar.gz: 7703872a8a0c651cab4cb92a15c0d5ba83b0b26a0ddac8843e6cd6ae0fe164446752361fb868c6cbd7a3cbd5475502af11c8124b9224c691d5d6ddecee200e43

data/DEVELOPING.md

@@ -41,7 +41,7 @@ Common tasks:
 In order to create a release, the following should be completed in order.
 
 1. Ensure all tests are passing (`rake spec`) and that there is enough test coverage.
-1. Make sure you are on the `master` branch of the repository, with all changes merged/committed already.
+1. Make sure you are on the `dev` branch of the repository, with all changes merged/committed already.
 1. Update the version number in the source code (`lib/opentok/version.rb`) and the README. See [Versioning](#versioning) for
    information about selecting an appropriate version number.
 1. Commit the version number change with the message ("Update to version v.x.x.x"), substituting the new version number.
@@ -49,7 +49,7 @@ In order to create a release, the following should be completed in order.
 1. Run `rake release`, which will create a git tag for the version number, build, and push the gem to Rubygems.
 1. Change the version number for future development by adding ".alpha.1", then make another commit with the message
    "Beginning development on next version".
-1. Push the changes to the main repository (`git push origin master`).
+1. Push the changes to the main repository (`git push origin dev`).
 1. Add a description to the [GitHub Releases](https://github.com/opentok/opentok-ruby-sdk/releases) page
    with any notable changes. Upload the built gem as an attachment.
 
@@ -66,11 +66,12 @@ from 1.
 
 ### Branches
 
-*  `master` - the main development branch.
+*  `dev` - the main development branch.
+*  `master` - reflects the latest stable release.
 *  `feat.foo` - feature branches. these are used for longer running tasks that cannot be accomplished in one commit.
-   once merged into master, these branches should be deleted.
-*  `vx.x.x` - if development for a future version/milestone has begun while master is working towards a sooner
-   release, this is the naming scheme for that branch. once merged into master, these branches should be deleted.
+   once merged into dev, these branches should be deleted.
+*  `vx.x.x` - if development for a future version/milestone has begun while dev is working towards a sooner
+   release, this is the naming scheme for that branch. once merged into dev, these branches should be deleted.
 
 ### Tags
 

data/README.md

@@ -17,7 +17,7 @@ Bundler helps manage dependencies for Ruby projects. Find more info here: <http:
 Add this gem to your `Gemfile`:
 
 ```ruby
-gem "opentok", "~> 2.4"
+gem "opentok", "~> 2.4.1"
 ```
 
 Allow bundler to install the change.
@@ -29,7 +29,7 @@ $ bundle install
 ## RubyGems:
 
 ```
-$ gem install opentok -v 2.4.0
+$ gem install opentok
 ```
 
 # Usage
@@ -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 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)
@@ -90,7 +91,8 @@ token = session.generate_token
 token = session.generate_token({
     :role        => :moderator,
     :expire_time => Time.now.to_i+(7 * 24 * 60 * 60), # in one week
-    :data        => 'name=Johnny'
+    :data        => 'name=Johnny',
+    :initial_layout_class_list => ['focus', 'inactive']
 });
 ```
 

data/lib/opentok/token_generator.rb

@@ -81,6 +81,15 @@ module OpenTok
         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
+
       digest = OpenSSL::Digest.new('sha1')
       data_string = Addressable::URI.form_encode data_params
       meta_string = Addressable::URI.form_encode({

data/lib/opentok/version.rb

@@ -1,4 +1,4 @@
 module OpenTok
   # @private
-  VERSION = '2.4.0'
+  VERSION = '2.4.1'
 end

data/sample/Archiving/public/js/host.js

@@ -2,7 +2,7 @@ var session = OT.initSession(apiKey, sessionId),
     publisher = OT.initPublisher('publisher'),
     archiveID = null;
 
-session.connect(token, function(error, info) {
+session.connect(token, function(error) {
   if (error) {
     console.error('Failed to connect', error);
   } else {

data/sample/Archiving/public/js/participant.js

@@ -1,7 +1,7 @@
 var session = OT.initSession(apiKey, sessionId),
     publisher = OT.initPublisher('publisher');
 
-session.connect(token, function(error, info) {
+session.connect(token, function(error) {
   if (error) {
     console.error('Failed to connect', error);
   } else {

data/spec/matchers/token.rb

@@ -7,7 +7,8 @@ require "addressable/uri"
 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_class_list => :initial_layout_class_list
   }
   match do |token|
     decoded_token = Base64.decode64(token[4..token.length])

data/spec/shared/opentok_generates_tokens.rb

@@ -73,6 +73,31 @@ shared_examples "opentok generates tokens" do
       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_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
+    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
+    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: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Stijn Mathysen
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-09 00:00:00.000000000 Z
+date: 2017-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -262,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby gem for the OpenTok API