New interal yields_successful_request() (#26)

Author: maurolepore

DESCRIPTION

@@ -19,6 +19,7 @@ Imports:
     cli,
     dplyr,
     glue,
+    httr2,
     rlang,
     tibble,
     utils

R/document_universe.R

@@ -9,7 +9,7 @@ document_universe_impl <- function(x, url_template = NULL) {
       out,
       topic = ifelse(
         .data$type == "help",
-        paste0("<a href=", glue::glue(url_template), ">", .data$topic, "</a>"),
+        to_href(url = .data$topic, template = glue::glue(url_template)),
         .data$topic
       )
     )
@@ -18,6 +18,9 @@ document_universe_impl <- function(x, url_template = NULL) {
   out
 }
 
+to_href <- function(url, template) {
+  paste0("<a href=", template, ">", url, "</a>")
+}
 
 #' Create a data frame with documentation metadata of one or more packages
 #'

R/yields_successful_request.R

@@ -0,0 +1,24 @@
+#' Does a URL yield a successful response?
+#'
+#' @param url A string.
+#'
+#' @return Logical.
+#'
+#' @examples
+#' yields_successful_request("bad")
+#' yields_successful_request("https://www.google.com/")
+#' yields_successful_request("https://www.google.com/404")
+#' @noRd
+yields_successful_request <- function(url) {
+  unlist(lapply(url, yields_successful_request_impl))
+}
+
+yields_successful_request_impl <- function(url) {
+  tryCatch(is_succesful_request(url), error = function(e) FALSE)
+}
+
+is_succesful_request <- function(url) {
+  req <- httr2::req_error(httr2::request(url), is_error = \(resp) FALSE)
+  resp <- httr2::req_perform(req)
+  identical(httr2::resp_status(resp), 200L)
+}

tests/testthat/test-yields_successful_request.R

@@ -0,0 +1,16 @@
+test_that("with a bad url returns FALSE", {
+  url <- "bad"
+  expect_equal(yields_successful_request(url), FALSE)
+})
+
+test_that("with a 404 url returns FALSE", {
+  skip_if_offline()
+  url <- "https://www.google.com/not/found"
+  expect_equal(yields_successful_request(url), FALSE)
+})
+
+test_that("with a good url returns FALSE", {
+  skip_if_offline()
+  url <- "https://www.google.com/"
+  expect_equal(yields_successful_request(url), TRUE)
+})