feat: Expose getVersionByID method on BoxFile (#1268)

Author: arjankowski

src/intTest/java/com/box/sdk/BoxFileIT.java

@@ -432,6 +432,27 @@ public void uploadNewVersionSucceeds() {
         }
     }
 
+    @Test
+    public void getVersionSucceeds() {
+        BoxAPIConnection api = jwtApiForServiceAccount();
+        String fileName = "[getVersionByIdSucceeds] Multi-version File.txt";
+        BoxFile uploadedFile = null;
+        try {
+            uploadedFile = uploadFileToUniqueFolder(api, fileName, "Test file");
+            uploadedFile.uploadNewVersion(this.getFileContent("Version 2"));
+
+            Collection<BoxFileVersion> versions = uploadedFile.getVersions();
+            BoxFileVersion versionFromGetVersions = versions.iterator().next();
+
+            BoxFileVersion versionFromGetById = uploadedFile.getVersionByID(versionFromGetVersions.getID());
+
+            assertThat(versionFromGetVersions.getVersionID(), equalTo(versionFromGetById.getVersionID()));
+            assertThat(versionFromGetVersions.getFileID(), equalTo(versionFromGetById.getFileID()));
+        } finally {
+            deleteFile(uploadedFile);
+        }
+    }
+
     @Test
     public void deleteVersionSucceeds() {
         BoxAPIConnection api = jwtApiForServiceAccount();

src/main/java/com/box/sdk/BoxFile.java

@@ -354,6 +354,7 @@ public void downloadRange(OutputStream output, long rangeStart, long rangeEnd, P
 
     /**
      * Can be used to override the URL used for file download.
+     *
      * @return URL for file downalod
      */
     protected URL getDownloadUrl() {
@@ -631,6 +632,32 @@ public void updateInfo(BoxFile.Info info) {
         }
     }
 
+    /**
+     * Retrieve a specific file version.
+     *
+     * @param fileVersionID the ID of the file version to retrieve.
+     * @param fields        the optional fields to retrieve.
+     * @return a specific file version.
+     */
+    public BoxFileVersion getVersionByID(String fileVersionID, String... fields) {
+        URL url = BoxFileVersion.VERSION_URL_TEMPLATE.build(this.getAPI().getBaseURL(), this.getID(), fileVersionID);
+        if (fields.length > 0) {
+            String queryString = new QueryStringBuilder().appendParam("fields", fields).toString();
+            url = BoxFileVersion.VERSION_URL_TEMPLATE.buildWithQuery(
+                this.getAPI().getBaseURL(),
+                queryString,
+                this.getID(),
+                fileVersionID
+            );
+        }
+
+        BoxJSONRequest request = new BoxJSONRequest(this.getAPI(), url, "GET");
+        try (BoxJSONResponse response = request.send()) {
+            JsonObject jsonObject = Json.parse(response.getJSON()).asObject();
+            return new BoxFileVersion(this.getAPI(), jsonObject, this.getID());
+        }
+    }
+
     /**
      * Gets up to 1000 versions of this file. Note that only users with premium accounts will be able to retrieve
      * previous versions of their files. `fields` parameter is optional, if specified only requested fields will
@@ -661,8 +688,8 @@ public Collection<BoxFileVersion> getVersions(String... fields) {
      */
     public PartialCollection<BoxFileVersion> getVersionsRange(long offset, long limit, String... fields) {
         QueryStringBuilder builder = new QueryStringBuilder()
-                .appendParam("limit", limit)
-                .appendParam("offset", offset);
+            .appendParam("limit", limit)
+            .appendParam("offset", offset);
 
         if (fields.length > 0) {
             builder.appendParam("fields", fields);
@@ -1439,7 +1466,7 @@ private BoxCollaboration.Info collaborate(JsonObject accessibleByField, BoxColla
         itemField.add("type", "file");
 
         return BoxCollaboration.create(this.getAPI(), accessibleByField, itemField, role, notify, canViewPath,
-                expiresAt, isAccessOnly);
+            expiresAt, isAccessOnly);
     }
 
     /**
@@ -1487,10 +1514,10 @@ public BoxCollaboration.Info collaborate(BoxCollaborator collaborator, BoxCollab
      * Adds a collaborator to this folder. An email will be sent to the collaborator if they don't already have a Box
      * account.
      *
-     * @param email       the email address of the collaborator to add.
-     * @param role        the role of the collaborator.
-     * @param notify      determines if the user (or all the users in the group) will receive email notifications.
-     * @param canViewPath whether view path collaboration feature is enabled or not.
+     * @param email        the email address of the collaborator to add.
+     * @param role         the role of the collaborator.
+     * @param notify       determines if the user (or all the users in the group) will receive email notifications.
+     * @param canViewPath  whether view path collaboration feature is enabled or not.
      * @param expiresAt    when the collaboration should expire.
      * @param isAccessOnly whether the collaboration is access only or not.
      * @return info about the new collaboration.

src/test/Fixtures/BoxFile/GetFileVersion200.json

@@ -0,0 +1,17 @@
+{
+  "type": "file_version",
+  "id": "12345",
+  "sha1": "a783fb33dcc129625d36c1b401fd315222590b5d",
+  "name": "Example.jpg",
+  "size": 37921,
+  "created_at": "2018-05-02T13:50:57-07:00",
+  "modified_at": "2018-05-02T13:50:59-07:00",
+  "modified_by": {
+    "type": "user",
+    "id": "1111",
+    "name": "Test User",
+    "login": "[email protected]"
+  },
+  "trashed_at": null,
+  "purged_at": null
+}

src/test/java/com/box/sdk/BoxFileTest.java

@@ -420,7 +420,7 @@ public void testGetThumbnailSucceeds() {
         );
         wireMockRule.stubFor(
             WireMock.get(WireMock.urlPathEqualTo(
-                "/2.0/internal_files/12345/versions/1116420931563/representations/jpg_thumb_32x32")
+                    "/2.0/internal_files/12345/versions/1116420931563/representations/jpg_thumb_32x32")
                 )
                 .willReturn(WireMock.aResponse()
                     .withHeader("Content-Type", APPLICATION_JSON)
@@ -429,7 +429,7 @@ public void testGetThumbnailSucceeds() {
         );
         wireMockRule.stubFor(
             WireMock.get(WireMock.urlPathEqualTo(
-                "/2.0/internal_files/1030335435441/versions/1116437417841/representations/jpg_thumb_32x32/content/"
+                    "/2.0/internal_files/1030335435441/versions/1116437417841/representations/jpg_thumb_32x32/content/"
                 ))
                 .willReturn(WireMock.aResponse()
                     .withHeader("Content-Type", "image/jpg")
@@ -527,6 +527,26 @@ public void testGetRepresentationContentSuccess() {
         assertThat(output.toString(), equalTo("This is a JPG"));
     }
 
+    @Test
+    public void testGetFileVersionByIdSucceeds() {
+        final String versionID = "12345";
+        final String fileID = "1111";
+        final String versionURL = "/2.0/files/" + fileID + "/versions/" + versionID;
+
+        String versionResult = getFixture("BoxFile/GetFileVersion200");
+
+        wireMockRule.stubFor(WireMock.get(WireMock.urlPathEqualTo(versionURL))
+            .willReturn(WireMock.aResponse()
+                .withHeader("Content-Type", APPLICATION_JSON)
+                .withBody(versionResult)));
+
+        BoxFile file = new BoxFile(this.api, fileID);
+        BoxFileVersion version = file.getVersionByID(versionID);
+
+        assertEquals(versionID, version.getVersionID());
+        assertEquals(fileID, version.getFileID());
+    }
+
     @Test
     public void testDeletePreviousFileVersionSucceeds() {
         final String versionID = "12345";
@@ -1213,20 +1233,20 @@ public void getVersionsWithLimitAndOffset() {
 
         // then
         api.setRequestInterceptor(
-                request -> {
-                    try {
-                        String query = URLDecoder.decode(request.getUrl().getQuery(), "UTF-8");
-                        assertThat(query, containsString("limit=10&offset=0&fields=name,version_number"));
-                        return new BoxJSONResponse() {
-                            @Override
-                            public String getJSON() {
-                                return "{\"entries\": [], \"total_count\": 100}";
-                            }
-                        };
-                    } catch (UnsupportedEncodingException e) {
-                        throw new RuntimeException(e);
-                    }
+            request -> {
+                try {
+                    String query = URLDecoder.decode(request.getUrl().getQuery(), "UTF-8");
+                    assertThat(query, containsString("limit=10&offset=0&fields=name,version_number"));
+                    return new BoxJSONResponse() {
+                        @Override
+                        public String getJSON() {
+                            return "{\"entries\": [], \"total_count\": 100}";
+                        }
+                    };
+                } catch (UnsupportedEncodingException e) {
+                    throw new RuntimeException(e);
                 }
+            }
         );
 
         // when