sdk/R/R/Arvados.R

   1 source("./R/HttpRequest.R")
   2 source("./R/HttpParser.R")
   3
   4 #' Arvados SDK Object
   5 #'
   6 #' All Arvados logic is inside this class
   7 #'
   8 #' @field token Token represents user authentification token.
   9 #' @field host Host represents server name we wish to connect to.
  10 #' @examples arv = Arvados$new("token", "host_name")
  11 #' @export Arvados
  12 Arvados <- R6::R6Class(
  13
  14     "Arvados",
  15
  16     public = list(
  17
  18         initialize = function(auth_token = NULL, host_name = NULL)
  19         {
  20             if(!is.null(host_name))
  21                Sys.setenv(ARVADOS_API_HOST  = host_name)
  22
  23             if(!is.null(auth_token))
  24                 Sys.setenv(ARVADOS_API_TOKEN = auth_token)
  25
  26             host  <- Sys.getenv("ARVADOS_API_HOST");
  27             token <- Sys.getenv("ARVADOS_API_TOKEN");
  28
  29             if(host == "" | token == "")
  30                 stop("Please provide host name and authentification token or set ARVADOS_API_HOST and ARVADOS_API_TOKEN environmental variables.")
  31
  32             discoveryDocumentURL <- paste0("https://", host, "/discovery/v1/apis/arvados/v1/rest")
  33
  34             version <- "v1"
  35             host  <- paste0("https://", host, "/arvados/", version, "/")
  36
  37             private$http       <- HttpRequest$new()
  38             private$httpParser <- HttpParser$new()
  39             private$token      <- token
  40             private$host       <- host
  41
  42             headers <- list(Authorization = paste("OAuth2", private$token))
  43
  44             serverResponse <- private$http$GET(discoveryDocumentURL, headers)
  45
  46             discoveryDocument <- private$httpParser$parseJSONResponse(serverResponse)
  47             private$webDavHostName <- discoveryDocument$keepWebServiceUrl
  48         },
  49
  50         getToken    = function() private$token,
  51         getHostName = function() private$host,
  52
  53         #Todo(Fudo): Hardcoded credentials to WebDAV server. Remove them later
  54         getWebDavHostName = function() private$webDavHostName,
  55
  56         getCollection = function(uuid)
  57         {
  58             collectionURL <- paste0(private$host, "collections/", uuid)
  59             headers <- list(Authorization = paste("OAuth2", private$token))
  60
  61             serverResponse <- private$http$GET(collectionURL, headers)
  62
  63             collection <- private$httpParser$parseJSONResponse(serverResponse)
  64
  65             if(!is.null(collection$errors))
  66                 stop(collection$errors)
  67
  68             collection
  69         },
  70
  71         listCollections = function(filters = NULL, limit = 100, offset = 0)
  72         {
  73             collectionURL <- paste0(private$host, "collections")
  74             headers <- list(Authorization = paste("OAuth2", private$token))
  75
  76             serverResponse <- private$http$GET(collectionURL, headers, filters, limit, offset)
  77             collection <- private$httpParser$parseJSONResponse(serverResponse)
  78
  79             if(!is.null(collection$errors))
  80                 stop(collection$errors)
  81
  82             collection
  83         },
  84
  85         deleteCollection = function(uuid)
  86         {
  87             collectionURL <- paste0(private$host, "collections/", uuid)
  88             headers <- list("Authorization" = paste("OAuth2", private$token),
  89                             "Content-Type"  = "application/json")
  90
  91             serverResponse <- private$http$DELETE(collectionURL, headers)
  92
  93             collection <- private$httpParser$parseJSONResponse(serverResponse)
  94
  95             if(!is.null(collection$errors))
  96                 stop(collection$errors)
  97
  98             collection
  99         },
 100
 101         updateCollection = function(uuid, body)
 102         {
 103             collectionURL <- paste0(private$host, "collections/", uuid)
 104             headers <- list("Authorization" = paste("OAuth2", private$token),
 105                             "Content-Type"  = "application/json")
 106
 107             body <- jsonlite::toJSON(body, auto_unbox = T)
 108
 109             serverResponse <- private$http$PUT(collectionURL, headers, body)
 110
 111             collection <- private$httpParser$parseJSONResponse(serverResponse)
 112
 113             if(!is.null(collection$errors))
 114                 stop(collection$errors)
 115
 116             collection
 117         },
 118
 119         createCollection = function(body)
 120         {
 121             collectionURL <- paste0(private$host, "collections")
 122             headers <- list("Authorization" = paste("OAuth2", private$token),
 123                             "Content-Type"  = "application/json")
 124             body <- jsonlite::toJSON(body, auto_unbox = T)
 125
 126             serverResponse <- private$http$POST(collectionURL, headers, body)
 127
 128             collection <- private$httpParser$parseJSONResponse(serverResponse)
 129
 130             if(!is.null(collection$errors))
 131                 stop(collection$errors)
 132
 133             collection
 134         }
 135
 136     ),
 137
 138     private = list(
 139
 140         token          = NULL,
 141         host           = NULL,
 142         webDavHostName = NULL,
 143         http           = NULL,
 144         httpParser     = NULL
 145     ),
 146
 147     cloneable = FALSE
 148 )