Extract BibEntry endpoints into BibEntryResource and add tests #13731
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| package org.jabref.http.server; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.List; | ||
|
|
||
| import org.jabref.http.JabrefMediaType; | ||
| import org.jabref.http.SrvStateManager; | ||
| import org.jabref.http.dto.BibEntryDTO; | ||
| import org.jabref.http.server.services.FilesToServe; | ||
| import org.jabref.http.server.services.ServerUtils; | ||
| import org.jabref.logic.citationstyle.JabRefItemDataProvider; | ||
| import org.jabref.logic.preferences.CliPreferences; | ||
| import org.jabref.model.database.BibDatabaseContext; | ||
| import org.jabref.model.entry.BibEntry; | ||
| import org.jabref.model.entry.BibEntryTypesManager; | ||
|
|
||
| import com.airhacks.afterburner.injection.Injector; | ||
| import com.google.gson.Gson; | ||
| import de.undercouch.citeproc.csl.CSLItemData; | ||
| import jakarta.inject.Inject; | ||
| import jakarta.ws.rs.GET; | ||
| import jakarta.ws.rs.NotFoundException; | ||
| import jakarta.ws.rs.Path; | ||
| import jakarta.ws.rs.PathParam; | ||
| import jakarta.ws.rs.Produces; | ||
| import jakarta.ws.rs.core.MediaType; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| @Path("libraries/{id}/entries/{entryId}") | ||
| public class BibEntryResource { | ||
|
|
||
| private static final Logger LOGGER = LoggerFactory.getLogger(BibEntryResource.class); | ||
|
|
||
| @Inject | ||
| private CliPreferences preferences; | ||
|
|
||
| @Inject | ||
| private SrvStateManager srvStateManager; | ||
|
|
||
| @Inject | ||
| private FilesToServe filesToServe; | ||
|
|
||
| @Inject | ||
| private Gson gson; | ||
|
|
||
| @GET | ||
| @Produces(JabrefMediaType.JSON_CSL_ITEM) | ||
| public String getCSLJsonRepresentation(@PathParam("id") String id, | ||
| @PathParam("entryId") String entryId) throws IOException { | ||
| List<BibEntry> entriesByCitationKey = getDatabaseContext(id) | ||
| .getDatabase() | ||
| .getEntriesByCitationKey(entryId); | ||
|
|
||
| if (entriesByCitationKey.isEmpty()) { | ||
| throw new NotFoundException("Entry with citation key '" + entryId + "' not found in library " + id); | ||
| } | ||
|
|
||
| if (entriesByCitationKey.size() > 1) { | ||
| LOGGER.warn("Multiple CSL JSON entries found with citation key '{}'. Using the first one.", entryId); | ||
| } | ||
|
|
||
| BibEntryTypesManager entryTypesManager = Injector.instantiateModelOrService(BibEntryTypesManager.class); | ||
| JabRefItemDataProvider jabRefItemDataProvider = new JabRefItemDataProvider(); | ||
| jabRefItemDataProvider.setData(entriesByCitationKey, getDatabaseContext(id), entryTypesManager); | ||
|
|
||
| CSLItemData cslItem = jabRefItemDataProvider.retrieveItem(entryId); | ||
|
|
||
| if (cslItem == null) { | ||
| throw new NotFoundException("Unable to convert entry '" + entryId + "' to CSL JSON"); | ||
| } | ||
|
|
||
| return gson.toJson(List.of(cslItem)); | ||
| } | ||
|
|
||
| @GET | ||
| @Produces(MediaType.APPLICATION_JSON) | ||
| public String getJsonRepresentation(@PathParam("id") String id, | ||
| @PathParam("entryId") String entryId) throws IOException { | ||
| BibDatabaseContext databaseContextBib = getDatabaseContext(id); | ||
| BibEntryTypesManager entryTypesManager = Injector.instantiateModelOrService(BibEntryTypesManager.class); | ||
|
|
||
| List<BibEntryDTO> list = databaseContextBib.getDatabase() | ||
| .getEntriesByCitationKey(entryId) | ||
| .stream() | ||
| .map(entry -> new BibEntryDTO(entry, | ||
| databaseContextBib.getMode(), | ||
| preferences.getFieldPreferences(), | ||
| entryTypesManager)) | ||
| .toList(); | ||
|
|
||
| return gson.toJson(list); | ||
| } | ||
|
|
||
| private BibDatabaseContext getDatabaseContext(String id) throws IOException { | ||
| return ServerUtils.getBibDatabaseContext(id, filesToServe, srvStateManager, preferences.getImportFormatPreferences()); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| package org.jabref.http.server; | ||
|
|
||
| import org.jabref.http.JabrefMediaType; | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import jakarta.ws.rs.core.Application; | ||
| import jakarta.ws.rs.core.MediaType; | ||
| import org.glassfish.jersey.server.ResourceConfig; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
|
|
||
| class BibEntryResourceTest extends ServerTest { | ||
|
|
||
|
|
||
| private final ObjectMapper mapper = new ObjectMapper(); | ||
|
|
||
| @Override | ||
| protected Application configure() { | ||
| ResourceConfig resourceConfig = new ResourceConfig( | ||
| LibraryResource.class, | ||
| LibrariesResource.class, | ||
| BibEntryResource.class | ||
| ); | ||
| addFilesToServeToResourceConfig(resourceConfig); | ||
| addGuiBridgeToResourceConfig(resourceConfig); | ||
| addPreferencesToResourceConfig(resourceConfig); | ||
| addGsonToResourceConfig(resourceConfig); | ||
| return resourceConfig.getApplication(); | ||
| } | ||
|
|
||
| @Test | ||
| void getCSLJsonRepresentation() throws Exception { | ||
| String response = target("/libraries/" + TestBibFile.GENERAL_SERVER_TEST.id + "/entries/Author2023test") | ||
| .request(JabrefMediaType.JSON_CSL_ITEM) | ||
| .get(String.class); | ||
| String expected = """ | ||
| [ | ||
| { | ||
| "id": "Author2023test", | ||
| "type": "ARTICLE", | ||
| "author": [ | ||
| { | ||
| "family": "Author", | ||
| "given": "Demo" | ||
| } | ||
| ], | ||
| "eventDate": { | ||
| "dateParts": [ | ||
| [ | ||
| 2023 | ||
| ] | ||
| ] | ||
| }, | ||
| "issued": { | ||
| "dateParts": [ | ||
| [ | ||
| 2023 | ||
| ] | ||
| ] | ||
| }, | ||
| "title": "Demo Title" | ||
| } | ||
| ] | ||
| """; | ||
|
|
||
| JsonNode root = mapper.readTree(response); | ||
| JsonNode expectedJson = mapper.readTree(expected); | ||
|
|
||
| assertEquals(root, expectedJson, "CSL JSON must match the expected structure"); | ||
| } | ||
|
|
||
| @Test | ||
| void getJsonRepresentation() throws Exception { | ||
| String response = target("/libraries/" + TestBibFile.GENERAL_SERVER_TEST.id + "/entries/Author2023test") | ||
| .request(MediaType.APPLICATION_JSON) | ||
| .get(String.class); | ||
| String expected = """ | ||
| [ | ||
| { | ||
| "sharingMetadata": { | ||
| "sharedID": -1, | ||
| "version": 1 | ||
| }, | ||
| "userComments": "", | ||
| "citationKey": "Author2023test", | ||
| "bibtex": "@Misc{Author2023test,\\n author \\u003d {Demo Author},\\n title \\u003d {Demo Title},\\n year \\u003d {2023},\\n}\\n" | ||
| } | ||
| ] | ||
| """; | ||
|
|
||
| JsonNode root = mapper.readTree(response); | ||
|
|
||
| JsonNode expectedJson = mapper.readTree(expected); | ||
|
|
||
| assertEquals(root, expectedJson, "JSON must match the expected structure"); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Those are the ones that should be moved to the new resource.