add support for cert download from ResearchEquals

closes codecheckers/register#162

Author: nuest

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: codecheck
 Title: Helper Functions for CODECHECK Project
-Version: 0.16.0
+Version: 0.17.0
 Authors@R: 
     c(person(given = "Stephen",
             family = "Eglen",

R/utils_download_certs.R

@@ -52,9 +52,9 @@ download_cert_pdf <- function(report_link, cert_id){
   }
 }
 
-#' Retrieves the download link for a certificate file from either Zenodo or OSF.
+#' Retrieves the download link for a certificate file from Zenodo, OSF, or ResearchEquals.
 #'
-#' @param report_link URL of the report to access, either from Zenodo or OSF.
+#' @param report_link URL of the report to access, either from Zenodo, OSF, or ResearchEquals.
 #' @param cert_id ID of the certificate, used for logging and warnings.
 #'
 #' @return The download link for the certificate file as a string if found; otherwise, NULL.
@@ -67,6 +67,11 @@ get_cert_link <- function(report_link, cert_id){
   else if (grepl("OSF", report_link, ignore.case = TRUE)) {
     cert_download_url <- get_osf_cert_link(report_link, cert_id)
   }
+  
+  # use issuer prefix for LibSci, see https://web.archive.org/web/20250504015818/https://www.libscie.org/blog/working-openly-1/minting-dois-for-research-modules-147/
+  else if (grepl("10.53962", report_link, ignore.case = TRUE)) {
+    cert_download_url <- get_researchequals_cert_link(report_link, cert_id)
+  }
 
   else(
     return(NULL)
@@ -216,6 +221,30 @@ get_zenodo_cert_link <- function(report_link, cert_id, api_key = "") {
 }
 
 
+#' Accesses a codecheck's ResearchEquals record via its report link and download the main file of the module
+#'
+#' @param report_link URL of the ResearchEquals report to access.
+#' @param cert_id ID of the certificate, used for logging and warnings.
+#' 
+#' @importFrom httr GET status_code content
+#' @importFrom jsonlite fromJSON
+#'
+#' @return The download link for the certificate file as a string if found; otherwise, NULL.
+get_researchequals_cert_link <- function(report_link, cert_id) {
+  # Download link example: https://www.researchequals.com/api/modules/main/wxh7-8yjd
+  # Let's guess the ID from the report_link
+  
+  # Checking for redirects and retrieving the record_id from there
+  response <- httr::GET(report_link)
+  final_url <- response$url
+  record_id <- basename(final_url)
+  
+  # Set the base URL for the ResearchEquals API
+  record_url <- paste0(CONFIG$CERT_LINKS[["researchequals_api"]], record_id)
+  
+  return (record_url)
+}
+
 
 #' Downloads a ZIP file from the given URL, searches for "codecheck.pdf" within its contents,
 #' renames it to "cert.pdf," and saves it in the specified directory. 

inst/extdata/config.R

@@ -196,7 +196,8 @@ CONFIG$CERT_LINKS <- list(
   osf_api = "https://api.osf.io/v2/",
   zenodo_api = "https://zenodo.org/api/records/",
   crossref_api = "https://api.crossref.org/works/",
-  openalex_api = "https://api.openalex.org/works/"
+  openalex_api = "https://api.openalex.org/works/",
+  researchequals_api = "https://www.researchequals.com/api/modules/main/"
 )
 
 CONFIG$CERTS_URL_PREFIX <- "https://doi.org/"

inst/tinytest/test_cert_download.R

@@ -0,0 +1,21 @@
+tinytest::using(ttdo)
+
+source(system.file("extdata", "config.R", package = "codecheck"))
+
+tmp <- tempdir()
+CONFIG$CERTS_DIR[["cert"]] <- tmp
+
+expect_silent({ result <- codecheck:::download_cert_pdf("https://doi.org/10.17605/osf.io/CSB7R", "9999-000") })
+expect_equal(result, 1)
+expect_true(file.exists(file.path(tmp, "9999-000", "cert.pdf")))
+expect_true(file.size(file.path(tmp, "9999-000", "cert.pdf")) > 300000)
+
+expect_silent({ result <- codecheck:::download_cert_pdf("https://doi.org/10.5281/zenodo.15630442", "9999-001") })
+expect_equal(result, 1)
+expect_true(file.exists(file.path(tmp, "9999-001", "cert.pdf")))
+expect_true(  file.size(file.path(tmp, "9999-001", "cert.pdf")) > 500000)
+
+expect_silent({ result <- codecheck:::download_cert_pdf("https://doi.org/10.53962/wgtb-cagt", "9999-002") })
+expect_equal(result, 1)
+expect_true(file.exists(file.path(tmp, "9999-002", "cert.pdf")))
+expect_true(  file.size(file.path(tmp, "9999-002", "cert.pdf")) > 200000)

inst/tinytest/test_cert_link.R

@@ -0,0 +1,10 @@
+tinytest::using(ttdo)
+
+source(system.file("extdata", "config.R", package = "codecheck"))
+
+expect_equal(codecheck:::get_cert_link("https://doi.org/10.17605/osf.io/CSB7R", "999-010"),
+             "https://osf.io/download/36nsb/")
+expect_equal(codecheck:::get_cert_link("https://doi.org/10.5281/zenodo.15630442", "999-020"),
+             "https://zenodo.org/api/records/15630442/files/CODECHECK_report_FBM.pdf/content")
+expect_equal(codecheck:::get_cert_link("https://doi.org/10.53962/wgtb-cagt", "999-030"),
+             "https://www.researchequals.com/api/modules/main/wgtb-cagt")