jsonrpc-rails 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 017eda83610eb76324999392d1f824fbc274f5182a3a1412ac3aaef19e9beaa8
-  data.tar.gz: 22f7ee6229d94a2f1dce2f03c7205d6c855b37b359a31b3ff6402e6c2fb40e4f
+  metadata.gz: 3c170f3b4c1b8b5d8903fc6202f317d98340c0939dae84117c062009f4128de3
+  data.tar.gz: 047dfecbe033df5e49a41a03d4c471452953358cb41bc95c0e2add3b9666ff81
 SHA512:
-  metadata.gz: dac03145eeddd7906005c9ad1770b745b6f6e8a4fd5185b7146b9adc9787cc21fa18697922063ba94e2ae5b3ab64839da27f4fa88fdfbe47c6cd88cb86b93b8e
-  data.tar.gz: 298e2f0955364e3175332f0288cffea4646afc410f73393c97573d1f3054fac105563af655a78a768e6ca3f69a920454dd6c3e7a859232df30fe93b9827e4fbc
+  metadata.gz: 2346088ba624f426d7f26df3f1d3d46faec883d2b45ef929ccd53e4bb1085132e8c0d2491b0f322ade4592ef0ffc182b0e39f15c795a490c7f0e4d2a2a646de1
+  data.tar.gz: c76d9df6e6b1e5c7eab1498ac9cf4a544f00c796cab13ae487ff302ac77a500ed488bd920ce9f010391de96430ee888fa68d3388f898646ebd82045e9d919dfd

data/README.md

@@ -184,6 +184,58 @@ class MyApiController < ApplicationController
 end
 ```
 
+## Error Codes
+
+The gem implements the complete JSON-RPC 2.0 error specification. All error codes are defined in `lib/json_rpc/json_rpc_error.rb` and can be used either as numeric codes or symbols:
+
+| Code | Symbol | Name | Description |
+|------|--------|------|-------------|
+| -32700 | `:parse_error` | Parse Error | Invalid JSON was received by the server |
+| -32600 | `:invalid_request` | Invalid Request | The JSON sent is not a valid Request object |
+| -32601 | `:method_not_found` | Method Not Found | The method does not exist / is not available |
+| -32602 | `:invalid_params` | Invalid Params | Invalid method parameter(s) |
+| -32603 | `:internal_error` | Internal Error | Internal JSON-RPC error |
+| -32000 | `:server_error` | Server Error | Implementation-defined server error |
+
+### Usage Examples
+
+```ruby
+# Using numeric codes
+render jsonrpc: {}, error: -32601, id: 1
+
+# Using symbols
+render jsonrpc: {}, error: :method_not_found, id: 1
+
+# Creating error objects
+error = JSON_RPC::JsonRpcError.build(:invalid_params)
+render jsonrpc: JSON_RPC::Response.new(id: 1, error: error)
+```
+
+## JSONRPC Namespace
+
+The gem uses two main namespaces to separate core JSON-RPC functionality from Rails integration:
+
+### JSON_RPC Module (Core Specification)
+
+Contains the core JSON-RPC 2.0 specification objects:
+
+- **`JSON_RPC::Request`** - Represents a JSON-RPC request with method, params, and id
+- **`JSON_RPC::Response`** - Represents a JSON-RPC response with result or error
+- **`JSON_RPC::Notification`** - Represents a JSON-RPC notification (request without id)
+- **`JSON_RPC::JsonRpcError`** - Exception class for JSON-RPC errors with standard error codes
+- **`JSON_RPC::Parser`** - Utility for converting hashes to typed JSON-RPC objects
+
+### JSONRPC_Rails Module (Rails Integration)
+
+Contains Rails-specific integration components:
+
+- **`JSONRPC_Rails::Railtie`** - Rails initialization, middleware setup, and renderer registration
+- **`JSONRPC_Rails::Middleware::Validator`** - Rack middleware for validating JSON-RPC requests
+- **`JSONRPC_Rails::ControllerHelpers`** - Helper methods like `jsonrpc_params` and `jsonrpc_params_batch?`
+- **`JSONRPC_Rails::VERSION`** - Current gem version
+
+This separation ensures clean architecture where core JSON-RPC logic is independent of Rails, while Rails-specific features are properly isolated.
+
 ## Testing
 
 A dummy Rails application is included within the gem (located in `test/dummy`) to facilitate testing. You can run the tests from the **project root directory** by executing:

data/lib/jsonrpc_rails/middleware/validator.rb

@@ -2,6 +2,7 @@
 
 require "json"
 require "active_support/json"
+require "stringio"
 
 module JSONRPC_Rails
   module Middleware
@@ -31,11 +32,16 @@ module JSONRPC_Rails
                                      env["CONTENT_TYPE"]&.start_with?(CONTENT_TYPE)
 
         body = env["rack.input"].read
-        env["rack.input"].rewind
+        # Replace consumed input with fresh StringIO for downstream middleware
+        # This is Rack 3.0+ compatible and works with all input stream types
+        env["rack.input"] = StringIO.new(body)
 
         raw_payload = parse_json(body)
 
-        return jsonrpc_error_response(:invalid_request) unless raw_payload.is_a?(Hash) || raw_payload.is_a?(Array)
+        unless raw_payload.is_a?(Hash) || raw_payload.is_a?(Array)
+          id = extract_id_from_raw_payload(raw_payload)
+          return jsonrpc_error_response(:invalid_request, id: id)
+        end
 
         validity, = if raw_payload.is_a?(Array)
                       validate_batch(raw_payload)
@@ -89,9 +95,10 @@ module JSONRPC_Rails
 
       def validate_single(obj)
         if validate_single_structure(obj)
-          [ :valid, nil ]
+          [ :valid, obj["id"] ]
         else
-          [ jsonrpc_error_response(:invalid_request), nil ]
+          id = obj.is_a?(Hash) ? obj["id"] : nil
+          [ jsonrpc_error_response(:invalid_request, id: id), id ]
         end
       end
 
@@ -119,12 +126,21 @@ module JSONRPC_Rails
 
       # @param error_sym [Symbol]
       # @param status    [Integer]
+      # @param id       [String, Integer, nil]
       # @return [Array] Rack triplet
-      def jsonrpc_error_response(error_sym, status: 400)
+      def jsonrpc_error_response(error_sym, status: 400, id: nil)
         error_obj = JSON_RPC::JsonRpcError.build(error_sym)
-        payload   = JSON_RPC::Response.new(id: nil, error: error_obj).to_json
+        payload   = JSON_RPC::Response.new(id: id, error: error_obj).to_json
+
+        [ status, { "content-type" => CONTENT_TYPE }, [ payload ] ]
+      end
 
-        [ status, { "Content-Type" => CONTENT_TYPE }, [ payload ] ]
+      # Extract ID from raw payload if possible
+      def extract_id_from_raw_payload(raw)
+        return nil unless raw.is_a?(Hash)
+        raw["id"]
+      rescue
+        nil
       end
     end
   end

data/lib/jsonrpc_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JSONRPC_Rails
-  VERSION = "0.5.2"
+  VERSION = "0.5.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonrpc-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors:
 - Abdelkader Boudih