RubyGems - spikard - Versions diffs - 0.3.6 → 0.6.1 - Mend

spikard 0.3.6 → 0.6.1

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 (142) hide show

checksums.yaml +4 -4
data/LICENSE +1 -1
data/README.md +674 -659
data/ext/spikard_rb/Cargo.toml +17 -17
data/ext/spikard_rb/extconf.rb +13 -10
data/ext/spikard_rb/src/lib.rs +6 -6
data/lib/spikard/app.rb +405 -386
data/lib/spikard/background.rb +27 -27
data/lib/spikard/config.rb +396 -396
data/lib/spikard/converters.rb +13 -13
data/lib/spikard/handler_wrapper.rb +113 -113
data/lib/spikard/provide.rb +214 -214
data/lib/spikard/response.rb +173 -173
data/lib/spikard/schema.rb +243 -243
data/lib/spikard/sse.rb +111 -111
data/lib/spikard/streaming_response.rb +44 -44
data/lib/spikard/testing.rb +256 -221
data/lib/spikard/upload_file.rb +131 -131
data/lib/spikard/version.rb +5 -5
data/lib/spikard/websocket.rb +59 -59
data/lib/spikard.rb +43 -43
data/sig/spikard.rbs +366 -366
data/vendor/crates/spikard-bindings-shared/Cargo.toml +63 -0
data/vendor/crates/spikard-bindings-shared/examples/config_extraction.rs +132 -0
data/vendor/crates/spikard-bindings-shared/src/config_extractor.rs +752 -0
data/vendor/crates/spikard-bindings-shared/src/conversion_traits.rs +194 -0
data/vendor/crates/spikard-bindings-shared/src/di_traits.rs +246 -0
data/vendor/crates/spikard-bindings-shared/src/error_response.rs +401 -0
data/vendor/crates/spikard-bindings-shared/src/handler_base.rs +238 -0
data/vendor/crates/spikard-bindings-shared/src/lib.rs +24 -0
data/vendor/crates/spikard-bindings-shared/src/lifecycle_base.rs +292 -0
data/vendor/crates/spikard-bindings-shared/src/lifecycle_executor.rs +616 -0
data/vendor/crates/spikard-bindings-shared/src/response_builder.rs +305 -0
data/vendor/crates/spikard-bindings-shared/src/test_client_base.rs +248 -0
data/vendor/crates/spikard-bindings-shared/src/validation_helpers.rs +351 -0
data/vendor/crates/spikard-bindings-shared/tests/comprehensive_coverage.rs +454 -0
data/vendor/crates/spikard-bindings-shared/tests/error_response_edge_cases.rs +383 -0
data/vendor/crates/spikard-bindings-shared/tests/handler_base_integration.rs +280 -0
data/vendor/crates/spikard-core/Cargo.toml +40 -40
data/vendor/crates/spikard-core/src/bindings/mod.rs +3 -3
data/vendor/crates/spikard-core/src/bindings/response.rs +133 -133
data/vendor/crates/spikard-core/src/debug.rs +127 -63
data/vendor/crates/spikard-core/src/di/container.rs +702 -726
data/vendor/crates/spikard-core/src/di/dependency.rs +273 -273
data/vendor/crates/spikard-core/src/di/error.rs +118 -118
data/vendor/crates/spikard-core/src/di/factory.rs +534 -538
data/vendor/crates/spikard-core/src/di/graph.rs +506 -545
data/vendor/crates/spikard-core/src/di/mod.rs +192 -192
data/vendor/crates/spikard-core/src/di/resolved.rs +405 -411
data/vendor/crates/spikard-core/src/di/value.rs +281 -283
data/vendor/crates/spikard-core/src/errors.rs +69 -39
data/vendor/crates/spikard-core/src/http.rs +415 -153
data/vendor/crates/spikard-core/src/lib.rs +29 -29
data/vendor/crates/spikard-core/src/lifecycle.rs +1186 -422
data/vendor/crates/spikard-core/src/metadata.rs +389 -0
data/vendor/crates/spikard-core/src/parameters.rs +2525 -722
data/vendor/crates/spikard-core/src/problem.rs +344 -310
data/vendor/crates/spikard-core/src/request_data.rs +1154 -189
data/vendor/crates/spikard-core/src/router.rs +510 -249
data/vendor/crates/spikard-core/src/schema_registry.rs +183 -183
data/vendor/crates/spikard-core/src/type_hints.rs +304 -304
data/vendor/crates/spikard-core/src/validation/error_mapper.rs +696 -0
data/vendor/crates/spikard-core/src/{validation.rs → validation/mod.rs} +457 -699
data/vendor/crates/spikard-http/Cargo.toml +62 -68
data/vendor/crates/spikard-http/examples/sse-notifications.rs +148 -0
data/vendor/crates/spikard-http/examples/websocket-chat.rs +92 -0
data/vendor/crates/spikard-http/src/auth.rs +296 -247
data/vendor/crates/spikard-http/src/background.rs +1860 -249
data/vendor/crates/spikard-http/src/bindings/mod.rs +3 -3
data/vendor/crates/spikard-http/src/bindings/response.rs +1 -1
data/vendor/crates/spikard-http/src/body_metadata.rs +8 -8
data/vendor/crates/spikard-http/src/cors.rs +1005 -490
data/vendor/crates/spikard-http/src/debug.rs +128 -63
data/vendor/crates/spikard-http/src/di_handler.rs +1668 -423
data/vendor/crates/spikard-http/src/handler_response.rs +901 -190
data/vendor/crates/spikard-http/src/handler_trait.rs +838 -228
data/vendor/crates/spikard-http/src/handler_trait_tests.rs +290 -284
data/vendor/crates/spikard-http/src/lib.rs +534 -529
data/vendor/crates/spikard-http/src/lifecycle/adapter.rs +230 -149
data/vendor/crates/spikard-http/src/lifecycle.rs +1193 -428
data/vendor/crates/spikard-http/src/middleware/mod.rs +560 -285
data/vendor/crates/spikard-http/src/middleware/multipart.rs +912 -86
data/vendor/crates/spikard-http/src/middleware/urlencoded.rs +513 -147
data/vendor/crates/spikard-http/src/middleware/validation.rs +768 -287
data/vendor/crates/spikard-http/src/openapi/mod.rs +309 -309
data/vendor/crates/spikard-http/src/openapi/parameter_extraction.rs +535 -190
data/vendor/crates/spikard-http/src/openapi/schema_conversion.rs +1363 -308
data/vendor/crates/spikard-http/src/openapi/spec_generation.rs +665 -195
data/vendor/crates/spikard-http/src/query_parser.rs +793 -369
data/vendor/crates/spikard-http/src/response.rs +720 -399
data/vendor/crates/spikard-http/src/server/handler.rs +1650 -87
data/vendor/crates/spikard-http/src/server/lifecycle_execution.rs +234 -98
data/vendor/crates/spikard-http/src/server/mod.rs +1593 -805
data/vendor/crates/spikard-http/src/server/request_extraction.rs +789 -119
data/vendor/crates/spikard-http/src/server/routing_factory.rs +629 -0
data/vendor/crates/spikard-http/src/sse.rs +1409 -447
data/vendor/crates/spikard-http/src/testing/form.rs +52 -14
data/vendor/crates/spikard-http/src/testing/multipart.rs +64 -60
data/vendor/crates/spikard-http/src/testing/test_client.rs +311 -285
data/vendor/crates/spikard-http/src/testing.rs +406 -377
data/vendor/crates/spikard-http/src/websocket.rs +1404 -324
data/vendor/crates/spikard-http/tests/background_behavior.rs +832 -0
data/vendor/crates/spikard-http/tests/common/handlers.rs +309 -0
data/vendor/crates/spikard-http/tests/common/mod.rs +26 -0
data/vendor/crates/spikard-http/tests/di_integration.rs +192 -0
data/vendor/crates/spikard-http/tests/doc_snippets.rs +5 -0
data/vendor/crates/spikard-http/tests/lifecycle_execution.rs +1093 -0
data/vendor/crates/spikard-http/tests/multipart_behavior.rs +656 -0
data/vendor/crates/spikard-http/tests/server_config_builder.rs +314 -0
data/vendor/crates/spikard-http/tests/sse_behavior.rs +620 -0
data/vendor/crates/spikard-http/tests/websocket_behavior.rs +663 -0
data/vendor/crates/spikard-rb/Cargo.toml +48 -42
data/vendor/crates/spikard-rb/build.rs +199 -8
data/vendor/crates/spikard-rb/src/background.rs +63 -63
data/vendor/crates/spikard-rb/src/config/mod.rs +5 -0
data/vendor/crates/spikard-rb/src/{config.rs → config/server_config.rs} +285 -294
data/vendor/crates/spikard-rb/src/conversion.rs +554 -453
data/vendor/crates/spikard-rb/src/di/builder.rs +100 -0
data/vendor/crates/spikard-rb/src/{di.rs → di/mod.rs} +375 -409
data/vendor/crates/spikard-rb/src/handler.rs +618 -625
data/vendor/crates/spikard-rb/src/integration/mod.rs +3 -0
data/vendor/crates/spikard-rb/src/lib.rs +1806 -2771
data/vendor/crates/spikard-rb/src/lifecycle.rs +275 -274
data/vendor/crates/spikard-rb/src/metadata/mod.rs +5 -0
data/vendor/crates/spikard-rb/src/metadata/route_extraction.rs +442 -0
data/vendor/crates/spikard-rb/src/runtime/mod.rs +5 -0
data/vendor/crates/spikard-rb/src/runtime/server_runner.rs +324 -0
data/vendor/crates/spikard-rb/src/server.rs +305 -283
data/vendor/crates/spikard-rb/src/sse.rs +231 -231
data/vendor/crates/spikard-rb/src/{test_client.rs → testing/client.rs} +538 -404
data/vendor/crates/spikard-rb/src/testing/mod.rs +7 -0
data/vendor/crates/spikard-rb/src/{test_sse.rs → testing/sse.rs} +143 -143
data/vendor/crates/spikard-rb/src/testing/websocket.rs +608 -0
data/vendor/crates/spikard-rb/src/websocket.rs +377 -233
metadata +60 -13
data/vendor/crates/spikard-http/src/parameters.rs +0 -1
data/vendor/crates/spikard-http/src/problem.rs +0 -1
data/vendor/crates/spikard-http/src/router.rs +0 -1
data/vendor/crates/spikard-http/src/schema_registry.rs +0 -1
data/vendor/crates/spikard-http/src/type_hints.rs +0 -1
data/vendor/crates/spikard-http/src/validation.rs +0 -1
data/vendor/crates/spikard-rb/src/test_websocket.rs +0 -221

data/vendor/crates/spikard-http/src/server/lifecycle_execution.rs CHANGED Viewed

@@ -1,98 +1,234 @@
-//! Lifecycle hooks execution logic
-use crate::handler_trait::Handler;
-use axum::body::Body;
-use axum::http::StatusCode;
-use std::sync::Arc;
-/// Execute a handler with lifecycle hooks
-///
-/// This wraps the handler execution with lifecycle hooks at appropriate points:
-/// 1. preValidation hooks (before handler, which does validation)
-/// 2. preHandler hooks (after validation, before handler)
-/// 3. Handler execution
-/// 4. onResponse hooks (after successful handler execution)
-/// 5. onError hooks (if handler or any hook fails)
-pub async fn execute_with_lifecycle_hooks(
-    req: axum::http::Request<Body>,
-    request_data: crate::handler_trait::RequestData,
-    handler: Arc<dyn Handler>,
-    hooks: Option<Arc<crate::LifecycleHooks>>,
-) -> Result<axum::http::Response<Body>, (axum::http::StatusCode, String)> {
-    use crate::lifecycle::HookResult;
-    let Some(hooks) = hooks else {
-        return handler.call(req, request_data).await;
-    };
-    if hooks.is_empty() {
-        return handler.call(req, request_data).await;
-    }
-    let req = match hooks.execute_pre_validation(req).await {
-        Ok(HookResult::Continue(r)) => r,
-        Ok(HookResult::ShortCircuit(response)) => return Ok(response),
-        Err(e) => {
-            let error_response = axum::http::Response::builder()
-                .status(StatusCode::INTERNAL_SERVER_ERROR)
-                .body(Body::from(format!(
-                    "{{\"error\":\"preValidation hook failed: {}\"}}",
-                    e
-                )))
-                .unwrap();
-            return match hooks.execute_on_error(error_response).await {
-                Ok(resp) => Ok(resp),
-                Err(_) => Ok(axum::http::Response::builder()
-                    .status(StatusCode::INTERNAL_SERVER_ERROR)
-                    .body(Body::from("{\"error\":\"Hook execution failed\"}"))
-                    .unwrap()),
-            };
-        }
-    };
-    let req = match hooks.execute_pre_handler(req).await {
-        Ok(HookResult::Continue(r)) => r,
-        Ok(HookResult::ShortCircuit(response)) => return Ok(response),
-        Err(e) => {
-            let error_response = axum::http::Response::builder()
-                .status(StatusCode::INTERNAL_SERVER_ERROR)
-                .body(Body::from(format!("{{\"error\":\"preHandler hook failed: {}\"}}", e)))
-                .unwrap();
-            return match hooks.execute_on_error(error_response).await {
-                Ok(resp) => Ok(resp),
-                Err(_) => Ok(axum::http::Response::builder()
-                    .status(StatusCode::INTERNAL_SERVER_ERROR)
-                    .body(Body::from("{\"error\":\"Hook execution failed\"}"))
-                    .unwrap()),
-            };
-        }
-    };
-    let response = match handler.call(req, request_data).await {
-        Ok(resp) => resp,
-        Err((status, message)) => {
-            let error_response = axum::http::Response::builder()
-                .status(status)
-                .body(Body::from(message))
-                .unwrap();
-            return match hooks.execute_on_error(error_response).await {
-                Ok(resp) => Ok(resp),
-                Err(e) => Ok(axum::http::Response::builder()
-                    .status(StatusCode::INTERNAL_SERVER_ERROR)
-                    .body(Body::from(format!("{{\"error\":\"onError hook failed: {}\"}}", e)))
-                    .unwrap()),
-            };
-        }
-    };
-    match hooks.execute_on_response(response).await {
-        Ok(resp) => Ok(resp),
-        Err(e) => Ok(axum::http::Response::builder()
-            .status(StatusCode::INTERNAL_SERVER_ERROR)
-            .body(Body::from(format!("{{\"error\":\"onResponse hook failed: {}\"}}", e)))
-            .unwrap()),
-    }
-}
+//! Lifecycle hooks execution logic
+use crate::handler_trait::Handler;
+use axum::body::Body;
+use axum::http::StatusCode;
+use std::sync::Arc;
+/// Execute a handler with lifecycle hooks
+///
+/// This wraps the handler execution with lifecycle hooks at appropriate points:
+/// 1. preValidation hooks (before handler, which does validation)
+/// 2. preHandler hooks (after validation, before handler)
+/// 3. Handler execution
+/// 4. onResponse hooks (after successful handler execution)
+/// 5. onError hooks (if handler or any hook fails)
+pub async fn execute_with_lifecycle_hooks(
+    req: axum::http::Request<Body>,
+    request_data: crate::handler_trait::RequestData,
+    handler: Arc<dyn Handler>,
+    hooks: Option<Arc<crate::LifecycleHooks>>,
+) -> Result<axum::http::Response<Body>, (axum::http::StatusCode, String)> {
+    use crate::lifecycle::HookResult;
+    let Some(hooks) = hooks else {
+        return handler.call(req, request_data).await;
+    };
+    if hooks.is_empty() {
+        return handler.call(req, request_data).await;
+    }
+    let req = match hooks.execute_pre_validation(req).await {
+        Ok(HookResult::Continue(r)) => r,
+        Ok(HookResult::ShortCircuit(response)) => return Ok(response),
+        Err(e) => {
+            let error_response = axum::http::Response::builder()
+                .status(StatusCode::INTERNAL_SERVER_ERROR)
+                .body(Body::from(format!(
+                    "{{\"error\":\"preValidation hook failed: {}\"}}",
+                    e
+                )))
+                .unwrap();
+            return match hooks.execute_on_error(error_response).await {
+                Ok(resp) => Ok(resp),
+                Err(_) => Ok(axum::http::Response::builder()
+                    .status(StatusCode::INTERNAL_SERVER_ERROR)
+                    .body(Body::from("{\"error\":\"Hook execution failed\"}"))
+                    .unwrap()),
+            };
+        }
+    };
+    let req = match hooks.execute_pre_handler(req).await {
+        Ok(HookResult::Continue(r)) => r,
+        Ok(HookResult::ShortCircuit(response)) => return Ok(response),
+        Err(e) => {
+            let error_response = axum::http::Response::builder()
+                .status(StatusCode::INTERNAL_SERVER_ERROR)
+                .body(Body::from(format!("{{\"error\":\"preHandler hook failed: {}\"}}", e)))
+                .unwrap();
+            return match hooks.execute_on_error(error_response).await {
+                Ok(resp) => Ok(resp),
+                Err(_) => Ok(axum::http::Response::builder()
+                    .status(StatusCode::INTERNAL_SERVER_ERROR)
+                    .body(Body::from("{\"error\":\"Hook execution failed\"}"))
+                    .unwrap()),
+            };
+        }
+    };
+    let response = match handler.call(req, request_data).await {
+        Ok(resp) => resp,
+        Err((status, message)) => {
+            let error_response = axum::http::Response::builder()
+                .status(status)
+                .body(Body::from(message))
+                .unwrap();
+            return match hooks.execute_on_error(error_response).await {
+                Ok(resp) => Ok(resp),
+                Err(e) => Ok(axum::http::Response::builder()
+                    .status(StatusCode::INTERNAL_SERVER_ERROR)
+                    .body(Body::from(format!("{{\"error\":\"onError hook failed: {}\"}}", e)))
+                    .unwrap()),
+            };
+        }
+    };
+    match hooks.execute_on_response(response).await {
+        Ok(resp) => Ok(resp),
+        Err(e) => Ok(axum::http::Response::builder()
+            .status(StatusCode::INTERNAL_SERVER_ERROR)
+            .body(Body::from(format!("{{\"error\":\"onResponse hook failed: {}\"}}", e)))
+            .unwrap()),
+    }
+}
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::lifecycle::{HookResult, request_hook, response_hook};
+    use axum::http::{Request, Response, StatusCode};
+    use http_body_util::BodyExt;
+    use serde_json::json;
+    use std::collections::HashMap;
+    struct OkHandler;
+    impl Handler for OkHandler {
+        fn call(
+            &self,
+            _request: Request<Body>,
+            _request_data: crate::handler_trait::RequestData,
+        ) -> std::pin::Pin<Box<dyn std::future::Future<Output = crate::handler_trait::HandlerResult> + Send + '_>>
+        {
+            Box::pin(async move {
+                Ok(Response::builder()
+                    .status(StatusCode::OK)
+                    .body(Body::from("ok"))
+                    .unwrap())
+            })
+        }
+    }
+    struct ErrHandler;
+    impl Handler for ErrHandler {
+        fn call(
+            &self,
+            _request: Request<Body>,
+            _request_data: crate::handler_trait::RequestData,
+        ) -> std::pin::Pin<Box<dyn std::future::Future<Output = crate::handler_trait::HandlerResult> + Send + '_>>
+        {
+            Box::pin(async move { Err((StatusCode::BAD_REQUEST, "bad".to_string())) })
+        }
+    }
+    fn empty_request_data() -> crate::handler_trait::RequestData {
+        crate::handler_trait::RequestData {
+            path_params: std::sync::Arc::new(HashMap::new()),
+            query_params: json!({}),
+            validated_params: None,
+            raw_query_params: std::sync::Arc::new(HashMap::new()),
+            body: json!(null),
+            raw_body: None,
+            headers: std::sync::Arc::new(HashMap::new()),
+            cookies: std::sync::Arc::new(HashMap::new()),
+            method: "GET".to_string(),
+            path: "/".to_string(),
+            #[cfg(feature = "di")]
+            dependencies: None,
+        }
+    }
+    #[tokio::test]
+    async fn pre_validation_error_with_failing_on_error_hook_returns_fallback() {
+        let mut hooks = crate::LifecycleHooks::new();
+        hooks.add_pre_validation(request_hook("boom", |_req| async move { Err("boom".to_string()) }));
+        hooks.add_on_error(response_hook("fail-on-error", |_resp| async move {
+            Err("fail".to_string())
+        }));
+        let req = Request::builder().uri("/").body(Body::empty()).unwrap();
+        let resp = execute_with_lifecycle_hooks(req, empty_request_data(), Arc::new(OkHandler), Some(Arc::new(hooks)))
+            .await
+            .unwrap();
+        assert_eq!(resp.status(), StatusCode::INTERNAL_SERVER_ERROR);
+        let body = resp.into_body().collect().await.unwrap().to_bytes();
+        assert_eq!(body.as_ref(), b"{\"error\":\"Hook execution failed\"}");
+    }
+    #[tokio::test]
+    async fn handler_error_with_failing_on_error_hook_returns_on_error_hook_failed_response() {
+        let mut hooks = crate::LifecycleHooks::new();
+        hooks.add_on_error(response_hook("fail-on-error", |_resp| async move {
+            Err("boom".to_string())
+        }));
+        let req = Request::builder().uri("/").body(Body::empty()).unwrap();
+        let resp = execute_with_lifecycle_hooks(req, empty_request_data(), Arc::new(ErrHandler), Some(Arc::new(hooks)))
+            .await
+            .unwrap();
+        assert_eq!(resp.status(), StatusCode::INTERNAL_SERVER_ERROR);
+        let body = resp.into_body().collect().await.unwrap().to_bytes();
+        let body_str = std::str::from_utf8(body.as_ref()).unwrap();
+        assert!(body_str.contains("\"error\":\"onError hook failed:"));
+        assert!(body_str.contains("boom"));
+    }
+    #[tokio::test]
+    async fn on_response_hook_error_returns_on_response_hook_failed_response() {
+        let mut hooks = crate::LifecycleHooks::new();
+        hooks.add_on_response(response_hook("fail-on-response", |_resp| async move {
+            Err("boom".to_string())
+        }));
+        let req = Request::builder().uri("/").body(Body::empty()).unwrap();
+        let resp = execute_with_lifecycle_hooks(req, empty_request_data(), Arc::new(OkHandler), Some(Arc::new(hooks)))
+            .await
+            .unwrap();
+        assert_eq!(resp.status(), StatusCode::INTERNAL_SERVER_ERROR);
+        let body = resp.into_body().collect().await.unwrap().to_bytes();
+        let body_str = std::str::from_utf8(body.as_ref()).unwrap();
+        assert!(body_str.contains("\"error\":\"onResponse hook failed:"));
+        assert!(body_str.contains("boom"));
+    }
+    #[tokio::test]
+    async fn pre_validation_short_circuit_skips_handler_and_returns_response() {
+        let mut hooks = crate::LifecycleHooks::new();
+        hooks.add_pre_validation(request_hook("short-circuit", |_req| async move {
+            Ok(HookResult::ShortCircuit(
+                Response::builder()
+                    .status(StatusCode::UNAUTHORIZED)
+                    .body(Body::from("nope"))
+                    .unwrap(),
+            ))
+        }));
+        let req = Request::builder().uri("/").body(Body::empty()).unwrap();
+        let resp = execute_with_lifecycle_hooks(req, empty_request_data(), Arc::new(ErrHandler), Some(Arc::new(hooks)))
+            .await
+            .unwrap();
+        assert_eq!(resp.status(), StatusCode::UNAUTHORIZED);
+        let body = resp.into_body().collect().await.unwrap().to_bytes();
+        assert_eq!(body.as_ref(), b"nope");
+    }
+}