spikard 0.4.0-x86_64-linux

data/sig/spikard.rbs

@@ -0,0 +1,366 @@
+module Spikard
+  VERSION: String
+
+  # JSON-serializable value types
+  type jsonPrimitive = String | Integer | Float | bool | nil
+  type jsonValue = jsonPrimitive | Array[jsonValue] | Hash[String, jsonValue]
+  type jsonObject = Hash[String, jsonValue]
+  type jsonArray = Array[jsonValue]
+
+  module Background
+    def self.run: () { () -> void } -> void
+  end
+
+  class CompressionConfig
+    attr_accessor gzip: bool
+    attr_accessor brotli: bool
+    attr_accessor min_size: Integer
+    attr_accessor quality: Integer
+
+    def initialize: (?gzip: bool, ?brotli: bool, ?min_size: Integer, ?quality: Integer) -> void
+  end
+
+  class RateLimitConfig
+    attr_accessor per_second: Integer
+    attr_accessor burst: Integer
+    attr_accessor ip_based: bool
+
+    def initialize: (per_second: Integer, burst: Integer, ?ip_based: bool) -> void
+  end
+
+  class JwtConfig
+    attr_accessor secret: String
+    attr_accessor algorithm: String
+    attr_accessor audience: Array[String]?
+    attr_accessor issuer: String?
+    attr_accessor leeway: Integer
+
+    def initialize: (secret: String, ?algorithm: String, ?audience: Array[String]?, ?issuer: String?, ?leeway: Integer) -> void
+  end
+
+  class ApiKeyConfig
+    attr_accessor keys: Array[String]
+    attr_accessor header_name: String
+
+    def initialize: (keys: Array[String], ?header_name: String) -> void
+  end
+
+  class StaticFilesConfig
+    attr_accessor directory: String
+    attr_accessor route_prefix: String
+    attr_accessor index_file: bool
+    attr_accessor cache_control: String?
+
+    def initialize: (directory: String, route_prefix: String, ?index_file: bool, ?cache_control: String?) -> void
+  end
+
+  class ContactInfo
+    attr_accessor name: String?
+    attr_accessor email: String?
+    attr_accessor url: String?
+
+    def initialize: (?name: String?, ?email: String?, ?url: String?) -> void
+  end
+
+  class LicenseInfo
+    attr_accessor name: String
+    attr_accessor url: String?
+
+    def initialize: (name: String, ?url: String?) -> void
+  end
+
+  class ServerInfo
+    attr_accessor url: String
+    attr_accessor description: String?
+
+    def initialize: (url: String, ?description: String?) -> void
+  end
+
+  class SecuritySchemeInfo
+    attr_accessor type: String
+    attr_accessor scheme: String?
+    attr_accessor bearer_format: String?
+    attr_accessor location: String?
+    attr_accessor name: String?
+
+    def initialize: (type: String, ?scheme: String?, ?bearer_format: String?, ?location: String?, ?name: String?) -> void
+  end
+
+  class OpenApiConfig
+    attr_accessor enabled: bool
+    attr_accessor title: String
+    attr_accessor version: String
+    attr_accessor description: String?
+    attr_accessor swagger_ui_path: String
+    attr_accessor redoc_path: String
+    attr_accessor openapi_json_path: String
+    attr_accessor contact: ContactInfo?
+    attr_accessor license: LicenseInfo?
+    attr_accessor servers: Array[ServerInfo]
+    attr_accessor security_schemes: Hash[String, SecuritySchemeInfo]
+
+    def initialize: (
+      ?enabled: bool,
+      ?title: String,
+      ?version: String,
+      ?description: String?,
+      ?swagger_ui_path: String,
+      ?redoc_path: String,
+      ?openapi_json_path: String,
+      ?contact: ContactInfo?,
+      ?license: LicenseInfo?,
+      ?servers: Array[ServerInfo],
+      ?security_schemes: Hash[String, SecuritySchemeInfo]
+    ) -> void
+  end
+
+  class ServerConfig
+    attr_accessor host: String
+    attr_accessor port: Integer
+    attr_accessor workers: Integer
+    attr_accessor enable_request_id: bool
+    attr_accessor max_body_size: Integer?
+    attr_accessor request_timeout: Integer?
+    attr_accessor compression: CompressionConfig
+    attr_accessor rate_limit: RateLimitConfig?
+    attr_accessor jwt_auth: JwtConfig?
+    attr_accessor api_key_auth: ApiKeyConfig?
+    attr_accessor static_files: Array[StaticFilesConfig]
+    attr_accessor graceful_shutdown: bool
+    attr_accessor shutdown_timeout: Integer
+    attr_accessor openapi: OpenApiConfig?
+
+    def initialize: (
+      ?host: String,
+      ?port: Integer,
+      ?workers: Integer,
+      ?enable_request_id: bool,
+      ?max_body_size: Integer?,
+      ?request_timeout: Integer?,
+      ?compression: CompressionConfig,
+      ?rate_limit: RateLimitConfig?,
+      ?jwt_auth: JwtConfig?,
+      ?api_key_auth: ApiKeyConfig?,
+      ?static_files: Array[StaticFilesConfig],
+      ?graceful_shutdown: bool,
+      ?shutdown_timeout: Integer,
+      ?openapi: OpenApiConfig?
+    ) -> void
+  end
+
+  class Response
+    attr_reader content: jsonValue
+    attr_reader status_code: Integer
+    attr_reader headers: Hash[String, String]
+    attr_reader native_response: Object
+
+    def initialize: (
+      ?content: jsonValue,
+      ?body: jsonValue,
+      ?status_code: Integer,
+      ?headers: Hash[String, String]?,
+      ?content_type: String?
+    ) -> void
+    def status: () -> Integer
+    def status_code=: (Integer) -> Integer
+    def headers=: (Hash[String, String]?) -> Hash[String, String]
+    def content=: (jsonValue) -> jsonValue
+    def set_header: (String, String) -> String
+    def set_cookie: (
+      String,
+      String,
+      ?max_age: Integer?,
+      ?domain: String?,
+      ?path: String?,
+      ?secure: bool?,
+      ?httponly: bool?,
+      ?samesite: String?
+    ) -> String
+    def to_native_response: () -> Object
+  end
+
+  class StreamingResponse
+    attr_reader stream: Enumerable[String]
+    attr_reader status_code: Integer
+    attr_reader headers: Hash[String, String]
+    attr_reader native_response: Object
+
+    def initialize: (Enumerable[String], ?status_code: Integer, ?headers: Hash[String, String]?) -> void
+    def to_native_response: () -> Object
+  end
+
+  module Testing
+  end
+
+  module LifecycleHooks
+    def on_request: () { (Object) -> (Object | nil) } -> Proc
+    def pre_validation: () { (Object) -> (Object | nil) } -> Proc
+    def pre_handler: () { (Object) -> (Object | nil) } -> Proc
+    def on_response: () { (Response) -> (Response | nil) } -> Proc
+    def on_error: () { (Exception) -> (Response | nil) } -> Proc
+  end
+
+  module ProvideSupport
+    def provide: (
+      String | Symbol,
+      ?Object,
+      ?depends_on: Array[String | Symbol],
+      ?singleton: bool,
+      ?cacheable: bool
+    ) ?{ (**jsonObject) -> Object } -> self
+    def dependencies: () -> Spikard::Native::DependencyRegistry
+  end
+
+  class App
+    include LifecycleHooks
+    include ProvideSupport
+
+    attr_reader routes: Array[Array[String]]
+
+    def initialize: () -> void
+    def register_route: (String, String, ?handler_name: String?, **jsonObject) { (Object) -> (Response | jsonValue) } -> Proc
+    def get: (String, ?handler_name: String?, **jsonObject) { (Object) -> (Response | jsonValue) } -> Proc
+    def post: (String, ?handler_name: String?, **jsonObject) { (Object) -> (Response | jsonValue) } -> Proc
+    def put: (String, ?handler_name: String?, **jsonObject) { (Object) -> (Response | jsonValue) } -> Proc
+    def patch: (String, ?handler_name: String?, **jsonObject) { (Object) -> (Response | jsonValue) } -> Proc
+    def delete: (String, ?handler_name: String?, **jsonObject) { (Object) -> (Response | jsonValue) } -> Proc
+    def options: (String, ?handler_name: String?, **jsonObject) { (Object) -> (Response | jsonValue) } -> Proc
+    def head: (String, ?handler_name: String?, **jsonObject) { (Object) -> (Response | jsonValue) } -> Proc
+    def trace: (String, ?handler_name: String?, **jsonObject) { (Object) -> (Response | jsonValue) } -> Proc
+    def websocket: (String, ?handler_name: String?, **jsonObject) { () -> WebSocketHandler } -> Proc
+    def sse: (String, ?handler_name: String?, **jsonObject) { () -> SseEventProducer } -> Proc
+    def websocket_handlers: () -> Hash[String, Proc]
+    def sse_producers: () -> Hash[String, Proc]
+    def run: (?config: ServerConfig | Hash[Symbol, jsonValue]?, ?host: String?, ?port: Integer?) -> void
+  end
+
+  class WebSocketHandler
+    def handle_message: (jsonObject) -> jsonObject?
+    def on_connect: () -> void
+    def on_disconnect: () -> void
+  end
+
+  class SseEvent
+    attr_accessor data: jsonObject
+    attr_accessor event_type: String?
+    attr_accessor id: String?
+    attr_accessor retry_ms: Integer?
+
+    def initialize: (data: jsonObject, ?event_type: String?, ?id: String?, ?retry_ms: Integer?) -> void
+    def to_h: () -> Hash[Symbol, jsonValue]
+  end
+
+  class SseEventProducer
+    def next_event: () -> SseEvent?
+    def on_connect: () -> void
+    def on_disconnect: () -> void
+  end
+
+  module Schema
+    def self.extract_json_schema: (Object) -> jsonObject?
+  end
+
+  module Native
+    def self.run_server: (
+      String,
+      Hash[Symbol, Proc],
+      ServerConfig,
+      Hash[Symbol, Array[Proc]],
+      Hash[String, Proc],
+      Hash[String, Proc],
+      Hash[String, jsonObject]
+    ) -> void
+
+    class DependencyRegistry
+      def initialize: () -> void
+    end
+
+    class TestClient
+      def initialize: (
+        String,
+        Hash[Symbol, Proc],
+        ServerConfig,
+        Hash[String, Proc],
+        Hash[String, Proc]
+      ) -> void
+      def request: (String, String, Hash[Symbol, jsonValue]) -> Hash[Symbol, jsonValue]
+      def websocket: (String) -> Object
+      def sse: (String) -> Object
+      def close: () -> void
+    end
+  end
+
+  module Testing
+    def self.create_test_client: (App, ?config: ServerConfig?) -> Testing::TestClient
+
+    class Response
+      attr_reader status_code: Integer
+      attr_reader headers: Hash[String, String]
+      attr_reader body: String?
+
+      def initialize: (Hash[Symbol, jsonValue]) -> void
+      def status: () -> Integer
+      def body_bytes: () -> String
+      def body_text: () -> String?
+      def text: () -> String?
+      def json: () -> jsonValue
+      def bytes: () -> Array[Integer]
+    end
+
+    class TestClient
+      def initialize: (Spikard::Native::TestClient) -> void
+      def self.new: (App | Spikard::Native::TestClient, ?config: ServerConfig?) -> TestClient
+      def request: (String, String, **jsonObject) -> Response
+      def websocket: (String) -> WebSocketTestConnection
+      def sse: (String) -> SseStream
+      def close: () -> void
+      def get: (String, **jsonObject) -> Response
+      def post: (String, **jsonObject) -> Response
+      def put: (String, **jsonObject) -> Response
+      def patch: (String, **jsonObject) -> Response
+      def delete: (String, **jsonObject) -> Response
+      def head: (String, **jsonObject) -> Response
+      def options: (String, **jsonObject) -> Response
+      def trace: (String, **jsonObject) -> Response
+    end
+
+    class WebSocketTestConnection
+      def initialize: (Object) -> void
+      def send_text: (String) -> void
+      def send_json: (jsonValue) -> void
+      def receive_text: () -> String
+      def receive_json: () -> jsonValue
+      def receive_bytes: () -> String
+      def receive_message: () -> WebSocketMessage
+      def close: () -> void
+    end
+
+    class WebSocketMessage
+      def initialize: (Object) -> void
+      def as_text: () -> String
+      def as_json: () -> jsonValue
+      def as_binary: () -> String
+      def close?: () -> bool
+    end
+
+    class SseStream
+      def initialize: (Object) -> void
+      def body: () -> String?
+      def events: () -> Array[InlineSseEvent]
+      def events_as_json: () -> jsonArray
+    end
+
+    class SseEvent
+      def initialize: (Object) -> void
+      def data: () -> jsonValue
+      def as_json: () -> jsonValue
+    end
+
+    class InlineSseEvent
+      attr_reader data: String
+
+      def initialize: (String) -> void
+      def as_json: () -> jsonValue
+    end
+  end
+end

data/vendor/bundle/ruby/3.4.0/gems/diff-lcs-1.6.2/mise.toml

@@ -0,0 +1,5 @@
+[tools]
+ruby = "3.4"
+
+[env]
+MAINTENANCE = "true"

data/vendor/bundle/ruby/3.4.0/gems/rake-compiler-dock-1.10.0/build/buildkitd.toml

@@ -0,0 +1,2 @@
+[worker.oci]
+  gc = false

data/vendor/crates/spikard-bindings-shared/Cargo.toml

@@ -0,0 +1,63 @@
+[package]
+name = "spikard-bindings-shared"
+version = "0.4.0"
+edition = "2024"
+authors = ["Na'aman Hirschfeld <nhirschfeld@gmail.com>"]
+license = "MIT"
+repository = "https://github.com/Goldziher/spikard"
+homepage = "https://github.com/Goldziher/spikard"
+
+[dependencies]
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+axum = { version = "0.8", features = ["multipart", "ws"] }
+tokio = { version = "1", features = ["full"] }
+thiserror = "2.0"
+spikard-core = { path = "../spikard-core", features = ["di"] }
+spikard-http = { path = "../spikard-http", features = ["di"] }
+tracing = "0.1"
+http = "1.4"
+http-body-util = "0.1"
+
+[features]
+default = []
+python-support = ["pyo3", "pyo3-async-runtimes"]
+node-support = ["napi", "napi-derive"]
+ruby-support = ["magnus"]
+php-support = ["ext-php-rs"]
+wasm-support = ["wasm-bindgen"]
+
+[dependencies.pyo3]
+version = "0.27"
+optional = true
+features = ["abi3-py310"]
+
+[dependencies.pyo3-async-runtimes]
+version = "0.27"
+optional = true
+features = ["tokio-runtime"]
+
+[dependencies.napi]
+version = "3"
+optional = true
+default-features = false
+features = ["napi9", "async"]
+
+[dependencies.napi-derive]
+version = "3"
+optional = true
+
+[dependencies.magnus]
+version = "0.8.2"
+optional = true
+
+[dependencies.ext-php-rs]
+version = "0.15"
+optional = true
+
+[dependencies.wasm-bindgen]
+version = "0.2"
+optional = true
+
+[dev-dependencies]
+pretty_assertions = "1.4"

data/vendor/crates/spikard-bindings-shared/examples/config_extraction.rs

@@ -0,0 +1,139 @@
+//! Example of implementing ConfigSource for a language binding
+//!
+//! This example demonstrates how a language binding (e.g., Python, Node.js, Ruby, PHP)
+//! would implement the `ConfigSource` trait to extract ServerConfig from language-specific objects.
+
+use spikard_bindings_shared::{ConfigExtractor, ConfigSource};
+use std::collections::HashMap;
+
+/// Example: PyO3 Python dict wrapper
+struct PyDictWrapper {
+    data: HashMap<String, String>,
+}
+
+impl PyDictWrapper {
+    fn new() -> Self {
+        Self { data: HashMap::new() }
+    }
+
+    fn insert(&mut self, key: &str, value: &str) {
+        self.data.insert(key.to_string(), value.to_string());
+    }
+}
+
+impl ConfigSource for PyDictWrapper {
+    fn get_bool(&self, key: &str) -> Option<bool> {
+        self.data.get(key).and_then(|v| match v.as_str() {
+            "true" | "True" => Some(true),
+            "false" | "False" => Some(false),
+            _ => v.parse().ok(),
+        })
+    }
+
+    fn get_u64(&self, key: &str) -> Option<u64> {
+        self.data.get(key).and_then(|v| v.parse().ok())
+    }
+
+    fn get_u16(&self, key: &str) -> Option<u16> {
+        self.data.get(key).and_then(|v| v.parse().ok())
+    }
+
+    fn get_string(&self, key: &str) -> Option<String> {
+        self.data.get(key).cloned()
+    }
+
+    fn get_vec_string(&self, key: &str) -> Option<Vec<String>> {
+        self.data
+            .get(key)
+            .map(|s| s.split(',').map(|item| item.trim().to_string()).collect())
+    }
+
+    fn get_nested(&self, _key: &str) -> Option<Box<dyn ConfigSource + '_>> {
+        // In a real binding, this would return a nested wrapper for nested objects
+        None
+    }
+
+    fn has_key(&self, key: &str) -> bool {
+        self.data.contains_key(key)
+    }
+}
+
+fn main() {
+    println!("=== ConfigExtractor Example ===\n");
+
+    // Example 1: Extract compression config
+    println!("1. Extracting compression configuration:");
+    let mut compression_config = PyDictWrapper::new();
+    compression_config.insert("gzip", "true");
+    compression_config.insert("brotli", "true");
+    compression_config.insert("min_size", "2048");
+    compression_config.insert("quality", "9");
+
+    match ConfigExtractor::extract_compression_config(&compression_config) {
+        Ok(config) => {
+            println!("   gzip: {}", config.gzip);
+            println!("   brotli: {}", config.brotli);
+            println!("   min_size: {}", config.min_size);
+            println!("   quality: {}\n", config.quality);
+        }
+        Err(e) => println!("   Error: {}\n", e),
+    }
+
+    // Example 2: Extract JWT auth config
+    println!("2. Extracting JWT authentication configuration:");
+    let mut jwt_config = PyDictWrapper::new();
+    jwt_config.insert("secret", "my-secret-key");
+    jwt_config.insert("algorithm", "HS256");
+    jwt_config.insert("leeway", "60");
+
+    match ConfigExtractor::extract_jwt_config(&jwt_config) {
+        Ok(config) => {
+            println!("   secret: [REDACTED]");
+            println!("   algorithm: {}", config.algorithm);
+            println!("   leeway: {}\n", config.leeway);
+        }
+        Err(e) => println!("   Error: {}\n", e),
+    }
+
+    // Example 3: Extract API Key auth config
+    println!("3. Extracting API Key authentication configuration:");
+    let mut api_key_config = PyDictWrapper::new();
+    api_key_config.insert("keys", "key1,key2,key3");
+    api_key_config.insert("header_name", "X-API-Key");
+
+    match ConfigExtractor::extract_api_key_config(&api_key_config) {
+        Ok(config) => {
+            println!("   keys: {:?}", config.keys);
+            println!("   header_name: {}\n", config.header_name);
+        }
+        Err(e) => println!("   Error: {}\n", e),
+    }
+
+    // Example 4: Extract rate limit config (with required fields)
+    println!("4. Extracting rate limit configuration:");
+    let mut rate_limit_config = PyDictWrapper::new();
+    rate_limit_config.insert("per_second", "100");
+    rate_limit_config.insert("burst", "20");
+    rate_limit_config.insert("ip_based", "true");
+
+    match ConfigExtractor::extract_rate_limit_config(&rate_limit_config) {
+        Ok(config) => {
+            println!("   per_second: {}", config.per_second);
+            println!("   burst: {}", config.burst);
+            println!("   ip_based: {}\n", config.ip_based);
+        }
+        Err(e) => println!("   Error: {}\n", e),
+    }
+
+    // Example 5: Extract rate limit with missing required field
+    println!("5. Testing error handling (missing 'burst' field):");
+    let rate_limit_config = PyDictWrapper::new();
+    // Only setting per_second, burst is required
+
+    match ConfigExtractor::extract_rate_limit_config(&rate_limit_config) {
+        Ok(_config) => println!("   Success (unexpected!)"),
+        Err(e) => println!("   Expected error: {}\n", e),
+    }
+
+    println!("=== Example Complete ===");
+}