fix box_delete_folder() (#200)

* bump version

* fix stray NULL-return

* return invisible(NULL) on delete-functions

* roxygenize

* add tests

* rename test-file, add token-skip

* add NEWS item

Co-authored-by: Nathan (Nate) Day <[email protected]>

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: boxr
 Type: Package
 Title: Interface for the 'Box.com API'
-Version: 0.3.5.9014
+Version: 0.3.5.9015
 Authors@R: c(
     person("Brendan", "Rocks", email = "[email protected]",
            role = c("aut")),

NEWS.md

@@ -33,6 +33,8 @@
 
 ## Bug Fixes
 
+* `box_file_delete()` and `box_folder_delete()` each now return `invisible(NULL)`. (#197)
+
 * `box_auth_service()` more resilient to bad-request failures. (#166)
 
 * `box_auth()` longer throws error if {usethis} not installed. (#168, @malcombarret)

R/boxr_auth.R

@@ -387,7 +387,7 @@ box_auth_on_attach <- function(auth_on_attach = FALSE) {
 #' @param token_text `character`, JSON text. If this is provided, 
 #'   `token_file` is ignored.
 #'
-#' @return Invisible `NULL`, called for side-effects.
+#' @return `r string_side_effects()`
 #' 
 #' @seealso \describe{
 #'   \item{[box_auth()]}{for authenticating to interactive-apps.}

R/boxr_delete_restore.R

@@ -16,15 +16,16 @@
 #' 
 #' @inheritParams box_browse
 #' @return \describe{
-#'   \item{`box_delete_file()`}{Object with S3 class [`boxr_file_reference`][boxr_S3_classes].}
+#'   \item{`box_delete_file()`}{Invisible `NULL`, called for side effects.}
 #'   \item{`box_restore_file()`}{Object with S3 class [`boxr_file_reference`][boxr_S3_classes].}
-#'   \item{`box_delete_folder()`}{Object with S3 class [`boxr_folder_reference`][boxr_S3_classes].}
+#'   \item{`box_delete_folder()`}{Invisible `NULL`, called for side effects.}
 #'   \item{`box_restore_folder()`}{Object with S3 class [`boxr_folder_reference`][boxr_S3_classes].}
 #' }
 #' 
 #' @export
 box_delete_file <- function(file_id) {
-  invisible(boxDeleteFile(file_id))
+  boxDeleteFile(file_id)
+  invisible(NULL)
 }
 
 #' @rdname box_delete_file
@@ -53,7 +54,8 @@ box_restore_file <- function(file_id) {
 #' @rdname box_delete_file
 #' @export
 box_delete_folder <- function(dir_id) {
-  add_folder_ref_class(httr::content(boxDeleteFolder(dir_id)))
+  boxDeleteFolder(dir_id)
+  invisible(NULL)
 }
 
 

tests/testthat/test_15_delete.R

@@ -0,0 +1,42 @@
+test_that("box_folder_delete() works", {
+
+  skip_if_no_token()
+
+  name_dir <- "test-folder-delete"
+
+  folder <- box_dir_create(name_dir, parent_dir_id = 0)
+
+  # check that box_delete_folder returns invisible(NULL)
+  expect_invisible(
+    expect_null(
+      box_delete_folder(folder$id)
+    )
+  )
+
+  # check that name_dir is not in box directory
+  names <- box_ls(0) %>% as.data.frame() %>% `[[`("name")
+  expect_false(name_dir %in% names)
+
+})
+
+
+test_that("box_file_delete() works", {
+
+  skip_if_no_token()
+
+  name_file <- "test-file-delete.rds"
+
+  file_upload <- box_save_rds("test", file_name = name_file, dir_id = 0)
+
+  # check that box_delete_file returns invisible(NULL)
+  expect_invisible(
+    expect_null(
+      box_delete_file(file_upload$id)
+    )
+  )
+
+  # check that name_file is not in box directory
+  names <- box_ls(0) %>% as.data.frame() %>% `[[`("name")
+  expect_false(name_file %in% names)
+
+})