fix #117 add support for json request api

Author: sckott

NAMESPACE

@@ -66,6 +66,7 @@ export(solr_facet)
 export(solr_get)
 export(solr_group)
 export(solr_highlight)
+export(solr_json_request)
 export(solr_mlt)
 export(solr_optimize)
 export(solr_parse)

R/SolrClient.R

@@ -111,6 +111,8 @@
 #' * `all(name = NULL, params = NULL, body = NULL, callopts=list(),
 #' raw=FALSE, parsetype='df', concat=',', optimizeMaxRows = TRUE,
 #' minOptimizedRows = 50000L, ...)`
+#' * `json_request(name = NULL, body = NULL, callopts=list(), 
+#' progress = NULL)`
 #' * `get(ids, name, fl = NULL, wt = 'json', raw = FALSE, ...)`
 #' * `add(x, name, commit = TRUE, commit_within = NULL, overwrite = TRUE,
 #' boost = NULL, wt = 'json', raw = FALSE, ...)`
@@ -849,6 +851,19 @@ SolrClient <- R6::R6Class(
     },
 
 
+    # JSON request API
+    json_request = function(name = NULL, body = NULL, callopts=list(), 
+      progress = NULL) {
+
+      stopifnot(inherits(body, "list") || is.character(body))
+      solr_POST_body(
+        self$make_url(),
+        if (!is.null(name)) url_handle(name) else self$path,
+        body, list(), ctype_json(), callopts, self$proxy, 
+        progress = progress)
+    },
+
+
     # documents methods
     get = function(ids, name, fl = NULL, wt = 'json', raw = FALSE, ...) {
       if (!is.null(fl)) fl <- paste0(fl, collapse = ",")

R/solr_json_request.R

@@ -0,0 +1,43 @@
+#' @title Solr json request
+#'
+#' @description search using the JSON request API
+#'
+#' @export
+#' @param conn A solrium connection object, see [SolrClient]
+#' @param name Name of a collection or core. Or leave as \code{NULL} if not needed.
+#' @param body (list) a named list, or a valid JSON character string
+#' @param callopts Call options passed on to [crul::HttpClient]
+#' @param progress a function with logic for printing a progress
+#' bar for an HTTP request, ultimately passed down to \pkg{curl}. only supports 
+#' \code{httr::progress} for now. See the README for an example.
+#'
+#' @return JSON character string
+#' @references See <https://lucene.apache.org/solr/guide/7_6/json-request-api.html>
+#' for more information.
+#' @note SOLR v7.1 was first version to support this. See
+#' <https://issues.apache.org/jira/browse/SOLR-11244>
+#' @note POST request only, no GET request available
+#' @examples \dontrun{
+#' # Connect to a local Solr instance
+#' (conn <- SolrClient$new())
+#' 
+#' ## body as JSON 
+#' a <- conn$json_request("gettingstarted", body = '{"query":"*:*"}')
+#' jsonlite::fromJSON(a)
+#' ## body as named list
+#' b <- conn$json_request("gettingstarted", body = list(query = "*:*"))
+#' jsonlite::fromJSON(b)
+#' 
+#' ## body as JSON 
+#' a <- solr_json_request(conn, "gettingstarted", body = '{"query":"*:*"}')
+#' jsonlite::fromJSON(a)
+#' ## body as named list
+#' b <- solr_json_request(conn, "gettingstarted", body = list(query = "*:*"))
+#' jsonlite::fromJSON(b)
+#' }
+solr_json_request <- function(conn, name = NULL, body = NULL, callopts = list(),
+  progress = NULL) {
+
+  conn$json_request(name = name, body = body, callopts = callopts, 
+    progress = progress)
+}

man/SolrClient.Rd

@@ -0,0 +1,18 @@
+context("solr_json_request")
+
+test_that("solr_json_request works", {
+  skip_on_cran()
+
+  if (!collection_exists(conn, "books")) {
+    collection_create(conn, name = "books")
+  }
+
+  a <- conn$json_request("gettingstarted", body = '{"query":"*:*"}')
+  alist <- jsonlite::fromJSON(a)
+
+  expect_is(a, "character")
+  expect_match(a, "responseHeader")
+  expect_match(a, "title")
+  expect_named(alist, c("responseHeader", "response"))
+  expect_is(alist$response$docs, "data.frame")
+})