Skip to content

API consistency: OK, response only has "data", remove okResponseGsonObject #3433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pdurbin wants to merge 1 commit into from
Closed

API consistency: OK, response only has "data", remove okResponseGsonObject #3433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 0 additions & 19 deletions src/main/java/edu/harvard/iq/dataverse/api/AbstractApiBean.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -499,26 +499,7 @@ protected Response ok( String msg ) {
.type(MediaType.APPLICATION_JSON)
.build();
}


/**
* Added to accommodate a JSON String generated from gson
*
* @param gsonObject
* @return
*/
protected Response okResponseGsonObject(String msg, com.google.gson.JsonObject gsonObject){

if (gsonObject == null){
throw new NullPointerException("gsonObject cannot be null");
}

gsonObject.addProperty("status", "OK");
gsonObject.addProperty("message", msg);

return Response.ok(gsonObject.toString(), MediaType.APPLICATION_JSON).build();
}

/**
* Returns an OK response (HTTP 200, status:OK) with the passed value
* in the data field.
Expand Down
4 changes: 1 addition & 3 deletions src/main/java/edu/harvard/iq/dataverse/api/Datasets.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -661,9 +661,7 @@ public Response addFileToDataset(@PathParam("id") String idSupplied,
String successMsg = ResourceBundle.getBundle("Bundle").getString("file.addreplace.success.add");
try {
//msgt("as String: " + addFileHelper.getSuccessResult());

return okResponseGsonObject(successMsg,
addFileHelper.getSuccessResultAsGsonObject());
return ok(AddReplaceFileHelper.convertGsonObjectToJsonObjectBuilder(successMsg, addFileHelper.getSuccessResultAsGsonObject()));
//"Look at that! You added a file! (hey hey, it may have worked)");
} catch (NoFilesException ex) {
Logger.getLogger(Files.class.getName()).log(Level.SEVERE, null, ex);
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/edu/harvard/iq/dataverse/api/Files.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,8 @@ public Response replaceFileInDataset(

try {
msgt("as String: " + addFileHelper.getSuccessResult());
return okResponseGsonObject(successMsg,
addFileHelper.getSuccessResultAsGsonObject());
return ok(AddReplaceFileHelper.convertGsonObjectToJsonObjectBuilder(successMsg, addFileHelper.getSuccessResultAsGsonObject()));

//"Look at that! You added a file! (hey hey, it may have worked)");
} catch (NoFilesException ex) {
Logger.getLogger(Files.class.getName()).log(Level.SEVERE, null, ex);
Expand Down
16 changes: 14 additions & 2 deletions src/main/java/edu/harvard/iq/dataverse/datasetutility/AddReplaceFileHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import edu.harvard.iq.dataverse.ingest.IngestServiceBean;
import java.io.IOException;
import java.io.InputStream;
import java.io.StringReader;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
Expand All @@ -34,6 +35,9 @@
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.ejb.EJBException;
import javax.json.Json;
import javax.json.JsonObjectBuilder;
import javax.json.JsonReader;
import javax.validation.ConstraintViolation;
import javax.ws.rs.core.Response;

Expand Down Expand Up @@ -1468,8 +1472,16 @@ public JsonObject getSuccessResultAsGsonObject() throws NoFilesException{
//return newlyAddedFile.asGsonObject(false);

}



public static JsonObjectBuilder convertGsonObjectToJsonObjectBuilder(String successMsg, JsonObject gsonObject) {
JsonObjectBuilder jsonObjectBuilder = Json.createObjectBuilder();
jsonObjectBuilder.add("message", successMsg);
JsonReader jsonReader = Json.createReader(new StringReader(gsonObject.toString()));
javax.json.JsonObject object = jsonReader.readObject();
jsonObjectBuilder.add("files", object.get("files"));
return jsonObjectBuilder;
}

/**
* Currently this is a placeholder if we decide to send
* user notifications.
Expand Down
48 changes: 24 additions & 24 deletions src/test/java/edu/harvard/iq/dataverse/api/FilesIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@ public void test_001_AddFileGood() {


addResponse.then().assertThat()
.body("message", equalTo(successMsg))
.body("data.message", equalTo(successMsg))
.body("status", equalTo(AbstractApiBean.STATUS_OK))
.body("files[0].contentType", equalTo("image/png"))
.body("files[0].filename", equalTo("dataverseproject.png"))
.body("data.files[0].contentType", equalTo("image/png"))
.body("data.files[0].filename", equalTo("dataverseproject.png"))
.statusCode(OK.getStatusCode());


Expand Down Expand Up @@ -240,13 +240,13 @@ public void test_006_ReplaceFileGood() {
String successMsgAdd = ResourceBundle.getBundle("Bundle").getString("file.addreplace.success.add");

addResponse.then().assertThat()
.body("message", equalTo(successMsgAdd))
.body("files[0].contentType", equalTo("image/png"))
.body("files[0].filename", equalTo("dataverseproject.png"))
.body("data.message", equalTo(successMsgAdd))
.body("data.files[0].contentType", equalTo("image/png"))
.body("data.files[0].filename", equalTo("dataverseproject.png"))
.statusCode(OK.getStatusCode());


long origFileId = JsonPath.from(addResponse.body().asString()).getLong("files[0].id");
long origFileId = JsonPath.from(addResponse.body().asString()).getLong("data.files[0].id");

msg("Orig file id: " + origFileId);
assertNotNull(origFileId); // If checkOut fails, display message
Expand Down Expand Up @@ -296,14 +296,14 @@ public void test_006_ReplaceFileGood() {

replaceResp.then().assertThat()
.statusCode(OK.getStatusCode())
.body("message", equalTo(successMsg2))
.body("files[0].filename", equalTo("cc0.png"))
.body("data.message", equalTo(successMsg2))
.body("data.files[0].filename", equalTo("cc0.png"))
//.body("data.rootDataFileId", equalTo(origFileId))
;

long rootDataFileId = JsonPath.from(replaceResp.body().asString()).getLong("files[0].rootDataFileId");
long previousDataFileId = JsonPath.from(replaceResp.body().asString()).getLong("files[0].previousDataFileId");
long newDataFileId = JsonPath.from(replaceResp.body().asString()).getLong("files[0].id");
long rootDataFileId = JsonPath.from(replaceResp.body().asString()).getLong("data.files[0].rootDataFileId");
long previousDataFileId = JsonPath.from(replaceResp.body().asString()).getLong("data.files[0].previousDataFileId");
long newDataFileId = JsonPath.from(replaceResp.body().asString()).getLong("data.files[0].id");

assertEquals(origFileId, previousDataFileId);
assertEquals(rootDataFileId, previousDataFileId);
Expand All @@ -330,12 +330,12 @@ public void test_006_ReplaceFileGood() {
replaceResp2.then().assertThat()
.statusCode(OK.getStatusCode())
.body("status", equalTo(AbstractApiBean.STATUS_OK))
.body("message", equalTo(successMsg2))
.body("files[0].filename", equalTo("favicondataverse.png"))
.body("data.message", equalTo(successMsg2))
.body("data.files[0].filename", equalTo("favicondataverse.png"))
;

long rootDataFileId2 = JsonPath.from(replaceResp2.body().asString()).getLong("files[0].rootDataFileId");
long previousDataFileId2 = JsonPath.from(replaceResp2.body().asString()).getLong("files[0].previousDataFileId");
long rootDataFileId2 = JsonPath.from(replaceResp2.body().asString()).getLong("data.files[0].rootDataFileId");
long previousDataFileId2 = JsonPath.from(replaceResp2.body().asString()).getLong("data.files[0].previousDataFileId");

msgt("newDataFileId: " + newDataFileId);
msgt("previousDataFileId2: " + previousDataFileId2);
Expand Down Expand Up @@ -369,13 +369,13 @@ public void test_007_ReplaceFileUnpublishedAndBadIds() {
String successMsgAdd = ResourceBundle.getBundle("Bundle").getString("file.addreplace.success.add");

addResponse.then().assertThat()
.body("message", equalTo(successMsgAdd))
.body("files[0].contentType", equalTo("image/png"))
.body("files[0].filename", equalTo("dataverseproject.png"))
.body("data.message", equalTo(successMsgAdd))
.body("data.files[0].contentType", equalTo("image/png"))
.body("data.files[0].filename", equalTo("dataverseproject.png"))
.statusCode(OK.getStatusCode());


long origFileId = JsonPath.from(addResponse.body().asString()).getLong("files[0].id");
long origFileId = JsonPath.from(addResponse.body().asString()).getLong("data.files[0].id");

msg("Orig file id: " + origFileId);
assertNotNull(origFileId); // If checkOut fails, display message
Expand Down Expand Up @@ -452,13 +452,13 @@ public void test_008_ReplaceFileAlreadyDeleted() {
String successMsgAdd = ResourceBundle.getBundle("Bundle").getString("file.addreplace.success.add");

addResponse.then().assertThat()
.body("message", equalTo(successMsgAdd))
.body("files[0].contentType", equalTo("image/png"))
.body("files[0].filename", equalTo("dataverseproject.png"))
.body("data.message", equalTo(successMsgAdd))
.body("data.files[0].contentType", equalTo("image/png"))
.body("data.files[0].filename", equalTo("dataverseproject.png"))
.statusCode(OK.getStatusCode());


long origFileId = JsonPath.from(addResponse.body().asString()).getLong("files[0].id");
long origFileId = JsonPath.from(addResponse.body().asString()).getLong("data.files[0].id");

msg("Orig file id: " + origFileId);
assertNotNull(origFileId); // If checkOut fails, display message
Expand Down