arbitrary request headers for ncurl

Author: shikokuchuo

NEWS.md

@@ -3,7 +3,7 @@
 #### New Features
 
 * New `stream()` interface exposes low-level byte stream functionality in the NNG library, intended for communicating with non-NNG endpoints, including but not limited to websocket servers.
-* `ncurl()` adds an 'async' option to perform HTTP requests asynchronously, returning immediately with a 'recvAio'. Also adds explicit arguments for HTTP method, content type and authorization headers and request data.
+* `ncurl()` adds an 'async' option to perform HTTP requests asynchronously, returning immediately with a 'recvAio'. Also adds explicit arguments for HTTP method, headers (which takes a named list or character vector) and request data.
 * New `messenger()` function implements a console-based 2-way messaging system using NNG's scalability protocols [currently experimental and undergoing early-stage testing].
 
 #### Updates

R/ncurl.R

@@ -6,9 +6,10 @@
 #'
 #' @param url the URL address.
 #' @param async [default FALSE] logical value whether to perform actions async.
-#' @param method (optional) the HTTP method.
-#' @param ctype (optional) the 'Content-type' header.
-#' @param auth (optional) the 'Authorization' header.
+#' @param method (optional) the HTTP method (defaults to 'GET' if not specified).
+#' @param headers (optional) a named list or character vector specifying the
+#'     HTTP request headers e.g. \code{list(`Content-Type` = "text/plain")} or
+#'     \code{c(Authorization = "Bearer APIKEY")}.
 #' @param data (optional) the request data to be submitted.
 #'
 #' @return Named list of 2 elements:
@@ -39,18 +40,18 @@
 #'
 #' @examples
 #' ncurl("http://httpbin.org/get")
-#' ncurl("http://httpbin.org/put", ,"PUT", "text/plain", "Bearer APIKEY", "hello world")
-#' ncurl("http://httpbin.org/post", ,"POST", "application/json", ,'{"key": "value"}')
+#' ncurl("http://httpbin.org/put", ,"PUT", list(Authorization = "Bearer APIKEY"), "hello world")
+#' ncurl("http://httpbin.org/post", ,"POST", c(`Content-Type` = "application/json"),'{"k":"v"}')
 #'
 #' @export
 #'
-ncurl <- function(url, async = FALSE, method = NULL, ctype = NULL, auth = NULL, data = NULL) {
+ncurl <- function(url, async = FALSE, method = NULL, headers = NULL, data = NULL) {
 
   data <- if (!missing(data)) writeBin(object = data, con = raw())
 
   if (missing(async) || !isTRUE(async)) {
 
-    res <- .Call(rnng_ncurl, url, method, ctype, auth, data)
+    res <- .Call(rnng_ncurl, url, method, headers, data)
     missing(res) && return(invisible())
     if (is.integer(res)) {
       logerror(res)
@@ -65,7 +66,7 @@ ncurl <- function(url, async = FALSE, method = NULL, ctype = NULL, auth = NULL,
 
   } else {
 
-    aio <- .Call(rnng_ncurl_aio, url, method, ctype, auth, data)
+    aio <- .Call(rnng_ncurl_aio, url, method, headers, data)
     is.integer(aio) && {
       logerror(aio)
       return(invisible(`class<-`(aio, "errorValue")))

README.Rmd

@@ -411,8 +411,9 @@ For advanced use, supports additional HTTP methods such as POST or PUT.
 
 ```{r ncurladv}
 
-res <- ncurl("http://httpbin.org/post", async = TRUE,
-             "POST", "application/json", "Bearer APIKEY", '{"key": "value"}')
+res <- ncurl("http://httpbin.org/post", async = TRUE, method = "POST",
+             headers = c(`Content-Type` = "application/json", Authorization = "Bearer APIKEY"),
+             data = '{"key": "value"}')
 res
 
 call_aio(res)$data

README.md

@@ -370,7 +370,7 @@ aio
 #> < recvAio >
 #>  - $data for message data
 aio$data |> str()
-#>  num [1:100000000] 1.3356 -0.0658 0.6899 -0.0952 -0.1385 ...
+#>  num [1:100000000] -1.898 0.604 0.988 0.395 -0.633 ...
 ```
 
 As `call_aio()` is blocking and will wait for completion, an alternative
@@ -407,7 +407,7 @@ sub |> recv(mode = "character", keep.raw = FALSE)
 
 pub |> send(c("other", "this other topic will not be received"), mode = "raw", echo = FALSE)
 sub |> recv(mode = "character", keep.raw = FALSE)
-#> 2022-03-31 16:21:28 [ 8 ] Try again
+#> 2022-04-02 19:46:07 [ 8 ] Try again
 
 # specify NULL to subscribe to ALL topics
 sub |> subscribe(topic = NULL)
@@ -418,7 +418,7 @@ sub |> recv("character", keep.raw = FALSE)
 sub |> unsubscribe(topic = NULL)
 pub |> send(c("newTopic", "this topic will now not be received"), mode = "raw", echo = FALSE)
 sub |> recv("character", keep.raw = FALSE)
-#> 2022-03-31 16:21:28 [ 8 ] Try again
+#> 2022-04-02 19:46:07 [ 8 ] Try again
 
 # however the topics explicitly subscribed to are still received
 pub |> send(c("examples", "this example will still be received"), mode = "raw", echo = FALSE)
@@ -474,7 +474,7 @@ aio2$data
 # after the survey expires, the second resolves into a timeout error
 Sys.sleep(0.5)
 aio2$data
-#> 2022-03-31 16:21:29 [ 5 ] Timed out
+#> 2022-04-02 19:46:08 [ 5 ] Timed out
 #> 'errorValue' int 5
 
 close(sur)
@@ -504,25 +504,26 @@ ncurl("http://httpbin.org/headers")
 #>   [1] 7b 0a 20 20 22 68 65 61 64 65 72 73 22 3a 20 7b 0a 20 20 20 20 22 48 6f 73
 #>  [26] 74 22 3a 20 22 68 74 74 70 62 69 6e 2e 6f 72 67 22 2c 20 0a 20 20 20 20 22
 #>  [51] 58 2d 41 6d 7a 6e 2d 54 72 61 63 65 2d 49 64 22 3a 20 22 52 6f 6f 74 3d 31
-#>  [76] 2d 36 32 34 35 63 36 66 39 2d 35 62 64 37 34 31 65 61 35 35 38 36 61 36 63
-#> [101] 66 30 65 34 64 36 61 61 61 22 0a 20 20 7d 0a 7d 0a
+#>  [76] 2d 36 32 34 38 39 39 66 30 2d 35 61 32 31 32 64 64 61 36 33 65 66 38 31 66
+#> [101] 31 30 64 39 39 66 62 63 30 22 0a 20 20 7d 0a 7d 0a
 #> 
 #> $data
-#> [1] "{\n  \"headers\": {\n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-6245c6f9-5bd741ea5586a6cf0e4d6aaa\"\n  }\n}\n"
+#> [1] "{\n  \"headers\": {\n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-624899f0-5a212dda63ef81f10d99fbc0\"\n  }\n}\n"
 ```
 
 For advanced use, supports additional HTTP methods such as POST or PUT.
 
 ``` r
-res <- ncurl("http://httpbin.org/post", async = TRUE,
-             "POST", "application/json", "Bearer APIKEY", '{"key": "value"}')
+res <- ncurl("http://httpbin.org/post", async = TRUE, method = "POST",
+             headers = c(`Content-Type` = "application/json", Authorization = "Bearer APIKEY"),
+             data = '{"key": "value"}')
 res
 #> < recvAio >
 #>  - $data for message data
 #>  - $raw for raw message
 
 call_aio(res)$data
-#> [1] "{\n  \"args\": {}, \n  \"data\": \"{\\\"key\\\": \\\"value\\\"}\", \n  \"files\": {}, \n  \"form\": {}, \n  \"headers\": {\n    \"Authorization\": \"Bearer APIKEY\", \n    \"Content-Length\": \"16\", \n    \"Content-Type\": \"application/json\", \n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-6245c6f9-7f1995a270c8f351194cfa3a\"\n  }, \n  \"json\": {\n    \"key\": \"value\"\n  }, \n  \"origin\": \"79.173.189.204\", \n  \"url\": \"http://httpbin.org/post\"\n}\n"
+#> [1] "{\n  \"args\": {}, \n  \"data\": \"{\\\"key\\\": \\\"value\\\"}\", \n  \"files\": {}, \n  \"form\": {}, \n  \"headers\": {\n    \"Authorization\": \"Bearer APIKEY\", \n    \"Content-Length\": \"16\", \n    \"Content-Type\": \"application/json\", \n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-624899f0-1c6f78c46ce661ac017ee613\"\n  }, \n  \"json\": {\n    \"key\": \"value\"\n  }, \n  \"origin\": \"78.145.225.121\", \n  \"url\": \"http://httpbin.org/post\"\n}\n"
 ```
 
 In this respect, it may be used as a performant and lightweight method

man/ncurl.Rd

@@ -893,7 +893,7 @@ SEXP rnng_stream_close(SEXP stream) {
 
 /* ncurl aio ---------------------------------------------------------------- */
 
-SEXP rnng_ncurl_aio(SEXP http, SEXP method, SEXP ctype, SEXP auth, SEXP data) {
+SEXP rnng_ncurl_aio(SEXP http, SEXP method, SEXP headers, SEXP data) {
 
   nng_url *url;
   nng_http_client *client;
@@ -930,25 +930,40 @@ SEXP rnng_ncurl_aio(SEXP http, SEXP method, SEXP ctype, SEXP auth, SEXP data) {
       return Rf_ScalarInteger(xc);
     }
   }
-  if (ctype != R_NilValue) {
-    const char *cty = CHAR(STRING_ELT(ctype, 0));
-    xc = nng_http_req_set_header(req, "Content-Type", cty);
-    if (xc) {
-      nng_http_req_free(req);
-      nng_http_client_free(client);
-      nng_url_free(url);
-      return Rf_ScalarInteger(xc);
-    }
-  }
-  if (auth != R_NilValue) {
-    const char *aut = CHAR(STRING_ELT(auth, 0));
-    xc = nng_http_req_set_header(req, "Authorization", aut);
-    if (xc) {
-      nng_http_req_free(req);
-      nng_http_client_free(client);
-      nng_url_free(url);
-      return Rf_ScalarInteger(xc);
+  if (headers != R_NilValue) {
+    R_xlen_t hlen = Rf_xlength(headers);
+    SEXP names = PROTECT(Rf_getAttrib(headers, R_NamesSymbol));
+    switch (TYPEOF(headers)) {
+    case STRSXP:
+      for (R_xlen_t i = 0; i < hlen; i++) {
+        const char *head = CHAR(STRING_ELT(headers, i));
+        const char *name = CHAR(STRING_ELT(names, i));
+        xc = nng_http_req_set_header(req, name, head);
+        if (xc) {
+          nng_http_req_free(req);
+          nng_http_client_free(client);
+          nng_url_free(url);
+          UNPROTECT(1);
+          return Rf_ScalarInteger(xc);
+        }
+      }
+      break;
+    case VECSXP:
+      for (R_xlen_t i = 0; i < hlen; i++) {
+        const char *head = CHAR(STRING_ELT(VECTOR_ELT(headers, i), 0));
+        const char *name = CHAR(STRING_ELT(names, i));
+        xc = nng_http_req_set_header(req, name, head);
+        if (xc) {
+          nng_http_req_free(req);
+          nng_http_client_free(client);
+          nng_url_free(url);
+          UNPROTECT(1);
+          return Rf_ScalarInteger(xc);
+        }
+      }
+      break;
     }
+    UNPROTECT(1);
   }
   if (data != R_NilValue) {
     unsigned char *dp = RAW(data);

src/aio.c

@@ -73,8 +73,8 @@ static const R_CallMethodDef CallEntries[] = {
   {"rnng_listener_set_uint64", (DL_FUNC) &rnng_listener_set_uint64, 3},
   {"rnng_listener_start", (DL_FUNC) &rnng_listener_start, 1},
   {"rnng_messenger", (DL_FUNC) &rnng_messenger, 1},
-  {"rnng_ncurl", (DL_FUNC) &rnng_ncurl, 5},
-  {"rnng_ncurl_aio", (DL_FUNC) &rnng_ncurl_aio, 5},
+  {"rnng_ncurl", (DL_FUNC) &rnng_ncurl, 4},
+  {"rnng_ncurl_aio", (DL_FUNC) &rnng_ncurl_aio, 4},
   {"rnng_protocol_open", (DL_FUNC) &rnng_protocol_open, 1},
   {"rnng_recv", (DL_FUNC) &rnng_recv, 2},
   {"rnng_recv_aio", (DL_FUNC) &rnng_recv_aio, 2},

src/init.c

@@ -64,8 +64,8 @@ extern SEXP rnng_listener_set_string(SEXP, SEXP, SEXP);
 extern SEXP rnng_listener_set_uint64(SEXP, SEXP, SEXP);
 extern SEXP rnng_listener_start(SEXP);
 extern SEXP rnng_messenger(SEXP);
-extern SEXP rnng_ncurl(SEXP, SEXP, SEXP, SEXP, SEXP);
-extern SEXP rnng_ncurl_aio(SEXP, SEXP, SEXP, SEXP, SEXP);
+extern SEXP rnng_ncurl(SEXP, SEXP, SEXP, SEXP);
+extern SEXP rnng_ncurl_aio(SEXP, SEXP, SEXP, SEXP);
 extern SEXP rnng_protocol_open(SEXP);
 extern SEXP rnng_recv(SEXP, SEXP);
 extern SEXP rnng_recv_aio(SEXP, SEXP);

src/nanonext.h

@@ -39,7 +39,7 @@ SEXP rnng_scm(void) {
 
 /* ncurl - minimalist http client ------------------------------------------- */
 
-SEXP rnng_ncurl(SEXP http, SEXP method, SEXP ctype, SEXP auth, SEXP data) {
+SEXP rnng_ncurl(SEXP http, SEXP method, SEXP headers, SEXP data) {
 
   nng_url *url;
   nng_http_client *client;
@@ -78,25 +78,40 @@ SEXP rnng_ncurl(SEXP http, SEXP method, SEXP ctype, SEXP auth, SEXP data) {
       return Rf_ScalarInteger(xc);
     }
   }
-  if (ctype != R_NilValue) {
-    const char *cty = CHAR(STRING_ELT(ctype, 0));
-    xc = nng_http_req_set_header(req, "Content-Type", cty);
-    if (xc) {
-      nng_http_req_free(req);
-      nng_http_client_free(client);
-      nng_url_free(url);
-      return Rf_ScalarInteger(xc);
-    }
-  }
-  if (auth != R_NilValue) {
-    const char *aut = CHAR(STRING_ELT(auth, 0));
-    xc = nng_http_req_set_header(req, "Authorization", aut);
-    if (xc) {
-      nng_http_req_free(req);
-      nng_http_client_free(client);
-      nng_url_free(url);
-      return Rf_ScalarInteger(xc);
+  if (headers != R_NilValue) {
+    R_xlen_t hlen = Rf_xlength(headers);
+    SEXP names = PROTECT(Rf_getAttrib(headers, R_NamesSymbol));
+    switch (TYPEOF(headers)) {
+    case STRSXP:
+      for (R_xlen_t i = 0; i < hlen; i++) {
+        const char *head = CHAR(STRING_ELT(headers, i));
+        const char *name = CHAR(STRING_ELT(names, i));
+        xc = nng_http_req_set_header(req, name, head);
+        if (xc) {
+          nng_http_req_free(req);
+          nng_http_client_free(client);
+          nng_url_free(url);
+          UNPROTECT(1);
+          return Rf_ScalarInteger(xc);
+        }
+      }
+      break;
+    case VECSXP:
+      for (R_xlen_t i = 0; i < hlen; i++) {
+        const char *head = CHAR(STRING_ELT(VECTOR_ELT(headers, i), 0));
+        const char *name = CHAR(STRING_ELT(names, i));
+        xc = nng_http_req_set_header(req, name, head);
+        if (xc) {
+          nng_http_req_free(req);
+          nng_http_client_free(client);
+          nng_url_free(url);
+          UNPROTECT(1);
+          return Rf_ScalarInteger(xc);
+        }
+      }
+      break;
     }
+    UNPROTECT(1);
   }
   if (data != R_NilValue) {
     unsigned char *dp = RAW(data);