R/api-client-wb.R

In CenterForOpenScience/osfr: Interface to the 'Open Science Framework' ('OSF')

#' Generate Waterbutler API paths
#'
#' @param id GUID for an OSF project or component
#' @param fid waterbutler identifier for a file or folder
#' @param provider storage provider (default: osfstorage)
#' @param type indicate whether the provided `fid` refers to a `"folder"` (the
#'   default) or `"file"`. This is significant because the path must always have
#'   a trailing flash when referring to a folder
#' @param version Specify the waterbutler API version
#'
#' @noRd
.wb_api_path <-
  function(id,
           fid = NULL,
           provider = "osfstorage",
           type = "folder") {

  type <- match.arg(type, c("folder", "file"))

  out <- sprintf("/resources/%s/providers/%s/", id, provider)
  if (!is.null(fid)) out <- sprintf("%s/%s/", out, fid)

  switch(type,
    file = sub("\\/$", "", out),
    folder = out
  )
}


# Waterbutler request functions -------------------------------------------

.wb_request <-
  function(method,
           path,
           query = list(),
           body = NULL,
           version = 1,
           verbose = FALSE,
           progress = FALSE,
           ...) {
  method <- match.arg(method, c("get", "put", "patch", "post", "delete"))

  if (progress) {
    pb <- switch(method,
      get = httr::progress(type = "down"),
      put = httr::progress(type = "up"),
      NULL
    )
  } else {
    pb <- NULL
  }

  cli <- .build_client(api = "wb", encode = "raw", progress = pb)
  cli$retry(
    method,
    prepend_version(path, version),
    query,
    body = body,
    times = 3,
    retry_only_on = "502",
    onwait = retry_message,
    ...
  )
}