R/post_file_votes.R

In virustotal: R Client for the 'VirusTotal' API

#' Add a vote to a file
#'
#' @param hash File hash (MD5, SHA1, or SHA256)
#' @param verdict Vote verdict: "harmless" or "malicious"
#' @param \dots Additional arguments passed to \code{\link{virustotal_POST}}.
#'
#' @return list containing response data
#'
#' @export
#'
#' @references \url{https://docs.virustotal.com/reference}
#'
#' @seealso \code{\link{set_key}} for setting the API key
#'
#' @examples \dontrun{
#'
#' # Before calling the function, set the API key using set_key('api_key_here')
#'
#' post_file_votes(hash='99017f6eebbac24f351415dd410d522d', verdict='malicious')
#' }

post_file_votes <- function(hash = NULL, verdict = NULL, ...) {

  assert_character(hash, len = 1, any.missing = FALSE, min.chars = 1)
  assert_character(verdict, len = 1, any.missing = FALSE)

  if (!verdict %in% c("harmless", "malicious")) {
    stop(virustotal_validation_error(
      message = "Verdict must be either 'harmless' or 'malicious'",
      parameter = "verdict",
      value = verdict
    ))
  }

  vote_body <- list(data = list(type = "vote",
                                 attributes = list(verdict = verdict)))
  res <- virustotal_POST(path = paste0("files/", hash, "/votes"),
                        body = vote_body, ...)

  res
}