test-bbk.R
In bbk: Client for Central Bank APIs

test_that("bbk_data input validation works", {
  # flow should be a character(1) with 5 <= nchar <= 8
  expect_error(bbk_data(1L, "abc"))
  expect_error(bbk_data(TRUE, "abc"))
  expect_error(bbk_data(NULL, "abc"))
  expect_error(bbk_data(c("a", "b"), "abc"))
  expect_error(bbk_data("a", "abc"))
  expect_error(bbk_data("abcd", "abc"))
  # key should be a character()
  expect_error(bbk_data("abcde", 1L))
  expect_error(bbk_data("abcde", TRUE))
  expect_error(bbk_data("abcde", NULL))
  # start_period should be a character(1) or NULL
  expect_error(bbk_data("abcde", "abc", start_period = 1L))
  expect_error(bbk_data("abcde", "abc", start_period = TRUE))
  expect_error(bbk_data("abcde", "abc", start_period = c("a", "b")))
  # end_period should be a character(1) or NULL
  expect_error(bbk_data("abcde", "abc", TRUE))
  expect_error(bbk_data("abcde", "abc", end_period = 1L))
  expect_error(bbk_data("abcde", "abc", end_period = c("a", "b")))
  # first_n should be a whole number or NULL
  expect_error(bbk_data("abcde", "abc", first_n = "abc"))
  expect_error(bbk_data("abcde", "abc", first_n = 1:2))
  expect_error(bbk_data("abcde", "abc", first_n = TRUE))
  expect_error(bbk_data("abcde", "abc", first_n = 1.5))
  expect_error(bbk_data("abcde", "abc", first_n = -1L))
  expect_error(bbk_data("abcde", "abc", first_n = 0L))
  # last_n should be a whole number or NULL
  expect_error(bbk_data("abcde", "abc", last_n = "abc"))
  expect_error(bbk_data("abcde", "abc", last_n = TRUE))
  expect_error(bbk_data("abcde", "abc", last_n = 1:2))
  expect_error(bbk_data("abcde", "abc", last_n = 1.5))
  expect_error(bbk_data("abcde", "abc", last_n = -1L))
  expect_error(bbk_data("abcde", "abc", last_n = 0L))
  # updated_after should be NULL, Date, POSIXct, or ISO 8601 string
  expect_error(bbk_data("abcde", "abc", updated_after = 1L))
  expect_error(bbk_data("abcde", "abc", updated_after = TRUE))
  expect_error(bbk_data("abcde", "abc", updated_after = NA))
})

test_that("bbk_data passes updated_after as preparedAfter", {
  captured = NULL
  httr2::local_mocked_responses(function(req) {
    captured <<- req
    httr2::response(200L, headers = "content-type: application/xml", body = charToRaw("<x/>"))
  })
  local_mocked_bindings(parse_bbk_data = function(xml) data.table())
  bbk_data("BBSIS", "abc", updated_after = as.Date("2024-06-01"))
  expect_match(captured$url, "preparedAfter=2024-06-01T00%3A00%3A00Z")
})

test_that("parse_bbk_data works", {
  body = xml2::read_xml(test_path("fixtures", "bbk-data.xml"))
  actual = parse_bbk_data(body)
  expect_data_table(actual, min.rows = 1L)
  expect_identical(
    unique(actual$key),
    "BBSIS.D.I.ZAR.ZI.EUR.S1311.B.A604.R10XX.R.A.A._Z._Z.A"
  )
  expect_date(actual$date)
})

test_that("parse_bbk_data scopes observations to each series", {
  body = xml2::read_xml(
    '<message:GenericData xmlns:message="m" xmlns:generic="http://generic">
      <message:DataSet>
        <generic:Series>
          <generic:SeriesKey><generic:Value id="ID" value="S1"/></generic:SeriesKey>
          <generic:Attributes><generic:Value id="BBK_TIME_FORMAT" value="P1M"/></generic:Attributes>
          <generic:Obs><generic:ObsDimension value="2020-01"/><generic:ObsValue value="1"/></generic:Obs>
          <generic:Obs><generic:ObsDimension value="2020-02"/><generic:ObsValue value="2"/></generic:Obs>
        </generic:Series>
        <generic:Series>
          <generic:SeriesKey><generic:Value id="ID" value="S2"/></generic:SeriesKey>
          <generic:Attributes><generic:Value id="BBK_TIME_FORMAT" value="P1M"/></generic:Attributes>
          <generic:Obs><generic:ObsDimension value="2020-01"/><generic:ObsValue value="9"/></generic:Obs>
        </generic:Series>
      </message:DataSet>
    </message:GenericData>'
  )
  actual = parse_bbk_data(body)
  expect_identical(actual$key, c("S1", "S1", "S2"))
  expect_identical(actual$value, c(1, 2, 9))
})

test_that("parse_bbk_data falls back to the untranslated attribute value", {
  body = xml2::read_xml(
    '<message:GenericData xmlns:message="m" xmlns:generic="http://generic">
      <message:DataSet>
        <generic:Series>
          <generic:SeriesKey><generic:Value id="ID" value="S1"/></generic:SeriesKey>
          <generic:Attributes>
            <generic:Value id="BBK_TIME_FORMAT" value="P1M"/>
            <generic:Value id="BBK_UNIT" value="DKK"/>
            <generic:Value id="BBK_UNIT_ENG"/>
            <generic:Value id="BBK_TITLE" value="Titel"/>
            <generic:Value id="BBK_TITLE_ENG" value="Title"/>
          </generic:Attributes>
          <generic:Obs><generic:ObsDimension value="2020-01"/><generic:ObsValue value="1"/></generic:Obs>
        </generic:Series>
      </message:DataSet>
    </message:GenericData>'
  )
  actual = parse_bbk_data(body)
  expect_identical(actual$unit, "DKK")
  expect_identical(actual$title, "Title")
})

test_that("extract_metadata reads the whole csv field", {
  metadata = c(
    'Comment (in english),"The ECB publishes daily rates, which are calculated at 14.15.",',
    "unit,DKK,",
    "category,,",
    "note,The bank's own rate,",
    'quoted,"He said ""hi"", then left",',
    "lonely"
  )
  expect_identical(
    extract_metadata(metadata, "^Comment \\(in english\\),"),
    "The ECB publishes daily rates, which are calculated at 14.15."
  )
  expect_identical(extract_metadata(metadata, "^unit,"), "DKK")
  expect_identical(extract_metadata(metadata, "^category,"), "")
  expect_identical(extract_metadata(metadata, "^note,"), "The bank's own rate")
  expect_identical(extract_metadata(metadata, "^quoted,"), 'He said "hi", then left')
  expect_identical(extract_metadata(metadata, "^lonely"), NA_character_)
  expect_identical(extract_metadata(metadata, "^absent,"), NA_character_)
})

test_that("parse_bbk_series works", {
  body = readRDS(test_path("fixtures", "bbk-series.rds"))
  actual = parse_bbk_series(
    body,
    "BBSIS.D.I.ZAR.ZI.EUR.S1311.B.A604.R10XX.R.A.A._Z._Z.A"
  )
  nms = c(
    "key",
    "date",
    "value",
    "title",
    "freq",
    "category",
    "unit",
    "unit_mult",
    "last_update",
    "comment",
    "source"
  )
  expect_data_table(actual, min.rows = 1L)
  expect_subset(names(actual), nms)
  expect_identical(
    unique(actual$key),
    "BBSIS.D.I.ZAR.ZI.EUR.S1311.B.A604.R10XX.R.A.A._Z._Z.A"
  )
  expect_date(actual$date)
})

test_that("parse_bbk_series detects the metadata header length", {
  body = readRDS(test_path("fixtures", "bbk-series-short-header.rds"))
  actual = parse_bbk_series(body, "BBAF3.Q.F41.S121.DE.S1.W0.LE.N._X.B")
  expect_data_table(actual, min.rows = 1L)
  expect_identical(actual$date[[1L]], as.Date("1999-01-01"))
  expect_identical(actual$value[[1L]], 4.4)
  expect_all_equal(actual$freq, "quarterly")
})

test_that("bbk_series input validation works", {
  expect_error(bbk_series(1L))
  expect_error(bbk_series(character()))
  expect_error(bbk_series(NA))
  expect_error(bbk_series())
  expect_error(bbk_series(NULL))
  expect_error(bbk_series(c("BBEX3.M.DKK.EUR.BB.AC.A01", "BBEX3.M.DKK.EUR.BB.AC.A02")))
})

test_that("bbk_dimension input validation works", {
  expect_error(bbk_dimension(1L))
  expect_error(bbk_dimension(TRUE))
  expect_error(bbk_dimension(NULL))
  expect_error(bbk_dimension(c("a", "b")))
})

test_that("metadata input validation works", {
  # type should be one of datastructure, dataflow, codelist, concept
  expect_error(bbk_metadata(1L))
  expect_error(bbk_metadata(TRUE))
  expect_error(bbk_metadata(c("datastructure", "dataflow")))
  expect_error(bbk_metadata("data"))
  # id should be a character(1) or NULL
  expect_error(bbk_metadata("datastructure", id = 1L))
  expect_error(bbk_metadata("datastructure", id = TRUE))
  expect_error(bbk_metadata("datastructure", id = c("a", "b")))
  # lang should be en or de
  expect_error(bbk_metadata(lang = "abc"))
  expect_error(bbk_metadata(lang = 1L))
  expect_error(bbk_metadata(lang = NA))
})

test_that("bbk_series does frequency conversion", {
  skip_if_offline()
  skip_on_cran()
  skip_on_ci()

  x = bbk_series("BBEX3.M.DKK.EUR.BB.AC.A01")
  expect_all_equal(x$freq, "monthly")
  x = bbk_series("BBAF3.Q.F41.S121.DE.S1.W0.LE.N._X.B")
  expect_all_equal(x$freq, "quarterly")
  x = bbk_series("BBBK11.D.TTA000")
  expect_all_equal(x$freq, "daily")
})