add applications method to list currently deployed applications

DESCRIPTION

@@ -22,3 +22,4 @@ Collate:
     'utils.R'
     'lucid.R'
     'deployments.R'
+    'applications.R'

NAMESPACE

@@ -1,5 +1,6 @@
 export(accountInfo)
 export(accounts)
+export(applications)
 export(deploy)
 export(removeAccount)
 export(setAccountInfo)

R/accounts.R

@@ -114,3 +114,40 @@ missingAccountErrorMessage <- function(name) {
   paste("account named '", name, "' does not exist", sep="")
 }
 
+resolveAccount <- function(account) {
+
+  # get existing accounts
+  accounts <- accounts()
+  if (length(accounts) == 0)
+    stopWithNoAccount()
+
+  # if no account was specified see if we can resolve the account to a default
+  if (is.null(account)) {
+    if (length(accounts) == 1) 
+      accounts[[1]]
+    else
+      stopWithSpecifyAccount()
+  }
+  # account explicitly specified, confirm it exists
+  else {
+      if (account %in% accounts)
+        account
+      else
+        stopWithMissingAccount(account)
+  }
+}
+
+stopWithNoAccount <- function() {
+  stop(paste("You must register an account using setAccountInfo prior to",
+             "proceeding."), call. = FALSE)
+}
+
+stopWithSpecifyAccount <- function() {
+  stop(paste("Please specify the account name (there are more than one",
+             "accounts registered on this system)", call. = FALSE))
+}
+
+stopWithMissingAccount <- function(account) {
+  stop(missingAccountErrorMessage(account), call. = FALSE)
+}
+

R/applications.R

@@ -0,0 +1,51 @@
+
+#' List Deployed Applications
+#' 
+#' List all applications currently deployed to ShinyApps for a given account.
+#' @param account Account name. If a single account is registered on the 
+#' system then this parameter can be omitted.
+#' @return 
+#' Returns a data frame with the following columns:
+#' \tabular{ll}{
+#' \code{id} \tab Unique id for the application\cr
+#' \code{name} \tab Name of application \cr 
+#' \code{url} \tab URL where application can be accessed\cr
+#' \code{status} \tab Current status of application. Valid values are \code{pending},
+#' \code{deploying}, \code{running}, \code{terminating}, \code{terminated}.
+#' }
+#' @note To register an account you call the \link{setAccountInfo} function.
+#' @examples
+#' \dontrun{
+#' 
+#' # list all applications for the default account
+#' applications()
+#' 
+#' # list all applications for a specific account
+#' applications("myaccount")
+#' }
+#' @export
+applications <- function(account = NULL) {
+
+  # resolve account (use default if possible, confirm exists, etc.)
+  accountInfo <- accountInfo(resolveAccount(account))
+
+  # create lucid client and retreive applications
+  lucid <- lucidClient(accountInfo)
+  apps <- lucid$applications(accountInfo$accountId)
+
+  # convert the list into a data frame with a subset of fields
+  id <- numeric()
+  name <- character()
+  url <- character()
+  status <- character()
+  for (app in apps) {
+    id <- append(id, app$id)
+    name <- append(name, app$name)
+    url <- append(url, app$url)
+    status <- append(status, app$status)
+  }
+  data.frame(id = id,
+             name = I(name),
+             url = I(url),
+             status = status)
+}

R/deploy.R

@@ -115,10 +115,8 @@ deploymentTarget <- function(appDir, appName, account) {
 
   # read existing accounts 
   accounts <- accounts()
-  if (length(accounts) == 0) {
-    stop(paste("You must register an account using setAccountInfo prior to",
-               "deploying an application."), call. = FALSE)
-  }
+  if (length(accounts) == 0) 
+    stopWithNoAccount()
 
   # validate account if provided
   if (!is.null(account)) {
@@ -164,8 +162,7 @@ deploymentTarget <- function(appDir, appName, account) {
       if (length(accounts) == 1)
         createDeploymentTarget(appName, accounts[[1]])
       else
-        stop(paste("Please specify the account which you want to deploy the",
-                   "application to."), call. = FALSE)
+        stopWithSpecifyAccount()
     }
 
     # single existing deployment

man/applications.Rd

@@ -0,0 +1,39 @@
+\name{applications}
+\alias{applications}
+\title{List Deployed Applications}
+\usage{
+  applications(account = NULL)
+}
+\arguments{
+  \item{account}{Account name. If a single account is
+  registered on the system then this parameter can be
+  omitted.}
+}
+\value{
+  Returns a data frame with the following columns:
+  \tabular{ll}{ \code{id} \tab Unique id for the
+  application\cr \code{name} \tab Name of application \cr
+  \code{url} \tab URL where application can be accessed\cr
+  \code{status} \tab Current status of application. Valid
+  values are \code{pending}, \code{deploying},
+  \code{running}, \code{terminating}, \code{terminated}. }
+}
+\description{
+  List all applications currently deployed to ShinyApps for
+  a given account.
+}
+\note{
+  To register an account you call the \link{setAccountInfo}
+  function.
+}
+\examples{
+\dontrun{
+
+# list all applications for the default account
+applications()
+
+# list all applications for a specific account
+applications("myaccount")
+}
+}
+