R/api.R

In DenUsenko/rbinotel: An R Client for the Binotel API

#' Build the API endpoint
#'
#' Take an endpoint and attach it to the base url
#'
#' @param endpoint an API endpoint without leading and trailing slashes
build_endpoint_url <- function(endpoint) {
  assertive::assert_is_character(endpoint)
  api_version <- getOption("rbinotel.api_version")
  api_base_url <- getOption("rbinotel.api_base_url")
  endpoint_url <- paste0(api_base_url, api_version, "/", endpoint, ".json")
  return(endpoint_url)
}

#' Add credentials to the API request
#'
#' Add key and secret to the list of parameters for request
#'
#' @param params named list of parameters
#' @param api_key client API key
#' @param api_secret client API secret
add_auth_params <- function(params, api_key = NULL, api_secret = NULL) {
  if (is.null(api_key)) api_key <- getOption("rbinotel.api_key")
  if (is.null(api_secret)) api_secret <- getOption("rbinotel.api_secret")
  signed_params <- append(params, list(key = api_key, secret = api_secret))
  return(signed_params)
}

#' Send request to Binotel API
#'
#' Send POST request with parameters and key/secret to /code{endpoint}
#'
#' @param endpoint API endpoint specific to the request
#' @param params list of parameters for request
send_api_request <- function(endpoint, params = list()) {
  url <- build_endpoint_url(endpoint)
  params <- add_auth_params(params)
  request_body <- jsonlite::toJSON(params)
  resp <- httr::POST(url, body = request_body, encode = "raw")

  # Check for errors in response

  if (httr::http_type(resp) != "application/json") {
    stop("Binotel API did not return json", call. = FALSE)
  }

  if (httr::status_code(resp) != 200) {
    stop(
      sprintf(
        "Binotel API request failed  [%s]",
        httr::status_code(resp)
      ),
      call. = FALSE
    )
  }

  parsed <- httr::content(resp, as = "parsed", simplifyVector = FALSE)

  if (parsed$status == "error") {
    stop(
      sprintf(
        "Binotel API request resulted in an error\n[Code %d] %s",
        parsed$code,
        parsed$message
      ),
      call. = FALSE
    )
  }

  # Return API response
  return(parsed)

}

# TODO: get key / secret and validate them
# TODO: control API limits
# TODO: use @importFrom