rain-sdk 1.2.0

A modern, type-safe Rust SDK for the Rain xyz API
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
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
//! Main HTTP client for the Rain SDK
//!
//! This module provides the core HTTP client for making requests to the Rain API.
//! The client supports both async and blocking (synchronous) operations.
//!
//! # Features
//!
//! - **Async Support**: Use `async`/`await` for non-blocking operations
//! - **Blocking Support**: Use synchronous methods for simpler code
//! - **Automatic Authentication**: Handles API key authentication
//! - **Error Handling**: Comprehensive error types with detailed context
//!
//! # Examples
//!
//! ## Async Client
//!
//! ```no_run
//! use rain_sdk::{RainClient, Config, Environment, AuthConfig};
//!
//! # #[cfg(feature = "async")]
//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
//! let config = Config::new(Environment::Dev);
//! let auth = AuthConfig::with_api_key("your-api-key".to_string());
//! let client = RainClient::new(config, auth)?;
//!
//! // Use async methods
//! # Ok(())
//! # }
//! ```
//!
//! ## Blocking Client
//!
//! ```no_run
//! use rain_sdk::{RainClient, Config, Environment, AuthConfig};
//!
//! # #[cfg(feature = "sync")]
//! # fn example() -> Result<(), Box<dyn std::error::Error>> {
//! let config = Config::new(Environment::Dev);
//! let auth = AuthConfig::with_api_key("your-api-key".to_string());
//! let client = RainClient::new(config, auth)?;
//!
//! // Use blocking methods
//! # Ok(())
//! # }
//! ```

use crate::auth::AuthConfig;
use crate::config::Config;
use crate::error::{RainError, Result};
use reqwest::header::{HeaderMap, HeaderValue, ACCEPT, CONTENT_TYPE};
use serde::de::DeserializeOwned;
use url::Url;

/// Main client for interacting with the Rain API
///
/// This client provides methods to interact with all Rain API endpoints.
/// It handles authentication, request building, and response parsing automatically.
///
/// # Thread Safety
///
/// The client is `Clone` and can be shared across threads safely.
///
/// # Examples
///
/// ```no_run
/// use rain_sdk::{RainClient, Config, Environment, AuthConfig};
///
/// # #[cfg(feature = "async")]
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let config = Config::new(Environment::Dev);
/// let auth = AuthConfig::with_api_key("your-api-key".to_string());
/// let client = RainClient::new(config, auth)?;
/// # Ok(())
/// # }
/// ```
#[derive(Clone)]
pub struct RainClient {
    config: Config,
    auth_config: AuthConfig,
    #[cfg(feature = "async")]
    client: reqwest::Client,
    #[cfg(feature = "sync")]
    blocking_client: reqwest::blocking::Client,
}

impl RainClient {
    /// Create a new client with the given configuration
    ///
    /// # Arguments
    ///
    /// * `config` - Client configuration (environment, timeout, etc.)
    /// * `auth_config` - Authentication configuration (API key)
    ///
    /// # Returns
    ///
    /// Returns a new `RainClient` instance ready to make API requests.
    ///
    /// # Errors
    ///
    /// This function will return an error if:
    /// - The HTTP client cannot be created
    /// - The user agent string is invalid
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use rain_sdk::{RainClient, Config, Environment, AuthConfig};
    ///
    /// # #[cfg(feature = "async")]
    /// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// let config = Config::new(Environment::Dev);
    /// let auth = AuthConfig::with_api_key("your-api-key".to_string());
    /// let client = RainClient::new(config, auth)?;
    /// # Ok(())
    /// # }
    /// ```
    pub fn new(config: Config, auth_config: AuthConfig) -> Result<Self> {
        #[cfg(feature = "async")]
        let client = {
            let mut headers = HeaderMap::new();
            headers.insert(ACCEPT, HeaderValue::from_static("application/json"));
            headers.insert(CONTENT_TYPE, HeaderValue::from_static("application/json"));
            headers.insert(
                "User-Agent",
                HeaderValue::from_str(&config.user_agent)
                    .map_err(|e| RainError::Other(anyhow::anyhow!("Invalid user agent: {e}")))?,
            );

            reqwest::Client::builder()
                .default_headers(headers)
                .timeout(std::time::Duration::from_secs(config.timeout_secs))
                .redirect(reqwest::redirect::Policy::limited(10))
                .build()
                .map_err(RainError::HttpError)?
        };

        #[cfg(feature = "sync")]
        let blocking_client = {
            let mut headers = HeaderMap::new();
            headers.insert(ACCEPT, HeaderValue::from_static("application/json"));
            headers.insert(CONTENT_TYPE, HeaderValue::from_static("application/json"));
            headers.insert(
                "User-Agent",
                HeaderValue::from_str(&config.user_agent)
                    .map_err(|e| RainError::Other(anyhow::anyhow!("Invalid user agent: {e}")))?,
            );

            reqwest::blocking::Client::builder()
                .default_headers(headers)
                .timeout(std::time::Duration::from_secs(config.timeout_secs))
                .redirect(reqwest::redirect::Policy::limited(10))
                .build()
                .map_err(|e| {
                    RainError::Other(anyhow::anyhow!("Failed to create blocking client: {e}"))
                })?
        };

        Ok(Self {
            config,
            auth_config,
            #[cfg(feature = "async")]
            client,
            #[cfg(feature = "sync")]
            blocking_client,
        })
    }

    /// Get the base URL for API requests
    ///
    /// Returns the base URL that all API requests will be made against.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use rain_sdk::{RainClient, Config, Environment, AuthConfig};
    ///
    /// # #[cfg(feature = "async")]
    /// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// let config = Config::new(Environment::Dev);
    /// let auth = AuthConfig::with_api_key("your-api-key".to_string());
    /// let client = RainClient::new(config, auth)?;
    ///
    /// let base_url = client.base_url();
    /// println!("API base URL: {}", base_url);
    /// # Ok(())
    /// # }
    /// ```
    pub fn base_url(&self) -> &Url {
        &self.config.base_url
    }

    /// Build a full URL from a path
    fn build_url(&self, path: &str) -> Result<Url> {
        // If path starts with /, we need to preserve the base URL's path
        let path_to_join = path.strip_prefix('/').unwrap_or(path);

        let mut url = self.config.base_url.clone();
        url.path_segments_mut()
            .map_err(|_| RainError::Other(anyhow::anyhow!("Cannot be a base URL")))?
            .pop_if_empty()
            .extend(path_to_join.split('/').filter(|s| !s.is_empty()));

        Ok(url)
    }

    #[cfg(feature = "async")]
    /// Make an async GET request
    pub async fn get<T: DeserializeOwned>(&self, path: &str) -> Result<T> {
        let url = self.build_url(path)?;
        let builder = self.client.get(url.as_str());
        let builder = crate::auth::add_auth_headers_async(builder, &self.auth_config);

        let response = builder.send().await?;
        self.handle_response(response).await
    }

    #[cfg(feature = "async")]
    /// Make an async GET request and return raw bytes
    pub async fn get_bytes(&self, path: &str) -> Result<Vec<u8>> {
        let url = self.build_url(path)?;
        let builder = self.client.get(url.as_str());
        let builder = crate::auth::add_auth_headers_async(builder, &self.auth_config);

        let response = builder.send().await?;
        let status = response.status();
        if status.is_success() {
            let bytes = response.bytes().await?;
            Ok(bytes.to_vec())
        } else {
            let text = response.text().await?;
            Err(RainError::Other(anyhow::anyhow!("HTTP {status}: {text}")))
        }
    }

    #[cfg(feature = "async")]
    /// Make an async POST request
    pub async fn post<T: DeserializeOwned, B: serde::Serialize>(
        &self,
        path: &str,
        body: &B,
    ) -> Result<T> {
        let url = self.build_url(path)?;
        let body_bytes = serde_json::to_vec(body)?;
        let builder = self.client.post(url.as_str()).body(body_bytes.clone());
        let builder = crate::auth::add_auth_headers_async(builder, &self.auth_config);

        let response = builder.send().await?;
        self.handle_response(response).await
    }

    #[cfg(feature = "async")]
    /// Make an async PATCH request
    pub async fn patch<T: DeserializeOwned, B: serde::Serialize>(
        &self,
        path: &str,
        body: &B,
    ) -> Result<T> {
        let url = self.build_url(path)?;
        let body_bytes = serde_json::to_vec(body)?;
        let builder = self.client.patch(url.as_str()).body(body_bytes.clone());
        let builder = crate::auth::add_auth_headers_async(builder, &self.auth_config);

        let response = builder.send().await?;
        self.handle_response(response).await
    }

    #[cfg(feature = "async")]
    /// Make an async PUT request
    pub async fn put<T: DeserializeOwned, B: serde::Serialize>(
        &self,
        path: &str,
        body: &B,
    ) -> Result<T> {
        let url = self.build_url(path)?;
        let body_bytes = serde_json::to_vec(body)?;
        let builder = self.client.put(url.as_str()).body(body_bytes.clone());
        let builder = crate::auth::add_auth_headers_async(builder, &self.auth_config);

        let response = builder.send().await?;
        self.handle_response(response).await
    }

    #[cfg(feature = "async")]
    /// Make an async GET request with custom headers
    pub async fn get_with_headers<T: DeserializeOwned>(
        &self,
        path: &str,
        headers: Vec<(&str, &str)>,
    ) -> Result<T> {
        let url = self.build_url(path)?;
        let mut builder = self.client.get(url.as_str());
        builder = crate::auth::add_auth_headers_async(builder, &self.auth_config);

        for (key, value) in headers {
            builder = builder.header(key, value);
        }

        let response = builder.send().await?;
        self.handle_response(response).await
    }

    #[cfg(feature = "async")]
    /// Make an async PUT request with custom headers
    pub async fn put_with_headers<T: DeserializeOwned, B: serde::Serialize>(
        &self,
        path: &str,
        body: &B,
        headers: Vec<(&str, &str)>,
    ) -> Result<T> {
        let url = self.build_url(path)?;
        let body_bytes = serde_json::to_vec(body)?;
        let mut builder = self.client.put(url.as_str()).body(body_bytes.clone());
        builder = crate::auth::add_auth_headers_async(builder, &self.auth_config);

        for (key, value) in headers {
            builder = builder.header(key, value);
        }

        let response = builder.send().await?;
        self.handle_response(response).await
    }

    #[cfg(feature = "async")]
    /// Make an async DELETE request
    pub async fn delete(&self, path: &str) -> Result<()> {
        let url = self.build_url(path)?;
        let builder = self.client.delete(url.as_str());
        let builder = crate::auth::add_auth_headers_async(builder, &self.auth_config);

        let response = builder.send().await?;
        let status = response.status();
        if status.is_success() || status == reqwest::StatusCode::NO_CONTENT {
            Ok(())
        } else {
            let text = response.text().await?;
            Err(RainError::Other(anyhow::anyhow!("HTTP {status}: {text}")))
        }
    }

    #[cfg(feature = "async")]
    /// Make an async PUT request with multipart form data
    pub async fn put_multipart<T: DeserializeOwned>(
        &self,
        path: &str,
        form: reqwest::multipart::Form,
    ) -> Result<T> {
        let url = self.build_url(path)?;
        let mut headers = HeaderMap::new();
        // Don't set Content-Type for multipart - reqwest will set it with boundary
        headers.insert(ACCEPT, HeaderValue::from_static("application/json"));
        headers.insert(
            "User-Agent",
            HeaderValue::from_str(&self.config.user_agent)
                .map_err(|e| RainError::Other(anyhow::anyhow!("Invalid user agent: {e}")))?,
        );

        let request = self
            .client
            .put(url.as_str())
            .headers(headers)
            .header("Api-Key", &self.auth_config.api_key)
            .multipart(form);

        let response = request.send().await?;
        self.handle_response(response).await
    }

    #[cfg(feature = "async")]
    /// Make an async PUT request with multipart form data that returns nothing (204)
    pub async fn put_multipart_no_content(
        &self,
        path: &str,
        form: reqwest::multipart::Form,
    ) -> Result<()> {
        let url = self.build_url(path)?;
        let mut headers = HeaderMap::new();
        // Don't set Content-Type for multipart - reqwest will set it with boundary
        headers.insert(ACCEPT, HeaderValue::from_static("application/json"));
        headers.insert(
            "User-Agent",
            HeaderValue::from_str(&self.config.user_agent)
                .map_err(|e| RainError::Other(anyhow::anyhow!("Invalid user agent: {e}")))?,
        );

        let request = self
            .client
            .put(url.as_str())
            .headers(headers)
            .header("Api-Key", &self.auth_config.api_key)
            .multipart(form);

        let response = request.send().await?;
        let status = response.status();
        if status == reqwest::StatusCode::NO_CONTENT || status.is_success() {
            Ok(())
        } else {
            let text = response.text().await?;
            Err(RainError::Other(anyhow::anyhow!("HTTP {status}: {text}")))
        }
    }

    #[cfg(feature = "sync")]
    /// Make a blocking GET request
    pub fn get_blocking<T: DeserializeOwned>(&self, path: &str) -> Result<T> {
        let url = self.build_url(path)?;
        let builder = self.blocking_client.get(url.as_str());
        let builder = crate::auth::add_auth_headers_sync(builder, &self.auth_config);

        let response = builder.send()?;
        self.handle_blocking_response(response)
    }

    #[cfg(feature = "sync")]
    /// Make a blocking GET request and return raw bytes
    pub fn get_bytes_blocking(&self, path: &str) -> Result<Vec<u8>> {
        let url = self.build_url(path)?;
        let builder = self.blocking_client.get(url.as_str());
        let builder = crate::auth::add_auth_headers_sync(builder, &self.auth_config);

        let response = builder.send()?;
        let status = response.status();
        if status.is_success() {
            let bytes = response.bytes()?;
            Ok(bytes.to_vec())
        } else {
            let text = response.text()?;
            Err(RainError::Other(anyhow::anyhow!("HTTP {status}: {text}")))
        }
    }

    #[cfg(feature = "sync")]
    /// Make a blocking POST request
    pub fn post_blocking<T: DeserializeOwned, B: serde::Serialize>(
        &self,
        path: &str,
        body: &B,
    ) -> Result<T> {
        let url = self.build_url(path)?;
        let body_bytes = serde_json::to_vec(body)?;
        let builder = self
            .blocking_client
            .post(url.as_str())
            .body(body_bytes.clone());
        let builder = crate::auth::add_auth_headers_sync(builder, &self.auth_config);

        let response = builder.send()?;
        self.handle_blocking_response(response)
    }

    #[cfg(feature = "sync")]
    /// Make a blocking PATCH request
    pub fn patch_blocking<T: DeserializeOwned, B: serde::Serialize>(
        &self,
        path: &str,
        body: &B,
    ) -> Result<T> {
        let url = self.build_url(path)?;
        let body_bytes = serde_json::to_vec(body)?;
        let builder = self
            .blocking_client
            .patch(url.as_str())
            .body(body_bytes.clone());
        let builder = crate::auth::add_auth_headers_sync(builder, &self.auth_config);

        let response = builder.send()?;
        self.handle_blocking_response(response)
    }

    #[cfg(feature = "sync")]
    /// Make a blocking PUT request
    pub fn put_blocking<T: DeserializeOwned, B: serde::Serialize>(
        &self,
        path: &str,
        body: &B,
    ) -> Result<T> {
        let url = self.build_url(path)?;
        let body_bytes = serde_json::to_vec(body)?;
        let builder = self
            .blocking_client
            .put(url.as_str())
            .body(body_bytes.clone());
        let builder = crate::auth::add_auth_headers_sync(builder, &self.auth_config);

        let response = builder.send()?;
        self.handle_blocking_response(response)
    }

    #[cfg(feature = "sync")]
    /// Make a blocking PUT request with multipart form data that returns nothing (204)
    pub fn put_multipart_blocking_no_content(
        &self,
        path: &str,
        form: reqwest::blocking::multipart::Form,
    ) -> Result<()> {
        let url = self.build_url(path)?;
        use reqwest::blocking::header::{HeaderMap, HeaderValue, ACCEPT};
        let mut headers = HeaderMap::new();
        headers.insert(ACCEPT, HeaderValue::from_static("application/json"));
        headers.insert(
            "User-Agent",
            HeaderValue::from_str(&self.config.user_agent)
                .map_err(|e| RainError::Other(anyhow::anyhow!("Invalid user agent: {e}")))?,
        );

        let response = self
            .blocking_client
            .put(url.as_str())
            .headers(headers)
            .header("Api-Key", &self.auth_config.api_key)
            .multipart(form)
            .send()?;

        let status = response.status();
        if status == reqwest::StatusCode::NO_CONTENT || status.is_success() {
            Ok(())
        } else {
            let text = response.text()?;
            Err(RainError::Other(anyhow::anyhow!("HTTP {status}: {text}")))
        }
    }

    #[cfg(feature = "sync")]
    /// Make a blocking DELETE request
    pub fn delete_blocking(&self, path: &str) -> Result<()> {
        let url = self.build_url(path)?;
        let builder = self.blocking_client.delete(url.as_str());
        let builder = crate::auth::add_auth_headers_sync(builder, &self.auth_config);

        let response = builder.send()?;
        let status = response.status();
        if status.is_success() || status == reqwest::StatusCode::NO_CONTENT {
            Ok(())
        } else {
            let text = response.text()?;
            Err(RainError::Other(anyhow::anyhow!("HTTP {status}: {text}")))
        }
    }

    #[cfg(feature = "async")]
    async fn handle_response<T: DeserializeOwned>(&self, response: reqwest::Response) -> Result<T> {
        let status = response.status();
        let url = response.url().clone();
        let text = response.text().await?;

        // Handle 202 Accepted (typically has no body)
        if status == reqwest::StatusCode::ACCEPTED {
            if text.is_empty() {
                // Try to deserialize as empty JSON object for 202
                serde_json::from_str("{}")
                    .or_else(|_| serde_json::from_str("null"))
                    .map_err(|_| RainError::ValidationError("Empty response body".to_string()))
            } else {
                serde_json::from_str(&text).map_err(RainError::DeserializationError)
            }
        } else if status.is_success() {
            if text.is_empty() {
                // Handle 204 No Content
                serde_json::from_str("null")
                    .map_err(|_| RainError::ValidationError("Empty response body".to_string()))
            } else {
                serde_json::from_str(&text).map_err(RainError::DeserializationError)
            }
        } else {
            // Try to parse as error response
            match serde_json::from_str::<crate::error::ApiErrorResponse>(&text) {
                Ok(api_error) => Err(RainError::ApiError {
                    status: status.as_u16(),
                    response: Box::new(api_error),
                }),
                Err(_) => Err(RainError::Other(anyhow::anyhow!(
                    "HTTP {} from {}: {}",
                    status,
                    url,
                    if text.len() > 200 {
                        format!("{}...", &text[..200])
                    } else {
                        text
                    }
                ))),
            }
        }
    }

    #[cfg(feature = "sync")]
    fn handle_blocking_response<T: DeserializeOwned>(
        &self,
        response: reqwest::blocking::Response,
    ) -> Result<T> {
        let status = response.status();
        let text = response.text()?;

        // Handle 202 Accepted (typically has no body)
        if status == reqwest::StatusCode::ACCEPTED {
            if text.is_empty() {
                // Try to deserialize as empty JSON object for 202
                serde_json::from_str("{}")
                    .or_else(|_| serde_json::from_str("null"))
                    .map_err(|_| RainError::ValidationError("Empty response body".to_string()))
            } else {
                serde_json::from_str(&text).map_err(RainError::DeserializationError)
            }
        } else if status.is_success() {
            if text.is_empty() {
                // Handle 204 No Content
                serde_json::from_str("null")
                    .map_err(|_| RainError::ValidationError("Empty response body".to_string()))
            } else {
                serde_json::from_str(&text).map_err(RainError::DeserializationError)
            }
        } else {
            // Try to parse as error response
            match serde_json::from_str::<crate::error::ApiErrorResponse>(&text) {
                Ok(api_error) => Err(RainError::ApiError {
                    status: status.as_u16(),
                    response: Box::new(api_error),
                }),
                Err(_) => Err(RainError::Other(anyhow::anyhow!("HTTP {status}: {text}"))),
            }
        }
    }
}