fix ropensci#68 replace httr with crul - except for gist_auth that uses oauth

Author: sckott

DESCRIPTION

@@ -1,16 +1,16 @@
 Package: gistr
 Title: Work with 'GitHub' 'Gists'
 Description: Work with 'GitHub' 'gists' from 'R' (e.g., 
-    <http://en.wikipedia.org/wiki/GitHub#Gist>, 
-    <https://help.github.com/articles/about-gists/>). A 'gist'
+    <https://en.wikipedia.org/wiki/GitHub#Gist>, 
+    <https://docs.github.com/en/github/writing-on-github/creating-gists/>). A 'gist'
     is simply one or more files with code/text/images/etc. This package allows
     the user to create new 'gists', update 'gists' with new files, rename files,
     delete files, get and delete 'gists', star and 'un-star' 'gists', fork 'gists',
     open a 'gist' in your default browser, get embed code for a 'gist', list
     'gist' 'commits', and get rate limit information when 'authenticated'. Some
     requests require authentication and some do not. 'Gists' website: 
     <https://gist.github.com/>.
-Version: 0.5.0.92
+Version: 0.5.1.91
 Authors@R: c(
     person("Scott", "Chamberlain", role = c("aut", "cre"), 
         email = "myrmecocystus@gmail.com", 
@@ -27,8 +27,9 @@ VignetteBuilder: knitr
 Encoding: UTF-8
 Language: en-US
 Imports:
-    jsonlite (>= 1.4),
-    httr (>= 1.2.0),
+    jsonlite,
+    crul,
+    httr,
     magrittr,
     assertthat,
     knitr,
@@ -37,7 +38,7 @@ Imports:
 Suggests:
     git2r,
     testthat
-RoxygenNote: 7.0.2
+RoxygenNote: 7.1.1
 X-schema.org-applicationCategory: Web
 X-schema.org-keywords: http, https, API, web-services, GitHub, GitHub API, gist, gists, code, script, snippet
 X-schema.org-isPartOf: https://ropensci.org

NAMESPACE

@@ -48,18 +48,16 @@ export(update)
 export(update_files)
 importFrom(assertthat,assert_that)
 importFrom(assertthat,has_extension)
+importFrom(crul,HttpClient)
 importFrom(dplyr,as_data_frame)
 importFrom(dplyr,bind_rows)
-importFrom(httr,DELETE)
-importFrom(httr,GET)
-importFrom(httr,PATCH)
-importFrom(httr,POST)
-importFrom(httr,PUT)
 importFrom(httr,add_headers)
-importFrom(httr,content)
-importFrom(httr,stop_for_status)
-importFrom(httr,warn_for_status)
+importFrom(httr,config)
+importFrom(httr,oauth2.0_token)
+importFrom(httr,oauth_app)
+importFrom(httr,oauth_endpoints)
 importFrom(jsonlite,flatten)
+importFrom(jsonlite,fromJSON)
 importFrom(knitr,knit)
 importFrom(magrittr,"%>%")
 importFrom(rmarkdown,render)

R/commits.R

@@ -5,7 +5,7 @@
 #' @param page (integer) Page number to return.
 #' @param per_page (integer) Number of items to return per page. 
 #' Default 30. Max 100.
-#' @param ... Further named args to [httr::GET()]
+#' @param ... Further named args to [crul::verb-GET]
 #' @examples \dontrun{
 #' gists()[[1]] %>% commits()
 #' gist(id = '1f399774e9ecc9153a6f') %>% commits(per_page = 5)

R/delete.R

@@ -11,9 +11,6 @@ delete <- function(gist, ...) {
   gist <- as.gist(gist)
   res <- gist_DELETE(paste0(ghbase(), '/gists/', gist$id), 
                      auth = gist_auth(), headers = ghead(), ...)
-  stop_for_status(res)
+  res$raise_for_status()
   message('Your gist has been deleted')
 }
-
-# res <- gist_DELETE(paste0(ghbase(), '/gists/', gist$id, "/2233500e6aac91a32cb84878edfb7a619fd8c56a"), 
-#                      auth = gist_auth(), headers = ghead(), httr::verbose())

R/forks.R

@@ -5,7 +5,7 @@
 #' @param page (integer) Page number to return.
 #' @param per_page (integer) Number of items to return per page. Default 30. 
 #' Max 100.
-#' @param ... Further named args to [httr::GET()]
+#' @param ... Further named args to [crul::verb-GET]
 #' @return A list of gist class objects
 #' @examples \dontrun{
 #' gist(id='1642874') %>% forks(per_page=2)
@@ -28,19 +28,14 @@ forks <- function(gist, page=NULL, per_page=30, ...) {
 #'
 #' @export
 #' @param gist A gist object or something coerceable to a gist
-#' @param ... Further named args to \code{\link[httr]{GET}}
+#' @param ... Further named args to [crul::verb-GET]
 #' @return A gist class object
 #' @examples \dontrun{
 #' # fork a gist
-#' gists()[[1]] %>% fork()
+#' w <- gists()[[1]] %>% fork()
 #'
 #' # browse to newly forked gist
-#' gist(id='0831f3fbd83ac4d46451') %>% fork() %>% browse()
-#'
-#' # extract the last one
-#' gist(id='1642874') %>%
-#'  forks() %>%
-#'  .[length(.)]
+#' browse(w)
 #' }
 
 fork <- function(gist, ...) {

R/gist.R

@@ -47,7 +47,6 @@
 #' (bigfile <- gist(id = "b74b878fd7d9176a4c52"))
 #' ## then get the raw_url, and retrieve the file
 #' url <- bigfile$files$`plossmall.json`$raw_url
-#' # httr::GET(url)
 #' }
 
 gist <- function(id, revision = NULL, ...){

R/gist_auth.R

@@ -26,7 +26,7 @@
 gist_auth <- function(app = gistr_app, reauth = FALSE) {
 
   if (exists("auth_config", envir = cache) && !reauth) {
-    return(cache$auth_config)
+    return(undo(cache$auth_config$headers))
   }
   pat <- Sys.getenv("GITHUB_PAT", "")
   if (!identical(pat, "")) {
@@ -41,9 +41,11 @@ gist_auth <- function(app = gistr_app, reauth = FALSE) {
     auth_config <- httr::config(token = token)
   }
   cache$auth_config <- auth_config
-  auth_config
+  undo(auth_config$headers)
 }
 
+undo <- function(x) unclass(as.list(unclass(x)))
+
 cache <- new.env(parent = emptyenv())
 
 gistr_app <- httr::oauth_app(

R/gist_create.R

@@ -43,10 +43,8 @@
 #' ```
 #' '}, knit=TRUE)
 #'
-#' library('httr')
-#' url <- "https://github.com/ropensci/geojsonio/blob/master/inst/examples/zillow_or.geojson"
-#' res <- httr::GET(url)
-#' json <- httr::content(res, as = "text")
+#' url <- "https://raw.githubusercontent.com/ropensci/geojsonio/master/inst/examples/zillow_or.geojson"
+#' json <- crul::HttpClient$new(url)$get()$parse("UTF-8")
 #' gist_create(code = json, filename = "zillow_or.geojson")
 #'
 #' # Knit and include source file, so both files are in the gist

R/gist_create_git.R

@@ -248,21 +248,21 @@ unpack <- function(z) {
 }
 
 cgist <- function(description, public) {
-  res <- httr::POST(paste0(ghbase(), '/gists'), 
-                    gist_auth(), 
-                    encode = "json",
-                    body = jsonlite::toJSON(list(
-                      description = description,
-                      public = public,
-                      files = list(
-                        ".gistr" = list(
-                          content = "gistr"
-                        )
-                      )
-                    ), auto_unbox = TRUE)
+  gist_POST(
+    paste0(ghbase(), '/gists'), 
+    gist_auth(),
+    ghead(),
+    body = jsonlite::toJSON(list(
+      description = description,
+      public = public,
+      files = list(
+        ".gistr" = list(
+          content = "gistr"
+        )
+      )
+    ), auto_unbox = TRUE),
+    encode = "json"
   )
-  stopstatus(res)
-  jsonlite::fromJSON(httr::content(res, "text", encoding = "UTF-8"), FALSE)
 }
 
 all_artifacts <- function(x) {

R/gist_create_obj.R

@@ -10,7 +10,7 @@
 #' @param pretty (logical) For data.frame and matrix objects, create
 #' a markdown table. If FALSE, pushes up json. (default: `TRUE`)
 #' @param filename Name of the file to create. Default: `file.txt`
-#' @param ... Further args passed on to [httr::POST()]
+#' @param ... Further args passed on to [crul::verb-POST]
 #' @details This function is specifically for going from R objects to a gist,
 #' whereas [gist_create()] is for going from files or executing code
 #' @seealso [gist_create()], [gist_create_git()]

R/gistr-package.R

@@ -6,7 +6,7 @@
 #' There are two ways to authorise gistr to work with your GitHub account:
 #'
 #' - Generate a personal access token (PAT) at
-#'  <https://help.github.com/articles/creating-an-access-token-for-command-line-use>
+#'  <https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token>
 #'  and record it in the `GITHUB_PAT` envar.
 #' - Interactively login into your GitHub account and authorise with OAuth.
 #'
@@ -15,11 +15,11 @@
 #' @importFrom magrittr %>%
 #' @importFrom knitr knit
 #' @importFrom rmarkdown render
-#' @importFrom httr GET POST PATCH PUT DELETE content stop_for_status
-#' add_headers warn_for_status
+#' @importFrom crul HttpClient
+#' @importFrom httr add_headers oauth_endpoints oauth2.0_token config oauth_app
 #' @importFrom assertthat assert_that has_extension
 #' @importFrom dplyr bind_rows as_data_frame
-#' @importFrom jsonlite flatten
+#' @importFrom jsonlite fromJSON flatten
 #' @name gistr-package
 #' @aliases gistr
 #' @docType package

R/gists.R

@@ -33,8 +33,7 @@
 #' # Your starred gists
 #' gists('starred')
 #' # pass in curl options
-#' gists(per_page=1, config=verbose())
-#' gists(per_page=1, config=timeout(seconds = 0.5))
+#' gists(per_page=1, verbose=TRUE)
 #' }
 
 gists <- function(what='public', since=NULL, page=NULL, per_page=30, ...) {

R/rate_limit.R

@@ -1,7 +1,7 @@
 #' Get rate limit information
 #'
 #' @export
-#' @param ... Named args to [httr::GET()]
+#' @param ... Named args to [crul::verb-GET]
 #' @examples \dontrun{
 #' rate_limit()
 #' }

R/run.R

@@ -59,17 +59,17 @@ run <- function(x, filename="code.R", knitopts=list()){
   if (inherits(x, 'gist')) x %>% update_files(outpath) else outpath
 }
 
-check_files <- function(x){
+check_files <- function(x) {
   if (length(x$files) > 1) {
     stop("You can only feed one file to run()")
   } else {
     x$files[[1]]
   }
 }
 
-get_raw <- function(path, ...){
-  res <- httr::GET(path, gist_auth(), ghead(), ...)
+get_raw <- function(path, ...) {
+  res <- cVERB("get", path, gist_auth(), ghead(), ...)
+  res$raise_for_status()
   stopifnot(res$headers$`content-type` == 'text/plain; charset=utf-8')
-  warn_for_status(res)
-  httr::content(res, as = "text", encoding = "UTF-8")
+  res$parse("UTF-8")
 }

R/star.R

@@ -23,8 +23,8 @@
 
 star <- function(gist, ...){
   gist <- as.gist(gist)
-  res <- gist_PUT(url_star(gist$id), gist_auth(), ghead(), 
-                  add_headers(`Content-Length` = 0), ...)
+  res <- gist_PUT(url_star(gist$id), gist_auth(),
+    c(ghead(), list(`Content-Length` = "0")), ...)
   star_mssg(res, 'Success, gist starred!')
   gist
 }
@@ -42,16 +42,17 @@ unstar <- function(gist, ...){
 #' @rdname star
 star_check <- function(gist, ...){
   gist <- as.gist(gist)
-  res <- GET(url_star(gist$id), gist_auth(), ghead(), ...)
+  res <- cVERB("get", url_star(gist$id), gist_auth(), ghead(), ...)
   msg <- if (res$status_code == 204) TRUE else FALSE
   message(msg)
   gist
 }
 
 url_star <- function(x) sprintf('%s/gists/%s/star', ghbase(), x)
 
-star_mssg <- function(x, y) if (x$status_code == 204) message(y) else 
-  warn_for_status(x)
+star_mssg <- function(x, y) {
+  if (x$status_code == 204) message(y) else warn_status(x)
+}
 
 star_action <- function(x, y) {
   if (x$status_code == 204) {
@@ -60,3 +61,9 @@ star_action <- function(x, y) {
     x$status_code
   }
 }
+
+warn_status <- function(x) {
+  if (x$status_code < 300) return(invisible(x))
+  tmp <- x$status_http()
+  warning(sprintf("(HTTP %s) %s", tmp$status_code, tmp$message), call.=FALSE)
+}