documentation and test update

tests/testthat/goods_bulk/comtradeapi.un.org/bulk/v1/file/32/b07f98ee4cfb477c5b86923bbf159d48ca519ccb35c35865b3578b075fc918fb-7315b4.R

@@ -0,0 +1,134 @@
+structure(list(method = "GET", url = "https://comtradeapi.un.org/bulk/v1/file/32/b07f98ee4cfb477c5b86923bbf159d48ca519ccb35c35865b3578b075fc918fb?format=json", 
+    status_code = 200L, headers = structure(list(`Content-Length` = "187742", 
+        `Content-Type` = "application/TSV", `Request-Context` = "appId=cid-v1:9b6e1d5a-3728-46ff-b743-6d33d23e54a6", 
+        `Content-Disposition` = "attachment; filename=\"C/A/32/C_A_32_196201_S1_O.txt.gz\"; size=187742", 
+        `x-frame-options` = "deny", `X-Content-Type-Options` = "nosniff", 
+        `X-XSS-Protection` = "1;mode=block", `strict-transport-security` = "max-age=31536000;includeSubDomains", 
+        `content-security-policy` = "frame-src 'self'", `x-permitted-cross-domain-policies` = "none", 
+        `Referrer-Policy` = "no-referrer-when-downgrade", `Permissions-Policy` = "accelerometer=(), camera=(), geolocation=(), gyroscope=(), magnetometer=(), microphone=(), payment=(), usb=()", 
+        Date = "Thu, 09 May 2024 22:26:42 GMT"), class = "httr2_headers"), 
+    body = as.raw(c(0x1f, 0x8b, 0x08, 0x08, 0x56, 0xd3, 0x22, 
+    0x5f, 0x02, 0xff, 0x43, 0x5f, 0x41, 0x5f, 0x33, 0x32, 0x5f, 
+    0x31, 0x39, 0x36, 0x32, 0x30, 0x31, 0x5f, 0x53, 0x31, 0x2e, 
+    0x74, 0x78, 0x74, 0x00, 0xcc, 0xbd, 0x59, 0xaf, 0x26, 0xc9, 
+    0x91, 0x1d, 0xf8, 0x9c, 0x03, 0xcc, 0x4f, 0x99, 0x86, 0xef, 
+    0xcb, 0x23, 0x45, 0x4c, 0x0f, 0x04, 0xb4, 0xc4, 0xd1, 0x88, 
+    0x33, 0x92, 0x1e, 0x0b, 0x64, 0x35, 0x45, 0x80, 0x4d, 0x52, 
+    0xc5, 0x12, 0x84, 0xfe, 0xf7, 0xe3, 0xe1, 0xab, 0x1d, 0xbf, 
+    0x95, 0x71, 0x83, 0x7d, 0x4f, 0x7c, 0xf1, 0xb1, 0x0b, 0x7d, 
+    0xcd, 0x2d, 0x33, 0xaf, 0x9d, 0xd8, 0x7c, 0xb1, 0xe5, 0xd8, 
+    0xef, 0x7f, 0xf8, 0xf9, 0x87, 0xbf, 0xfd, 0xf8, 0xf3, 0xaf, 
+    0xff, 0xf2, 0xfb, 0x1f, 0xbf, 0xfd, 0xfc, 0xaf, 0x7f, 0xfd, 
+    0xb1, 0x0a, 0xff, 0xfc, 0xd3, 0x8f, 0xff, 0xa3, 0x0a, 0x3f, 
+    0xfd, 0xf8, 0xcf, 0xff, 0xf7, 0x8f, 0x3f, 0xfd, 0xf1, 0x2f, 
+    0xbf, 0xff, 0xf7, 0xbf, 0x3f, 0xe4, 0xff, 0xf6, 0xe3, 0x0f, 
+    0x3f, 0x1d, 0x3f, 0xff, 0xc3, 0x5f, 0xfe, 0xfc, 0xf3, 0x7f, 
+    0xff, 0xf6, 0xd7, 0xfa, 0x27, 0x65, 0xfc, 0xd7, 0xbf, 0xfc, 
+    0xf4, 0xf3, 0x8f, 0x3f, 0xb5, 0x7f, 0xf9, 0xa7, 0xbf, 0xfc, 
+    0xaf, 0x2a, 0xfc, 0xf5, 0x87, 0x9f, 0x7e, 0xfe, 0x73, 0x57, 
+    0x76, 0xd9, 0xd4, 0xc1, 0xef, 0xfe, 0xf4, 0xc3, 0xdf, 0xfe, 
+    0xf6, 0xc7, 0x7f, 0xfe, 0xe3, 0xef, 0x7e, 0xf8, 0xf9, 0x8f, 
+    0x7f, 0xf9, 0xf3, 0x7f, 0x2e, 0xbf, 0xf1, 0x77, 0xff, 0xfd, 
+    0x17, 0xfe, 0xa0, 0xaa, 0xfe, 0xf8, 0xb7, 0xdf, 0xfc, 0xf4, 
+    0xc7, 0x3f, 0xfc, 0xf1, 0xcf, 0x3f, 0xfc, 0xe9, 0xd7, 0xf0, 
+    0x87, 0xdf, 0x7e, 0xf7, 0x2f, 0xbf, 0x6f, 0xff, 0xe6, 0x7f, 
+    0xfe, 0xed, 0xe7, 0xbf, 0xfc, 0xcb, 0xdf, 0xaa, 0xfc, 0x2f, 
+    0x7f, 0x19, 0x3f, 0xdb, 0xd5, 0xfc, 0x8f, 0x9f, 0xff, 0xf5, 
+    0xff, 0xfd, 0xf3, 0x1f, 0xa7, 0x5c, 0x7e, 0xd9, 0x7f, 0xfa, 
+    0xf9, 0x5f, 0xff, 0xcf, 0xbf, 0xfd, 0xfc, 0xc7, 0x7f, 0xf9, 
+    0xe1, 0xe7, 0x1f, 0x7f, 0xff, 0xed, 0x87, 0x3f, 0xfd, 0xfc, 
+    0x9f, 0xc4, 0xdf, 0x68, 0xc3, 0xf2, 0x97, 0x7e, 0x55, 0x85, 
+    0xf5, 0xf7, 0xfe, 0xfc, 0xe3, 0xcf, 0xff, 0xe5, 0x0f, 0x3f, 
+    0x97, 0x3f, 0xf8, 0x8f, 0x55, 0x58, 0x7f, 0xf0, 0x87, 0x9f, 
+    0xfe, 0xf2, 0xb7, 0xbf, 0xb5, 0x3f, 0xfa, 0xbf, 0xba, 0xb8, 
+    0xfe, 0xf0, 0xd7, 0xff, 0xfe, 0x1f, 0xff, 0xbf, 0x1f, 0xfe, 
+    0xf4, 0x3f, 0x7f, 0xfc, 0xf6, 0x8f, 0xbf, 0xf9, 0x77, 0x4d, 
+    0xf8, 0xeb, 0x4f, 0xe5, 0x8f, 0x7e, 0xfa, 0xd7, 0x36, 0xf8, 
+    0xd3, 0x8f, 0x7f, 0xf8, 0xe1, 0x77, 0xc3, 0x48, 0xb9, 0xa0, 
+    0x7f, 0xfc, 0xd3, 0x0f, 0x7f, 0x28, 0xbf, 0xe7, 0xff, 0x69, 
+    0xb7, 0xf2, 0xf7, 0x07, 0x8c, 0x3f, 0xfc, 0xe1, 0xa7, 0xf2, 
+    0x97, 0x7e, 0xfe, 0xf1, 0x7f, 0xff, 0xdf, 0x8c, 0x52, 0xd6, 
+    0xe8, 0x1c, 0x8c, 0xd2, 0x5a, 0x19, 0xad, 0xd4, 0xb7, 0x5f, 
+    0x7f, 0xfb, 0xd5, 0xb7, 0xa6, 0x50, 0xba, 0x0a, 0xdf, 0xbc, 
+    0x69, 0x3f, 0xad, 0xf9, 0xf6, 0x1f, 0xbe, 0xa9, 0xf2, 0x7f, 
+    0xff, 0x59, 0x1f, 0xff, 0xe9, 0x6f, 0xce, 0x7c, 0xfb, 0xb5, 
+    0x52, 0x55, 0xf5, 0x7f, 0xe8, 0x6f, 0xf3, 0xff, 0xb7, 0xff, 
+    0x82, 0xd3, 0x2e, 0xa5, 0x7f, 0x28, 0xf2, 0x94, 0x54, 0xf9, 
+    0x37, 0xea, 0xab, 0x36, 0xb5, 0xb6, 0x79, 0x9a, 0x4d, 0xdf, 
+    0x4c, 0x76, 0x41, 0xfd, 0xc3, 0x82, 0xb0, 0xc6, 0xe5, 0x3f, 
+    0xaf, 0x52, 0x8e, 0x07, 0x84, 0x21, 0xb0, 0x10, 0x38, 0x81, 
+    0x20, 0x85, 0x98, 0x83, 0x40, 0xb0, 0xc6, 0xe5, 0x3f, 0xe7, 
+    0x4c, 0xae, 0x37, 0x61, 0x08, 0x2c, 0x04, 0x02, 0x80, 0xd6, 
+    0xc1, 0x78, 0x89, 0x40, 0x28, 0xca, 0x7f, 0xd9, 0xeb, 0xec, 
+    0x0f, 0x08, 0x43, 0x20, 0x41, 0xd0, 0x02, 0x82, 0xb5, 0x26, 
+    0x68, 0x81, 0x60, 0x8d, 0x2b, 0x1c, 0x95, 0xf3, 0x01, 0x60, 
+    0x08, 0x24, 0x00, 0xf2, 0x16, 0xb8, 0x72, 0x71, 0x51, 0xde, 
+    0x82, 0xa5, 0x38, 0x46, 0x2a, 0x94, 0xf7, 0xa2, 0x42, 0x18, 
+    0x12, 0x07, 0xc3, 0xc9, 0xfb, 0x7f, 0x97, 0xcd, 0x13, 0x93, 
+    0x49, 0x85, 0x18, 0xeb, 0xfb, 0x3e, 0x25, 0x86, 0x49, 0x8b, 
+    0xf7, 0xda, 0xeb, 0x60, 0x8d, 0x0d, 0x49, 0xdc, 0x6d, 0x50, 
+    0x1d, 0x8f, 0x3f, 0x86, 0x64, 0xb2, 0x3d, 0x90, 0x2c, 0x91, 
+    0x04, 0xe5, 0x6d, 0x90, 0x9c, 0x3c, 0x88, 0xfb, 0xac, 0x5a, 
+    0x93, 0xc3, 0x34, 0x1c, 0xbf, 0xe9, 0xe3, 0xd7, 0xc3, 0x6b, 
+    0x6f, 0xb5, 0x99, 0x73, 0x8f, 0x55, 0xaa, 0x4e, 0x3d, 0xed, 
+    0x27, 0xcb, 0xbe, 0x11, 0xf6, 0x6d, 0xf0, 0xaa, 0xcf, 0x29, 
+    0x0d, 0x80, 0x2b, 0xf7, 0x5f, 0xcd, 0xf9, 0xd7, 0xea, 0xd8, 
+    0x66, 0xbf, 0x21, 0xb0, 0x30, 0x48, 0x08, 0x31, 0xa5, 0x60, 
+    0x25, 0x04, 0xab, 0xc2, 0xba, 0x09, 0x36, 0xa8, 0x0e, 0xa1, 
+    0x0b, 0x24, 0x08, 0x41, 0xde, 0x06, 0xed, 0x73, 0xb0, 0x30, 
+    0x03, 0x9b, 0x18, 0x55, 0x9e, 0x0f, 0x22, 0xe6, 0x36, 0x13, 
+    0x0c, 0x81, 0x85, 0x41, 0x0b, 0x0c, 0x65, 0x89, 0xf3, 0x59, 
+    0xde, 0x06, 0x15, 0xd2, 0x9a, 0x00)), request = structure(list(
+        url = "https://comtradeapi.un.org/bulk/v1/file/32/b07f98ee4cfb477c5b86923bbf159d48ca519ccb35c35865b3578b075fc918fb?format=json", 
+        method = NULL, headers = structure(list(`Ocp-Apim-Subscription-Key` = "1556dc28c565437e92119755dd47eb86"), redact = character(0)), 
+        body = NULL, fields = list(), options = list(), policies = list(
+            error_body = function (resp) 
+            {
+                if (!is.null(httr2::resp_header(resp, "Content-Type"))) {
+                  if (stringr::str_detect(httr2::resp_header(resp, 
+                    "Content-Type"), "json")) {
+                    body <- httr2::resp_body_json(resp, simplifyVector = TRUE)
+                    message <- body$errorObject$errorMessage
+                    if (!is.null(message)) {
+                      message <- c(message)
+                    }
+                    return(message)
+                  }
+                  else if (stringr::str_detect(httr2::resp_header(resp, 
+                    "Content-Type"), "text")) {
+                    body <- httr2::resp_body_string(resp)
+                    if (stringr::str_detect(body, "Request URL Too Long")) {
+                      message <- c("You might have provided too many parameters and the URL got too long.")
+                      return(message)
+                    }
+                    else if (stringr::str_detect(body, "The resource you are looking for has been removed")) {
+                      message <- c("The original message is: ", 
+                        body, "But most likely you have exceeded the character value for the api.")
+                      return(message)
+                    }
+                  }
+                }
+            }, throttle_delay = function (req) 
+            {
+                realm <- realm %||% url_parse(req$url)$hostname
+                last <- the$throttle[[realm]]
+                if (is.null(last)) {
+                  wait <- 0
+                }
+                else {
+                  wait <- delay - (unix_time() - last)
+                }
+                sys_sleep(wait, "for throttling delay")
+                throttle_touch(realm)
+                wait
+            }, retry_max_tries = 2, retry_is_transient = function (resp) 
+            {
+                (httr2::resp_status(resp) == 403 && httr2::resp_header(resp, 
+                  "Retry-After") != "0") || (httr2::resp_status(resp) == 
+                  429 && httr2::resp_header(resp, "Retry-After") != 
+                  "0")
+            }, retry_after = function (resp) 
+            {
+                time <- as.numeric(httr2::resp_header(resp, "Retry-After"))
+                time
+            })), class = "httr2_request"), cache = new.env(parent = emptyenv())), class = "httr2_response")

tests/testthat/goods_bulk/comtradeapi.un.org/bulk/v1/get/C/A/HS-4f1d0f.json

@@ -0,0 +1,23 @@
+{
+    "elapsedTime": "0.1 secs",
+    "count": 1,
+    "data": [
+        {
+            "fileUrl": "https://comtradeapi.un.org/bulk/v1/file/32/b07f98ee4cfb477c5b86923bbf159d48ca519ccb35c35865b3578b075fc918fb",
+            "fileSize": "183.34 KB",
+            "isOriginalClassification": true,
+            "reporterCode": 32,
+            "freqCode": "A",
+            "typeCode": "C",
+            "classificationCode": "S1",
+            "refPeriodId": 196201,
+            "period": 1962,
+            "publicationDate": "2003-04-29T11:24:10Z",
+            "partitionKey": "32",
+            "rowKey": "b07f98ee4cfb477c5b86923bbf159d48ca519ccb35c35865b3578b075fc918fb",
+            "timestamp": "2024-03-10T04:54:11.8900761+00:00",
+            "eTag": "W/\"datetime'2024-03-10T04%3A54%3A11.8900761Z'\""
+        }
+    ],
+    "error": ""
+}

tests/testthat/goods_bulk_error/comtradeapi.un.org/bulk/v1/get/C/A/HS-a503f3.json

@@ -0,0 +1,8 @@
+{
+    "elapsedTime": "0.09 secs",
+    "count": 0,
+    "data": [
+
+    ],
+    "error": ""
+}

tests/testthat/test-ct_get_bulk.R

@@ -0,0 +1,55 @@
+
+httptest2::with_mock_dir("goods_bulk_error", {
+  test_that("test that error works for params that have no values", {
+    expect_error(
+      ct_get_bulk(
+        reporter = 'ARG',
+        start_date = '1920',
+        end_date = "1920"
+      ),
+      "Probably no data for this combination of parameters"
+    )
+  })
+})
+
+without_internet({
+  test_that('URL query is correctly constructed with goods',
+            {
+              expect_GET(
+                comtradr::ct_get_bulk(reporter = 'ARG',
+                                      start_date = '1962',
+                                      end_date = "1962",
+                                      verbose = T)
+                ,'https://comtradeapi.un.org/bulk/v1/get/C/A/HS?reporterCode=32&period=1962') # nolint
+            })
+})
+
+httptest2::with_mock_dir("goods_bulk",{
+  test_that("We can get goods data", {
+    expect_s3_class(comtradr::ct_get_bulk(reporter = 'ARG',
+                                          start_date = '1962',
+                                          end_date = "1962",
+                                          verbose = T), 'data.frame')
+  })
+})
+
+httptest2::with_mock_dir("goods_bulk", {
+  test_that("test informative messages", {
+    expect_message(comtradr::ct_get_bulk(reporter = 'ARG',
+                                         start_date = '1962',
+                                         end_date = "1962",
+                                         verbose = T),
+                   'Processing bulk file, this writes to your cache directory') # nolint
+    expect_message(comtradr::ct_get_bulk(reporter = 'ARG',
+                                         start_date = '1962',
+                                         end_date = "1962",
+                                         verbose = T),
+                   'Performing request, which can take a few seconds, depend') # nolint
+
+    expect_message(comtradr::ct_get_bulk(reporter = 'ARG',
+                                         start_date = '1962',
+                                         end_date = "1962",
+                                         verbose = T),
+                   'Will download files size of: 183.3 KB') # nolint
+  })
+})