R/proxy.r

In httr: Tools for Working with URLs and HTTP

#' Use a proxy to connect to the internet.
#'
#' @param url,port location of proxy
#' @param username,password login details for proxy, if needed
#' @param auth type of HTTP authentication to use. Should be one of the
#'   following: basic, digest, digest_ie, gssnegotiate, ntlm, any.
#' @family config
#' @export
#' @examples
#' # See http://www.hidemyass.com/proxy-list for a list of public proxies
#' # to test with
#' # GET("http://had.co.nz", use_proxy("64.251.21.73", 8080), verbose())
use_proxy <- function(url, port = NULL, username = NULL, password = NULL,
                      auth = "basic") {
  if (!is.null(username) || !is.null(password)) {
    proxyuserpwd <- paste0(username, ":", password)
  } else {
    proxyuserpwd <- NULL
  }

  if (!is.null(port)) stopifnot(is.numeric(port))

  config(
    proxy = url,
    proxyuserpwd = proxyuserpwd,
    proxyport = port,
    proxyauth = auth_flags(auth)
  )
}