R/validate_address_usps.R

In hansthompson/rusps: Validates US addresses using the USPS api

validate_address_usps <- function(street, city, state, username) {
  
  rmwac <- function(x) x[ !names(x) %in% "ReturnText"]
  
  nullToNA <- function(x) {
    x[sapply(x, is.null)] <- NA
    return(x)
  }
  
  all_addresses <- data.frame()
  
  scheme_host_path <- paste0("http://production.shippingapis.com/ShippingAPITest.dll?API=ZipCodeLookup&XML=<ZipCodeLookupRequest USERID=\"")
  
  host_with_start_tag <- paste0(scheme_host_path, username, "\">")
  
  endtag <- "</ZipCodeLookupRequest>"
  
  n_ids <- length(street)
  
  remainder <- n_ids %% 5
  
  groups <- floor(n_ids / 5)
  
  # request in batches of five addresses
  for(j in 0:(groups-1))  {
    
    address_ids <- c()
    
    for(i in 0:4) {
      id_number <- paste0("<Address ID=\"", i, "\">")
      
      address_part  <- paste0("<Address1></Address1><Address2>",
                              street[(i + 1) + (j * 5)], "</Address2><City>",
                              city[(i + 1) + (j * 5)], "</City><State>",
                              state[(i + 1) + (j * 5)], "</State></Address>")
      
      address_ids <- c(address_ids,  paste0(id_number, address_part))
    }
    
    body <- paste0(address_ids, collapse = "")
    
    URL <- paste0(host_with_start_tag, body, endtag, collapse = "")
    
    address_list <- xmlToList(xmlParse(URL))
    
    index.errors <- unlist(lapply(address_list, function(x) {names(x)[1]})) == "Error"
    
    address_list[index.errors] <- 
      structure(list(Address = structure(list(Address2 = NA,
                                              City = NA, State = NA, Zip5 = NA, Zip4 = NA,
                                              .attrs = structure("0", .Names = "ID")), 
                                         .Names = c("Address2","City", "State", "Zip5", "Zip4", ".attrs"))), 
                .Names = "Address")
    
    usps_addresses <- do.call(rbind, lapply(address_list, rmwac))
    
    
    usps_addresses <- as.data.frame(usps_addresses)
    
    all_addresses <- rbind(all_addresses, usps_addresses)
  }
  
  # request in individual addresses
  for(l in (n_ids - remainder + 1) : n_ids) {
    
    id_number <- paste0("<Address ID=\"", 0, "\">")
    
    address_part  <- paste0("<Address1></Address1><Address2>",
                            street[l], "</Address2><City>",
                            city[l], "</City><State>",
                            state[l], "</State></Address>")
    body <- paste0(id_number, address_part, collapse = "")
    
    URL <- paste0(host_with_start_tag, body, endtag, collapse = "")
    
    address_list <- xmlToList(xmlParse(URL))
    
    index.errors <- unlist(lapply(address_list, function(x) {names(x)[1]})) == "Error"
    
    address_list[index.errors] <- structure(list(Address = structure(list(Address2 = NA,
                                                                          City = NA, State = NA, Zip5 = NA, Zip4 = NA,
                                                                          .attrs = structure("0", .Names = "ID")),
                                                                     .Names = c("Address2",
                                                                                "City", "State", "Zip5", "Zip4", ".attrs"))), .Names = "Address")
    
    
    usps_addresses <- do.call(rbind, lapply(address_list, rmwac))
    
    usps_addresses <- as.data.frame(usps_addresses)
    
    all_addresses <- rbind(all_addresses, usps_addresses)
    
  }
  
  rownames(all_addresses) <- NULL
  return(all_addresses[,1:5])
}