-
Notifications
You must be signed in to change notification settings - Fork 6
/
resource.R
361 lines (346 loc) · 12.7 KB
/
resource.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
#' Create HDX Resource
#'
#' R6 objects are essentially environments, structured in a way that makes them
#' look like an object in a more typical object-oriented language than R. They
#' support public and private members, as well as inheritance across different
#' packages.
#'
#' @export
#' @details
#' **Methods**
#' \describe{
#' \item{`create(path, query, disk, stream, ...)`}{
#' Make a GET request
#' }
#' \item{`read(path, query, body, disk, stream, ...)`}{
#' Make a POST request
#' }
#' \item{`delete(path, query, body, disk, stream, ...)`}{
#' Make a PUT request
#' }
#' \item{`setup(path, query, body, disk, stream, ...)`}{
#' Make a PATCH request
#' }
#' \item{`delete(path, query, body, disk, stream, ...)`}{
#' Make a DELETE request
#' }
#' \item{`head(path, query, ...)`}{
#' Make a HEAD request
#' }
#' }
#'
#' @format NULL
#' @usage NULL
#' @details Possible parameters (not all are allowed in each HTTP verb):
#' \itemize{
#' \item read_from_hdx - query terms, as a named list
#' \item search_in_hdx - body as an R list
#' \item update_from_yaml - one of form, multipart, json, or raw
#' \item add_update_resource
#' \item add_update_resources - one of form, multipart, json, or raw
#' }
#'
#' @examples
#' \dontrun{
#' # ---------------------------------------------------------
#' Configuration$create(hdx_site = "demo")
#' resource <- Resource$read_from_hdx("98aa1742-b5d3-40c3-94c6-01e31ded6e84")
#' resource
#' }
#'
#'
Resource <- R6::R6Class(
"Resource",
private = list(
configuration = NULL,
download_folder_ = NULL
),
public = list(
data = NULL,
initialize = function(initial_data = NULL, configuration = NULL) {
if (is.null(configuration) | !inherits(configuration, "Configuration")) {
private$configuration <- Configuration$read()
} else {
private$configuration <- configuration
}
if (is.null(initial_data)) initial_data <- list()
initial_data <- drop_nulls(initial_data)
self$data <- initial_data
},
update_from_yaml = function(hdx_resource_static_yaml) {
self$data <- yaml::yaml.load_file(hdx_resource_static_yaml)
},
update_from_json = function(hdx_resource_static_json) {
self$data <- jsonlite::fromJSON(hdx_resource_static_json,
simplifyVector = TRUE)
},
touch = function() {
private$configuration$call_remoteclient("resource_patch",
list(id = self$data$id))
},
download = function(folder = NULL, filename = NULL,
quiet = TRUE, force = FALSE, ...) {
if (is.null(folder))
folder <- tempdir()
if (is.null(filename)) {
filename <- basename(self$data$url)
if (!is.null(self$data$resource_type) && self$data$resource_type == "api")
filename <- gsub("\\?.*", "", filename)
}
path <- file.path(folder, filename)
if (!file.exists(path) | force)
download.file(url = self$data$url, destfile = path,
mode = "wb", quiet = quiet, ...)
private$download_folder_ <- tools::file_path_as_absolute(folder)
invisible(tools::file_path_as_absolute(path))
},
download_folder = function() {
tools::file_path_as_absolute(private$download_folder_)
},
read_session = function(sheet = NULL, layer = NULL, folder = NULL, simplify_json = TRUE, quiet = TRUE, hxl = FALSE, ...) {
if (!is.null(private$download_folder_) & is.null(folder))
folder <- self$download_folder()
path <- self$download(folder = folder, quiet = quiet, ...)
format <- self$get_file_type()
switch(
format,
csv = {
check_packages("readr")
df <- readr::read_csv(path)
if (isTRUE(hxl))
df <- rhxl::as_hxl(df)
df
},
excel = read_sheet(path = path, sheet = sheet, hxl = hxl),
xlsx = read_sheet(path = path, sheet = sheet, hxl = hxl),
xls = read_sheet(path = path, sheet = sheet, hxl = hxl),
json = {
check4X("jsonlite")
jsonlite::fromJSON(path, simplifyVector = simplify_json)
},
geojson = read_vector(path, layer),
`zipped shapefile` = read_vector(path = path, layer = layer),
`zipped geodatabase` = read_vector(path = path, layer = layer, zipped = FALSE),
`zipped geopackage` = read_vector(path = path, layer = layer),
`zipped geotiff` = read_raster(path = path, layer = layer),
kmz = read_vector(path = path, layer = layer),
`zipped kml` = read_vector(path = path, layer = layer))
},
get_layers = function(folder = NULL, quiet = TRUE) {
if (!is.null(private$download_folder_) & is.null(folder))
folder <- self$download_folder()
path <- self$download(folder = folder, quiet = quiet)
format <- self$get_file_type()
supported_geo_format <- c("geojson", "zipped shapefile", "zipped geodatabase",
"zipped geopackage", "zipped geotiff", "kmz", "zipped kml")
if (!format %in% supported_geo_format) stop("This (spatial) data format is not yet supported", call. = FALSE)
switch(
format,
geojson = get_layers_(path, zipped = FALSE),
`zipped shapefile` = get_layers_(path),
`zipped geodatabase` = get_layers_(path, zipped = FALSE),
`zipped geopackage` = get_layers_(path),
kmz = get_layers_(path),
`zipped kml` = get_layers_(path))
},
get_sheets = function(folder = NULL, quiet = TRUE, ...) {
if (!is.null(private$download_folder_) & is.null(folder))
folder <- self$download_folder()
path <- self$download(folder = folder, quiet = quiet, ...)
format <- self$get_file_type()
if (!format %in% c("xlsx", "xls", "excel")) stop("`get_sheets work only with Excel file", call. = FALSE)
switch(
format,
excel = get_sheets_(path = path),
xlsx = get_sheets_(path = path),
xls = get_sheets_(path = path))
},
get_dataset = function() {
package_id <- self$data$package_id
if (is.null(package_id)) {
stop("Resource has no package id!", call. = FALSE)
} else {
Dataset$read_from_hdx(package_id)
}
},
get_file_to_upload = function() {
self$data$file_to_upload
},
set_file_to_upload = function(file_to_upload) {
self$data$file_to_upload <- crul::upload(file_to_upload)
},
check_required_field = function(check_dataset_id = FALSE) {
n2 <- names(self$data)
n1 <- private$configuration$data$resource$required_fields
if (check_datasetid) n1 <- setdiff(n1, "package_id")
if (!all(n1 %in% n2))
stop(sprintf("Field %s is missing in the dataset!", setdiff(n1, n2)), call. = FALSE)
},
read_from_hdx = function(identifier, configuration = NULL) {
if (is.null(configuration) | !inherits(configuration, "Configuration"))
configuration <- private$configuration
res <- configuration$call_remoteclient("resource_show", list(id = identifier))
Resource$new(initial_data = res$result, configuration = configuration)
},
search_in_hdx = function(query = "*:*", configuration = NULL, ...) {
if (is.null(configuration) | !inherits(configuration, "Configuration"))
configuration <- private$configuration
res <- configuration$call_remoteclient("resource_search", list(query = query, ...))
list_of_rs <- lapply(res$result$results, function(x) Resource$new(initial_data = x, configuration = configuration))
class(list_of_rs) <- "resources_list"
list_of_rs
},
get_file_type = function() {
tolower(self$data$format)
},
get_format = function() {
tolower(self$data$format)
},
set_file_type = function(file_type) {
self$data$format <- file_type
},
set_format = function(format) {
self$data$format <- format
},
as_list = function() {
self$data
},
update_in_hdx = function() {
configuration <- private$configuration
resource_id <- self$data$id
if (is.null(resource_id))
stop("Resource not on HDX use `create_in_hdx` method")
rs <- drop_nulls(self$data)
h <- curl::new_handle(http_version = 2, useragent = get_user_agent())
curl::handle_setheaders(h,
`X-CKAN-API-Key` = configuration$get_hdx_key(),
`Content-Type` = "multipart/form-data")
curl::handle_setform(h, .list = rs)
url <- paste0(configuration$get_hdx_site_url(), "api/action/resource_update")
res <- curl::curl_fetch_memory(url, handle = h)
if (res$status_code != 200L)
stop("Resources not created check the parameters")
invisible(res)
},
create_in_hdx = function(dataset_id = NULL) {
configuration <- private$configuration
rs <- self$data
rs$package_id <- dataset_id
h <- curl::new_handle(http_version = 2, useragent = get_user_agent())
curl::handle_setheaders(h,
`X-CKAN-API-Key` = configuration$get_hdx_key(),
`Content-Type` = "multipart/form-data")
curl::handle_setform(h, .list = rs)
url <- paste0(configuration$get_hdx_site_url(), "api/action/resource_create")
res <- curl::curl_fetch_memory(url, handle = h)
if (res$status_code == 200L) {
message("All resources uploaded")
} else {
stop("Resources not created check the parameters")
}
invisible(res)
},
create_datastore = function() {
},
delete_datastore = function() {
},
update_datastore = function() {
},
browse = function() {
url <- private$configuration$get_hdx_site_url()
dataset_id <- self$data$package_id
resource_id <- self$data$id
browseURL(url = paste0(url, "dataset/", dataset_id, "/resource/", resource_id))
},
print = function() {
cat(paste0("<HDX Resource> ", self$data$id), "\n")
cat(" Name: ", self$data$name, "\n", sep = "")
cat(" Description: ", self$data$description, "\n", sep = "")
cat(" Size: ", self$data$size, "\n", sep = "")
cat(" Format: ", self$data$format, "\n", sep = "")
invisible(self)
}
)
)
#' @aliases Resource
Resource$read_from_hdx <- function(identifier, configuration = NULL) {
rs <- Resource$new()
rs$read_from_hdx(identifier = identifier, configuration = configuration)
}
#' @aliases Resource
Resource$search_in_hdx <- function(query = "*:*", configuration = NULL, ...) {
rs <- Resource$new()
rs$search_in_hdx(query = query, configuration = configuration, ...)
}
#' @export
#' @aliases Resource
#' @importFrom tibble as_tibble
as_tibble.Resource <- function(x, ...) {
df <- tibble::data_frame(
resource_id = x$data$id,
resource_name = x$data$name,
resource_format = tolower(x$data$format),
resource_url = x$data$url)
df$resource <- list(x)
df
}
#' @export
#' @aliases Resource
as.list.Resource <- function(x) {
x$as_list()
}
#' @export
#' @aliases Resource
download <- function(resource, folder = NULL, filename = NULL, quiet = FALSE, ...) {
assert_resource(resource)
resource$download(folder = folder, filename = filename, quiet = quiet, ...)
}
#' @export
#' @aliases Resource
get_layers <- function(resource, folder = NULL, quiet = TRUE) {
assert_resource(resource)
resource$get_layers(folder = folder, quiet = quiet)
}
#' @export
#' @aliases Resource
get_sheets <- function(resource, folder = NULL, quiet = TRUE, ...) {
assert_resource(resource)
resource$get_sheets(folder = folder, quiet = quiet, ...)
}
#' @export
#' @aliases Resource
get_format <- function(resource) {
assert_resource(resource)
resource$get_format()
}
#' @export
#' @aliases Resource
read_session <- function(resource, sheet = NULL, layer = NULL, folder = NULL, simplify_json = TRUE, hxl = FALSE, ...) {
assert_resource(resource)
resource$read_session(sheet = sheet,
layer = layer,
folder = folder,
simplify_json = simplify_json,
hxl = hxl,
...)
}
#' @aliases Resource
.search_resources <- function(query = "*:*", configuration = NULL, ...) {
rs <- Resource$new()
rs$search_in_hdx(query = query, configuration = configuration, ...)
}
#' @export
#' @aliases Resource
search_resources <- memoise::memoise(.search_resources)
#' @aliases Resource
.read_resource <- function(identifier = NULL, configuration = NULL, ...) {
rs <- Resource$new()
rs$read_from_hdx(identifier = identifier, configuration = configuration, ...)
}
#' @export
#' @aliases Resource
read_resource <- memoise::memoise(.read_resource)
#' @export
#' @aliases Resource
browse.Resource <- function(x)
x$browse()