jsonrpc-middleware 0.4.0 → 0.6.0

data/lib/jsonrpc/railtie.rb

@@ -8,6 +8,13 @@ module JSONRPC
       app.middleware.use JSONRPC::Middleware
     end
 
+    # Register the JSON-RPC routes DSL extension
+    initializer 'jsonrpc.routes_dsl' do
+      ActiveSupport.on_load(:action_controller) do
+        ActionDispatch::Routing::Mapper.include(JSONRPC::MapperExtension)
+      end
+    end
+
     initializer 'jsonrpc.renderer' do
       ActiveSupport.on_load(:action_controller) do
         Mime::Type.register 'application/json', :jsonrpc
@@ -28,7 +35,7 @@ module JSONRPC
               self.response_body = ''
               ''
             else
-              result_data.to_json
+              MultiJson.dump(result_data)
             end
           elsif jsonrpc_notification?
             # Notification - no response body
@@ -37,7 +44,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
     #
@@ -85,16 +87,6 @@ module JSONRPC
     #
     # @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 +98,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 +111,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 +148,7 @@ module JSONRPC
     # @return [String] the response as a JSON string
     #
     def to_json(*)
-      to_h.to_json(*)
-    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)
+      MultiJson.dump(to_h, *)
     end
   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
+    include Dry.Types()
+  end
+end

data/lib/jsonrpc/version.rb

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

data/lib/jsonrpc.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require 'zeitwerk'
+require 'dry-struct'
 require 'dry-validation'
+require 'multi_json'
 
 Dry::Validation.load_extensions(:predicates_as_macros)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonrpc-middleware
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Wilson Silva
@@ -9,6 +9,20 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: dry-validation
   requirement: !ruby/object:Gem::Requirement
@@ -23,6 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -45,8 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".aiexclude"
+- ".aiignore"
 - ".claude/commands/document.md"
+- ".claude/commands/gemfile/update.md"
 - ".claude/commands/test.md"
 - ".claude/docs/yard.md"
 - ".claude/settings.local.json"
@@ -80,6 +109,8 @@ files:
 - examples/rack/README.md
 - examples/rack/app.rb
 - examples/rack/config.ru
+- examples/rails-routing-dsl/README.md
+- examples/rails-routing-dsl/config.ru
 - examples/rails-single-file-routing/README.md
 - examples/rails-single-file-routing/config.ru
 - examples/rails-single-file/README.md
@@ -136,9 +167,13 @@ files:
 - lib/jsonrpc/notification.rb
 - lib/jsonrpc/parser.rb
 - lib/jsonrpc/railtie.rb
+- lib/jsonrpc/railtie/batch_constraint.rb
+- lib/jsonrpc/railtie/mapper_extension.rb
 - lib/jsonrpc/railtie/method_constraint.rb
+- lib/jsonrpc/railtie/routes_dsl.rb
 - lib/jsonrpc/request.rb
 - lib/jsonrpc/response.rb
+- lib/jsonrpc/types.rb
 - lib/jsonrpc/validator.rb
 - lib/jsonrpc/version.rb
 - sig/jsonrpc.rbs
@@ -166,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.0
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Rack middleware implementing the JSON-RPC 2.0 protocol.
 test_files: []