jsonrpc-rails 0.1.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 441449ded5e2318b8781addfbef037112f6db49595a3cb4ae3cddb35826ee02f
-  data.tar.gz: 0a4729694ca406fb564b9dbe5ba715f37d072f68a20a9f1e509121849050f18a
+  metadata.gz: 145a4a20db9c6d49fa01ca8b9eb0c1a853288195a78c099b4ecc9eefc4f551d8
+  data.tar.gz: c5ac9e090225a393917f0cda10c6d8a4d0593b428659d596539c1999edc3edcb
 SHA512:
-  metadata.gz: dcc63ff788dc3952db0974ae8acde6c363d6d61ce358e645b736ea53c709000f47ae3af11ba4ba9ae344a5b03bc7d9382fef229e58bbfe92925dbf790ea134f9
-  data.tar.gz: edbaaea3853e4f24bc63fe6c6261bf0386494b553f3559dafe722a9ab4ee02903b4004dbfc4874cdf310aa8a1e50ddc54d20db2ce0be8cbd050f835a030f8d1b
+  metadata.gz: a5d77db449217fddce82825a2daac7019d9c2133759dfd23cf01c1eb10fb4ec9d91b24ceca98fadb244b011a6becb15fe40256ab5d318cc4e65a5d23b2842247
+  data.tar.gz: fdcf40b192d2f132d577c47195b007e67172e574f99936c3d74f2c30d31e7cc956a6dabba74ef8362777deaec2fb3f4a974736aa14991fd9e33ccba2bd28faf3

data/README.md

@@ -10,7 +10,7 @@ It integrates into Rails, allowing you to render JSON-RPC responses and validate
 - **Rails Integration:** Easily integrate JSON-RPC 2.0 support via a Rails Railtie.
 - **Custom Renderer:** Render responses with `render jsonrpc:`, automatically wrapping data in the JSON-RPC 2.0 envelope.
 - **Error Handling:** Built-in support for both success and error responses according to the JSON-RPC 2.0 specification.
-- **Request Validation:** Includes middleware (`JSON_RPC_Rails::Middleware::Validator`) to strictly validate incoming JSON-RPC 2.0 requests (single and batch) against the specification structure.
+- **Request Validation:** Includes middleware (`JSONRPC_Rails::Middleware::Validator`) to strictly validate incoming JSON-RPC 2.0 requests (single and batch) against the specification structure.
 - **Rails 8+ Compatibility:** Designed specifically for Rails 8 and later versions.
 
 ## Installation
@@ -38,6 +38,22 @@ gem install jsonrpc-rails
 ### Rendering Responses
 
 Once installed, **jsonrpc-rails** registers a custom renderer with Rails. 
+
+Enable validation where you need it
+
+Add this to config/application.rb (or an environment file):
+```ruby
+# Validate only the JSON‑RPC endpoints you expose
+config.jsonrpc_rails.validated_paths = [
+"/rpc",                    # exact string
+%r{\A/api/v\d+/rpc\z},     # regexp
+->(p) { p.start_with? "/rpc/private" } # lambda / proc
+]
+```
+
+Leave the array empty (default) and the middleware is effectively off.
+Use [/.*\z/] if you really want it on everywhere.
+
 In your controllers, you can render JSON-RPC responses like so:
 
 ```ruby
@@ -81,7 +97,7 @@ You can override the default `message` or add `data` for either method by provid
 
 ### Handling Requests
 
-The gem automatically inserts `JSON_RPC_Rails::Middleware::Validator` into your application's middleware stack. This middleware performs the following actions for incoming **POST** requests with `Content-Type: application/json`:
+The gem automatically inserts `JSONRPC_Rails::Middleware::Validator` into your application's middleware stack. This middleware performs the following actions for incoming **POST** requests with `Content-Type: application/json`:
 
 1.  **Parses** the JSON body. Returns a JSON-RPC `Parse error (-32700)` if parsing fails.
 2.  **Validates** the structure against the JSON-RPC 2.0 specification (single or batch). It performs strict validation, ensuring `jsonrpc: "2.0"`, a string `method`, optional `params` (array/object), optional `id` (string/number/null), and **no extraneous keys**. Returns a JSON-RPC `Invalid Request (-32600)` error if validation fails. **Note:** For batch requests, if *any* individual request within the batch is structurally invalid, the entire batch is rejected with a single `Invalid Request (-32600)` error.

data/lib/jsonrpc-rails.rb

@@ -7,7 +7,5 @@ require_relative "json_rpc/request"
 require_relative "json_rpc/response"
 require_relative "json_rpc/notification"
 
-# Define the top-level module for the gem (optional, but good practice)
-module JSON_RPC_Rails
-  # You might add gem-level configuration or methods here if needed later.
+module JSONRPC_Rails
 end

data/lib/jsonrpc_rails/middleware/validator.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require "json"
-require "active_support/json" # Add this require
+require "active_support/json"
 
-module JSON_RPC_Rails
+module JSONRPC_Rails
   module Middleware
     # Rack middleware to strictly validate incoming JSON-RPC 2.0 requests.
     # It checks for correct Content-Type, parses JSON, and validates the structure
@@ -18,23 +18,25 @@ module JSON_RPC_Rails
     # Other valid JSON payloads (e.g., strings, numbers, booleans, null) are passed through.
     class Validator
       CONTENT_TYPE = "application/json"
-      ENV_PAYLOAD_KEY = "jsonrpc.payload"
+      ENV_PAYLOAD_KEY = :"jsonrpc.payload"
 
-      def initialize(app)
+      def initialize(app, paths = nil)
         @app = app
+
+        @paths = Array(paths || Rails.configuration.jsonrpc_rails.validated_paths)
       end
 
       def call(env)
-        request = Rack::Request.new(env)
+        return @app.call(env) unless validate_path?(env["PATH_INFO"])
 
         # Only process POST requests with the correct Content-Type
-        unless request.post? && request.content_type&.start_with?(CONTENT_TYPE)
-          return @app.call(env)
-        end
+        return @app.call(env) unless env["REQUEST_METHOD"] == "POST" &&
+                                     env["CONTENT_TYPE"]&.start_with?(CONTENT_TYPE)
 
         # Read and parse the request body
-        body = request.body.read
-        request.body.rewind # Rewind body for potential downstream middleware/apps
+        # Safely read and rewind
+        body = env["rack.input"].read
+        env["rack.input"].rewind
         payload = parse_json(body)
 
         # Handle JSON parsing errors
@@ -89,6 +91,19 @@ module JSON_RPC_Rails
         nil
       end
 
+      def validate_path?(path)
+        return false if @paths.empty?
+
+        @paths.any? do |m|
+          case m
+          when String then path == m
+          when Regexp then m.match?(path)
+          when Proc   then m.call(path)
+          else             false
+          end
+        end
+      end
+
       # Performs strict validation on a single object to ensure it conforms
       # to the JSON-RPC 2.0 structure (jsonrpc, method, params, id) and
       # has no extraneous keys.
@@ -108,8 +123,8 @@ module JSON_RPC_Rails
           return false
         end
 
-        # Optional 'id' must be a String, Number (Integer/Float), or Null if present
-        if obj.key?("id") && ![ String, Integer, Float, NilClass ].include?(obj["id"].class)
+        # Optional 'id' must be a String, Number (Integer), or Null if present
+        if obj.key?("id") && ![ String, Integer, NilClass ].include?(obj["id"].class)
           return false
         end
 

data/lib/jsonrpc_rails/railtie.rb

@@ -1,12 +1,13 @@
 require_relative "middleware/validator"
 
-module JSON_RPC_Rails
+module JSONRPC_Rails
   # Use Rails::Railtie to integrate with the Rails application
   class Railtie < Rails::Railtie
+    config.jsonrpc_rails = ActiveSupport::OrderedOptions.new
+    config.jsonrpc_rails.validated_paths = [] # By default, we inject it into the void.
     # Insert the JSON-RPC Validator middleware early in the stack.
-    # Inserting before Rack::Sendfile, which is typically present early in the stack.
     initializer "jsonrpc-rails.add_validator_middleware" do |app|
-      app.middleware.use JSON_RPC_Rails::Middleware::Validator
+      app.middleware.use JSONRPC_Rails::Middleware::Validator
     end
 
     initializer "jsonrpc-rails.add_renderers" do

data/lib/jsonrpc_rails/version.rb

@@ -1,3 +1,3 @@
-module JSON_RPC_Rails
-    VERSION = "0.1.1"
+module JSONRPC_Rails
+    VERSION = "0.3.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jsonrpc-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Abdelkader Boudih
 bindir: bin
 cert_chain: []
-date: 2025-03-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -65,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A Railtie-based gem that brings JSON-RPC 2.0 support to your Rails application.
 test_files: []