R/list-measurements.R

In hrbrmstr/ooni: Tools to Access the Open Observatory of Network Interference ('OONI')

.process_list_measurements_results <- function(res) {

  out <- httr::content(res, as = "text", encoding = "UTF-8")

  out <-  jsonlite::fromJSON(out)

  res_df <- out$results
  res_df$measurement_start_time <- to_ooni_timestamp(res_df$measurement_start_time)
  class(res_df) <- c("tbl_df", "tbl", "data.frame")

  attr(res_df, "pagination_info") <-
    list(
      method = "ooni_list_measurements",
      count = out$metadata$count,
      current_page = out$metadata$current_page,
      limit = out$metadata$limit,
      next_url = out$metadata$next_url,
      offset = out$metadata$offset,
      pages = out$metadata$pages
    )

  res_df

}

#' List measurements
#'
#' @md
#' @param test_name the name of the measurement test. One of "`web_connectivity`",
#'        "`http_requests`", "`dns_consistency`", "`http_invalid_request_line`",
#'        "`bridge_reachability`", "`tcp_connect`", "`http_header_field_manipulation`",
#'        "`http_host`", "`multi_protocol_traceroute`", "`meek_fronted_requests_test`",
#'        "`whatsapp`", "`vanilla_tor`", "`facebook_messenger`", "`ndt`", "`dash`",
#'        "`telegram`". Defaults to "`web_connectivity`".
#' @param confirmed logical (optional); return only measurements that have confirmed network
#'        anomalies? (i.e. we found a blockpage, a middlebox was found, the IM app is blocked,
#'        etc.). Default is `TRUE` meaning return only confirmed anomalies?
#' @param report_id the report id to search measurements for
#' @param input URL or IP address to search measurements for
#' @param probe_cc two letter country code
#' @param probe_asn autonomous system number in the format "ASXXX"
#' @param since,until start/end dates of when measurements were run. A `POSIXct` object,
#'     `Date` object or character string that can be converted to one of those
#'     objects.
#' @param since_index return results only strictly greater than the provided index
#' @param order_by how the results should be ordered by. One of "`test_start_time`",
#'        "`probe_cc`", "`report_id`", "`probe_asn`", "`test_name`", "`index`",
#'        "`idx`", or "`report_no`". Default is "`test_start_time`".
#' @param ascending should the order be ascending or descending
#' @param offset offset into the paginated result set (default: `0`)
#' @param limit number of records to return (default & max are `100`)
#' @export
ooni_list_measurements <- function(test_name =
                                     c(
                                       "web_connectivity", "http_requests", "dns_consistency",
                                       "http_invalid_request_line", "bridge_reachability",
                                       "tcp_connect", "http_header_field_manipulation",
                                       "http_host", "multi_protocol_traceroute",
                                       "meek_fronted_requests_test", "whatsapp",
                                       "vanilla_tor", "facebook_messenger", "ndt",
                                       "dash","telegram"
                                     ),
                                   probe_cc = NULL,
                                   probe_asn = NULL,
                                   confirmed = TRUE,
                                   # anomaly = c(TRUE,FALSE),
                                   # failure = c(TRUE,FALSE),
                                   report_id = NULL,
                                   input = NULL,
                                   since = NULL,
                                   until = NULL,
                                   since_index = NULL,
                                   order_by = c(
                                     "test_start_time", "probe_cc", "probe_asn",
                                     "test_name", "input"
                                   ),
                                   ascending = TRUE,
                                   offset = 0L,
                                   limit = 100L) {

  match.arg(
    order_by[1],
    c("test_start_time", "probe_cc", "probe_asn", "test_name", "input")
  ) -> order_by

  match.arg(
    test_name[1],
    c(
      "web_connectivity", "http_requests", "dns_consistency", "http_invalid_request_line",
      "bridge_reachability", "tcp_connect", "http_header_field_manipulation", "http_host",
      "multi_protocol_traceroute", "meek_fronted_requests_test", "whatsapp", "vanilla_tor",
      "facebook_messenger", "ndt", "dash","telegram"
    )
  ) -> test_name

  if ((limit < 1) | (limit > 100)) limit <- 100L

  httr::GET(
    url = "https://api.ooni.io/api/v1/measurements",
    httr::content_type_json(),
    query = list(
      report_id = report_id,
      input = input,
      confirmed = tolower(as.character(confirmed)),
      probe_cc = probe_cc,
      probe_asn = probe_asn,
      test_name = test_name,
      since = to_ooni_timestamp(since),
      until = to_ooni_timestamp(until),
      since_index = since_index,
      order_by = order_by,
      order = (if (ascending[1]) "asc" else "desc"),
      offset = as.integer(offset),
      limit = as.integer(limit)
    ),
    httr::verbose()
  ) -> res

  httr::stop_for_status(res)

  .process_list_measurements_results(res)

}