R/github_utils.R

In seandavi/sars2pack: COVID-19 data resources and analysis tools

#' do an ls of a github repo
#'
#' Specify repo, path, and github reference (master, sha, etc.)
#' and get back an `ls` of that directory, including download links.
#'
#' @param repository character(1) formatted as 'user/repo_name' from Github
#' @param path character(1) The path in the repo to `ls` on
#' @param ref character(1) The github reference (tag, sha, branch) to
#'     run the ls on. Default is master.
#'
#' @return
#' A `tibble` with columns including:
#' - name
#' - path
#' - size
#' - download_url
#' - type (`file` or `dir`)
#'
#' @examples
#' ls_github('TheEconomist/covid-19-excess-deaths-tracker',
#'           'output-data/excess-deaths')
#' 
#' 
#' @export
ls_github = function(repository, path='', ref='master') {
    path = stringr::str_replace(path,'/$','')
    retry = 0
    while(retry<5) {
        res = httr::GET(sprintf('https://api.github.com/repos/%s/contents/%s?ref=%s',
                                    repository, path, ref))
        res2 = tibble::as_tibble(jsonlite::fromJSON(httr::content(res,type='text',encoding='UTF-8')))
        if('type' %in% colnames(res2)) return(res2)
        retry = retry+1
        Sys.sleep(min(4,(2^retry)-1))
    }
    stop('github access was unsuccessful')
}