spikard 0.13.0 → 0.15.3

data/lib/spikard/native.rb

@@ -0,0 +1,86 @@
+# This file is auto-generated by alef — DO NOT EDIT.
+# alef:hash:5edec17b527ff92ce6cce13114f42972a434edf40e174a174cbb292c5f29567f
+# To regenerate: alef generate
+# To verify freshness: alef verify --exit-code
+# Issues & docs: https://github.com/kreuzberg-dev/alef
+# frozen_string_literal: true
+
+require 'json'
+require 'sorbet-runtime'
+require 'spikard_rb'
+module Spikard
+  # Security scheme types
+  module SecuritySchemeInfo
+    extend T::Helpers
+    extend T::Sig
+
+    interface!
+
+    # Dispatch from a Hash to the appropriate variant constructor.
+    # @param hash [Hash] with discriminator field and variant-specific fields
+    # @return [variant_class] an instance of the appropriate variant
+    sig { params(hash: T::Hash[T.untyped, T.untyped]).returns(T.untyped) }
+    def self.from_hash(hash)
+      discriminator = hash[:type] || hash['type']
+      case discriminator
+      when 'http' then SecuritySchemeInfoHttp.from_hash(hash)
+      when 'apiKey' then SecuritySchemeInfoApiKey.from_hash(hash)
+      else raise "Unknown discriminator: #{discriminator}"
+      end
+    end
+  end
+
+  # Variant SecuritySchemeInfoHttp of the SecuritySchemeInfo sum type.
+  SecuritySchemeInfoHttp = Data.define(:scheme, :bearer_format) do
+    include SecuritySchemeInfo
+    extend T::Sig
+
+    # @return [String]
+    sig { returns(String) }
+    def scheme = super # rubocop:disable Lint/UselessMethodDefinition
+
+    # @return [T.nilable(String)]
+    sig { returns(T.nilable(String)) }
+    def bearer_format = super # rubocop:disable Lint/UselessMethodDefinition
+
+    sig { returns(T::Boolean) }
+    def http? = true
+
+    sig { returns(T::Boolean) }
+    def api_key? = false
+
+    # @param hash [Hash] deserialized from the native extension
+    # @return [self]
+    sig { params(hash: T::Hash[T.untyped, T.untyped]).returns(T.attached_class) }
+    def self.from_hash(hash)
+      new(scheme: hash[:scheme] || hash['scheme'], bearer_format: hash[:bearer_format] || hash['bearer_format'])
+    end
+  end
+
+  # Variant SecuritySchemeInfoApiKey of the SecuritySchemeInfo sum type.
+  SecuritySchemeInfoApiKey = Data.define(:location, :name) do
+    include SecuritySchemeInfo
+    extend T::Sig
+
+    # @return [String]
+    sig { returns(String) }
+    def location = super # rubocop:disable Lint/UselessMethodDefinition
+
+    # @return [String]
+    sig { returns(String) }
+    def name = super # rubocop:disable Lint/UselessMethodDefinition
+
+    sig { returns(T::Boolean) }
+    def http? = false
+
+    sig { returns(T::Boolean) }
+    def api_key? = true
+
+    # @param hash [Hash] deserialized from the native extension
+    # @return [self]
+    sig { params(hash: T::Hash[T.untyped, T.untyped]).returns(T.attached_class) }
+    def self.from_hash(hash)
+      new(location: hash[:location] || hash['location'], name: hash[:name] || hash['name'])
+    end
+  end
+end

data/lib/spikard/version.rb

@@ -1,5 +1,10 @@
+# This file is auto-generated by alef — DO NOT EDIT.
+# alef:hash:a37eb853a8ae098db1da14ad188f43587f0c70078b4f75ce80f07f607804871f
+# To regenerate: alef generate
+# To verify freshness: alef verify --exit-code
+# Issues & docs: https://github.com/kreuzberg-dev/alef
 # frozen_string_literal: true
 
 module Spikard
-  VERSION = '0.13.0'
+  VERSION = '0.15.3'
 end

data/lib/spikard.rb

@@ -1,57 +1,13 @@
+# This file is auto-generated by alef — DO NOT EDIT.
+# alef:hash:5c62d312ae2c1f0cd7d066ce8b2986e3e074ad0372813b665ae9cd9525b62162
+# To regenerate: alef generate
+# To verify freshness: alef verify --exit-code
+# Issues & docs: https://github.com/kreuzberg-dev/alef
 # frozen_string_literal: true
 
-# Main Ruby namespace for the Spikard bindings.
-module Spikard
-end
-
-begin
-  require 'json'
-rescue LoadError
-  # Fallback to pure-Ruby implementation when native JSON extension is unavailable
-  require 'json/pure'
-end
 require_relative 'spikard/version'
-require_relative 'spikard/config'
-require_relative 'spikard/response'
-require_relative 'spikard/background'
-require_relative 'spikard/schema'
-require_relative 'spikard/websocket'
-require_relative 'spikard/sse'
-require_relative 'spikard/grpc'
-require_relative 'spikard/upload_file'
-require_relative 'spikard/converters'
-require_relative 'spikard/provide'
-require_relative 'spikard/handler_wrapper'
-require_relative 'spikard/app'
-require_relative 'spikard/testing'
-
-begin
-  require 'spikard_rb'
-rescue LoadError => e
-  raise LoadError, <<~MSG, e.backtrace
-    Failed to load the Spikard native extension (spikard_rb). Run `bundle exec rake ext:build` to compile it before executing tests.
-    Original error: #{e.message}
-  MSG
-end
+require_relative 'spikard/native'
 
-at_exit do
-  if defined?(Spikard::Native) &&
-     Spikard::Native.respond_to?(:__shutdown_websocket_workers__, true)
-    Spikard::Native.__shutdown_websocket_workers__
-  end
-end
-
-if defined?(Spikard::Native::TestClient) && !Spikard::Native::TestClient.method_defined?(:__spikard_native_request,
-                                                                                         false)
-  Spikard::Native::TestClient.class_eval do
-    alias_method :__spikard_native_request, :request
-
-    def request(method, path, options = nil)
-      __spikard_native_request(method, path, options)
-    end
-  end
+module Spikard
+  # Re-export all types and functions from native extension
 end
-
-# Convenience aliases and methods
-Spikard::TestClient = Spikard::Testing::TestClient
-Spikard.extend Spikard::HandlerWrapper

data/sig/types.rbs

@@ -0,0 +1,427 @@
+# This file is auto-generated by alef — DO NOT EDIT.
+# alef:hash:dbf8bf90f99d68da22b871df1d242fee8be43b6b6779f41c132936c3df22a1fd
+# To regenerate: alef generate
+# To verify freshness: alef verify --exit-code
+# Issues & docs: https://github.com/kreuzberg-dev/alef
+
+module Spikard
+
+  VERSION: String
+
+  type json_value = Hash[String, untyped] | Array[untyped] | String | Integer | Float | bool | nil
+  type JsonValue = json_value
+
+  class UploadFile
+    attr_reader filename: String
+    attr_reader content_type: String
+    attr_reader size: Integer
+    attr_reader content: String
+    attr_reader content_encoding: String
+
+    def initialize: (filename: String, ?content_type: String, ?size: Integer, content: String, ?content_encoding: String) -> void
+    def as_bytes: () -> String
+    def read_to_string: () -> String
+    def content_type_or_default: () -> String
+  end
+
+  class ResponseSnapshot
+    attr_reader status: Integer
+    attr_reader headers: Hash[String, String]
+    attr_reader body: String
+
+    def initialize: (status: Integer, headers: Hash[String, String], body: String) -> void
+    def text: () -> String
+    def header: (String name) -> String?
+  end
+
+  class CorsConfig
+    attr_accessor allowed_origins: Array[String]?
+    attr_accessor allowed_methods: Array[String]?
+    attr_accessor allowed_headers: Array[String]?
+    attr_accessor expose_headers: Array[String]?
+    attr_accessor max_age: Integer?
+    attr_accessor allow_credentials: bool?
+
+    def initialize: (?allowed_origins: Array[String], ?allowed_methods: Array[String], ?allowed_headers: Array[String], ?expose_headers: Array[String], ?max_age: Integer, ?allow_credentials: bool) -> void
+    def allowed_methods_joined: () -> String
+    def allowed_headers_joined: () -> String
+    def is_origin_allowed: (String origin) -> bool
+    def is_method_allowed: (String method) -> bool
+    def are_headers_allowed: (Array[String] requested) -> bool
+    def self.default: () -> CorsConfig
+  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
+    def self.default: () -> CompressionConfig
+  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
+    def self.default: () -> RateLimitConfig
+  end
+
+  class JsonRpcMethodInfo
+    attr_reader method_name: String
+    attr_reader description: String
+    attr_reader params_schema: JsonValue
+    attr_reader result_schema: JsonValue
+    attr_reader deprecated: bool
+    attr_reader tags: Array[String]
+
+    def initialize: (method_name: String, ?description: String, ?params_schema: JsonValue, ?result_schema: JsonValue, deprecated: bool, tags: Array[String]) -> void
+  end
+
+  class ProblemDetails
+    attr_reader type_uri: String
+    attr_reader title: String
+    attr_reader status: Integer
+    attr_reader detail: String
+    attr_reader instance: String
+    attr_reader extensions: Hash[String, JsonValue]
+
+    def initialize: (type_uri: String, title: String, status: Integer, ?detail: String, ?instance: String, extensions: Hash[String, JsonValue]) -> void
+    def with_detail: (String detail) -> ProblemDetails
+    def with_instance: (String instance) -> ProblemDetails
+    def to_json: () -> String
+    def to_json_pretty: () -> String
+    def self.not_found: (String detail) -> ProblemDetails
+    def self.method_not_allowed: (String detail) -> ProblemDetails
+    def self.internal_server_error: (String detail) -> ProblemDetails
+    def self.bad_request: (String detail) -> ProblemDetails
+  end
+
+  class GraphQLRouteConfig
+    def path: (String path) -> GraphQLRouteConfig
+    def method: (String method) -> GraphQLRouteConfig
+    def enable_playground: (bool enable) -> GraphQLRouteConfig
+    def description: (String description) -> GraphQLRouteConfig
+    def get_path: () -> String
+    def get_method: () -> String
+    def is_playground_enabled: () -> bool
+    def get_description: () -> String?
+    def self.default: () -> GraphQLRouteConfig
+  end
+
+  class SchemaConfig
+    attr_accessor introspection_enabled: bool?
+    attr_accessor complexity_limit: Integer?
+    attr_accessor depth_limit: Integer?
+
+    def initialize: (?introspection_enabled: bool, ?complexity_limit: Integer, ?depth_limit: Integer) -> void
+    def self.default: () -> SchemaConfig
+  end
+
+  class QueryOnlyConfig
+    attr_accessor introspection_enabled: bool?
+    attr_accessor complexity_limit: Integer?
+    attr_accessor depth_limit: Integer?
+
+    def initialize: (?introspection_enabled: bool, ?complexity_limit: Integer, ?depth_limit: Integer) -> void
+    def self.default: () -> QueryOnlyConfig
+  end
+
+  class QueryMutationConfig
+    attr_accessor introspection_enabled: bool?
+    attr_accessor complexity_limit: Integer?
+    attr_accessor depth_limit: Integer?
+
+    def initialize: (?introspection_enabled: bool, ?complexity_limit: Integer, ?depth_limit: Integer) -> void
+    def self.default: () -> QueryMutationConfig
+  end
+
+  class FullSchemaConfig
+    attr_accessor introspection_enabled: bool?
+    attr_accessor complexity_limit: Integer?
+    attr_accessor depth_limit: Integer?
+
+    def initialize: (?introspection_enabled: bool, ?complexity_limit: Integer, ?depth_limit: Integer) -> void
+    def self.default: () -> FullSchemaConfig
+  end
+
+  class AsyncApiConfig
+    attr_accessor enabled: bool?
+    attr_accessor spec: JsonValue?
+
+    def initialize: (?enabled: bool, ?spec: JsonValue) -> void
+  end
+
+  class ParsedChannel
+    attr_reader name: String
+    attr_reader address: String
+    attr_reader messages: Array[String]
+    attr_reader bindings: JsonValue
+
+    def initialize: (name: String, address: String, messages: Array[String], ?bindings: JsonValue) -> void
+  end
+
+  class ParsedOperation
+    attr_reader name: String
+    attr_reader action: String
+    attr_reader channel: String
+
+    def initialize: (name: String, action: String, channel: String) -> void
+  end
+
+  class ParsedMessage
+    attr_reader name: String
+    attr_reader schema: JsonValue
+
+    def initialize: (name: String, ?schema: JsonValue) -> void
+  end
+
+  class ParseResult
+    attr_reader spec_version: String
+    attr_reader title: String
+    attr_reader api_version: String
+    attr_reader channels: Array[ParsedChannel]
+    attr_reader operations: Array[ParsedOperation]
+    attr_reader messages: Array[ParsedMessage]
+
+    def initialize: (spec_version: String, title: String, api_version: String, channels: Array[ParsedChannel], operations: Array[ParsedOperation], messages: Array[ParsedMessage]) -> void
+  end
+
+  class ParseRequest
+    attr_reader spec: JsonValue
+
+    def initialize: (spec: JsonValue) -> void
+  end
+
+  class ValidationResponse
+    attr_reader valid: bool
+    attr_reader errors: Array[String]
+
+    def initialize: (valid: bool, errors: Array[String]) -> void
+  end
+
+  class ValidateRequest
+    attr_reader spec: JsonValue
+    attr_reader channel: String
+    attr_reader message: String
+    attr_reader payload: JsonValue
+
+    def initialize: (spec: JsonValue, channel: String, message: String, payload: JsonValue) -> void
+  end
+
+  class BackgroundTaskConfig
+    attr_accessor max_queue_size: Integer?
+    attr_accessor max_concurrent_tasks: Integer?
+    attr_accessor drain_timeout_secs: Integer?
+
+    def initialize: (?max_queue_size: Integer, ?max_concurrent_tasks: Integer, ?drain_timeout_secs: Integer) -> void
+    def self.default: () -> BackgroundTaskConfig
+  end
+
+  class BackgroundJobMetadata
+    attr_accessor name: String?
+    attr_accessor request_id: String?
+
+    def initialize: (?name: String, ?request_id: String) -> void
+    def self.default: () -> BackgroundJobMetadata
+  end
+
+  class GrpcConfig
+    attr_accessor enabled: bool?
+    attr_accessor max_message_size: Integer?
+    attr_accessor enable_compression: bool?
+    attr_accessor request_timeout: Integer?
+    attr_accessor max_concurrent_streams: Integer?
+    attr_accessor enable_keepalive: bool?
+    attr_accessor keepalive_interval: Integer?
+    attr_accessor keepalive_timeout: Integer?
+    attr_accessor max_stream_response_bytes: Integer?
+
+    def initialize: (?enabled: bool, ?max_message_size: Integer, ?enable_compression: bool, ?request_timeout: Integer, ?max_concurrent_streams: Integer, ?enable_keepalive: bool, ?keepalive_interval: Integer, ?keepalive_timeout: Integer, ?max_stream_response_bytes: Integer) -> void
+    def self.default: () -> GrpcConfig
+  end
+
+  class JsonRpcConfig
+    attr_accessor enabled: bool?
+    attr_accessor endpoint_path: String?
+    attr_accessor enable_batch: bool?
+    attr_accessor max_batch_size: Integer?
+
+    def initialize: (?enabled: bool, ?endpoint_path: String, ?enable_batch: bool, ?max_batch_size: Integer) -> void
+    def self.default: () -> JsonRpcConfig
+  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
+    def self.default: () -> OpenApiConfig
+  end
+
+  class ContactInfo
+    attr_reader name: String
+    attr_reader email: String
+    attr_reader url: String
+
+    def initialize: (?name: String, ?email: String, ?url: String) -> void
+  end
+
+  class LicenseInfo
+    attr_reader name: String
+    attr_reader url: String
+
+    def initialize: (name: String, ?url: String) -> void
+  end
+
+  class ServerInfo
+    attr_reader url: String
+    attr_reader description: String
+
+    def initialize: (url: String, ?description: String) -> void
+  end
+
+  class Response
+    attr_accessor content: JsonValue?
+    attr_accessor status_code: Integer?
+    attr_accessor headers: Hash[String, String]?
+
+    def initialize: (?content: JsonValue, ?status_code: Integer, ?headers: Hash[String, String]) -> void
+    def set_header: (String key, String value) -> void
+    def set_cookie: (String key, String value, bool secure, bool http_only, ?Integer max_age, ?String domain, ?String path, ?String same_site) -> void
+    def self.default: () -> Response
+  end
+
+  class SseEvent
+    attr_reader event_type: String
+    attr_reader data: JsonValue
+    attr_reader id: String
+    attr_reader retry: Integer
+
+    def initialize: (?event_type: String, data: JsonValue, ?id: String, ?retry: Integer) -> void
+    def with_id: (String id) -> SseEvent
+    def with_retry: (Integer retry_ms) -> SseEvent
+  end
+
+  class TestingSseEvent
+    attr_reader data: String
+
+    def initialize: (data: String) -> void
+  end
+
+  class JwtConfig
+    attr_reader secret: String
+    attr_reader algorithm: String
+    attr_reader audience: Array[String]
+    attr_reader issuer: String
+    attr_reader leeway: Integer
+
+    def initialize: (secret: String, algorithm: String, ?audience: Array[String], ?issuer: String, leeway: Integer) -> void
+  end
+
+  class ApiKeyConfig
+    attr_reader keys: Array[String]
+    attr_reader header_name: String
+
+    def initialize: (keys: Array[String], header_name: String) -> void
+  end
+
+  class StaticFilesConfig
+    attr_reader directory: String
+    attr_reader route_prefix: String
+    attr_reader index_file: bool
+    attr_reader cache_control: String
+
+    def initialize: (directory: String, route_prefix: String, index_file: bool, ?cache_control: String) -> 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 asyncapi: AsyncApiConfig?
+    attr_accessor openapi: OpenApiConfig?
+    attr_accessor jsonrpc: JsonRpcConfig?
+    attr_accessor grpc: GrpcConfig?
+    attr_accessor background_tasks: BackgroundTaskConfig?
+    attr_accessor enable_http_trace: bool?
+
+    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, ?asyncapi: AsyncApiConfig, ?openapi: OpenApiConfig, ?jsonrpc: JsonRpcConfig, ?grpc: GrpcConfig, ?background_tasks: BackgroundTaskConfig, ?enable_http_trace: bool) -> void
+    def self.default: () -> ServerConfig
+  end
+
+  class GraphQLSubscriptionSnapshot
+    attr_reader operation_id: String
+    attr_reader acknowledged: bool
+    attr_reader event: JsonValue
+    attr_reader errors: Array[JsonValue]
+    attr_reader complete_received: bool
+
+    def initialize: (operation_id: String, acknowledged: bool, ?event: JsonValue, errors: Array[JsonValue], complete_received: bool) -> void
+  end
+
+  class TestClient
+    def get: (String path, ?Array[String] query_params, ?Array[String] headers) -> ResponseSnapshot
+    def post: (String path, ?JsonValue json, ?Array[String] form_data, String multipart, ?Array[String] query_params, ?Array[String] headers) -> ResponseSnapshot
+    def request_raw: (Method method, String path, String body, ?Array[String] query_params, ?Array[String] headers) -> ResponseSnapshot
+    def put: (String path, ?JsonValue json, ?Array[String] query_params, ?Array[String] headers) -> ResponseSnapshot
+    def patch: (String path, ?JsonValue json, ?Array[String] query_params, ?Array[String] headers) -> ResponseSnapshot
+    def delete: (String path, ?Array[String] query_params, ?Array[String] headers) -> ResponseSnapshot
+    def options: (String path, ?Array[String] query_params, ?Array[String] headers) -> ResponseSnapshot
+    def head: (String path, ?Array[String] query_params, ?Array[String] headers) -> ResponseSnapshot
+    def trace: (String path, ?Array[String] query_params, ?Array[String] headers) -> ResponseSnapshot
+    def graphql_at: (String endpoint, String query, ?JsonValue variables, ?String operation_name) -> ResponseSnapshot
+    def graphql: (String query, ?JsonValue variables, ?String operation_name) -> ResponseSnapshot
+    def graphql_with_status: (String query, ?JsonValue variables, ?String operation_name) -> String
+    def graphql_subscription_at: (String endpoint, String query, ?JsonValue variables, ?String operation_name) -> GraphQLSubscriptionSnapshot
+    def graphql_subscription: (String query, ?JsonValue variables, ?String operation_name) -> GraphQLSubscriptionSnapshot
+  end
+
+  class SnapshotError
+  end
+
+  class WebSocketMessage
+  end
+
+  class Method
+    type value = :get | :post | :put | :patch | :delete | :head | :options | :trace
+  end
+
+  class SecuritySchemeInfo
+  end
+
+  def self.schema_query_only: () -> QueryOnlyConfig
+
+  def self.schema_query_mutation: () -> QueryMutationConfig
+
+  def self.schema_full: () -> FullSchemaConfig
+
+  class GraphQLErrorInfo
+    def status_code: () -> Integer
+    def transient?: () -> bool
+    def error_type: () -> String
+  end
+
+end