jsonrpc-middleware 0.5.0 → 0.7.0

data/Rakefile

@@ -1,29 +1,23 @@
 # frozen_string_literal: true
 
+require 'English' # For $CHILD_STATUS
 require 'bundler/audit/task'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 require 'yaml'
+require 'yard'
 require 'yard/rake/yardoc_task'
-require 'yard-junk/rake'
-require 'yardstick/rake/measurement'
-require 'yardstick/rake/verify'
-
-yardstick_options = YAML.load_file('.yardstick.yml')
 
 Bundler::Audit::Task.new
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 YARD::Rake::YardocTask.new
-YardJunk::Rake.define_task
-Yardstick::Rake::Measurement.new(:yardstick_measure, yardstick_options)
-Yardstick::Rake::Verify.new(:verify_measurements, yardstick_options)
 
 task default: %i[spec rubocop]
 
 # Remove the report on rake clobber
-CLEAN.include('measurements', 'doc', '.yardoc', 'tmp')
+CLEAN.include('doc', '.yardoc', 'tmp')
 
 # Delete these files and folders when running rake clobber.
 CLOBBER.include('coverage', '.rspec_status')
@@ -32,11 +26,10 @@ desc 'Run spec with coverage'
 task :coverage do
   ENV['COVERAGE'] = 'true'
   Rake::Task['spec'].execute
-  `open coverage/index.html`
 end
 
 desc 'Test, lint and perform security and documentation audits'
-task qa: %w[spec rubocop yard:junk verify_measurements bundle:audit]
+task qa: %w[spec rubocop yard:lint bundle:audit]
 
 namespace :yard do
   desc 'Format YARD documentation'
@@ -94,59 +87,118 @@ namespace :yard do
     puts
     puts 'Done!'
   end
+
+  desc 'Lint YARD documentation'
+  task :lint do
+    system 'bundle exec yard-lint lib/'
+  end
 end
 
 namespace :examples do
   desc 'Run bundle install on all example folders'
   task :bundle_install do
     examples_dir = File.join(Dir.pwd, 'examples')
-    
+
     unless Dir.exist?(examples_dir)
       puts 'Examples directory not found'
       exit 1
     end
-    
+
     example_folders = Dir.glob(File.join(examples_dir, '*')).select { |path| Dir.exist?(path) }
-    
+
     if example_folders.empty?
       puts 'No example folders found'
       return
     end
-    
+
     puts "Found #{example_folders.length} example folders:"
     example_folders.each { |folder| puts "  - #{File.basename(folder)}" }
     puts
-    
+
     failed_folders = []
-    
+
     example_folders.each do |folder|
       gemfile_path = File.join(folder, 'Gemfile')
-      
+
       unless File.exist?(gemfile_path)
         puts "Skipping #{File.basename(folder)} - no Gemfile found"
         next
       end
-      
+
       puts "Running bundle install in #{File.basename(folder)}..."
-      
+
       Dir.chdir(folder) do
         system('bundle install')
-        
-        unless $?.success?
+
+        if $CHILD_STATUS.success?
+          puts "  ✓ Successfully installed gems in #{File.basename(folder)}"
+        else
           failed_folders << File.basename(folder)
           puts "  ✗ Failed to bundle install in #{File.basename(folder)}"
+        end
+      end
+
+      puts
+    end
+
+    if failed_folders.empty?
+      puts 'All example folders processed successfully!'
+    else
+      puts "Failed to process #{failed_folders.length} folders: #{failed_folders.join(", ")}"
+      exit 1
+    end
+  end
+
+  desc 'Run bundle update on all example folders'
+  task :bundle_update do
+    examples_dir = File.join(Dir.pwd, 'examples')
+
+    unless Dir.exist?(examples_dir)
+      puts 'Examples directory not found'
+      exit 1
+    end
+
+    example_folders = Dir.glob(File.join(examples_dir, '*')).select { |path| Dir.exist?(path) }
+
+    if example_folders.empty?
+      puts 'No example folders found'
+      return
+    end
+
+    puts "Found #{example_folders.length} example folders:"
+    example_folders.each { |folder| puts "  - #{File.basename(folder)}" }
+    puts
+
+    failed_folders = []
+
+    example_folders.each do |folder|
+      gemfile_path = File.join(folder, 'Gemfile')
+
+      unless File.exist?(gemfile_path)
+        puts "Skipping #{File.basename(folder)} - no Gemfile found"
+        next
+      end
+
+      puts "Running bundle update in #{File.basename(folder)}..."
+
+      Dir.chdir(folder) do
+        system('bundle update --all')
+
+        if $CHILD_STATUS.success?
+          puts "  ✓ Successfully updated gems in #{File.basename(folder)}"
         else
-          puts "  ✓ Successfully installed gems in #{File.basename(folder)}"
+          failed_folders << File.basename(folder)
+          puts "  ✗ Failed to bundle update in #{File.basename(folder)}"
         end
       end
-      
+
       puts
     end
-    
+
     if failed_folders.empty?
       puts 'All example folders processed successfully!'
     else
-      puts "Failed to process #{failed_folders.length} folders: #{failed_folders.join(', ')}"
+      puts "Failed to process #{failed_folders.length} folders: #{failed_folders.join(", ")}"
       exit 1
     end
   end

data/examples/README.md

@@ -10,6 +10,7 @@ This directory contains example implementations of JSON-RPC servers using the js
 - [**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
+- [**rails-routing-dsl**](./rails-routing-dsl/) - Smart home control server showcasing Rails JSON-RPC routing DSL
 - [**sinatra-classic**](./sinatra-classic/) - Calculator server using classic Sinatra
 - [**sinatra-modular**](./sinatra-modular/) - Calculator server using modular Sinatra
 
@@ -27,6 +28,14 @@ The echo examples implement:
 
 - `echo` - Returns the input message
 
+The rails-routing-dsl example implements a smart home control API:
+
+- `on` / `off` - Control main home automation system
+- `lights.on` / `lights.off` - Control lights
+- `climate.on` / `climate.off` - Control climate system
+- `climate.fan.on` / `climate.fan.off` - Control climate fan
+- Batch request support for multiple operations
+
 ## Running Examples
 
 Each example directory contains its own README with specific instructions. Generally:

data/examples/procedures.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 JSONRPC.configure do |config|
+  # Logger instance (default: Logger.new($stdout, progname: 'JSONRPC'))
+  config.logger = Logger.new($stdout, progname: 'JSONRPC')
   config.log_internal_errors = true           # Log internal error backtraces (default: true)
   config.log_request_validation_errors = true # Log JSON-RPC request validation errors (default: false)
   config.render_internal_errors = true        # Render detailed internal error information in responses (default: true)
@@ -14,7 +16,7 @@ JSONRPC.configure do |config|
     end
 
     rule(:addends) do
-      key.failure('must contain at least one addend') if value.empty?
+      key.failure('must contain at least two addends') if value.size < 2
     end
   end
 

data/examples/rack/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: ../..
   specs:
-    jsonrpc-middleware (0.4.0)
+    jsonrpc-middleware (0.6.0)
+      dry-struct (~> 1.8)
       dry-validation (~> 1.11)
+      multi_json (~> 1.20)
       zeitwerk (~> 2.7)
 
 GEM
@@ -32,6 +34,11 @@ GEM
       dry-logic (~> 1.5)
       dry-types (~> 1.8)
       zeitwerk (~> 2.6)
+    dry-struct (1.8.0)
+      dry-core (~> 1.1)
+      dry-types (~> 1.8, >= 1.8.2)
+      ice_nine (~> 0.11)
+      zeitwerk (~> 2.6)
     dry-types (1.8.3)
       bigdecimal (~> 3.0)
       concurrent-ruby (~> 1.0)
@@ -45,7 +52,9 @@ GEM
       dry-initializer (~> 3.2)
       dry-schema (~> 1.14)
       zeitwerk (~> 2.6)
+    ice_nine (0.11.2)
     logger (1.7.0)
+    multi_json (1.21.1)
     nio4r (2.7.4)
     puma (6.6.0)
       nio4r (~> 2.0)
@@ -65,4 +74,4 @@ DEPENDENCIES
   rackup
 
 BUNDLED WITH
-   2.7.0
+  4.0.8

data/examples/rack-echo/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: ../..
   specs:
-    jsonrpc-middleware (0.4.0)
+    jsonrpc-middleware (0.6.0)
+      dry-struct (~> 1.8)
       dry-validation (~> 1.11)
+      multi_json (~> 1.20)
       zeitwerk (~> 2.7)
 
 GEM
@@ -32,6 +34,11 @@ GEM
       dry-logic (~> 1.5)
       dry-types (~> 1.8)
       zeitwerk (~> 2.6)
+    dry-struct (1.8.0)
+      dry-core (~> 1.1)
+      dry-types (~> 1.8, >= 1.8.2)
+      ice_nine (~> 0.11)
+      zeitwerk (~> 2.6)
     dry-types (1.8.3)
       bigdecimal (~> 3.0)
       concurrent-ruby (~> 1.0)
@@ -45,7 +52,9 @@ GEM
       dry-initializer (~> 3.2)
       dry-schema (~> 1.14)
       zeitwerk (~> 2.6)
+    ice_nine (0.11.2)
     logger (1.7.0)
+    multi_json (1.21.1)
     nio4r (2.7.4)
     puma (6.6.0)
       nio4r (~> 2.0)
@@ -65,4 +74,4 @@ DEPENDENCIES
   rackup
 
 BUNDLED WITH
-   2.7.0
+  4.0.8

data/examples/rails/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: ../..
   specs:
-    jsonrpc-middleware (0.4.0)
+    jsonrpc-middleware (0.6.0)
+      dry-struct (~> 1.8)
       dry-validation (~> 1.11)
+      multi_json (~> 1.20)
       zeitwerk (~> 2.7)
 
 GEM
@@ -113,6 +115,11 @@ GEM
       dry-logic (~> 1.5)
       dry-types (~> 1.8)
       zeitwerk (~> 2.6)
+    dry-struct (1.8.0)
+      dry-core (~> 1.1)
+      dry-types (~> 1.8, >= 1.8.2)
+      ice_nine (~> 0.11)
+      zeitwerk (~> 2.6)
     dry-types (1.8.3)
       bigdecimal (~> 3.0)
       concurrent-ruby (~> 1.0)
@@ -132,6 +139,7 @@ GEM
       activesupport (>= 6.1)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
     io-console (0.8.1)
     irb (1.15.2)
       pp (>= 0.6.0)
@@ -148,7 +156,11 @@ GEM
       net-smtp
     marcel (1.0.4)
     mini_mime (1.1.5)
-    minitest (5.25.5)
+    mini_portile2 (2.8.9)
+    minitest (6.0.2)
+      drb (~> 2.0)
+      prism (~> 1.5)
+    multi_json (1.21.1)
     net-imap (0.5.9)
       date
       net-protocol
@@ -159,25 +171,15 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.4)
-    nokogiri (1.18.8-aarch64-linux-gnu)
-      racc (~> 1.4)
-    nokogiri (1.18.8-aarch64-linux-musl)
-      racc (~> 1.4)
-    nokogiri (1.18.8-arm-linux-gnu)
-      racc (~> 1.4)
-    nokogiri (1.18.8-arm-linux-musl)
+    nokogiri (1.18.8)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     nokogiri (1.18.8-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.8-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.18.8-x86_64-linux-gnu)
-      racc (~> 1.4)
-    nokogiri (1.18.8-x86_64-linux-musl)
-      racc (~> 1.4)
     pp (0.6.2)
       prettyprint
     prettyprint (0.2.0)
+    prism (1.9.0)
     psych (5.2.6)
       date
       stringio
@@ -242,14 +244,7 @@ GEM
     zeitwerk (2.7.3)
 
 PLATFORMS
-  aarch64-linux-gnu
-  aarch64-linux-musl
-  arm-linux-gnu
-  arm-linux-musl
   arm64-darwin
-  x86_64-darwin
-  x86_64-linux-gnu
-  x86_64-linux-musl
 
 DEPENDENCIES
   debug
@@ -258,4 +253,4 @@ DEPENDENCIES
   rails (~> 8.0.2)
 
 BUNDLED WITH
-   2.7.0
+  4.0.8

data/examples/rails/config/initializers/jsonrpc.rb

@@ -16,7 +16,7 @@ require_relative '../../../procedures'
 #     end
 #
 #     rule(:addends) do
-#       key.failure('must contain at least one addend') if value.empty?
+#       key.failure('must contain at least two addends') if value.size < 2
 #     end
 #   end
 #

data/examples/rails-routing-dsl/config.ru

@@ -65,7 +65,7 @@ class App < Rails::Application
 end
 
 # Controller for main system operations
-class MainController < ActionController::Base
+class MainController < ApplicationController
   def on
     render jsonrpc: { device: 'main_system', status: 'on' }
   end
@@ -76,7 +76,7 @@ class MainController < ActionController::Base
 end
 
 # Controller for lights operations
-class LightsController < ActionController::Base
+class LightsController < ApplicationController
   def on
     render jsonrpc: { device: 'lights', status: 'on' }
   end
@@ -87,7 +87,7 @@ class LightsController < ActionController::Base
 end
 
 # Controller for climate operations
-class ClimateController < ActionController::Base
+class ClimateController < ApplicationController
   def on
     render jsonrpc: { device: 'climate_system', status: 'on' }
   end
@@ -98,7 +98,7 @@ class ClimateController < ActionController::Base
 end
 
 # Controller for climate fan operations
-class FanController < ActionController::Base
+class FanController < ApplicationController
   def on
     render jsonrpc: { device: 'fan', status: 'on' }
   end
@@ -109,7 +109,7 @@ class FanController < ActionController::Base
 end
 
 # Controller for batch operations
-class BatchController < ActionController::Base
+class BatchController < ApplicationController
   def handle
     # Process each request in the batch and collect results
     results = jsonrpc_batch.process_each do |request_or_notification|

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

@@ -40,7 +40,7 @@ class App < Rails::Application
 end
 
 # Define the JSONRPC controller
-class JsonrpcController < ActionController::Base
+class JsonrpcController < ApplicationController
   def handle
     if jsonrpc_request?
       result = handle_single(jsonrpc_request)

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

@@ -10,6 +10,10 @@ Uses constraints to route JSON-RPC requests to different Rails controller action
 class App < Rails::Application
   # ...
   routes.append do
+    # Handle batch requests
+    post '/', to: 'jsonrpc#ping_or_echo', constraints: JSONRPC::BatchConstraint.new
+
+    # Handle individual method requests
     post '/', to: 'jsonrpc#echo', constraints: JSONRPC::MethodConstraint.new('echo')
     post '/', to: 'jsonrpc#ping', constraints: JSONRPC::MethodConstraint.new('ping')
   end
@@ -25,6 +29,20 @@ class JsonrpcController < ActionController::Base
   def ping
     render jsonrpc: 'pong'
   end
+
+  # POST /
+  def ping_or_echo
+    results = jsonrpc_batch.process_each do |request_or_notification|
+      case request_or_notification.method
+      when 'echo'
+        request_or_notification.params
+      when 'ping'
+        'pong'
+      end
+    end
+
+    render jsonrpc: results
+  end
 end
 ```
 
@@ -36,18 +54,35 @@ bundle exec rackup
 
 ## API
 
-The server implements an echo API with these procedures:
+The server implements these procedures:
 
 - `echo` - Returns the input message
-- `ping` - Returns "pong"
+- `ping` - Returns `'pong'`
 
 ## Example Requests
 
+Echo request:
 ```sh
 curl -X POST http://localhost:9292 \
   -H "Content-Type: application/json" \
   -d '{"jsonrpc": "2.0", "method": "echo", "params": {"message": "Hello, World!"}, "id": 1}'
+```
+
+Ping request:
+```sh
+curl -X POST http://localhost:9292 \
+  -H "Content-Type: application/json" \
+  -d '{"jsonrpc": "2.0", "method": "ping", "params": {}, "id": 2}'
+```
+
+Batch request with multiple methods:
+```sh
+# Batch request with multiple methods
 curl -X POST http://localhost:9292 \
   -H "Content-Type: application/json" \
-  -d '{"jsonrpc": "2.0""method": "ping", "params": {}, "id": 2}'
+  -d '[
+    {"jsonrpc": "2.0", "method": "echo", "params": {"message": "Hello from batch!"}, "id": 1},
+    {"jsonrpc": "2.0", "method": "ping", "params": {}, "id": 2},
+    {"jsonrpc": "2.0", "method": "echo", "params": {"message": "Another echo"}, "id": 3}
+  ]'
 ```

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

@@ -37,13 +37,17 @@ class App < Rails::Application
   config.hosts.clear
 
   routes.append do
+    # Handle batch requests
+    post '/', to: 'jsonrpc#ping_or_echo', constraints: JSONRPC::BatchConstraint.new
+
+    # Handle individual method requests
     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
+class JsonrpcController < ApplicationController
   def echo
     render jsonrpc: jsonrpc_request.params
   end
@@ -51,6 +55,19 @@ class JsonrpcController < ActionController::Base
   def ping
     render jsonrpc: 'pong'
   end
+
+  def ping_or_echo
+    results = jsonrpc_batch.process_each do |request_or_notification|
+      case request_or_notification.method
+      when 'echo'
+        request_or_notification.params
+      when 'ping'
+        'pong'
+      end
+    end
+
+    render jsonrpc: results
+  end
 end
 
 App.initialize!

data/examples/sinatra-classic/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: ../..
   specs:
-    jsonrpc-middleware (0.4.0)
+    jsonrpc-middleware (0.6.0)
+      dry-struct (~> 1.8)
       dry-validation (~> 1.11)
+      multi_json (~> 1.20)
       zeitwerk (~> 2.7)
 
 GEM
@@ -33,6 +35,11 @@ GEM
       dry-logic (~> 1.5)
       dry-types (~> 1.8)
       zeitwerk (~> 2.6)
+    dry-struct (1.8.0)
+      dry-core (~> 1.1)
+      dry-types (~> 1.8, >= 1.8.2)
+      ice_nine (~> 0.11)
+      zeitwerk (~> 2.6)
     dry-types (1.8.3)
       bigdecimal (~> 3.0)
       concurrent-ruby (~> 1.0)
@@ -46,8 +53,9 @@ GEM
       dry-initializer (~> 3.2)
       dry-schema (~> 1.14)
       zeitwerk (~> 2.6)
+    ice_nine (0.11.2)
     logger (1.7.0)
-    multi_json (1.16.0)
+    multi_json (1.21.1)
     mustermann (3.0.3)
       ruby2_keywords (~> 0.0.1)
     nio4r (2.7.4)
@@ -92,4 +100,4 @@ DEPENDENCIES
   sinatra-contrib
 
 BUNDLED WITH
-   2.7.0
+  4.0.8

data/examples/sinatra-modular/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: ../..
   specs:
-    jsonrpc-middleware (0.4.0)
+    jsonrpc-middleware (0.6.0)
+      dry-struct (~> 1.8)
       dry-validation (~> 1.11)
+      multi_json (~> 1.20)
       zeitwerk (~> 2.7)
 
 GEM
@@ -33,6 +35,11 @@ GEM
       dry-logic (~> 1.5)
       dry-types (~> 1.8)
       zeitwerk (~> 2.6)
+    dry-struct (1.8.0)
+      dry-core (~> 1.1)
+      dry-types (~> 1.8, >= 1.8.2)
+      ice_nine (~> 0.11)
+      zeitwerk (~> 2.6)
     dry-types (1.8.3)
       bigdecimal (~> 3.0)
       concurrent-ruby (~> 1.0)
@@ -46,8 +53,9 @@ GEM
       dry-initializer (~> 3.2)
       dry-schema (~> 1.14)
       zeitwerk (~> 2.6)
+    ice_nine (0.11.2)
     logger (1.7.0)
-    multi_json (1.16.0)
+    multi_json (1.21.1)
     mustermann (3.0.3)
       ruby2_keywords (~> 0.0.1)
     nio4r (2.7.4)
@@ -92,4 +100,4 @@ DEPENDENCIES
   sinatra-contrib
 
 BUNDLED WITH
-   2.7.0
+  4.0.8