ultimate_json_rpc 1.0.0

data/sig/ultimate_json_rpc.rbs

@@ -0,0 +1,208 @@
+module UltimateJsonRpc
+  VERSION: String
+
+  module Core
+    class Error < StandardError
+    end
+
+    class InvalidRequest < Error
+    end
+
+    class InvalidParams < Error
+    end
+
+    class MethodNotFound < Error
+      attr_reader method_name: String
+
+      def initialize: (String) -> void
+    end
+
+    class ApplicationError < Error
+      attr_reader code: Integer
+      attr_reader rpc_data: untyped
+
+      def initialize: (code: Integer, message: String, ?data: untyped) -> void
+    end
+
+    class ServerError < Error
+      attr_reader code: Integer
+      attr_reader rpc_data: untyped
+
+      def initialize: (code: Integer, message: String, ?data: untyped) -> void
+    end
+
+    REQUEST_TIMEOUT: Integer
+
+    class RequestTimeout < ServerError
+      def initialize: (?untyped) -> void
+    end
+
+    PARSE_ERROR: Integer
+    INVALID_REQUEST: Integer
+    METHOD_NOT_FOUND: Integer
+    INVALID_PARAMS: Integer
+    INTERNAL_ERROR: Integer
+    SERVER_ERROR_MIN: Integer
+    SERVER_ERROR_MAX: Integer
+    RESERVED_ERROR_MIN: Integer
+    RESERVED_ERROR_MAX: Integer
+    ERROR_MESSAGES: Hash[Integer, String]
+
+    class Request
+      MAX_NESTING: Integer
+
+      attr_reader method_name: String
+      attr_reader params: Array[untyped] | Hash[String, untyped] | nil
+      attr_reader id: String | Numeric | nil
+      attr_reader context: Hash[Symbol, untyped]
+
+      def initialize: (Hash[String, untyped]) -> void
+      def notification?: () -> bool
+    end
+
+    module Response
+      def self.success: (untyped, untyped) -> Hash[String, untyped]
+      def self.error: (Integer, untyped, ?data: untyped, ?message: String?) -> Hash[String, untyped]
+    end
+
+    class Handler
+      def initialize: () -> void
+      def expose: (Module | Object, ?namespace: String | Symbol | nil, ?only: Array[Symbol | String] | Symbol | String | nil, ?except: Array[Symbol | String] | Symbol | String | nil, ?descriptions: Hash[Symbol | String, String]?, ?returns: Hash[Symbol | String, untyped]?, ?deprecated: Hash[Symbol | String, untyped]?, ?params_schema: Hash[Symbol | String, untyped]?) -> void
+      def expose_method: (String | Symbol, ?callable, ?description: String?, ?returns: untyped, ?deprecated: (bool | String)?, ?params_schema: Hash[String | Symbol, untyped]?) ?{ (*untyped) -> untyped } -> void
+      def call: (String, Array[untyped] | Hash[String, untyped] | nil) -> untyped
+      def method?: (String) -> bool
+      def methods_list: () -> Array[String]
+      def methods_info: () -> Array[Hash[String, untyped]]
+      def size: () -> Integer
+      def empty?: () -> bool
+      def freeze: () -> self
+    end
+  end
+
+  interface _Callable
+    def call: (*untyped) -> untyped
+  end
+
+  interface _JsonAdapter
+    def parse: (String) -> untyped
+    def generate: (untyped) -> String
+  end
+
+  type callable = Proc | Method | _Callable
+
+  class Server
+    attr_reader name: String?
+    attr_reader version: String?
+    attr_reader description: String?
+    attr_reader max_batch_size: Integer?
+    attr_reader timeout: Numeric?
+    attr_reader json_adapter: _JsonAdapter
+
+    def initialize: (?name: String?, ?version: String?, ?description: String?, ?max_batch_size: Integer?, ?expose_errors: bool, ?timeout: Numeric?, ?concurrent_batches: bool, ?max_concurrency: Integer, ?json: _JsonAdapter) -> void
+    def expose: (Module | Object, ?namespace: String | Symbol | nil, ?only: Array[Symbol | String] | Symbol | String | nil, ?except: Array[Symbol | String] | Symbol | String | nil, ?descriptions: Hash[Symbol | String, String]?, ?returns: Hash[Symbol | String, untyped]?, ?deprecated: Hash[Symbol | String, untyped]?, ?params_schema: Hash[Symbol | String, untyped]?) -> self
+    def expose_method: (String | Symbol, ?callable, ?description: String?, ?returns: untyped, ?deprecated: (bool | String)?, ?params_schema: Hash[String | Symbol, untyped]?) ?{ (*untyped) -> untyped } -> self
+    def use: (?only: Array[String | Symbol] | String | Symbol | nil, ?except: Array[String | Symbol] | String | Symbol | nil) { (Core::Request, Proc) -> untyped } -> self
+    def on: (Symbol) { (*untyped) -> void } -> self
+    def register_error: (code: Integer, message: String, ?description: String?) -> self
+    def authorize: (*String, ?code: Integer, ?message: String) { (Core::Request) -> boolish } -> self
+    def to_proc: () -> Proc
+    def inspect: () -> String
+    def expose_errors?: () -> bool
+    def concurrent_batches?: () -> bool
+    def method?: (String) -> bool
+    def handle: (String) -> String?
+    alias call handle
+    def handle_parsed: (untyped) -> String?
+    def methods_list: () -> Array[String]
+    def methods_info: () -> Array[Hash[String, untyped]]
+    def size: () -> Integer
+    def empty?: () -> bool
+    def freeze: () -> self
+  end
+
+  module Transport
+    class Stdio
+      def initialize: (Server, ?input: IO, ?output: IO) -> void
+      def run: () -> void
+      def stop: () -> void
+      def running?: () -> bool
+    end
+
+    class Rack
+      def initialize: (Server) -> void
+      def call: (Hash[String, untyped]) -> [Integer, Hash[String, String], Array[String]]
+      def freeze: () -> self
+    end
+
+    class TCP
+      DEFAULT_MAX_CONNECTIONS: Integer
+      MAX_LINE_BYTES: Integer
+
+      def initialize: (Server, port: Integer, ?host: String, ?max_connections: Integer) -> void
+      def run: () -> void
+      def stop: () -> void
+      def running?: () -> bool
+      def port: () -> Integer?
+    end
+
+    class WebSocket
+      attr_reader server: Server
+
+      def initialize: (Server) -> void
+      def on_message: (untyped) -> String?
+      def call: (untyped, untyped) -> void
+      def freeze: () -> self
+    end
+  end
+
+  module Extras
+    class MCP
+      PROTOCOL_VERSION: String
+
+      def initialize: (Server, ?input: IO, ?output: IO, ?json: _JsonAdapter) -> void
+      def run: () -> void
+      def stop: () -> void
+      def running?: () -> bool
+    end
+
+    class Profiler
+      DEFAULT_MAX_SAMPLES: Integer
+
+      def initialize: (Server, ?max_samples: Integer) -> void
+      def []: (String) -> Hash[Symbol, untyped]?
+      def tracked_methods: () -> Array[String]
+      alias method_names tracked_methods
+      def stats: () -> Hash[String, Hash[Symbol, untyped]]
+      def reset: () -> void
+    end
+
+    class RateLimiter
+      def initialize: (Server, max: Integer, period: Numeric, ?key: (Symbol | Proc)?, ?code: Integer, ?message: String, ?only: Array[String | Symbol] | String | Symbol | nil, ?except: Array[String | Symbol] | String | Symbol | nil) -> void
+    end
+
+    class Logging
+      def initialize: (Server, untyped, ?level: Symbol) -> void
+    end
+
+    class Recorder
+      def initialize: (Server, ?output: IO?, ?max_exchanges: Integer?, ?json: _JsonAdapter) -> void
+      def exchanges: () -> Array[Hash[String, untyped]]
+      def clear: () -> void
+      def size: () -> Integer
+    end
+
+    class Docs
+      def initialize: (Server, ?json: _JsonAdapter) -> void
+      def to_markdown: () -> String
+    end
+
+    module TestHelpers
+      def rpc_call: (Server, String, ?params: untyped, ?id: String | Integer) -> Hash[String, untyped]
+      def rpc_notify: (Server, String, ?params: untyped) -> String?
+      def rpc_batch: (Server, *Hash[String, untyped]) -> Array[Hash[String, untyped]]?
+      def assert_rpc_success: (Hash[String, untyped], ?expected: untyped, ?msg: String?) -> void
+      def assert_rpc_error: (Hash[String, untyped], ?code: Integer?, ?message: String?, ?msg: String?) -> void
+      def assert_rpc_notification: (Server, String, ?params: untyped, ?msg: String?) -> void
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: ultimate_json_rpc
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andriy Tyurnikov
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Network-agnostic JSON-RPC server that exposes Ruby modules, classes,
+  instances, and namespaces as callable RPC endpoints.
+email:
+- Andriy.Tyurnikov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/error_handling.rb
+- examples/mcp_server.rb
+- examples/multi_namespace.rb
+- examples/rack_server.ru
+- examples/testing_patterns.rb
+- examples/websocket_server.ru
+- lib/ultimate_json_rpc.rb
+- lib/ultimate_json_rpc/core/errors.rb
+- lib/ultimate_json_rpc/core/handler.rb
+- lib/ultimate_json_rpc/core/request.rb
+- lib/ultimate_json_rpc/core/response.rb
+- lib/ultimate_json_rpc/extras/docs.rb
+- lib/ultimate_json_rpc/extras/logging.rb
+- lib/ultimate_json_rpc/extras/mcp.rb
+- lib/ultimate_json_rpc/extras/profiler.rb
+- lib/ultimate_json_rpc/extras/rate_limit.rb
+- lib/ultimate_json_rpc/extras/recorder.rb
+- lib/ultimate_json_rpc/extras/test_helpers.rb
+- lib/ultimate_json_rpc/server.rb
+- lib/ultimate_json_rpc/transport/rack.rb
+- lib/ultimate_json_rpc/transport/stdio.rb
+- lib/ultimate_json_rpc/transport/tcp.rb
+- lib/ultimate_json_rpc/transport/websocket.rb
+- lib/ultimate_json_rpc/version.rb
+- sig/ultimate_json_rpc.rbs
+homepage: https://github.com/rubakas/ultimate_json_rpc
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rubakas/ultimate_json_rpc
+  source_code_uri: https://github.com/rubakas/ultimate_json_rpc
+  changelog_uri: https://github.com/rubakas/ultimate_json_rpc/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.8
+specification_version: 4
+summary: Expose Ruby objects through JSON-RPC
+test_files: []