R/connect_enedis.R

In achey2016/rlinky: R Linky data fetcher

#' access_enedis
#' 
#' Access Enedis website and check we can reach it.
#' 
#' Accède au site d'Enedis et vérifie qu'on peut l'atteindre.
#'
#' @param url Enedis URL for login
#' It defaults to \url{"https://espace-client-connexion.enedis.fr/auth/UI/Login"}
#' but other values may be useful for unit tests
#' @param realm passed as a query to enedis website. 
#' Only tested with "particuliers"
#' @param goto passed as a query to enedis website. 
#' Usually \url{"https://espace-client-particuliers.enedis.fr/group/espace-particuliers/accueil"}
#'
#' @return the result of httr::GET query
#' @importFrom httr GET
#' @importFrom httr status_code
#' @importFrom httr http_status
#' 
#' @export
#' @seealso \code{\link{connect_enedis}}, \code{\link{disconnect_enedis}}
#'
#' @examples
#' access_enedis()
access_enedis <- function(url,
                          realm = "particuliers",
                          goto) {
  if (missing(url)) {
    url <- rlinky::enedis_url;
  }
  if (missing(goto)) {
    goto <- rlinky::enedis_accueil;
  }
  # Get Enedis Home Page
  r2 <- GET(url = url,
            query = list(realm = realm,
                         goto = goto))
  # The status code should be 200 (HTTP_OK) or at least < 300
  if (status_code(r2) >= 300) {
    stop(paste(url,
               "reports HTTP error",
               status_code(r2),
               " : ",
               http_status(r2)$message,
               "\n"))
  }
  return(r2)
}

#' connect_enedis
#' 
#' Connects to Enedis website. This function searches identifier and password in a "secretfile" in json format.
#' Connection au site d'enedis. Cette fonction suppose au prealable d'avoir cree
#' un fichier "secretfile" au format json qui contient ses identifiants. 
#' 
#' The secretfile should look like:
#' Le fichier secretfile peut contenir quelque chose comme :
#' 
#' \preformatted{
#' \{   
#'   "IDToken1": ["mon.mail@connu.d.enedis"],   
#'   "IDToken2": ["mon.mot.de.passe.pour.enedis"]   
#' \}   
#' }
#' 
#' @param url defaults to "https://espace-client-connexion.enedis.fr/auth/UI/Login"
#' @param realm defaults to "particuliers"
#' @param goto defaults to "https://espace-client-particuliers.enedis.fr/group/espace-particuliers/accueil"
#' @param secretfile path to your secretfile in json format. chemin d'accès à secretfile.
#'
#' @return the result of httr::GET or httr::POST query
#' 
#' @importFrom httr POST
#' @importFrom httr content
#' @importFrom jsonlite fromJSON
#' @importFrom xml2 xml_attr
#' @importFrom xml2 xml_find_all
#' 
#' @export
#' @seealso \code{\link{disconnect_enedis}}
#' @seealso \code{\link{query_daily_month}}
#' 
#' @examples
#' connect_enedis(secretfile = "~/.secret_enedis_json")
#' disconnect_enedis()
connect_enedis <- function(url,
  realm = "particuliers",
  goto,
  secretfile = "~/.secret_enedis_json") {
  if (missing(url)) {
    url <- rlinky::enedis_url;
  }
  if (missing(goto)) {
    goto <- rlinky::enedis_accueil;
  }
  # 1) Read Enedis home page
  r2 <- access_enedis(url, realm, goto)
  # 2) If we are still connected, skip the login steps
  if (!grepl("MODE CONNECTE", content(r2, "text", "text"))) {
    # 3) Fetch login form content
    login_form2 <- xml_find_all(content(r2), ".//form[@name='Login']")
    if (length(login_form2) != 1) {
      stop("No login form found")
    }
    # 4) Take all input fields in this form but the submit button
    input2 <- xml_find_all(login_form2, ".//input[@type!='submit']")
    # 5) Save input values in a list
    list2 <- as.list(xml_attr(input2, "value"))
    names(list2) <- xml_attr(input2, "name")

    # 6) Read the secretfile to fill identifier and password
    infos_connect <- fromJSON(file(secretfile))
    list2$IDToken1 <- infos_connect$IDToken1
    list2$IDToken2 <- infos_connect$IDToken2

    # 7) Post the filled in form to connect
    r3 <- POST(url = url,
               body = list2,
               encode = "form")
    if (!grepl("Suivre ma consommation", content(r3, "text"))) {
      warning("Unexpected connection failure")
    }
  } else {
    message("Already connected\n")
    r3 <- r2;
  }
  return(r3)
}

#' disconnect_enedis
#' 
#' Disconnect from enedis website
#'
#' @param url Enedis url used to log in
#' @param url_logout Enedis url to be fetched for logout
#'
#' @return the result of httr::GET query
#' @importFrom httr GET
#' @importFrom httr handle_find
#' @export
#' @seealso \code{\link{connect_enedis}}
#' @examples
#' connect_enedis()
#' disconnect_enedis()
disconnect_enedis <- function(url, url_logout) {
  if (missing(url)) {
    url <- rlinky::enedis_url;
  }
  if (missing(url_logout)) {
    url_logout <- rlinky::enedis_url_logout;
  }
  r5 <- GET(url = url_logout,
            handle = handle_find(url))
  return(r5)
}