Added: canDataFileBeDownloaded API endpoint

IQSS · Jul 7, 2023 · 6ead834 · 6ead834
1 parent 886a508
commit 6ead834
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 2 deletions.
diff --git a/src/main/java/edu/harvard/iq/dataverse/api/Files.java b/src/main/java/edu/harvard/iq/dataverse/api/Files.java
@@ -11,6 +11,7 @@
 import edu.harvard.iq.dataverse.DataverseRequestServiceBean;
 import edu.harvard.iq.dataverse.DataverseServiceBean;
 import edu.harvard.iq.dataverse.EjbDataverseEngine;
+import edu.harvard.iq.dataverse.FileDownloadServiceBean;
 import edu.harvard.iq.dataverse.FileMetadata;
 import edu.harvard.iq.dataverse.GuestbookResponseServiceBean;
 import edu.harvard.iq.dataverse.TermsOfUseAndAccessValidator;
@@ -106,6 +107,9 @@ public class Files extends AbstractApiBean {
     @Inject
     GuestbookResponseServiceBean guestbookResponseService;
 
+    @Inject
+    FileDownloadServiceBean fileDownloadServiceBean;
+
     private static final Logger logger = Logger.getLogger(Files.class.getName());
 
 
@@ -824,11 +828,18 @@ public Response getFixityAlgorithm() {
 
     @GET
     @Path("{id}/guestbookResponses/count")
-    public Response getCountGuestbookResponsesByDataFileId(@PathParam("id") String dataFileId) {
+    public Response getCountGuestbookResponsesByDataFileId(@PathParam("id") long dataFileId) {
         try {
-            return ok(guestbookResponseService.getCountGuestbookResponsesByDataFileId(Long.parseLong(dataFileId)).toString());
+            return ok(guestbookResponseService.getCountGuestbookResponsesByDataFileId(dataFileId).toString());
         } catch (NumberFormatException nfe) {
             return badRequest("File identifier has to be numeric.");
         }
     }
+
+    @GET
+    @AuthRequired
+    @Path("{id}/canBeDownloaded")
+    public Response canDataFileBeDownloaded(@Context ContainerRequestContext crc, @PathParam("id") long dataFileId) {
+        return ok(fileDownloadServiceBean.canDownloadFile(getRequestUser(crc), fileSvc.find(dataFileId).getFileMetadata()));
+    }
 }
diff --git a/src/test/java/edu/harvard/iq/dataverse/api/FilesIT.java b/src/test/java/edu/harvard/iq/dataverse/api/FilesIT.java
@@ -2054,4 +2054,36 @@ public void testGetCountGuestbookResponsesByDataFileId() {
                 .statusCode(OK.getStatusCode())
                 .body("data.message", equalTo("1"));
     }
+
+    @Test
+    public void testCanDataFileBeDownloaded() {
+        Response createUser = UtilIT.createRandomUser();
+        createUser.then().assertThat().statusCode(OK.getStatusCode());
+        String apiToken = UtilIT.getApiTokenFromResponse(createUser);
+
+        Response createDataverseResponse = UtilIT.createRandomDataverse(apiToken);
+        createDataverseResponse.then().assertThat().statusCode(CREATED.getStatusCode());
+        String dataverseAlias = UtilIT.getAliasFromResponse(createDataverseResponse);
+
+        Response createDatasetResponse = UtilIT.createRandomDatasetViaNativeApi(dataverseAlias, apiToken);
+        createDatasetResponse.then().assertThat().statusCode(CREATED.getStatusCode());
+        Integer datasetId = JsonPath.from(createDatasetResponse.body().asString()).getInt("data.id");
+
+        // Upload test file
+        String pathToTestFile = "src/main/webapp/resources/images/dataverseproject.png";
+        Response uploadResponse = UtilIT.uploadFileViaNative(datasetId.toString(), pathToTestFile, Json.createObjectBuilder().build(), apiToken);
+        uploadResponse.then().assertThat().statusCode(OK.getStatusCode());
+
+        // Publish collection and dataset
+        UtilIT.publishDataverseViaNativeApi(dataverseAlias, apiToken).then().assertThat().statusCode(OK.getStatusCode());
+        UtilIT.publishDatasetViaNativeApi(datasetId, "major", apiToken).then().assertThat().statusCode(OK.getStatusCode());
+
+        // Assert user can download test file
+        Integer testFileId = JsonPath.from(uploadResponse.body().asString()).getInt("data.files[0].dataFile.id");
+        Response canDataFileBeDownloadedResponse = UtilIT.canDataFileBeDownloaded(testFileId, apiToken);
+
+        canDataFileBeDownloadedResponse.then().assertThat().statusCode(OK.getStatusCode());
+        boolean canDownloadTestFile = JsonPath.from(canDataFileBeDownloadedResponse.body().asString()).getBoolean("data");
+        assertTrue(canDownloadTestFile);
+    }
 }
diff --git a/src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java b/src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java
@@ -3275,4 +3275,10 @@ static Response getCountGuestbookResponsesByDataFileId(Integer dataFileId, Strin
                 .header(API_TOKEN_HTTP_HEADER, apiToken)
                 .get("/api/files/" + dataFileId + "/guestbookResponses/count");
     }
+
+    static Response canDataFileBeDownloaded(Integer dataFileId, String apiToken) {
+        return given()
+                .header(API_TOKEN_HTTP_HEADER, apiToken)
+                .get("/api/files/" + dataFileId + "/canBeDownloaded");
+    }
 }