rs-utcp 0.3.2

Rust implementation of the Universal Tool Calling Protocol (UTCP).
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

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

use crate::auth::AuthConfig;
use crate::providers::base::{BaseProvider, Provider, ProviderType};

/// Provider definition for streaming HTTP endpoints that emit chunked JSON.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct StreamableHttpProvider {
    #[serde(flatten)]
    pub base: BaseProvider,
    pub url: String,
    #[serde(default = "StreamableHttpProvider::default_method")]
    pub http_method: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub headers: Option<HashMap<String, String>>,
}

impl Provider for StreamableHttpProvider {
    fn type_(&self) -> ProviderType {
        ProviderType::HttpStream
    }

    fn name(&self) -> String {
        self.base.name.clone()
    }

    fn as_any(&self) -> &dyn std::any::Any {
        self
    }
}

impl StreamableHttpProvider {
    /// Construct a streaming HTTP provider pointing at a base URL.
    pub fn new(name: String, url: String, auth: Option<AuthConfig>) -> Self {
        Self {
            base: BaseProvider {
                name,
                provider_type: ProviderType::HttpStream,
                auth,
                allowed_communication_protocols: None,
            },
            url,
            http_method: Self::default_method(),
            headers: None,
        }
    }

    fn default_method() -> String {
        "POST".to_string()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[test]
    fn streamable_http_provider_defaults_to_post() {
        let json = json!({
            "name": "test-http-stream",
            "provider_type": "http_stream",
            "url": "https://example.com/stream"
        });

        let provider: StreamableHttpProvider = serde_json::from_value(json).unwrap();
        assert_eq!(provider.base.name, "test-http-stream");
        assert_eq!(provider.http_method, "POST");
        assert!(provider.headers.is_none());
    }

    #[test]
    fn streamable_http_provider_accepts_method_and_headers() {
        let json = json!({
            "name": "test-http-stream-full",
            "provider_type": "http_stream",
            "url": "https://example.com/stream",
            "http_method": "PUT",
            "headers": {
                "Authorization": "Bearer token"
            }
        });

        let provider: StreamableHttpProvider = serde_json::from_value(json).unwrap();
        assert_eq!(provider.http_method, "PUT");
        assert_eq!(
            provider
                .headers
                .unwrap()
                .get("Authorization")
                .map(|s| s.as_str()),
            Some("Bearer token")
        );
    }

    #[test]
    fn streamable_http_provider_new_sets_defaults() {
        let provider = StreamableHttpProvider::new(
            "new-http-stream".to_string(),
            "https://example.com".to_string(),
            None,
        );

        assert_eq!(provider.base.provider_type, ProviderType::HttpStream);
        assert_eq!(provider.http_method, "POST");
        assert!(provider.headers.is_none());
    }
}