feat: initial support for metadata endpoints

NAMESPACE

@@ -1,2 +1,14 @@
 # Generated by roxygen2: do not edit by hand
 
+export(bb_codelist)
+export(bb_concept_scheme)
+export(bb_data_structure)
+export(bb_dataflow)
+importFrom(httr2,req_error)
+importFrom(httr2,req_headers)
+importFrom(httr2,req_perform)
+importFrom(httr2,req_url_path_append)
+importFrom(httr2,req_user_agent)
+importFrom(httr2,request)
+importFrom(httr2,resp_body_json)
+importFrom(httr2,resp_body_xml)

R/api.R

@@ -0,0 +1,69 @@
+bbundesbank <- function(flow, key) {
+  stopifnot(is.character(flow), is.character(key))
+  flow <- toupper(flow)
+  key <- toupper(key)
+
+  request("https://api.statistiken.bundesbank.de/rest/data") |>
+    req_user_agent("worldbank (https://m-muecke.github.io/worldbank)") |>
+    req_headers(Accept = "application/json") |>
+    req_url_path_append(flow, key) |>
+    req_perform() |>
+    resp_body_json()
+}
+
+bundesbank <- function(resource) {
+  request("https://api.statistiken.bundesbank.de/rest") |>
+    req_user_agent("worldbank (https://m-muecke.github.io/worldbank)") |>
+    req_url_path_append(resource) |>
+    req_error(body = \(resp) resp_body_json(resp)$title) |>
+    req_perform()
+}
+
+bb_metadata <- function(resource, id = NULL) {
+  stopifnot(is.null(id) || is.character(id) && length(id) == 1)
+  # only supports xml return format
+  resource <- "metadata/datastructure/BBK"
+  if (!is.null(id)) {
+    resource <- paste(resource, toupper(id), sep = "/")
+  }
+  res <- bundesbank(resource) |>
+    resp_body_xml()
+  res
+}
+
+#' Returns available data structures
+#'
+#' @references <https://www.bundesbank.de/en/statistics/time-series-databases/help-for-sdmx-web-service/web-service-interface-metadata> # nolint
+#' @family metadata
+#' @export
+bb_data_structure <- function(id = NULL) {
+  bb_metadata("metadata/datastructure/BBK", id)
+}
+
+#' Returns available dataflows
+#'
+#' @references <https://www.bundesbank.de/en/statistics/time-series-databases/help-for-sdmx-web-service/web-service-interface-metadata> # nolint
+#' @family metadata
+#' @export
+bb_dataflow <- function(id = NULL) {
+  bb_metadata("metadata/dataflow/BBK", id)
+}
+
+#' Returns available code lists
+#'
+#' @references <https://www.bundesbank.de/en/statistics/time-series-databases/help-for-sdmx-web-service/web-service-interface-metadata> # nolint
+#' @family metadata
+#' @export
+bb_codelist <- function(id = NULL) {
+  # TODO: check if supports json return format
+  bb_metadata("metadata/codelist/BBK", id)
+}
+
+#'
+#'
+#' @references <https://www.bundesbank.de/en/statistics/time-series-databases/help-for-sdmx-web-service/web-service-interface-metadata> # nolint
+#' @family metadata
+#' @export
+bb_concept_scheme <- function(id = NULL) {
+  bb_metadata("metadata/conceptscheme/BBK", id)
+}

R/bundesbank-package.R

@@ -0,0 +1,14 @@
+#' @keywords internal
+"_PACKAGE"
+
+## usethis namespace: start
+#' @importFrom httr2 req_error
+#' @importFrom httr2 req_headers
+#' @importFrom httr2 req_perform
+#' @importFrom httr2 req_url_path_append
+#' @importFrom httr2 req_user_agent
+#' @importFrom httr2 request
+#' @importFrom httr2 resp_body_json
+#' @importFrom httr2 resp_body_xml
+## usethis namespace: end
+NULL

README.Rmd

@@ -27,3 +27,7 @@ You can install the development version of bundesbank from [GitHub](https://gith
 # install.packages("pak")
 pak::pak("m-muecke/bundesbank")
 ```
+
+## Other Bundesbank API packages
+
+* [bundesbank](https://github.com/enricoschumann/bundesbank)

README.md

@@ -21,3 +21,7 @@ You can install the development version of bundesbank from
 # install.packages("pak")
 pak::pak("m-muecke/bundesbank")
 ```
+
+## Other Bundesbank API packages
+
+- [bundesbank](https://github.com/enricoschumann/bundesbank)