R/service-urls.R

In ropenscilabs/deposits: A universal client for depositing and accessing research data anywhere

#' Get URL of deposit service
#'
#' @param cli Deposits client with 'url_base' and 'service' fields.
#' @param deposit_id Optional identifier of specified deposit. If specified,
#' return URL to that deposit, otherwise return generic URL to particular
#' service, used to create or list deposits.
#' @param private Figshare API URLs differ for public articles by having the
#' "account" sub-domain removed. This flag can be used to force insertion of
#' this private sub-domain for methods, such as new article creation, which
#' nevertheless require it.
#' @return URL
#' @noRd

get_service_url <- function (cli, deposit_id = NULL, private = TRUE) {

    subdom <- ""
    if (cli$service == "figshare") {

        subdom <- "articles" # public articles
        if (private) {
            subdom <- "account/articles"
        } else {
            cli$deposits_list ()
            if (!is.null (deposit_id) && !is.null (cli$deposits$id)) {
                if (deposit_id %in% cli$deposits$id) {
                    subdom <- "account/articles" # private articles
                }
            }
        }

    } else if (cli$service == "zenodo") {

        subdom <- "deposit/depositions"
    }

    url <- paste0 (cli$url_base, subdom)

    if (!is.null (deposit_id)) {
        checkmate::assert_int (deposit_id)
        url <- paste0 (url, "/", deposit_id)
    }

    return (url)
}