From 8c2a637cfbf6c250e77c03b88a3a9933acf29b74 Mon Sep 17 00:00:00 2001 From: Bryce Mecum Date: Mon, 11 Jun 2018 21:04:11 -0800 Subject: [PATCH 1/2] Remove space_create and spaces_object_delete from exports As per #140: - Remove export tags from space_create and spaces_object_delete - Add notes to the roxygen docstrings - Add `stops` with a hopefully helpful error message that the fns are not implemented yet - Re-document package --- NAMESPACE | 2 -- R/spaces.R | 7 ++++++- R/spaces_object_delete.R | 6 +++++- man/spaces.Rd | 3 ++- man/spaces_object_delete.Rd | 3 ++- 5 files changed, 15 insertions(+), 6 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index af4973a..4b73164 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -189,12 +189,10 @@ export(sizes) export(snapshot) export(snapshot_delete) export(snapshots) -export(space_create) export(spaces) export(spaces_acl_get) export(spaces_acl_put) export(spaces_object_copy) -export(spaces_object_delete) export(spaces_object_get) export(spaces_object_head) export(spaces_object_put) diff --git a/R/spaces.R b/R/spaces.R index b415e38..ec29b8f 100644 --- a/R/spaces.R +++ b/R/spaces.R @@ -151,10 +151,15 @@ space_files <- function(space_info) { } #' Create a new space +#' +#' This function is not implemented yet. A working implementation is planned in +#' future releases of this package. +#' #' @importFrom aws.s3 put_bucket -#' @export #' @rdname spaces space_create <- function(name, spaces_key = NULL, spaces_secret = NULL, ...) { + stop("This function is not implemented yet.", call. = FALSE) + if (is.null(name)) stop("Please specify the space name") spaces_key <- check_space_access(spaces_key) spaces_secret <- check_space_secret(spaces_secret) diff --git a/R/spaces_object_delete.R b/R/spaces_object_delete.R index b024a3a..22070b1 100644 --- a/R/spaces_object_delete.R +++ b/R/spaces_object_delete.R @@ -1,5 +1,8 @@ #' Delete an Object from a Space #' +#' This function is not implemented yet. A working implementation is planned in +#' future releases of this package. +#' #' @param object (character) The Object to delete #' @param space (character) The Space to delete the Object from #' @template spaces_args @@ -7,7 +10,6 @@ #' #' @return \code{TRUE} if successful, otherwise an object of class aws_error #' details if not. -#' @export #' #' @references \url{https://developers.digitalocean.com/documentation/ #' spaces/#delete-object} @@ -26,6 +28,8 @@ spaces_object_delete <- function(object, spaces_key = NULL, spaces_secret = NULL, ...) { + stop("This function is not implemented yet.", call. = FALSE) + spaces_key <- check_space_access(spaces_key) spaces_secret <- check_space_secret(spaces_secret) diff --git a/man/spaces.Rd b/man/spaces.Rd index 89ed797..116a124 100644 --- a/man/spaces.Rd +++ b/man/spaces.Rd @@ -39,7 +39,8 @@ from the \code{aws.s3} package.} \item{space_create}{Create a new space} } -Create a new space +This function is not implemented yet. A working implementation is planned in +future releases of this package. } \examples{ \dontrun{ diff --git a/man/spaces_object_delete.Rd b/man/spaces_object_delete.Rd index a52609d..45749e2 100644 --- a/man/spaces_object_delete.Rd +++ b/man/spaces_object_delete.Rd @@ -27,7 +27,8 @@ variable \code{DO_SPACES_SECRET_KEY}.} details if not. } \description{ -Delete an Object from a Space +This function is not implemented yet. A working implementation is planned in +future releases of this package. } \examples{ \dontrun{ From 6e99234bdbf2b863e7e2c8751173fb26d102d408 Mon Sep 17 00:00:00 2001 From: Bryce Mecum Date: Mon, 11 Jun 2018 21:04:24 -0800 Subject: [PATCH 2/2] Remove unneeded blank lines in some spaces functions --- R/spaces_object_copy.R | 1 - R/spaces_object_delete.R | 1 - R/spaces_object_put.R | 1 - 3 files changed, 3 deletions(-) diff --git a/R/spaces_object_copy.R b/R/spaces_object_copy.R index 7b6d9c2..ea5e742 100644 --- a/R/spaces_object_copy.R +++ b/R/spaces_object_copy.R @@ -47,5 +47,4 @@ spaces_object_copy <- function(from_object, secret = spaces_secret, base_url = spaces_base, ...) - } diff --git a/R/spaces_object_delete.R b/R/spaces_object_delete.R index 22070b1..207ea28 100644 --- a/R/spaces_object_delete.R +++ b/R/spaces_object_delete.R @@ -40,5 +40,4 @@ spaces_object_delete <- function(object, secret = spaces_secret, base_url = spaces_base, ...) - } diff --git a/R/spaces_object_put.R b/R/spaces_object_put.R index 430ab45..b012257 100644 --- a/R/spaces_object_put.R +++ b/R/spaces_object_put.R @@ -49,5 +49,4 @@ spaces_object_put <- function(file, secret = spaces_secret, base_url = spaces_base, ...) - }