jsonrpc2 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6656e3e753bbf3ae9c6d64fc70f1f98ecabe3f8854651d9d4574f6d1b4a3a6c2
-  data.tar.gz: 9ecd6c561d1c037f755331d8ca9c968f085e76479853dccbd239e89cb5e76b84
+  metadata.gz: 38157bffab895f13838433b4564add0f49d5823a9220eafc0b8d9e402bad7931
+  data.tar.gz: 5ff1f88ca328078754a7fec05f386ab7308ddef82fbb4f8e357b4eceeef0d373
 SHA512:
-  metadata.gz: 00fc45704df91c0a9b836c9ae7167a2117709e52275d47233c44e724b0f245de35ed29f445c2c4b383fc864f14511577f7e49a023d562e6ae753e29ca95114dd
-  data.tar.gz: 76b803ba32848432dee6797b733ce75e775c151a9e1cf18047ce84dbe5aff6c8ea0d62bbb56e55b66f128e81a5522176db331a078b63247014b4270a00078c74
+  metadata.gz: b59d216b880ebeb4988573873090e9bd0807b77a8c7235ee28cfd84a6aeef219d5a7c7c9e16109a93b55d1857a01d3bf7e5ccc10f6bde4e62972199e05f2bccc
+  data.tar.gz: 507d80c0b89143a72c092dc994bc31d72977d5289dfb2c446d879af4b8790f0456457bc8d649a21cdcae9d632f2e8d3acb121c9f24999dcf276d39c18122a05f

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.3.0] - 2023-02-09
+### Added
+- Possibility to define callback for request calls prior to validation `JSONRPC2::Interface#before_validation`
+
 ## [0.2.0] - 2022-04-07
 ### Added
 - Possibility to define callback for server errors with `JSONRPC2::Interface#on_server_error`

data/lib/jsonrpc2/interface.rb

@@ -239,6 +239,7 @@ module JSONRPC2
     # @param [Hash] params Method parameters
     # @return [Hash] JSON response
     def call(method, id, params)
+      invoke_before_validation_hook(method, id, params)
       if api_methods.include?(method)
         begin
           Types.valid_params?(self.class, method, params)
@@ -398,10 +399,19 @@ module JSONRPC2
       log_error("Server error hook failed - #{error.class}: #{error.message} #{error.backtrace.join("\n    ")}")
     end
 
+    def invoke_before_validation_hook(method, id, params)
+      before_validation(method: method, id: id, params: params)
+    rescue => error
+      log_error("Before validation hook failed - #{error.class}: #{error.message} #{error.backtrace.join("\n    ")}")
+    end
+
     # Available for reimplementation by a subclass, noop by default
     def on_server_error(request_id:, error:)
     end
 
+    def before_validation(method:, id:, params:)
+    end
+
     def log_error(message)
       logger.error("#{env['json.request-id']} #{message}") if logger.respond_to?(:error)
     end

data/lib/jsonrpc2/version.rb

@@ -1,5 +1,5 @@
 # JSONRPC2 namespace module
 module JSONRPC2
   # Version
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/lib/interface_spec.rb

@@ -118,6 +118,30 @@ RSpec.describe JSONRPC2::Interface do
           )
         end
       end
+
+      context 'with a correctly configured before_validation hook' do
+        before do
+          rpc_api_class.class_eval do
+            attr_reader :test_before_validation_data
+
+            def before_validation(method:, id:, params:)
+              @test_before_validation_data = {
+                method: method,
+                id: id,
+                params: params
+              }
+            end
+          end
+        end
+
+        it 'invokes the hook' do
+          dispatch_result
+
+          expect(instance.test_before_validation_data[:method]).to eq('hello')
+          expect(instance.test_before_validation_data[:id]).to eq(123)
+          expect(instance.test_before_validation_data[:params]).to eq({ 'name' => 'Geoff' })
+        end
+      end
     end
 
     context 'with an unhandled server error' do
@@ -131,6 +155,28 @@ RSpec.describe JSONRPC2::Interface do
         )
       end
 
+      context 'with a correctly configured error hook' do
+        before do
+          rpc_api_class.class_eval do
+            attr_reader :test_error_data
+
+            def on_server_error(request_id:, error:)
+              @test_error_data = {
+                request_id: request_id,
+                error: error
+              }
+            end
+          end
+        end
+
+        it 'invokes the hook' do
+          dispatch_result
+
+          expect(instance.test_error_data[:error].message).to eq('He-Must-Not-Be-Named')
+          expect(instance.test_error_data[:request_id]).to eq(nil) # Request_id is generated higher in the stack
+        end
+      end
+
       context 'with error hook raising an error' do
         let(:initialization_params) { super().merge('rack.logger' => rack_logger) }
         let(:rack_logger) { instance_double(::Logger, :rack_logger, info: nil, error: nil) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonrpc2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Geoff Youngs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-14 00:00:00.000000000 Z
+date: 2023-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient