R/get_official.R

In daranzolin/rcicero: This package is a wrapper for the Cicero API

#' get_official
#'
#'Obtain official information from the Cicero API. Can seach by latitude and longitude coordinates and first and last name.
#'
#' @importFrom magrittr "%>%"
#' @importFrom httr stop_for_status GET content
#' @importFrom tidyjson as.tbl_json spread_values jstring enter_object
#' @importFrom dplyr select as_data_frame contains
#'
#' @param lat Latitude coordiante
#'
#' @param lon Longitude coordinate
#'
#' @param search_loc Street address
#'
#' @param first_name First name of official
#'
#' @param valid_on date for official
#'
#' @param last_name Last name of official
#'
#' @param district_type Officials from which district type?
#'
#' @return list
#'
#' @export
#'
#' @examples
#' #' get_official(lat = 40, lon = -75.1)
#' #' get_official(search_loc = "3175 Bowers Ave. Santa Clara, CA", district_type = c("STATE_LOWER", "STATE_UPPER"))
#' #' get_official(last_name = "Obama")
get_official <- function(search_loc = NULL, lat = NULL, lon = NULL, first_name = NULL, last_name = NULL,
                          valid_on = NULL,
                          district_type = c("STATE_LOWER", "STATE_UPPER",
                                           "NATIONAL_UPPER", "NATIONAL_LOWER", "NATIONAL_EXEC")) {
  if (!is.null(valid_on)) {
    valid_on <- try(as.Date(valid_on, format = "%Y-%m-%d"))
    if (class(valid_on) == "try-error" || is.na(valid_on)) {
      stop("valid_on argument must be in %Y-%m-%d format")
    }
  }
  valid_district_types <-  c("STATE_LOWER", "STATE_UPPER",
                        "NATIONAL_UPPER", "NATIONAL_LOWER", "NATIONAL_EXEC")
  district_checks <- sapply(district_type, function(x) x %in% valid_district_types)
  if (!all(district_checks)) {
    stop("district_type argument must be STATE_LOWER, STATE_UPPER, NATIONAL_UPPER, NATIONAL_LOWER, or NATIONAL_EXEC")
  }

  args <- list(
    key = check_key(),
    token = check_token(),
    user = check_user(),
    search_loc = search_loc,
    first_name = first_name,
    lat = lat,
    lon = lon,
    format = "json"
    )
  dist_args <- iter_args_list(district_type, "district_type")
  last_name <- iter_args_list(last_name, "last_name")
  args <- sc(
    c(args, last_name, dist_args)
    )

  json <- cicero_query("/official", args, "text")

  if (!is.null(search_loc)) {
    gen_info <- json %>% tidyjson::as.tbl_json() %>%
      tidyjson::enter_object("response") %>%
      tidyjson::enter_object("results") %>%
      tidyjson::enter_object("candidates") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(match_postal = tidyjson::jstring("match_postal"),
                              lat = tidyjson::jnumber("y"),
                              lon = tidyjson::jnumber("x")
                              ) %>%
      tidyjson::enter_object("officials") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(last_name = tidyjson::jstring("last_name"),
                              first_name = tidyjson::jstring("first_name"),
                              notes = tidyjson::jstring("notes"),
                              photo_url = tidyjson::jstring("photo_origin_url"),
                              party = tidyjson::jstring("party"),
                              initial_start_date = tidyjson::jstring("initial_term_start_date"),
                              current_term_start_date = tidyjson::jstring("current_term_start_date"),
                              webform_url = tidyjson::jstring("web_form_url")
                              )

    identifiers <- json %>% tidyjson::as.tbl_json() %>%
      tidyjson::enter_object("response") %>%
      tidyjson::enter_object("results") %>%
      tidyjson::enter_object("candidates") %>% tidyjson::gather_array() %>%
      tidyjson::enter_object("officials") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(last_name = tidyjson::jstring("last_name"),
                              first_name = tidyjson::jstring("first_name")
                              ) %>%
      tidyjson::enter_object("identifiers") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(identifier = tidyjson::jstring("identifier_value"),
                              identifier_type = tidyjson::jstring("identifier_type")
                              )

    district_info <- json %>% tidyjson::as.tbl_json() %>%
      tidyjson::enter_object("response") %>%
      tidyjson::enter_object("results") %>%
      tidyjson::enter_object("candidates") %>% tidyjson::gather_array() %>%
      tidyjson::enter_object("officials") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(last_name = tidyjson::jstring("last_name"),
                              first_name = tidyjson::jstring("first_name")
                              ) %>%
      tidyjson::enter_object("office") %>%
      tidyjson::enter_object("district") %>%
      tidyjson::spread_values(district_type = tidyjson::jstring("district_type"),
                              country = tidyjson::jstring("country"),
                              district_id = tidyjson::jstring("district_id"),
                              label = tidyjson::jstring("label"),
                              state = tidyjson::jstring("state"),
                              subtype = tidyjson::jstring("subtype")
                              )

    committee_info <- json %>% tidyjson::as.tbl_json() %>%
      tidyjson::enter_object("response") %>%
      tidyjson::enter_object("results") %>%
      tidyjson::enter_object("candidates") %>% tidyjson::gather_array() %>%
      tidyjson::enter_object("officials") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(last_name = tidyjson::jstring("last_name"),
                              first_name = tidyjson::jstring("first_name")
                              ) %>%
      tidyjson::enter_object("committees") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(description = tidyjson::jstring("description"),
                              comm_id = tidyjson::jstring("id")
                              )

    address_info <- json %>% tidyjson::as.tbl_json() %>%
      tidyjson::enter_object("response") %>%
      tidyjson::enter_object("results") %>%
      tidyjson::enter_object("candidates") %>% tidyjson::gather_array() %>%
      tidyjson::enter_object("officials") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(last_name = tidyjson::jstring("last_name"),
                              first_name = tidyjson::jstring("first_name")
                              ) %>%
      tidyjson::enter_object("addresses") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(postal_code = tidyjson::jstring("postal_code"),
                              phone = tidyjson::jstring("phone_1"),
                              fax = tidyjson::jstring("fax_1"),
                              city = tidyjson::jstring("city"),
                              state = tidyjson::jstring("state"),
                              address_1 = tidyjson::jstring("address_1"),
                              address_2 = tidyjson::jstring("address_2"),
                              address_3 = tidyjson::jstring("address_3")
                              )

  } else {
    gen_info <- json %>% tidyjson::as.tbl_json() %>%
      tidyjson::enter_object("response") %>%
      tidyjson::enter_object("results") %>%
      tidyjson::spread_values(match_postal = tidyjson::jstring("match_postal"),
                              lat = tidyjson::jnumber("y"),
                              lon = tidyjson::jnumber("x")
                              ) %>%
      tidyjson::enter_object("officials") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(last_name = tidyjson::jstring("last_name"),
                              first_name = tidyjson::jstring("first_name"),
                              notes = tidyjson::jstring("notes"),
                              photo_url = tidyjson::jstring("photo_origin_url"),
                              party = tidyjson::jstring("party"),
                              initial_start_date = tidyjson::jstring("initial_term_start_date"),
                              current_term_start_date = tidyjson::jstring("current_term_start_date"),
                              webform_url = tidyjson::jstring("web_form_url")
                              )

    identifiers <- json %>% tidyjson::as.tbl_json() %>%
      tidyjson::enter_object("response") %>%
      tidyjson::enter_object("results") %>%
      tidyjson::enter_object("officials") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(last_name = tidyjson::jstring("last_name"),
                              first_name = tidyjson::jstring("first_name")
                              ) %>%
      tidyjson::enter_object("identifiers") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(identifier = tidyjson::jstring("identifier_value"),
                              identifier_type = tidyjson::jstring("identifier_type")
                              )

    district_info <- json %>% tidyjson::as.tbl_json() %>%
      tidyjson::enter_object("response") %>%
      tidyjson::enter_object("results") %>%
      tidyjson::enter_object("officials") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(last_name = tidyjson::jstring("last_name"),
                              first_name = tidyjson::jstring("first_name")
                              ) %>%
      tidyjson::enter_object("office") %>%
      tidyjson::enter_object("district") %>%
      tidyjson::spread_values(district_type = tidyjson::jstring("district_type"),
                              country = tidyjson::jstring("country"),
                              district_id = tidyjson::jstring("district_id"),
                              label = tidyjson::jstring("label"),
                              state = tidyjson::jstring("state"),
                              subtype = tidyjson::jstring("subtype")
                              )

    committee_info <- json %>% tidyjson::as.tbl_json() %>%
      tidyjson::enter_object("response") %>%
      tidyjson::enter_object("results") %>%
      tidyjson::enter_object("officials") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(last_name = tidyjson::jstring("last_name"),
                              first_name = tidyjson::jstring("first_name")
                              ) %>%
      tidyjson::enter_object("committees") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(description = tidyjson::jstring("description"),
                              comm_id = tidyjson::jstring("id")
                              )

    address_info <- json %>% tidyjson::as.tbl_json() %>%
      tidyjson::enter_object("response") %>%
      tidyjson::enter_object("results") %>%
      tidyjson::enter_object("officials") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(last_name = tidyjson::jstring("last_name"),
                              first_name = tidyjson::jstring("first_name")
                              ) %>%
      tidyjson::enter_object("addresses") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(postal_code = tidyjson::jstring("postal_code"),
                              phone = tidyjson::jstring("phone_1"),
                              fax = tidyjson::jstring("fax_1"),
                              city = tidyjson::jstring("city"),
                              state = tidyjson::jstring("state"),
                              address_1 = tidyjson::jstring("address_1"),
                              address_2 = tidyjson::jstring("address_2"),
                              address_3 = tidyjson::jstring("address_3")
                              )
  }

  off_data <- list(
    gen_info = gen_info,
    identifiers = identifiers,
    committee_info = committee_info,
    address_info = address_info,
    district_info = district_info
  )
  off_data <- lapply(off_data, format_df)
  return(off_data)
}