R/unfollowback.R

In mkearney/trickrtweet: Twitter Networking

#' unfollowback
#'
#' Removes friends who don't follow back (with exceptions)
#'
#' @param keep Character vector of screen names or IDs to not unfollow.
#'   These are probably popular accounts that you don't expect reciprocity
#'   from. Default is NULL. If "../data/keepers.rds" exists, it will be
#'   read in and used regardless of whether this value is NULL.
#' @param ... Passed to \code{\link{unfollowback.default}}
#' @return List where each element corresponds to an API response object.
#'   Elements should be of status 200 if unfollow request was successful.
#' @importFrom rtweet get_friends get_followers lookup_users
#' @export
unfollowback <- function(keep = NULL, ...) {
  UseMethod("unfollowback")
}


#' unfollowback
#'
#' Removes friends who don't follow back (with exceptions)
#'
#' @param keep Character vector of screen names or IDs to not unfollow.
#'   These are probably popular accounts that you don't expect reciprocity
#'   from. Default is NULL. If there is a TWITTER_KEEPERS path, it will be
#'   read in and used regardless of whether this value is NULL.
#' @return List where each element corresponds to an API response object.
#'   Elements should be of status 200 if unfollow request was successful.
#' @importFrom rtweet get_friends get_followers lookup_users
#' @export
unfollowback.default <- function(keep = NULL) {
  user <- home_user()
  ## friends
  fds <- get(".fds", envir = .trickrtweet)
  ## followers
  flw <- get(".flw", envir = .trickrtweet)
  ## id people who don't follow back
  tounf <- fds[!fds %in% flw]
  if (length(tounf) == 0L) {
    message("No haters. Nothing but follow backs!")
    return(invisible())
  }
  ## friends user data
  fds_data <- get(".fds_data", envir = .trickrtweet)
  ## subset to users to unfollow
  tu_users <- fds_data[fds_data$user_id %in% tounf, ]
  ## keepers
  keepers <- Sys.getenv("TWITTER_KEEPERS")
  if (!is.null(keep)) {
    keepdata <- lookup_users(keep)
    keep <- keeptdata$user_id
  }
  if (file.exists(keepers) && !identical("", keepers)) {
    keepers <- readRDS(keepers)
    keep <- c(keepers, keep)
  }
  if (!is.null(keep)) {
    tounf <- tu_users$user_id[!tu_users$user_id %in% keep]
    saveRDS(keep, file = Sys.getenv("TWITTER_KEEPERS"))
  }
  ## final vector to unfollow
  tounf <- fds[fds %in% tounf]
  ## if none then say so
  if (length(tounf) == 0L) {
    message("No one left to unfollow!")
    return(invisible())
  }
  ## unfollow
  out <- Map(
    unfollow_user, user = tounf
  )
  ## return invisible
  return(out)
}

#' @importFrom rtweet post_unfollow_user
unfollow_user <- function(..., sleeper = TRUE) {
  if (sleeper) {
    ## sleep an average of 3.5 seconds per call
    Sys.sleep(runif(1, 2, 4))
  }
  post_unfollow_user(...)
}