arcgis 0.1.2

Type-safe Rust SDK for the ArcGIS REST API with compile-time guarantees
Documentation
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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
//! Item operations for the Portal client.

use super::super::{
    AddItemParams, AddItemResult, DeleteItemResult, ItemInfo, UpdateItemParams, UpdateItemResult,
};
use super::PortalClient;
use crate::Result;
use tracing::instrument;

impl<'a> PortalClient<'a> {
    /// Gets a portal item by ID.
    ///
    /// Retrieves detailed metadata for a specific item.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use arcgis::{ArcGISClient, ApiKeyAuth, PortalClient};
    /// # async fn example(portal: &PortalClient<'_>) -> arcgis::Result<()> {
    /// let item = portal.get_item("abc123def456").await?;
    /// println!("Title: {}", item.title());
    /// println!("Type: {}", item.item_type());
    /// println!("Owner: {}", item.owner());
    /// # Ok(())
    /// # }
    /// ```
    #[instrument(skip(self, item_id))]
    pub async fn get_item(&self, item_id: impl AsRef<str>) -> Result<ItemInfo> {
        let item_id = item_id.as_ref();
        tracing::debug!(item_id = %item_id, "Getting item");

        let url = format!("{}/content/items/{}", self.base_url, item_id);

        // Get authentication token

        tracing::debug!(url = %url, "Sending getItem request");

        // Build request
        let mut request = self.client.http().get(&url).query(&[("f", "json")]);

        if let Some(token) = self.client.get_token_if_required().await? {
            request = request.query(&[("token", token)]);
        }

        let response = request.send().await?;

        // Check for HTTP errors
        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|e| format!("Failed to read error response: {}", e));
            tracing::error!(status = %status, error = %error_text, "getItem request failed");
            return Err(crate::Error::from(crate::ErrorKind::Api {
                code: status.as_u16() as i32,
                message: format!("HTTP {}: {}", status, error_text),
            }));
        }

        // Parse response
        let item: ItemInfo = response.json().await?;

        tracing::debug!(title = %item.title(), item_type = %item.item_type(), "Got item");

        Ok(item)
    }

    /// Adds a new item to the portal.
    ///
    /// Creates a new item in the authenticated user's content area.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use arcgis::{ArcGISClient, ApiKeyAuth, PortalClient, AddItemParams};
    /// # async fn example(portal: &PortalClient<'_>) -> arcgis::Result<()> {
    /// let params = AddItemParams::new("My Map", "Web Map")
    ///     .with_description("A sample web map")
    ///     .with_tags(vec!["sample".to_string(), "demo".to_string()]);
    ///
    /// let result = portal.add_item(params).await?;
    /// println!("Created item: {}", result.id());
    /// # Ok(())
    /// # }
    /// ```
    #[instrument(skip(self, params))]
    pub async fn add_item(&self, params: AddItemParams) -> Result<AddItemResult> {
        tracing::debug!(title = %params.title(), item_type = %params.item_type(), "Adding item");

        // Get authentication token

        // We need the username to construct the URL
        let user = self.get_self().await?;
        let username = user.effective_username().ok_or_else(|| {
            crate::Error::from(crate::ErrorKind::Api {
                code: 401,
                message: "Username not available in user info".to_string(),
            })
        })?;

        let url = format!("{}/content/users/{}/addItem", self.base_url, username);

        tracing::debug!(url = %url, username = %username, "Sending addItem request");

        // Build form data
        let mut form = reqwest::multipart::Form::new()
            .text("f", "json")
            .text("title", params.title().to_string())
            .text("type", params.item_type().to_string());

        if let Some(desc) = params.description() {
            form = form.text("description", desc.to_string());
        }

        if let Some(tags) = params.tags() {
            form = form.text("tags", tags.join(","));
        }

        if let Some(snippet) = params.snippet() {
            form = form.text("snippet", snippet.to_string());
        }

        if let Some(categories) = params.categories() {
            form = form.text("categories", categories.join(","));
        }

        if let Some(keywords) = params.type_keywords() {
            form = form.text("typeKeywords", keywords.join(","));
        }

        if let Some(url_str) = params.url() {
            form = form.text("url", url_str.to_string());
        }

        if let Some(wkid) = params.spatial_reference() {
            form = form.text("spatialReference", wkid.to_string());
        }

        if let Some(extent) = params.extent() {
            let extent_str = serde_json::to_string(extent)?;
            form = form.text("extent", extent_str);
        }

        if let Some(access) = params.access() {
            form = form.text("access", access.to_string());
        }

        if let Some(properties) = params.properties() {
            let props_str = serde_json::to_string(properties)?;
            form = form.text("properties", props_str);
        }

        if let Some(folder) = params.folder() {
            form = form.text("folder", folder.to_string());
        }

        if let Some(text) = params.text() {
            // Add text content as a text parameter (not as a file)
            form = form.text("text", text.to_string());
        }

        // Build request
        // Add token if required by auth provider

        if let Some(token) = self.client.get_token_if_required().await? {
            form = form.text("token", token);
        }

        let response = self.client.http().post(&url).multipart(form).send().await?;

        // Check for HTTP errors
        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|e| format!("Failed to read error response: {}", e));
            tracing::error!(status = %status, error = %error_text, "addItem request failed");
            return Err(crate::Error::from(crate::ErrorKind::Api {
                code: status.as_u16() as i32,
                message: format!("HTTP {}: {}", status, error_text),
            }));
        }

        // Get response text for debugging
        let response_text = response.text().await?;
        tracing::debug!(response = %response_text, "addItem raw response");

        // Parse response
        let result: AddItemResult = serde_json::from_str(&response_text)?;

        tracing::debug!(item_id = %result.id(), success = result.success(), "Item added");

        Ok(result)
    }

    /// Updates an existing portal item's metadata.
    ///
    /// Updates properties like title, description, tags, etc. for an existing item.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use arcgis::{ArcGISClient, ApiKeyAuth, PortalClient, UpdateItemParams};
    /// # async fn example(portal: &PortalClient<'_>) -> arcgis::Result<()> {
    /// let params = UpdateItemParams::new()
    ///     .with_title("Updated Title")
    ///     .with_description("Updated description");
    ///
    /// let result = portal.update_item("abc123def456", params).await?;
    /// println!("Update success: {}", result.success());
    /// # Ok(())
    /// # }
    /// ```
    #[instrument(skip(self, item_id, params))]
    pub async fn update_item(
        &self,
        item_id: impl AsRef<str>,
        params: UpdateItemParams,
    ) -> Result<UpdateItemResult> {
        let item_id = item_id.as_ref();
        tracing::debug!(item_id = %item_id, "Updating item");

        // Get authentication token

        // Get the item to find its owner
        let item = self.get_item(item_id).await?;
        let url = format!(
            "{}/content/users/{}/items/{}/update",
            self.base_url,
            item.owner(),
            item_id
        );

        tracing::debug!(url = %url, owner = %item.owner(), "Sending updateItem request");

        // Build form data
        let mut form = reqwest::multipart::Form::new().text("f", "json");

        if let Some(title) = params.title() {
            form = form.text("title", title.to_string());
        }

        if let Some(desc) = params.description() {
            form = form.text("description", desc.to_string());
        }

        if let Some(tags) = params.tags() {
            form = form.text("tags", tags.join(","));
        }

        if let Some(snippet) = params.snippet() {
            form = form.text("snippet", snippet.to_string());
        }

        if let Some(categories) = params.categories() {
            form = form.text("categories", categories.join(","));
        }

        if let Some(keywords) = params.type_keywords() {
            form = form.text("typeKeywords", keywords.join(","));
        }

        if let Some(url_str) = params.url() {
            form = form.text("url", url_str.to_string());
        }

        if let Some(wkid) = params.spatial_reference() {
            form = form.text("spatialReference", wkid.to_string());
        }

        if let Some(extent) = params.extent() {
            let extent_str = serde_json::to_string(extent)?;
            form = form.text("extent", extent_str);
        }

        if let Some(access) = params.access() {
            form = form.text("access", access.to_string());
        }

        // Build request
        // Add token if required by auth provider

        if let Some(token) = self.client.get_token_if_required().await? {
            form = form.text("token", token);
        }

        let response = self.client.http().post(&url).multipart(form).send().await?;

        // Check for HTTP errors
        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|e| format!("Failed to read error response: {}", e));
            tracing::error!(status = %status, error = %error_text, "updateItem request failed");
            return Err(crate::Error::from(crate::ErrorKind::Api {
                code: status.as_u16() as i32,
                message: format!("HTTP {}: {}", status, error_text),
            }));
        }

        // Parse response
        let result: UpdateItemResult = response.json().await?;

        tracing::debug!(success = result.success(), "Item updated");

        Ok(result)
    }

    /// Deletes a portal item.
    ///
    /// Permanently removes an item from the portal.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use arcgis::{ArcGISClient, ApiKeyAuth, PortalClient};
    /// # async fn example(portal: &PortalClient<'_>) -> arcgis::Result<()> {
    /// let result = portal.delete_item("abc123def456").await?;
    /// println!("Delete success: {}", result.success());
    /// # Ok(())
    /// # }
    /// ```
    #[instrument(skip(self, item_id))]
    pub async fn delete_item(&self, item_id: impl AsRef<str>) -> Result<DeleteItemResult> {
        let item_id = item_id.as_ref();
        tracing::debug!(item_id = %item_id, "Deleting item");

        // Get authentication token

        // Get the item to find its owner
        let item = self.get_item(item_id).await?;
        let url = format!(
            "{}/content/users/{}/items/{}/delete",
            self.base_url,
            item.owner(),
            item_id
        );

        tracing::debug!(url = %url, owner = %item.owner(), "Sending deleteItem request");

        // Build request
        let mut form_data = vec![("f", "json")];

        // Add token if required by auth provider

        let token_opt = self.client.get_token_if_required().await?;

        let token_str;

        if let Some(token) = token_opt {
            token_str = token;

            form_data.push(("token", token_str.as_str()));
        }

        let response = self
            .client
            .http()
            .post(&url)
            .form(&form_data)
            .send()
            .await?;

        // Check for HTTP errors
        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|e| format!("Failed to read error response: {}", e));
            tracing::error!(status = %status, error = %error_text, "deleteItem request failed");
            return Err(crate::Error::from(crate::ErrorKind::Api {
                code: status.as_u16() as i32,
                message: format!("HTTP {}: {}", status, error_text),
            }));
        }

        // Parse response
        let result: DeleteItemResult = response.json().await?;

        tracing::debug!(success = result.success(), "Item deleted");

        Ok(result)
    }

    /// Downloads the data file associated with a portal item.
    ///
    /// Returns the raw bytes of the item's data file (e.g., the actual web map JSON,
    /// a GeoJSON file, or other item data).
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use arcgis::{ArcGISClient, ApiKeyAuth, PortalClient};
    /// # async fn example(portal: &PortalClient<'_>) -> arcgis::Result<()> {
    /// let data = portal.get_item_data("abc123def456").await?;
    /// println!("Downloaded {} bytes", data.len());
    /// # Ok(())
    /// # }
    /// ```
    #[instrument(skip(self, item_id))]
    pub async fn get_item_data(&self, item_id: impl AsRef<str>) -> Result<bytes::Bytes> {
        let item_id = item_id.as_ref();
        tracing::debug!(item_id = %item_id, "Getting item data");

        let url = format!("{}/content/items/{}/data", self.base_url, item_id);

        // Get authentication token

        tracing::debug!(url = %url, "Sending getItemData request");

        // Build request
        let mut request = self.client.http().get(&url).query(&[("f", "json")]);

        if let Some(token) = self.client.get_token_if_required().await? {
            request = request.query(&[("token", token)]);
        }

        let response = request.send().await?;

        // Check for HTTP errors
        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|e| format!("Failed to read error response: {}", e));
            tracing::error!(status = %status, error = %error_text, "getItemData request failed");
            return Err(crate::Error::from(crate::ErrorKind::Api {
                code: status.as_u16() as i32,
                message: format!("HTTP {}: {}", status, error_text),
            }));
        }

        // Get bytes
        let bytes = response.bytes().await?;

        tracing::debug!(size = bytes.len(), "Retrieved item data");

        Ok(bytes)
    }

    /// Uploads or updates the data file for a portal item.
    ///
    /// Updates the item's data content (e.g., web map definition, GeoJSON, etc.).
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use arcgis::{ArcGISClient, ApiKeyAuth, PortalClient};
    /// # async fn example(portal: &PortalClient<'_>) -> arcgis::Result<()> {
    /// let data = br#"{"type":"FeatureCollection","features":[]}"#.to_vec();
    /// let result = portal.update_item_data("abc123def456", data).await?;
    /// println!("Update success: {}", result.success());
    /// # Ok(())
    /// # }
    /// ```
    #[instrument(skip(self, item_id, data))]
    pub async fn update_item_data(
        &self,
        item_id: impl AsRef<str>,
        data: Vec<u8>,
    ) -> Result<UpdateItemResult> {
        let item_id = item_id.as_ref();
        tracing::debug!(item_id = %item_id, size = data.len(), "Updating item data");

        // Get authentication token

        // Get the item to find its owner
        let item = self.get_item(item_id).await?;
        let url = format!(
            "{}/content/users/{}/items/{}/update",
            self.base_url,
            item.owner(),
            item_id
        );

        tracing::debug!(url = %url, owner = %item.owner(), "Sending updateItemData request");

        // Create multipart form with file
        let part = reqwest::multipart::Part::bytes(data)
            .file_name("data.json")
            .mime_str("application/json")?;

        let mut form = reqwest::multipart::Form::new()
            .text("f", "json")
            .part("file", part);

        // Add token if required by auth provider
        if let Some(token) = self.client.get_token_if_required().await? {
            form = form.text("token", token);
        }

        let response = self.client.http().post(&url).multipart(form).send().await?;

        // Check for HTTP errors
        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|e| format!("Failed to read error response: {}", e));
            tracing::error!(status = %status, error = %error_text, "updateItemData request failed");
            return Err(crate::Error::from(crate::ErrorKind::Api {
                code: status.as_u16() as i32,
                message: format!("HTTP {}: {}", status, error_text),
            }));
        }

        // Parse response
        let result: UpdateItemResult = response.json().await?;

        tracing::debug!(success = result.success(), "Item data updated");

        Ok(result)
    }
}