spikard 0.3.2 → 0.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (180) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +659 -659
  4. data/ext/spikard_rb/Cargo.toml +17 -17
  5. data/ext/spikard_rb/extconf.rb +10 -10
  6. data/ext/spikard_rb/src/lib.rs +6 -6
  7. data/lib/spikard/app.rb +386 -386
  8. data/lib/spikard/background.rb +27 -27
  9. data/lib/spikard/config.rb +396 -396
  10. data/lib/spikard/converters.rb +13 -13
  11. data/lib/spikard/handler_wrapper.rb +113 -113
  12. data/lib/spikard/provide.rb +214 -214
  13. data/lib/spikard/response.rb +173 -173
  14. data/lib/spikard/schema.rb +243 -243
  15. data/lib/spikard/sse.rb +111 -111
  16. data/lib/spikard/streaming_response.rb +44 -44
  17. data/lib/spikard/testing.rb +221 -221
  18. data/lib/spikard/upload_file.rb +131 -131
  19. data/lib/spikard/version.rb +5 -5
  20. data/lib/spikard/websocket.rb +59 -59
  21. data/lib/spikard.rb +43 -43
  22. data/sig/spikard.rbs +360 -360
  23. data/vendor/crates/spikard-core/Cargo.toml +40 -40
  24. data/vendor/crates/spikard-core/src/bindings/mod.rs +3 -3
  25. data/vendor/crates/spikard-core/src/bindings/response.rs +133 -133
  26. data/vendor/crates/spikard-core/src/debug.rs +63 -63
  27. data/vendor/crates/spikard-core/src/di/container.rs +726 -726
  28. data/vendor/crates/spikard-core/src/di/dependency.rs +273 -273
  29. data/vendor/crates/spikard-core/src/di/error.rs +118 -118
  30. data/vendor/crates/spikard-core/src/di/factory.rs +538 -538
  31. data/vendor/crates/spikard-core/src/di/graph.rs +545 -545
  32. data/vendor/crates/spikard-core/src/di/mod.rs +192 -192
  33. data/vendor/crates/spikard-core/src/di/resolved.rs +411 -411
  34. data/vendor/crates/spikard-core/src/di/value.rs +283 -283
  35. data/vendor/crates/spikard-core/src/errors.rs +39 -39
  36. data/vendor/crates/spikard-core/src/http.rs +153 -153
  37. data/vendor/crates/spikard-core/src/lib.rs +29 -29
  38. data/vendor/crates/spikard-core/src/lifecycle.rs +422 -422
  39. data/vendor/crates/spikard-core/src/parameters.rs +722 -722
  40. data/vendor/crates/spikard-core/src/problem.rs +310 -310
  41. data/vendor/crates/spikard-core/src/request_data.rs +189 -189
  42. data/vendor/crates/spikard-core/src/router.rs +249 -249
  43. data/vendor/crates/spikard-core/src/schema_registry.rs +183 -183
  44. data/vendor/crates/spikard-core/src/type_hints.rs +304 -304
  45. data/vendor/crates/spikard-core/src/validation.rs +699 -699
  46. data/vendor/crates/spikard-http/Cargo.toml +58 -58
  47. data/vendor/crates/spikard-http/src/auth.rs +247 -247
  48. data/vendor/crates/spikard-http/src/background.rs +249 -249
  49. data/vendor/crates/spikard-http/src/bindings/mod.rs +3 -3
  50. data/vendor/crates/spikard-http/src/bindings/response.rs +1 -1
  51. data/vendor/crates/spikard-http/src/body_metadata.rs +8 -8
  52. data/vendor/crates/spikard-http/src/cors.rs +490 -490
  53. data/vendor/crates/spikard-http/src/debug.rs +63 -63
  54. data/vendor/crates/spikard-http/src/di_handler.rs +423 -423
  55. data/vendor/crates/spikard-http/src/handler_response.rs +190 -190
  56. data/vendor/crates/spikard-http/src/handler_trait.rs +228 -228
  57. data/vendor/crates/spikard-http/src/handler_trait_tests.rs +284 -284
  58. data/vendor/crates/spikard-http/src/lib.rs +529 -529
  59. data/vendor/crates/spikard-http/src/lifecycle/adapter.rs +149 -149
  60. data/vendor/crates/spikard-http/src/lifecycle.rs +428 -428
  61. data/vendor/crates/spikard-http/src/middleware/mod.rs +285 -285
  62. data/vendor/crates/spikard-http/src/middleware/multipart.rs +86 -86
  63. data/vendor/crates/spikard-http/src/middleware/urlencoded.rs +147 -147
  64. data/vendor/crates/spikard-http/src/middleware/validation.rs +287 -287
  65. data/vendor/crates/spikard-http/src/openapi/mod.rs +309 -309
  66. data/vendor/crates/spikard-http/src/openapi/parameter_extraction.rs +190 -190
  67. data/vendor/crates/spikard-http/src/openapi/schema_conversion.rs +308 -308
  68. data/vendor/crates/spikard-http/src/openapi/spec_generation.rs +195 -195
  69. data/vendor/crates/spikard-http/src/parameters.rs +1 -1
  70. data/vendor/crates/spikard-http/src/problem.rs +1 -1
  71. data/vendor/crates/spikard-http/src/query_parser.rs +369 -369
  72. data/vendor/crates/spikard-http/src/response.rs +399 -399
  73. data/vendor/crates/spikard-http/src/router.rs +1 -1
  74. data/vendor/crates/spikard-http/src/schema_registry.rs +1 -1
  75. data/vendor/crates/spikard-http/src/server/handler.rs +87 -87
  76. data/vendor/crates/spikard-http/src/server/lifecycle_execution.rs +98 -98
  77. data/vendor/crates/spikard-http/src/server/mod.rs +805 -805
  78. data/vendor/crates/spikard-http/src/server/request_extraction.rs +119 -119
  79. data/vendor/crates/spikard-http/src/sse.rs +447 -447
  80. data/vendor/crates/spikard-http/src/testing/form.rs +14 -14
  81. data/vendor/crates/spikard-http/src/testing/multipart.rs +60 -60
  82. data/vendor/crates/spikard-http/src/testing/test_client.rs +285 -285
  83. data/vendor/crates/spikard-http/src/testing.rs +377 -377
  84. data/vendor/crates/spikard-http/src/type_hints.rs +1 -1
  85. data/vendor/crates/spikard-http/src/validation.rs +1 -1
  86. data/vendor/crates/spikard-http/src/websocket.rs +324 -324
  87. data/vendor/crates/spikard-rb/Cargo.toml +42 -42
  88. data/vendor/crates/spikard-rb/build.rs +8 -8
  89. data/vendor/crates/spikard-rb/src/background.rs +63 -63
  90. data/vendor/crates/spikard-rb/src/config.rs +294 -294
  91. data/vendor/crates/spikard-rb/src/conversion.rs +453 -453
  92. data/vendor/crates/spikard-rb/src/di.rs +409 -409
  93. data/vendor/crates/spikard-rb/src/handler.rs +625 -625
  94. data/vendor/crates/spikard-rb/src/lib.rs +2771 -2771
  95. data/vendor/crates/spikard-rb/src/lifecycle.rs +274 -274
  96. data/vendor/crates/spikard-rb/src/server.rs +283 -283
  97. data/vendor/crates/spikard-rb/src/sse.rs +231 -231
  98. data/vendor/crates/spikard-rb/src/test_client.rs +404 -404
  99. data/vendor/crates/spikard-rb/src/test_sse.rs +143 -143
  100. data/vendor/crates/spikard-rb/src/test_websocket.rs +221 -221
  101. data/vendor/crates/spikard-rb/src/websocket.rs +233 -233
  102. data/vendor/spikard-core/Cargo.toml +40 -40
  103. data/vendor/spikard-core/src/bindings/mod.rs +3 -3
  104. data/vendor/spikard-core/src/bindings/response.rs +133 -133
  105. data/vendor/spikard-core/src/debug.rs +63 -63
  106. data/vendor/spikard-core/src/di/container.rs +726 -726
  107. data/vendor/spikard-core/src/di/dependency.rs +273 -273
  108. data/vendor/spikard-core/src/di/error.rs +118 -118
  109. data/vendor/spikard-core/src/di/factory.rs +538 -538
  110. data/vendor/spikard-core/src/di/graph.rs +545 -545
  111. data/vendor/spikard-core/src/di/mod.rs +192 -192
  112. data/vendor/spikard-core/src/di/resolved.rs +411 -411
  113. data/vendor/spikard-core/src/di/value.rs +283 -283
  114. data/vendor/spikard-core/src/http.rs +153 -153
  115. data/vendor/spikard-core/src/lib.rs +28 -28
  116. data/vendor/spikard-core/src/lifecycle.rs +422 -422
  117. data/vendor/spikard-core/src/parameters.rs +719 -719
  118. data/vendor/spikard-core/src/problem.rs +310 -310
  119. data/vendor/spikard-core/src/request_data.rs +189 -189
  120. data/vendor/spikard-core/src/router.rs +249 -249
  121. data/vendor/spikard-core/src/schema_registry.rs +183 -183
  122. data/vendor/spikard-core/src/type_hints.rs +304 -304
  123. data/vendor/spikard-core/src/validation.rs +699 -699
  124. data/vendor/spikard-http/Cargo.toml +58 -58
  125. data/vendor/spikard-http/src/auth.rs +247 -247
  126. data/vendor/spikard-http/src/background.rs +249 -249
  127. data/vendor/spikard-http/src/bindings/mod.rs +3 -3
  128. data/vendor/spikard-http/src/bindings/response.rs +1 -1
  129. data/vendor/spikard-http/src/body_metadata.rs +8 -8
  130. data/vendor/spikard-http/src/cors.rs +490 -490
  131. data/vendor/spikard-http/src/debug.rs +63 -63
  132. data/vendor/spikard-http/src/di_handler.rs +423 -423
  133. data/vendor/spikard-http/src/handler_response.rs +190 -190
  134. data/vendor/spikard-http/src/handler_trait.rs +228 -228
  135. data/vendor/spikard-http/src/handler_trait_tests.rs +284 -284
  136. data/vendor/spikard-http/src/lib.rs +529 -529
  137. data/vendor/spikard-http/src/lifecycle/adapter.rs +149 -149
  138. data/vendor/spikard-http/src/lifecycle.rs +428 -428
  139. data/vendor/spikard-http/src/middleware/mod.rs +285 -285
  140. data/vendor/spikard-http/src/middleware/multipart.rs +86 -86
  141. data/vendor/spikard-http/src/middleware/urlencoded.rs +147 -147
  142. data/vendor/spikard-http/src/middleware/validation.rs +287 -287
  143. data/vendor/spikard-http/src/openapi/mod.rs +309 -309
  144. data/vendor/spikard-http/src/openapi/parameter_extraction.rs +190 -190
  145. data/vendor/spikard-http/src/openapi/schema_conversion.rs +308 -308
  146. data/vendor/spikard-http/src/openapi/spec_generation.rs +195 -195
  147. data/vendor/spikard-http/src/parameters.rs +1 -1
  148. data/vendor/spikard-http/src/problem.rs +1 -1
  149. data/vendor/spikard-http/src/query_parser.rs +369 -369
  150. data/vendor/spikard-http/src/response.rs +399 -399
  151. data/vendor/spikard-http/src/router.rs +1 -1
  152. data/vendor/spikard-http/src/schema_registry.rs +1 -1
  153. data/vendor/spikard-http/src/server/handler.rs +80 -80
  154. data/vendor/spikard-http/src/server/lifecycle_execution.rs +98 -98
  155. data/vendor/spikard-http/src/server/mod.rs +805 -805
  156. data/vendor/spikard-http/src/server/request_extraction.rs +119 -119
  157. data/vendor/spikard-http/src/sse.rs +447 -447
  158. data/vendor/spikard-http/src/testing/form.rs +14 -14
  159. data/vendor/spikard-http/src/testing/multipart.rs +60 -60
  160. data/vendor/spikard-http/src/testing/test_client.rs +285 -285
  161. data/vendor/spikard-http/src/testing.rs +377 -377
  162. data/vendor/spikard-http/src/type_hints.rs +1 -1
  163. data/vendor/spikard-http/src/validation.rs +1 -1
  164. data/vendor/spikard-http/src/websocket.rs +324 -324
  165. data/vendor/spikard-rb/Cargo.toml +42 -42
  166. data/vendor/spikard-rb/build.rs +8 -8
  167. data/vendor/spikard-rb/src/background.rs +63 -63
  168. data/vendor/spikard-rb/src/config.rs +294 -294
  169. data/vendor/spikard-rb/src/conversion.rs +392 -392
  170. data/vendor/spikard-rb/src/di.rs +409 -409
  171. data/vendor/spikard-rb/src/handler.rs +534 -534
  172. data/vendor/spikard-rb/src/lib.rs +2020 -2020
  173. data/vendor/spikard-rb/src/lifecycle.rs +267 -267
  174. data/vendor/spikard-rb/src/server.rs +283 -283
  175. data/vendor/spikard-rb/src/sse.rs +231 -231
  176. data/vendor/spikard-rb/src/test_client.rs +404 -404
  177. data/vendor/spikard-rb/src/test_sse.rs +143 -143
  178. data/vendor/spikard-rb/src/test_websocket.rs +221 -221
  179. data/vendor/spikard-rb/src/websocket.rs +233 -233
  180. metadata +1 -1
@@ -1,404 +1,404 @@
1
- //! Native Ruby test client for HTTP testing.
2
- //!
3
- //! This module implements `NativeTestClient`, a wrapped Ruby class that provides
4
- //! HTTP testing capabilities against a Spikard server. It manages test servers
5
- //! for both HTTP and WebSocket/SSE transports.
6
-
7
- #![allow(dead_code)]
8
-
9
- use axum::http::Method;
10
- use axum_test::{TestServer, TestServerConfig, Transport};
11
- use bytes::Bytes;
12
- use cookie::Cookie;
13
- use magnus::prelude::*;
14
- use magnus::{Error, RHash, Ruby, Value, gc::Marker};
15
- use serde_json::Value as JsonValue;
16
- use spikard_http::testing::{
17
- MultipartFilePart, SnapshotError, build_multipart_body, encode_urlencoded_body, snapshot_response,
18
- };
19
- use spikard_http::{Route, RouteMetadata};
20
- use std::cell::RefCell;
21
- use std::collections::HashMap;
22
- use std::sync::Arc;
23
-
24
- use crate::conversion::{parse_request_config, response_to_ruby};
25
- use crate::handler::RubyHandler;
26
- use crate::server::GLOBAL_RUNTIME;
27
-
28
- /// Request configuration built from Ruby options hash.
29
- pub struct RequestConfig {
30
- pub query: Option<JsonValue>,
31
- pub headers: HashMap<String, String>,
32
- pub cookies: HashMap<String, String>,
33
- pub body: Option<RequestBody>,
34
- }
35
-
36
- /// HTTP request body variants.
37
- pub enum RequestBody {
38
- Json(JsonValue),
39
- Form(JsonValue),
40
- Raw(String),
41
- Multipart {
42
- form_data: Vec<(String, String)>,
43
- files: Vec<MultipartFilePart>,
44
- },
45
- }
46
-
47
- /// Snapshot of an HTTP response.
48
- pub struct TestResponseData {
49
- pub status: u16,
50
- pub headers: HashMap<String, String>,
51
- pub body_text: Option<String>,
52
- }
53
-
54
- /// Error wrapper for native request failures.
55
- #[derive(Debug)]
56
- pub struct NativeRequestError(pub String);
57
-
58
- /// Inner client state containing the test servers and handlers.
59
- pub struct ClientInner {
60
- pub http_server: Arc<TestServer>,
61
- pub transport_server: Arc<TestServer>,
62
- /// Keep Ruby handler closures alive for GC; accessed via the `mark` hook.
63
- #[allow(dead_code)]
64
- pub handlers: Vec<RubyHandler>,
65
- }
66
-
67
- /// Native Ruby TestClient wrapper for integration testing.
68
- ///
69
- /// Wraps an optional `ClientInner` that holds the HTTP test servers
70
- /// and keeps handler references alive for Ruby's garbage collector.
71
- #[derive(Default)]
72
- #[magnus::wrap(class = "Spikard::Native::TestClient", free_immediately, mark)]
73
- pub struct NativeTestClient {
74
- pub inner: RefCell<Option<ClientInner>>,
75
- }
76
-
77
- impl NativeTestClient {
78
- /// Initialize the test client with routes, handlers, and server config.
79
- ///
80
- /// # Arguments
81
- ///
82
- /// * `ruby` - Ruby VM reference
83
- /// * `this` - The wrapped NativeTestClient instance
84
- /// * `routes_json` - JSON string containing route metadata
85
- /// * `handlers` - Ruby Hash mapping handler_name => Proc
86
- /// * `config_value` - Ruby ServerConfig object
87
- /// * `ws_handlers` - Ruby Hash of WebSocket handlers (optional)
88
- /// * `sse_producers` - Ruby Hash of SSE producers (optional)
89
- pub fn initialize(
90
- ruby: &Ruby,
91
- this: &Self,
92
- routes_json: String,
93
- handlers: Value,
94
- config_value: Value,
95
- ws_handlers: Value,
96
- sse_producers: Value,
97
- ) -> Result<(), Error> {
98
- let metadata: Vec<RouteMetadata> = serde_json::from_str(&routes_json)
99
- .map_err(|err| Error::new(ruby.exception_arg_error(), format!("Invalid routes JSON: {err}")))?;
100
-
101
- let handlers_hash = RHash::from_value(handlers).ok_or_else(|| {
102
- Error::new(
103
- ruby.exception_arg_error(),
104
- "handlers parameter must be a Hash of handler_name => Proc",
105
- )
106
- })?;
107
-
108
- let json_module = ruby
109
- .class_object()
110
- .const_get("JSON")
111
- .map_err(|_| Error::new(ruby.exception_runtime_error(), "JSON module not available"))?;
112
-
113
- let server_config = crate::config::extract_server_config(ruby, config_value)?;
114
-
115
- let schema_registry = spikard_http::SchemaRegistry::new();
116
- let mut prepared_routes = Vec::with_capacity(metadata.len());
117
- let mut handler_refs = Vec::with_capacity(metadata.len());
118
- let mut route_metadata_vec = Vec::with_capacity(metadata.len());
119
-
120
- for meta in metadata.clone() {
121
- let handler_value = crate::conversion::fetch_handler(ruby, &handlers_hash, &meta.handler_name)?;
122
- let route = Route::from_metadata(meta.clone(), &schema_registry)
123
- .map_err(|err| Error::new(ruby.exception_runtime_error(), format!("Failed to build route: {err}")))?;
124
-
125
- let handler = RubyHandler::new(&route, handler_value, json_module)?;
126
- prepared_routes.push((route, Arc::new(handler.clone()) as Arc<dyn spikard_http::Handler>));
127
- handler_refs.push(handler);
128
- route_metadata_vec.push(meta);
129
- }
130
-
131
- let mut router = spikard_http::server::build_router_with_handlers_and_config(
132
- prepared_routes,
133
- server_config,
134
- route_metadata_vec,
135
- )
136
- .map_err(|err| Error::new(ruby.exception_runtime_error(), format!("Failed to build router: {err}")))?;
137
-
138
- let mut ws_endpoints = Vec::new();
139
- if !ws_handlers.is_nil() {
140
- let ws_hash = RHash::from_value(ws_handlers)
141
- .ok_or_else(|| Error::new(ruby.exception_arg_error(), "WebSocket handlers must be a Hash"))?;
142
-
143
- ws_hash.foreach(
144
- |path: String, factory: Value| -> Result<magnus::r_hash::ForEach, Error> {
145
- let handler_instance = factory.funcall::<_, _, Value>("call", ()).map_err(|e| {
146
- Error::new(
147
- ruby.exception_runtime_error(),
148
- format!("Failed to create WebSocket handler: {}", e),
149
- )
150
- })?;
151
-
152
- let ws_state = crate::websocket::create_websocket_state(ruby, handler_instance)?;
153
-
154
- ws_endpoints.push((path, ws_state));
155
-
156
- Ok(magnus::r_hash::ForEach::Continue)
157
- },
158
- )?;
159
- }
160
-
161
- let mut sse_endpoints = Vec::new();
162
- if !sse_producers.is_nil() {
163
- let sse_hash = RHash::from_value(sse_producers)
164
- .ok_or_else(|| Error::new(ruby.exception_arg_error(), "SSE producers must be a Hash"))?;
165
-
166
- sse_hash.foreach(
167
- |path: String, factory: Value| -> Result<magnus::r_hash::ForEach, Error> {
168
- let producer_instance = factory.funcall::<_, _, Value>("call", ()).map_err(|e| {
169
- Error::new(
170
- ruby.exception_runtime_error(),
171
- format!("Failed to create SSE producer: {}", e),
172
- )
173
- })?;
174
-
175
- let sse_state = crate::sse::create_sse_state(ruby, producer_instance)?;
176
-
177
- sse_endpoints.push((path, sse_state));
178
-
179
- Ok(magnus::r_hash::ForEach::Continue)
180
- },
181
- )?;
182
- }
183
-
184
- use axum::routing::get;
185
- for (path, ws_state) in ws_endpoints {
186
- router = router.route(
187
- &path,
188
- get(spikard_http::websocket_handler::<crate::websocket::RubyWebSocketHandler>).with_state(ws_state),
189
- );
190
- }
191
-
192
- for (path, sse_state) in sse_endpoints {
193
- router = router.route(
194
- &path,
195
- get(spikard_http::sse_handler::<crate::sse::RubySseEventProducer>).with_state(sse_state),
196
- );
197
- }
198
-
199
- let http_server = GLOBAL_RUNTIME
200
- .block_on(async { TestServer::new(router.clone()) })
201
- .map_err(|err| {
202
- Error::new(
203
- ruby.exception_runtime_error(),
204
- format!("Failed to initialise test server: {err}"),
205
- )
206
- })?;
207
-
208
- let ws_config = TestServerConfig {
209
- transport: Some(Transport::HttpRandomPort),
210
- ..Default::default()
211
- };
212
- let transport_server = GLOBAL_RUNTIME
213
- .block_on(async { TestServer::new_with_config(router, ws_config) })
214
- .map_err(|err| {
215
- Error::new(
216
- ruby.exception_runtime_error(),
217
- format!("Failed to initialise WebSocket transport server: {err}"),
218
- )
219
- })?;
220
-
221
- *this.inner.borrow_mut() = Some(ClientInner {
222
- http_server: Arc::new(http_server),
223
- transport_server: Arc::new(transport_server),
224
- handlers: handler_refs,
225
- });
226
-
227
- Ok(())
228
- }
229
-
230
- /// Execute an HTTP request against the test server.
231
- ///
232
- /// # Arguments
233
- ///
234
- /// * `ruby` - Ruby VM reference
235
- /// * `this` - The wrapped NativeTestClient instance
236
- /// * `method` - HTTP method (GET, POST, etc.)
237
- /// * `path` - URL path
238
- /// * `options` - Ruby Hash with query, headers, cookies, body, etc.
239
- pub fn request(ruby: &Ruby, this: &Self, method: String, path: String, options: Value) -> Result<Value, Error> {
240
- let inner_borrow = this.inner.borrow();
241
- let inner = inner_borrow
242
- .as_ref()
243
- .ok_or_else(|| Error::new(ruby.exception_runtime_error(), "TestClient not initialised"))?;
244
- let method_upper = method.to_ascii_uppercase();
245
- let http_method = Method::from_bytes(method_upper.as_bytes()).map_err(|err| {
246
- Error::new(
247
- ruby.exception_arg_error(),
248
- format!("Unsupported method {method_upper}: {err}"),
249
- )
250
- })?;
251
-
252
- let request_config = parse_request_config(ruby, options)?;
253
-
254
- let response = GLOBAL_RUNTIME
255
- .block_on(execute_request(
256
- inner.http_server.clone(),
257
- http_method,
258
- path.clone(),
259
- request_config,
260
- ))
261
- .map_err(|err| {
262
- Error::new(
263
- ruby.exception_runtime_error(),
264
- format!("Request failed for {method_upper} {path}: {}", err.0),
265
- )
266
- })?;
267
-
268
- response_to_ruby(ruby, response)
269
- }
270
-
271
- /// Close the test client and clean up resources.
272
- pub fn close(&self) -> Result<(), Error> {
273
- *self.inner.borrow_mut() = None;
274
- Ok(())
275
- }
276
-
277
- /// Connect to a WebSocket endpoint on the test server.
278
- pub fn websocket(ruby: &Ruby, this: &Self, path: String) -> Result<Value, Error> {
279
- let inner_borrow = this.inner.borrow();
280
- let inner = inner_borrow
281
- .as_ref()
282
- .ok_or_else(|| Error::new(ruby.exception_runtime_error(), "TestClient not initialised"))?;
283
-
284
- let server = Arc::clone(&inner.transport_server);
285
-
286
- drop(inner_borrow);
287
-
288
- let handle =
289
- GLOBAL_RUNTIME.spawn(async move { spikard_http::testing::connect_websocket(&server, &path).await });
290
-
291
- let ws = GLOBAL_RUNTIME.block_on(async {
292
- handle
293
- .await
294
- .map_err(|e| Error::new(ruby.exception_runtime_error(), format!("WebSocket task failed: {}", e)))
295
- })?;
296
-
297
- let ws_conn = crate::test_websocket::WebSocketTestConnection::new(ws);
298
- Ok(ruby.obj_wrap(ws_conn).as_value())
299
- }
300
-
301
- /// Connect to an SSE endpoint on the test server.
302
- pub fn sse(ruby: &Ruby, this: &Self, path: String) -> Result<Value, Error> {
303
- let inner_borrow = this.inner.borrow();
304
- let inner = inner_borrow
305
- .as_ref()
306
- .ok_or_else(|| Error::new(ruby.exception_runtime_error(), "TestClient not initialised"))?;
307
-
308
- let response = GLOBAL_RUNTIME
309
- .block_on(async {
310
- let axum_response = inner.transport_server.get(&path).await;
311
- snapshot_response(axum_response).await
312
- })
313
- .map_err(|e| Error::new(ruby.exception_runtime_error(), format!("SSE request failed: {}", e)))?;
314
-
315
- crate::test_sse::sse_stream_from_response(ruby, &response)
316
- }
317
-
318
- /// GC mark hook so Ruby keeps handler closures alive.
319
- #[allow(dead_code)]
320
- pub fn mark(&self, marker: &Marker) {
321
- let inner_ref = self.inner.borrow();
322
- if let Some(inner) = inner_ref.as_ref() {
323
- for handler in &inner.handlers {
324
- handler.mark(marker);
325
- }
326
- }
327
- }
328
- }
329
-
330
- /// Execute an HTTP request against a test server.
331
- ///
332
- /// Handles method routing, query params, headers, cookies, and various body formats.
333
- pub async fn execute_request(
334
- server: Arc<TestServer>,
335
- method: Method,
336
- path: String,
337
- config: RequestConfig,
338
- ) -> Result<TestResponseData, NativeRequestError> {
339
- let mut request = match method {
340
- Method::GET => server.get(&path),
341
- Method::POST => server.post(&path),
342
- Method::PUT => server.put(&path),
343
- Method::PATCH => server.patch(&path),
344
- Method::DELETE => server.delete(&path),
345
- Method::HEAD => server.method(Method::HEAD, &path),
346
- Method::OPTIONS => server.method(Method::OPTIONS, &path),
347
- Method::TRACE => server.method(Method::TRACE, &path),
348
- other => return Err(NativeRequestError(format!("Unsupported HTTP method {other}"))),
349
- };
350
-
351
- if let Some(query) = config.query {
352
- request = request.add_query_params(&query);
353
- }
354
-
355
- for (name, value) in config.headers {
356
- request = request.add_header(name.as_str(), value.as_str());
357
- }
358
-
359
- for (name, value) in config.cookies {
360
- request = request.add_cookie(Cookie::new(name, value));
361
- }
362
-
363
- if let Some(body) = config.body {
364
- match body {
365
- RequestBody::Json(json_value) => {
366
- request = request.json(&json_value);
367
- }
368
- RequestBody::Form(form_value) => {
369
- let encoded = encode_urlencoded_body(&form_value)
370
- .map_err(|err| NativeRequestError(format!("Failed to encode form body: {err}")))?;
371
- request = request
372
- .content_type("application/x-www-form-urlencoded")
373
- .bytes(Bytes::from(encoded));
374
- }
375
- RequestBody::Raw(raw) => {
376
- request = request.bytes(Bytes::from(raw));
377
- }
378
- RequestBody::Multipart { form_data, files } => {
379
- let (multipart_body, boundary) = build_multipart_body(&form_data, &files);
380
- request = request
381
- .content_type(&format!("multipart/form-data; boundary={}", boundary))
382
- .bytes(Bytes::from(multipart_body));
383
- }
384
- }
385
- }
386
-
387
- let response = request.await;
388
- let snapshot = snapshot_response(response).await.map_err(snapshot_err_to_native)?;
389
- let body_text = if snapshot.body.is_empty() {
390
- None
391
- } else {
392
- Some(String::from_utf8_lossy(&snapshot.body).into_owned())
393
- };
394
-
395
- Ok(TestResponseData {
396
- status: snapshot.status,
397
- headers: snapshot.headers,
398
- body_text,
399
- })
400
- }
401
-
402
- fn snapshot_err_to_native(err: SnapshotError) -> NativeRequestError {
403
- NativeRequestError(err.to_string())
404
- }
1
+ //! Native Ruby test client for HTTP testing.
2
+ //!
3
+ //! This module implements `NativeTestClient`, a wrapped Ruby class that provides
4
+ //! HTTP testing capabilities against a Spikard server. It manages test servers
5
+ //! for both HTTP and WebSocket/SSE transports.
6
+
7
+ #![allow(dead_code)]
8
+
9
+ use axum::http::Method;
10
+ use axum_test::{TestServer, TestServerConfig, Transport};
11
+ use bytes::Bytes;
12
+ use cookie::Cookie;
13
+ use magnus::prelude::*;
14
+ use magnus::{Error, RHash, Ruby, Value, gc::Marker};
15
+ use serde_json::Value as JsonValue;
16
+ use spikard_http::testing::{
17
+ MultipartFilePart, SnapshotError, build_multipart_body, encode_urlencoded_body, snapshot_response,
18
+ };
19
+ use spikard_http::{Route, RouteMetadata};
20
+ use std::cell::RefCell;
21
+ use std::collections::HashMap;
22
+ use std::sync::Arc;
23
+
24
+ use crate::conversion::{parse_request_config, response_to_ruby};
25
+ use crate::handler::RubyHandler;
26
+ use crate::server::GLOBAL_RUNTIME;
27
+
28
+ /// Request configuration built from Ruby options hash.
29
+ pub struct RequestConfig {
30
+ pub query: Option<JsonValue>,
31
+ pub headers: HashMap<String, String>,
32
+ pub cookies: HashMap<String, String>,
33
+ pub body: Option<RequestBody>,
34
+ }
35
+
36
+ /// HTTP request body variants.
37
+ pub enum RequestBody {
38
+ Json(JsonValue),
39
+ Form(JsonValue),
40
+ Raw(String),
41
+ Multipart {
42
+ form_data: Vec<(String, String)>,
43
+ files: Vec<MultipartFilePart>,
44
+ },
45
+ }
46
+
47
+ /// Snapshot of an HTTP response.
48
+ pub struct TestResponseData {
49
+ pub status: u16,
50
+ pub headers: HashMap<String, String>,
51
+ pub body_text: Option<String>,
52
+ }
53
+
54
+ /// Error wrapper for native request failures.
55
+ #[derive(Debug)]
56
+ pub struct NativeRequestError(pub String);
57
+
58
+ /// Inner client state containing the test servers and handlers.
59
+ pub struct ClientInner {
60
+ pub http_server: Arc<TestServer>,
61
+ pub transport_server: Arc<TestServer>,
62
+ /// Keep Ruby handler closures alive for GC; accessed via the `mark` hook.
63
+ #[allow(dead_code)]
64
+ pub handlers: Vec<RubyHandler>,
65
+ }
66
+
67
+ /// Native Ruby TestClient wrapper for integration testing.
68
+ ///
69
+ /// Wraps an optional `ClientInner` that holds the HTTP test servers
70
+ /// and keeps handler references alive for Ruby's garbage collector.
71
+ #[derive(Default)]
72
+ #[magnus::wrap(class = "Spikard::Native::TestClient", free_immediately, mark)]
73
+ pub struct NativeTestClient {
74
+ pub inner: RefCell<Option<ClientInner>>,
75
+ }
76
+
77
+ impl NativeTestClient {
78
+ /// Initialize the test client with routes, handlers, and server config.
79
+ ///
80
+ /// # Arguments
81
+ ///
82
+ /// * `ruby` - Ruby VM reference
83
+ /// * `this` - The wrapped NativeTestClient instance
84
+ /// * `routes_json` - JSON string containing route metadata
85
+ /// * `handlers` - Ruby Hash mapping handler_name => Proc
86
+ /// * `config_value` - Ruby ServerConfig object
87
+ /// * `ws_handlers` - Ruby Hash of WebSocket handlers (optional)
88
+ /// * `sse_producers` - Ruby Hash of SSE producers (optional)
89
+ pub fn initialize(
90
+ ruby: &Ruby,
91
+ this: &Self,
92
+ routes_json: String,
93
+ handlers: Value,
94
+ config_value: Value,
95
+ ws_handlers: Value,
96
+ sse_producers: Value,
97
+ ) -> Result<(), Error> {
98
+ let metadata: Vec<RouteMetadata> = serde_json::from_str(&routes_json)
99
+ .map_err(|err| Error::new(ruby.exception_arg_error(), format!("Invalid routes JSON: {err}")))?;
100
+
101
+ let handlers_hash = RHash::from_value(handlers).ok_or_else(|| {
102
+ Error::new(
103
+ ruby.exception_arg_error(),
104
+ "handlers parameter must be a Hash of handler_name => Proc",
105
+ )
106
+ })?;
107
+
108
+ let json_module = ruby
109
+ .class_object()
110
+ .const_get("JSON")
111
+ .map_err(|_| Error::new(ruby.exception_runtime_error(), "JSON module not available"))?;
112
+
113
+ let server_config = crate::config::extract_server_config(ruby, config_value)?;
114
+
115
+ let schema_registry = spikard_http::SchemaRegistry::new();
116
+ let mut prepared_routes = Vec::with_capacity(metadata.len());
117
+ let mut handler_refs = Vec::with_capacity(metadata.len());
118
+ let mut route_metadata_vec = Vec::with_capacity(metadata.len());
119
+
120
+ for meta in metadata.clone() {
121
+ let handler_value = crate::conversion::fetch_handler(ruby, &handlers_hash, &meta.handler_name)?;
122
+ let route = Route::from_metadata(meta.clone(), &schema_registry)
123
+ .map_err(|err| Error::new(ruby.exception_runtime_error(), format!("Failed to build route: {err}")))?;
124
+
125
+ let handler = RubyHandler::new(&route, handler_value, json_module)?;
126
+ prepared_routes.push((route, Arc::new(handler.clone()) as Arc<dyn spikard_http::Handler>));
127
+ handler_refs.push(handler);
128
+ route_metadata_vec.push(meta);
129
+ }
130
+
131
+ let mut router = spikard_http::server::build_router_with_handlers_and_config(
132
+ prepared_routes,
133
+ server_config,
134
+ route_metadata_vec,
135
+ )
136
+ .map_err(|err| Error::new(ruby.exception_runtime_error(), format!("Failed to build router: {err}")))?;
137
+
138
+ let mut ws_endpoints = Vec::new();
139
+ if !ws_handlers.is_nil() {
140
+ let ws_hash = RHash::from_value(ws_handlers)
141
+ .ok_or_else(|| Error::new(ruby.exception_arg_error(), "WebSocket handlers must be a Hash"))?;
142
+
143
+ ws_hash.foreach(
144
+ |path: String, factory: Value| -> Result<magnus::r_hash::ForEach, Error> {
145
+ let handler_instance = factory.funcall::<_, _, Value>("call", ()).map_err(|e| {
146
+ Error::new(
147
+ ruby.exception_runtime_error(),
148
+ format!("Failed to create WebSocket handler: {}", e),
149
+ )
150
+ })?;
151
+
152
+ let ws_state = crate::websocket::create_websocket_state(ruby, handler_instance)?;
153
+
154
+ ws_endpoints.push((path, ws_state));
155
+
156
+ Ok(magnus::r_hash::ForEach::Continue)
157
+ },
158
+ )?;
159
+ }
160
+
161
+ let mut sse_endpoints = Vec::new();
162
+ if !sse_producers.is_nil() {
163
+ let sse_hash = RHash::from_value(sse_producers)
164
+ .ok_or_else(|| Error::new(ruby.exception_arg_error(), "SSE producers must be a Hash"))?;
165
+
166
+ sse_hash.foreach(
167
+ |path: String, factory: Value| -> Result<magnus::r_hash::ForEach, Error> {
168
+ let producer_instance = factory.funcall::<_, _, Value>("call", ()).map_err(|e| {
169
+ Error::new(
170
+ ruby.exception_runtime_error(),
171
+ format!("Failed to create SSE producer: {}", e),
172
+ )
173
+ })?;
174
+
175
+ let sse_state = crate::sse::create_sse_state(ruby, producer_instance)?;
176
+
177
+ sse_endpoints.push((path, sse_state));
178
+
179
+ Ok(magnus::r_hash::ForEach::Continue)
180
+ },
181
+ )?;
182
+ }
183
+
184
+ use axum::routing::get;
185
+ for (path, ws_state) in ws_endpoints {
186
+ router = router.route(
187
+ &path,
188
+ get(spikard_http::websocket_handler::<crate::websocket::RubyWebSocketHandler>).with_state(ws_state),
189
+ );
190
+ }
191
+
192
+ for (path, sse_state) in sse_endpoints {
193
+ router = router.route(
194
+ &path,
195
+ get(spikard_http::sse_handler::<crate::sse::RubySseEventProducer>).with_state(sse_state),
196
+ );
197
+ }
198
+
199
+ let http_server = GLOBAL_RUNTIME
200
+ .block_on(async { TestServer::new(router.clone()) })
201
+ .map_err(|err| {
202
+ Error::new(
203
+ ruby.exception_runtime_error(),
204
+ format!("Failed to initialise test server: {err}"),
205
+ )
206
+ })?;
207
+
208
+ let ws_config = TestServerConfig {
209
+ transport: Some(Transport::HttpRandomPort),
210
+ ..Default::default()
211
+ };
212
+ let transport_server = GLOBAL_RUNTIME
213
+ .block_on(async { TestServer::new_with_config(router, ws_config) })
214
+ .map_err(|err| {
215
+ Error::new(
216
+ ruby.exception_runtime_error(),
217
+ format!("Failed to initialise WebSocket transport server: {err}"),
218
+ )
219
+ })?;
220
+
221
+ *this.inner.borrow_mut() = Some(ClientInner {
222
+ http_server: Arc::new(http_server),
223
+ transport_server: Arc::new(transport_server),
224
+ handlers: handler_refs,
225
+ });
226
+
227
+ Ok(())
228
+ }
229
+
230
+ /// Execute an HTTP request against the test server.
231
+ ///
232
+ /// # Arguments
233
+ ///
234
+ /// * `ruby` - Ruby VM reference
235
+ /// * `this` - The wrapped NativeTestClient instance
236
+ /// * `method` - HTTP method (GET, POST, etc.)
237
+ /// * `path` - URL path
238
+ /// * `options` - Ruby Hash with query, headers, cookies, body, etc.
239
+ pub fn request(ruby: &Ruby, this: &Self, method: String, path: String, options: Value) -> Result<Value, Error> {
240
+ let inner_borrow = this.inner.borrow();
241
+ let inner = inner_borrow
242
+ .as_ref()
243
+ .ok_or_else(|| Error::new(ruby.exception_runtime_error(), "TestClient not initialised"))?;
244
+ let method_upper = method.to_ascii_uppercase();
245
+ let http_method = Method::from_bytes(method_upper.as_bytes()).map_err(|err| {
246
+ Error::new(
247
+ ruby.exception_arg_error(),
248
+ format!("Unsupported method {method_upper}: {err}"),
249
+ )
250
+ })?;
251
+
252
+ let request_config = parse_request_config(ruby, options)?;
253
+
254
+ let response = GLOBAL_RUNTIME
255
+ .block_on(execute_request(
256
+ inner.http_server.clone(),
257
+ http_method,
258
+ path.clone(),
259
+ request_config,
260
+ ))
261
+ .map_err(|err| {
262
+ Error::new(
263
+ ruby.exception_runtime_error(),
264
+ format!("Request failed for {method_upper} {path}: {}", err.0),
265
+ )
266
+ })?;
267
+
268
+ response_to_ruby(ruby, response)
269
+ }
270
+
271
+ /// Close the test client and clean up resources.
272
+ pub fn close(&self) -> Result<(), Error> {
273
+ *self.inner.borrow_mut() = None;
274
+ Ok(())
275
+ }
276
+
277
+ /// Connect to a WebSocket endpoint on the test server.
278
+ pub fn websocket(ruby: &Ruby, this: &Self, path: String) -> Result<Value, Error> {
279
+ let inner_borrow = this.inner.borrow();
280
+ let inner = inner_borrow
281
+ .as_ref()
282
+ .ok_or_else(|| Error::new(ruby.exception_runtime_error(), "TestClient not initialised"))?;
283
+
284
+ let server = Arc::clone(&inner.transport_server);
285
+
286
+ drop(inner_borrow);
287
+
288
+ let handle =
289
+ GLOBAL_RUNTIME.spawn(async move { spikard_http::testing::connect_websocket(&server, &path).await });
290
+
291
+ let ws = GLOBAL_RUNTIME.block_on(async {
292
+ handle
293
+ .await
294
+ .map_err(|e| Error::new(ruby.exception_runtime_error(), format!("WebSocket task failed: {}", e)))
295
+ })?;
296
+
297
+ let ws_conn = crate::test_websocket::WebSocketTestConnection::new(ws);
298
+ Ok(ruby.obj_wrap(ws_conn).as_value())
299
+ }
300
+
301
+ /// Connect to an SSE endpoint on the test server.
302
+ pub fn sse(ruby: &Ruby, this: &Self, path: String) -> Result<Value, Error> {
303
+ let inner_borrow = this.inner.borrow();
304
+ let inner = inner_borrow
305
+ .as_ref()
306
+ .ok_or_else(|| Error::new(ruby.exception_runtime_error(), "TestClient not initialised"))?;
307
+
308
+ let response = GLOBAL_RUNTIME
309
+ .block_on(async {
310
+ let axum_response = inner.transport_server.get(&path).await;
311
+ snapshot_response(axum_response).await
312
+ })
313
+ .map_err(|e| Error::new(ruby.exception_runtime_error(), format!("SSE request failed: {}", e)))?;
314
+
315
+ crate::test_sse::sse_stream_from_response(ruby, &response)
316
+ }
317
+
318
+ /// GC mark hook so Ruby keeps handler closures alive.
319
+ #[allow(dead_code)]
320
+ pub fn mark(&self, marker: &Marker) {
321
+ let inner_ref = self.inner.borrow();
322
+ if let Some(inner) = inner_ref.as_ref() {
323
+ for handler in &inner.handlers {
324
+ handler.mark(marker);
325
+ }
326
+ }
327
+ }
328
+ }
329
+
330
+ /// Execute an HTTP request against a test server.
331
+ ///
332
+ /// Handles method routing, query params, headers, cookies, and various body formats.
333
+ pub async fn execute_request(
334
+ server: Arc<TestServer>,
335
+ method: Method,
336
+ path: String,
337
+ config: RequestConfig,
338
+ ) -> Result<TestResponseData, NativeRequestError> {
339
+ let mut request = match method {
340
+ Method::GET => server.get(&path),
341
+ Method::POST => server.post(&path),
342
+ Method::PUT => server.put(&path),
343
+ Method::PATCH => server.patch(&path),
344
+ Method::DELETE => server.delete(&path),
345
+ Method::HEAD => server.method(Method::HEAD, &path),
346
+ Method::OPTIONS => server.method(Method::OPTIONS, &path),
347
+ Method::TRACE => server.method(Method::TRACE, &path),
348
+ other => return Err(NativeRequestError(format!("Unsupported HTTP method {other}"))),
349
+ };
350
+
351
+ if let Some(query) = config.query {
352
+ request = request.add_query_params(&query);
353
+ }
354
+
355
+ for (name, value) in config.headers {
356
+ request = request.add_header(name.as_str(), value.as_str());
357
+ }
358
+
359
+ for (name, value) in config.cookies {
360
+ request = request.add_cookie(Cookie::new(name, value));
361
+ }
362
+
363
+ if let Some(body) = config.body {
364
+ match body {
365
+ RequestBody::Json(json_value) => {
366
+ request = request.json(&json_value);
367
+ }
368
+ RequestBody::Form(form_value) => {
369
+ let encoded = encode_urlencoded_body(&form_value)
370
+ .map_err(|err| NativeRequestError(format!("Failed to encode form body: {err}")))?;
371
+ request = request
372
+ .content_type("application/x-www-form-urlencoded")
373
+ .bytes(Bytes::from(encoded));
374
+ }
375
+ RequestBody::Raw(raw) => {
376
+ request = request.bytes(Bytes::from(raw));
377
+ }
378
+ RequestBody::Multipart { form_data, files } => {
379
+ let (multipart_body, boundary) = build_multipart_body(&form_data, &files);
380
+ request = request
381
+ .content_type(&format!("multipart/form-data; boundary={}", boundary))
382
+ .bytes(Bytes::from(multipart_body));
383
+ }
384
+ }
385
+ }
386
+
387
+ let response = request.await;
388
+ let snapshot = snapshot_response(response).await.map_err(snapshot_err_to_native)?;
389
+ let body_text = if snapshot.body.is_empty() {
390
+ None
391
+ } else {
392
+ Some(String::from_utf8_lossy(&snapshot.body).into_owned())
393
+ };
394
+
395
+ Ok(TestResponseData {
396
+ status: snapshot.status,
397
+ headers: snapshot.headers,
398
+ body_text,
399
+ })
400
+ }
401
+
402
+ fn snapshot_err_to_native(err: SnapshotError) -> NativeRequestError {
403
+ NativeRequestError(err.to_string())
404
+ }