R/user_list_items.R

In jemus42/tRakt: Get Data from 'trakt.tv'

#' Get a user's list's items
#'
#' @inheritParams trakt_api_common_parameters
#' @param list_id The list identifier, either `trakt` ID or `slug` of the list.
#'   Can be optained via the website (URL `slug`) or e.g. [user_lists].
#' @param type `character(1) [NULL]`: If not `NULL`, only items of that media type are
#' returned. Possible values are `"movie"`, `"show"`, `"season"`, `"episode"`, `"person"`.
#' @inherit trakt_api_common_parameters return
#'
#' @export
#' @family list methods
#' @eval apiurl("users", "list items")
#' @importFrom dplyr select one_of filter bind_cols arrange matches
#' @importFrom purrr map_df
#' @importFrom rlang is_empty
#' @examples
#' \dontrun{
#' # A large list with various media types
#' # All items
#' user_list_items("sp1ti", list_id = "5615781", extended = "min")
#'
#' # Movies only
#' user_list_items("sp1ti", list_id = "5615781", extended = "min", type = "movie")
#'
#' # Shows...
#' user_list_items("sp1ti", list_id = "5615781", extended = "min", type = "shows")
#'
#' # Only seasons
#' user_list_items("sp1ti", list_id = "5615781", extended = "min", type = "season")
#'
#' # Only episodes
#' user_list_items("sp1ti", list_id = "5615781", extended = "min", type = "episodes")
#' }
user_list_items <- function(user = getOption("trakt_username"),
                            list_id, type = NULL,
                            extended = c("min", "full")) {
  check_username(user)

  type <- check_types(type, several.ok = TRUE)

  extended <- match.arg(extended)

  url <- build_trakt_url(
    "users", user, "lists", list_id, "items", type,
    extended = extended
  )
  response <- trakt_get(url)

  if (is_empty(response)) {
    return(tibble())
  }

  # What types are present in the list
  list_types <- unique(response$type)

  # Get the list "base" without media items
  # If type == "seasons" or "episode"; there will be a "show" object,
  # which needs removal from list_base, but isn't present in response$type
  list_base <- response |>
    select(-one_of(list_types), -matches("^show$"))

  # Row-bind the list base to the unpacked media items
  map_df(list_types, ~ {
    bind_cols(
      list_base |>
        filter(type == .x),
      flatten_media_object(response, .x)
    )
  }) |>
    arrange(rank) |>
    fix_tibble_response()
}