adds expired status to archive and skips unknown properties when parsing. fixes #44

Author: aoberoi

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

@@ -1,13 +1,15 @@
 package com.opentok;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonValue;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 /**
 * Represents an archive of an OpenTok session. 
 */
+@JsonIgnoreProperties(ignoreUnknown=true)
 public class Archive {
     /**
      * Defines values returned by the {@link Archive#getStatus} method.
@@ -38,7 +40,9 @@ public enum Status {
          * The archive file is available at the target S3 bucket you set at the
          * <a href="https://dashboard.tokbox.com">OpenTok dashboard</a>.
          */
-        UPLOADED;
+        UPLOADED,
+
+        EXPIRED;
 
         @JsonValue public String toString() {
             return super.toString().toLowerCase();

src/main/java/com/opentok/OpenTok.java

@@ -15,6 +15,7 @@
 import com.fasterxml.jackson.core.JsonParseException;
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.JsonMappingException;
 import com.fasterxml.jackson.databind.type.TypeFactory;
 import com.opentok.exception.OpenTokException;
@@ -24,6 +25,7 @@
 import com.opentok.util.HttpClient;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.ObjectReader;
 import org.xml.sax.InputSource;
 
 /**
@@ -41,6 +43,8 @@ public class OpenTok {
     private int apiKey;
     private String apiSecret;
     protected HttpClient client;
+    static protected ObjectReader archiveReader = new ObjectMapper()
+            .reader(Archive.class);
 
     /**
      * Creates an OpenTok object.
@@ -311,10 +315,9 @@ private static String readXml(String xpathQuery, String xml) throws XPathExpress
      * @return The {@link Archive} object.
      */
     public Archive getArchive(String archiveId) throws OpenTokException {
-        ObjectMapper mapper = new ObjectMapper();
         String archive = this.client.getArchive(archiveId);
         try {
-            return mapper.readValue(archive, Archive.class);
+            return archiveReader.readValue(archive);
         } catch (Exception e) {
             throw new RequestException("Exception mapping json: " + e.getMessage());
         }
@@ -385,9 +388,8 @@ public Archive startArchive(String sessionId, String name) throws OpenTokExcepti
         }
         // TODO: do validation on sessionId and name
         String archive = this.client.startArchive(sessionId, name);
-        ObjectMapper mapper = new ObjectMapper();
         try {
-            return mapper.readValue(archive, Archive.class);
+            return archiveReader.readValue(archive);
         } catch (Exception e) {
             throw new RequestException("Exception mapping json: " + e.getMessage());
         }
@@ -405,9 +407,8 @@ public Archive startArchive(String sessionId, String name) throws OpenTokExcepti
     public Archive stopArchive(String archiveId) throws OpenTokException {
 
         String archive = this.client.stopArchive(archiveId);
-        ObjectMapper mapper = new ObjectMapper();
         try {
-            return mapper.readValue(archive, Archive.class);
+            return archiveReader.readValue(archive);
         } catch (Exception e) {
             throw new RequestException("Exception mapping json: " + e.getMessage());
         }

src/test/java/com/opentok/test/OpenTokTest.java

@@ -548,4 +548,53 @@ public void testDeleteArchive() throws OpenTokException {
 
     // TODO: test delete archive failure scenarios
 
+    // NOTE: this test is pretty sloppy
+    @Test public void testGetExpiredArchive() throws OpenTokException {
+        String archiveId = "ARCHIVEID";
+        stubFor(get(urlEqualTo("/v2/partner/"+this.apiKey+"/archive/"+archiveId))
+                .willReturn(aResponse()
+                        .withStatus(200)
+                        .withHeader("Content-Type", "application/json")
+                        .withBody("{\n" +
+                                "          \"createdAt\" : 1395187836000,\n" +
+                                "          \"duration\" : 62,\n" +
+                                "          \"id\" : \"" + archiveId + "\",\n" +
+                                "          \"name\" : \"\",\n" +
+                                "          \"partnerId\" : 123456,\n" +
+                                "          \"reason\" : \"\",\n" +
+                                "          \"sessionId\" : \"SESSIONID\",\n" +
+                                "          \"size\" : 8347554,\n" +
+                                "          \"status\" : \"expired\",\n" +
+                                "          \"url\" : null\n" +
+                                "        }")));
+
+        Archive archive = sdk.getArchive(archiveId);
+        assertNotNull(archive);
+        assertEquals(Archive.Status.EXPIRED, archive.getStatus());
+    }
+
+    @Test public void testGetArchiveWithUnknownProperties() throws OpenTokException {
+        String archiveId = "ARCHIVEID";
+        stubFor(get(urlEqualTo("/v2/partner/"+this.apiKey+"/archive/"+archiveId))
+                .willReturn(aResponse()
+                        .withStatus(200)
+                        .withHeader("Content-Type", "application/json")
+                        .withBody("{\n" +
+                                "          \"createdAt\" : 1395187836000,\n" +
+                                "          \"duration\" : 62,\n" +
+                                "          \"id\" : \"" + archiveId + "\",\n" +
+                                "          \"name\" : \"\",\n" +
+                                "          \"partnerId\" : 123456,\n" +
+                                "          \"reason\" : \"\",\n" +
+                                "          \"sessionId\" : \"SESSIONID\",\n" +
+                                "          \"size\" : 8347554,\n" +
+                                "          \"status\" : \"expired\",\n" +
+                                "          \"url\" : null,\n" +
+                                "          \"thisisnotaproperty\" : null\n" +
+                                "        }")));
+
+        Archive archive = sdk.getArchive(archiveId);
+
+        assertNotNull(archive);
+    }
 }