R/gist.R

In kruny1001/pbshop: pbshop Web Application

#' Publish a list of files as a gist
#' 
#' @param gdir directory of files to post
#' @param description brief description of gist
#' @param public whether gist is public (defaults to TRUE)
#' @importFrom RCurl postForm
#' @importFrom rjson fromJSON
#' 
#' @examples
#' \dontrun{
#' gist = create_gist(gfiles, description = 'description', public = T)
#' }
post_gist_oauth <- function(gist, 
    viewer = getOption('GIST_VIEWER', 'http://pagist.github.io')){
  if (is.null(getOption('github.username'))){
    username <- readline("Please enter your github username: ")
    options(github.username = username)
  }
  if (is.null(getOption('github.password'))){
    password <- readline("Please enter your github password: ")
    options(github.password = password)
  }
  token = get_token(getOption('github.username'), getOption('github.password'))
  response = postForm(
    uri = 'https://api.github.com/gists',
    .opts = list(
      postFields = gist,
      httpheader = c('Authorization' = paste('token', token))
    )
  ) 
  html_url = fromJSON(response[1])$html_url
  message('Your gist has been published')
  message('View chart at ', paste(viewer, basename(html_url), sep = "/"))
}


#' Function that takes a list of files and creates payload for API
#'
#' @param filenames names of files to post
#' @param description brief description of gist (optional)
#' @param public whether gist is public (defaults to TRUE)
create_gist <- function(filenames, description = "", extras = NULL, public = TRUE){
  if (!is.null(extras)) filenames <- c(filenames, extras)
  files = lapply(filenames, function(file){
    x = list(content =  paste(readLines(file, warn = F), collapse = "\n"))
  })
  names(files) = basename(filenames)
  body = list(description = description, public = public, files = files)
  toJSON(body)
}

#' Get basic authorization token from Github using curl
#' 
#' Source: https://help.github.com/articles/creating-an-oauth-token-for-command-line-use
get_token <- function(username, pwd){
  require(RCurl); require(rjson)
  response = postForm(
    uri = 'https://api.github.com/authorizations',
    .opts = list(
      postFields = '{"scopes": ["user", "gist"]}',
      userpwd = paste(username, pwd, sep = ":"),
      httpauth = 1L
    )
  )
  return(fromJSON(response[1])$token)
}

post_gist <- function(gist, 
   viewer = getOption("rcharts.viewer", 'http://rcharts.github.io/viewer/?')){
  require(httr)
  credentials = get_credentials()
  response = POST(
    url = 'https://api.github.com/gists',
    body = gist,
    config = c(
      authenticate(
        getOption('github.username'), 
        getOption('github.password'), 
        type = 'basic'
      ),
      add_headers("User-Agent" = "Dummy")
    )
  )
  html_url = content(response)$html_url
  message('Your gist has been published')
  message('View chart at ', paste(viewer, basename(html_url), sep = ""))
  invisible(basename(html_url))
}

# REFACTOR: Refactor to consolidate update_gist and post_gist
update_gist <- function(gist, id,
   viewer = getOption("rcharts.viewer", 'http://rcharts.github.io/viewer/?')){
  require(httr)
  credentials = get_credentials()
  response = PATCH(
    url = sprintf('https://api.github.com/gists/%s', id),
    body = gist,
    config = c(
      authenticate(
        getOption('github.username'), 
        getOption('github.password'), 
        type = 'basic'
      ),
      add_headers("User-Agent" = "Dummy")
    )
  )
  html_url = content(response)$html_url
  message('Your gist has been updated')
  message('View chart at ', paste(viewer, basename(html_url), sep = ""))
  invisible(basename(html_url))
}

get_credentials = function(){
  if (is.null(getOption('github.username'))){
    username <- readline("Please enter your github username: ")
    options(github.username = username)
  }
  if (is.null(getOption('github.password'))){
    password <- readline("Please enter your github password: ")
    options(github.password = password)
  }
}