From 2b1ce80b084a9b890e4cdb84ff92c04212ef84cf Mon Sep 17 00:00:00 2001 From: Julia Damerow Date: Mon, 20 Jun 2022 16:55:29 -0400 Subject: [PATCH 01/17] [CITE-177] setup and created service to query crossref --- citesphere/pom.xml | 8 +++- .../service/crossref/CrossrefService.java | 13 +++++++ .../crossref/impl/CrossrefServiceImpl.java | 38 +++++++++++++++++++ .../web/user/MoveItemsController.java | 6 ++- .../src/main/resources/config.properties | 2 + 5 files changed, 64 insertions(+), 3 deletions(-) create mode 100644 citesphere/src/main/java/edu/asu/diging/citesphere/core/service/crossref/CrossrefService.java create mode 100644 citesphere/src/main/java/edu/asu/diging/citesphere/core/service/crossref/impl/CrossrefServiceImpl.java diff --git a/citesphere/pom.xml b/citesphere/pom.xml index e5d4af906..6477fc1c9 100644 --- a/citesphere/pom.xml +++ b/citesphere/pom.xml @@ -26,6 +26,7 @@ 0.12 0.4 1.17 + 0.1 $2a$04$oQo44vqcDIFRoYKiAXoNheurzkwX9dcNmowvTX/hsWuBMwijqn44i @@ -156,6 +157,11 @@ citesphere-model ${citesphere.model.version} + + edu.asu.diging + crossref-connect + ${crossref-connect-version} + @@ -626,7 +632,7 @@ org.apache.maven.plugins maven-war-plugin - 2.6 + 3.3.2 diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/crossref/CrossrefService.java b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/crossref/CrossrefService.java new file mode 100644 index 000000000..f331608fa --- /dev/null +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/crossref/CrossrefService.java @@ -0,0 +1,13 @@ +package edu.asu.diging.citesphere.core.service.crossref; + +import java.io.IOException; +import java.util.List; + +import edu.asu.diging.crossref.exception.RequestFailedException; +import edu.asu.diging.crossref.model.Item; + +public interface CrossrefService { + + List search(String query, int page) throws RequestFailedException, IOException; + +} \ No newline at end of file diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/crossref/impl/CrossrefServiceImpl.java b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/crossref/impl/CrossrefServiceImpl.java new file mode 100644 index 000000000..143aef735 --- /dev/null +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/crossref/impl/CrossrefServiceImpl.java @@ -0,0 +1,38 @@ +package edu.asu.diging.citesphere.core.service.crossref.impl; + +import java.io.IOException; +import java.util.List; + +import javax.annotation.PostConstruct; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.annotation.PropertySource; +import org.springframework.stereotype.Service; + +import edu.asu.diging.citesphere.core.service.crossref.CrossrefService; +import edu.asu.diging.crossref.exception.RequestFailedException; +import edu.asu.diging.crossref.model.Item; +import edu.asu.diging.crossref.service.CrossrefConfiguration; +import edu.asu.diging.crossref.service.CrossrefWorksService; +import edu.asu.diging.crossref.service.impl.CrossrefWorksServiceImpl; + +@Service +@PropertySource("config.properties") +public class CrossrefServiceImpl implements CrossrefService { + + @Value("${_crossref_default_pagesize}") + private int defaultPageSize; + + private CrossrefWorksService service; + + @PostConstruct + public void init() { + service = new CrossrefWorksServiceImpl(CrossrefConfiguration.getDefaultConfig()); + } + + + @Override + public List search(String query, int page) throws RequestFailedException, IOException { + return service.search(query, defaultPageSize, (page-1)*defaultPageSize); + } +} diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/MoveItemsController.java b/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/MoveItemsController.java index 0858c497f..9e703e567 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/MoveItemsController.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/MoveItemsController.java @@ -97,7 +97,8 @@ public class MoveItemsController { "/auth/group/{zoteroGroupId}/collection/{parentcollectionId}/items/move/{targetCollectionId}/sync/start" }) public @ResponseBody Sync startSync(Authentication authentication, - @PathVariable("zoteroGroupId") String zoteroGroupId, @PathVariable("targetCollectionId") String collectionId, + @PathVariable("zoteroGroupId") String zoteroGroupId, + @PathVariable("targetCollectionId") String collectionId, @RequestParam(defaultValue = "1", required = false, value = "page") String page) { try { citationManager.getGroupItems((IUser) authentication.getPrincipal(), zoteroGroupId, collectionId, @@ -119,7 +120,8 @@ public class MoveItemsController { "/auth/group/{zoteroGroupId}/collection/{parentcollectionId}/items/move/{targetCollectionId}/totalItems" }) public @ResponseBody Long getTotalCitationsCollection(Authentication authentication, - @PathVariable("zoteroGroupId") String zoteroGroupId, @PathVariable("targetCollectionId") String collectionId) { + @PathVariable("zoteroGroupId") String zoteroGroupId, + @PathVariable("targetCollectionId") String collectionId) { ICitationCollection collection = collectionManager.getCollection((IUser) authentication.getPrincipal(), zoteroGroupId, collectionId); return collection.getNumberOfItems(); diff --git a/citesphere/src/main/resources/config.properties b/citesphere/src/main/resources/config.properties index 07328b26f..d547d1dbd 100644 --- a/citesphere/src/main/resources/config.properties +++ b/citesphere/src/main/resources/config.properties @@ -89,3 +89,5 @@ giles_check_endpoint=/api/v2/files/upload/check/ giles_file_endpoint=/api/v2/resources/files/{0}/content javers_default_author=${javers.default.author} + +_crossref_default_pagesize=50 From 557f26f0525c7d5b561e9b20f712396c1af2a632 Mon Sep 17 00:00:00 2001 From: Julia Damerow Date: Wed, 6 Jul 2022 15:38:17 -0400 Subject: [PATCH 02/17] [CITE-177] front end and backend changes to start crossref import --- citesphere/pom.xml | 2 +- .../api/v1/user/JobInfoController.java | 10 +- .../core/model/jobs/IImportCrossrefJob.java | 15 +++ .../model/jobs/impl/ImportCrossrefJob.java | 31 ++++++ .../jobs/ImportCrossrefJobRepository.java | 9 ++ .../crossref/impl/CrossrefServiceImpl.java | 2 +- .../jobs/IImportCrossrefJobManager.java | 13 +++ .../jobs/impl/ImportCrossrefJobManager.java | 79 +++++++++++++ .../user/jobs/ImportCrossrefController.java | 83 ++++++++++++++ .../src/main/resources/config.properties | 2 +- .../WEB-INF/views/auth/import/crossref.html | 105 ++++++++++++++++++ .../webapp/WEB-INF/views/layouts/main.html | 2 + 12 files changed, 347 insertions(+), 6 deletions(-) create mode 100644 citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/IImportCrossrefJob.java create mode 100644 citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/impl/ImportCrossrefJob.java create mode 100644 citesphere/src/main/java/edu/asu/diging/citesphere/core/repository/jobs/ImportCrossrefJobRepository.java create mode 100644 citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/IImportCrossrefJobManager.java create mode 100644 citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java create mode 100644 citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java create mode 100644 citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html diff --git a/citesphere/pom.xml b/citesphere/pom.xml index 6477fc1c9..188201dff 100644 --- a/citesphere/pom.xml +++ b/citesphere/pom.xml @@ -24,7 +24,7 @@ 6.2.3 2.2.6.RELEASE 0.12 - 0.4 + 0.5 1.17 0.1 diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java b/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java index cab48f00c..89b95ece0 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java @@ -9,12 +9,14 @@ import org.springframework.web.bind.annotation.RequestMapping; import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.ArrayNode; import com.fasterxml.jackson.databind.node.ObjectNode; import edu.asu.diging.citesphere.core.export.IExportTaskManager; import edu.asu.diging.citesphere.core.model.IZoteroToken; import edu.asu.diging.citesphere.core.model.export.IExportTask; import edu.asu.diging.citesphere.core.model.jobs.IExportJob; +import edu.asu.diging.citesphere.core.model.jobs.IImportCrossrefJob; import edu.asu.diging.citesphere.core.model.jobs.IJob; import edu.asu.diging.citesphere.core.model.jobs.IUploadJob; import edu.asu.diging.citesphere.core.service.jobs.IUploadJobManager; @@ -62,16 +64,18 @@ public ResponseEntity getProfile(@RequestHeader HttpHeaders headers) { // FIXME: ugly, needs better solution if (job instanceof IUploadJob) { node.put("groupId", ((IUploadJob)job).getCitationGroup()); - } - if (job instanceof IExportJob) { + } else if (job instanceof IExportJob) { IExportTask exportTask = exportTaskManager.get(((IExportJob)job).getTaskId()); node.put("groupId", exportTask.getGroupId()); node.put("collectionId", exportTask.getCollectionId()); node.put("exportType", exportTask.getExportType().name()); node.put("taskId", exportTask.getId()); + } else if (job instanceof IImportCrossrefJob) { + ArrayNode doisNode = mapper.createArrayNode(); + ((IImportCrossrefJob)job).getDois().forEach(d -> doisNode.add(d)); + node.set("dois", doisNode); } - return new ResponseEntity<>(node.toString(), HttpStatus.OK); } } diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/IImportCrossrefJob.java b/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/IImportCrossrefJob.java new file mode 100644 index 000000000..e1b37724d --- /dev/null +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/IImportCrossrefJob.java @@ -0,0 +1,15 @@ +package edu.asu.diging.citesphere.core.model.jobs; + +import java.util.List; + +public interface IImportCrossrefJob extends IJob { + + /** + * Get the DOIs of the resources to be imported from Crossref. + * @return list of resources to be imported + */ + List getDois(); + + void setDois(List dois); + +} \ No newline at end of file diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/impl/ImportCrossrefJob.java b/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/impl/ImportCrossrefJob.java new file mode 100644 index 000000000..dff853fe2 --- /dev/null +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/impl/ImportCrossrefJob.java @@ -0,0 +1,31 @@ +package edu.asu.diging.citesphere.core.model.jobs.impl; + +import java.util.List; + +import javax.persistence.ElementCollection; +import javax.persistence.Entity; + +import edu.asu.diging.citesphere.core.model.jobs.IImportCrossrefJob; + +@Entity +public class ImportCrossrefJob extends Job implements IImportCrossrefJob { + + @ElementCollection + private List dois; + + /** + * Get the DOIs of the resources to be imported from Crossref. + * @return list of resources to be imported + */ + @Override + public List getDois() { + return dois; + } + + @Override + public void setDois(List dois) { + this.dois = dois; + } + + +} diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/core/repository/jobs/ImportCrossrefJobRepository.java b/citesphere/src/main/java/edu/asu/diging/citesphere/core/repository/jobs/ImportCrossrefJobRepository.java new file mode 100644 index 000000000..d61f20a27 --- /dev/null +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/core/repository/jobs/ImportCrossrefJobRepository.java @@ -0,0 +1,9 @@ +package edu.asu.diging.citesphere.core.repository.jobs; + +import org.springframework.data.repository.CrudRepository; + +import edu.asu.diging.citesphere.core.model.jobs.impl.ImportCrossrefJob; + +public interface ImportCrossrefJobRepository extends CrudRepository { + +} diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/crossref/impl/CrossrefServiceImpl.java b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/crossref/impl/CrossrefServiceImpl.java index 143aef735..fbcb80de3 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/crossref/impl/CrossrefServiceImpl.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/crossref/impl/CrossrefServiceImpl.java @@ -17,7 +17,7 @@ import edu.asu.diging.crossref.service.impl.CrossrefWorksServiceImpl; @Service -@PropertySource("config.properties") +@PropertySource("classpath:config.properties") public class CrossrefServiceImpl implements CrossrefService { @Value("${_crossref_default_pagesize}") diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/IImportCrossrefJobManager.java b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/IImportCrossrefJobManager.java new file mode 100644 index 000000000..4623d3821 --- /dev/null +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/IImportCrossrefJobManager.java @@ -0,0 +1,13 @@ +package edu.asu.diging.citesphere.core.service.jobs; + +import java.util.List; + +import edu.asu.diging.citesphere.core.exceptions.GroupDoesNotExistException; +import edu.asu.diging.citesphere.core.model.jobs.IImportCrossrefJob; +import edu.asu.diging.citesphere.user.IUser; + +public interface IImportCrossrefJobManager { + + IImportCrossrefJob createJob(IUser user, String groupId, List dois) throws GroupDoesNotExistException; + +} \ No newline at end of file diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java new file mode 100644 index 000000000..1935ddb3d --- /dev/null +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java @@ -0,0 +1,79 @@ +package edu.asu.diging.citesphere.core.service.jobs.impl; + +import java.time.OffsetDateTime; +import java.util.List; + +import javax.transaction.Transactional; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.annotation.PropertySource; +import org.springframework.stereotype.Service; + +import edu.asu.diging.citesphere.core.exceptions.GroupDoesNotExistException; +import edu.asu.diging.citesphere.core.exceptions.MessageCreationException; +import edu.asu.diging.citesphere.core.kafka.IKafkaRequestProducer; +import edu.asu.diging.citesphere.core.model.jobs.IImportCrossrefJob; +import edu.asu.diging.citesphere.core.model.jobs.JobStatus; +import edu.asu.diging.citesphere.core.model.jobs.impl.ImportCrossrefJob; +import edu.asu.diging.citesphere.core.model.jobs.impl.JobPhase; +import edu.asu.diging.citesphere.core.repository.jobs.ImportCrossrefJobRepository; +import edu.asu.diging.citesphere.core.service.IGroupManager; +import edu.asu.diging.citesphere.core.service.jobs.IImportCrossrefJobManager; +import edu.asu.diging.citesphere.core.service.jwt.IJwtTokenService; +import edu.asu.diging.citesphere.messages.KafkaTopics; +import edu.asu.diging.citesphere.messages.model.KafkaJobMessage; +import edu.asu.diging.citesphere.model.bib.ICitationGroup; +import edu.asu.diging.citesphere.user.IUser; + +@Service +@Transactional +@PropertySource("classpath:/config.properties") +public class ImportCrossrefJobManager implements IImportCrossrefJobManager { + + private final Logger logger = LoggerFactory.getLogger(getClass()); + + @Value("${_job_page_size}") + private int jobPageSize; + + @Autowired + private IGroupManager groupManager; + + @Autowired + private ImportCrossrefJobRepository jobRepo; + + @Autowired + private IKafkaRequestProducer kafkaProducer; + + @Autowired + private IJwtTokenService tokenService; + + @Override + public IImportCrossrefJob createJob(IUser user, String groupId, List dois) throws GroupDoesNotExistException { + ICitationGroup group = groupManager.getGroup(user, groupId); + if (group == null) { + throw new GroupDoesNotExistException(); + } + + IImportCrossrefJob job = new ImportCrossrefJob(); + job.setCreatedOn(OffsetDateTime.now()); + job.setUsername(user.getUsername()); + job.setDois(dois); + job.setStatus(JobStatus.PREPARED); + jobRepo.save((ImportCrossrefJob)job); + + String token = tokenService.generateJobApiToken(job); + try { + kafkaProducer.sendRequest(new KafkaJobMessage(token), KafkaTopics.REFERENCES_IMPORT_CROSSREF_TOPIC); + } catch (MessageCreationException e) { + logger.error("Could not send Kafka message.", e); + job.setStatus(JobStatus.FAILURE); + job.getPhases().add(new JobPhase(JobStatus.FAILURE, e.getMessage())); + jobRepo.save((ImportCrossrefJob)job); + } + + return job; + } +} diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java b/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java new file mode 100644 index 000000000..655ae5919 --- /dev/null +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java @@ -0,0 +1,83 @@ +package edu.asu.diging.citesphere.web.user.jobs; + +import java.io.IOException; +import java.security.Principal; +import java.util.List; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Controller; +import org.springframework.ui.Model; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.servlet.mvc.support.RedirectAttributes; + +import edu.asu.diging.citesphere.core.exceptions.GroupDoesNotExistException; +import edu.asu.diging.citesphere.core.service.ICitationManager; +import edu.asu.diging.citesphere.core.service.IGroupManager; +import edu.asu.diging.citesphere.core.service.crossref.CrossrefService; +import edu.asu.diging.citesphere.core.service.jobs.IImportCrossrefJobManager; +import edu.asu.diging.citesphere.core.user.IUserManager; +import edu.asu.diging.citesphere.user.IUser; +import edu.asu.diging.crossref.exception.RequestFailedException; +import edu.asu.diging.crossref.model.Item; + +@Controller +public class ImportCrossrefController { + + private final Logger logger = LoggerFactory.getLogger(getClass()); + + @Autowired + private CrossrefService crossrefService; + + @Autowired + private ICitationManager citationManager; + + @Autowired + private IUserManager userManager; + + @Autowired + private IImportCrossrefJobManager jobManager; + + @RequestMapping("/auth/import/crossref") + public String get(Model model, Principal principal) { + model.addAttribute("groups", citationManager.getGroups(userManager.findByUsername(principal.getName()))); + return "auth/import/crossref"; + } + + @RequestMapping("/auth/import/crossref/search") + public ResponseEntity> search(@RequestParam("query") String query, @RequestParam("page") int page) { + List results = null; + try { + results = crossrefService.search(query, page); + } catch (RequestFailedException | IOException e) { + logger.error("Could not get Crossref results.", e); + return new ResponseEntity>(HttpStatus.INTERNAL_SERVER_ERROR); + } + + return new ResponseEntity>(results, HttpStatus.OK); + } + + @RequestMapping(value="/auth/import/crossref", method=RequestMethod.POST) + public String post(Authentication authentication, @RequestParam("groupId") String groupId, + @RequestParam("dois[]") List dois, RedirectAttributes redirectAttrs) { + try { + jobManager.createJob((IUser) authentication.getPrincipal(), groupId, dois); + redirectAttrs.addFlashAttribute("show_alert", true); + redirectAttrs.addFlashAttribute("alert_type", "success"); + redirectAttrs.addFlashAttribute("alert_msg", "Import in progress."); + } catch (GroupDoesNotExistException e) { + logger.error("Group not found.", e); + redirectAttrs.addFlashAttribute("show_alert", true); + redirectAttrs.addFlashAttribute("alert_type", "danger"); + redirectAttrs.addFlashAttribute("alert_msg", e.getMessage()); + } + + return "redirect:/auth/import/crossref"; + } +} diff --git a/citesphere/src/main/resources/config.properties b/citesphere/src/main/resources/config.properties index d547d1dbd..a89c162d5 100644 --- a/citesphere/src/main/resources/config.properties +++ b/citesphere/src/main/resources/config.properties @@ -90,4 +90,4 @@ giles_file_endpoint=/api/v2/resources/files/{0}/content javers_default_author=${javers.default.author} -_crossref_default_pagesize=50 +_crossref_default_pagesize=20 diff --git a/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html b/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html new file mode 100644 index 000000000..c9847acee --- /dev/null +++ b/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html @@ -0,0 +1,105 @@ + + + + + + +
+
+
+
+

Import from Crossref

+
+
+
+ +
Search
+
+
+
+ +

Results

+
+ +
+

+ Import into Group: + +

+

+ +

+
+
+ +
+
+
+ + diff --git a/citesphere/src/main/webapp/WEB-INF/views/layouts/main.html b/citesphere/src/main/webapp/WEB-INF/views/layouts/main.html index db0d1104e..7c5ff4c86 100644 --- a/citesphere/src/main/webapp/WEB-INF/views/layouts/main.html +++ b/citesphere/src/main/webapp/WEB-INF/views/layouts/main.html @@ -90,6 +90,8 @@
  • Import from File
    • +
  • Import + from CrossRef
  • See all Imports
    • From dacc76f5335db4f25671c5d84e2b9b85a0143c6e Mon Sep 17 00:00:00 2001 From: Pratik Prakash Giri <32401726+PratikGiri@users.noreply.github.com> Date: Mon, 6 Mar 2023 17:00:31 -0700 Subject: [PATCH 03/17] [CITE-177] Clearing the div before fetching the results --- .../main/webapp/WEB-INF/views/auth/import/crossref.html | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html b/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html index c9847acee..f55962aa0 100644 --- a/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html +++ b/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html @@ -13,9 +13,10 @@ async: false, success: function(data) { var container = $("#resultsContainer"); + document.getElementById('resultsContainer').innerHTML = ''; data.forEach(function(result) { - var panel = $('
    '); - var item = $('
    '); + panel = $('
    '); + item = $('
    '); panel.append(item); var checkbox = $(' '); item.append(checkbox); @@ -46,6 +47,9 @@ console.print("success"); } }) + document.getElementById('resultsContainer').innerHTML = ''; + selectedDois.clear(); + $("#importBtn").text("Import Selected"); }); }); From 709aa1547460d8c3d163a57f549a8cacdf5950ba Mon Sep 17 00:00:00 2001 From: PradnyaC11 Date: Fri, 26 Apr 2024 16:40:10 -0700 Subject: [PATCH 04/17] [CITE-177] Added group ID to Kafka message --- .../core/model/jobs/IImportCrossrefJob.java | 11 ++++++++ .../model/jobs/impl/ImportCrossrefJob.java | 27 +++++++++++++++++++ .../jobs/impl/ImportCrossrefJobManager.java | 1 + 3 files changed, 39 insertions(+) diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/IImportCrossrefJob.java b/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/IImportCrossrefJob.java index e1b37724d..c83bb233d 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/IImportCrossrefJob.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/IImportCrossrefJob.java @@ -2,6 +2,8 @@ import java.util.List; +import edu.asu.diging.citesphere.model.bib.ICitationGroup; + public interface IImportCrossrefJob extends IJob { /** @@ -11,5 +13,14 @@ public interface IImportCrossrefJob extends IJob { List getDois(); void setDois(List dois); + + void setCitationGroup(String citationGroup); + + String getCitationGroup(); + + ICitationGroup getCitationGroupDetail(); + + void setCitationGroupDetail(ICitationGroup citationGroupDetail); + } \ No newline at end of file diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/impl/ImportCrossrefJob.java b/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/impl/ImportCrossrefJob.java index dff853fe2..1527e63ce 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/impl/ImportCrossrefJob.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/impl/ImportCrossrefJob.java @@ -4,14 +4,19 @@ import javax.persistence.ElementCollection; import javax.persistence.Entity; +import javax.persistence.Transient; import edu.asu.diging.citesphere.core.model.jobs.IImportCrossrefJob; +import edu.asu.diging.citesphere.model.bib.ICitationGroup; @Entity public class ImportCrossrefJob extends Job implements IImportCrossrefJob { @ElementCollection private List dois; + private String citationGroup; + @Transient + private ICitationGroup citationGroupDetail; /** * Get the DOIs of the resources to be imported from Crossref. @@ -26,6 +31,28 @@ public List getDois() { public void setDois(List dois) { this.dois = dois; } + + @Override + public String getCitationGroup() { + return citationGroup; + } + + @Override + public void setCitationGroup(String citationGroup) { + this.citationGroup = citationGroup; + } + + @Override + public ICitationGroup getCitationGroupDetail() { + return citationGroupDetail; + } + + @Override + public void setCitationGroupDetail(ICitationGroup citationGroupDetail) { + this.citationGroupDetail = citationGroupDetail; + } + + } diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java index 1935ddb3d..37ab5a3fe 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java @@ -61,6 +61,7 @@ public IImportCrossrefJob createJob(IUser user, String groupId, List doi job.setCreatedOn(OffsetDateTime.now()); job.setUsername(user.getUsername()); job.setDois(dois); + job.setCitationGroup(groupId); job.setStatus(JobStatus.PREPARED); jobRepo.save((ImportCrossrefJob)job); From 4791750e9d6fd910db3475490ca68514f5f8af1b Mon Sep 17 00:00:00 2001 From: PradnyaC11 Date: Tue, 30 Apr 2024 15:11:09 -0700 Subject: [PATCH 05/17] [CITE-177] Updated JobInfoController to add groupId to response --- .../citesphere/api/v1/user/JobInfoController.java | 1 + .../service/jobs/impl/ImportCrossrefJobManager.java | 10 +++++----- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java b/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java index 89b95ece0..c33e11d52 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java @@ -74,6 +74,7 @@ public ResponseEntity getProfile(@RequestHeader HttpHeaders headers) { ArrayNode doisNode = mapper.createArrayNode(); ((IImportCrossrefJob)job).getDois().forEach(d -> doisNode.add(d)); node.set("dois", doisNode); + node.put("groupId", ((IImportCrossrefJob)job).getCitationGroup()); } return new ResponseEntity<>(node.toString(), HttpStatus.OK); diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java index 37ab5a3fe..d24708383 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java @@ -56,14 +56,14 @@ public IImportCrossrefJob createJob(IUser user, String groupId, List doi if (group == null) { throw new GroupDoesNotExistException(); } - - IImportCrossrefJob job = new ImportCrossrefJob(); + + ImportCrossrefJob job = new ImportCrossrefJob(); job.setCreatedOn(OffsetDateTime.now()); job.setUsername(user.getUsername()); job.setDois(dois); job.setCitationGroup(groupId); - job.setStatus(JobStatus.PREPARED); - jobRepo.save((ImportCrossrefJob)job); + job.setStatus(JobStatus.PREPARED); + jobRepo.save(job); String token = tokenService.generateJobApiToken(job); try { @@ -72,7 +72,7 @@ public IImportCrossrefJob createJob(IUser user, String groupId, List doi logger.error("Could not send Kafka message.", e); job.setStatus(JobStatus.FAILURE); job.getPhases().add(new JobPhase(JobStatus.FAILURE, e.getMessage())); - jobRepo.save((ImportCrossrefJob)job); + jobRepo.save(job); } return job; From 0e74de643dbb896b0f0ad97c55951bf3f663cf29 Mon Sep 17 00:00:00 2001 From: PradnyaC11 Date: Wed, 12 Jun 2024 16:24:32 -0700 Subject: [PATCH 06/17] [CITE-177] Added test cases for ImportCrossrefJobManager & ImportCrossrefController --- .../citesphere/core/model/jobs/impl/Job.java | 3 +- .../web/user/MoveItemsController.java | 6 +- .../user/jobs/ImportCrossrefController.java | 2 +- .../impl/ImportCrossrefJobManagerTest.java | 116 ++++++++++++++ .../jobs/ImportCrossrefControllerTest.java | 144 ++++++++++++++++++ 5 files changed, 265 insertions(+), 6 deletions(-) create mode 100644 citesphere/src/test/java/edu/asu/diging/citesphere/core/service/impl/ImportCrossrefJobManagerTest.java create mode 100644 citesphere/src/test/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefControllerTest.java diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/impl/Job.java b/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/impl/Job.java index e05e332e7..52c643d90 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/impl/Job.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/core/model/jobs/impl/Job.java @@ -1,6 +1,7 @@ package edu.asu.diging.citesphere.core.model.jobs.impl; import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; import javax.persistence.CascadeType; @@ -42,7 +43,7 @@ public class Job implements IJob { @JsonIgnore @OneToMany(cascade=CascadeType.ALL) - private List phases; + private List phases = new ArrayList<>(); /* (non-Javadoc) diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/MoveItemsController.java b/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/MoveItemsController.java index 9e703e567..0858c497f 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/MoveItemsController.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/MoveItemsController.java @@ -97,8 +97,7 @@ public class MoveItemsController { "/auth/group/{zoteroGroupId}/collection/{parentcollectionId}/items/move/{targetCollectionId}/sync/start" }) public @ResponseBody Sync startSync(Authentication authentication, - @PathVariable("zoteroGroupId") String zoteroGroupId, - @PathVariable("targetCollectionId") String collectionId, + @PathVariable("zoteroGroupId") String zoteroGroupId, @PathVariable("targetCollectionId") String collectionId, @RequestParam(defaultValue = "1", required = false, value = "page") String page) { try { citationManager.getGroupItems((IUser) authentication.getPrincipal(), zoteroGroupId, collectionId, @@ -120,8 +119,7 @@ public class MoveItemsController { "/auth/group/{zoteroGroupId}/collection/{parentcollectionId}/items/move/{targetCollectionId}/totalItems" }) public @ResponseBody Long getTotalCitationsCollection(Authentication authentication, - @PathVariable("zoteroGroupId") String zoteroGroupId, - @PathVariable("targetCollectionId") String collectionId) { + @PathVariable("zoteroGroupId") String zoteroGroupId, @PathVariable("targetCollectionId") String collectionId) { ICitationCollection collection = collectionManager.getCollection((IUser) authentication.getPrincipal(), zoteroGroupId, collectionId); return collection.getNumberOfItems(); diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java b/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java index 655ae5919..ee513e199 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java @@ -72,7 +72,7 @@ public String post(Authentication authentication, @RequestParam("groupId") Strin redirectAttrs.addFlashAttribute("alert_type", "success"); redirectAttrs.addFlashAttribute("alert_msg", "Import in progress."); } catch (GroupDoesNotExistException e) { - logger.error("Group not found.", e); + logger.error("Could not create crossref job because group does not exist.", e); redirectAttrs.addFlashAttribute("show_alert", true); redirectAttrs.addFlashAttribute("alert_type", "danger"); redirectAttrs.addFlashAttribute("alert_msg", e.getMessage()); diff --git a/citesphere/src/test/java/edu/asu/diging/citesphere/core/service/impl/ImportCrossrefJobManagerTest.java b/citesphere/src/test/java/edu/asu/diging/citesphere/core/service/impl/ImportCrossrefJobManagerTest.java new file mode 100644 index 000000000..b5611dc49 --- /dev/null +++ b/citesphere/src/test/java/edu/asu/diging/citesphere/core/service/impl/ImportCrossrefJobManagerTest.java @@ -0,0 +1,116 @@ +package edu.asu.diging.citesphere.core.service.impl; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertThrows; +import static org.mockito.Matchers.any; +import static org.mockito.Matchers.anyString; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.doThrow; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.time.OffsetDateTime; +import java.util.Arrays; +import java.util.List; + +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.runners.MockitoJUnitRunner; +import org.springframework.test.util.ReflectionTestUtils; + +import edu.asu.diging.citesphere.core.exceptions.GroupDoesNotExistException; +import edu.asu.diging.citesphere.core.exceptions.MessageCreationException; +import edu.asu.diging.citesphere.core.kafka.IKafkaRequestProducer; +import edu.asu.diging.citesphere.core.model.jobs.IImportCrossrefJob; +import edu.asu.diging.citesphere.core.model.jobs.JobStatus; +import edu.asu.diging.citesphere.core.model.jobs.impl.ImportCrossrefJob; +import edu.asu.diging.citesphere.core.repository.jobs.ImportCrossrefJobRepository; +import edu.asu.diging.citesphere.core.service.IGroupManager; +import edu.asu.diging.citesphere.core.service.jobs.impl.ImportCrossrefJobManager; +import edu.asu.diging.citesphere.core.service.jwt.IJwtTokenService; +import edu.asu.diging.citesphere.messages.model.KafkaJobMessage; +import edu.asu.diging.citesphere.model.bib.ICitationGroup; +import edu.asu.diging.citesphere.user.IUser; + +@RunWith(MockitoJUnitRunner.class) +public class ImportCrossrefJobManagerTest { + + @InjectMocks + private ImportCrossrefJobManager importCrossrefJobManager; + + @Mock + private IGroupManager groupManager; + + @Mock + private ImportCrossrefJobRepository jobRepo; + + @Mock + private IKafkaRequestProducer kafkaProducer; + + @Mock + private IJwtTokenService tokenService; + + @Mock + private IUser user; + + @Mock + private ICitationGroup group; + private List dois; + + @Before + public void setup() { + ReflectionTestUtils.setField(importCrossrefJobManager, "jobPageSize", 10); + doReturn("username").when(user).getUsername(); + dois = Arrays.asList("10.1000/xyz123", "10.1000/xyz456"); + } + + @Test + public void testCreateJob_GroupExists() throws Exception { + String groupId = "groupId"; + List dois = Arrays.asList("doi1", "doi2"); + doReturn(group).when(groupManager).getGroup(user, groupId); + doReturn("jobToken").when(tokenService).generateJobApiToken(any(ImportCrossrefJob.class)); + + IImportCrossrefJob job = importCrossrefJobManager.createJob(user, groupId, dois); + + assertNotNull(job); + assertEquals(OffsetDateTime.now(), job.getCreatedOn()); + assertEquals(user.getUsername(), job.getUsername()); + assertEquals(dois, job.getDois()); + assertEquals(groupId, job.getCitationGroup()); + assertEquals(JobStatus.PREPARED, job.getStatus()); + verify(jobRepo, times(1)).save(any(ImportCrossrefJob.class)); + verify(kafkaProducer).sendRequest(any(KafkaJobMessage.class), anyString()); + } + + @Test + public void testCreateJob_GroupDoesNotExist() { + String groupId = "groupId"; + List dois = Arrays.asList("doi1", "doi2"); + doReturn(null).when(groupManager).getGroup(user, groupId); + + GroupDoesNotExistException exception = assertThrows(GroupDoesNotExistException.class, () -> importCrossrefJobManager.createJob(user, groupId, dois)); + assertNotNull(exception); + } + + @Test + public void testCreateJob_MessageCreationException() throws Exception { + String groupId = "groupId"; + when(groupManager.getGroup(user, groupId)).thenReturn(group); + when(tokenService.generateJobApiToken(any(ImportCrossrefJob.class))).thenReturn("token"); + doThrow(new MessageCreationException("Error creating message")).when(kafkaProducer).sendRequest(any(KafkaJobMessage.class), anyString()); + + IImportCrossrefJob job = importCrossrefJobManager.createJob(user, groupId, dois); + + assertNotNull(job); + assertEquals(JobStatus.FAILURE, job.getStatus()); + assertEquals(1, job.getPhases().size()); + assertEquals("Error creating message", job.getPhases().get(0).getMessage()); + verify(jobRepo, times(2)).save(any(ImportCrossrefJob.class)); + } +} \ No newline at end of file diff --git a/citesphere/src/test/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefControllerTest.java b/citesphere/src/test/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefControllerTest.java new file mode 100644 index 000000000..f7099f92c --- /dev/null +++ b/citesphere/src/test/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefControllerTest.java @@ -0,0 +1,144 @@ +package edu.asu.diging.citesphere.web.user.jobs; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; +import static org.mockito.Matchers.anyList; +import static org.mockito.Matchers.eq; +import static org.mockito.Mockito.doThrow; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.io.IOException; +import java.security.Principal; +import java.util.Arrays; +import java.util.List; + +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.runners.MockitoJUnitRunner; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.security.core.Authentication; +import org.springframework.ui.Model; +import org.springframework.web.servlet.mvc.support.RedirectAttributes; + +import edu.asu.diging.citesphere.core.exceptions.GroupDoesNotExistException; +import edu.asu.diging.citesphere.core.service.ICitationManager; +import edu.asu.diging.citesphere.core.service.crossref.CrossrefService; +import edu.asu.diging.citesphere.core.service.jobs.IImportCrossrefJobManager; +import edu.asu.diging.citesphere.core.user.IUserManager; +import edu.asu.diging.citesphere.model.bib.ICitationGroup; +import edu.asu.diging.citesphere.user.IUser; +import edu.asu.diging.crossref.exception.RequestFailedException; +import edu.asu.diging.crossref.model.Item; + +@RunWith(MockitoJUnitRunner.class) +public class ImportCrossrefControllerTest { + + @InjectMocks + private ImportCrossrefController importCrossrefController; + + @Mock + private CrossrefService crossrefService; + + @Mock + private ICitationManager citationManager; + + @Mock + private IUserManager userManager; + + @Mock + private IImportCrossrefJobManager jobManager; + + @Mock + private Model model; + + @Mock + private Principal principal; + + @Mock + private Authentication authentication; + + @Mock + private RedirectAttributes redirectAttrs; + + @Mock + private IUser user; + + @Before + public void setUp() { + when(principal.getName()).thenReturn("testuser"); + when(userManager.findByUsername("testuser")).thenReturn(user); + } + + @Test + public void testGet() { + List groups = Arrays.asList(mock(ICitationGroup.class), mock(ICitationGroup.class)); + when(citationManager.getGroups(user)).thenReturn(groups); + + String viewName = importCrossrefController.get(model, principal); + + assertEquals("auth/import/crossref", viewName); + verify(model).addAttribute(eq("groups"), anyList()); + } + + @Test + public void testSearch_Success() throws RequestFailedException, IOException { + String query = "sample query"; + int page = 1; + List items = List.of(mock(Item.class), mock(Item.class)); + when(crossrefService.search(query, page)).thenReturn(items); + + ResponseEntity> response = importCrossrefController.search(query, page); + + assertEquals(HttpStatus.OK, response.getStatusCode()); + assertEquals(items, response.getBody()); + } + + @Test + public void testSearch_Failure() throws RequestFailedException, IOException { + String query = "sample query"; + int page = 1; + when(crossrefService.search(query, page)).thenThrow(new IOException("IO Exception")); + + ResponseEntity> response = importCrossrefController.search(query, page); + + assertEquals(HttpStatus.INTERNAL_SERVER_ERROR, response.getStatusCode()); + assertNull(response.getBody()); + } + + @Test + public void testPost_Success() throws GroupDoesNotExistException { + String groupId = "groupId"; + List dois = Arrays.asList("doi1", "doi2"); + when(authentication.getPrincipal()).thenReturn(user); + + String viewName = importCrossrefController.post(authentication, groupId, dois, redirectAttrs); + + assertEquals("redirect:/auth/import/crossref", viewName); + verify(jobManager).createJob(user, groupId, dois); + verify(redirectAttrs).addFlashAttribute("show_alert", true); + verify(redirectAttrs).addFlashAttribute("alert_type", "success"); + verify(redirectAttrs).addFlashAttribute("alert_msg", "Import in progress."); + } + + @Test + public void testPost_GroupDoesNotExistException() throws GroupDoesNotExistException { + String groupId = "groupId"; + List dois = Arrays.asList("doi1", "doi2"); + when(authentication.getPrincipal()).thenReturn(user); + doThrow(new GroupDoesNotExistException("Group does not exist")).when(jobManager).createJob(user, groupId, dois); + + String viewName = importCrossrefController.post(authentication, groupId, dois, redirectAttrs); + + assertEquals("redirect:/auth/import/crossref", viewName); + verify(jobManager).createJob(user, groupId, dois); + verify(redirectAttrs).addFlashAttribute("show_alert", true); + verify(redirectAttrs).addFlashAttribute("alert_type", "danger"); + verify(redirectAttrs).addFlashAttribute("alert_msg", "Group does not exist"); + } +} From 8faa45cbe1edf8b04df56b4490f0b93fa355af33 Mon Sep 17 00:00:00 2001 From: PradnyaC11 Date: Thu, 13 Jun 2024 15:38:04 -0700 Subject: [PATCH 07/17] [CITE-177] Updated crossref.html to show alert --- .../user/jobs/ImportCrossrefController.java | 26 ++++++++++--------- .../WEB-INF/views/auth/import/crossref.html | 18 +++++++++++-- 2 files changed, 30 insertions(+), 14 deletions(-) diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java b/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java index ee513e199..22da3c4fa 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java @@ -2,7 +2,9 @@ import java.io.IOException; import java.security.Principal; +import java.util.HashMap; import java.util.List; +import java.util.Map; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -15,11 +17,9 @@ import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RequestParam; -import org.springframework.web.servlet.mvc.support.RedirectAttributes; import edu.asu.diging.citesphere.core.exceptions.GroupDoesNotExistException; import edu.asu.diging.citesphere.core.service.ICitationManager; -import edu.asu.diging.citesphere.core.service.IGroupManager; import edu.asu.diging.citesphere.core.service.crossref.CrossrefService; import edu.asu.diging.citesphere.core.service.jobs.IImportCrossrefJobManager; import edu.asu.diging.citesphere.core.user.IUserManager; @@ -64,20 +64,22 @@ public ResponseEntity> search(@RequestParam("query") String query, @R } @RequestMapping(value="/auth/import/crossref", method=RequestMethod.POST) - public String post(Authentication authentication, @RequestParam("groupId") String groupId, - @RequestParam("dois[]") List dois, RedirectAttributes redirectAttrs) { + public ResponseEntity> post(Authentication authentication, @RequestParam("groupId") String groupId, + @RequestParam("dois[]") List dois, Model model) { + Map response = new HashMap<>(); try { jobManager.createJob((IUser) authentication.getPrincipal(), groupId, dois); - redirectAttrs.addFlashAttribute("show_alert", true); - redirectAttrs.addFlashAttribute("alert_type", "success"); - redirectAttrs.addFlashAttribute("alert_msg", "Import in progress."); + System.out.println("============================================================================================================="); + response.put("show_alert", true); + response.put("alert_type", "success"); + response.put("alert_msg", "Import in progress."); } catch (GroupDoesNotExistException e) { logger.error("Could not create crossref job because group does not exist.", e); - redirectAttrs.addFlashAttribute("show_alert", true); - redirectAttrs.addFlashAttribute("alert_type", "danger"); - redirectAttrs.addFlashAttribute("alert_msg", e.getMessage()); + response.put("show_alert", true); + response.put("alert_type", "danger"); + response.put("alert_msg", e.getMessage()); + return new ResponseEntity>(HttpStatus.INTERNAL_SERVER_ERROR); } - - return "redirect:/auth/import/crossref"; + return new ResponseEntity>(response, HttpStatus.OK); } } diff --git a/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html b/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html index f55962aa0..e2327efb5 100644 --- a/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html +++ b/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html @@ -32,7 +32,6 @@ $("#importBtn").click(function(e) { e.preventDefault(); - console.log(Array.from(selectedDois.values())); var group = $("#groupSelect").val() $.ajax({ type: 'POST', @@ -44,7 +43,13 @@ "dois": Array.from(selectedDois.values()), }, success: function(data) { - console.print("success"); + var uploadedFilesList = $("#uploaded-files-list"); + var alert = data; + if(alert.show_alert && alert.alert_type=="success") { + $("#uploadedAlert").show(); + } else if (alert.show_alert && alert.alert_type=="success") { + $("#failAlert").show(); + } } }) document.getElementById('resultsContainer').innerHTML = ''; @@ -77,6 +82,15 @@

    Import from Crossref

    + + +
    From 836705d4b2e53f86dbbc704f51d68cd43c3dbe05 Mon Sep 17 00:00:00 2001 From: PradnyaC11 Date: Tue, 2 Jul 2024 15:51:14 -0700 Subject: [PATCH 08/17] [CITE-177] Addressing the PR comments --- .../user/jobs/ImportCrossrefController.java | 3 +- .../impl/ImportCrossrefJobManagerTest.java | 7 ++-- .../jobs/ImportCrossrefControllerTest.java | 37 +++++++++++-------- 3 files changed, 25 insertions(+), 22 deletions(-) diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java b/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java index 22da3c4fa..e475e86e4 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java @@ -69,7 +69,6 @@ public ResponseEntity> post(Authentication authentication, @ Map response = new HashMap<>(); try { jobManager.createJob((IUser) authentication.getPrincipal(), groupId, dois); - System.out.println("============================================================================================================="); response.put("show_alert", true); response.put("alert_type", "success"); response.put("alert_msg", "Import in progress."); @@ -78,7 +77,7 @@ public ResponseEntity> post(Authentication authentication, @ response.put("show_alert", true); response.put("alert_type", "danger"); response.put("alert_msg", e.getMessage()); - return new ResponseEntity>(HttpStatus.INTERNAL_SERVER_ERROR); + return new ResponseEntity>(response, HttpStatus.INTERNAL_SERVER_ERROR); } return new ResponseEntity>(response, HttpStatus.OK); } diff --git a/citesphere/src/test/java/edu/asu/diging/citesphere/core/service/impl/ImportCrossrefJobManagerTest.java b/citesphere/src/test/java/edu/asu/diging/citesphere/core/service/impl/ImportCrossrefJobManagerTest.java index b5611dc49..7fd627622 100644 --- a/citesphere/src/test/java/edu/asu/diging/citesphere/core/service/impl/ImportCrossrefJobManagerTest.java +++ b/citesphere/src/test/java/edu/asu/diging/citesphere/core/service/impl/ImportCrossrefJobManagerTest.java @@ -70,7 +70,7 @@ public void setup() { } @Test - public void testCreateJob_GroupExists() throws Exception { + public void test_createJob_success() throws Exception { String groupId = "groupId"; List dois = Arrays.asList("doi1", "doi2"); doReturn(group).when(groupManager).getGroup(user, groupId); @@ -79,7 +79,6 @@ public void testCreateJob_GroupExists() throws Exception { IImportCrossrefJob job = importCrossrefJobManager.createJob(user, groupId, dois); assertNotNull(job); - assertEquals(OffsetDateTime.now(), job.getCreatedOn()); assertEquals(user.getUsername(), job.getUsername()); assertEquals(dois, job.getDois()); assertEquals(groupId, job.getCitationGroup()); @@ -89,7 +88,7 @@ public void testCreateJob_GroupExists() throws Exception { } @Test - public void testCreateJob_GroupDoesNotExist() { + public void test_createJob_groupDoesNotExist() { String groupId = "groupId"; List dois = Arrays.asList("doi1", "doi2"); doReturn(null).when(groupManager).getGroup(user, groupId); @@ -99,7 +98,7 @@ public void testCreateJob_GroupDoesNotExist() { } @Test - public void testCreateJob_MessageCreationException() throws Exception { + public void test_createJob_messageCreationException() throws Exception { String groupId = "groupId"; when(groupManager.getGroup(user, groupId)).thenReturn(group); when(tokenService.generateJobApiToken(any(ImportCrossrefJob.class))).thenReturn("token"); diff --git a/citesphere/src/test/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefControllerTest.java b/citesphere/src/test/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefControllerTest.java index f7099f92c..c9b01511b 100644 --- a/citesphere/src/test/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefControllerTest.java +++ b/citesphere/src/test/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefControllerTest.java @@ -1,6 +1,7 @@ package edu.asu.diging.citesphere.web.user.jobs; import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; import static org.mockito.Matchers.anyList; import static org.mockito.Matchers.eq; @@ -13,6 +14,7 @@ import java.security.Principal; import java.util.Arrays; import java.util.List; +import java.util.Map; import org.junit.Before; import org.junit.Test; @@ -76,7 +78,7 @@ public void setUp() { } @Test - public void testGet() { + public void test_get_successs() { List groups = Arrays.asList(mock(ICitationGroup.class), mock(ICitationGroup.class)); when(citationManager.getGroups(user)).thenReturn(groups); @@ -87,7 +89,7 @@ public void testGet() { } @Test - public void testSearch_Success() throws RequestFailedException, IOException { + public void test_search_success() throws RequestFailedException, IOException { String query = "sample query"; int page = 1; List items = List.of(mock(Item.class), mock(Item.class)); @@ -100,7 +102,7 @@ public void testSearch_Success() throws RequestFailedException, IOException { } @Test - public void testSearch_Failure() throws RequestFailedException, IOException { + public void test_search_failure() throws RequestFailedException, IOException { String query = "sample query"; int page = 1; when(crossrefService.search(query, page)).thenThrow(new IOException("IO Exception")); @@ -112,33 +114,36 @@ public void testSearch_Failure() throws RequestFailedException, IOException { } @Test - public void testPost_Success() throws GroupDoesNotExistException { + public void test_post_success() throws GroupDoesNotExistException { String groupId = "groupId"; List dois = Arrays.asList("doi1", "doi2"); when(authentication.getPrincipal()).thenReturn(user); - String viewName = importCrossrefController.post(authentication, groupId, dois, redirectAttrs); + ResponseEntity> responseEntity = importCrossrefController.post(authentication, groupId, dois, redirectAttrs); - assertEquals("redirect:/auth/import/crossref", viewName); + assertEquals(HttpStatus.OK, responseEntity.getStatusCode()); + Map responseBody = responseEntity.getBody(); + assertNotNull(responseBody); + assertEquals(true, responseBody.get("show_alert")); + assertEquals("success", responseBody.get("alert_type")); + assertEquals("Import in progress.", responseBody.get("alert_msg")); verify(jobManager).createJob(user, groupId, dois); - verify(redirectAttrs).addFlashAttribute("show_alert", true); - verify(redirectAttrs).addFlashAttribute("alert_type", "success"); - verify(redirectAttrs).addFlashAttribute("alert_msg", "Import in progress."); } @Test - public void testPost_GroupDoesNotExistException() throws GroupDoesNotExistException { + public void test_post_groupDoesNotExistException() throws GroupDoesNotExistException { String groupId = "groupId"; List dois = Arrays.asList("doi1", "doi2"); when(authentication.getPrincipal()).thenReturn(user); doThrow(new GroupDoesNotExistException("Group does not exist")).when(jobManager).createJob(user, groupId, dois); - String viewName = importCrossrefController.post(authentication, groupId, dois, redirectAttrs); + ResponseEntity> responseEntity = importCrossrefController.post(authentication, groupId, dois, redirectAttrs); - assertEquals("redirect:/auth/import/crossref", viewName); - verify(jobManager).createJob(user, groupId, dois); - verify(redirectAttrs).addFlashAttribute("show_alert", true); - verify(redirectAttrs).addFlashAttribute("alert_type", "danger"); - verify(redirectAttrs).addFlashAttribute("alert_msg", "Group does not exist"); + assertEquals(HttpStatus.INTERNAL_SERVER_ERROR, responseEntity.getStatusCode()); + Map responseBody = responseEntity.getBody(); + assertNotNull(responseBody); + assertEquals(true, responseBody.get("show_alert")); + assertEquals("danger", responseBody.get("alert_type")); + assertEquals("Group does not exist", responseBody.get("alert_msg")); } } From 5495a627269d1f38178d884e17054d459496040c Mon Sep 17 00:00:00 2001 From: PradnyaC11 Date: Tue, 2 Jul 2024 16:01:12 -0700 Subject: [PATCH 09/17] [CITE-177] Changed crossref-connect-version in pom.xml --- citesphere/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/citesphere/pom.xml b/citesphere/pom.xml index 9f53e91ef..4902c9e80 100644 --- a/citesphere/pom.xml +++ b/citesphere/pom.xml @@ -26,7 +26,7 @@ 0.12 0.5 1.19 - 0.1 + 0.3-SNAPSHOT $2a$04$oQo44vqcDIFRoYKiAXoNheurzkwX9dcNmowvTX/hsWuBMwijqn44i From d9ad221f9ad35337336444d3fbd56cecebbed909 Mon Sep 17 00:00:00 2001 From: PradnyaC11 Date: Thu, 11 Jul 2024 16:45:53 -0700 Subject: [PATCH 10/17] [CITE-177] Addressed PR comments --- citesphere/pom.xml | 2 +- .../core/service/jobs/impl/ImportCrossrefJobManager.java | 2 +- .../citesphere/web/user/jobs/ImportCrossrefController.java | 2 +- .../main/webapp/WEB-INF/views/auth/import/crossref.html | 7 ++++--- .../core/service/impl/ImportCrossrefJobManagerTest.java | 1 - .../web/user/jobs/ImportCrossrefControllerTest.java | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/citesphere/pom.xml b/citesphere/pom.xml index 4902c9e80..8d97a38bf 100644 --- a/citesphere/pom.xml +++ b/citesphere/pom.xml @@ -26,7 +26,7 @@ 0.12 0.5 1.19 - 0.3-SNAPSHOT + 0.2 $2a$04$oQo44vqcDIFRoYKiAXoNheurzkwX9dcNmowvTX/hsWuBMwijqn44i diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java index d24708383..39f340f57 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/core/service/jobs/impl/ImportCrossrefJobManager.java @@ -54,7 +54,7 @@ public class ImportCrossrefJobManager implements IImportCrossrefJobManager { public IImportCrossrefJob createJob(IUser user, String groupId, List dois) throws GroupDoesNotExistException { ICitationGroup group = groupManager.getGroup(user, groupId); if (group == null) { - throw new GroupDoesNotExistException(); + throw new GroupDoesNotExistException("Group does not exists"); } ImportCrossrefJob job = new ImportCrossrefJob(); diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java b/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java index e475e86e4..0ac305282 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefController.java @@ -77,7 +77,7 @@ public ResponseEntity> post(Authentication authentication, @ response.put("show_alert", true); response.put("alert_type", "danger"); response.put("alert_msg", e.getMessage()); - return new ResponseEntity>(response, HttpStatus.INTERNAL_SERVER_ERROR); + return new ResponseEntity>(response, HttpStatus.OK); } return new ResponseEntity>(response, HttpStatus.OK); } diff --git a/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html b/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html index e2327efb5..acf36b9ed 100644 --- a/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html +++ b/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html @@ -47,11 +47,12 @@ var alert = data; if(alert.show_alert && alert.alert_type=="success") { $("#uploadedAlert").show(); - } else if (alert.show_alert && alert.alert_type=="success") { + } else if (alert.show_alert && alert.alert_type=="danger") { + $("#failMessage").html(alert.alert_msg); $("#failAlert").show(); } } - }) + }); document.getElementById('resultsContainer').innerHTML = ''; selectedDois.clear(); $("#importBtn").text("Import Selected"); @@ -89,7 +90,7 @@

    Import from Crossref

    diff --git a/citesphere/src/test/java/edu/asu/diging/citesphere/core/service/impl/ImportCrossrefJobManagerTest.java b/citesphere/src/test/java/edu/asu/diging/citesphere/core/service/impl/ImportCrossrefJobManagerTest.java index 7fd627622..8415d9191 100644 --- a/citesphere/src/test/java/edu/asu/diging/citesphere/core/service/impl/ImportCrossrefJobManagerTest.java +++ b/citesphere/src/test/java/edu/asu/diging/citesphere/core/service/impl/ImportCrossrefJobManagerTest.java @@ -109,7 +109,6 @@ public void test_createJob_messageCreationException() throws Exception { assertNotNull(job); assertEquals(JobStatus.FAILURE, job.getStatus()); assertEquals(1, job.getPhases().size()); - assertEquals("Error creating message", job.getPhases().get(0).getMessage()); verify(jobRepo, times(2)).save(any(ImportCrossrefJob.class)); } } \ No newline at end of file diff --git a/citesphere/src/test/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefControllerTest.java b/citesphere/src/test/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefControllerTest.java index c9b01511b..1d86d8fb7 100644 --- a/citesphere/src/test/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefControllerTest.java +++ b/citesphere/src/test/java/edu/asu/diging/citesphere/web/user/jobs/ImportCrossrefControllerTest.java @@ -139,7 +139,7 @@ public void test_post_groupDoesNotExistException() throws GroupDoesNotExistExcep ResponseEntity> responseEntity = importCrossrefController.post(authentication, groupId, dois, redirectAttrs); - assertEquals(HttpStatus.INTERNAL_SERVER_ERROR, responseEntity.getStatusCode()); + assertEquals(HttpStatus.OK, responseEntity.getStatusCode()); Map responseBody = responseEntity.getBody(); assertNotNull(responseBody); assertEquals(true, responseBody.get("show_alert")); From 3fffd0ed12a33c6a795121c0c344a83050816612 Mon Sep 17 00:00:00 2001 From: PradnyaC11 Date: Thu, 1 Aug 2024 16:45:04 -0700 Subject: [PATCH 11/17] [CITE-177] Addressing PR comments --- .../WEB-INF/views/auth/import/crossref.html | 72 +++++++++---------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html b/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html index acf36b9ed..03fb41bc0 100644 --- a/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html +++ b/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html @@ -8,52 +8,52 @@ $("#searchButton").click(function(e) { e.preventDefault(); $.ajax({ - type: 'GET', - url: [[@{|/auth/import/crossref/search|}]] + "?page=1&query=" + $("#searchQuery").val(), - async: false, - success: function(data) { - var container = $("#resultsContainer"); - document.getElementById('resultsContainer').innerHTML = ''; - data.forEach(function(result) { - panel = $('
    '); - item = $('
    '); - panel.append(item); - var checkbox = $(' '); - item.append(checkbox); - checkbox.click(function() { - updateButton(checkbox); - }); - item.append(result.title); - container.append(panel); - }); - } + type: 'GET', + url: [[@{|/auth/import/crossref/search|}]]+ "?page=1&query=" + $("#searchQuery").val(), + async: false, + success: function(data) { + var container = $("#resultsContainer"); + document.getElementById('resultsContainer').innerHTML = ''; + data.forEach(function(result) { + panel = $('
    '); + item = $('
    '); + panel.append(item); + var checkbox = $(' '); + item.append(checkbox); + checkbox.click(function() { + updateButton(checkbox); + }); + item.append(result.title); + container.append(panel); + }); + } }); }); - - $("#importBtn").click(function(e) { + + $("#importBtn").click(function(e) { e.preventDefault(); var group = $("#groupSelect").val() $.ajax({ - type: 'POST', - url: [[@{|/auth/import/crossref|}]], - dataType: "json", - data: { - [[${_csrf.parameterName}]]: [[${_csrf.token}]], - "groupId": group, - "dois": Array.from(selectedDois.values()), - }, - success: function(data) { - var uploadedFilesList = $("#uploaded-files-list"); - var alert = data; - if(alert.show_alert && alert.alert_type=="success") { + type: 'POST', + url: [[@{|/auth/import/crossref|}]], + dataType: "json", + data: { + [[${_csrf.parameterName}]]: [[${_csrf.token}]], + "groupId": group, + "dois": Array.from(selectedDois.values()), + }, + success: function(data) { + var uploadedFilesList = $("#uploaded-files-list"); + var alert = data; + if(alert.show_alert && alert.alert_type == "success") { $("#uploadedAlert").show(); - } else if (alert.show_alert && alert.alert_type=="danger") { + } else if (alert.show_alert && alert.alert_type == "danger") { $("#failMessage").html(alert.alert_msg); $("#failAlert").show(); } - } + } }); - document.getElementById('resultsContainer').innerHTML = ''; + document.getElementById('resultsContainer').innerHTML = ''; selectedDois.clear(); $("#importBtn").text("Import Selected"); }); From 73245815a765789f7966d276bfff324b44f9664d Mon Sep 17 00:00:00 2001 From: PradnyaC11 Date: Fri, 2 Aug 2024 16:29:02 -0700 Subject: [PATCH 12/17] [CITE-177] Addressing PR comments --- .../api/v1/user/JobInfoController.java | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java b/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java index c33e11d52..33057e886 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java @@ -1,5 +1,10 @@ package edu.asu.diging.citesphere.api.v1.user; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; @@ -8,10 +13,6 @@ import org.springframework.web.bind.annotation.RequestHeader; import org.springframework.web.bind.annotation.RequestMapping; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.databind.node.ArrayNode; -import com.fasterxml.jackson.databind.node.ObjectNode; - import edu.asu.diging.citesphere.core.export.IExportTaskManager; import edu.asu.diging.citesphere.core.model.IZoteroToken; import edu.asu.diging.citesphere.core.model.export.IExportTask; @@ -56,8 +57,7 @@ public ResponseEntity getProfile(@RequestHeader HttpHeaders headers) { IJob job = jobManager.findJob(tokenContents.getJobId()); IZoteroToken zoteroToken = tokenManager.getToken(userManager.findByUsername(job.getUsername())); - ObjectMapper mapper = new ObjectMapper(); - ObjectNode node = mapper.createObjectNode(); + Map node = new HashMap<>(); node.put("zotero", zoteroToken.getToken()); node.put("zoteroId", zoteroToken.getUserId()); node.put("username", job.getUsername()); @@ -71,9 +71,9 @@ public ResponseEntity getProfile(@RequestHeader HttpHeaders headers) { node.put("exportType", exportTask.getExportType().name()); node.put("taskId", exportTask.getId()); } else if (job instanceof IImportCrossrefJob) { - ArrayNode doisNode = mapper.createArrayNode(); - ((IImportCrossrefJob)job).getDois().forEach(d -> doisNode.add(d)); - node.set("dois", doisNode); + List doisList = new ArrayList<>(); + ((IImportCrossrefJob)job).getDois().forEach(d -> doisList.add(d)); + node.put("dois", doisList); node.put("groupId", ((IImportCrossrefJob)job).getCitationGroup()); } From fc238b91935855d1a78d8c89740b1e9ffe3b0795 Mon Sep 17 00:00:00 2001 From: PradnyaC11 Date: Fri, 6 Sep 2024 09:48:34 -0700 Subject: [PATCH 13/17] [CITE-177] Addressed PR comments --- .../api/v1/user/JobInfoController.java | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java b/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java index 33057e886..f112e8815 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java @@ -57,26 +57,26 @@ public ResponseEntity getProfile(@RequestHeader HttpHeaders headers) { IJob job = jobManager.findJob(tokenContents.getJobId()); IZoteroToken zoteroToken = tokenManager.getToken(userManager.findByUsername(job.getUsername())); - Map node = new HashMap<>(); - node.put("zotero", zoteroToken.getToken()); - node.put("zoteroId", zoteroToken.getUserId()); - node.put("username", job.getUsername()); + Map reponse = new HashMap<>(); + reponse.put("zotero", zoteroToken.getToken()); + reponse.put("zoteroId", zoteroToken.getUserId()); + reponse.put("username", job.getUsername()); // FIXME: ugly, needs better solution if (job instanceof IUploadJob) { - node.put("groupId", ((IUploadJob)job).getCitationGroup()); + reponse.put("groupId", ((IUploadJob)job).getCitationGroup()); } else if (job instanceof IExportJob) { IExportTask exportTask = exportTaskManager.get(((IExportJob)job).getTaskId()); - node.put("groupId", exportTask.getGroupId()); - node.put("collectionId", exportTask.getCollectionId()); - node.put("exportType", exportTask.getExportType().name()); - node.put("taskId", exportTask.getId()); + reponse.put("groupId", exportTask.getGroupId()); + reponse.put("collectionId", exportTask.getCollectionId()); + reponse.put("exportType", exportTask.getExportType().name()); + reponse.put("taskId", exportTask.getId()); } else if (job instanceof IImportCrossrefJob) { List doisList = new ArrayList<>(); ((IImportCrossrefJob)job).getDois().forEach(d -> doisList.add(d)); - node.put("dois", doisList); - node.put("groupId", ((IImportCrossrefJob)job).getCitationGroup()); + reponse.put("dois", doisList); + reponse.put("groupId", ((IImportCrossrefJob)job).getCitationGroup()); } - return new ResponseEntity<>(node.toString(), HttpStatus.OK); + return new ResponseEntity<>(reponse.toString(), HttpStatus.OK); } } From 4c7f0d9668cc4131a42b75350ca2edbec48bdbb9 Mon Sep 17 00:00:00 2001 From: PradnyaC11 <36339748+PradnyaC11@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:53:06 -0700 Subject: [PATCH 14/17] [CITE-177] Corrected indentation for crossref.html --- .../src/main/webapp/WEB-INF/views/auth/import/crossref.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html b/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html index 03fb41bc0..fa7680731 100644 --- a/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html +++ b/citesphere/src/main/webapp/WEB-INF/views/auth/import/crossref.html @@ -27,7 +27,7 @@ container.append(panel); }); } - }); + }); }); $("#importBtn").click(function(e) { @@ -52,7 +52,7 @@ $("#failAlert").show(); } } - }); + }); document.getElementById('resultsContainer').innerHTML = ''; selectedDois.clear(); $("#importBtn").text("Import Selected"); From ba4a409ac08d25ccfe1bc8dc03cbc2472445856c Mon Sep 17 00:00:00 2001 From: PradnyaC11 Date: Fri, 20 Sep 2024 16:12:00 -0700 Subject: [PATCH 15/17] [CITE-177] Addressed PR comments --- .../api/v1/user/JobInfoController.java | 41 ++++++++++++------- 1 file changed, 26 insertions(+), 15 deletions(-) diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java b/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java index f112e8815..25f5ba643 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java @@ -57,26 +57,37 @@ public ResponseEntity getProfile(@RequestHeader HttpHeaders headers) { IJob job = jobManager.findJob(tokenContents.getJobId()); IZoteroToken zoteroToken = tokenManager.getToken(userManager.findByUsername(job.getUsername())); - Map reponse = new HashMap<>(); - reponse.put("zotero", zoteroToken.getToken()); - reponse.put("zoteroId", zoteroToken.getUserId()); - reponse.put("username", job.getUsername()); + Map response = new HashMap<>(); + response.put("zotero", zoteroToken.getToken()); + response.put("zoteroId", zoteroToken.getUserId()); + response.put("username", job.getUsername()); // FIXME: ugly, needs better solution if (job instanceof IUploadJob) { - reponse.put("groupId", ((IUploadJob)job).getCitationGroup()); + handleUploadJob(response, (IUploadJob) job); } else if (job instanceof IExportJob) { - IExportTask exportTask = exportTaskManager.get(((IExportJob)job).getTaskId()); - reponse.put("groupId", exportTask.getGroupId()); - reponse.put("collectionId", exportTask.getCollectionId()); - reponse.put("exportType", exportTask.getExportType().name()); - reponse.put("taskId", exportTask.getId()); + handleExportJob(response, (IExportJob) job); } else if (job instanceof IImportCrossrefJob) { - List doisList = new ArrayList<>(); - ((IImportCrossrefJob)job).getDois().forEach(d -> doisList.add(d)); - reponse.put("dois", doisList); - reponse.put("groupId", ((IImportCrossrefJob)job).getCitationGroup()); + handleImportCrossrefJob(response, (IImportCrossrefJob) job); } - return new ResponseEntity<>(reponse.toString(), HttpStatus.OK); + return new ResponseEntity<>(response.toString(), HttpStatus.OK); + } + + private void handleUploadJob(Map response, IUploadJob job) { + response.put("groupId", job.getCitationGroup()); + } + + private void handleExportJob(Map response, IExportJob job) { + IExportTask exportTask = exportTaskManager.get(job.getTaskId()); + response.put("groupId", exportTask.getGroupId()); + response.put("collectionId", exportTask.getCollectionId()); + response.put("exportType", exportTask.getExportType().name()); + response.put("taskId", exportTask.getId()); + } + + private void handleImportCrossrefJob(Map response, IImportCrossrefJob job) { + List doisList = new ArrayList<>(job.getDois()); + response.put("dois", doisList); + response.put("groupId", job.getCitationGroup()); } } From baf03ada114c65d3622a199adcbe61b0d399342d Mon Sep 17 00:00:00 2001 From: PradnyaC11 Date: Fri, 25 Oct 2024 16:40:03 -0700 Subject: [PATCH 16/17] [CITE-177] Addressing PR comments --- .../api/v1/user/JobInfoController.java | 31 ++++++++++++++----- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java b/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java index 25f5ba643..061c64acd 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java @@ -4,7 +4,10 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +import java.util.function.BiConsumer; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; @@ -20,6 +23,9 @@ import edu.asu.diging.citesphere.core.model.jobs.IImportCrossrefJob; import edu.asu.diging.citesphere.core.model.jobs.IJob; import edu.asu.diging.citesphere.core.model.jobs.IUploadJob; +import edu.asu.diging.citesphere.core.model.jobs.impl.ExportJob; +import edu.asu.diging.citesphere.core.model.jobs.impl.ImportCrossrefJob; +import edu.asu.diging.citesphere.core.model.jobs.impl.UploadJob; import edu.asu.diging.citesphere.core.service.jobs.IUploadJobManager; import edu.asu.diging.citesphere.core.service.jwt.IJobApiTokenContents; import edu.asu.diging.citesphere.core.user.IUserManager; @@ -28,6 +34,8 @@ @Controller public class JobInfoController extends BaseJobInfoController { + private final Logger logger = LoggerFactory.getLogger(getClass()); + @Autowired private IUserManager userManager; @@ -38,9 +46,17 @@ public class JobInfoController extends BaseJobInfoController { private IUploadJobManager jobManager; @Autowired - private IExportTaskManager exportTaskManager; + private IExportTaskManager exportTaskManager; + private Map, BiConsumer, Object>> jobHandlers = new HashMap<>(); + public JobInfoController() { + // Map each job class to its respective handling method + jobHandlers.put(UploadJob.class, (response, job) -> handleUploadJob(response, (IUploadJob) job)); + jobHandlers.put(ExportJob.class, (response, job) -> handleExportJob(response, (IExportJob) job)); + jobHandlers.put(ImportCrossrefJob.class, (response, job) -> handleImportCrossrefJob(response, (IImportCrossrefJob) job)); + } + @RequestMapping(value="/job/info") public ResponseEntity getProfile(@RequestHeader HttpHeaders headers) { ResponseEntity entity = checkForToken(headers); @@ -61,13 +77,12 @@ public ResponseEntity getProfile(@RequestHeader HttpHeaders headers) { response.put("zotero", zoteroToken.getToken()); response.put("zoteroId", zoteroToken.getUserId()); response.put("username", job.getUsername()); - // FIXME: ugly, needs better solution - if (job instanceof IUploadJob) { - handleUploadJob(response, (IUploadJob) job); - } else if (job instanceof IExportJob) { - handleExportJob(response, (IExportJob) job); - } else if (job instanceof IImportCrossrefJob) { - handleImportCrossrefJob(response, (IImportCrossrefJob) job); + BiConsumer, Object> handler = jobHandlers.get(job.getClass()); + if (handler != null) { + handler.accept(response, job); + } else { + logger.error("No handler found for job type: " + job.getClass()); + return new ResponseEntity<>("No handler found for job type: " + job.getClass(), HttpStatus.INTERNAL_SERVER_ERROR); } return new ResponseEntity<>(response.toString(), HttpStatus.OK); From 9afba4503e4b8eb1c71575a857a14c19477a8745 Mon Sep 17 00:00:00 2001 From: PradnyaC11 Date: Mon, 28 Oct 2024 15:42:04 -0700 Subject: [PATCH 17/17] [CITE-177] Addressed PR comments --- .../api/v1/user/JobInfoController.java | 62 ++++++++++--------- 1 file changed, 34 insertions(+), 28 deletions(-) diff --git a/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java b/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java index 061c64acd..6cf1a1bfd 100644 --- a/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java +++ b/citesphere/src/main/java/edu/asu/diging/citesphere/api/v1/user/JobInfoController.java @@ -1,8 +1,6 @@ package edu.asu.diging.citesphere.api.v1.user; -import java.util.ArrayList; import java.util.HashMap; -import java.util.List; import java.util.Map; import java.util.function.BiConsumer; @@ -16,6 +14,11 @@ import org.springframework.web.bind.annotation.RequestHeader; import org.springframework.web.bind.annotation.RequestMapping; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.ArrayNode; +import com.fasterxml.jackson.databind.node.ObjectNode; + import edu.asu.diging.citesphere.core.export.IExportTaskManager; import edu.asu.diging.citesphere.core.model.IZoteroToken; import edu.asu.diging.citesphere.core.model.export.IExportTask; @@ -48,17 +51,17 @@ public class JobInfoController extends BaseJobInfoController { @Autowired private IExportTaskManager exportTaskManager; - private Map, BiConsumer, Object>> jobHandlers = new HashMap<>(); + private Map, BiConsumer> jobHandlers = new HashMap<>(); public JobInfoController() { // Map each job class to its respective handling method - jobHandlers.put(UploadJob.class, (response, job) -> handleUploadJob(response, (IUploadJob) job)); - jobHandlers.put(ExportJob.class, (response, job) -> handleExportJob(response, (IExportJob) job)); - jobHandlers.put(ImportCrossrefJob.class, (response, job) -> handleImportCrossrefJob(response, (IImportCrossrefJob) job)); + jobHandlers.put(UploadJob.class, (node, job) -> handleUploadJob(node, (IUploadJob) job)); + jobHandlers.put(ExportJob.class, (node, job) -> handleExportJob(node, (IExportJob) job)); + jobHandlers.put(ImportCrossrefJob.class, (node, job) -> handleImportCrossrefJob(node, (IImportCrossrefJob) job)); } @RequestMapping(value="/job/info") - public ResponseEntity getProfile(@RequestHeader HttpHeaders headers) { + public ResponseEntity getProfile(@RequestHeader HttpHeaders headers) throws JsonProcessingException { ResponseEntity entity = checkForToken(headers); if (entity != null) { return entity; @@ -72,37 +75,40 @@ public ResponseEntity getProfile(@RequestHeader HttpHeaders headers) { IJob job = jobManager.findJob(tokenContents.getJobId()); IZoteroToken zoteroToken = tokenManager.getToken(userManager.findByUsername(job.getUsername())); - - Map response = new HashMap<>(); - response.put("zotero", zoteroToken.getToken()); - response.put("zoteroId", zoteroToken.getUserId()); - response.put("username", job.getUsername()); - BiConsumer, Object> handler = jobHandlers.get(job.getClass()); + + ObjectMapper mapper = new ObjectMapper(); + ObjectNode node = mapper.createObjectNode(); + node.put("zotero", zoteroToken.getToken()); + node.put("zoteroId", zoteroToken.getUserId()); + node.put("username", job.getUsername()); + BiConsumer handler = jobHandlers.get(job.getClass()); if (handler != null) { - handler.accept(response, job); + handler.accept(node, job); } else { logger.error("No handler found for job type: " + job.getClass()); return new ResponseEntity<>("No handler found for job type: " + job.getClass(), HttpStatus.INTERNAL_SERVER_ERROR); } - - return new ResponseEntity<>(response.toString(), HttpStatus.OK); + + return new ResponseEntity<>(node.toString(), HttpStatus.OK); } - - private void handleUploadJob(Map response, IUploadJob job) { - response.put("groupId", job.getCitationGroup()); + + private void handleUploadJob(ObjectNode node, IUploadJob job) { + node.put("groupId", job.getCitationGroup()); } - private void handleExportJob(Map response, IExportJob job) { + private void handleExportJob(ObjectNode node, IExportJob job) { IExportTask exportTask = exportTaskManager.get(job.getTaskId()); - response.put("groupId", exportTask.getGroupId()); - response.put("collectionId", exportTask.getCollectionId()); - response.put("exportType", exportTask.getExportType().name()); - response.put("taskId", exportTask.getId()); + node.put("groupId", exportTask.getGroupId()); + node.put("collectionId", exportTask.getCollectionId()); + node.put("exportType", exportTask.getExportType().name()); + node.put("taskId", exportTask.getId()); } - private void handleImportCrossrefJob(Map response, IImportCrossrefJob job) { - List doisList = new ArrayList<>(job.getDois()); - response.put("dois", doisList); - response.put("groupId", job.getCitationGroup()); + @SuppressWarnings("deprecation") + private void handleImportCrossrefJob(ObjectNode node, IImportCrossrefJob job) { + ObjectMapper mapper = new ObjectMapper(); + ArrayNode arrayNode = mapper.valueToTree(job.getDois()); + node.put("dois", arrayNode); + node.put("groupId", job.getCitationGroup()); } }