Add support for basic digital ocean spaces API

DESCRIPTION

@@ -23,7 +23,8 @@ Imports:
     httr (>= 1.2.0),
     jsonlite (>= 1.1),
     magrittr,
-    yaml
+    yaml,
+    aws.s3 (>= 0.3.3)
 Suggests:
     roxygen2 (>= 6.0.1),
     testthat,

NAMESPACE

@@ -19,6 +19,7 @@ S3method(as.snapshot,character)
 S3method(as.snapshot,list)
 S3method(as.snapshot,numeric)
 S3method(as.snapshot,snapshot)
+S3method(as.space,space)
 S3method(as.sshkey,character)
 S3method(as.sshkey,list)
 S3method(as.sshkey,numeric)
@@ -46,11 +47,13 @@ S3method(print,domain_record)
 S3method(print,droplet)
 S3method(print,image)
 S3method(print,snapshot)
+S3method(print,space)
 S3method(print,sshkey)
 S3method(print,tag)
 S3method(print,volume)
 S3method(print,volume_snapshot)
 S3method(summary,droplet)
+S3method(summary,space)
 export("%>%")
 export(account)
 export(action)
@@ -61,6 +64,7 @@ export(as.domain_record)
 export(as.droplet)
 export(as.image)
 export(as.snapshot)
+export(as.space)
 export(as.sshkey)
 export(as.tag)
 export(as.volume)
@@ -159,6 +163,10 @@ export(sizes)
 export(snapshot)
 export(snapshot_delete)
 export(snapshots)
+export(space_create)
+export(space_info)
+export(spaces)
+export(spaces_GET)
 export(standardise_keys)
 export(tag)
 export(tag_create)
@@ -178,6 +186,9 @@ export(volume_resize)
 export(volume_snapshot_create)
 export(volume_snapshots)
 export(volumes)
+importFrom(aws.s3,bucketlist)
+importFrom(aws.s3,get_bucket)
+importFrom(aws.s3,put_bucket)
 importFrom(httr,GET)
 importFrom(httr,HEAD)
 importFrom(httr,POST)

R/spaces.R

@@ -0,0 +1,137 @@
+spaces_base <- "nyc3.digitaloceanspaces.com"
+
+check_space_access <- function(spaces_key) {
+  tmp <- if (is.null(spaces_key)) Sys.getenv("DO_SPACES_ACCESS_KEY") else spaces_key
+  if (tmp == "") stop("Need a digital ocean spaces access key defined in your session", call. = FALSE) else tmp
+}
+
+check_space_secret <- function(spaces_secret) {
+  tmp <- if (is.null(spaces_secret)) Sys.getenv("DO_SPACES_SECRET_KEY") else spaces_secret
+  if (tmp == "") stop("Need a digital ocean spaces access key defined in your session", call. = FALSE) else tmp
+}
+
+#' @param x Object to coerce to a space
+#' @export
+#' @rdname spaces
+as.space <- function(x) UseMethod("as.space")
+#' @export
+as.space.space <- function(x) x
+
+#' @export
+print.space <- function(x, ...) {
+  cat("<space>", x$Name, "\n", sep = "")
+  cat("  Created at: ", x$CreationDate, "\n")
+}
+
+#' @export
+summary.space <- function(object, ...) {
+  space_info <- space_info(name = object$Name, ...)
+
+  # obtain total size used by space
+  size <- space_size(space_info)
+
+  # obtain number of files in space
+  n_files <- space_files(space_info)
+
+  cat("<space_detail>", object$Name, "\n", sep = "")
+  cat("  Size (GB):    ", size, "\n")
+  cat("  Files:        ", n_files, "\n", sep = "")
+  cat("  Created at:   ", object$CreationDate, "\n")
+}
+
+#' Spaces storage operations
+#'
+#' \describe{
+#'  \item{space}{List space contents}
+#'  \item{spaces}{List spaces in your digital ocean account}
+#'  \item{space_create}{Create a new space}
+#' }
+#'
+#' @param name (character) Space name.
+#' @param spaces_key (character) String containing a spaces access key. If
+#'   missing, defaults to value stored in an environment variable \code{DO_SPACES_ACCESS_KEY}.
+#' @param spaces_secret (character) String containing the secret associated
+#'   with the spaces key. If missing, defaults to value stored in an environment
+#'   variable \code{DO_SPACES_SECRET_KEY}.
+#' @param ... Additional arguments passed down to \code{\link[aws.s3]{bucketlist}},
+#'   \code{\link[aws.s3]{get_bucket}}, \code{\link[aws.s3]{put_bucket}} functions.
+
+#' @importFrom aws.s3 bucketlist
+#' @export
+#' @rdname spaces
+spaces_GET <- function(spaces_key = NULL, spaces_secret = NULL, ...) {
+
+  spaces_key <- check_space_access(spaces_key)
+  spaces_secret <- check_space_secret(spaces_secret)
+
+  res <- aws.s3::s3HTTP(verb = "GET",
+                        region = NULL,
+                        key = spaces_key,
+                        secret = spaces_secret,
+                        base_url = spaces_base,
+                        ...)
+
+  return(res)
+}
+
+#' @export
+#' @rdname spaces
+spaces <- function(spaces_key = NULL, spaces_secret = NULL, ...) {
+
+  res <- spaces_GET(spaces_key = spaces_key, spaces_secret = spaces_secret, ...)
+  spaces <- lapply(res$Buckets, structure, class = "space")
+  setNames(spaces, vapply(res$Buckets, function(x) x$Name, character(1)))
+}
+
+#' @importFrom aws.s3 get_bucket
+#' @export
+#' @rdname spaces
+space_info <- function(name, spaces_key = NULL, spaces_secret = NULL, ...) {
+  if (is.null(name)) stop("Please specify the space name")
+  spaces_key <- check_space_access(spaces_key)
+  spaces_secret <- check_space_secret(spaces_secret)
+
+  space_info <- get_bucket(name,
+                           region = NULL,
+                           check_region = FALSE,
+                           key = spaces_key,
+                           secret = spaces_secret,
+                           base_url = spaces_base,
+                           max = Inf,
+                           ...)
+
+  return(space_info)
+}
+
+space_size <- function(space_info) {
+  # grab the sizes from each file (unit is bytes)
+  sizes <- vapply(space_info, function(x) x$Size, numeric(1))
+
+  # compute total size (convert to gb)
+  sum(sizes) * 1e-09
+}
+
+space_files <- function(space_info) {
+  # remove entries with size 0 (those are nested directories)
+  length(lapply(space_info, function(x) x[x$Size > 0]))
+}
+
+#' Create a new space
+#' @importFrom aws.s3 put_bucket
+#' @export
+#' @rdname spaces
+space_create <- function(name, spaces_key = NULL, spaces_secret = NULL, ...) {
+  if (is.null(name)) stop("Please specify the space name")
+  spaces_key <- check_space_access(spaces_key)
+  spaces_secret <- check_space_secret(spaces_secret)
+
+  res <- put_bucket(name,
+             region = NULL,
+             acl = acl,
+             key = spaces_key,
+             secret = spaces_secret,
+             base_url = spaces_base,
+             ...)
+
+  if (res) message(sprintf("New space %s created successfully"))
+}

tests/testthat/test-space.R

@@ -0,0 +1,16 @@
+# tests for spaces
+context("space")
+
+test_that("fails well with no input", {
+  expect_error(space_info(), "argument \"name\" is missing")
+})
+
+test_that("key checks fail when not defined in environment", {
+  skip_on_cran()
+
+  Sys.unsetenv("DO_SPACES_ACCESS_KEY")
+  expect_error(check_space_access(spaces_key = NULL), "Need a digital ocean spaces access key defined in your session")
+
+  Sys.unsetenv("DO_SPACES_SECRET_KEY")
+  expect_error(check_space_secret(spaces_secret = NULL), "Need a digital ocean spaces access key defined in your session")
+})