spikard 0.3.4 → 0.3.6

data/vendor/spikard-rb/src/config.rs

@@ -1,294 +0,0 @@
-//! ServerConfig extraction from Ruby configuration objects.
-//!
-//! This module handles conversion of Ruby ServerConfig objects
-//! into Rust ServerConfig structs for Spikard HTTP server setup.
-
-#![allow(dead_code)]
-
-use magnus::prelude::*;
-use magnus::{Error, RArray, RHash, Ruby, TryConvert, Value};
-use spikard_http::{
-    ApiKeyConfig, CompressionConfig, ContactInfo, JwtConfig, LicenseInfo, OpenApiConfig, RateLimitConfig, ServerConfig,
-    ServerInfo, StaticFilesConfig,
-};
-use std::collections::HashMap;
-
-use crate::conversion::{get_optional_string_from_hash, get_required_string_from_hash};
-
-/// Extract a ServerConfig from a Ruby configuration object.
-///
-/// Handles all ServerConfig properties including middleware configs,
-/// authentication, static files, and OpenAPI documentation settings.
-pub fn extract_server_config(ruby: &Ruby, config_value: Value) -> Result<ServerConfig, Error> {
-    let host: String = config_value.funcall("host", ())?;
-
-    let port: u32 = config_value.funcall("port", ())?;
-
-    let workers: usize = config_value.funcall("workers", ())?;
-
-    let enable_request_id: bool = config_value.funcall("enable_request_id", ())?;
-
-    let max_body_size_value: Value = config_value.funcall("max_body_size", ())?;
-    let max_body_size = if max_body_size_value.is_nil() {
-        None
-    } else {
-        Some(u64::try_convert(max_body_size_value)? as usize)
-    };
-
-    let request_timeout_value: Value = config_value.funcall("request_timeout", ())?;
-    let request_timeout = if request_timeout_value.is_nil() {
-        None
-    } else {
-        Some(u64::try_convert(request_timeout_value)?)
-    };
-
-    let graceful_shutdown: bool = config_value.funcall("graceful_shutdown", ())?;
-
-    let shutdown_timeout: u64 = config_value.funcall("shutdown_timeout", ())?;
-
-    // Compression config
-    let compression_value: Value = config_value.funcall("compression", ())?;
-    let compression = if compression_value.is_nil() {
-        None
-    } else {
-        let gzip: bool = compression_value.funcall("gzip", ())?;
-        let brotli: bool = compression_value.funcall("brotli", ())?;
-        let min_size: usize = compression_value.funcall("min_size", ())?;
-        let quality: u32 = compression_value.funcall("quality", ())?;
-        Some(CompressionConfig {
-            gzip,
-            brotli,
-            min_size,
-            quality,
-        })
-    };
-
-    // Rate limit config
-    let rate_limit_value: Value = config_value.funcall("rate_limit", ())?;
-    let rate_limit = if rate_limit_value.is_nil() {
-        None
-    } else {
-        let per_second: u64 = rate_limit_value.funcall("per_second", ())?;
-        let burst: u32 = rate_limit_value.funcall("burst", ())?;
-        let ip_based: bool = rate_limit_value.funcall("ip_based", ())?;
-        Some(RateLimitConfig {
-            per_second,
-            burst,
-            ip_based,
-        })
-    };
-
-    // JWT auth config
-    let jwt_auth_value: Value = config_value.funcall("jwt_auth", ())?;
-    let jwt_auth = if jwt_auth_value.is_nil() {
-        None
-    } else {
-        let secret: String = jwt_auth_value.funcall("secret", ())?;
-        let algorithm: String = jwt_auth_value.funcall("algorithm", ())?;
-        let audience_value: Value = jwt_auth_value.funcall("audience", ())?;
-        let audience = if audience_value.is_nil() {
-            None
-        } else {
-            Some(Vec::<String>::try_convert(audience_value)?)
-        };
-        let issuer_value: Value = jwt_auth_value.funcall("issuer", ())?;
-        let issuer = if issuer_value.is_nil() {
-            None
-        } else {
-            Some(String::try_convert(issuer_value)?)
-        };
-        let leeway: u64 = jwt_auth_value.funcall("leeway", ())?;
-        Some(JwtConfig {
-            secret,
-            algorithm,
-            audience,
-            issuer,
-            leeway,
-        })
-    };
-
-    // API key auth config
-    let api_key_auth_value: Value = config_value.funcall("api_key_auth", ())?;
-    let api_key_auth = if api_key_auth_value.is_nil() {
-        None
-    } else {
-        let keys: Vec<String> = api_key_auth_value.funcall("keys", ())?;
-        let header_name: String = api_key_auth_value.funcall("header_name", ())?;
-        Some(ApiKeyConfig { keys, header_name })
-    };
-
-    // Static files config
-    let static_files_value: Value = config_value.funcall("static_files", ())?;
-    let static_files_array = RArray::from_value(static_files_value)
-        .ok_or_else(|| Error::new(ruby.exception_type_error(), "static_files must be an Array"))?;
-
-    let mut static_files = Vec::new();
-    for i in 0..static_files_array.len() {
-        let sf_value = static_files_array.entry::<Value>(i as isize)?;
-        let directory: String = sf_value.funcall("directory", ())?;
-        let route_prefix: String = sf_value.funcall("route_prefix", ())?;
-        let index_file: bool = sf_value.funcall("index_file", ())?;
-        let cache_control_value: Value = sf_value.funcall("cache_control", ())?;
-        let cache_control = if cache_control_value.is_nil() {
-            None
-        } else {
-            Some(String::try_convert(cache_control_value)?)
-        };
-        static_files.push(StaticFilesConfig {
-            directory,
-            route_prefix,
-            index_file,
-            cache_control,
-        });
-    }
-
-    // OpenAPI config
-    let openapi_value: Value = config_value.funcall("openapi", ())?;
-    let openapi = if openapi_value.is_nil() {
-        None
-    } else {
-        let enabled: bool = openapi_value.funcall("enabled", ())?;
-        let title: String = openapi_value.funcall("title", ())?;
-        let version: String = openapi_value.funcall("version", ())?;
-        let description_value: Value = openapi_value.funcall("description", ())?;
-        let description = if description_value.is_nil() {
-            None
-        } else {
-            Some(String::try_convert(description_value)?)
-        };
-        let swagger_ui_path: String = openapi_value.funcall("swagger_ui_path", ())?;
-        let redoc_path: String = openapi_value.funcall("redoc_path", ())?;
-        let openapi_json_path: String = openapi_value.funcall("openapi_json_path", ())?;
-
-        let contact = extract_contact_info(ruby, &openapi_value)?;
-        let license = extract_license_info(ruby, &openapi_value)?;
-        let servers = extract_servers(ruby, &openapi_value)?;
-
-        let security_schemes = HashMap::new();
-
-        Some(OpenApiConfig {
-            enabled,
-            title,
-            version,
-            description,
-            swagger_ui_path,
-            redoc_path,
-            openapi_json_path,
-            contact,
-            license,
-            servers,
-            security_schemes,
-        })
-    };
-
-    Ok(ServerConfig {
-        host,
-        port: port as u16,
-        workers,
-        enable_request_id,
-        max_body_size,
-        request_timeout,
-        compression,
-        rate_limit,
-        jwt_auth,
-        api_key_auth,
-        static_files,
-        graceful_shutdown,
-        shutdown_timeout,
-        background_tasks: spikard_http::BackgroundTaskConfig::default(),
-        openapi,
-        lifecycle_hooks: None,
-        #[cfg(feature = "di")]
-        di_container: None,
-    })
-}
-
-/// Extract contact information from OpenAPI config.
-fn extract_contact_info(_ruby: &Ruby, openapi_value: &Value) -> Result<Option<ContactInfo>, Error> {
-    let contact_value: Value = openapi_value.funcall("contact", ())?;
-    if contact_value.is_nil() {
-        return Ok(None);
-    }
-
-    if let Some(contact_hash) = RHash::from_value(contact_value) {
-        let name = get_optional_string_from_hash(contact_hash, "name")?;
-        let email = get_optional_string_from_hash(contact_hash, "email")?;
-        let url = get_optional_string_from_hash(contact_hash, "url")?;
-        return Ok(Some(ContactInfo { name, email, url }));
-    }
-
-    let name_value: Value = contact_value.funcall("name", ())?;
-    let email_value: Value = contact_value.funcall("email", ())?;
-    let url_value: Value = contact_value.funcall("url", ())?;
-    Ok(Some(ContactInfo {
-        name: if name_value.is_nil() {
-            None
-        } else {
-            Some(String::try_convert(name_value)?)
-        },
-        email: if email_value.is_nil() {
-            None
-        } else {
-            Some(String::try_convert(email_value)?)
-        },
-        url: if url_value.is_nil() {
-            None
-        } else {
-            Some(String::try_convert(url_value)?)
-        },
-    }))
-}
-
-/// Extract license information from OpenAPI config.
-fn extract_license_info(ruby: &Ruby, openapi_value: &Value) -> Result<Option<LicenseInfo>, Error> {
-    let license_value: Value = openapi_value.funcall("license", ())?;
-    if license_value.is_nil() {
-        return Ok(None);
-    }
-
-    if let Some(license_hash) = RHash::from_value(license_value) {
-        let name = get_required_string_from_hash(license_hash, "name", ruby)?;
-        let url = get_optional_string_from_hash(license_hash, "url")?;
-        return Ok(Some(LicenseInfo { name, url }));
-    }
-
-    let name: String = license_value.funcall("name", ())?;
-    let url_value: Value = license_value.funcall("url", ())?;
-    let url = if url_value.is_nil() {
-        None
-    } else {
-        Some(String::try_convert(url_value)?)
-    };
-    Ok(Some(LicenseInfo { name, url }))
-}
-
-/// Extract server information from OpenAPI config.
-fn extract_servers(ruby: &Ruby, openapi_value: &Value) -> Result<Vec<ServerInfo>, Error> {
-    let servers_value: Value = openapi_value.funcall("servers", ())?;
-    let servers_array = RArray::from_value(servers_value)
-        .ok_or_else(|| Error::new(ruby.exception_type_error(), "servers must be an Array"))?;
-
-    let mut servers = Vec::new();
-    for i in 0..servers_array.len() {
-        let server_value = servers_array.entry::<Value>(i as isize)?;
-
-        let (url, description) = if let Some(server_hash) = RHash::from_value(server_value) {
-            let url = get_required_string_from_hash(server_hash, "url", ruby)?;
-            let description = get_optional_string_from_hash(server_hash, "description")?;
-            (url, description)
-        } else {
-            let url: String = server_value.funcall("url", ())?;
-            let description_value: Value = server_value.funcall("description", ())?;
-            let description = if description_value.is_nil() {
-                None
-            } else {
-                Some(String::try_convert(description_value)?)
-            };
-            (url, description)
-        };
-
-        servers.push(ServerInfo { url, description });
-    }
-
-    Ok(servers)
-}

data/vendor/spikard-rb/src/conversion.rs

@@ -1,392 +0,0 @@
-//! Ruby ↔ Rust type conversion utilities.
-//!
-//! This module provides functions for converting between Ruby and Rust types,
-//! including JSON conversion, string conversion, and request/response building.
-
-#![allow(dead_code)]
-
-use bytes::Bytes;
-use magnus::prelude::*;
-use magnus::{Error, RArray, RHash, RString, Ruby, TryConvert, Value};
-use serde_json::Value as JsonValue;
-use spikard_http::problem::ProblemDetails;
-use spikard_http::testing::MultipartFilePart;
-use std::collections::HashMap;
-
-use crate::test_client::{RequestBody, RequestConfig, TestResponseData};
-
-/// Convert a Ruby value to JSON.
-///
-/// Uses Ruby's JSON.generate method to serialize the Ruby object
-/// and then parses the result.
-pub fn ruby_value_to_json(ruby: &Ruby, json_module: Value, value: Value) -> Result<JsonValue, Error> {
-    if value.is_nil() {
-        return Ok(JsonValue::Null);
-    }
-
-    let json_string: String = json_module.funcall("generate", (value,))?;
-    serde_json::from_str(&json_string).map_err(|err| {
-        Error::new(
-            ruby.exception_runtime_error(),
-            format!("Failed to convert Ruby value to JSON: {err}"),
-        )
-    })
-}
-
-/// Convert JSON to a Ruby value.
-///
-/// Recursively converts JSON types to native Ruby types:
-/// - null → nil
-/// - bool → true/false
-/// - number → integer or float
-/// - string → string
-/// - array → array
-/// - object → hash
-pub fn json_to_ruby(ruby: &Ruby, value: &JsonValue) -> Result<Value, Error> {
-    match value {
-        JsonValue::Null => Ok(ruby.qnil().as_value()),
-        JsonValue::Bool(b) => Ok(if *b {
-            ruby.qtrue().as_value()
-        } else {
-            ruby.qfalse().as_value()
-        }),
-        JsonValue::Number(num) => {
-            if let Some(i) = num.as_i64() {
-                Ok(ruby.integer_from_i64(i).as_value())
-            } else if let Some(f) = num.as_f64() {
-                Ok(ruby.float_from_f64(f).as_value())
-            } else {
-                Ok(ruby.qnil().as_value())
-            }
-        }
-        JsonValue::String(str_val) => Ok(ruby.str_new(str_val).as_value()),
-        JsonValue::Array(items) => {
-            let array = ruby.ary_new();
-            for item in items {
-                array.push(json_to_ruby(ruby, item)?)?;
-            }
-            Ok(array.as_value())
-        }
-        JsonValue::Object(map) => {
-            let hash = ruby.hash_new();
-            for (key, item) in map {
-                hash.aset(ruby.str_new(key), json_to_ruby(ruby, item)?)?;
-            }
-            Ok(hash.as_value())
-        }
-    }
-}
-
-/// Convert a HashMap to a Ruby Hash.
-pub fn map_to_ruby_hash(ruby: &Ruby, map: &HashMap<String, String>) -> Result<Value, Error> {
-    let hash = ruby.hash_new();
-    for (key, value) in map {
-        hash.aset(ruby.str_new(key), ruby.str_new(value))?;
-    }
-    Ok(hash.as_value())
-}
-
-/// Convert a HashMap of Vecs to a Ruby Hash with array values.
-pub fn multimap_to_ruby_hash(ruby: &Ruby, map: &HashMap<String, Vec<String>>) -> Result<Value, Error> {
-    let hash = ruby.hash_new();
-    for (key, values) in map {
-        let array = ruby.ary_new();
-        for value in values {
-            array.push(ruby.str_new(value))?;
-        }
-        hash.aset(ruby.str_new(key), array)?;
-    }
-    Ok(hash.as_value())
-}
-
-/// Convert a Ruby value to Bytes.
-///
-/// Accepts either String or Array of bytes.
-pub fn ruby_value_to_bytes(value: Value) -> Result<Bytes, std::io::Error> {
-    if let Ok(str_value) = RString::try_convert(value) {
-        // SAFETY: Magnus guarantees RString::as_slice() returns valid UTF-8 (or binary)
-        // bytes for the lifetime of the RString. The slice is only used within this
-        // function scope to copy into a Bytes buffer, and does not outlive the RString
-        // reference. The copy_from_slice operation is safe for the borrowed data.
-        let slice = unsafe { str_value.as_slice() };
-        return Ok(Bytes::copy_from_slice(slice));
-    }
-
-    if let Ok(vec_bytes) = Vec::<u8>::try_convert(value) {
-        return Ok(Bytes::from(vec_bytes));
-    }
-
-    Err(std::io::Error::other(
-        "Streaming chunks must be Strings or Arrays of bytes",
-    ))
-}
-
-/// Convert a response to a Ruby Hash.
-pub fn response_to_ruby(ruby: &Ruby, response: TestResponseData) -> Result<Value, Error> {
-    let hash = ruby.hash_new();
-
-    hash.aset(
-        ruby.intern("status_code"),
-        ruby.integer_from_i64(response.status as i64),
-    )?;
-
-    let headers_hash = ruby.hash_new();
-    for (key, value) in response.headers {
-        headers_hash.aset(ruby.str_new(&key), ruby.str_new(&value))?;
-    }
-    hash.aset(ruby.intern("headers"), headers_hash)?;
-
-    if let Some(body) = response.body_text {
-        let body_value = ruby.str_new(&body);
-        hash.aset(ruby.intern("body"), body_value)?;
-        hash.aset(ruby.intern("body_text"), body_value)?;
-    } else {
-        hash.aset(ruby.intern("body"), ruby.qnil())?;
-        hash.aset(ruby.intern("body_text"), ruby.qnil())?;
-    }
-
-    Ok(hash.as_value())
-}
-
-/// Convert a ProblemDetails to a JSON string.
-pub fn problem_to_json(problem: &ProblemDetails) -> String {
-    problem
-        .to_json_pretty()
-        .unwrap_or_else(|err| format!("Failed to serialise problem details: {err}"))
-}
-
-/// Fetch a handler from a Ruby Hash by name.
-///
-/// Tries both symbol and string keys.
-pub fn fetch_handler(ruby: &Ruby, handlers: &RHash, name: &str) -> Result<Value, Error> {
-    let symbol_key = ruby.intern(name);
-    if let Some(value) = handlers.get(symbol_key) {
-        return Ok(value);
-    }
-
-    let string_key = ruby.str_new(name);
-    if let Some(value) = handlers.get(string_key) {
-        return Ok(value);
-    }
-
-    Err(Error::new(
-        ruby.exception_name_error(),
-        format!("Handler '{name}' not provided"),
-    ))
-}
-
-/// Get an optional keyword argument from a Ruby Hash.
-pub fn get_kw(ruby: &Ruby, hash: RHash, name: &str) -> Option<Value> {
-    let sym = ruby.intern(name);
-    hash.get(sym).or_else(|| hash.get(name))
-}
-
-/// Parse request configuration from a Ruby options Hash.
-///
-/// Supports: query, headers, cookies, json, data, raw_body, files
-pub fn parse_request_config(ruby: &Ruby, options: Value) -> Result<RequestConfig, Error> {
-    if options.is_nil() {
-        return Ok(RequestConfig {
-            query: None,
-            headers: HashMap::new(),
-            cookies: HashMap::new(),
-            body: None,
-        });
-    }
-
-    let hash = RHash::from_value(options)
-        .ok_or_else(|| Error::new(ruby.exception_arg_error(), "request options must be a Hash"))?;
-
-    let json_module = ruby
-        .class_object()
-        .const_get("JSON")
-        .map_err(|_| Error::new(ruby.exception_runtime_error(), "JSON module not available"))?;
-
-    let query = if let Some(value) = get_kw(ruby, hash, "query") {
-        if value.is_nil() {
-            None
-        } else {
-            Some(ruby_value_to_json(ruby, json_module, value)?)
-        }
-    } else {
-        None
-    };
-
-    let headers = if let Some(value) = get_kw(ruby, hash, "headers") {
-        if value.is_nil() {
-            HashMap::new()
-        } else {
-            let hash = RHash::try_convert(value)?;
-            hash.to_hash_map::<String, String>()?
-        }
-    } else {
-        HashMap::new()
-    };
-
-    let cookies = if let Some(value) = get_kw(ruby, hash, "cookies") {
-        if value.is_nil() {
-            HashMap::new()
-        } else {
-            let hash = RHash::try_convert(value)?;
-            hash.to_hash_map::<String, String>()?
-        }
-    } else {
-        HashMap::new()
-    };
-
-    let files_opt = get_kw(ruby, hash, "files");
-    let has_files = files_opt.is_some() && !files_opt.unwrap().is_nil();
-
-    let body = if has_files {
-        let files_value = files_opt.unwrap();
-        let files = extract_files(ruby, files_value)?;
-
-        let mut form_data = Vec::new();
-        if let Some(data_value) = get_kw(ruby, hash, "data")
-            && !data_value.is_nil()
-        {
-            let data_hash = RHash::try_convert(data_value)?;
-
-            let keys_array: RArray = data_hash.funcall("keys", ())?;
-
-            for i in 0..keys_array.len() {
-                let key_val = keys_array.entry::<Value>(i as isize)?;
-                let field_name = String::try_convert(key_val)?;
-                let value = data_hash
-                    .get(key_val)
-                    .ok_or_else(|| Error::new(ruby.exception_runtime_error(), "Failed to get hash value"))?;
-
-                if let Some(array) = RArray::from_value(value) {
-                    for j in 0..array.len() {
-                        let item = array.entry::<Value>(j as isize)?;
-                        let item_str = String::try_convert(item)?;
-                        form_data.push((field_name.clone(), item_str));
-                    }
-                } else {
-                    let value_str = String::try_convert(value)?;
-                    form_data.push((field_name, value_str));
-                }
-            }
-        }
-
-        Some(RequestBody::Multipart { form_data, files })
-    } else if let Some(value) = get_kw(ruby, hash, "json") {
-        if value.is_nil() {
-            None
-        } else {
-            Some(RequestBody::Json(ruby_value_to_json(ruby, json_module, value)?))
-        }
-    } else if let Some(value) = get_kw(ruby, hash, "data") {
-        if value.is_nil() {
-            None
-        } else {
-            Some(RequestBody::Form(ruby_value_to_json(ruby, json_module, value)?))
-        }
-    } else if let Some(value) = get_kw(ruby, hash, "raw_body") {
-        if value.is_nil() {
-            None
-        } else {
-            Some(RequestBody::Raw(String::try_convert(value)?))
-        }
-    } else {
-        None
-    };
-
-    Ok(RequestConfig {
-        query,
-        headers,
-        cookies,
-        body,
-    })
-}
-
-/// Extract files from a Ruby Hash.
-///
-/// Files can be provided as [filename, content] or [filename, content, content_type]
-pub fn extract_files(ruby: &Ruby, files_value: Value) -> Result<Vec<MultipartFilePart>, Error> {
-    let files_hash = RHash::try_convert(files_value)?;
-
-    let keys_array: RArray = files_hash.funcall("keys", ())?;
-    let mut result = Vec::new();
-
-    for i in 0..keys_array.len() {
-        let key_val = keys_array.entry::<Value>(i as isize)?;
-        let field_name = String::try_convert(key_val)?;
-        let value = files_hash
-            .get(key_val)
-            .ok_or_else(|| Error::new(ruby.exception_runtime_error(), "Failed to get hash value"))?;
-
-        if let Some(outer_array) = RArray::from_value(value) {
-            if outer_array.is_empty() {
-                continue;
-            }
-
-            let first_elem = outer_array.entry::<Value>(0)?;
-
-            if RArray::from_value(first_elem).is_some() {
-                for j in 0..outer_array.len() {
-                    let file_array = outer_array.entry::<Value>(j as isize)?;
-                    let file_data = extract_single_file(ruby, &field_name, file_array)?;
-                    result.push(file_data);
-                }
-            } else {
-                let file_data = extract_single_file(ruby, &field_name, value)?;
-                result.push(file_data);
-            }
-        }
-    }
-
-    Ok(result)
-}
-
-/// Extract a single file from a Ruby array [filename, content, content_type (optional)].
-pub fn extract_single_file(ruby: &Ruby, field_name: &str, array_value: Value) -> Result<MultipartFilePart, Error> {
-    let array = RArray::from_value(array_value)
-        .ok_or_else(|| Error::new(ruby.exception_arg_error(), "file must be an Array [filename, content]"))?;
-
-    if array.len() < 2 {
-        return Err(Error::new(
-            ruby.exception_arg_error(),
-            "file Array must have at least 2 elements: [filename, content]",
-        ));
-    }
-
-    let filename: String = String::try_convert(array.shift()?)?;
-    let content_str: String = String::try_convert(array.shift()?)?;
-    let content = content_str.into_bytes();
-
-    let content_type: Option<String> = if !array.is_empty() {
-        String::try_convert(array.shift()?).ok()
-    } else {
-        None
-    };
-
-    Ok(MultipartFilePart {
-        field_name: field_name.to_string(),
-        filename,
-        content,
-        content_type,
-    })
-}
-
-/// Extract an optional string from a Ruby Hash.
-pub fn get_optional_string_from_hash(hash: RHash, key: &str) -> Result<Option<String>, Error> {
-    match hash.get(String::from(key)) {
-        Some(v) if !v.is_nil() => Ok(Some(String::try_convert(v)?)),
-        _ => Ok(None),
-    }
-}
-
-/// Extract a required string from a Ruby Hash.
-pub fn get_required_string_from_hash(hash: RHash, key: &str, ruby: &Ruby) -> Result<String, Error> {
-    let value = hash
-        .get(String::from(key))
-        .ok_or_else(|| Error::new(ruby.exception_arg_error(), format!("missing required key '{}'", key)))?;
-    if value.is_nil() {
-        return Err(Error::new(
-            ruby.exception_arg_error(),
-            format!("key '{}' cannot be nil", key),
-        ));
-    }
-    String::try_convert(value)
-}