jsonrpc-middleware 0.6.0 → 0.7.0

data/lib/jsonrpc/parser.rb

@@ -6,6 +6,8 @@ module JSONRPC
   # The Parser handles converting raw JSON strings into appropriate JSONRPC objects
   # based on the JSON-RPC 2.0 protocol specification.
   #
+  # @api public
+  #
   # @example Parse a request
   #   parser = JSONRPC::Parser.new
   #   request = parser.parse('{"jsonrpc":"2.0","method":"subtract","params":[42,23],"id":1}')
@@ -26,14 +28,13 @@ module JSONRPC
     # @example Parse a batch request
     #   parser.parse('[{"jsonrpc":"2.0","method":"sum","params":[1,2],"id":"1"}]')
     #
+    # @raise [ParseError] if the JSON is invalid
+    # @raise [InvalidRequestError] if the request structure is invalid
+    #
     # @param json [String] the JSON-RPC 2.0 message
     #
     # @return [Request, Notification, BatchRequest] the parsed object
     #
-    # @raise [ParseError] if the JSON is invalid
-    #
-    # @raise [InvalidRequestError] if the request structure is invalid
-    #
     def parse(json)
       data = MultiJson.load(json)
 
@@ -83,12 +84,12 @@ module JSONRPC
     #
     # @api private
     #
+    # @raise [InvalidRequestError] if the batch is empty
+    #
     # @param data [Array] the array of request data
     #
     # @return [BatchRequest] the batch request
     #
-    # @raise [InvalidRequestError] if the batch is empty
-    #
     def parse_batch(data)
       raise InvalidRequestError.new(data: { details: 'Batch request cannot be empty' }) if data.empty?
 
@@ -114,12 +115,12 @@ module JSONRPC
     #
     # @api private
     #
+    # @raise [InvalidRequestError] if the request structure is invalid
+    #
     # @param data [Hash] the parsed JSON data for a single item
     #
     # @return [Request, Notification] the parsed request or notification
     #
-    # @raise [InvalidRequestError] if the request structure is invalid
-    #
     def parse_single_for_batch(data)
       validate_jsonrpc_version(data)
       validate_request_structure(data)
@@ -141,10 +142,10 @@ module JSONRPC
     #
     # @api private
     #
-    # @param data [Hash] the request data
-    #
     # @raise [InvalidRequestError] if the version is missing or invalid
     #
+    # @param data [Hash] the request data
+    #
     # @return [void]
     #
     def validate_jsonrpc_version(data)
@@ -170,10 +171,10 @@ module JSONRPC
     #
     # @api private
     #
-    # @param data [Hash] the request data
-    #
     # @raise [InvalidRequestError] if the request structure is invalid
     #
+    # @param data [Hash] the request data
+    #
     # @return [void]
     #
     def validate_request_structure(data)

data/lib/jsonrpc/railtie/batch_constraint.rb

@@ -13,6 +13,7 @@ module JSONRPC
     # Check if the request is a JSON-RPC batch request
     #
     # @param request [ActionDispatch::Request] The Rails request object
+    #
     # @return [Boolean] true if the request is a batch request, false otherwise
     #
     def matches?(request)

data/lib/jsonrpc/railtie/mapper_extension.rb

@@ -8,8 +8,6 @@ module JSONRPC
   module MapperExtension
     # Define JSON-RPC routes with a DSL
     #
-    # @param path [String] the path to handle JSON-RPC requests on
-    #
     # @example Define JSON-RPC routes
     #   jsonrpc '/api/v1' do
     #     # Handle batch requests
@@ -24,6 +22,8 @@ module JSONRPC
     #     end
     #   end
     #
+    # @param path [String] the path to handle JSON-RPC requests on
+    #
     # @return [void]
     #
     def jsonrpc(path = '/', &)

data/lib/jsonrpc/railtie/method_constraint.rb

@@ -22,6 +22,7 @@ module JSONRPC
     # Check if the request matches the configured method name
     #
     # @param request [ActionDispatch::Request] The Rails request object
+    #
     # @return [Boolean] true if the JSON-RPC method matches, false otherwise
     #
     def matches?(request)
@@ -31,5 +32,13 @@ module JSONRPC
 
       jsonrpc_request.method == @jsonrpc_method_name
     end
+
+    # Returns a string representation of the constraint
+    #
+    # @return [String] A string showing the configured JSON-RPC method name
+    #
+    def to_s
+      "#<JSONRPC::MethodConstraint method=\"#{@jsonrpc_method_name}\">"
+    end
   end
 end

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

data/lib/jsonrpc/response.rb

@@ -82,9 +82,7 @@ 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
     #
 
@@ -150,5 +148,7 @@ module JSONRPC
     def to_json(*)
       MultiJson.dump(to_h, *)
     end
+
+    alias to_response to_h
   end
 end

data/lib/jsonrpc/types.rb

@@ -8,6 +8,6 @@ module JSONRPC
   # @see https://dry-rb.org/gems/dry-types/ Dry::Types documentation
   #
   module Types
-    include Dry.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.6.0'
+  VERSION = '0.7.0'
 end

data/lib/jsonrpc.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'logger'
 require 'zeitwerk'
 require 'dry-struct'
 require 'dry-validation'
@@ -72,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