Add test for get_submissions_metadata

[Aryllen]

This seems tricky. Need to mock the rest calls, but also in a way that allows for checking that all data (i.e. all data from all pages) is being consolidated.

synapseforms/R/get-submission-metadata.R

Lines 1 to 56 in fca1f01

	#' Get all submission metadata by state filter
	#'
	#' Get the metadata for all submissions by state filter:
	#' WAITING_FOR_SUBMISSION, SUBMITTED_WAITING_FOR_REVIEW,
	#' ACCEPTED, REJECTED.
	#'
	#' @export
	#' @param syn Synapse login object
	#' @param state_filter The filter that is desired to gather submissions by.
	#' Filters are: `WAITING_FOR_SUBMISSION`, `SUBMITTED_WAITING_FOR_REVIEW`,
	#' `ACCEPTED`, `REJECTED`. Only accepts one filter.
	#' @param group The groupID.
	#' @param all_users TRUE to get all submissions in group; FALSE to get
	#' group submissions from caller only.
	#' @return A dataframe of the submission metadata, or NULL if there are
	#' no submissions that meet the criteria.
	#' @examples
	#' \dontrun{
	#'
	#' # Note: Must have permissions to access group.
	#' # The example group will not work for most individuals.
	#'
	#' syn <- log_into_synapse()
	#'
	#' sub_meta_to_review <- get_submissions_metadata(
	#' syn = syn,
	#' group = 13
	#' )
	#'
	#' sub_meta_accepted <- get_submissions_metadata(
	#' syn = syn,
	#' state_filter = "ACCEPTED",
	#' group = 13
	#' )
	#' }
	get_submissions_metadata <- function(syn, group, all_users = TRUE,
	state_filter = "SUBMITTED_WAITING_FOR_REVIEW") { # nolint
	uri <- "https://repo-prod.prod.sagebase.org/repo/v1/form/data/list/reviewer"
	if (!all_users) {
	uri <- "https://repo-prod.prod.sagebase.org/repo/v1/form/data/list"
	}
	body <- glue::glue('{{"filterByState":["{state_filter}"],"groupId":"{group}"}}') # nolint
	response <- rest_post(syn = syn, uri = uri, body = body)
	if (length(response$page) == 0) {
	return(NULL)
	}
	metadata <- get_json_as_df(data = response$page)
	while (length(response) == 2) {
	body <- glue::glue('{{"filterByState":["{state_filter}"],"groupId":"{group}","nextPageToken":"{response$nextPageToken}"}}') # nolint
	response <- rest_post(syn = syn, uri = uri, body = body)
	temp_metadata <- get_json_as_df(data = response$page)
	metadata <- rbind(metadata, temp_metadata)
	}
	metadata
	}