jsonrpc-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a329937c7fecde34677567a8df15dab630b5062b30c01f1fcb825b25789e590
-  data.tar.gz: e7d7de880e9adc77839bb29feafdff54a35f56de555a68aa7e9d62413bf2d3fa
+  metadata.gz: 7c7eaabe38b79dd41bac2752a456d5278e6cc780c3d2ebbe0493c349ff24ee10
+  data.tar.gz: 51797ce9c50cd5e51b248f8a4376880f7ffcf19245daa8ae2ef1a4b9d5d17cdf
 SHA512:
-  metadata.gz: e98d92b3ea32b21fc6b1fafa766a0a9b3a60f9cd0475424753c486e62c872945dd105c0e64f91c9d0eba291918ec5bab6f5d3310d4039ed2b807c9c53d3f6291
-  data.tar.gz: b724be97e378604ede9244d90b76d93f07c0070a1e142ed0d3787c5d81e4df1dd8f1848a3d84fdd28096d6ae6cb7102e86780fe6c2b2fbabbf8a8e1fc8f0615b
+  metadata.gz: 3a55b1b369ff4d277b3351c6632a858bd00244cd0799108fbeaf4e64ba2e5b39c4687be0f1855e96df90343541e8ac0ab137684cad4f7af7394a75612b367395
+  data.tar.gz: 9883f5c131ab3437cde5410f82a21f072824a045e1680ad27d81ef1f4d10d471149a7db639c18d8e2d194586979919224c4e921bae263236023d71934d2a6cc5

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
@@ -81,7 +81,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,8 +1,9 @@
 # frozen_string_literal: true
 
 require "json"
+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
@@ -17,40 +18,54 @@ 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)
         @app = app
       end
 
       def call(env)
-        request = Rack::Request.new(env)
-
         # 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
-        return jsonrpc_error_response(:parse_error) unless payload
-
-        # Only attempt JSON-RPC validation if payload is a Hash or Array
-        unless payload.is_a?(Hash) || payload.is_a?(Array)
-          # Pass through other valid JSON types (string, number, boolean, null)
-          return @app.call(env)
+        # If parsing fails (returns nil), pass through
+        return @app.call(env) unless payload
+
+        # Determine if we should proceed with strict validation based on payload type and content
+        should_validate = false
+        is_batch = false
+
+        case payload
+        when Hash
+          # Validate single Hash only if 'jsonrpc' key is present
+          should_validate = payload.key?("jsonrpc")
+          is_batch = false
+        when Array
+          # Validate Array only if ALL elements are Hashes AND at least one has 'jsonrpc' key
+          all_hashes = payload.all? { |el| el.is_a?(Hash) }
+          any_jsonrpc = payload.any? { |el| el.is_a?(Hash) && el.key?("jsonrpc") }
+          if all_hashes && any_jsonrpc
+            should_validate = true
+            is_batch = true
+          end
+          # Note: Empty arrays or arrays not meeting the criteria will pass through
         end
 
-        # Payload is Hash or Array, proceed with JSON-RPC validation
-        is_batch = payload.is_a?(Array)
-        # validate_batch handles the empty array case internally now
+        # If conditions for validation are not met, pass through
+        return @app.call(env) unless should_validate
+
+        # --- Proceed with strict validation ---
         validation_result, _ = is_batch ? validate_batch(payload) : validate_single(payload)
 
-        # If validation failed, return the generated error response
+        # If strict validation failed (e.g., wrong version, missing method, invalid batch element), return the error
         return validation_result unless validation_result == :valid
 
         # Store the validated payload (original structure) in env for the controller
@@ -62,14 +77,13 @@ module JSON_RPC_Rails
 
       private
 
-      # Removed jsonrpc_payload? method
-
-      # Parses the JSON body string. Returns parsed data or nil on failure.
+      # Parses the JSON body string using ActiveSupport::JSON. Returns parsed data or nil on failure.
       def parse_json(body)
         return nil if body.nil? || body.strip.empty?
 
-        JSON.parse(body)
-      rescue JSON::ParserError
+        ActiveSupport::JSON.decode(body)
+      rescue ActiveSupport::JSON.parse_error
+        # Return nil if parsing fails, allowing the request to pass through
         nil
       end
 
@@ -92,8 +106,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
 
@@ -152,11 +166,10 @@ module JSON_RPC_Rails
                       JSON_RPC::JsonRpcError.new(error_type)
         end
 
-        response_body = {
-          jsonrpc: "2.0",
+        response_body = JSON_RPC::Response.new(
+          id: nil, # Middleware errors have null id
           error: error_obj.to_h,
-          id: nil # Middleware errors have null id
-        }.to_json
+        ).to_json
 
         [
           status,

data/lib/jsonrpc_rails/railtie.rb

@@ -1,12 +1,12 @@
 require_relative "middleware/validator"
 
-module JSON_RPC_Rails
+module JSONRPC_Rails
   # Use Rails::Railtie to integrate with the Rails application
   class Railtie < Rails::Railtie
     # 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.0"
+module JSONRPC_Rails
+    VERSION = "0.2.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jsonrpc-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Abdelkader Boudih
 bindir: bin
 cert_chain: []
-date: 2025-03-27 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: []