R/read_functions.R

Defines functions read_data read_status read_field read_settings

Documented in read_data read_field read_settings read_status

.build_n_get <- purrr::as_mapper(~ .x %>%
                                httr::build_url() %>%
                                httr::GET()
                              )

#' Title
#'
#' @param channel
#' @param parameters
#'
#' @return
#' @export
#'
#' @examples
read_data <- function(channel, parameters = list()) {
  .compose_ts_url(
    channel = channel,
    request_type = "feeds",
    parameters = parameters
  ) %>%
    .build_n_get() %>%
    .parse_response()
}

#' Title
#'
#' @param channel
#' @param parameters
#'
#' @return
#' @export
#'
#' @examples
read_status <- function(channel, parameters = list()) {
  .compose_ts_url(
    channel = channel,
    request_type = "status",
    parameters = parameters
  ) %>%
    .build_n_get %>%
    .parse_response()
}


#' Title
#'
#' @param channel
#' @param field
#' @param parameters
#'
#' @return
#' @export
#'
#' @examples
read_field <- function(channel, field, parameters = list()) {
  .compose_ts_url(
    channel = channel,
    request_type = "fields",
    field = field,
    parameters = parameters
  ) %>%
    .build_n_get() %>%
    .parse_response()
}

#' Title
#'
#' @param channel
#'
#' @return
#' @export
#'
#' @examples
read_settings <- function(channel){
  if(channel$private) stop("Private Channels require User API key. Not implemented yet")
  .compose_ts_url(
    channel = channel,
    request_type = NA_character_
  ) %>%
    .build_n_get() %>%
    .parse_response()
}
benjaminschwetz/speakr documentation built on Nov. 4, 2019, 7:14 a.m.