R/alteryx_job.R

In alterryx: An 'API' Client for the 'Alteryx' Gallery

#' @title Alteryx Jobs
#'
#' @description Handling of job information returned by the Alteryx
#' Gallery API. For more information, see \code{\link{get_job}}.
#'
#' @exportClass alteryx_job
#'
#' @rdname alteryx_job
#

#' @rdname alteryx_job
#'
#' @param x A \code{list} of values pertaining to an Alteryx job returned from
#' the Alteryx Gallery API
#' @param parent An \code{alteryx_app} or \code{alteryx_job} containing the id
#' and name information of the parent application for a job.
#'
#' @export
as.alteryx_job <- function(x, parent) {
  add_parent <- function(job, parent) {
    parent <- list(parentApp = parent$fileName %||% parent$parentApp,
                   parentId = parent$id %||% parent$parentId)

    alteryx_job <- append(job, parent)
    return(alteryx_job)
  }

  x <- add_parent(x, parent)

  expected <- c("appId",
                "parentApp",
                "parentId",
                "id",
                "createDate",
                "status",
                "disposition",
                "outputs",
                "messages",
                "priority",
                "workerTag")

  expected <- sort(expected)
  x_names <- sort(names(x))

  if(!identical(x_names, expected))
    stop("Unexpected input. Cannot convert to type alteryx_job.")

  class(x) <- append("alteryx_job", class(x))
  return(x)
}

#' @rdname alteryx_job
#'
#' @param object An R object
#'
#' @export
is.alteryx_job <- function(object) inherits(object, "alteryx_job")

#' @export
format.alteryx_job <- function(x, ...) {
  paste(
    paste("Alteryx job for app", x$parentApp),
    paste("Job ID:", x$id),
    paste("Status:", x$status),
    paste("Disposition:", x$disposition),
    sep = "\n"
  )
}

#' @export
print.alteryx_job <- function(x, ...) cat(format(x, ...), "\n")

#' @export
get_info.alteryx_job <- function(resource, full_info = FALSE) {

  if(full_info) {

    info <- lapply(names(resource), function(x) {resource[[x]]})
    names(info) <- names(resource)

  } else {

    info_names <- names(resource)
    info_names <- info_names[!info_names %in% c("outputs", "messages")]

    info <- lapply(info_names, function(x) {resource[[x]]})
    names(info) <- info_names

    if(length(resource$outputs)) {
      output_names <- lapply(resource$outputs, function(x) {x$name})
      outputs <- lapply(resource$outputs, function(x) {x$id})
      names(outputs) <- unlist(output_names)
      info <- append(info, list(outputs = outputs))
    }

  }

  return(info)
}