jsonrpc-middleware 0.5.0 → 0.7.0

data/lib/jsonrpc/railtie/routes_dsl.rb

@@ -57,9 +57,6 @@ module JSONRPC
 
     # Define a JSON-RPC method route
     #
-    # @param jsonrpc_method [String] the JSON-RPC method name
-    # @param to [String] the Rails controller action (e.g., 'users#create')
-    #
     # @example Map a JSON-RPC method to controller action
     #   method 'user.create', to: 'users#create'
     #
@@ -68,33 +65,30 @@ module JSONRPC
     #     method 'create', to: 'posts#create'  # becomes posts.create
     #   end
     #
+    # @param jsonrpc_method [String] the JSON-RPC method name
+    # @param to [String] the Rails controller action (e.g., 'users#create')
+    #
     # @return [void]
     #
     def method(jsonrpc_method, to:)
       full_method_name = build_full_method_name(jsonrpc_method)
       constraint = JSONRPC::MethodConstraint.new(full_method_name)
 
-      @mapper.post @path_prefix, {
-        to: to,
-        constraints: constraint
-      }
+      @mapper.post(@path_prefix, to: to, constraints: constraint)
     end
 
     # Define a route for handling JSON-RPC batch requests
     #
-    # @param to [String] the Rails controller action (e.g., 'batches#handle')
-    #
     # @example Map batch requests to a controller action
     #   batch to: 'batches#handle'
     #
+    # @param to [String] the Rails controller action (e.g., 'batches#handle')
+    #
     # @return [void]
     def batch(to:)
       constraint = JSONRPC::BatchConstraint.new
 
-      @mapper.post @path_prefix, {
-        to: to,
-        constraints: constraint
-      }
+      @mapper.post(@path_prefix, to: to, constraints: constraint)
     end
 
     # Create a namespace for grouping related JSON-RPC methods
@@ -102,8 +96,6 @@ module JSONRPC
     # Namespaces can be nested to create hierarchical method names.
     # Each level of nesting adds a dot-separated prefix to the method names.
     #
-    # @param name [String] the namespace name
-    #
     # @example Single-level namespace
     #   namespace 'posts' do
     #     method 'create', to: 'posts#create' # becomes posts.create
@@ -121,6 +113,8 @@ module JSONRPC
     #     end
     #   end
     #
+    # @param name [String] the namespace name
+    #
     # @return [void]
     #
     def namespace(name, &)
@@ -134,6 +128,7 @@ module JSONRPC
     # Build the full method name including namespaces
     #
     # @param method_name [String] the base method name
+    #
     # @return [String] the full method name with namespace prefixes
     #
     def build_full_method_name(method_name)

data/lib/jsonrpc/railtie.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module JSONRPC
+  # Integrates JSONRPC middleware, routing DSL, and helpers into Rails applications.
+  #
   # @api private
   class Railtie < ::Rails::Railtie
     # Rails routing constraint for matching JSON-RPC method names
@@ -35,7 +37,7 @@ module JSONRPC
               self.response_body = ''
               ''
             else
-              result_data.to_json
+              MultiJson.dump(result_data)
             end
           elsif jsonrpc_notification?
             # Notification - no response body
@@ -44,7 +46,7 @@ module JSONRPC
             ''
           else
             # Fallback - treat as regular JSON-RPC response
-            result_data.to_json
+            MultiJson.dump(result_data)
           end
         end
       end

data/lib/jsonrpc/request.rb

@@ -13,7 +13,7 @@ module JSONRPC
   # @example Create a request with named parameters
   #   request = JSONRPC::Request.new(method: "subtract", params: { minuend: 42, subtrahend: 23 }, id: 3)
   #
-  class Request
+  class Request < Dry::Struct
     # JSON-RPC protocol version
     #
     # @api public
@@ -23,7 +23,7 @@ module JSONRPC
     #
     # @return [String]
     #
-    attr_reader :jsonrpc
+    attribute :jsonrpc, Types::String.default('2.0')
 
     # The method name to invoke
     #
@@ -34,7 +34,7 @@ module JSONRPC
     #
     # @return [String]
     #
-    attr_reader :method
+    attribute :method, Types::String.constrained(format: /\A(?!rpc\.)/)
 
     # Parameters to pass to the method
     #
@@ -45,7 +45,7 @@ module JSONRPC
     #
     # @return [Hash, Array, nil]
     #
-    attr_reader :params
+    attribute? :params, (Types::Hash | Types::Array).optional
 
     # The request identifier
     #
@@ -56,36 +56,7 @@ module JSONRPC
     #
     # @return [String, Integer, nil]
     #
-    attr_reader :id
-
-    # Creates a new JSON-RPC 2.0 Request object
-    #
-    # @api public
-    #
-    # @example Create a request with positional parameters
-    #   JSONRPC::Request.new(method: "subtract", params: [42, 23], id: 1)
-    #
-    # @param method [String] the name of the method to be invoked
-    # @param params [Hash, Array, nil] the parameters to be used during method invocation
-    # @param id [String, Integer, nil] the request identifier
-    #
-    # @raise [ArgumentError] if method is not a String or is reserved
-    #
-    # @raise [ArgumentError] if params is not a Hash, Array, or nil
-    #
-    # @raise [ArgumentError] if id is not a String, Integer, or nil
-    #
-    def initialize(method:, id:, params: nil)
-      @jsonrpc = '2.0'
-
-      validate_method(method)
-      validate_params(params)
-      validate_id(id)
-
-      @method = method
-      @params = params
-      @id = id
-    end
+    attribute? :id, Types::String | Types::Integer | Types::Nil
 
     # Converts the request to a JSON-compatible Hash
     #
@@ -119,61 +90,18 @@ module JSONRPC
     # @return [String] the request as a JSON string
     #
     def to_json(*)
-      to_h.to_json(*)
+      MultiJson.dump(to_h, *)
     end
 
-    private
-
-    # Validates that the method name meets JSON-RPC 2.0 requirements
-    #
-    # @api private
-    #
-    # @param method [String] the method name
-    #
-    # @raise [ArgumentError] if method is not a String or is reserved
-    #
-    # @return [void]
-    #
-    def validate_method(method)
-      raise ArgumentError, 'Method must be a String' unless method.is_a?(String)
-
-      return unless method.start_with?('rpc.')
-
-      raise ArgumentError, "Method names starting with 'rpc.' are reserved"
-    end
-
-    # Validates that the params is a valid structure according to JSON-RPC 2.0
-    #
-    # @api private
-    #
-    # @param params [Hash, Array, nil] the parameters
-    #
-    # @raise [ArgumentError] if params is not a Hash, Array, or nil
-    #
-    # @return [void]
-    #
-    def validate_params(params)
-      return if params.nil?
-
-      return if params.is_a?(Hash) || params.is_a?(Array)
-
-      raise ArgumentError, 'Params must be an Object, Array, or omitted'
-    end
-
-    # Validates that the id meets JSON-RPC 2.0 requirements
-    #
-    # @api private
+    # The method name to invoke
     #
-    # @param id [String, Integer, nil] the request identifier
+    # @api public
     #
-    # @raise [ArgumentError] if id is not a String, Integer, or nil
+    # @example
+    #   request.method # => "subtract"
     #
-    # @return [void]
+    # @return [String]
     #
-    def validate_id(id)
-      return if id.nil?
-
-      raise ArgumentError, 'ID must be a String, Integer, or nil' unless id.is_a?(String) || id.is_a?(Integer)
-    end
+    def method = attributes[:method]
   end
 end

data/lib/jsonrpc/response.rb

@@ -19,7 +19,9 @@ module JSONRPC
   #   error = JSONRPC::Error.new(code: -32601, message: "Method not found")
   #   response = JSONRPC::Response.new(error: error, id: 1)
   #
-  class Response
+  class Response < Dry::Struct
+    transform_keys(&:to_sym)
+
     # JSON-RPC protocol version
     #
     # @api public
@@ -29,7 +31,7 @@ module JSONRPC
     #
     # @return [String]
     #
-    attr_reader :jsonrpc
+    attribute :jsonrpc, Types::String.default('2.0')
 
     # The result of the method invocation (for success)
     #
@@ -40,7 +42,7 @@ module JSONRPC
     #
     # @return [Object, nil]
     #
-    attr_reader :result
+    attribute? :result, Types::Any
 
     # The error object (for failure)
     #
@@ -51,7 +53,7 @@ module JSONRPC
     #
     # @return [JSONRPC::Error, nil]
     #
-    attr_reader :error
+    attribute? :error, Types.Instance(JSONRPC::Error).optional
 
     # The request identifier
     #
@@ -62,7 +64,7 @@ module JSONRPC
     #
     # @return [String, Integer, nil]
     #
-    attr_reader :id
+    attribute? :id, Types::String | Types::Integer | Types::Nil
 
     # Creates a new JSON-RPC 2.0 Response object
     #
@@ -80,21 +82,9 @@ module JSONRPC
     # @param id [String, Integer, nil] the request identifier
     #
     # @raise [ArgumentError] if both result and error are present or both are nil
-    #
     # @raise [ArgumentError] if error is present but not a JSONRPC::Error
-    #
     # @raise [ArgumentError] if id is not a String, Integer, or nil
     #
-    def initialize(id:, result: nil, error: nil)
-      @jsonrpc = '2.0'
-
-      validate_result_and_error(result, error)
-      validate_id(id)
-
-      @result = result
-      @error = error
-      @id = id
-    end
 
     # Checks if the response is successful
     #
@@ -106,7 +96,7 @@ module JSONRPC
     # @return [Boolean] true if the response contains a result, false if it contains an error
     #
     def success?
-      !@result.nil?
+      !result.nil?
     end
 
     # Checks if the response is an error
@@ -119,7 +109,7 @@ module JSONRPC
     # @return [Boolean] true if the response contains an error, false if it contains a result
     #
     def error?
-      !@error.nil?
+      !error.nil?
     end
 
     # Converts the response to a JSON-compatible Hash
@@ -156,48 +146,9 @@ module JSONRPC
     # @return [String] the response as a JSON string
     #
     def to_json(*)
-      to_h.to_json(*)
+      MultiJson.dump(to_h, *)
     end
 
-    private
-
-    # Validates that exactly one of result or error is present
-    #
-    # @api private
-    #
-    # @param result [Object, nil] the result
-    # @param error [JSONRPC::Error, nil] the error
-    #
-    # @raise [ArgumentError] if both result and error are present or both are nil
-    #
-    # @raise [ArgumentError] if error is present but not a JSONRPC::Error
-    #
-    # @return [void]
-    #
-    def validate_result_and_error(result, error)
-      raise ArgumentError, 'Either result or error must be present' if result.nil? && error.nil?
-
-      raise ArgumentError, 'Response cannot contain both result and error' if !result.nil? && !error.nil?
-
-      return unless !error.nil? && !error.is_a?(Error)
-
-      raise ArgumentError, 'Error must be a JSONRPC::Error'
-    end
-
-    # Validates that the id meets JSON-RPC 2.0 requirements
-    #
-    # @api private
-    #
-    # @param id [String, Integer, nil] the request identifier
-    #
-    # @raise [ArgumentError] if id is not a String, Integer, or nil
-    #
-    # @return [void]
-    #
-    def validate_id(id)
-      return if id.nil?
-
-      raise ArgumentError, 'ID must be a String, Integer, or nil' unless id.is_a?(String) || id.is_a?(Integer)
-    end
+    alias to_response to_h
   end
 end

data/lib/jsonrpc/types.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module JSONRPC
+  # Container for dry-types
+  #
+  # @api private
+  #
+  # @see https://dry-rb.org/gems/dry-types/ Dry::Types documentation
+  #
+  module Types
+    send(:include, Dry.Types()) # Uses send to fix a YARD documentation bug
+  end
+end

data/lib/jsonrpc/validator.rb

@@ -13,6 +13,16 @@ module JSONRPC
   #   error = validator.validate(request)
   #
   class Validator
+    # Initializes the Validator
+    #
+    # @api public
+    #
+    # @param logger [Logger] the logger instance for diagnostic output
+    #
+    def initialize(logger: JSONRPC.configuration.logger)
+      @logger = logger
+    end
+
     # Validates a single request, notification or a batch
     #
     # @api public
@@ -92,7 +102,7 @@ module JSONRPC
           request_id: extract_request_id(request_or_notification),
           data: {
             method: request_or_notification.method,
-            params: validation_result.errors.to_h
+            params: validation_result.errors.to_h # rubocop:disable Rails/DeprecatedActiveModelErrorsMethods
           }
         )
       end
@@ -100,8 +110,8 @@ module JSONRPC
       nil
     rescue StandardError => e
       if JSONRPC.configuration.log_request_validation_errors
-        puts "Validation error: #{e.message}"
-        puts e.backtrace.join("\n")
+        @logger.error("Validation error: #{e.message}")
+        @logger.error(e.backtrace.join("\n"))
       end
 
       InternalError.new(request_id: extract_request_id(request_or_notification))
@@ -111,7 +121,7 @@ module JSONRPC
     #
     # @api private
     #
-    # @param request [Request, Notification] the request
+    # @param request [Request, Notification] A request or notification to be validated
     # @param procedure [Configuration::Procedure] the procedure configuration
     #
     # @return [Hash, InvalidParamsError] prepared params or error

data/lib/jsonrpc/version.rb

@@ -11,5 +11,5 @@ module JSONRPC
   #
   # @return [String] The current version number
   #
-  VERSION = '0.5.0'
+  VERSION = '0.7.0'
 end

data/lib/jsonrpc.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+require 'logger'
 require 'zeitwerk'
+require 'dry-struct'
 require 'dry-validation'
+require 'multi_json'
 
 Dry::Validation.load_extensions(:predicates_as_macros)
 
@@ -70,10 +73,12 @@ loader.enable_reloading
 loader.collapse("#{__dir__}/jsonrpc/errors")
 loader.collapse("#{__dir__}/jsonrpc/railtie")
 
+# :nocov:
 unless defined?(Rails)
   loader.ignore("#{__dir__}/jsonrpc/railtie.rb")
   loader.ignore("#{__dir__}/jsonrpc/railtie/method_constraint.rb")
 end
+# :nocov:
 
 loader.inflector.inflect('jsonrpc' => 'JSONRPC')
 loader.setup