Add ncurl, allow setting NANONEXT_TLS, update CI

Author: shikokuchuo

.github/workflows/check-standard.yaml

@@ -1,4 +1,4 @@
-# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
 # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
 on:
   push:
@@ -31,16 +31,17 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - uses: r-lib/actions/setup-pandoc@v1
+      - uses: r-lib/actions/setup-pandoc@v2
 
-      - uses: r-lib/actions/setup-r@v1
+      - uses: r-lib/actions/setup-r@v2
         with:
           r-version: ${{ matrix.config.r }}
           http-user-agent: ${{ matrix.config.http-user-agent }}
           use-public-rspm: true
 
-      - uses: r-lib/actions/setup-r-dependencies@v1
+      - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          extra-packages: rcmdcheck
+          extra-packages: any::rcmdcheck
+          needs: check
 
-      - uses: r-lib/actions/check-r-package@v1
+      - uses: r-lib/actions/check-r-package@v2

.github/workflows/pkgdown.yaml

@@ -1,8 +1,10 @@
-# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
 # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
 on:
   push:
     branches: [main]
+  pull_request:
+    branches: [main]
   release:
     types: [published]
   workflow_dispatch:
@@ -17,19 +19,25 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - uses: r-lib/actions/setup-pandoc@v1
+      - uses: r-lib/actions/setup-pandoc@v2
 
-      - uses: r-lib/actions/setup-r@v1
+      - uses: r-lib/actions/setup-r@v2
         with:
           use-public-rspm: true
 
-      - uses: r-lib/actions/setup-r-dependencies@v1
+      - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          extra-packages: pkgdown
+          extra-packages: any::pkgdown, local::.
           needs: website
 
       - name: Deploy package
+        if: github.event_name != 'pull_request'
         run: |
           git config --local user.name "$GITHUB_ACTOR"
           git config --local user.email "[email protected]"
           Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'
+
+      - name: Build site without deploying
+        if: github.event_name == 'pull_request'
+        run: |
+          Rscript -e 'pkgdown::build_site(preview = FALSE, install = FALSE)'

NAMESPACE

@@ -27,6 +27,7 @@ export(ctx_send_vec)
 export(dial)
 export(listen)
 export(nano)
+export(ncurl)
 export(nng_error)
 export(nng_version)
 export(recv)

NEWS.md

@@ -1,5 +1,8 @@
 # nanonext 0.1.0.9000 (under development)
 
+* Add `ncurl()` minimalistic http(s) client.
+* Allow setting the environment variable 'NANONEXT_TLS=1' prior to package installation to enable TLS where the system NNG library has been built with TLS support (using Mbed TLS).
+
 # nanonext 0.1.0
 
 * Initial release to CRAN, rOpenSci R-universe and Github.

R/utils.R

@@ -2,9 +2,16 @@
 
 #' NNG Library Version
 #'
-#' Returns the version of 'libnng' used.
+#' Returns the version of 'libnng' used and whether TLS is supported.
 #'
-#' @return A character vector.
+#' @return A character vector of length 2.
+#'
+#' @section TLS Support:
+#'
+#'     The environment variable 'NANONEXT_TLS=1' may be set, e.g. by using
+#'     \code{Sys.setenv(NANONEXT_TLS=1)}, prior to package installation to enable
+#'     TLS where the system NNG library has been built with TLS support (using
+#'     Mbed TLS). Note: this is not applicable to Windows systems.
 #'
 #' @examples
 #' nng_version()
@@ -38,3 +45,41 @@ nng_error <- function(error) {
 
 }
 
+#' ncurl
+#'
+#' nano cURL - a minimalistic http(s) client.
+#'
+#' @param http the URL/address of the resource to retrieve.
+#'
+#' @return Named list of 2 elements: 'raw' containing a raw vector of the received
+#'     resource and 'data', the raw vector converted to a character string.
+#'
+#' @details Only performs HTTP GET operations, and does not follow HTTP redirects.
+#'
+#'     The raw vector may be saved to a file using \code{\link{writeBin}} to
+#'     re-create the original resource.
+#'
+#'     The data vector is a character string allowing further parsing within R,
+#'     as HTML, JSON etc.
+#'
+#' @section TLS Support:
+#'
+#'     Connecting to secure https sites is supported if your version of the NNG
+#'     library was built with TLS support (using Mbed TLS) and the environment
+#'     variable NANONEXT_TLS=1 was set when installing the package e.g. by
+#'     \code{Sys.setenv(NANONEXT_TLS=1)}. Note: not applicable for Windows systems.
+#'
+#' @export
+#'
+ncurl <- function(http) {
+
+  res <- .Call(rnng_ncurl, http)
+  missing(res) && return(invisible())
+  if (is.integer(res)) {
+    message(res, " : ", nng_error(res))
+    return(invisible(res))
+  }
+  list(raw = res, data = rawToChar(res))
+
+}
+

configure

@@ -6,6 +6,9 @@
 # Library settings
 PKG_TEST_HEADER="<nng/nng.h>"
 PKG_LIBS="-lnng"
+if [ "$NANONEXT_TLS" ]; then
+  PKG_LIBS="$PKG_LIBS -lmbedtls -lmbedx509 -lmbedcrypto"
+fi
 PKG_CFLAGS=""
 LIB_VER="1.5.2"
 SYS_LIB=0
@@ -77,7 +80,23 @@ CFLAGS=`${R_HOME}/bin/R CMD config CFLAGS`
 echo "#include $PKG_TEST_HEADER" | ${CC} ${PKG_CFLAGS} ${CFLAGS} -E -xc - >/dev/null 2>&1
 
 if [ $? -ne 0 ]; then
-  if [ $SYS_LIB = 1 ]; then
+  if [ "$SYS_LIB" -ne 1 ]; then
+    echo "------------------------------[ NANONEXT ]------------------------------"
+    echo "Configuration failed because 'libnng' was not found."
+    echo "Automatic download and/or build also failed. Try installing:"
+    echo " * deb: libnng-dev (Debian, Ubuntu, etc.)"
+    echo " * rpm: nng-devel (Fedora, CentOS etc.)"
+    echo " * arch: https://aur.archlinux.org/nng.git (Arch from AUR)"
+    echo " * brew: nng (MacOS)"
+    echo "Alternatively:"
+    echo " * vcpkg: nng (Linux/MacOS, follow getting started instructions at"
+    echo "               https://vcpkg.io/ starting from your HOME directory)"
+    echo "If 'libnng' is already installed but in a non-standard location, you"
+    echo "may set INCLUDE_DIR and LIB_DIR manually via:"
+    echo "R CMD INSTALL --configure-vars='INCLUDE_DIR=... LIB_DIR=...'"
+    echo "-------------------------------------------------------------------------"
+    exit 1
+  else
     echo "Attempt to use system libnng failed"
     echo "Preparing to download and build library from source..."
     curl -L https://github.com/nanomsg/nng/archive/refs/tags/v$LIB_VER.tar.gz -o nng.tar.gz
@@ -118,22 +137,6 @@ if [ $? -ne 0 ]; then
       echo "-------------------------------------------------------------------------"
       exit 1
     fi
-  else
-    echo "------------------------------[ NANONEXT ]------------------------------"
-    echo "Configuration failed because 'libnng' was not found."
-    echo "Automatic download and/or build also failed. Try installing:"
-    echo " * deb: libnng-dev (Debian, Ubuntu, etc.)"
-    echo " * rpm: nng-devel (Fedora, CentOS etc.)"
-    echo " * arch: https://aur.archlinux.org/nng.git (Arch from AUR)"
-    echo " * brew: nng (MacOS)"
-    echo "Alternatively:"
-    echo " * vcpkg: nng (Linux/MacOS, follow getting started instructions at"
-    echo "               https://vcpkg.io/ starting from your HOME directory)"
-    echo "If 'libnng' is already installed but in a non-standard location, you"
-    echo "may set INCLUDE_DIR and LIB_DIR manually via:"
-    echo "R CMD INSTALL --configure-vars='INCLUDE_DIR=... LIB_DIR=...'"
-    echo "-------------------------------------------------------------------------"
-    exit 1
   fi
 fi