spikard 0.3.4 → 0.3.6

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 +366 -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 +68 -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. metadata +1 -79
  103. data/vendor/spikard-core/Cargo.toml +0 -40
  104. data/vendor/spikard-core/src/bindings/mod.rs +0 -3
  105. data/vendor/spikard-core/src/bindings/response.rs +0 -133
  106. data/vendor/spikard-core/src/debug.rs +0 -63
  107. data/vendor/spikard-core/src/di/container.rs +0 -726
  108. data/vendor/spikard-core/src/di/dependency.rs +0 -273
  109. data/vendor/spikard-core/src/di/error.rs +0 -118
  110. data/vendor/spikard-core/src/di/factory.rs +0 -538
  111. data/vendor/spikard-core/src/di/graph.rs +0 -545
  112. data/vendor/spikard-core/src/di/mod.rs +0 -192
  113. data/vendor/spikard-core/src/di/resolved.rs +0 -411
  114. data/vendor/spikard-core/src/di/value.rs +0 -283
  115. data/vendor/spikard-core/src/http.rs +0 -153
  116. data/vendor/spikard-core/src/lib.rs +0 -28
  117. data/vendor/spikard-core/src/lifecycle.rs +0 -422
  118. data/vendor/spikard-core/src/parameters.rs +0 -719
  119. data/vendor/spikard-core/src/problem.rs +0 -310
  120. data/vendor/spikard-core/src/request_data.rs +0 -189
  121. data/vendor/spikard-core/src/router.rs +0 -249
  122. data/vendor/spikard-core/src/schema_registry.rs +0 -183
  123. data/vendor/spikard-core/src/type_hints.rs +0 -304
  124. data/vendor/spikard-core/src/validation.rs +0 -699
  125. data/vendor/spikard-http/Cargo.toml +0 -58
  126. data/vendor/spikard-http/src/auth.rs +0 -247
  127. data/vendor/spikard-http/src/background.rs +0 -249
  128. data/vendor/spikard-http/src/bindings/mod.rs +0 -3
  129. data/vendor/spikard-http/src/bindings/response.rs +0 -1
  130. data/vendor/spikard-http/src/body_metadata.rs +0 -8
  131. data/vendor/spikard-http/src/cors.rs +0 -490
  132. data/vendor/spikard-http/src/debug.rs +0 -63
  133. data/vendor/spikard-http/src/di_handler.rs +0 -423
  134. data/vendor/spikard-http/src/handler_response.rs +0 -190
  135. data/vendor/spikard-http/src/handler_trait.rs +0 -228
  136. data/vendor/spikard-http/src/handler_trait_tests.rs +0 -284
  137. data/vendor/spikard-http/src/lib.rs +0 -529
  138. data/vendor/spikard-http/src/lifecycle/adapter.rs +0 -149
  139. data/vendor/spikard-http/src/lifecycle.rs +0 -428
  140. data/vendor/spikard-http/src/middleware/mod.rs +0 -285
  141. data/vendor/spikard-http/src/middleware/multipart.rs +0 -86
  142. data/vendor/spikard-http/src/middleware/urlencoded.rs +0 -147
  143. data/vendor/spikard-http/src/middleware/validation.rs +0 -287
  144. data/vendor/spikard-http/src/openapi/mod.rs +0 -309
  145. data/vendor/spikard-http/src/openapi/parameter_extraction.rs +0 -190
  146. data/vendor/spikard-http/src/openapi/schema_conversion.rs +0 -308
  147. data/vendor/spikard-http/src/openapi/spec_generation.rs +0 -195
  148. data/vendor/spikard-http/src/parameters.rs +0 -1
  149. data/vendor/spikard-http/src/problem.rs +0 -1
  150. data/vendor/spikard-http/src/query_parser.rs +0 -369
  151. data/vendor/spikard-http/src/response.rs +0 -399
  152. data/vendor/spikard-http/src/router.rs +0 -1
  153. data/vendor/spikard-http/src/schema_registry.rs +0 -1
  154. data/vendor/spikard-http/src/server/handler.rs +0 -80
  155. data/vendor/spikard-http/src/server/lifecycle_execution.rs +0 -98
  156. data/vendor/spikard-http/src/server/mod.rs +0 -805
  157. data/vendor/spikard-http/src/server/request_extraction.rs +0 -119
  158. data/vendor/spikard-http/src/sse.rs +0 -447
  159. data/vendor/spikard-http/src/testing/form.rs +0 -14
  160. data/vendor/spikard-http/src/testing/multipart.rs +0 -60
  161. data/vendor/spikard-http/src/testing/test_client.rs +0 -285
  162. data/vendor/spikard-http/src/testing.rs +0 -377
  163. data/vendor/spikard-http/src/type_hints.rs +0 -1
  164. data/vendor/spikard-http/src/validation.rs +0 -1
  165. data/vendor/spikard-http/src/websocket.rs +0 -324
  166. data/vendor/spikard-rb/Cargo.toml +0 -42
  167. data/vendor/spikard-rb/build.rs +0 -8
  168. data/vendor/spikard-rb/src/background.rs +0 -63
  169. data/vendor/spikard-rb/src/config.rs +0 -294
  170. data/vendor/spikard-rb/src/conversion.rs +0 -392
  171. data/vendor/spikard-rb/src/di.rs +0 -409
  172. data/vendor/spikard-rb/src/handler.rs +0 -534
  173. data/vendor/spikard-rb/src/lib.rs +0 -2020
  174. data/vendor/spikard-rb/src/lifecycle.rs +0 -267
  175. data/vendor/spikard-rb/src/server.rs +0 -283
  176. data/vendor/spikard-rb/src/sse.rs +0 -231
  177. data/vendor/spikard-rb/src/test_client.rs +0 -404
  178. data/vendor/spikard-rb/src/test_sse.rs +0 -143
  179. data/vendor/spikard-rb/src/test_websocket.rs +0 -221
  180. data/vendor/spikard-rb/src/websocket.rs +0 -233
@@ -1,453 +1,453 @@
1
- //! Ruby ↔ Rust type conversion utilities.
2
- //!
3
- //! This module provides functions for converting between Ruby and Rust types,
4
- //! including JSON conversion, string conversion, and request/response building.
5
-
6
- #![allow(dead_code)]
7
-
8
- use bytes::Bytes;
9
- use magnus::prelude::*;
10
- use magnus::{Error, RArray, RHash, RString, Ruby, TryConvert, Value};
11
- use serde_json::Value as JsonValue;
12
- use spikard_http::problem::ProblemDetails;
13
- use spikard_http::testing::MultipartFilePart;
14
- use std::collections::HashMap;
15
-
16
- use crate::test_client::{RequestBody, RequestConfig, TestResponseData};
17
-
18
- /// Convert a Ruby value to JSON.
19
- ///
20
- /// Uses Ruby's JSON.generate method to serialize the Ruby object
21
- /// and then parses the result.
22
- pub fn ruby_value_to_json(ruby: &Ruby, json_module: Value, value: Value) -> Result<JsonValue, Error> {
23
- if value.is_nil() {
24
- return Ok(JsonValue::Null);
25
- }
26
-
27
- let json_string: String = json_module.funcall("generate", (value,))?;
28
- serde_json::from_str(&json_string).map_err(|err| {
29
- Error::new(
30
- ruby.exception_runtime_error(),
31
- format!("Failed to convert Ruby value to JSON: {err}"),
32
- )
33
- })
34
- }
35
-
36
- /// Convert JSON to a Ruby value.
37
- ///
38
- /// Recursively converts JSON types to native Ruby types:
39
- /// - null → nil
40
- /// - bool → true/false
41
- /// - number → integer or float
42
- /// - string → string
43
- /// - array → array
44
- /// - object → hash
45
- pub fn json_to_ruby(ruby: &Ruby, value: &JsonValue) -> Result<Value, Error> {
46
- json_to_ruby_with_uploads(ruby, value, None::<&Value>)
47
- }
48
-
49
- /// Convert JSON to a Ruby value, optionally materialising UploadFile objects.
50
- ///
51
- /// If `upload_file_class` is provided and the JSON object contains
52
- /// file-metadata keys (`filename`, `content`), this will instantiate
53
- /// `UploadFile` instead of returning a plain Hash.
54
- pub fn json_to_ruby_with_uploads(
55
- ruby: &Ruby,
56
- value: &JsonValue,
57
- upload_file_class: Option<&Value>,
58
- ) -> Result<Value, Error> {
59
- match value {
60
- JsonValue::Null => Ok(ruby.qnil().as_value()),
61
- JsonValue::Bool(b) => Ok(if *b {
62
- ruby.qtrue().as_value()
63
- } else {
64
- ruby.qfalse().as_value()
65
- }),
66
- JsonValue::Number(num) => {
67
- if let Some(i) = num.as_i64() {
68
- Ok(ruby.integer_from_i64(i).as_value())
69
- } else if let Some(f) = num.as_f64() {
70
- Ok(ruby.float_from_f64(f).as_value())
71
- } else {
72
- Ok(ruby.qnil().as_value())
73
- }
74
- }
75
- JsonValue::String(str_val) => Ok(ruby.str_new(str_val).as_value()),
76
- JsonValue::Array(items) => {
77
- let array = ruby.ary_new();
78
- for item in items {
79
- array.push(json_to_ruby_with_uploads(ruby, item, upload_file_class)?)?;
80
- }
81
- Ok(array.as_value())
82
- }
83
- JsonValue::Object(map) => {
84
- if let Some(upload_file) = upload_file_class {
85
- if let Some(upload) = try_build_upload_file(ruby, upload_file, map)? {
86
- return Ok(upload);
87
- }
88
- }
89
-
90
- let hash = ruby.hash_new();
91
- for (key, item) in map {
92
- hash.aset(
93
- ruby.str_new(key),
94
- json_to_ruby_with_uploads(ruby, item, upload_file_class)?,
95
- )?;
96
- }
97
- Ok(hash.as_value())
98
- }
99
- }
100
- }
101
-
102
- /// Convert a HashMap to a Ruby Hash.
103
- pub fn map_to_ruby_hash(ruby: &Ruby, map: &HashMap<String, String>) -> Result<Value, Error> {
104
- let hash = ruby.hash_new();
105
- for (key, value) in map {
106
- hash.aset(ruby.str_new(key), ruby.str_new(value))?;
107
- }
108
- Ok(hash.as_value())
109
- }
110
-
111
- /// Convert a HashMap of Vecs to a Ruby Hash with array values.
112
- pub fn multimap_to_ruby_hash(ruby: &Ruby, map: &HashMap<String, Vec<String>>) -> Result<Value, Error> {
113
- let hash = ruby.hash_new();
114
- for (key, values) in map {
115
- let array = ruby.ary_new();
116
- for value in values {
117
- array.push(ruby.str_new(value))?;
118
- }
119
- hash.aset(ruby.str_new(key), array)?;
120
- }
121
- Ok(hash.as_value())
122
- }
123
-
124
- fn try_build_upload_file(
125
- ruby: &Ruby,
126
- upload_file_class: &Value,
127
- map: &serde_json::Map<String, JsonValue>,
128
- ) -> Result<Option<Value>, Error> {
129
- let filename = match map.get("filename").and_then(|v| v.as_str()) {
130
- Some(name) => name,
131
- None => return Ok(None),
132
- };
133
- let content = match map.get("content") {
134
- Some(JsonValue::String(s)) => s.as_str(),
135
- _ => return Ok(None),
136
- };
137
-
138
- let content_type = map.get("content_type").and_then(|v| v.as_str());
139
- let size = map.get("size").and_then(|v| v.as_u64());
140
- let headers_value = map
141
- .get("headers")
142
- .and_then(|v| v.as_object())
143
- .map(|obj| {
144
- obj.iter()
145
- .filter_map(|(k, v)| v.as_str().map(|val| (k.clone(), val.to_string())))
146
- .collect::<HashMap<String, String>>()
147
- })
148
- .unwrap_or_default();
149
- let headers = map_to_ruby_hash(ruby, &headers_value)?;
150
- let content_encoding = map.get("content_encoding").and_then(|v| v.as_str());
151
-
152
- let kwargs = magnus::kwargs!(
153
- "content_type" => content_type,
154
- "size" => size,
155
- "headers" => headers,
156
- "content_encoding" => content_encoding
157
- );
158
-
159
- let upload = upload_file_class.funcall("new", (filename, content, kwargs))?;
160
- Ok(Some(upload))
161
- }
162
-
163
- /// Convert a Ruby value to Bytes.
164
- ///
165
- /// Accepts either String or Array of bytes.
166
- pub fn ruby_value_to_bytes(value: Value) -> Result<Bytes, std::io::Error> {
167
- if let Ok(str_value) = RString::try_convert(value) {
168
- // SAFETY: Magnus guarantees RString::as_slice() returns valid UTF-8 (or binary)
169
- // bytes for the lifetime of the RString. The slice is only used within this
170
- // function scope to copy into a Bytes buffer, and does not outlive the RString
171
- // reference. The copy_from_slice operation is safe for the borrowed data.
172
- let slice = unsafe { str_value.as_slice() };
173
- return Ok(Bytes::copy_from_slice(slice));
174
- }
175
-
176
- if let Ok(vec_bytes) = Vec::<u8>::try_convert(value) {
177
- return Ok(Bytes::from(vec_bytes));
178
- }
179
-
180
- Err(std::io::Error::other(
181
- "Streaming chunks must be Strings or Arrays of bytes",
182
- ))
183
- }
184
-
185
- /// Convert a response to a Ruby Hash.
186
- pub fn response_to_ruby(ruby: &Ruby, response: TestResponseData) -> Result<Value, Error> {
187
- let hash = ruby.hash_new();
188
-
189
- hash.aset(
190
- ruby.intern("status_code"),
191
- ruby.integer_from_i64(response.status as i64),
192
- )?;
193
-
194
- let headers_hash = ruby.hash_new();
195
- for (key, value) in response.headers {
196
- headers_hash.aset(ruby.str_new(&key), ruby.str_new(&value))?;
197
- }
198
- hash.aset(ruby.intern("headers"), headers_hash)?;
199
-
200
- if let Some(body) = response.body_text {
201
- let body_value = ruby.str_new(&body);
202
- hash.aset(ruby.intern("body"), body_value)?;
203
- hash.aset(ruby.intern("body_text"), body_value)?;
204
- } else {
205
- hash.aset(ruby.intern("body"), ruby.qnil())?;
206
- hash.aset(ruby.intern("body_text"), ruby.qnil())?;
207
- }
208
-
209
- Ok(hash.as_value())
210
- }
211
-
212
- /// Convert a ProblemDetails to a JSON string.
213
- pub fn problem_to_json(problem: &ProblemDetails) -> String {
214
- problem
215
- .to_json_pretty()
216
- .unwrap_or_else(|err| format!("Failed to serialise problem details: {err}"))
217
- }
218
-
219
- /// Fetch a handler from a Ruby Hash by name.
220
- ///
221
- /// Tries both symbol and string keys.
222
- pub fn fetch_handler(ruby: &Ruby, handlers: &RHash, name: &str) -> Result<Value, Error> {
223
- let symbol_key = ruby.intern(name);
224
- if let Some(value) = handlers.get(symbol_key) {
225
- return Ok(value);
226
- }
227
-
228
- let string_key = ruby.str_new(name);
229
- if let Some(value) = handlers.get(string_key) {
230
- return Ok(value);
231
- }
232
-
233
- Err(Error::new(
234
- ruby.exception_name_error(),
235
- format!("Handler '{name}' not provided"),
236
- ))
237
- }
238
-
239
- /// Get an optional keyword argument from a Ruby Hash.
240
- pub fn get_kw(ruby: &Ruby, hash: RHash, name: &str) -> Option<Value> {
241
- let sym = ruby.intern(name);
242
- hash.get(sym).or_else(|| hash.get(name))
243
- }
244
-
245
- /// Parse request configuration from a Ruby options Hash.
246
- ///
247
- /// Supports: query, headers, cookies, json, data, raw_body, files
248
- pub fn parse_request_config(ruby: &Ruby, options: Value) -> Result<RequestConfig, Error> {
249
- if options.is_nil() {
250
- return Ok(RequestConfig {
251
- query: None,
252
- headers: HashMap::new(),
253
- cookies: HashMap::new(),
254
- body: None,
255
- });
256
- }
257
-
258
- let hash = RHash::from_value(options)
259
- .ok_or_else(|| Error::new(ruby.exception_arg_error(), "request options must be a Hash"))?;
260
-
261
- let json_module = ruby
262
- .class_object()
263
- .const_get("JSON")
264
- .map_err(|_| Error::new(ruby.exception_runtime_error(), "JSON module not available"))?;
265
-
266
- let query = if let Some(value) = get_kw(ruby, hash, "query") {
267
- if value.is_nil() {
268
- None
269
- } else {
270
- Some(ruby_value_to_json(ruby, json_module, value)?)
271
- }
272
- } else {
273
- None
274
- };
275
-
276
- let headers = if let Some(value) = get_kw(ruby, hash, "headers") {
277
- if value.is_nil() {
278
- HashMap::new()
279
- } else {
280
- let hash = RHash::try_convert(value)?;
281
- hash.to_hash_map::<String, String>()?
282
- }
283
- } else {
284
- HashMap::new()
285
- };
286
-
287
- let cookies = if let Some(value) = get_kw(ruby, hash, "cookies") {
288
- if value.is_nil() {
289
- HashMap::new()
290
- } else {
291
- let hash = RHash::try_convert(value)?;
292
- hash.to_hash_map::<String, String>()?
293
- }
294
- } else {
295
- HashMap::new()
296
- };
297
-
298
- let files_opt = get_kw(ruby, hash, "files");
299
- let has_files = files_opt.is_some() && !files_opt.unwrap().is_nil();
300
-
301
- let body = if has_files {
302
- let files_value = files_opt.unwrap();
303
- let files = extract_files(ruby, files_value)?;
304
-
305
- let mut form_data = Vec::new();
306
- if let Some(data_value) = get_kw(ruby, hash, "data")
307
- && !data_value.is_nil()
308
- {
309
- let data_hash = RHash::try_convert(data_value)?;
310
-
311
- let keys_array: RArray = data_hash.funcall("keys", ())?;
312
-
313
- for i in 0..keys_array.len() {
314
- let key_val = keys_array.entry::<Value>(i as isize)?;
315
- let field_name = String::try_convert(key_val)?;
316
- let value = data_hash
317
- .get(key_val)
318
- .ok_or_else(|| Error::new(ruby.exception_runtime_error(), "Failed to get hash value"))?;
319
-
320
- if let Some(array) = RArray::from_value(value) {
321
- for j in 0..array.len() {
322
- let item = array.entry::<Value>(j as isize)?;
323
- let item_str = String::try_convert(item)?;
324
- form_data.push((field_name.clone(), item_str));
325
- }
326
- } else {
327
- let value_str = String::try_convert(value)?;
328
- form_data.push((field_name, value_str));
329
- }
330
- }
331
- }
332
-
333
- Some(RequestBody::Multipart { form_data, files })
334
- } else if let Some(value) = get_kw(ruby, hash, "json") {
335
- if value.is_nil() {
336
- None
337
- } else {
338
- Some(RequestBody::Json(ruby_value_to_json(ruby, json_module, value)?))
339
- }
340
- } else if let Some(value) = get_kw(ruby, hash, "data") {
341
- if value.is_nil() {
342
- None
343
- } else {
344
- Some(RequestBody::Form(ruby_value_to_json(ruby, json_module, value)?))
345
- }
346
- } else if let Some(value) = get_kw(ruby, hash, "raw_body") {
347
- if value.is_nil() {
348
- None
349
- } else {
350
- Some(RequestBody::Raw(String::try_convert(value)?))
351
- }
352
- } else {
353
- None
354
- };
355
-
356
- Ok(RequestConfig {
357
- query,
358
- headers,
359
- cookies,
360
- body,
361
- })
362
- }
363
-
364
- /// Extract files from a Ruby Hash.
365
- ///
366
- /// Files can be provided as [filename, content] or [filename, content, content_type]
367
- pub fn extract_files(ruby: &Ruby, files_value: Value) -> Result<Vec<MultipartFilePart>, Error> {
368
- let files_hash = RHash::try_convert(files_value)?;
369
-
370
- let keys_array: RArray = files_hash.funcall("keys", ())?;
371
- let mut result = Vec::new();
372
-
373
- for i in 0..keys_array.len() {
374
- let key_val = keys_array.entry::<Value>(i as isize)?;
375
- let field_name = String::try_convert(key_val)?;
376
- let value = files_hash
377
- .get(key_val)
378
- .ok_or_else(|| Error::new(ruby.exception_runtime_error(), "Failed to get hash value"))?;
379
-
380
- if let Some(outer_array) = RArray::from_value(value) {
381
- if outer_array.is_empty() {
382
- continue;
383
- }
384
-
385
- let first_elem = outer_array.entry::<Value>(0)?;
386
-
387
- if RArray::from_value(first_elem).is_some() {
388
- for j in 0..outer_array.len() {
389
- let file_array = outer_array.entry::<Value>(j as isize)?;
390
- let file_data = extract_single_file(ruby, &field_name, file_array)?;
391
- result.push(file_data);
392
- }
393
- } else {
394
- let file_data = extract_single_file(ruby, &field_name, value)?;
395
- result.push(file_data);
396
- }
397
- }
398
- }
399
-
400
- Ok(result)
401
- }
402
-
403
- /// Extract a single file from a Ruby array [filename, content, content_type (optional)].
404
- pub fn extract_single_file(ruby: &Ruby, field_name: &str, array_value: Value) -> Result<MultipartFilePart, Error> {
405
- let array = RArray::from_value(array_value)
406
- .ok_or_else(|| Error::new(ruby.exception_arg_error(), "file must be an Array [filename, content]"))?;
407
-
408
- if array.len() < 2 {
409
- return Err(Error::new(
410
- ruby.exception_arg_error(),
411
- "file Array must have at least 2 elements: [filename, content]",
412
- ));
413
- }
414
-
415
- let filename: String = String::try_convert(array.shift()?)?;
416
- let content_str: String = String::try_convert(array.shift()?)?;
417
- let content = content_str.into_bytes();
418
-
419
- let content_type: Option<String> = if !array.is_empty() {
420
- String::try_convert(array.shift()?).ok()
421
- } else {
422
- None
423
- };
424
-
425
- Ok(MultipartFilePart {
426
- field_name: field_name.to_string(),
427
- filename,
428
- content,
429
- content_type,
430
- })
431
- }
432
-
433
- /// Extract an optional string from a Ruby Hash.
434
- pub fn get_optional_string_from_hash(hash: RHash, key: &str) -> Result<Option<String>, Error> {
435
- match hash.get(String::from(key)) {
436
- Some(v) if !v.is_nil() => Ok(Some(String::try_convert(v)?)),
437
- _ => Ok(None),
438
- }
439
- }
440
-
441
- /// Extract a required string from a Ruby Hash.
442
- pub fn get_required_string_from_hash(hash: RHash, key: &str, ruby: &Ruby) -> Result<String, Error> {
443
- let value = hash
444
- .get(String::from(key))
445
- .ok_or_else(|| Error::new(ruby.exception_arg_error(), format!("missing required key '{}'", key)))?;
446
- if value.is_nil() {
447
- return Err(Error::new(
448
- ruby.exception_arg_error(),
449
- format!("key '{}' cannot be nil", key),
450
- ));
451
- }
452
- String::try_convert(value)
453
- }
1
+ //! Ruby ↔ Rust type conversion utilities.
2
+ //!
3
+ //! This module provides functions for converting between Ruby and Rust types,
4
+ //! including JSON conversion, string conversion, and request/response building.
5
+
6
+ #![allow(dead_code)]
7
+
8
+ use bytes::Bytes;
9
+ use magnus::prelude::*;
10
+ use magnus::{Error, RArray, RHash, RString, Ruby, TryConvert, Value};
11
+ use serde_json::Value as JsonValue;
12
+ use spikard_http::problem::ProblemDetails;
13
+ use spikard_http::testing::MultipartFilePart;
14
+ use std::collections::HashMap;
15
+
16
+ use crate::test_client::{RequestBody, RequestConfig, TestResponseData};
17
+
18
+ /// Convert a Ruby value to JSON.
19
+ ///
20
+ /// Uses Ruby's JSON.generate method to serialize the Ruby object
21
+ /// and then parses the result.
22
+ pub fn ruby_value_to_json(ruby: &Ruby, json_module: Value, value: Value) -> Result<JsonValue, Error> {
23
+ if value.is_nil() {
24
+ return Ok(JsonValue::Null);
25
+ }
26
+
27
+ let json_string: String = json_module.funcall("generate", (value,))?;
28
+ serde_json::from_str(&json_string).map_err(|err| {
29
+ Error::new(
30
+ ruby.exception_runtime_error(),
31
+ format!("Failed to convert Ruby value to JSON: {err}"),
32
+ )
33
+ })
34
+ }
35
+
36
+ /// Convert JSON to a Ruby value.
37
+ ///
38
+ /// Recursively converts JSON types to native Ruby types:
39
+ /// - null → nil
40
+ /// - bool → true/false
41
+ /// - number → integer or float
42
+ /// - string → string
43
+ /// - array → array
44
+ /// - object → hash
45
+ pub fn json_to_ruby(ruby: &Ruby, value: &JsonValue) -> Result<Value, Error> {
46
+ json_to_ruby_with_uploads(ruby, value, None::<&Value>)
47
+ }
48
+
49
+ /// Convert JSON to a Ruby value, optionally materialising UploadFile objects.
50
+ ///
51
+ /// If `upload_file_class` is provided and the JSON object contains
52
+ /// file-metadata keys (`filename`, `content`), this will instantiate
53
+ /// `UploadFile` instead of returning a plain Hash.
54
+ pub fn json_to_ruby_with_uploads(
55
+ ruby: &Ruby,
56
+ value: &JsonValue,
57
+ upload_file_class: Option<&Value>,
58
+ ) -> Result<Value, Error> {
59
+ match value {
60
+ JsonValue::Null => Ok(ruby.qnil().as_value()),
61
+ JsonValue::Bool(b) => Ok(if *b {
62
+ ruby.qtrue().as_value()
63
+ } else {
64
+ ruby.qfalse().as_value()
65
+ }),
66
+ JsonValue::Number(num) => {
67
+ if let Some(i) = num.as_i64() {
68
+ Ok(ruby.integer_from_i64(i).as_value())
69
+ } else if let Some(f) = num.as_f64() {
70
+ Ok(ruby.float_from_f64(f).as_value())
71
+ } else {
72
+ Ok(ruby.qnil().as_value())
73
+ }
74
+ }
75
+ JsonValue::String(str_val) => Ok(ruby.str_new(str_val).as_value()),
76
+ JsonValue::Array(items) => {
77
+ let array = ruby.ary_new();
78
+ for item in items {
79
+ array.push(json_to_ruby_with_uploads(ruby, item, upload_file_class)?)?;
80
+ }
81
+ Ok(array.as_value())
82
+ }
83
+ JsonValue::Object(map) => {
84
+ if let Some(upload_file) = upload_file_class {
85
+ if let Some(upload) = try_build_upload_file(ruby, upload_file, map)? {
86
+ return Ok(upload);
87
+ }
88
+ }
89
+
90
+ let hash = ruby.hash_new();
91
+ for (key, item) in map {
92
+ hash.aset(
93
+ ruby.str_new(key),
94
+ json_to_ruby_with_uploads(ruby, item, upload_file_class)?,
95
+ )?;
96
+ }
97
+ Ok(hash.as_value())
98
+ }
99
+ }
100
+ }
101
+
102
+ /// Convert a HashMap to a Ruby Hash.
103
+ pub fn map_to_ruby_hash(ruby: &Ruby, map: &HashMap<String, String>) -> Result<Value, Error> {
104
+ let hash = ruby.hash_new();
105
+ for (key, value) in map {
106
+ hash.aset(ruby.str_new(key), ruby.str_new(value))?;
107
+ }
108
+ Ok(hash.as_value())
109
+ }
110
+
111
+ /// Convert a HashMap of Vecs to a Ruby Hash with array values.
112
+ pub fn multimap_to_ruby_hash(ruby: &Ruby, map: &HashMap<String, Vec<String>>) -> Result<Value, Error> {
113
+ let hash = ruby.hash_new();
114
+ for (key, values) in map {
115
+ let array = ruby.ary_new();
116
+ for value in values {
117
+ array.push(ruby.str_new(value))?;
118
+ }
119
+ hash.aset(ruby.str_new(key), array)?;
120
+ }
121
+ Ok(hash.as_value())
122
+ }
123
+
124
+ fn try_build_upload_file(
125
+ ruby: &Ruby,
126
+ upload_file_class: &Value,
127
+ map: &serde_json::Map<String, JsonValue>,
128
+ ) -> Result<Option<Value>, Error> {
129
+ let filename = match map.get("filename").and_then(|v| v.as_str()) {
130
+ Some(name) => name,
131
+ None => return Ok(None),
132
+ };
133
+ let content = match map.get("content") {
134
+ Some(JsonValue::String(s)) => s.as_str(),
135
+ _ => return Ok(None),
136
+ };
137
+
138
+ let content_type = map.get("content_type").and_then(|v| v.as_str());
139
+ let size = map.get("size").and_then(|v| v.as_u64());
140
+ let headers_value = map
141
+ .get("headers")
142
+ .and_then(|v| v.as_object())
143
+ .map(|obj| {
144
+ obj.iter()
145
+ .filter_map(|(k, v)| v.as_str().map(|val| (k.clone(), val.to_string())))
146
+ .collect::<HashMap<String, String>>()
147
+ })
148
+ .unwrap_or_default();
149
+ let headers = map_to_ruby_hash(ruby, &headers_value)?;
150
+ let content_encoding = map.get("content_encoding").and_then(|v| v.as_str());
151
+
152
+ let kwargs = magnus::kwargs!(
153
+ "content_type" => content_type,
154
+ "size" => size,
155
+ "headers" => headers,
156
+ "content_encoding" => content_encoding
157
+ );
158
+
159
+ let upload = upload_file_class.funcall("new", (filename, content, kwargs))?;
160
+ Ok(Some(upload))
161
+ }
162
+
163
+ /// Convert a Ruby value to Bytes.
164
+ ///
165
+ /// Accepts either String or Array of bytes.
166
+ pub fn ruby_value_to_bytes(value: Value) -> Result<Bytes, std::io::Error> {
167
+ if let Ok(str_value) = RString::try_convert(value) {
168
+ // SAFETY: Magnus guarantees RString::as_slice() returns valid UTF-8 (or binary)
169
+ // bytes for the lifetime of the RString. The slice is only used within this
170
+ // function scope to copy into a Bytes buffer, and does not outlive the RString
171
+ // reference. The copy_from_slice operation is safe for the borrowed data.
172
+ let slice = unsafe { str_value.as_slice() };
173
+ return Ok(Bytes::copy_from_slice(slice));
174
+ }
175
+
176
+ if let Ok(vec_bytes) = Vec::<u8>::try_convert(value) {
177
+ return Ok(Bytes::from(vec_bytes));
178
+ }
179
+
180
+ Err(std::io::Error::other(
181
+ "Streaming chunks must be Strings or Arrays of bytes",
182
+ ))
183
+ }
184
+
185
+ /// Convert a response to a Ruby Hash.
186
+ pub fn response_to_ruby(ruby: &Ruby, response: TestResponseData) -> Result<Value, Error> {
187
+ let hash = ruby.hash_new();
188
+
189
+ hash.aset(
190
+ ruby.intern("status_code"),
191
+ ruby.integer_from_i64(response.status as i64),
192
+ )?;
193
+
194
+ let headers_hash = ruby.hash_new();
195
+ for (key, value) in response.headers {
196
+ headers_hash.aset(ruby.str_new(&key), ruby.str_new(&value))?;
197
+ }
198
+ hash.aset(ruby.intern("headers"), headers_hash)?;
199
+
200
+ if let Some(body) = response.body_text {
201
+ let body_value = ruby.str_new(&body);
202
+ hash.aset(ruby.intern("body"), body_value)?;
203
+ hash.aset(ruby.intern("body_text"), body_value)?;
204
+ } else {
205
+ hash.aset(ruby.intern("body"), ruby.qnil())?;
206
+ hash.aset(ruby.intern("body_text"), ruby.qnil())?;
207
+ }
208
+
209
+ Ok(hash.as_value())
210
+ }
211
+
212
+ /// Convert a ProblemDetails to a JSON string.
213
+ pub fn problem_to_json(problem: &ProblemDetails) -> String {
214
+ problem
215
+ .to_json_pretty()
216
+ .unwrap_or_else(|err| format!("Failed to serialise problem details: {err}"))
217
+ }
218
+
219
+ /// Fetch a handler from a Ruby Hash by name.
220
+ ///
221
+ /// Tries both symbol and string keys.
222
+ pub fn fetch_handler(ruby: &Ruby, handlers: &RHash, name: &str) -> Result<Value, Error> {
223
+ let symbol_key = ruby.intern(name);
224
+ if let Some(value) = handlers.get(symbol_key) {
225
+ return Ok(value);
226
+ }
227
+
228
+ let string_key = ruby.str_new(name);
229
+ if let Some(value) = handlers.get(string_key) {
230
+ return Ok(value);
231
+ }
232
+
233
+ Err(Error::new(
234
+ ruby.exception_name_error(),
235
+ format!("Handler '{name}' not provided"),
236
+ ))
237
+ }
238
+
239
+ /// Get an optional keyword argument from a Ruby Hash.
240
+ pub fn get_kw(ruby: &Ruby, hash: RHash, name: &str) -> Option<Value> {
241
+ let sym = ruby.intern(name);
242
+ hash.get(sym).or_else(|| hash.get(name))
243
+ }
244
+
245
+ /// Parse request configuration from a Ruby options Hash.
246
+ ///
247
+ /// Supports: query, headers, cookies, json, data, raw_body, files
248
+ pub fn parse_request_config(ruby: &Ruby, options: Value) -> Result<RequestConfig, Error> {
249
+ if options.is_nil() {
250
+ return Ok(RequestConfig {
251
+ query: None,
252
+ headers: HashMap::new(),
253
+ cookies: HashMap::new(),
254
+ body: None,
255
+ });
256
+ }
257
+
258
+ let hash = RHash::from_value(options)
259
+ .ok_or_else(|| Error::new(ruby.exception_arg_error(), "request options must be a Hash"))?;
260
+
261
+ let json_module = ruby
262
+ .class_object()
263
+ .const_get("JSON")
264
+ .map_err(|_| Error::new(ruby.exception_runtime_error(), "JSON module not available"))?;
265
+
266
+ let query = if let Some(value) = get_kw(ruby, hash, "query") {
267
+ if value.is_nil() {
268
+ None
269
+ } else {
270
+ Some(ruby_value_to_json(ruby, json_module, value)?)
271
+ }
272
+ } else {
273
+ None
274
+ };
275
+
276
+ let headers = if let Some(value) = get_kw(ruby, hash, "headers") {
277
+ if value.is_nil() {
278
+ HashMap::new()
279
+ } else {
280
+ let hash = RHash::try_convert(value)?;
281
+ hash.to_hash_map::<String, String>()?
282
+ }
283
+ } else {
284
+ HashMap::new()
285
+ };
286
+
287
+ let cookies = if let Some(value) = get_kw(ruby, hash, "cookies") {
288
+ if value.is_nil() {
289
+ HashMap::new()
290
+ } else {
291
+ let hash = RHash::try_convert(value)?;
292
+ hash.to_hash_map::<String, String>()?
293
+ }
294
+ } else {
295
+ HashMap::new()
296
+ };
297
+
298
+ let files_opt = get_kw(ruby, hash, "files");
299
+ let has_files = files_opt.is_some() && !files_opt.unwrap().is_nil();
300
+
301
+ let body = if has_files {
302
+ let files_value = files_opt.unwrap();
303
+ let files = extract_files(ruby, files_value)?;
304
+
305
+ let mut form_data = Vec::new();
306
+ if let Some(data_value) = get_kw(ruby, hash, "data")
307
+ && !data_value.is_nil()
308
+ {
309
+ let data_hash = RHash::try_convert(data_value)?;
310
+
311
+ let keys_array: RArray = data_hash.funcall("keys", ())?;
312
+
313
+ for i in 0..keys_array.len() {
314
+ let key_val = keys_array.entry::<Value>(i as isize)?;
315
+ let field_name = String::try_convert(key_val)?;
316
+ let value = data_hash
317
+ .get(key_val)
318
+ .ok_or_else(|| Error::new(ruby.exception_runtime_error(), "Failed to get hash value"))?;
319
+
320
+ if let Some(array) = RArray::from_value(value) {
321
+ for j in 0..array.len() {
322
+ let item = array.entry::<Value>(j as isize)?;
323
+ let item_str = String::try_convert(item)?;
324
+ form_data.push((field_name.clone(), item_str));
325
+ }
326
+ } else {
327
+ let value_str = String::try_convert(value)?;
328
+ form_data.push((field_name, value_str));
329
+ }
330
+ }
331
+ }
332
+
333
+ Some(RequestBody::Multipart { form_data, files })
334
+ } else if let Some(value) = get_kw(ruby, hash, "json") {
335
+ if value.is_nil() {
336
+ None
337
+ } else {
338
+ Some(RequestBody::Json(ruby_value_to_json(ruby, json_module, value)?))
339
+ }
340
+ } else if let Some(value) = get_kw(ruby, hash, "data") {
341
+ if value.is_nil() {
342
+ None
343
+ } else {
344
+ Some(RequestBody::Form(ruby_value_to_json(ruby, json_module, value)?))
345
+ }
346
+ } else if let Some(value) = get_kw(ruby, hash, "raw_body") {
347
+ if value.is_nil() {
348
+ None
349
+ } else {
350
+ Some(RequestBody::Raw(String::try_convert(value)?))
351
+ }
352
+ } else {
353
+ None
354
+ };
355
+
356
+ Ok(RequestConfig {
357
+ query,
358
+ headers,
359
+ cookies,
360
+ body,
361
+ })
362
+ }
363
+
364
+ /// Extract files from a Ruby Hash.
365
+ ///
366
+ /// Files can be provided as [filename, content] or [filename, content, content_type]
367
+ pub fn extract_files(ruby: &Ruby, files_value: Value) -> Result<Vec<MultipartFilePart>, Error> {
368
+ let files_hash = RHash::try_convert(files_value)?;
369
+
370
+ let keys_array: RArray = files_hash.funcall("keys", ())?;
371
+ let mut result = Vec::new();
372
+
373
+ for i in 0..keys_array.len() {
374
+ let key_val = keys_array.entry::<Value>(i as isize)?;
375
+ let field_name = String::try_convert(key_val)?;
376
+ let value = files_hash
377
+ .get(key_val)
378
+ .ok_or_else(|| Error::new(ruby.exception_runtime_error(), "Failed to get hash value"))?;
379
+
380
+ if let Some(outer_array) = RArray::from_value(value) {
381
+ if outer_array.is_empty() {
382
+ continue;
383
+ }
384
+
385
+ let first_elem = outer_array.entry::<Value>(0)?;
386
+
387
+ if RArray::from_value(first_elem).is_some() {
388
+ for j in 0..outer_array.len() {
389
+ let file_array = outer_array.entry::<Value>(j as isize)?;
390
+ let file_data = extract_single_file(ruby, &field_name, file_array)?;
391
+ result.push(file_data);
392
+ }
393
+ } else {
394
+ let file_data = extract_single_file(ruby, &field_name, value)?;
395
+ result.push(file_data);
396
+ }
397
+ }
398
+ }
399
+
400
+ Ok(result)
401
+ }
402
+
403
+ /// Extract a single file from a Ruby array [filename, content, content_type (optional)].
404
+ pub fn extract_single_file(ruby: &Ruby, field_name: &str, array_value: Value) -> Result<MultipartFilePart, Error> {
405
+ let array = RArray::from_value(array_value)
406
+ .ok_or_else(|| Error::new(ruby.exception_arg_error(), "file must be an Array [filename, content]"))?;
407
+
408
+ if array.len() < 2 {
409
+ return Err(Error::new(
410
+ ruby.exception_arg_error(),
411
+ "file Array must have at least 2 elements: [filename, content]",
412
+ ));
413
+ }
414
+
415
+ let filename: String = String::try_convert(array.shift()?)?;
416
+ let content_str: String = String::try_convert(array.shift()?)?;
417
+ let content = content_str.into_bytes();
418
+
419
+ let content_type: Option<String> = if !array.is_empty() {
420
+ String::try_convert(array.shift()?).ok()
421
+ } else {
422
+ None
423
+ };
424
+
425
+ Ok(MultipartFilePart {
426
+ field_name: field_name.to_string(),
427
+ filename,
428
+ content,
429
+ content_type,
430
+ })
431
+ }
432
+
433
+ /// Extract an optional string from a Ruby Hash.
434
+ pub fn get_optional_string_from_hash(hash: RHash, key: &str) -> Result<Option<String>, Error> {
435
+ match hash.get(String::from(key)) {
436
+ Some(v) if !v.is_nil() => Ok(Some(String::try_convert(v)?)),
437
+ _ => Ok(None),
438
+ }
439
+ }
440
+
441
+ /// Extract a required string from a Ruby Hash.
442
+ pub fn get_required_string_from_hash(hash: RHash, key: &str, ruby: &Ruby) -> Result<String, Error> {
443
+ let value = hash
444
+ .get(String::from(key))
445
+ .ok_or_else(|| Error::new(ruby.exception_arg_error(), format!("missing required key '{}'", key)))?;
446
+ if value.is_nil() {
447
+ return Err(Error::new(
448
+ ruby.exception_arg_error(),
449
+ format!("key '{}' cannot be nil", key),
450
+ ));
451
+ }
452
+ String::try_convert(value)
453
+ }