ia-redis-rpc 2.0.0.pre.dev → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e100cf545ffbc90a79ab59ac0fc9386627b24d74ceb524ba0537357975fb3e38
-  data.tar.gz: 238d7c1299aa3cc24fb94cc783fa81a0f7dfd223f2612e2fa5c4ebbe30e8233c
+  metadata.gz: 6429f97b99f8b0a63a1db9ac8834efd273718d7ddd797a9558408caf8ec2e41c
+  data.tar.gz: 87ce089cfa6e86f6270a02742f6e613c741faabd189e0c517b644da9a44f2103
 SHA512:
-  metadata.gz: 3563aa1e79e727c406cce2971ec0a402277df1fd264d42e6aeabe0b49e212453911e08cec1abd59edf9736bc4592dc92bf12336f6788e56ecd3c771dd5fe3a40
-  data.tar.gz: 642146ffe8c4a043f9454a4f978e374656752bd99a15359fe33669cccb7e91d7b3fda4a9f2bdc8a301370bf68d120b0c0c759c459cf7f89276fe4bc473d85954
+  metadata.gz: 8cc6c900ac1299e205372a1876d8e3884a310310c6624f3ab6aacc22fc5c433ddc175b0dfd35522082fec4655adf4e5724a449209e9216c66d4f1890e5b02a44
+  data.tar.gz: e287474f5df739d7cb16c400097ccae92272df4842c55ed38fc501f577e3ba028d9a6e3c1c3d08482b53d514025479c2496f719f8d82a4ba42b24f8e50305a3d

data/examples/calc.rb

@@ -1,7 +1,7 @@
 class Calculator
     # A simple, mutable calculator used for testing.
     # referenced explicitly in ../spec/calculator.spec.rb
-    
+
     def initialize
         @acc = 0.0
     end
@@ -27,6 +27,11 @@ class Calculator
     end
 
     def val
-      @acc
+        @acc
+    end
+
+    def sleep(time)
+        # expose this method to test response timeouts
+        super
     end
 end

data/lib/redis-rpc/version.rb

@@ -1,3 +1,3 @@
 module RedisRpc
-  VERSION = "2.0.0-dev"
+  VERSION = "2.1.0"
 end

data/lib/redis-rpc.rb

@@ -69,7 +69,7 @@ module RedisRpc
         'timeout_at' => get_timeout_at,
       }
 
-      rpc_raw_request = JSON.dump rpc_request
+      rpc_raw_request = rpc_request.to_json
 
       # transport
       @redis_server.rpush @message_queue, rpc_raw_request
@@ -116,7 +116,12 @@ module RedisRpc
     def initialize(redis_server, message_queue, local_object, timeout: nil, response_expiry: 1, verbose: false, logger: nil)
       @redis_server = redis_server
       @message_queue = message_queue
-      @local_object = local_object
+      @local_object = local_object.tap do |o|
+        # Override #respond_to? so it only exposes methods which are directly defined by the receiver
+        def o.respond_to?(method_name)
+          self.public_methods(false).include?(method_name.to_sym)
+        end
+      end
       @timeout = timeout || 0
       @response_expiry = response_expiry
       @verbose = verbose
@@ -176,8 +181,13 @@ module RedisRpc
 
         logger&.info("[#{Time.now}] #{self.class.name} : action=run_one rpc_call=#{@local_object.class.name}##{function_call['name']}(#{function_call['args']})")
 
+        function_call_name = function_call['name'].to_sym
+        unless @local_object.public_methods(false).include?(function_call_name)
+          raise "Forbidden RPC call '#{function_call_name}'"
+        end
+
         function_call['kwargs'].transform_keys!(&:to_sym) if function_call['kwargs']&.kind_of?(Hash)
-        return_value = @local_object.send(function_call['name'].to_sym, *function_call['args'], **function_call['kwargs'])
+        return_value = @local_object.public_send(function_call_name, *function_call['args'], **function_call['kwargs'])
         rpc_response = { 'return_value' => return_value }
       rescue StandardError => err
         rpc_response = { 'exception' => err.to_s, 'backtrace' => err.backtrace }
@@ -192,7 +202,7 @@ module RedisRpc
       end
 
       # response transport
-      rpc_raw_response = JSON.dump rpc_response
+      rpc_raw_response = rpc_response.to_json
       @redis_server.multi do |pipeline|
         pipeline.rpush response_queue, rpc_raw_response
         pipeline.expire response_queue, @response_expiry

data/spec/calculator_spec.rb

@@ -48,6 +48,11 @@ describe Calculator do
       expect { calculator.a_missing_method }.to raise_error(RedisRpc::RemoteException)
     end
 
+    it 'should raise when method is not implemented by receiver' do
+      # noinspection RubyResolve
+      expect { calculator.send(:instance_eval, "puts :remote_exec") }.to raise_error(RedisRpc::RemoteException, "Forbidden RPC call 'instance_eval'")
+    end
+
     it 'should raise timeout when execution expires' do
       expect { calculator.send(:sleep, 3) }.to raise_error RedisRpc::TimeoutException
     end

data/spec/kwargs_spec.rb

@@ -11,6 +11,7 @@ describe KwargsEcho do
     let(:hall) { KwargsEcho.new }
 
     it 'should echo' do
+      expect(hall.public_methods(true).include?(:echo)).to eq(true)
       expect(hall.echo(1, kwarg1: :kw1)).to be == {args1: 1, kwarg1: :kw1, kwarg2: :kwarg2}
     end
   end
@@ -25,6 +26,18 @@ describe KwargsEcho do
     after(:each) { rpc_server_builder.call.stop! && @rpc_server.kill; rpc_server_builder.call.flush_queue! }
     let(:hall) { RedisRpc::Client.new($REDIS, 'hall', timeout: 2) }
 
+    it 'should respond_to?(:echo)' do
+      expect(hall.respond_to?(:echo)).to eq(true)
+    end
+
+    it 'should not respond_to?(:sleep)' do
+      expect(hall.respond_to?(:sleep)).to eq(false)
+    end
+
+    it 'should not respond_to?(:instance_eval)' do
+      expect(hall.respond_to?(:instance_eval)).to eq(false)
+    end
+
     it 'should echo' do
       expect(hall.echo(1, kwarg1: :kw1)).to be == { "args1" => 1, "kwarg1" => "kw1", "kwarg2" => "kwarg2" }
     end

data/spec/spec_helper.rb

@@ -9,6 +9,8 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 
+require_relative '../lib/redis-rpc'
+
 RSpec.configure do |config|
   config.before :suite do
     raise 'redis-server must be on your path to run this test' if `which redis-server`.empty?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ia-redis-rpc
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.dev
+  version: 2.1.0
 platform: ruby
 authors:
 - Phuong Nguyen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-27 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -144,9 +144,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.3
 signing_key: