R/user_delete_folder.r

In ropensci/RMendeley: Interface to Mendeley API methods

#' deleteFolder - Delete a existing folder from your Mendeley library.
#'
#'<longer description>
#'@param mc OAuth object of class MendeleyCredentials
#'@param  name name of folder to be removed
#'@param curl If using in a loop, call getCurlHandle() first and pass
#'  the returned value in here (avoids unnecessary footprint)
#' @param ... optional additional curl options (debugging tools mostly).
#'@export
#'@examples \dontrun{
#' deleteFolder(mc, 'folder_name')
#'}
#' @author Karthik Ram \email{karthik.ram@@gmail.com}
#DTL  This should take an id that is the human-readable name of the folder and then
 #  call the folders() method to get the actual ID.
 # Allow the caller to use I('id') to specify that it is the actual id.
deleteFolder <- function(mc = NULL, name = NULL, ..., curl = getCurlHandle()) {
if (!is(mc, "MendeleyCredentials"))
        stop("Invalid or missing Mendeley credentials. ?mendeley_auth for more information.",
            call. = FALSE)

if(is.null(name))
    stop("You did not specify a folder to delete", call.=FALSE)

    ffname <- name
    name <- getFolderID(mc, name, ..., curl = curl)
    u <- sprintf("http://api.mendeley.com/oapi/library/folders/%s/", name)
    result <- mc$OAuthRequest(u, method = "DELETE", ..., curl = curl)
    if (result != "") {
        return(fromJSON(result))
    } else {
        cat("Folder ", ffname, ":", name, "deleted successfully \n")
    }
}
# API: http://apidocs.mendeley.com/user-library-delete-folder