implements TokenOptions class with Builder pattern initialization, fixes #25

aoberoi · aoberoi · commit 68a66a7bf7f8 · 2014-04-14T21:15:14.000-04:00
* refactors tests to use the new API
* moves role validation into TokenOptions
* makes expire_time a mandatory part of the token data
diff --git a/src/main/java/com/opentok/api/OpenTok.java b/src/main/java/com/opentok/api/OpenTok.java
@@ -18,6 +18,7 @@
 
 import javax.xml.bind.DatatypeConverter;
 
+import com.opentok.api.constants.TokenOptions;
 import org.codehaus.jackson.JsonNode;
 import org.codehaus.jackson.map.ObjectMapper;
 import org.codehaus.jackson.type.TypeReference;
@@ -144,87 +145,39 @@ public OpenTok(int apiKey, String apiSecret, String apiUrl) {
      *
      * @return The token string.
      */
-    public String generateToken(String sessionId, String role, long expireTime, String connectionData) throws OpenTokException {
+    public String generateToken(String sessionId, TokenOptions tokenOptions) throws OpenTokException {
 
         if(sessionId == null || sessionId == "") {
             throw new OpenTokInvalidArgumentException("Session not valid");
         }
-        String decodedSessionId = "";
-        try { 
-            String subSessionId = sessionId.substring(2);
-            for (int i = 0; i<3; i++){
-                String newSessionId = subSessionId.concat(repeatString("=",i));
-                decodedSessionId = new String(DatatypeConverter.parseBase64Binary(
-                        newSessionId.replace('-', '+').replace('_', '/')), "ISO8859_1");
-                if (decodedSessionId.contains("~")){ 
-                    break;
-                }
-            }
-        } catch (UnsupportedEncodingException e) {
-            throw new OpenTokSessionNotFoundException("Session not found");
-        }
 
-        if(!decodedSessionId.split("~")[1].equals(String.valueOf(apiKey))) {
-            throw new OpenTokSessionNotFoundException("Session not found");
-        }
+        // TODO: use more succinct codec routines
+//        String decodedSessionId = "";
+//        try {
+//            String subSessionId = sessionId.substring(2);
+//            for (int i = 0; i<3; i++){
+//                String newSessionId = subSessionId.concat(repeatString("=",i));
+//                decodedSessionId = new String(DatatypeConverter.parseBase64Binary(
+//                        newSessionId.replace('-', '+').replace('_', '/')), "ISO8859_1");
+//                if (decodedSessionId.contains("~")){
+//                    break;
+//                }
+//            }
+//        } catch (UnsupportedEncodingException e) {
+//            throw new OpenTokSessionNotFoundException("Session not found");
+//        }
+//
+//        if(!decodedSessionId.split("~")[1].equals(String.valueOf(apiKey))) {
+//            throw new OpenTokSessionNotFoundException("Session not found");
+//        }
         
         Session session = new Session(sessionId, apiKey, apiSecret);
-        return session.generateToken(role, expireTime, connectionData);
+        return session.generateToken(tokenOptions);
     }
 
-    
-
-    /**
-     * Generates the token for the given session. The role is set to publisher, the token expires in
-     * 24 hours, and there is no connection data.
-     *
-     * @param sessionId The session ID.
-     *
-     * @see #generateToken(String sessionId, String role, long expireTime, String connectionData)
-     */
     public String generateToken(String sessionId) throws OpenTokException {
-        return this.generateToken(sessionId, RoleConstants.PUBLISHER, 0, null);
-    }
-
-
-    /**
-     * Generates the token for the given session and with the specified role. The token expires in
-     * 24 hours, and there is no connection data.
-     *
-     * @param sessionId The session ID.
-     * @param role The role assigned to the token.
-     *
-     * @see #generateToken(String sessionId, String role, long expireTime, String connectionData)
-     */
-    public String generateToken(String sessionId, String role) throws OpenTokException {
-        return this.generateToken(sessionId, role, 0, null);
-    }
-
-    /**
-     * Generates the token for the given session, with the specified role and expiration time.
-     * There is no connection data.
-     *
-     * @param sessionId The session ID.
-     * @param role The role assigned to the token.
-     * @param expireTime The expiration time, in seconds, since the UNIX epoch. Pass in 0 to use
-     * the default expiration time of 24 hours after the token creation time. The maximum expiration
-     * time is 30 days after the creation time.
-     *
-     * @see #generateToken(String sessionId, String role, long expireTime, String connectionData)
-     */
-    public String generateToken(String sessionId, String role, Long expireTime) throws OpenTokException {
-        return this.generateToken(sessionId, role, expireTime, null);
-    }
-
-    /**
-     * Creates an OpenTok session and returns the session ID, with the default properties. The
-     * session uses the OpenTok media server. And the session uses the first client connecting
-     * to determine the location of OpenTok server to use.
-     *
-     * @see #createSession(SessionProperties)
-     */
-    public Session createSession() throws OpenTokException {
-        return createSession(null);
+        // NOTE: should there be a static defaultTokenOptions?
+        return generateToken(sessionId, new TokenOptions.Builder().build());
     }
 
     /**
@@ -337,6 +290,17 @@ public Session createSession(SessionProperties properties) throws OpenTokExcepti
         }
     }
 
+    /**
+     * Creates an OpenTok session and returns the session ID, with the default properties. The
+     * session uses the OpenTok media server. And the session uses the first client connecting
+     * to determine the location of OpenTok server to use.
+     *
+     * @see #createSession(SessionProperties)
+     */
+    public Session createSession() throws OpenTokException {
+        return createSession(null);
+    }
+
     private static String repeatString(String str, int times){
         StringBuilder ret = new StringBuilder();
         for(int i = 0;i < times;i++) ret.append(str);
diff --git a/src/main/java/com/opentok/api/Session.java b/src/main/java/com/opentok/api/Session.java
@@ -4,8 +4,8 @@
 import java.net.URLEncoder;
 import java.util.Random;
 
-import com.opentok.api.constants.RoleConstants;
 import com.opentok.api.constants.SessionProperties;
+import com.opentok.api.constants.TokenOptions;
 import com.opentok.exception.OpenTokException;
 import com.opentok.exception.OpenTokInvalidArgumentException;
 import com.opentok.exception.OpenTokRequestException;
@@ -54,35 +54,8 @@ public SessionProperties getProperties() {
      * @see #generateToken(String sessionId, String role, long expireTime, String connectionData)
      */
     public String generateToken() throws OpenTokException {
-        return this.generateToken(RoleConstants.PUBLISHER, 0, null);
-    }
-
-
-    /**
-     * Generates the token for the given session and with the specified role. The token expires in
-     * 24 hours, and there is no connection data.
-     *
-     * @param role The role assigned to the token.
-     *
-     * @see #generateToken(String sessionId, String role, long expireTime, String connectionData)
-     */
-    public String generateToken(String role) throws OpenTokException {
-        return this.generateToken(role, 0, null);
-    }
-
-    /**
-     * Generates the token for the given session, with the specified role and expiration time.
-     * There is no connection data.
-     *
-     * @param role The role assigned to the token.
-     * @param expireTime The expiration time, in seconds, since the UNIX epoch. Pass in 0 to use
-     * the default expiration time of 24 hours after the token creation time. The maximum expiration
-     * time is 30 days after the creation time.
-     *
-     * @see #generateToken(String sessionId, String role, long expireTime, String connectionData)
-     */
-    public String generateToken(String role, Long expireTime) throws OpenTokException {
-        return this.generateToken(role, expireTime, null);
+        // NOTE: maybe there should be a static object for the defaultTokenOptions?
+        return this.generateToken(new TokenOptions.Builder().build());
     }
 
     /**
@@ -111,9 +84,17 @@ public String generateToken(String role, Long expireTime) throws OpenTokExceptio
      *
      * @return The token string.
      */
-    public String generateToken(String role, long expireTime,
-            String connectionData) throws OpenTokInvalidArgumentException,
-            OpenTokRequestException {
+    public String generateToken(TokenOptions tokenOptions) throws
+            OpenTokInvalidArgumentException, OpenTokRequestException {
+
+        if (tokenOptions == null) {
+            throw new OpenTokInvalidArgumentException("Token options cannot be null");
+        }
+
+        String role = tokenOptions.getRole();
+        double expireTime = tokenOptions.getExpireTime(); // will be 0 if nothing was explicitly set
+        String data = tokenOptions.getData();             // will be null if nothing was explicitly set
+
         Long create_time = new Long(System.currentTimeMillis() / 1000).longValue();
         StringBuilder dataStringBuilder = new StringBuilder();
         //Build the string
@@ -128,30 +109,31 @@ public String generateToken(String role, long expireTime,
         dataStringBuilder.append("&role=");
         dataStringBuilder.append(role);
 
-        if(!RoleConstants.SUBSCRIBER.equals(role) &&
-                !RoleConstants.PUBLISHER.equals(role) &&
-                !RoleConstants.MODERATOR.equals(role) &&
-                !"".equals(role))
-            throw new OpenTokInvalidArgumentException(role + " is not a recognized role");
-
-        if (expireTime != 0) {
-            if(expireTime < (System.currentTimeMillis() / 1000)-1)
-                throw new OpenTokInvalidArgumentException("Expire time must be in the future");
-            if(expireTime > (System.currentTimeMillis() / 1000 + 2592000))
-                throw new OpenTokInvalidArgumentException("Expire time must be in the next 30 days");
-            dataStringBuilder.append("&expire_time=");
-            dataStringBuilder.append(expireTime);
+        double now = System.currentTimeMillis() / 1000L;
+        if (expireTime == 0) {
+            expireTime = now + (60*60*24); // 1 day
+        } else if(expireTime < now-1) {
+            throw new OpenTokInvalidArgumentException(
+                    "Expire time must be in the future. relative time: "+ (expireTime - now));
+        } else if(expireTime > (now + (60*60*24*30) /* 30 days */)) {
+            throw new OpenTokInvalidArgumentException(
+                    "Expire time must be in the next 30 days. too large by "+ (expireTime - (now + (60*60*24*30))));
         }
-
-        if (connectionData != null) {
-            if(connectionData.length() > 1000)
-                throw new OpenTokInvalidArgumentException("Connection data must be less than 1000 characters");
+        dataStringBuilder.append("&expire_time=");
+        dataStringBuilder.append(expireTime);
+
+        if (data != null) {
+            if(data.length() > 1000) {
+                throw new OpenTokInvalidArgumentException(
+                        "Connection data must be less than 1000 characters. length: " + data.length());
+            }
             dataStringBuilder.append("&connection_data=");
             try {
-                dataStringBuilder.append(URLEncoder.encode(connectionData, "UTF-8"));
+                dataStringBuilder.append(URLEncoder.encode(data, "UTF-8"));
             } catch (UnsupportedEncodingException e) {
-                throw new OpenTokInvalidArgumentException("Error during URL encode of your connectionData: " +  e.getMessage());
-            };
+                throw new OpenTokInvalidArgumentException(
+                        "Error during URL encode of your connection data: " +  e.getMessage());
+            }
         }
 
 
@@ -165,6 +147,7 @@ public String generateToken(String role, long expireTime,
 
             innerBuilder.append("&sig=");
 
+            // TODO: user a more concise crypto routine
             innerBuilder.append(GenerateMac.calculateRFC2104HMAC(dataStringBuilder.toString(),
                     this.apiSecret));
             innerBuilder.append(":");
diff --git a/src/main/java/com/opentok/api/constants/TokenOptions.java b/src/main/java/com/opentok/api/constants/TokenOptions.java
@@ -0,0 +1,73 @@
+package com.opentok.api.constants;
+
+import com.opentok.exception.OpenTokInvalidArgumentException;
+
+/**
+ * Created by ankur on 4/14/14.
+ */
+public class TokenOptions {
+
+    private String role;
+    private double expireTime;
+    private String data;
+
+    private TokenOptions(Builder builder) {
+        this.role = builder.role != null ? builder.role : "publisher";
+
+        // default value calculated at token generation time
+        this.expireTime = builder.expireTime;
+
+        // default value of null means to omit the key "connection_data" from the token
+        this.data = builder.data;
+    }
+
+    public String getRole() {
+        return role;
+    }
+
+    public double getExpireTime() {
+        return expireTime;
+    }
+
+    public String getData() {
+        return data;
+    }
+
+    // TODO: toMap() method?
+
+    public static class Builder {
+        private String role;
+        private double expireTime = 0;
+        private String data;
+
+        public Builder role(String role) throws OpenTokInvalidArgumentException {
+            if (role.equals("publisher") || role.equals("subscriber") || role.equals("moderator")) {
+                this.role = role;
+            } else {
+                throw new OpenTokInvalidArgumentException("The given role is not valid: " + role);
+            }
+            return this;
+        }
+
+        public Builder expireTime(double expireTime) {
+            // NOTE: since this object can be stored/cached, validation should occur at token generation time
+            this.expireTime = expireTime;
+            return this;
+        }
+
+        public Builder data(String data) throws OpenTokInvalidArgumentException {
+            if (data.length() <= 1000) {
+                this.data = data;
+            } else {
+                throw new OpenTokInvalidArgumentException(
+                        "The given connection data is too long, limit is 1000 characters: "+data.length());
+            }
+            return this;
+        }
+
+        public TokenOptions build() {
+            return new TokenOptions(this);
+        }
+    }
+
+}
diff --git a/src/test/java/com/opentok/test/OpenTokTest.java b/src/test/java/com/opentok/test/OpenTokTest.java
