R/proxy_connect.r

In lina2497/demeter_proxy: Functions for connectivity on Demeter

#' Connect through proxy with Demeter credentials hidden
#'
#' @param show_characters logical indicating whether the characters of the password whould be visible.
#' @param url  Optional: Character string for the url you are trying to get to. 
#'
#' @return Allows internet connectivity, e.g. APIs, webscraping, installing packages from github.
#' @examples
#' proxy_connect()
#' 
#' @export
#' @import getPass
#' @importFrom stringr str_split
#' @importFrom curl ie_get_proxy_for_url







#This Script will allow you to connect to API's and webscrape on demeter.

proxy_connect <-
  function(show_characters = FALSE,
           url = "http://google.com") {
    #Asks for username
    ifelse(
      show_characters,
      username <-
        readline(prompt = "Enter Username:"),
      username <- getPass::getPass(msg = "Username", noblank = T)
    )
    
    #Asks for password
    ifelse(
      show_characters,
      password <-
        readline(prompt = "Enter Password:"),
      password <- getPass::getPass(msg = "Password", noblank = T)
    )
    
    #If a URL is supplied, the proxy address is retrieved for it, otherwise it defaults to an external IP
    proxy_ip <-
      stringr::str_split(curl::ie_get_proxy_for_url(url), ";")[[1]][1]
    
    #This combines your username and password with the IP address of the proxy
    proxy_address <-
      paste0("http://", username, ":", password, "@", proxy_ip)
    
    #This creates envirnmnet variables with the proxy details allowing R to connect.
    Sys.setenv(http_proxy = proxy_address,
               https_proxy = proxy_address)
  }