R/styles.R

In mapboxapi: R Interface to 'Mapbox' Web Services

#' Get information about a style or list styles from a Mapbox account
#'
#' See the [Mapbox Styles API](https://docs.mapbox.com/api/maps/styles/)
#' documentation for more information.
#'
#' @param style_url A Mapbox style URL
#' @param style_id A style ID
#' @param username A Mapbox username
#' @param access_token A Mapbox public or secret access token; set with
#'   [mb_access_token()]
#'
#' @return [get_style] returns a list of information about your selected style.
#'   [list_styles] returns a data frame of information about styles from a
#'   Mapbox account
#' @name get_style
#' @export
get_style <- function(style_id,
                      username,
                      style_url = NULL,
                      access_token = NULL) {
  access_token <- get_mb_access_token(access_token, default = "MAPBOX_SECRET_TOKEN")

  if (!is.null(style_url)) {
    username <- stringi::stri_extract(style_url, regex = paste0("(?<=styles/).+(?=/)"))
    style_id <- stringi::stri_extract(style_url, regex = paste0("(?<=", username, "/).+"))
  }

  url <- sprintf("https://api.mapbox.com/styles/v1/%s/%s", username, style_id)

  request <- httr::GET(
    url = url,
    query = list(access_token = access_token)
  )

  content <- httr::content(request, as = "text")

  if (request$status_code != 200) {
    stop(print(content$message), call. = FALSE)
  }

  return(jsonlite::fromJSON(content))
}

#' @name list_styles
#' @rdname get_style
#' @export
list_styles <- function(username, access_token = NULL) {
  access_token <- get_mb_access_token(access_token, default = "MAPBOX_SECRET_TOKEN")

  url <- sprintf("https://api.mapbox.com/styles/v1/%s", username)

  request <- httr::GET(url, query = list(access_token = access_token))

  content <- httr::content(request, as = "text")

  if (request$status_code != 200) {
    stop(content, call. = FALSE)
  }

  return(jsonlite::fromJSON(content))
}