R/whoami.R

In ShixiangWang/yq: 'YuQue' 'API'

#' Info on current YuQue user
#'
#' Reports basic profile for the YuQue user.
#'
#' Get a personal access token for the YuQue API from
#' \url{https://www.yuque.com/settings} and select the scopes necessary for
#' your planned tasks. The \code{repo} scope, for example, is one many are
#' likely to need. The token itself is a string of 40 letters and digits.
#'
#' You can set it using [yq_config] function. You can also store it any way
#' you like and provide explicitly via the \code{.token}
#' argument to \code{\link{yq}()}.
#'
#' However, you can also define an environment variable \code{YUQUE_TOKEN}
#' with this value in their \code{.Renviron} file. Add a
#' line that looks like this, substituting your PAT:
#'
#' \preformatted{
#' YUQUE_TOKEN=8c70fd8419398999c9ac5bacf3192882193cadf2
#' }
#'
#' Put a line break at the end! If you're using an editor that shows line
#' numbers, there should be (at least) two lines, where the second one is empty.
#' Restart R for this to take effect. Call \code{yq_whoami()} to confirm
#' success.
#'
#' To get complete information on the authenticated user, call
#' \code{yq("/users/your_login_name")}.
#'
#' @inheritParams yq
#' @param show default is `TRUE`, print info.
#'
#' @return a `data.frame`
#' @export
#'
#' @examples
#' \dontrun{
#' yq_whoami()
#'
#' }
yq_whoami <- function(.token = NULL, .api_url = NULL, .send_headers = NULL,
                      show = TRUE) {
  # //TODO: add code for configured user
  .token <- .token %||% yq_token()
  if (isTRUE(.token == "")) {
    message(
      "No personal access token (PAT) available.\n",
      "Obtain a PAT from here after you login in YuQue:\n",
      "https://www.yuque.com/settings/\n",
      "For more on what to do with the PAT, see ?yq_whoami.",
      "\n==========================================="
    )
    if (file.exists(.yuque_config_path)) {
        login = jsonlite::read_json(.yuque_config_path, simplifyVector = TRUE)$login
        res <- yq(
            endpoint = "/users/:login", login = login, .token = .token,
            .api_url = .api_url, .send_headers = .send_headers
        )
    } else {
        message(
            "Also no configure file for YuQue available.\n",
            "Please either specify .token argument or \n",
            "set configuration via yq_config()"
        )
        return(invisible(NULL))
    }
  } else {
    res <- yq(
      endpoint = "/user", .token = .token,
      .api_url = .api_url, .send_headers = .send_headers
    )
  }

  res = parse_user_info(res, show = show)
  invisible(res)
}

obfuscate <- function(x, first = 2, last = 0) {
  paste0(
    substr(x, start = 1, stop = first),
    "...",
    substr(x, start = nchar(x) - last + 1, stop = nchar(x))
  )
}