request fields with _id

Author: mustberuss

R/search-pv.R

@@ -346,9 +346,32 @@ search_pv <- function(query,
     return(first_res) # else we iterate through pages below
   }
 
-  unique_sort_keys <- rep("asc", length(pk))
-  names(unique_sort_keys) <- pk
-  arg_list$sort <- unique_sort_keys
+  if(is.null(fields))
+  {
+    # request the default fields returned by the first call, otherwise adding the pk below
+    # will just return that/thoses fields.
+    fields <- names(first_res$data[[1]])
+  }
+
+  # add pk here instead - pk fields not added to first_res
+  # We need pk to be in the result for all_pages to work with ease, hence adding
+  # it below
+  pk <- get_ok_pk(endpoint)
+
+  fields <- unique(c(pk, fields))
+  abbreviated_fields <- sub_grp_names_for_fields(endpoint, fields)
+  arg_list$fields <- abbreviated_fields 
+
+  required_paging_keys <- rep("asc", length(pk))
+  names(required_paging_keys) <- pk
+
+  # append required_paging_keys to user's sort if needed when supplied
+  if(is.null(sort)) {
+    arg_list$sort <- required_paging_keys
+  } else {
+    non_duplicate_keys <- setdiff(names(required_paging_keys), names(sort))
+    arg_list$sort <- c(sort, required_paging_keys[non_duplicate_keys])
+  }
 
   paged_data <- request_apply(
     first_res, method, query, base_url, arg_list, api_key, ...

tests/testthat/test-api-bugs.R

@@ -18,20 +18,21 @@ test_that("Queries returning non-utility patents page well", {
 
   all_types_res <- search_pv(only_utility_qry, all_pages = TRUE)
   expect_true(
-    nrow(all_types_res$data$patents) != all_types_res$query_results$total_hits
+    nrow(all_types_res$data$patents) == all_types_res$query_results$total_hits
   )
 })
 
-test_that("inventors.inventor and assignees.assignee aren't returned
+test_that("inventors.inventor_id and assignees.assignee_id are returned
           from patent endpoint when specified exactly", {
   skip_on_cran()
   query <- TEST_QUERIES[["patent"]]
   # Should return inventors and assignee list cols
-  wrong_res <- search_pv(
-    query, fields = c("inventors.inventor", "assignees.assignee")
+  res <- search_pv(
+    query, fields = c("inventors.inventor_id", "assignees.assignee_id")
   )
-  # ...But they don't
-  expect_equal(colnames(wrong_res$data$patents), "patent_id")
+  # ...But they do, just without the _id
+  expect_no_error(res$data$patents$inventors[[1]]$inventor)
+  expect_no_error(res$data$patents$assignees[[1]]$assignee)
 
   # Good result when not specifying nested-level fields explicitly
   good_res <- search_pv(