Merge branch 'master' into jeffswartz-account-portal-docs

Author: aiham

.travis.yml

@@ -12,10 +12,11 @@ before_script:
   - echo $JAVA_OPTS
   - export JAVA_OPTS="$JAVA_OPTS -Xmx1024m"
   - export GRADLE_OPTS=-Xmx1024m
+after_success:
+- bash <(curl -s https://codecov.io/bash) -t $CODECOV_TOKEN
 
 # workaround for https://github.com/travis-ci/travis-ci/issues/5227
-before_install:
-  - cat /etc/hosts # optionally check the content *before*
-  - sudo hostname "$(hostname | cut -c1-63)"
-  - sed -e "s/^\\(127\\.0\\.0\\.1.*\\)/\\1 $(hostname | cut -c1-63)/" /etc/hosts | sudo tee /etc/hosts
-  - cat /etc/hosts # optionally check the content *after*
+addons:
+  hosts:
+    - myshorthost
+  hostname: myshorthost

README.md

@@ -1,7 +1,7 @@
 # OpenTok Java SDK
 
-[![Build Status](https://travis-ci.org/opentok/Opentok-Java-SDK.svg)](https://travis-ci.org/opentok/Opentok-Java-SDK)
-
+[![Build Status](https://travis-ci.org/opentok/Opentok-Java-SDK.svg?branch=master)](https://travis-ci.org/opentok/Opentok-Java-SDK)
+[![codecov](https://codecov.io/gh/opentok/Opentok-Java-SDK/branch/master/graph/badge.svg)](https://codecov.io/gh/opentok/Opentok-Java-SDK)
 The OpenTok Java SDK lets you generate
 [sessions](http://tokbox.com/opentok/tutorials/create-session/) and
 [tokens](http://tokbox.com/opentok/tutorials/create-token/) for [OpenTok](http://www.tokbox.com/)
@@ -62,6 +62,12 @@ String apiSecret = "YOUR API SECRET";
 OpenTok opentok = new OpenTok(apiKey, apiSecret)
 ```
 
+And make sure you call `close` when you are done to prevent leaked file descriptors.
+
+```java
+opentok.close();
+```
+
 ## Creating Sessions
 
 To create an OpenTok Session, use the `OpenTok` instance's `createSession(SessionProperties properties)`
@@ -135,7 +141,7 @@ String token = session.generateToken(new TokenOptions.Builder()
 
 You can start the recording of an OpenTok Session using a `com.opentok.OpenTok` instance's
 `startArchive(String sessionId, String name)` method. This will return a `com.opentok.Archive` instance.
-The parameter `name` is a optional and used to assign a name for the Archive. Note that you can
+The parameter `name` is optional and used to assign a name for the Archive. Note that you can
 only start an Archive on a Session that has clients connected.
 
 ```java

build.gradle

@@ -7,10 +7,12 @@ apply plugin: 'maven'
 apply plugin: 'signing'
 apply plugin: 'idea'
 apply plugin: 'eclipse'
+apply plugin: 'license'
+apply plugin: 'jacoco'
 
 group = 'com.tokbox'
 archivesBaseName = 'opentok-server-sdk'
-version = '3.0.0-beta.2'
+version = '3.0.0-beta.3'
 
 task javadocJar(type: Jar) {
     classifier = 'javadoc'
@@ -26,6 +28,13 @@ javadoc {
     }
 }
 
+jacocoTestReport {
+    reports {
+        xml.enabled true
+        html.enabled false
+    }
+}
+
 task sourcesJar(type: Jar) {
     classifier = 'sources'
     from sourceSets.main.allSource
@@ -38,17 +47,17 @@ repositories {
 dependencies {
     testCompile group: 'junit', name: 'junit', version: '[4.3,5.0['
     testCompile group: 'com.github.tomakehurst', name: 'wiremock', version: '[1.45,1.99999)'
-    testCompile group: 'commons-lang', name: 'commons-lang', version: '[2.6,2.99999)'
+    compile group: 'commons-lang', name: 'commons-lang', version: '[2.6,2.99999)'
     compile group: 'com.ning', name: 'async-http-client', version: '[1.9,2.0['
     compile group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '[2.3.1,2.99999)'
     compile group: 'commons-validator', name: 'commons-validator', version: '[1.4.0,1.99999)'
     compile group: 'commons-codec', name: 'commons-codec', version: '[1.9,1.99999]'
+    compile group: 'org.bitbucket.b_c', name: 'jose4j', version: '0.5.1'
     // TODO: find out how to initialize these dependencies properly, or remove them
     //compile group: 'org.slf4j', name: 'slf4j-api', version: '1.7.5'
     //compile group: 'org.slf4j', name: 'slf4j-simple', version: '1.7.5'
 }
 
-apply plugin: 'license'
 license {
     header rootProject.file('codequality/HEADER')
     ext.year = Calendar.getInstance().get(Calendar.YEAR)
@@ -132,4 +141,4 @@ tasks.withType(JavaCompile) {
             // and other specific JDK jars
         }
     }
-}
+}

codecov.yml

@@ -0,0 +1,15 @@
+# Team Yaml
+coverage:
+  round: down
+  precision: 5
+
+# Repository Yaml
+coverage:
+  round: up
+  range: 0..10
+
+# Used in Codecov after updating
+coverage:
+  round: up
+  range: 0..10
+  precision: 5

sample/Archiving/public/js/host.js

@@ -1,50 +1,61 @@
-var session = OT.initSession(sessionId),
-    publisher = OT.initPublisher("publisher"),
+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) {
   archiveID = event.id;
-  console.log("ARCHIVE STARTED");
-  $(".start").hide();
-  $(".stop").show();
+  console.log('ARCHIVE STARTED');
+  $('.start').hide();
+  $('.stop').show();
   disableForm();
 });
 
 session.on('archiveStopped', function(event) {
   archiveID = null;
-  console.log("ARCHIVE STOPPED");
-  $(".start").show();
-  $(".stop").hide();
+  console.log('ARCHIVE STOPPED');
+  $('.start').show();
+  $('.stop').hide();
   enableForm();
 });
 
 $(document).ready(function() {
-  $(".start").click(function (event) {
-    var options = $(".archive-options").serialize();
+  $('.start').click(function(event) {
+    var options = $('.archive-options').serialize();
     disableForm();
-    $.post("/start", options).fail(enableForm);
+    $.post('/start', options).fail(enableForm);
   }).show();
-  $(".stop").click(function(event){
-    $.get("stop/" + archiveID);
+  $('.stop').click(function(event){
+    $.get('stop/' + archiveID);
   }).hide();
 });
 
 
 function disableForm() {
-  $(".archive-options-fields").attr('disabled', 'disabled');
+  $('.archive-options-fields').attr('disabled', 'disabled');
 }
 
 function enableForm() {
-  $(".archive-options-fields").removeAttr('disabled');
-}
+  $('.archive-options-fields').removeAttr('disabled');
+}

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);
+    }
+  });
+});

sample/Archiving/src/main/resources/com/example/freemarker/host.ftl

@@ -1,6 +1,6 @@
 <#include "header.ftl">
 
-<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">
 

sample/Archiving/src/main/resources/com/example/freemarker/participant.ftl

@@ -1,5 +1,5 @@
 <#include "header.ftl">
-  <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">
 

sample/HelloWorld/public/js/helloworld.js

@@ -1,29 +1,37 @@
 // Initialize an OpenTok Session object
-var session = OT.initSession(sessionId);
+var session = OT.initSession(apiKey, sessionId);
 
 // Initialize a Publisher, and place it into the element with id="publisher"
-var publisher = OT.initPublisher(apiKey, 'publisher');
+var publisher = OT.initPublisher('publisher');
 
 // Attach an event handler for when the session dispatches the 'streamCreated' event.
 session.on('streamCreated', function(event) {
-    // This function runs when another client publishes a stream (eg. session.publish())
+  // This function runs when another client publishes a stream (eg. session.publish())
 
-    // Subscribe to the stream that caused this event, put it inside the DOM element with id='subscribers'
-    session.subscribe(event.stream, 'subscribers', {
-        insertMode: 'append'
-    });
+  // Subscribe to the stream that caused this event, put it inside the DOM element with id='subscribers'
+  session.subscribe(event.stream, 'subscribers', {
+    insertMode: 'append'
+  }, 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, function(error) {
-    // This function runs when session.connect() asynchronously completes
-
-    // Handle connection errors
-    if (error) {
-        return console.error(error);
-    }
+session.connect(token, function(error) {
+  // This function runs when session.connect() asynchronously completes
 
+  // Handle connection errors
+  if (error) {
+    console.error('Failed to connect', error);
+  } else {
     // 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);
+      }
+    });
+  }
 });

sample/HelloWorld/src/main/resources/com/example/freemarker/index.ftl

@@ -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 = '${ apiKey }';
         var sessionId = '${ sessionId }';

src/main/java/com/opentok/Archive.java

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2016 TokBox, Inc.
+ * Copyright (C) 2017 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.
@@ -11,7 +11,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 /**
-* Represents an archive of an OpenTok session. 
+* Represents an archive of an OpenTok session.
 */
 @JsonIgnoreProperties(ignoreUnknown=true)
 public class Archive {
@@ -146,9 +146,8 @@ public int getPartnerId() {
     }
 
     /**
-     * For archives with the status of Status.STOPPED, this can be set to "maximum duration
-     * exceeded", "maximum idle time exceeded", "session ended", "user initiated". For archives
-     * with the status of Status.FAILED, this can be set to "failure".
+     * For archives with the status Status.STOPPED or Status.FAILED, this string describes the
+     * reason the archive stopped (such as "maximum duration exceeded") or failed.
      */
     public String getReason() {
         return reason;
@@ -161,7 +160,7 @@ public String getSessionId() {
         return sessionId;
     }
 
-    /** 
+    /**
      * The size of the MP4 file. For archives that have not been generated, this value is set to 0.
      */
     public int getSize() {
@@ -177,7 +176,7 @@ public Status getStatus() {
 
     /**
      * The download URL of the available MP4 file. This is only set for an archive with the status
-     * set to Status.AVAILABLE; for other archives, (including archives with the status of 
+     * set to Status.AVAILABLE; for other archives, (including archives with the status of
      * Status.UPLOADED) this method returns null. The download URL is obfuscated, and the file
      * is only available from the URL for 10 minutes. To generate a new URL, call the
      * {@link com.opentok.OpenTok#listArchives()} or {@link com.opentok.OpenTok#getArchive(String)}
@@ -202,7 +201,7 @@ public boolean hasAudio() {
     }
 
     /**
-     * The output mode to be generated for this archive: <code>composed</code> or <code>individual</code>. 
+     * The output mode to be generated for this archive: <code>composed</code> or <code>individual</code>.
      */
     public OutputMode getOutputMode() {
         return outputMode;
@@ -215,7 +214,7 @@ public String toString() {
         } catch (Exception e) {
             return "";
         }
-        
+
     }
 
-}
+}

src/main/java/com/opentok/ArchiveList.java

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2016 TokBox, Inc.
+ * Copyright (C) 2017 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.

src/main/java/com/opentok/ArchiveMode.java

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2016 TokBox, Inc.
+ * Copyright (C) 2017 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.