Merge pull request #737 from ldecicco-USGS/main

Change custom UA to environmental variable

.github/workflows/R-CMD-check.yaml

@@ -29,6 +29,7 @@ jobs:
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
       R_KEEP_PKG_SOURCE: yes
+      CUSTOM_DR_UA: 'GitHub_CI'
 
     steps:
       - uses: actions/checkout@9a9194f87191a7e9055e3e9b95b8cfb13023bb08

.github/workflows/pkgdown.yaml

@@ -28,6 +28,7 @@ jobs:
       group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      CUSTOM_DR_UA: 'GitHub_CI'
     steps:
       - uses: actions/checkout@c0a81a463886bb75afe234e07a9fd5bb79219196
 

.github/workflows/test-coverage.yaml

@@ -11,6 +11,12 @@ name: test-coverage
 jobs:
   test-coverage:
     runs-on: macOS-latest
+
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+      CUSTOM_DR_UA: 'GitHub_CI'
+
     steps:
       - uses: actions/checkout@c0a81a463886bb75afe234e07a9fd5bb79219196
 

.gitlab-ci.yml

@@ -30,6 +30,7 @@ variables:
   BUILD_LOGS_DIR: "$CI_PROJECT_DIR/ci/logs"
   NOT_CRAN: "true"
   PAGES_OUTDIR: "$CI_PROJECT_DIR/public"
+  CUSTOM_DR_UA: "GitLab_CI"
 
 build-image:
   stage: build

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: dataRetrieval
 Type: Package
 Title: Retrieval Functions for USGS and EPA Hydrology and Water Quality Data
-Version: 2.7.17
+Version: 2.7.17.9000
 Authors@R: c(
     person("Laura", "DeCicco", role = c("aut","cre"),
             email = "[email protected]",

NEWS

@@ -1,3 +1,7 @@
+dataRetrieval 2.7.18
+===================
+* Added a way to include a custom user-agent suffix via an enviornmental variable "CUSTOM_DR_UA"
+
 dataRetrieval 2.7.17
 ===================
 * Fixed bug with server problems causing errors.

R/getWebServiceData.R

@@ -1,7 +1,8 @@
 #' Function to return data from web services
 #'
 #' This function accepts a url parameter, and returns the raw data. The function enhances
-#' \code{\link[httr]{GET}} with more informative error messages.
+#' \code{\link[httr]{GET}} with more informative error messages. To add a 
+#' custom user agent, create an environmental variable: CUSTOM_DR_UA
 #'
 #' @param obs_url character containing the url for the retrieval
 #' @param \dots information to pass to header request
@@ -137,8 +138,8 @@ default_ua <- function() {
 
   ua <- paste0(names(versions), "/", versions, collapse = " ")
 
-  if ("UA.dataRetrieval" %in% names(options)) {
-    ua <- paste0(ua, "/", options()[["UA.dataRetrieval"]])
+  if (Sys.getenv("CUSTOM_DR_UA") != "") {
+    ua <- paste0(ua, "/", Sys.getenv("CUSTOM_DR_UA"))
   }
 
   return(ua)