tests/testthat/test-page_data.R

In ropensci/dataaimsr: AIMS Data Platform API Client

weather_doi <- data_doi("weather")
ssts_doi <- data_doi("temp_loggers")

with_mock_dir("Correct-structure-pagedata", {
  test_that("Correct structure", {
    # default to 1000 returns next_page link
    wa <- page_data(weather_doi, filters = valid_weather_filters(), api_key = null_api_key())
    # input to 300 returns next_page link
    sa <- page_data(ssts_doi, filters = valid_tlogger_filters(), api_key = null_api_key())
    # larger size makes output fit in one go
    wb <- page_data(weather_doi, filters = weather_filters_larger_size(),
                    api_key = null_api_key())
    # default to 1000 returns next_page link
    sb <- page_data(ssts_doi, filters = tlogger_filters_no_size(), api_key = null_api_key())
    # next_page works
    wa_n <- next_page_data(wa$links$next_page, api_key = null_api_key())
    sa_n <- next_page_data(sa$links$next_page, api_key = null_api_key())
    final_nrow_wa <- nrow(wa$data) + nrow(wa_n$data)
    final_nrow_sa <- nrow(sa$data) + nrow(sa_n$data)
    expect_is(wa, "list")
    expect_length(wa, 5)
    expect_true("links" %in% names(wa))
    expect_is(wa$links, "list")
    expect_identical(names(wa$links), "next_page")
    expect_is(sa, "list")
    expect_length(sa, 5)
    expect_true(all(c("cursor", "links") %in% names(sa)))
    expect_is(sa$links, "list")
    expect_identical(names(sa$links), "next_page")
    expect_is(wb, "list")
    expect_length(wb, 5)
    expect_true(
      all(
        c("metadata", "citation", "links", "cursor", "data") %in% names(wb)
      )
    )
    expect_is(sb, "list")
    expect_length(sb, 5)
    expect_true(
      all(
        c("metadata", "citation", "links", "cursor", "data") %in% names(sb)
      )
    )
    expect_is(wa_n, "list")
    expect_length(wa_n, 5)
    expect_true(
      all(
        c("metadata", "citation", "links", "cursor", "data") %in% names(wa_n)
      )
    )
    expect_is(sa_n, "list")
    expect_length(sa_n, 5)
    expect_true(
      all(
        c("metadata", "citation", "links", "cursor", "data") %in% names(sa_n)
      )
    )
    expect_true(final_nrow_sa < nrow(sb$data))
    expect_identical(final_nrow_wa, nrow(wb$data))
  })
})

with_mock_dir("Wrong-filters-pagedata", {
  test_that("Wrong filters", {
    texpect <- function(...) expect_error(expect_message(...))
    texpect(
      page_data(weather_doi, filters = invalid_weather_filters_series(), api_key = null_api_key())
    )
    texpect(expect_is(page_data(weather_doi, filters = invalid_weather_filters_dates(),
                      api_key = null_api_key()), "data.frame"))
  })
})

with_mock_dir("summary-requests-pagedata", {
  test_that("summary requests", {
    expect_error(page_data(weather_doi, api_key = null_api_key(),
                           summary = "summary-by-series"))
    expect_error(page_data(weather_doi, api_key = null_api_key(),
                           summary = "summary-by-deployment"))
    expect_message(expect_is(page_data(ssts_doi, api_key = null_api_key(),
                                       summary = "summary-by-series"),
                   "data.frame"))
    expect_message(expect_is(page_data(ssts_doi, api_key = null_api_key(),
                                       summary = "summary-by-deployment"),
                   "data.frame"))
  })
})