Class: JSONRPC::Validator

Inherits:

Object

• Object
• JSONRPC::Validator

Defined in:

lib/jsonrpc/validator.rb

Overview

Validates JSON-RPC 2.0 requests, notifications and batches

The Validator handles parameter validation for JSON-RPC requests by checking method signatures against registered procedure definitions using Dry::Validation contracts.

Examples:

Validate a single request

validator = JSONRPC::Validator.new
error = validator.validate(request)

Instance Method Summary

• #initialize(logger: JSONRPC.configuration.logger) ⇒ Validator constructor

  Initializes the Validator.

• #validate(batch_or_request) ⇒ JSONRPC::Error, ...

  Validates a single request, notification or a batch.

Constructor Details

#initialize(logger: JSONRPC.configuration.logger) ⇒ Validator

Initializes the Validator

Parameters:

• logger (Logger) (defaults to: JSONRPC.configuration.logger) —

  the logger instance for diagnostic output

# File 'lib/jsonrpc/validator.rb', line 22

def initialize(logger: JSONRPC.configuration.logger)
  @logger = logger
end

Instance Method Details

#validate(batch_or_request) ⇒ JSONRPC::Error, ...

Validates a single request, notification or a batch

Examples:

Validate a single request

validator = JSONRPC::Validator.new
error = validator.validate(request)

Validate a batch of requests

validator = JSONRPC::Validator.new
errors = validator.validate(batch)

Parameters:

• batch_or_request (JSONRPC::BatchRequest, JSONRPC::Request, JSONRPC::Notification) —

  the object to validate

Returns:

• (JSONRPC::Error, Array<JSONRPC::Error>, nil) —

  error(s) if validation fails, nil if successful

# File 'lib/jsonrpc/validator.rb', line 42

def validate(batch_or_request)
  case batch_or_request
  when BatchRequest
    validate_batch_params(batch_or_request)
  when Request, Notification
    validate_request_params(batch_or_request)
  end
end