opentok 2.4.0.beta.1 → 2.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a1348f9a120404e5fa6a5dd9710a7f7d44b2be8
+  data.tar.gz: 194a975415e454028ab738929df4462c5dd8213a
+SHA512:
+  metadata.gz: 6870dd1f8e7dfb518fd1027f40605f1267c9d4aa740916aaf03828c87f1f019d90cc48389134a6b5a18cd3c1f5bcdd2c7a5c2fa1b010acd43b4a86a14f6192cc
+  data.tar.gz: b5f30aa15b3db675de70b97065ef8165830c89de6193af18dda0c99d3253f4e49e7025d14030c79d553eed26ea1b69d624532af07577a822d3a1e1e7a0356224

data/.gitignore

@@ -15,5 +15,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor
 
 .DS_Store

data/.travis.yml

@@ -9,7 +9,8 @@ rvm:
 - 2.0.0
 - 2.1.0
 - 2.2.0
-- rbx-2
+- 2.3.0
+- 2.4.0
 notifications:
   slack:
     secure: agVll2R9PTPvJMcUgbvOh9eGt60zGDc8kPUwEsiQr828rCgXh/ZxD5irYDyKQg3ZsS8+f3MjFCwzU7uQALkia2pDrie9d8g8m1dt4Q5U7Qm6QecshvE0U9JwbB5Ngxaftbqyf0XEFrE7CKs7RI1BzFRpe8m+fdZgfwccX8Gb7pc=

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.0.beta.1"
+gem "opentok", "~> 2.4"
 ```
 
 Allow bundler to install the change.
@@ -29,7 +29,7 @@ $ bundle install
 ## RubyGems:
 
 ```
-$ gem install opentok -v 2.4.0.beta.1
+$ gem install opentok -v 2.4.0
 ```
 
 # Usage
@@ -75,10 +75,9 @@ session_id = session.session_id
 
 Once a Session is created, you can start generating Tokens for clients to use when connecting to it.
 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
+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. 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.
+the Token.
 
 ```ruby
 # Generate a Token from just a session_id (fetched from a database)
@@ -89,10 +88,9 @@ 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',
-    :initial_layout_classes => ['focus', 'inactive']
+    :role        => :moderator,
+    :expire_time => Time.now.to_i+(7 * 24 * 60 * 60), # in one week
+    :data        => 'name=Johnny'
 });
 ```
 
@@ -188,8 +186,7 @@ repository and follow the Walkthroughs:
 
 # Documentation
 
-Reference documentation is available at <http://www.tokbox.com//opentok/libraries/server/ruby/reference/index.html> and in the
-doc directory of the SDK.
+Reference documentation is available at <http://www.tokbox.com//opentok/libraries/server/ruby/reference/index.html>.
 
 # Requirements
 

data/lib/opentok.rb

@@ -1,6 +1,6 @@
 require "opentok/opentok"
 
-# Namespace for classes and modules in the OpenTok 2.2 Ruby SDK.
+# Namespace for classes and modules in the OpenTok Ruby SDK.
 module OpenTok
 
 end

data/lib/opentok/archive.rb

@@ -30,9 +30,8 @@ module OpenTok
     #   The API key associated with the archive.
     #
     # @attr [string] reason
-    #   For archives with the status "stopped", this can be set to "90 mins exceeded", "failure",
-    #   "session ended", or "user initiated". For archives with the status "failed", this can be set
-    #   to "system failure".
+    #   For archives with the status "stopped" or "failed", this string describes the
+    #   reason the archive stopped (such as "maximum duration exceeded") or failed.
     #
     # @attr [string] session_id
     #   The session ID of the OpenTok session associated with this archive.

data/lib/opentok/archives.rb

@@ -96,11 +96,13 @@ module OpenTok
     #   the most recent archive. If you do not specify an offset, 0 is used.
     # @option options [integer] :count Optional. The number of archives to be returned. The maximum
     #   number of archives returned is 1000.
+    # @option options [String] :session_id Optional. The session ID that archives belong to. This is
+    #   useful when listing multiple archives for an {https://tokbox.com/developer/guides/archiving/#automatic-archives automatically archived session}
     #
     # @return [ArchiveList] An ArchiveList object, which is an array of Archive objects.
     def all(options = {})
-      raise ArgumentError, "Limit is invalid" unless options[:count].nil? or (0..100).include? options[:count]
-      archive_list_json = @client.list_archives(options[:offset], options[:count])
+      raise ArgumentError, "Limit is invalid" unless options[:count].nil? or (0..1000).include? options[:count]
+      archive_list_json = @client.list_archives(options[:offset], options[:count], options[:sessionId])
       ArchiveList.new self, archive_list_json
     end
 

data/lib/opentok/client.rb

@@ -1,8 +1,10 @@
+require "opentok/constants"
 require "opentok/exceptions"
 require "opentok/extensions/hash"
 
 require "active_support/inflector"
 require "httparty"
+require "jwt"
 
 module OpenTok
   # @private For internal use by the SDK.
@@ -17,15 +19,34 @@ module OpenTok
     def initialize(api_key, api_secret, api_url, ua_addendum="")
       self.class.base_uri api_url
       self.class.headers({
-        "X-TB-PARTNER-AUTH" => "#{api_key}:#{api_secret}",
         "User-Agent" => "OpenTok-Ruby-SDK/#{VERSION}" + (ua_addendum ? " #{ua_addendum}" : "")
       })
       @api_key = api_key
+      @api_secret = api_secret
+    end
+
+    def generate_jwt(api_key, api_secret)
+      now = Time.now.to_i
+      payload = {
+        :iss => api_key,
+        :iat => now,
+        :exp => now + AUTH_EXPIRE
+      }
+      token = JWT.encode payload, api_secret, 'HS256', :ist => 'project'
+      token
+    end
+
+    def generate_headers(extra_headers = {})
+      defaults = { "X-OPENTOK-AUTH" => generate_jwt(@api_key, @api_secret) }
+      defaults.merge extra_headers
     end
 
     def create_session(opts)
       opts.extend(HashExtensions)
-      response = self.class.post("/session/create", :body => opts.camelize_keys!)
+      response = self.class.post("/session/create", {
+        :body => opts.camelize_keys!,
+        :headers => generate_headers
+      })
       case response.code
       when (200..300)
         response
@@ -41,9 +62,9 @@ module OpenTok
     def start_archive(session_id, opts)
       opts.extend(HashExtensions)
       body = { "sessionId" => session_id }.merge(opts.camelize_keys!)
-      response = self.class.post("/v2/partner/#{@api_key}/archive", {
+      response = self.class.post("/v2/project/#{@api_key}/archive", {
         :body => body.to_json,
-        :headers => { "Content-Type" => "application/json" }
+        :headers => generate_headers("Content-Type" => "application/json")
       })
       case response.code
       when 200
@@ -64,7 +85,9 @@ module OpenTok
     end
 
     def get_archive(archive_id)
-      response = self.class.get("/v2/partner/#{@api_key}/archive/#{archive_id}")
+      response = self.class.get("/v2/project/#{@api_key}/archive/#{archive_id}", {
+        :headers => generate_headers
+      })
       case response.code
       when 200
         response
@@ -79,12 +102,14 @@ module OpenTok
       raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
     end
 
-    def list_archives(offset, count)
+    def list_archives(offset, count, sessionId)
       query = Hash.new
       query[:offset] = offset unless offset.nil?
       query[:count] = count unless count.nil?
-      response = self.class.get("/v2/partner/#{@api_key}/archive", {
-        :query => query.empty? ? nil : query
+      query[:sessionId] = sessionId unless sessionId.nil?
+      response = self.class.get("/v2/project/#{@api_key}/archive", {
+        :query => query.empty? ? nil : query,
+        :headers => generate_headers
       })
       case response.code
       when 200
@@ -99,8 +124,8 @@ module OpenTok
     end
 
     def stop_archive(archive_id)
-      response = self.class.post("/v2/partner/#{@api_key}/archive/#{archive_id}/stop", {
-        :headers => { "Content-Type" => "application/json" }
+      response = self.class.post("/v2/project/#{@api_key}/archive/#{archive_id}/stop", {
+        :headers => generate_headers("Content-Type" => "application/json")
       })
       case response.code
       when 200
@@ -121,8 +146,8 @@ module OpenTok
     end
 
     def delete_archive(archive_id)
-      response = self.class.delete("/v2/partner/#{@api_key}/archive/#{archive_id}", {
-        :headers => { "Content-Type" => "application/json" }
+      response = self.class.delete("/v2/project/#{@api_key}/archive/#{archive_id}", {
+        :headers => generate_headers("Content-Type" => "application/json")
       })
       case response.code
       when 204

data/lib/opentok/constants.rb

@@ -3,4 +3,5 @@ module OpenTok
   TOKEN_SENTINEL = "T1=="
   ROLES = { subscriber: "subscriber", publisher: "publisher", moderator: "moderator" }
   ARCHIVE_MODES = Set.new([:manual, :always])
+  AUTH_EXPIRE = 300
 end

data/lib/opentok/opentok.rb

@@ -34,7 +34,7 @@ module OpenTok
   #       streams, and signal. (This is the default value if you do not specify a role.)
   #
   #     * <code>:moderator</code> -- In addition to the privileges granted to a
-  #       publisher, in clients using the OpenTok.js 2.2 library, a moderator can call the
+  #       publisher, in clients using the OpenTok.js library, a moderator can call the
   #       <code>forceUnpublish()</code> and <code>forceDisconnect()</code> method of the
   #       Session object.
   #   @option options [integer] :expire_time The expiration time, in seconds since the UNIX epoch.

data/lib/opentok/session.rb

@@ -32,7 +32,7 @@ module OpenTok
   #       streams, and signal. (This is the default value if you do not specify a role.)
   #
   #     * <code>:moderator</code> -- In addition to the privileges granted to a
-  #       publisher, in clients using the OpenTok.js 2.2 library, a moderator can call the
+  #       publisher, in clients using the OpenTok.js library, a moderator can call the
   #       <code>forceUnpublish()</code> and <code>forceDisconnect()</code> method of the
   #       Session object.
   #   @option options [integer] :expire_time The expiration time, in seconds since the UNIX epoch.

data/lib/opentok/token_generator.rb

@@ -81,15 +81,6 @@ module OpenTok
         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({

data/lib/opentok/version.rb

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

data/opentok.gemspec

@@ -19,13 +19,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 10.1.1"
   spec.add_development_dependency "rspec", "~> 2.14.1"
-  spec.add_development_dependency "webmock", "~> 1.17.4"
+  spec.add_development_dependency "webmock", "~> 2.3.2"
   spec.add_development_dependency "vcr", "~> 2.8.0"
   spec.add_development_dependency "yard", "~> 0.8.7"
   # TODO: exclude this for compatibility with rbx
   # spec.add_development_dependency "debugger", "~> 1.6.6"
 
   spec.add_dependency "addressable", "~> 2.3" #  2.3.0 <= version < 3.0.0
-  spec.add_dependency "httparty", "~> 0.13.1"
+  spec.add_dependency "httparty", "~> 0.14.0"
   spec.add_dependency "activesupport", ">= 2.0"
+  spec.add_dependency "jwt", "~> 1.5.6"
 end

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

@@ -1,16 +1,27 @@
-var session = OT.initSession(sessionId),
+var session = OT.initSession(apiKey, sessionId),
     publisher = OT.initPublisher('publisher'),
     archiveID = null;
 
-session.connect(apiKey, token, function(err, info) {
-  if(err) {
-    alert(err.message || err);
+session.connect(token, function(error, info) {
+  if (error) {
+    console.error('Failed to connect', error);
+  } else {
+    session.publish(publisher, function(error) {
+      if (error) {
+        console.error('Failed to publish', error);
+      }
+    });
   }
-  session.publish(publisher);
 });
 
 session.on('streamCreated', function(event) {
-  session.subscribe(event.stream, 'subscribers', { insertMode: 'append' });
+  session.subscribe(event.stream, 'subscribers', {
+    insertMode: 'append'
+  }, function(error) {
+    if (error) {
+      console.error('Failed to subscribe', error);
+    }
+  });
 });
 
 session.on('archiveStarted', function(event) {
@@ -30,7 +41,7 @@ session.on('archiveStopped', function(event) {
 });
 
 $(document).ready(function() {
-  $('.start').click(function (event) {
+  $('.start').click(function(event) {
     var options = $('.archive-options').serialize();
     disableForm();
     $.post('/start', options).fail(enableForm);

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

@@ -1,13 +1,24 @@
-var session = OT.initSession(sessionId),
-    publisher = OT.initPublisher("publisher");
+var session = OT.initSession(apiKey, sessionId),
+    publisher = OT.initPublisher('publisher');
 
-session.connect(apiKey, token, function(err, info) {
-  if(err) {
-    alert(err.message || err);
+session.connect(token, function(error, info) {
+  if (error) {
+    console.error('Failed to connect', error);
+  } else {
+    session.publish(publisher, function(error) {
+      if (error) {
+        console.error('Failed to publish', error);
+      }
+    });
   }
-  session.publish(publisher);
 });
 
 session.on('streamCreated', function(event) {
-  session.subscribe(event.stream, "subscribers", { insertMode : "append" });
+  session.subscribe(event.stream, 'subscribers', {
+    insertMode : 'append'
+  }, function(error) {
+    if (error) {
+      console.error('Failed to subscribe', error);
+    }
+  });
 });

data/sample/Archiving/views/host.erb

@@ -1,4 +1,4 @@
-<script src="//static.opentok.com/webrtc/v2.2/js/opentok.min.js"></script>
+<script src="https://static.opentok.com/v2/js/opentok.min.js"></script>
 
   <div class="container bump-me">
 

data/sample/Archiving/views/participant.erb

@@ -1,4 +1,4 @@
-<script src="//static.opentok.com/webrtc/v2.2/js/opentok.min.js"></script>
+<script src="https://static.opentok.com/v2/js/opentok.min.js"></script>
 
   <div class="container bump-me">
 

data/sample/HelloWorld/public/js/helloworld.js

@@ -1,8 +1,16 @@
 // Initialize an OpenTok Session object
-var session = TB.initSession(sessionId);
+var session = OT.initSession(apiKey, sessionId);
 
 // Initialize a Publisher, and place it into the element with id="publisher"
-var publisher = TB.initPublisher(apiKey, 'publisher');
+var publisher = OT.initPublisher('publisher', {
+    insertMode: 'append',
+    width: '100%',
+    height: '100%'
+}, function(error) {
+  if (error) {
+    console.error('Failed to initialise publisher', error);
+  }
+});
 
 // Attach event handlers
 session.on({
@@ -11,7 +19,11 @@ session.on({
   sessionConnected: function(event) {
     // Publish the publisher we initialzed earlier (this will trigger 'streamCreated' on other
     // clients)
-    session.publish(publisher);
+    session.publish(publisher, function(error) {
+      if (error) {
+        console.error('Failed to publish', error);
+      }
+    });
   },
 
   // This function runs when another client publishes a stream (eg. session.publish())
@@ -23,10 +35,18 @@ session.on({
     document.getElementById('subscribers').appendChild(subContainer);
 
     // Subscribe to the stream that caused this event, put it inside the container we just made
-    session.subscribe(event.stream, subContainer);
+    session.subscribe(event.stream, subContainer, function(error) {
+      if (error) {
+        console.error('Failed to subscribe', error);
+      }
+    });
   }
 
 });
 
-// Connect to the Session using the 'apiKey' of the application and a 'token' for permission
-session.connect(apiKey, token);
+// Connect to the Session using a 'token'
+session.connect(token, function(error) {
+  if (error) {
+    console.error('Failed to connect', error);
+  }
+});

data/sample/HelloWorld/views/index.erb

@@ -3,7 +3,7 @@
 <head>
     <meta charset="utf-8" />
     <title>OpenTok Hello World</title>
-    <script src="//static.opentok.com/webrtc/v2.2/js/TB.min.js"></script>
+    <script src="https://static.opentok.com/v2/js/opentok.min.js"></script>
     <script type="text/javascript">
         var apiKey = '<%= api_key %>';
         var sessionId = '<%= session_id %>';