R/report.R

In byapparov/rGoodData: GoodData API Client Package

#' @import utils
#' @import data.table

library(httr)
library(data.table)

# Environment variables required:
# GOODDATA_DOMAIN - this is what goes before /gdc/ in your GoodData account
# GOODDATA_PROJECT - this is the hash of the project that can be found in the url
# GOODDATA_USER
# GOODDATA_PASSWORD


#' Loads data from GoodData
#'
#' @export
#' @param report.id identifier of the report
gdLoadReport <- function(report.id) {
  definition.id <- getLastDefinition(report.id)
  report.uri <- getReportRawUri(definition.id)
  dt <- getReportData(report.uri)
  return(dt)
}


#' Function gets uri for export of raw report data
#' @export
#'
#' @param obj integer id of the report definition, which refers to a version of a report
#' @return uri of the report results that can be uploaded with the GET request
getReportRawUri <- function(obj) {
  values = sprintf('
                  {
                    "report_req": {
                      "reportDefinition": "/gdc/md/%1$s/obj/%2$i"
                    }
                  }', Sys.getenv("GOODDATA_PROJECT"), obj)

  api.url <- paste0(Sys.getenv("GOODDATA_DOMAIN"), "/gdc/app/projects/",
                    Sys.getenv("GOODDATA_PROJECT"), "/execute/raw")


  response <- POST(url = api.url,
                   body = values,
                   content_type_json() ,
                   add_headers(Accept = "application/json",
                               "Content-Type" = "application/json",
                               "User-Agent" = getUserAgent(),
                               Cookie = authCookie()))

  c <- processResponse(response)

  uri <- paste0(Sys.getenv("GOODDATA_DOMAIN"), c$uri)
  return(uri)
}


#' Gets report results as data.table
#' @export
#'
#' @param uri url for the report resutls
#' @param wait time to wait till next get attempt if report is not ready
#' @return data.table with report
getReportData <- function(uri, wait = 5) {
  response <- GET(uri,
                  authenticate(Sys.getenv("GOODDATA_USER"), Sys.getenv("GOODDATA_PASSWORD")),
                  add_headers(Accept = "application/json",
                              "User-Agent" = getUserAgent(),
                              "Content-Type" = "application/json"))
  status <- status_code(response)
  if(status >= 200 & status < 300) {
    if(http_type(response) == "text/csv") {
      report <- content(response, "text", encoding = "UTF-8")
      report <- fread(report, encoding = "UTF-8")
    } else { # we have to retry as report data was not generated yet.
      cat("\rWaiting for report: ", wait, " sec")
      Sys.sleep(wait)
      wait <- min(wait * 2, 60)
      report <- getReportData(uri, wait)
    }
    return(report)
  } else { # error
    processResponseError(response)
  }
}

#' Gets last definition for a report object id
#' @export
#'
#' @param report.obj integer id of the report object
#' @return integer id of the latest report definitin object
getLastDefinition <- function(report.obj) {
  response <- GET(url = paste0(Sys.getenv("GOODDATA_DOMAIN"), "/gdc/md/", Sys.getenv("GOODDATA_PROJECT"), "/obj/", report.obj),
                  add_headers(Accept = "application/json",
                              "Content-Type" = "application/json",
                              "User-Agent" = getUserAgent(),
                              Cookie = authCookie()))

  c <- processResponse(response)
  last.definition <- tail(c$report$content$definitions, 1)[[1]]
  definition.obj <- tail(strsplit(last.definition, "/")[[1]], 1)
  return(as.integer(definition.obj))
}