jsonrpc-middleware 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea48adea36c2a7f311bb0b5c8d1868999f9ec7b6530a2b933600f8433655b63c
-  data.tar.gz: 8e4abe926bb02da6155650d2296d5df0b07562de6ce08163ad433df09ac40e1d
+  metadata.gz: be698b3797653f7d1139c034b97f4be0895cc181f840c4fe3d9edfb9624fb0a2
+  data.tar.gz: 3276fd9d13964cf6fe92f9a64ffe5bfac21bef767b3fde94328bc744ca2c8731
 SHA512:
-  metadata.gz: 90b63747650ce423ae7f5f881db75c0c8fceabc05e627fa0fd6647cd6b67c1445eab3a09dfc19cac3b5d62d9814e9a692b96e50e0bbdc41bd8b83d9d3582b6bc
-  data.tar.gz: 64c40bf854999ce3c0cdc8261a921d603ed8ec664c46a6e0d4578afbc9404e693f7b8ff5456385fdcb671867049d4e07028efa51ac48276a5adfd5c4a24b194d
+  metadata.gz: e4da3b7c0bd1fedc61baa9b8c4e9dc7fbd90c60c3e8509a676bd72b35d224a5928280bb56c5c4a7c92a40e5958544b81544e8461a551be818b8dd41b433416c0
+  data.tar.gz: cd7f389f4bf622cd9191c19dbba17890fa260259bd590d8d4bf9629dfc49f7573a05b772f25050c283fedc3b7f1d3899828ae1009a3b5deb52bc9911264c94ab

data/.aiexclude

@@ -1,3 +1,4 @@
+.kiro
 .ruby-lsp
 .vscode
 coverage

data/.tool-versions

@@ -1 +1 @@
-ruby 3.4.4
+ruby 3.4.5

data/CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2025-07-17
+
+### Added
+- Rails routing support with method constraints for JSON-RPC procedures
+- Rails single-file routing example application
+- Method constraint helper for Rails routing integration
+
+### Changed
+- Updated Ruby to v3.4.5 across all environments
+- Updated development dependencies (bundler, overcommit, rubocop, rubocop-yard)
+- Updated examples dependencies to use latest versions
+- Improved documentation for Rails single-file applications
+
+### Fixed
+- Standardized Ruby version usage across the project
+
 ## [0.2.0] - 2025-07-10
 
 ### Added

data/examples/README.md

@@ -7,8 +7,9 @@ This directory contains example implementations of JSON-RPC servers using the js
 - [**rack-echo**](./rack-echo/) - Echo server using Rack with helpers
 - [**rack-single-file**](./rack-single-file/) - Minimal single-file example with bundler/inline
 - [**rack**](./rack/) - Calculator server using pure Rack
-- [**rails**](./rails-single-file/) - Calculator server using Rails
+- [**rails**](./rails/) - Calculator server using Rails
 - [**rails-single-file**](./rails-single-file/) - Echo server using Rails with bundler/inline
+- [**rails-single-file-routing**](./rails-single-file-routing/) - Echo server using Rails with method-specific routing
 - [**sinatra-classic**](./sinatra-classic/) - Calculator server using classic Sinatra
 - [**sinatra-modular**](./sinatra-modular/) - Calculator server using modular Sinatra
 

data/examples/rack/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: ../..
   specs:
-    jsonrpc-middleware (0.1.0)
+    jsonrpc-middleware (0.2.0)
       dry-validation (~> 1.11)
       zeitwerk (~> 2.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    bigdecimal (3.1.9)
+    bigdecimal (3.2.2)
     concurrent-ruby (1.3.5)
     dry-configurable (1.3.0)
       dry-core (~> 1.1)
@@ -32,7 +32,7 @@ GEM
       dry-logic (~> 1.5)
       dry-types (~> 1.8)
       zeitwerk (~> 2.6)
-    dry-types (1.8.2)
+    dry-types (1.8.3)
       bigdecimal (~> 3.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0)
@@ -49,10 +49,10 @@ GEM
     nio4r (2.7.4)
     puma (6.6.0)
       nio4r (~> 2.0)
-    rack (3.1.14)
+    rack (3.1.16)
     rackup (2.2.1)
       rack (>= 3)
-    zeitwerk (2.7.2)
+    zeitwerk (2.7.3)
 
 PLATFORMS
   arm64-darwin-24
@@ -65,4 +65,4 @@ DEPENDENCIES
   rackup
 
 BUNDLED WITH
-   2.6.8
+   2.7.0

data/examples/rack-echo/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: ../..
   specs:
-    jsonrpc-middleware (0.1.0)
+    jsonrpc-middleware (0.2.0)
       dry-validation (~> 1.11)
       zeitwerk (~> 2.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    bigdecimal (3.1.9)
+    bigdecimal (3.2.2)
     concurrent-ruby (1.3.5)
     dry-configurable (1.3.0)
       dry-core (~> 1.1)
@@ -32,7 +32,7 @@ GEM
       dry-logic (~> 1.5)
       dry-types (~> 1.8)
       zeitwerk (~> 2.6)
-    dry-types (1.8.2)
+    dry-types (1.8.3)
       bigdecimal (~> 3.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0)
@@ -49,10 +49,10 @@ GEM
     nio4r (2.7.4)
     puma (6.6.0)
       nio4r (~> 2.0)
-    rack (3.1.14)
+    rack (3.1.16)
     rackup (2.2.1)
       rack (>= 3)
-    zeitwerk (2.7.2)
+    zeitwerk (2.7.3)
 
 PLATFORMS
   arm64-darwin-24
@@ -65,4 +65,4 @@ DEPENDENCIES
   rackup
 
 BUNDLED WITH
-   2.6.8
+   2.7.0

data/examples/rails/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    jsonrpc-middleware (0.1.0)
+    jsonrpc-middleware (0.2.0)
       dry-validation (~> 1.11)
       zeitwerk (~> 2.7)
 
@@ -126,13 +126,13 @@ GEM
       dry-initializer (~> 3.2)
       dry-schema (~> 1.14)
       zeitwerk (~> 2.6)
-    erb (5.0.1)
+    erb (5.0.2)
     erubi (1.13.1)
     globalid (1.2.1)
       activesupport (>= 6.1)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    io-console (0.8.0)
+    io-console (0.8.1)
     irb (1.15.2)
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
@@ -258,4 +258,4 @@ DEPENDENCIES
   rails (~> 8.0.2)
 
 BUNDLED WITH
-   2.6.9
+   2.7.0

data/examples/rails-single-file/README.md

@@ -0,0 +1,23 @@
+# Rails Single File
+
+An echo server using Rails with bundler/inline in a single file.
+
+## Running
+
+```sh
+bundle exec rackup
+```
+
+## API
+
+The server implements an echo API with this procedure:
+
+- `echo` - Returns the input message
+
+## Example Requests
+
+```sh
+curl -X POST http://localhost:9292 \
+  -H "Content-Type: application/json" \
+  -d '{"jsonrpc": "2.0", "method": "echo", "params": {"message": "Hello, World!"}, "id": 1}'
+```

data/examples/rails-single-file-routing/README.md

@@ -0,0 +1,53 @@
+# Rails Single File Routing
+
+Demonstrates routing JSON-RPC methods to different Rails controller actions.
+
+## Highlights
+
+Uses constraints to route JSON-RPC requests to different Rails controller actions:
+
+```ruby
+class App < Rails::Application
+  # ...
+  routes.append do
+    post '/', to: 'jsonrpc#echo', constraints: JSONRPC::MethodConstraint.new('echo')
+    post '/', to: 'jsonrpc#ping', constraints: JSONRPC::MethodConstraint.new('ping')
+  end
+end
+
+class JsonrpcController < ActionController::Base
+  # POST /
+  def echoc
+    render jsonrpc: jsonrpc_request.params
+  end
+
+  # POST /
+  def ping
+    render jsonrpc: 'pong'
+  end
+end
+```
+
+## Running
+
+```sh
+bundle exec rackup
+```
+
+## API
+
+The server implements an echo API with these procedures:
+
+- `echo` - Returns the input message
+- `ping` - Returns "pong"
+
+## Example Requests
+
+```sh
+curl -X POST http://localhost:9292 \
+  -H "Content-Type: application/json" \
+  -d '{"jsonrpc": "2.0", "method": "echo", "params": {"message": "Hello, World!"}, "id": 1}'
+curl -X POST http://localhost:9292 \
+  -H "Content-Type: application/json" \
+  -d '{"jsonrpc": "2.0""method": "ping", "params": {}, "id": 2}'
+```

data/examples/rails-single-file-routing/config.ru

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'bundler/inline'
+
+gemfile(true) do
+  source 'https://rubygems.org'
+
+  gem 'rails', '~> 8.0.2'
+  gem 'puma', '~> 6.6.0'
+  gem 'jsonrpc-middleware', path: '../../', require: 'jsonrpc'
+end
+
+require 'rails'
+require 'action_controller/railtie'
+
+JSONRPC.configure do |config|
+  config.rescue_internal_errors = true # set to +false+ if you want to raise JSONRPC::InternalError manually
+
+  procedure(:echo) do
+    params do
+      required(:message).filled(:string)
+    end
+  end
+
+  procedure(:ping) do
+    params do
+      # no params
+    end
+  end
+end
+
+# Define the application
+class App < Rails::Application
+  config.root = __dir__
+  config.cache_classes = true
+  config.eager_load = true
+  config.active_support.deprecation = :stderr
+  config.consider_all_requests_local = true
+  config.active_support.to_time_preserves_timezone = :zone
+  config.logger = nil
+  config.hosts.clear
+
+  routes.append do
+    post '/', to: 'jsonrpc#echo', constraints: JSONRPC::MethodConstraint.new('echo')
+    post '/', to: 'jsonrpc#ping', constraints: JSONRPC::MethodConstraint.new('ping')
+  end
+end
+
+# Define the JSONRPC controller
+class JsonrpcController < ActionController::Base
+  def echo
+    render jsonrpc: jsonrpc_request.params
+  end
+
+  def ping
+    render jsonrpc: 'pong'
+  end
+end
+
+App.initialize!
+
+run App

data/examples/sinatra-classic/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: ../..
   specs:
-    jsonrpc-middleware (0.1.0)
+    jsonrpc-middleware (0.2.0)
       dry-validation (~> 1.11)
       zeitwerk (~> 2.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    base64 (0.2.0)
+    base64 (0.3.0)
     bigdecimal (3.2.2)
     concurrent-ruby (1.3.5)
     dry-configurable (1.3.0)
@@ -47,18 +47,18 @@ GEM
       dry-schema (~> 1.14)
       zeitwerk (~> 2.6)
     logger (1.7.0)
-    multi_json (1.15.0)
+    multi_json (1.16.0)
     mustermann (3.0.3)
       ruby2_keywords (~> 0.0.1)
     nio4r (2.7.4)
     puma (6.6.0)
       nio4r (~> 2.0)
-    rack (3.1.13)
+    rack (3.1.16)
     rack-protection (4.1.1)
       base64 (>= 0.1.0)
       logger (>= 1.6.0)
       rack (>= 3.0.0, < 4)
-    rack-session (2.1.0)
+    rack-session (2.1.1)
       base64 (>= 0.1.0)
       rack (>= 3.0.0)
     rackup (2.2.1)
@@ -77,8 +77,8 @@ GEM
       rack-protection (= 4.1.1)
       sinatra (= 4.1.1)
       tilt (~> 2.0)
-    tilt (2.6.0)
-    zeitwerk (2.7.2)
+    tilt (2.6.1)
+    zeitwerk (2.7.3)
 
 PLATFORMS
   arm64-darwin-24
@@ -92,4 +92,4 @@ DEPENDENCIES
   sinatra-contrib
 
 BUNDLED WITH
-   2.6.8
+   2.7.0

data/examples/sinatra-classic/app.rb

@@ -26,8 +26,6 @@ post '/' do
   end
 end
 
-private
-
 def handle_single(request_or_notification)
   params = request_or_notification.params
 

data/examples/sinatra-modular/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: ../..
   specs:
-    jsonrpc-middleware (0.1.0)
+    jsonrpc-middleware (0.2.0)
       dry-validation (~> 1.11)
       zeitwerk (~> 2.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    base64 (0.2.0)
+    base64 (0.3.0)
     bigdecimal (3.2.2)
     concurrent-ruby (1.3.5)
     dry-configurable (1.3.0)
@@ -47,18 +47,18 @@ GEM
       dry-schema (~> 1.14)
       zeitwerk (~> 2.6)
     logger (1.7.0)
-    multi_json (1.15.0)
+    multi_json (1.16.0)
     mustermann (3.0.3)
       ruby2_keywords (~> 0.0.1)
     nio4r (2.7.4)
     puma (6.6.0)
       nio4r (~> 2.0)
-    rack (3.1.13)
+    rack (3.1.16)
     rack-protection (4.1.1)
       base64 (>= 0.1.0)
       logger (>= 1.6.0)
       rack (>= 3.0.0, < 4)
-    rack-session (2.1.0)
+    rack-session (2.1.1)
       base64 (>= 0.1.0)
       rack (>= 3.0.0)
     rackup (2.2.1)
@@ -77,8 +77,8 @@ GEM
       rack-protection (= 4.1.1)
       sinatra (= 4.1.1)
       tilt (~> 2.0)
-    tilt (2.6.0)
-    zeitwerk (2.7.2)
+    tilt (2.6.1)
+    zeitwerk (2.7.3)
 
 PLATFORMS
   arm64-darwin-24
@@ -92,4 +92,4 @@ DEPENDENCIES
   sinatra-contrib
 
 BUNDLED WITH
-   2.6.8
+   2.7.0

data/lib/jsonrpc/railtie/method_constraint.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module JSONRPC
+  # This constraint allows Rails routes to be matched based on the JSON-RPC
+  # method name in the request, enabling method-specific routing.
+  #
+  # @example Using in Rails routes
+  #   post '/', to: 'jsonrpc#echo', constraints: JSONRPC::Railtie::MethodConstraint.new('echo')
+  #   post '/', to: 'jsonrpc#ping', constraints: JSONRPC::Railtie::MethodConstraint.new('ping')
+  #
+  # @api private
+  #
+  class MethodConstraint
+    # Initialize a new method constraint
+    #
+    # @param jsonrpc_method_name [String] The JSON-RPC method name to match against
+    #
+    def initialize(jsonrpc_method_name)
+      @jsonrpc_method_name = jsonrpc_method_name
+    end
+
+    # 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)
+      jsonrpc_request = request.env['jsonrpc.request']
+
+      return false unless jsonrpc_request
+
+      jsonrpc_request.method == @jsonrpc_method_name
+    end
+  end
+end

data/lib/jsonrpc/railtie.rb

@@ -3,6 +3,7 @@
 module JSONRPC
   # @api private
   class Railtie < ::Rails::Railtie
+    # Rails routing constraint for matching JSON-RPC method names
     initializer 'jsonrpc.middleware' do |app|
       app.middleware.use JSONRPC::Middleware
     end

data/lib/jsonrpc/version.rb

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

data/lib/jsonrpc.rb

@@ -68,10 +68,13 @@ loader = Zeitwerk::Loader.for_gem
 loader.log! if ENV['DEBUG_ZEITWERK'] == 'true'
 loader.enable_reloading
 loader.collapse("#{__dir__}/jsonrpc/errors")
-loader.ignore("#{__dir__}/jsonrpc/railtie.rb")
+loader.collapse("#{__dir__}/jsonrpc/railtie")
+
+unless defined?(Rails)
+  loader.ignore("#{__dir__}/jsonrpc/railtie.rb")
+  loader.ignore("#{__dir__}/jsonrpc/railtie/method_constraint.rb")
+end
+
 loader.inflector.inflect('jsonrpc' => 'JSONRPC')
 loader.setup
 loader.eager_load
-
-# Only load Rails integration if Rails is available
-require_relative 'jsonrpc/railtie' if defined?(Rails)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonrpc-middleware
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Wilson Silva
@@ -79,9 +79,11 @@ files:
 - examples/rack/README.md
 - examples/rack/app.rb
 - examples/rack/config.ru
+- examples/rails-single-file-routing/README.md
+- examples/rails-single-file-routing/config.ru
+- examples/rails-single-file/README.md
 - examples/rails-single-file/config.ru
 - examples/rails/.gitignore
-- examples/rails/.ruby-version
 - examples/rails/Gemfile
 - examples/rails/Gemfile.lock
 - examples/rails/README.md
@@ -133,6 +135,7 @@ files:
 - lib/jsonrpc/notification.rb
 - lib/jsonrpc/parser.rb
 - lib/jsonrpc/railtie.rb
+- lib/jsonrpc/railtie/method_constraint.rb
 - lib/jsonrpc/request.rb
 - lib/jsonrpc/response.rb
 - lib/jsonrpc/validator.rb
@@ -162,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.0
 specification_version: 4
 summary: Implementation of the JSON-RPC protocol.
 test_files: []

data/examples/rails/.ruby-version

@@ -1 +0,0 @@
-ruby-3.4.4