spikard 0.12.0 → 0.15.2
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.
- checksums.yaml +4 -4
- data/Steepfile +6 -0
- data/ext/spikard_rb/extconf.rb +1 -2
- data/ext/spikard_rb/{Cargo.lock → native/Cargo.lock} +897 -451
- data/ext/spikard_rb/native/Cargo.toml +24 -0
- data/ext/spikard_rb/src/lib.rs +5366 -3
- data/lib/spikard/native.rb +86 -0
- data/lib/spikard/version.rb +6 -1
- data/lib/spikard.rb +8 -45
- data/lib/spikard_rb.so +0 -0
- data/sig/types.rbs +427 -0
- metadata +14 -242
- data/LICENSE +0 -1
- data/README.md +0 -267
- data/ext/spikard_rb/Cargo.toml +0 -17
- data/lib/spikard/app.rb +0 -428
- data/lib/spikard/background.rb +0 -58
- data/lib/spikard/config.rb +0 -506
- data/lib/spikard/converters.rb +0 -13
- data/lib/spikard/grpc.rb +0 -182
- data/lib/spikard/handler_wrapper.rb +0 -113
- data/lib/spikard/provide.rb +0 -214
- data/lib/spikard/response.rb +0 -173
- data/lib/spikard/schema.rb +0 -243
- data/lib/spikard/sse.rb +0 -111
- data/lib/spikard/streaming_response.rb +0 -44
- data/lib/spikard/testing.rb +0 -432
- data/lib/spikard/upload_file.rb +0 -131
- data/lib/spikard/websocket.rb +0 -59
- data/sig/spikard.rbs +0 -719
- data/vendor/crates/spikard-bindings-shared/Cargo.toml +0 -80
- data/vendor/crates/spikard-bindings-shared/examples/config_extraction.rs +0 -132
- data/vendor/crates/spikard-bindings-shared/src/config_extractor.rs +0 -905
- data/vendor/crates/spikard-bindings-shared/src/conversion_traits.rs +0 -210
- data/vendor/crates/spikard-bindings-shared/src/di_traits.rs +0 -252
- data/vendor/crates/spikard-bindings-shared/src/error_response.rs +0 -404
- data/vendor/crates/spikard-bindings-shared/src/grpc_metadata.rs +0 -199
- data/vendor/crates/spikard-bindings-shared/src/handler_base.rs +0 -252
- data/vendor/crates/spikard-bindings-shared/src/json_conversion.rs +0 -829
- data/vendor/crates/spikard-bindings-shared/src/lazy_cache.rs +0 -587
- data/vendor/crates/spikard-bindings-shared/src/lib.rs +0 -33
- data/vendor/crates/spikard-bindings-shared/src/lifecycle_base.rs +0 -298
- data/vendor/crates/spikard-bindings-shared/src/lifecycle_executor.rs +0 -594
- data/vendor/crates/spikard-bindings-shared/src/response_builder.rs +0 -743
- data/vendor/crates/spikard-bindings-shared/src/response_interpreter.rs +0 -944
- data/vendor/crates/spikard-bindings-shared/src/test_client_base.rs +0 -260
- data/vendor/crates/spikard-bindings-shared/src/validation_helpers.rs +0 -369
- data/vendor/crates/spikard-bindings-shared/tests/config_extractor_behavior.rs +0 -192
- data/vendor/crates/spikard-bindings-shared/tests/error_response_edge_cases.rs +0 -383
- data/vendor/crates/spikard-bindings-shared/tests/full_coverage.rs +0 -459
- data/vendor/crates/spikard-bindings-shared/tests/handler_base_integration.rs +0 -280
- data/vendor/crates/spikard-bindings-shared/tests/integration_tests.rs +0 -669
- data/vendor/crates/spikard-core/Cargo.toml +0 -60
- data/vendor/crates/spikard-core/src/bindings/mod.rs +0 -3
- data/vendor/crates/spikard-core/src/bindings/response.rs +0 -130
- data/vendor/crates/spikard-core/src/debug.rs +0 -127
- data/vendor/crates/spikard-core/src/di/container.rs +0 -702
- data/vendor/crates/spikard-core/src/di/dependency.rs +0 -273
- data/vendor/crates/spikard-core/src/di/error.rs +0 -118
- data/vendor/crates/spikard-core/src/di/factory.rs +0 -538
- data/vendor/crates/spikard-core/src/di/graph.rs +0 -507
- data/vendor/crates/spikard-core/src/di/mod.rs +0 -192
- data/vendor/crates/spikard-core/src/di/resolved.rs +0 -428
- data/vendor/crates/spikard-core/src/di/value.rs +0 -282
- data/vendor/crates/spikard-core/src/errors.rs +0 -72
- data/vendor/crates/spikard-core/src/http.rs +0 -492
- data/vendor/crates/spikard-core/src/lib.rs +0 -29
- data/vendor/crates/spikard-core/src/lifecycle.rs +0 -1273
- data/vendor/crates/spikard-core/src/metadata.rs +0 -378
- data/vendor/crates/spikard-core/src/parameters.rs +0 -2546
- data/vendor/crates/spikard-core/src/problem.rs +0 -358
- data/vendor/crates/spikard-core/src/request_data.rs +0 -1146
- data/vendor/crates/spikard-core/src/router.rs +0 -530
- data/vendor/crates/spikard-core/src/schema_registry.rs +0 -197
- data/vendor/crates/spikard-core/src/type_hints.rs +0 -311
- data/vendor/crates/spikard-core/src/validation/error_mapper.rs +0 -710
- data/vendor/crates/spikard-core/src/validation/mod.rs +0 -470
- data/vendor/crates/spikard-core/tests/bindings_response_tests.rs +0 -136
- data/vendor/crates/spikard-core/tests/di_dependency_defaults.rs +0 -37
- data/vendor/crates/spikard-core/tests/error_mapper.rs +0 -761
- data/vendor/crates/spikard-core/tests/parameters_edge_cases.rs +0 -106
- data/vendor/crates/spikard-core/tests/parameters_full.rs +0 -701
- data/vendor/crates/spikard-core/tests/parameters_schema_and_formats.rs +0 -301
- data/vendor/crates/spikard-core/tests/request_data_roundtrip.rs +0 -67
- data/vendor/crates/spikard-core/tests/validation_coverage.rs +0 -250
- data/vendor/crates/spikard-core/tests/validation_error_paths.rs +0 -45
- data/vendor/crates/spikard-http/Cargo.toml +0 -87
- data/vendor/crates/spikard-http/examples/sse-notifications.rs +0 -148
- data/vendor/crates/spikard-http/examples/websocket-chat.rs +0 -92
- data/vendor/crates/spikard-http/src/auth.rs +0 -301
- data/vendor/crates/spikard-http/src/background.rs +0 -1860
- data/vendor/crates/spikard-http/src/bindings/mod.rs +0 -3
- data/vendor/crates/spikard-http/src/bindings/response.rs +0 -1
- data/vendor/crates/spikard-http/src/body_metadata.rs +0 -8
- data/vendor/crates/spikard-http/src/cors.rs +0 -1026
- data/vendor/crates/spikard-http/src/debug.rs +0 -128
- data/vendor/crates/spikard-http/src/di_handler.rs +0 -1672
- data/vendor/crates/spikard-http/src/grpc/framing.rs +0 -469
- data/vendor/crates/spikard-http/src/grpc/handler.rs +0 -1122
- data/vendor/crates/spikard-http/src/grpc/mod.rs +0 -434
- data/vendor/crates/spikard-http/src/grpc/service.rs +0 -622
- data/vendor/crates/spikard-http/src/grpc/streaming.rs +0 -319
- data/vendor/crates/spikard-http/src/handler_response.rs +0 -901
- data/vendor/crates/spikard-http/src/handler_trait.rs +0 -1015
- data/vendor/crates/spikard-http/src/handler_trait_tests.rs +0 -290
- data/vendor/crates/spikard-http/src/jsonrpc/http_handler.rs +0 -502
- data/vendor/crates/spikard-http/src/jsonrpc/method_registry.rs +0 -648
- data/vendor/crates/spikard-http/src/jsonrpc/mod.rs +0 -58
- data/vendor/crates/spikard-http/src/jsonrpc/protocol.rs +0 -1207
- data/vendor/crates/spikard-http/src/jsonrpc/router.rs +0 -2262
- data/vendor/crates/spikard-http/src/lib.rs +0 -548
- data/vendor/crates/spikard-http/src/lifecycle/adapter.rs +0 -230
- data/vendor/crates/spikard-http/src/lifecycle.rs +0 -1193
- data/vendor/crates/spikard-http/src/middleware/mod.rs +0 -560
- data/vendor/crates/spikard-http/src/middleware/multipart.rs +0 -912
- data/vendor/crates/spikard-http/src/middleware/urlencoded.rs +0 -513
- data/vendor/crates/spikard-http/src/middleware/validation.rs +0 -768
- data/vendor/crates/spikard-http/src/openapi/mod.rs +0 -309
- data/vendor/crates/spikard-http/src/openapi/parameter_extraction.rs +0 -535
- data/vendor/crates/spikard-http/src/openapi/schema_conversion.rs +0 -1363
- data/vendor/crates/spikard-http/src/openapi/spec_generation.rs +0 -667
- data/vendor/crates/spikard-http/src/query_parser.rs +0 -793
- data/vendor/crates/spikard-http/src/response.rs +0 -720
- data/vendor/crates/spikard-http/src/server/fast_router.rs +0 -186
- data/vendor/crates/spikard-http/src/server/grpc_routing.rs +0 -858
- data/vendor/crates/spikard-http/src/server/handler.rs +0 -1661
- data/vendor/crates/spikard-http/src/server/lifecycle_execution.rs +0 -253
- data/vendor/crates/spikard-http/src/server/mod.rs +0 -1649
- data/vendor/crates/spikard-http/src/server/request_extraction.rs +0 -871
- data/vendor/crates/spikard-http/src/server/routing_factory.rs +0 -618
- data/vendor/crates/spikard-http/src/sse.rs +0 -1409
- data/vendor/crates/spikard-http/src/testing/form.rs +0 -52
- data/vendor/crates/spikard-http/src/testing/multipart.rs +0 -64
- data/vendor/crates/spikard-http/src/testing/test_client.rs +0 -787
- data/vendor/crates/spikard-http/src/testing.rs +0 -617
- data/vendor/crates/spikard-http/src/websocket.rs +0 -1477
- data/vendor/crates/spikard-http/tests/auth_integration.rs +0 -645
- data/vendor/crates/spikard-http/tests/background_behavior.rs +0 -832
- data/vendor/crates/spikard-http/tests/common/grpc_helpers.rs +0 -1012
- data/vendor/crates/spikard-http/tests/common/handlers.rs +0 -309
- data/vendor/crates/spikard-http/tests/common/mod.rs +0 -33
- data/vendor/crates/spikard-http/tests/common/test_builders.rs +0 -628
- data/vendor/crates/spikard-http/tests/di_handler_error_responses.rs +0 -162
- data/vendor/crates/spikard-http/tests/di_integration.rs +0 -192
- data/vendor/crates/spikard-http/tests/doc_snippets.rs +0 -5
- data/vendor/crates/spikard-http/tests/grpc_bidirectional_streaming.rs +0 -430
- data/vendor/crates/spikard-http/tests/grpc_client_streaming.rs +0 -738
- data/vendor/crates/spikard-http/tests/grpc_error_handling_test.rs +0 -652
- data/vendor/crates/spikard-http/tests/grpc_integration_test.rs +0 -334
- data/vendor/crates/spikard-http/tests/grpc_metadata_test.rs +0 -532
- data/vendor/crates/spikard-http/tests/grpc_server_integration.rs +0 -495
- data/vendor/crates/spikard-http/tests/grpc_server_streaming.rs +0 -974
- data/vendor/crates/spikard-http/tests/lifecycle_execution.rs +0 -1093
- data/vendor/crates/spikard-http/tests/middleware_stack_integration.rs +0 -389
- data/vendor/crates/spikard-http/tests/multipart_behavior.rs +0 -656
- data/vendor/crates/spikard-http/tests/request_extraction_full.rs +0 -513
- data/vendor/crates/spikard-http/tests/server_auth_middleware_behavior.rs +0 -328
- data/vendor/crates/spikard-http/tests/server_config_builder.rs +0 -314
- data/vendor/crates/spikard-http/tests/server_configured_router_behavior.rs +0 -200
- data/vendor/crates/spikard-http/tests/server_cors_preflight.rs +0 -83
- data/vendor/crates/spikard-http/tests/server_handler_wrappers.rs +0 -464
- data/vendor/crates/spikard-http/tests/server_method_router_additional_behavior.rs +0 -286
- data/vendor/crates/spikard-http/tests/server_method_router_coverage.rs +0 -118
- data/vendor/crates/spikard-http/tests/server_middleware_behavior.rs +0 -99
- data/vendor/crates/spikard-http/tests/server_middleware_branches.rs +0 -204
- data/vendor/crates/spikard-http/tests/server_openapi_jsonrpc_static.rs +0 -421
- data/vendor/crates/spikard-http/tests/server_router_behavior.rs +0 -121
- data/vendor/crates/spikard-http/tests/sse_behavior.rs +0 -620
- data/vendor/crates/spikard-http/tests/sse_full_behavior.rs +0 -584
- data/vendor/crates/spikard-http/tests/sse_handler_behavior.rs +0 -130
- data/vendor/crates/spikard-http/tests/test_client_requests.rs +0 -167
- data/vendor/crates/spikard-http/tests/testing_helpers.rs +0 -87
- data/vendor/crates/spikard-http/tests/testing_module_coverage.rs +0 -155
- data/vendor/crates/spikard-http/tests/urlencoded_content_type.rs +0 -82
- data/vendor/crates/spikard-http/tests/websocket_behavior.rs +0 -663
- data/vendor/crates/spikard-http/tests/websocket_full_behavior.rs +0 -440
- data/vendor/crates/spikard-http/tests/websocket_integration.rs +0 -150
- data/vendor/crates/spikard-rb/Cargo.toml +0 -68
- data/vendor/crates/spikard-rb/build.rs +0 -200
- data/vendor/crates/spikard-rb/src/background.rs +0 -63
- data/vendor/crates/spikard-rb/src/config/mod.rs +0 -5
- data/vendor/crates/spikard-rb/src/config/server_config.rs +0 -401
- data/vendor/crates/spikard-rb/src/conversion.rs +0 -688
- data/vendor/crates/spikard-rb/src/di/builder.rs +0 -100
- data/vendor/crates/spikard-rb/src/di/mod.rs +0 -375
- data/vendor/crates/spikard-rb/src/grpc/handler.rs +0 -834
- data/vendor/crates/spikard-rb/src/grpc/mod.rs +0 -13
- data/vendor/crates/spikard-rb/src/gvl.rs +0 -80
- data/vendor/crates/spikard-rb/src/handler.rs +0 -699
- data/vendor/crates/spikard-rb/src/integration/mod.rs +0 -3
- data/vendor/crates/spikard-rb/src/lib.rs +0 -2264
- data/vendor/crates/spikard-rb/src/lifecycle.rs +0 -303
- data/vendor/crates/spikard-rb/src/metadata/mod.rs +0 -5
- data/vendor/crates/spikard-rb/src/metadata/route_extraction.rs +0 -507
- data/vendor/crates/spikard-rb/src/request.rs +0 -439
- data/vendor/crates/spikard-rb/src/runtime/mod.rs +0 -5
- data/vendor/crates/spikard-rb/src/runtime/server_runner.rs +0 -344
- data/vendor/crates/spikard-rb/src/server.rs +0 -307
- data/vendor/crates/spikard-rb/src/sse.rs +0 -231
- data/vendor/crates/spikard-rb/src/testing/client.rs +0 -698
- data/vendor/crates/spikard-rb/src/testing/mod.rs +0 -7
- data/vendor/crates/spikard-rb/src/testing/sse.rs +0 -108
- data/vendor/crates/spikard-rb/src/testing/websocket.rs +0 -573
- data/vendor/crates/spikard-rb/src/websocket.rs +0 -475
- data/vendor/crates/spikard-rb-macros/Cargo.toml +0 -25
- data/vendor/crates/spikard-rb-macros/src/lib.rs +0 -51
metadata
CHANGED
|
@@ -1,28 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: spikard
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.15.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
|
-
- Na'aman Hirschfeld
|
|
7
|
+
- Na'aman Hirschfeld <nhirschfeld@gmail.com>
|
|
8
8
|
bindir: bin
|
|
9
9
|
cert_chain: []
|
|
10
10
|
date: 1980-01-02 00:00:00.000000000 Z
|
|
11
11
|
dependencies:
|
|
12
|
-
- !ruby/object:Gem::Dependency
|
|
13
|
-
name: base64
|
|
14
|
-
requirement: !ruby/object:Gem::Requirement
|
|
15
|
-
requirements:
|
|
16
|
-
- - ">="
|
|
17
|
-
- !ruby/object:Gem::Version
|
|
18
|
-
version: '0'
|
|
19
|
-
type: :runtime
|
|
20
|
-
prerelease: false
|
|
21
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
22
|
-
requirements:
|
|
23
|
-
- - ">="
|
|
24
|
-
- !ruby/object:Gem::Version
|
|
25
|
-
version: '0'
|
|
26
12
|
- !ruby/object:Gem::Dependency
|
|
27
13
|
name: rb_sys
|
|
28
14
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -38,251 +24,40 @@ dependencies:
|
|
|
38
24
|
- !ruby/object:Gem::Version
|
|
39
25
|
version: '0.9'
|
|
40
26
|
- !ruby/object:Gem::Dependency
|
|
41
|
-
name:
|
|
27
|
+
name: sorbet-runtime
|
|
42
28
|
requirement: !ruby/object:Gem::Requirement
|
|
43
29
|
requirements:
|
|
44
30
|
- - "~>"
|
|
45
31
|
- !ruby/object:Gem::Version
|
|
46
|
-
version: '0.
|
|
32
|
+
version: '0.5'
|
|
47
33
|
type: :runtime
|
|
48
34
|
prerelease: false
|
|
49
35
|
version_requirements: !ruby/object:Gem::Requirement
|
|
50
36
|
requirements:
|
|
51
37
|
- - "~>"
|
|
52
38
|
- !ruby/object:Gem::Version
|
|
53
|
-
version: '0.
|
|
54
|
-
description:
|
|
55
|
-
Spikard is a Rust-centric multi-language HTTP toolkit providing a high-performance core library
|
|
56
|
-
and language bindings (Python, Node.js, Ruby, PHP, WebAssembly) to build and validate typed web services.
|
|
57
|
-
|
|
58
|
-
The Ruby binding uses Magnus for zero-overhead FFI, providing Sinatra-style routing, full async/await support,
|
|
59
|
-
WebSockets, Server-Sent Events, request validation with JSON Schema and dry-schema, lifecycle hooks,
|
|
60
|
-
dependency injection, and comprehensive middleware stack (compression, rate limiting, authentication).
|
|
61
|
-
|
|
62
|
-
Features:
|
|
63
|
-
- Zero-copy Rust-to-Ruby serialization via Magnus
|
|
64
|
-
- Async-first with Tokio and Axum backing
|
|
65
|
-
- Type-safe RBS type definitions for Steep
|
|
66
|
-
- Tower-HTTP middleware stack
|
|
67
|
-
- Lifecycle hooks (onRequest, preValidation, preHandler, onResponse, onError)
|
|
68
|
-
- Built-in WebSocket and SSE support
|
|
69
|
-
- Request validation with JSON Schema
|
|
70
|
-
email:
|
|
71
|
-
- nhirschfeld@gmail.com
|
|
39
|
+
version: '0.5'
|
|
40
|
+
description: Rust-centric multi-language HTTP framework with polyglot bindings
|
|
72
41
|
executables: []
|
|
73
42
|
extensions:
|
|
74
43
|
- ext/spikard_rb/extconf.rb
|
|
75
44
|
extra_rdoc_files: []
|
|
76
45
|
files:
|
|
77
|
-
-
|
|
78
|
-
- README.md
|
|
79
|
-
- ext/spikard_rb/Cargo.lock
|
|
80
|
-
- ext/spikard_rb/Cargo.toml
|
|
46
|
+
- Steepfile
|
|
81
47
|
- ext/spikard_rb/extconf.rb
|
|
48
|
+
- ext/spikard_rb/native/Cargo.lock
|
|
49
|
+
- ext/spikard_rb/native/Cargo.toml
|
|
82
50
|
- ext/spikard_rb/src/lib.rs
|
|
83
51
|
- lib/spikard.rb
|
|
84
|
-
- lib/spikard/
|
|
85
|
-
- lib/spikard/background.rb
|
|
86
|
-
- lib/spikard/config.rb
|
|
87
|
-
- lib/spikard/converters.rb
|
|
88
|
-
- lib/spikard/grpc.rb
|
|
89
|
-
- lib/spikard/handler_wrapper.rb
|
|
90
|
-
- lib/spikard/provide.rb
|
|
91
|
-
- lib/spikard/response.rb
|
|
92
|
-
- lib/spikard/schema.rb
|
|
93
|
-
- lib/spikard/sse.rb
|
|
94
|
-
- lib/spikard/streaming_response.rb
|
|
95
|
-
- lib/spikard/testing.rb
|
|
96
|
-
- lib/spikard/upload_file.rb
|
|
52
|
+
- lib/spikard/native.rb
|
|
97
53
|
- lib/spikard/version.rb
|
|
98
|
-
- lib/
|
|
99
|
-
- sig/
|
|
100
|
-
- vendor/crates/spikard-bindings-shared/Cargo.toml
|
|
101
|
-
- vendor/crates/spikard-bindings-shared/examples/config_extraction.rs
|
|
102
|
-
- vendor/crates/spikard-bindings-shared/src/config_extractor.rs
|
|
103
|
-
- vendor/crates/spikard-bindings-shared/src/conversion_traits.rs
|
|
104
|
-
- vendor/crates/spikard-bindings-shared/src/di_traits.rs
|
|
105
|
-
- vendor/crates/spikard-bindings-shared/src/error_response.rs
|
|
106
|
-
- vendor/crates/spikard-bindings-shared/src/grpc_metadata.rs
|
|
107
|
-
- vendor/crates/spikard-bindings-shared/src/handler_base.rs
|
|
108
|
-
- vendor/crates/spikard-bindings-shared/src/json_conversion.rs
|
|
109
|
-
- vendor/crates/spikard-bindings-shared/src/lazy_cache.rs
|
|
110
|
-
- vendor/crates/spikard-bindings-shared/src/lib.rs
|
|
111
|
-
- vendor/crates/spikard-bindings-shared/src/lifecycle_base.rs
|
|
112
|
-
- vendor/crates/spikard-bindings-shared/src/lifecycle_executor.rs
|
|
113
|
-
- vendor/crates/spikard-bindings-shared/src/response_builder.rs
|
|
114
|
-
- vendor/crates/spikard-bindings-shared/src/response_interpreter.rs
|
|
115
|
-
- vendor/crates/spikard-bindings-shared/src/test_client_base.rs
|
|
116
|
-
- vendor/crates/spikard-bindings-shared/src/validation_helpers.rs
|
|
117
|
-
- vendor/crates/spikard-bindings-shared/tests/config_extractor_behavior.rs
|
|
118
|
-
- vendor/crates/spikard-bindings-shared/tests/error_response_edge_cases.rs
|
|
119
|
-
- vendor/crates/spikard-bindings-shared/tests/full_coverage.rs
|
|
120
|
-
- vendor/crates/spikard-bindings-shared/tests/handler_base_integration.rs
|
|
121
|
-
- vendor/crates/spikard-bindings-shared/tests/integration_tests.rs
|
|
122
|
-
- vendor/crates/spikard-core/Cargo.toml
|
|
123
|
-
- vendor/crates/spikard-core/src/bindings/mod.rs
|
|
124
|
-
- vendor/crates/spikard-core/src/bindings/response.rs
|
|
125
|
-
- vendor/crates/spikard-core/src/debug.rs
|
|
126
|
-
- vendor/crates/spikard-core/src/di/container.rs
|
|
127
|
-
- vendor/crates/spikard-core/src/di/dependency.rs
|
|
128
|
-
- vendor/crates/spikard-core/src/di/error.rs
|
|
129
|
-
- vendor/crates/spikard-core/src/di/factory.rs
|
|
130
|
-
- vendor/crates/spikard-core/src/di/graph.rs
|
|
131
|
-
- vendor/crates/spikard-core/src/di/mod.rs
|
|
132
|
-
- vendor/crates/spikard-core/src/di/resolved.rs
|
|
133
|
-
- vendor/crates/spikard-core/src/di/value.rs
|
|
134
|
-
- vendor/crates/spikard-core/src/errors.rs
|
|
135
|
-
- vendor/crates/spikard-core/src/http.rs
|
|
136
|
-
- vendor/crates/spikard-core/src/lib.rs
|
|
137
|
-
- vendor/crates/spikard-core/src/lifecycle.rs
|
|
138
|
-
- vendor/crates/spikard-core/src/metadata.rs
|
|
139
|
-
- vendor/crates/spikard-core/src/parameters.rs
|
|
140
|
-
- vendor/crates/spikard-core/src/problem.rs
|
|
141
|
-
- vendor/crates/spikard-core/src/request_data.rs
|
|
142
|
-
- vendor/crates/spikard-core/src/router.rs
|
|
143
|
-
- vendor/crates/spikard-core/src/schema_registry.rs
|
|
144
|
-
- vendor/crates/spikard-core/src/type_hints.rs
|
|
145
|
-
- vendor/crates/spikard-core/src/validation/error_mapper.rs
|
|
146
|
-
- vendor/crates/spikard-core/src/validation/mod.rs
|
|
147
|
-
- vendor/crates/spikard-core/tests/bindings_response_tests.rs
|
|
148
|
-
- vendor/crates/spikard-core/tests/di_dependency_defaults.rs
|
|
149
|
-
- vendor/crates/spikard-core/tests/error_mapper.rs
|
|
150
|
-
- vendor/crates/spikard-core/tests/parameters_edge_cases.rs
|
|
151
|
-
- vendor/crates/spikard-core/tests/parameters_full.rs
|
|
152
|
-
- vendor/crates/spikard-core/tests/parameters_schema_and_formats.rs
|
|
153
|
-
- vendor/crates/spikard-core/tests/request_data_roundtrip.rs
|
|
154
|
-
- vendor/crates/spikard-core/tests/validation_coverage.rs
|
|
155
|
-
- vendor/crates/spikard-core/tests/validation_error_paths.rs
|
|
156
|
-
- vendor/crates/spikard-http/Cargo.toml
|
|
157
|
-
- vendor/crates/spikard-http/examples/sse-notifications.rs
|
|
158
|
-
- vendor/crates/spikard-http/examples/websocket-chat.rs
|
|
159
|
-
- vendor/crates/spikard-http/src/auth.rs
|
|
160
|
-
- vendor/crates/spikard-http/src/background.rs
|
|
161
|
-
- vendor/crates/spikard-http/src/bindings/mod.rs
|
|
162
|
-
- vendor/crates/spikard-http/src/bindings/response.rs
|
|
163
|
-
- vendor/crates/spikard-http/src/body_metadata.rs
|
|
164
|
-
- vendor/crates/spikard-http/src/cors.rs
|
|
165
|
-
- vendor/crates/spikard-http/src/debug.rs
|
|
166
|
-
- vendor/crates/spikard-http/src/di_handler.rs
|
|
167
|
-
- vendor/crates/spikard-http/src/grpc/framing.rs
|
|
168
|
-
- vendor/crates/spikard-http/src/grpc/handler.rs
|
|
169
|
-
- vendor/crates/spikard-http/src/grpc/mod.rs
|
|
170
|
-
- vendor/crates/spikard-http/src/grpc/service.rs
|
|
171
|
-
- vendor/crates/spikard-http/src/grpc/streaming.rs
|
|
172
|
-
- vendor/crates/spikard-http/src/handler_response.rs
|
|
173
|
-
- vendor/crates/spikard-http/src/handler_trait.rs
|
|
174
|
-
- vendor/crates/spikard-http/src/handler_trait_tests.rs
|
|
175
|
-
- vendor/crates/spikard-http/src/jsonrpc/http_handler.rs
|
|
176
|
-
- vendor/crates/spikard-http/src/jsonrpc/method_registry.rs
|
|
177
|
-
- vendor/crates/spikard-http/src/jsonrpc/mod.rs
|
|
178
|
-
- vendor/crates/spikard-http/src/jsonrpc/protocol.rs
|
|
179
|
-
- vendor/crates/spikard-http/src/jsonrpc/router.rs
|
|
180
|
-
- vendor/crates/spikard-http/src/lib.rs
|
|
181
|
-
- vendor/crates/spikard-http/src/lifecycle.rs
|
|
182
|
-
- vendor/crates/spikard-http/src/lifecycle/adapter.rs
|
|
183
|
-
- vendor/crates/spikard-http/src/middleware/mod.rs
|
|
184
|
-
- vendor/crates/spikard-http/src/middleware/multipart.rs
|
|
185
|
-
- vendor/crates/spikard-http/src/middleware/urlencoded.rs
|
|
186
|
-
- vendor/crates/spikard-http/src/middleware/validation.rs
|
|
187
|
-
- vendor/crates/spikard-http/src/openapi/mod.rs
|
|
188
|
-
- vendor/crates/spikard-http/src/openapi/parameter_extraction.rs
|
|
189
|
-
- vendor/crates/spikard-http/src/openapi/schema_conversion.rs
|
|
190
|
-
- vendor/crates/spikard-http/src/openapi/spec_generation.rs
|
|
191
|
-
- vendor/crates/spikard-http/src/query_parser.rs
|
|
192
|
-
- vendor/crates/spikard-http/src/response.rs
|
|
193
|
-
- vendor/crates/spikard-http/src/server/fast_router.rs
|
|
194
|
-
- vendor/crates/spikard-http/src/server/grpc_routing.rs
|
|
195
|
-
- vendor/crates/spikard-http/src/server/handler.rs
|
|
196
|
-
- vendor/crates/spikard-http/src/server/lifecycle_execution.rs
|
|
197
|
-
- vendor/crates/spikard-http/src/server/mod.rs
|
|
198
|
-
- vendor/crates/spikard-http/src/server/request_extraction.rs
|
|
199
|
-
- vendor/crates/spikard-http/src/server/routing_factory.rs
|
|
200
|
-
- vendor/crates/spikard-http/src/sse.rs
|
|
201
|
-
- vendor/crates/spikard-http/src/testing.rs
|
|
202
|
-
- vendor/crates/spikard-http/src/testing/form.rs
|
|
203
|
-
- vendor/crates/spikard-http/src/testing/multipart.rs
|
|
204
|
-
- vendor/crates/spikard-http/src/testing/test_client.rs
|
|
205
|
-
- vendor/crates/spikard-http/src/websocket.rs
|
|
206
|
-
- vendor/crates/spikard-http/tests/auth_integration.rs
|
|
207
|
-
- vendor/crates/spikard-http/tests/background_behavior.rs
|
|
208
|
-
- vendor/crates/spikard-http/tests/common/grpc_helpers.rs
|
|
209
|
-
- vendor/crates/spikard-http/tests/common/handlers.rs
|
|
210
|
-
- vendor/crates/spikard-http/tests/common/mod.rs
|
|
211
|
-
- vendor/crates/spikard-http/tests/common/test_builders.rs
|
|
212
|
-
- vendor/crates/spikard-http/tests/di_handler_error_responses.rs
|
|
213
|
-
- vendor/crates/spikard-http/tests/di_integration.rs
|
|
214
|
-
- vendor/crates/spikard-http/tests/doc_snippets.rs
|
|
215
|
-
- vendor/crates/spikard-http/tests/grpc_bidirectional_streaming.rs
|
|
216
|
-
- vendor/crates/spikard-http/tests/grpc_client_streaming.rs
|
|
217
|
-
- vendor/crates/spikard-http/tests/grpc_error_handling_test.rs
|
|
218
|
-
- vendor/crates/spikard-http/tests/grpc_integration_test.rs
|
|
219
|
-
- vendor/crates/spikard-http/tests/grpc_metadata_test.rs
|
|
220
|
-
- vendor/crates/spikard-http/tests/grpc_server_integration.rs
|
|
221
|
-
- vendor/crates/spikard-http/tests/grpc_server_streaming.rs
|
|
222
|
-
- vendor/crates/spikard-http/tests/lifecycle_execution.rs
|
|
223
|
-
- vendor/crates/spikard-http/tests/middleware_stack_integration.rs
|
|
224
|
-
- vendor/crates/spikard-http/tests/multipart_behavior.rs
|
|
225
|
-
- vendor/crates/spikard-http/tests/request_extraction_full.rs
|
|
226
|
-
- vendor/crates/spikard-http/tests/server_auth_middleware_behavior.rs
|
|
227
|
-
- vendor/crates/spikard-http/tests/server_config_builder.rs
|
|
228
|
-
- vendor/crates/spikard-http/tests/server_configured_router_behavior.rs
|
|
229
|
-
- vendor/crates/spikard-http/tests/server_cors_preflight.rs
|
|
230
|
-
- vendor/crates/spikard-http/tests/server_handler_wrappers.rs
|
|
231
|
-
- vendor/crates/spikard-http/tests/server_method_router_additional_behavior.rs
|
|
232
|
-
- vendor/crates/spikard-http/tests/server_method_router_coverage.rs
|
|
233
|
-
- vendor/crates/spikard-http/tests/server_middleware_behavior.rs
|
|
234
|
-
- vendor/crates/spikard-http/tests/server_middleware_branches.rs
|
|
235
|
-
- vendor/crates/spikard-http/tests/server_openapi_jsonrpc_static.rs
|
|
236
|
-
- vendor/crates/spikard-http/tests/server_router_behavior.rs
|
|
237
|
-
- vendor/crates/spikard-http/tests/sse_behavior.rs
|
|
238
|
-
- vendor/crates/spikard-http/tests/sse_full_behavior.rs
|
|
239
|
-
- vendor/crates/spikard-http/tests/sse_handler_behavior.rs
|
|
240
|
-
- vendor/crates/spikard-http/tests/test_client_requests.rs
|
|
241
|
-
- vendor/crates/spikard-http/tests/testing_helpers.rs
|
|
242
|
-
- vendor/crates/spikard-http/tests/testing_module_coverage.rs
|
|
243
|
-
- vendor/crates/spikard-http/tests/urlencoded_content_type.rs
|
|
244
|
-
- vendor/crates/spikard-http/tests/websocket_behavior.rs
|
|
245
|
-
- vendor/crates/spikard-http/tests/websocket_full_behavior.rs
|
|
246
|
-
- vendor/crates/spikard-http/tests/websocket_integration.rs
|
|
247
|
-
- vendor/crates/spikard-rb-macros/Cargo.toml
|
|
248
|
-
- vendor/crates/spikard-rb-macros/src/lib.rs
|
|
249
|
-
- vendor/crates/spikard-rb/Cargo.toml
|
|
250
|
-
- vendor/crates/spikard-rb/build.rs
|
|
251
|
-
- vendor/crates/spikard-rb/src/background.rs
|
|
252
|
-
- vendor/crates/spikard-rb/src/config/mod.rs
|
|
253
|
-
- vendor/crates/spikard-rb/src/config/server_config.rs
|
|
254
|
-
- vendor/crates/spikard-rb/src/conversion.rs
|
|
255
|
-
- vendor/crates/spikard-rb/src/di/builder.rs
|
|
256
|
-
- vendor/crates/spikard-rb/src/di/mod.rs
|
|
257
|
-
- vendor/crates/spikard-rb/src/grpc/handler.rs
|
|
258
|
-
- vendor/crates/spikard-rb/src/grpc/mod.rs
|
|
259
|
-
- vendor/crates/spikard-rb/src/gvl.rs
|
|
260
|
-
- vendor/crates/spikard-rb/src/handler.rs
|
|
261
|
-
- vendor/crates/spikard-rb/src/integration/mod.rs
|
|
262
|
-
- vendor/crates/spikard-rb/src/lib.rs
|
|
263
|
-
- vendor/crates/spikard-rb/src/lifecycle.rs
|
|
264
|
-
- vendor/crates/spikard-rb/src/metadata/mod.rs
|
|
265
|
-
- vendor/crates/spikard-rb/src/metadata/route_extraction.rs
|
|
266
|
-
- vendor/crates/spikard-rb/src/request.rs
|
|
267
|
-
- vendor/crates/spikard-rb/src/runtime/mod.rs
|
|
268
|
-
- vendor/crates/spikard-rb/src/runtime/server_runner.rs
|
|
269
|
-
- vendor/crates/spikard-rb/src/server.rs
|
|
270
|
-
- vendor/crates/spikard-rb/src/sse.rs
|
|
271
|
-
- vendor/crates/spikard-rb/src/testing/client.rs
|
|
272
|
-
- vendor/crates/spikard-rb/src/testing/mod.rs
|
|
273
|
-
- vendor/crates/spikard-rb/src/testing/sse.rs
|
|
274
|
-
- vendor/crates/spikard-rb/src/testing/websocket.rs
|
|
275
|
-
- vendor/crates/spikard-rb/src/websocket.rs
|
|
54
|
+
- lib/spikard_rb.so
|
|
55
|
+
- sig/types.rbs
|
|
276
56
|
homepage: https://github.com/Goldziher/spikard
|
|
277
57
|
licenses:
|
|
278
58
|
- MIT
|
|
279
59
|
metadata:
|
|
280
|
-
|
|
281
|
-
source_code_uri: https://github.com/Goldziher/spikard
|
|
282
|
-
changelog_uri: https://github.com/Goldziher/spikard/blob/main/CHANGELOG.md
|
|
283
|
-
documentation_uri: https://github.com/Goldziher/spikard/tree/main/packages/ruby#documentation
|
|
284
|
-
bug_tracker_uri: https://github.com/Goldziher/spikard/issues
|
|
285
|
-
funding_uri: https://github.com/Goldziher/spikard
|
|
60
|
+
keywords: http,web,framework,polyglot,rust
|
|
286
61
|
rubygems_mfa_required: 'true'
|
|
287
62
|
rdoc_options: []
|
|
288
63
|
require_paths:
|
|
@@ -292,9 +67,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
292
67
|
- - ">="
|
|
293
68
|
- !ruby/object:Gem::Version
|
|
294
69
|
version: 3.2.0
|
|
295
|
-
- - "<"
|
|
296
|
-
- !ruby/object:Gem::Version
|
|
297
|
-
version: '5.0'
|
|
298
70
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
299
71
|
requirements:
|
|
300
72
|
- - ">="
|
|
@@ -303,5 +75,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
303
75
|
requirements: []
|
|
304
76
|
rubygems_version: 3.6.9
|
|
305
77
|
specification_version: 4
|
|
306
|
-
summary:
|
|
78
|
+
summary: Rust-centric multi-language HTTP framework with polyglot bindings
|
|
307
79
|
test_files: []
|
data/LICENSE
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
See ../../LICENSE
|
data/README.md
DELETED
|
@@ -1,267 +0,0 @@
|
|
|
1
|
-
# Spikard Ruby
|
|
2
|
-
|
|
3
|
-
[](https://spikard.dev)
|
|
4
|
-
[](https://crates.io/crates/spikard)
|
|
5
|
-
[](https://pypi.org/project/spikard/)
|
|
6
|
-
[](https://www.npmjs.com/package/@spikard/node)
|
|
7
|
-
[](https://rubygems.org/gems/spikard)
|
|
8
|
-
[](https://packagist.org/packages/spikard/spikard)
|
|
9
|
-
[](https://hex.pm/packages/spikard)
|
|
10
|
-
[](../../LICENSE)
|
|
11
|
-
|
|
12
|
-
Ruby bindings for Spikard: a Rust-centric web framework with type-safe code generation from OpenAPI, GraphQL, AsyncAPI, and OpenRPC specifications. Leverage Sinatra-style routing with zero-copy FFI performance.
|
|
13
|
-
|
|
14
|
-
## Key Features
|
|
15
|
-
|
|
16
|
-
- **Type-safe with RBS**: Full RBS type definitions for Steep type checking
|
|
17
|
-
- **Zero-copy FFI**: Magnus/rb-sys bindings eliminate serialization overhead
|
|
18
|
-
- **Sinatra-style routing**: Familiar `get`, `post`, `put`, `patch`, `delete` DSL
|
|
19
|
-
- **Code generation**: Generate type-safe handlers from OpenAPI, GraphQL, AsyncAPI, and OpenRPC specs
|
|
20
|
-
- **Full async support**: Non-blocking handlers with complete async/await integration
|
|
21
|
-
- **Tower-HTTP middleware**: Compression, rate limiting, authentication, CORS, request IDs
|
|
22
|
-
- **Real-time**: WebSockets and Server-Sent Events (SSE)
|
|
23
|
-
- **Production-ready**: Dependency injection, validation schemas, lifecycle hooks
|
|
24
|
-
|
|
25
|
-
## Installation
|
|
26
|
-
|
|
27
|
-
**Via RubyGems (recommended):**
|
|
28
|
-
|
|
29
|
-
```bash
|
|
30
|
-
gem install spikard
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
**From source:**
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
bundle install
|
|
37
|
-
bundle exec rake ext:build
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
**Requirements:** Ruby 3.2-4.x, Bundler, and Rust toolchain (for building from source). On Windows, use RubyInstaller with MSYS2 DevKit and the GNU Rust toolchain.
|
|
41
|
-
|
|
42
|
-
## Quick Start
|
|
43
|
-
|
|
44
|
-
```ruby
|
|
45
|
-
require "spikard"
|
|
46
|
-
|
|
47
|
-
app = Spikard::App.new
|
|
48
|
-
|
|
49
|
-
app.get "/hello" do |request|
|
|
50
|
-
{ message: "Hello, World!" }
|
|
51
|
-
end
|
|
52
|
-
|
|
53
|
-
app.get "/users/:id" do |request|
|
|
54
|
-
user_id = request[:path_params]["id"]
|
|
55
|
-
{ id: user_id, name: "Alice" }
|
|
56
|
-
end
|
|
57
|
-
|
|
58
|
-
app.post "/users" do |request|
|
|
59
|
-
{ id: 1, name: request[:body]["name"] }
|
|
60
|
-
end
|
|
61
|
-
|
|
62
|
-
app.run(port: 8000)
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
The `request` hash provides access to:
|
|
66
|
-
- `request[:method]` - HTTP method
|
|
67
|
-
- `request[:path]` - URL path
|
|
68
|
-
- `request[:path_params]` - Path parameters
|
|
69
|
-
- `request[:query]` - Query parameters
|
|
70
|
-
- `request[:headers]` - Request headers
|
|
71
|
-
- `request[:cookies]` - Request cookies
|
|
72
|
-
- `request[:body]` - Parsed request body
|
|
73
|
-
|
|
74
|
-
## Validation
|
|
75
|
-
|
|
76
|
-
Pass a `request_schema` to validate incoming JSON:
|
|
77
|
-
|
|
78
|
-
```ruby
|
|
79
|
-
require "dry-schema"
|
|
80
|
-
|
|
81
|
-
UserSchema = Dry::Schema.JSON do
|
|
82
|
-
required(:name).filled(:str?)
|
|
83
|
-
required(:email).filled(:str?)
|
|
84
|
-
end
|
|
85
|
-
|
|
86
|
-
app.post "/users", request_schema: UserSchema do |request|
|
|
87
|
-
{ id: 1, name: request[:body]["name"] }
|
|
88
|
-
end
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
Also supports raw JSON Schema objects and dry-struct schemas.
|
|
92
|
-
|
|
93
|
-
## Dependency Injection
|
|
94
|
-
|
|
95
|
-
Inject dependencies as keyword parameters:
|
|
96
|
-
|
|
97
|
-
```ruby
|
|
98
|
-
app.provide("config", { "db_url" => "postgresql://localhost" })
|
|
99
|
-
app.provide("db", depends_on: ["config"], singleton: true) { |config:| Pool.new(config) }
|
|
100
|
-
|
|
101
|
-
app.get "/data" do |request, config:, db:|
|
|
102
|
-
{ url: config["db_url"] }
|
|
103
|
-
end
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
## Responses
|
|
107
|
-
|
|
108
|
-
Return a Hash, String, or Response object:
|
|
109
|
-
|
|
110
|
-
```ruby
|
|
111
|
-
# Simple hash (auto-serialized to JSON)
|
|
112
|
-
app.get "/hello" do
|
|
113
|
-
{ message: "Hello, World!" }
|
|
114
|
-
end
|
|
115
|
-
|
|
116
|
-
# Custom status and headers
|
|
117
|
-
app.post "/users" do |request|
|
|
118
|
-
Spikard::Response.new(
|
|
119
|
-
content: { id: 1 },
|
|
120
|
-
status_code: 201,
|
|
121
|
-
headers: { "X-Custom" => "value" }
|
|
122
|
-
)
|
|
123
|
-
end
|
|
124
|
-
|
|
125
|
-
# Streaming response
|
|
126
|
-
app.get "/stream" do
|
|
127
|
-
stream = Enumerator.new { |y| y << "data" }
|
|
128
|
-
Spikard::StreamingResponse.new(stream)
|
|
129
|
-
end
|
|
130
|
-
|
|
131
|
-
# File uploads
|
|
132
|
-
app.post "/upload", file_params: true do |request|
|
|
133
|
-
file = request[:body]["file"]
|
|
134
|
-
{ filename: file.filename, size: file.size }
|
|
135
|
-
end
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
## Configuration
|
|
139
|
-
|
|
140
|
-
Configure the server with middleware options:
|
|
141
|
-
|
|
142
|
-
```ruby
|
|
143
|
-
config = Spikard::ServerConfig.new(
|
|
144
|
-
host: "0.0.0.0",
|
|
145
|
-
port: 8080,
|
|
146
|
-
workers: 4,
|
|
147
|
-
compression: Spikard::CompressionConfig.new(gzip: true, brotli: true),
|
|
148
|
-
rate_limit: Spikard::RateLimitConfig.new(per_second: 100),
|
|
149
|
-
jwt: Spikard::JwtConfig.new(secret: "key", algorithm: "HS256"),
|
|
150
|
-
static_files: Spikard::StaticFilesConfig.new(directory: "./public"),
|
|
151
|
-
max_body_size: 10 * 1024 * 1024,
|
|
152
|
-
request_timeout: 30
|
|
153
|
-
)
|
|
154
|
-
|
|
155
|
-
app.run(config: config)
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
See [Configuration Reference](lib/spikard/config.rb) for full options.
|
|
159
|
-
|
|
160
|
-
## Lifecycle Hooks
|
|
161
|
-
|
|
162
|
-
Execute logic at key points in the request lifecycle:
|
|
163
|
-
|
|
164
|
-
```ruby
|
|
165
|
-
app.on_request { |req| puts "#{req[:method]} #{req[:path]}" }
|
|
166
|
-
app.pre_validation { |req| req }
|
|
167
|
-
app.pre_handler { |req| req }
|
|
168
|
-
app.on_response { |res| res }
|
|
169
|
-
app.on_error { |res| res }
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
Return a Request/Response object to continue, or a Response to short-circuit.
|
|
173
|
-
|
|
174
|
-
## Real-Time Communication
|
|
175
|
-
|
|
176
|
-
**WebSockets:**
|
|
177
|
-
|
|
178
|
-
```ruby
|
|
179
|
-
class ChatHandler < Spikard::WebSocketHandler
|
|
180
|
-
def handle_message(message) = { echo: message }
|
|
181
|
-
end
|
|
182
|
-
|
|
183
|
-
app.websocket("/chat") { ChatHandler.new }
|
|
184
|
-
```
|
|
185
|
-
|
|
186
|
-
**Server-Sent Events:**
|
|
187
|
-
|
|
188
|
-
```ruby
|
|
189
|
-
class Events < Spikard::SseEventProducer
|
|
190
|
-
def next_event = Spikard::SseEvent.new(data: { msg: "Hello" })
|
|
191
|
-
end
|
|
192
|
-
|
|
193
|
-
app.sse("/events") { Events.new }
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
## Background Tasks
|
|
197
|
-
|
|
198
|
-
Offload work after sending response:
|
|
199
|
-
|
|
200
|
-
```ruby
|
|
201
|
-
app.post "/process" do
|
|
202
|
-
Spikard::Background.run { perform_long_task }
|
|
203
|
-
{ status: "processing" }
|
|
204
|
-
end
|
|
205
|
-
```
|
|
206
|
-
|
|
207
|
-
## Testing
|
|
208
|
-
|
|
209
|
-
Use the TestClient for integration tests:
|
|
210
|
-
|
|
211
|
-
```ruby
|
|
212
|
-
client = Spikard::TestClient.new(app)
|
|
213
|
-
|
|
214
|
-
# HTTP requests
|
|
215
|
-
response = client.get("/hello", query: { name: "Alice" })
|
|
216
|
-
puts response.status_code # 200
|
|
217
|
-
puts response.json # { "message" => "Hello, World!" }
|
|
218
|
-
|
|
219
|
-
# POST, WebSocket, SSE all supported
|
|
220
|
-
response = client.post("/users", json: { name: "Bob" })
|
|
221
|
-
ws = client.websocket("/chat")
|
|
222
|
-
sse = client.sse("/events")
|
|
223
|
-
|
|
224
|
-
client.close
|
|
225
|
-
```
|
|
226
|
-
|
|
227
|
-
## Type Safety with RBS & Steep
|
|
228
|
-
|
|
229
|
-
Full RBS type definitions are included in `sig/spikard.rbs`. Use Steep for type checking:
|
|
230
|
-
|
|
231
|
-
```bash
|
|
232
|
-
bundle exec steep check
|
|
233
|
-
```
|
|
234
|
-
|
|
235
|
-
## Performance
|
|
236
|
-
|
|
237
|
-
Benchmarked across 34 workloads at 100 concurrency ([methodology](../../docs/benchmarks/methodology.md)):
|
|
238
|
-
|
|
239
|
-
| Framework | Avg RPS | P50 (ms) | P99 (ms) |
|
|
240
|
-
|-----------|--------:|----------:|----------:|
|
|
241
|
-
| **spikard** | 7,151 | 14.62 | 18.98 |
|
|
242
|
-
| roda | 5,038 | 26.89 | 35.61 |
|
|
243
|
-
| hanami-api | 5,032 | 76.10 | 414.35 |
|
|
244
|
-
|
|
245
|
-
Spikard is **1.4x faster** than Roda with significantly lower tail latency.
|
|
246
|
-
|
|
247
|
-
## Learn More
|
|
248
|
-
|
|
249
|
-
**Examples & Code Generation:**
|
|
250
|
-
- [Runnable Examples](../../examples/) - Ruby, Python, TypeScript, PHP, Elixir, and Rust
|
|
251
|
-
- [Code Generation Guide](../../examples/README.md) - Generate from OpenAPI, GraphQL, AsyncAPI, OpenRPC
|
|
252
|
-
|
|
253
|
-
**Documentation:**
|
|
254
|
-
- Full documentation at [spikard.dev](https://spikard.dev)
|
|
255
|
-
- [Type Definitions (RBS)](sig/spikard.rbs) - Full Steep type signatures
|
|
256
|
-
- [CONTRIBUTING.md](../../CONTRIBUTING.md) - Development workflow
|
|
257
|
-
|
|
258
|
-
**Other Languages:**
|
|
259
|
-
- [Python (PyPI)](https://pypi.org/project/spikard/)
|
|
260
|
-
- [TypeScript (npm)](https://www.npmjs.com/package/@spikard/node)
|
|
261
|
-
- [PHP (Packagist)](https://packagist.org/packages/spikard/spikard)
|
|
262
|
-
- [Elixir (Hex.pm)](https://hex.pm/packages/spikard)
|
|
263
|
-
- [Rust (Crates.io)](https://crates.io/crates/spikard)
|
|
264
|
-
|
|
265
|
-
## License
|
|
266
|
-
|
|
267
|
-
MIT - See [LICENSE](../../LICENSE) for details
|
data/ext/spikard_rb/Cargo.toml
DELETED
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
[package]
|
|
2
|
-
name = "spikard-rb-ext"
|
|
3
|
-
version = "0.12.0"
|
|
4
|
-
edition = "2024"
|
|
5
|
-
license = "MIT"
|
|
6
|
-
authors = ["Na'aman Hirschfeld <nhirschfeld@gmail.com>"]
|
|
7
|
-
|
|
8
|
-
[lib]
|
|
9
|
-
name = "spikard_rb"
|
|
10
|
-
crate-type = ["cdylib"]
|
|
11
|
-
|
|
12
|
-
[workspace]
|
|
13
|
-
|
|
14
|
-
[dependencies]
|
|
15
|
-
magnus = { version = "0.8.2", features = ["rb-sys"] }
|
|
16
|
-
# Use crates from the workspace root
|
|
17
|
-
spikard_rb_core = { package = "spikard-rb", path = "../../vendor/crates/spikard-rb" }
|