diff --git a/R/connectHost.R b/R/connectHost.R new file mode 100644 index 0000000..acb2b49 --- /dev/null +++ b/R/connectHost.R @@ -0,0 +1,23 @@ +##' Creates a server object containing the base URL of the PEcAn API server, +##' the username & password, which can be simply passed into other functions +##' to make requests to the PEcAn API. +##' Currently, there is no validation. In future, we may validate the username-password +##' pair by hitting the appropriate API endpoint +##' +##' @name connect +##' @title Creates a server object that can be passed into other functions for making requests to the PEcAn API +##' @param url Base URL of the PEcAn API Server +##' @param username Username +##' @param password Password corresponding to the username +##' @param host host corresponds to host runner machine +##' @return A server object that can be passed into other functions for making requests to the PEcAn API +##' @export +##' @examples +##' server <- connectHost(url="http://localhost:8000", username="carya", password="illinois", host="pecan.localhost") + +connectHost <- function(url, username=NULL, password=NULL, host){ + header <- add_headers(Host = host) + + res <- list(url=sub('^/|/$','',url), username=username, password=password, headers = header) + return(res) +}