R/slackr_utils.R

In slackr: Send Messages, Images, R Objects and Files to 'Slack' Channels/Users

#' Get a data frame of Slack users
#'
#' @param token Authentication token bearing required scopes.
#' @return `data.frame` of users
#' @importFrom dplyr bind_cols setdiff
#' @export
slackr_users <- function(token = Sys.getenv("SLACK_TOKEN")) {
  members <- list_users(token = token)
  cols <- setdiff(colnames(members), c("profile", "real_name"))
  bind_cols(
    members[, cols],
    members$profile
  )
}

#' Get a data frame of Slack channels
#'
#' @param token Authentication token bearing required scopes.
#' @param exclude_archived A boolean indicating whether or not to exclude archived channels.
#'
#' @importFrom dplyr bind_rows
#'
#' @return A data.frame of channels
#' @export
slackr_channels <- function(token = Sys.getenv("SLACK_TOKEN"), exclude_archived = TRUE) {
  c1 <- list_channels(token = token, types = "public_channel", exclude_archived = exclude_archived)
  c2 <- list_channels(token = token, types = "private_channel", exclude_archived = exclude_archived)

  bind_rows(c1, c2)
}

#' Get a data frame of Slack IM ids
#'
#' @param token Authentication token bearing required scopes.
#' @importFrom dplyr left_join rename
#'
#' @author Quinn Weber (aut), Bob Rudis (ctb)
#' @references <https://github.com/mrkaye97/slackr/pull/13>
#' @return `data.frame` of im ids and user names
#' @export
slackr_ims <- function(token = Sys.getenv("SLACK_TOKEN")) {
  ims <- list_channels(token = token, types = "im", exclude_archived = TRUE) %>%
    rename(channel = "id")
  users <- slackr_users(token = token)

  if ((nrow(ims) == 0) | (nrow(users) == 0)) {
    abort("slackr is not seeing any users in your workspace. Are you sure you have the right scopes enabled? See the readme for details.")
  }

  left_join(users, ims, by = c(id = "user"))
}

#' Translate vector of channel names to channel IDs for API
#'
#' Given a vector of one or more channel names, retrieve list of
#' active channels and try to replace channels that begin with "`#`" or "`@@`"
#' with the channel ID for that channel.
#'
#' @param channels Comma-separated list of channel names or IDs where the file will be shared.
#' @param token Authentication token bearing required scopes.
#' @author Quinn Weber (ctb), Bob Rudis (aut)
#' @return character vector - original channel list with `#` or
#'          `@@` channels replaced with ID's.
#' @export
slackr_chtrans <- function(channels, token = Sys.getenv("SLACK_TOKEN")) {
  channel_cache <- slackr_census(token)

  chan_xref <-
    channel_cache[
      (channel_cache$name %in% channels) |
        (channel_cache$real_name %in% channels) |
        (channel_cache$id %in% channels),
    ]

  ifelse(
    is.na(chan_xref$id),
    as.character(chan_xref$name),
    as.character(chan_xref$id)
  )
}

#' Create a cache of the users and channels in the workspace in order to limit API requests
#'
#' @param token Authentication token bearing required scopes.
#' @return A data.frame of channels and users
#' @importFrom dplyr bind_rows distinct
#' @importFrom tibble tibble
#' @importFrom memoise memoise
#' @importFrom cachem cache_mem cache_disk
#' @noRd
#'
slackr_census_fun <- function(token) {
  msg <- "Are you sure you have the right scopes enabled? See the readme for details."

  chan <- slackr_channels(token)

  if (is.null(chan) || nrow(chan) == 0) {
    stop("slackr is not seeing any channels in your workspace. ", msg)
  }

  users <- slackr_ims(token)
  if (is.null(chan) || nrow(chan) == 0) {
    stop("slackr is not seeing any users in your workspace. ", msg)
  }

  chan$name <- sprintf("#%s", chan$name)
  users$name <- sprintf("@%s", users$name)

  chan_list <- tibble(
    id        = character(0),
    name      = character(0),
    real_name = character(0)
  )

  if (length(chan) > 0) {
    chan_list <- bind_rows(chan_list, chan[, c("id", "name")])
  }
  if (length(users) > 0) {
    chan_list <- bind_rows(chan_list, users[, c("id", "name", "real_name")])
  }

  distinct(chan_list)
}

cache_dir <- Sys.getenv("SLACK_CACHE_DIR")
if (cache_dir == "") {
  slackr_census <- memoise::memoise(slackr_census_fun, cache = cachem::cache_mem())
} else {
  slackr_census <- memoise::memoise(slackr_census_fun, cache = cachem::cache_disk(dir = cache_dir))
}