Merge pull request #18 from bigcommerce/call-opts

Add the ability for call options to the client, which enables deadline setting

Author: splittingred

CHANGELOG.md

@@ -1,5 +1,9 @@
 Changelog for the gruf gem. This includes internal history before the gem was made.
 
+h3. 1.1.0
+
+- Add the ability for call options to the client, which enables deadline setting 
+
 h3. 1.0.0
 
 - Bump gRPC to 1.4 

lib/gruf/client.rb

@@ -47,14 +47,14 @@ def initialize(service:, options: {})
     ##
     # Call the client's method with given params
     #
-    def call(request_method, params = {}, metadata = {})
+    def call(request_method, params = {}, metadata = {}, opts = {})
       req = request_object(request_method, params)
       md = build_metadata(metadata)
       call_sig = call_signature(request_method)
 
       raise NotImplementedError, "The method #{request_method} has not been implemented in this service." unless call_sig
 
-      execute(call_sig, req, md)
+      execute(call_sig, req, md, opts)
     rescue GRPC::BadStatus => e
       emk = Gruf.error_metadata_key.to_s
       raise Gruf::Client::Error, error_deserializer_class.new(e.metadata[emk]).deserialize if e.respond_to?(:metadata) && e.metadata.key?(emk)
@@ -68,9 +68,11 @@ def call(request_method, params = {}, metadata = {})
     # @param [Object] req
     # @param [Hash] md
     #
-    def execute(call_sig, req, md)
+    def execute(call_sig, req, md, opts)
       timed = Timer.time do
-        send(call_sig, req, return_op: true, metadata: md)
+        opts[:return_op] = true
+        opts[:metadata] = md
+        send(call_sig, req, opts)
       end
       Gruf::Response.new(timed.result, timed.time)
     end

lib/gruf/version.rb

@@ -15,5 +15,5 @@
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 module Gruf
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

spec/gruf/client_spec.rb

@@ -46,8 +46,9 @@
   describe '.call' do
     let(:metadata) { { foo: 'bar' } }
     let(:params) { { id: 1 } }
+    let(:opts) { {} }
     let(:op) { build_operation(metadata: metadata) }
-    subject { client.call(method_name, params, metadata) }
+    subject { client.call(method_name, params, metadata, opts) }
 
     context 'if the call is successful' do
       let(:req) { Rpc::GetThingRequest.new(params) }
@@ -57,6 +58,16 @@
         expect(client).to receive(:get_thing).with(req, return_op: true, metadata: metadata).and_return(op)
         expect(subject).to be_truthy
       end
+
+      context 'with a deadline' do
+        let(:deadline) { Time.now + 42 }
+        let(:opts) { { deadline: deadline } }
+
+        it 'should pass the deadline into the call' do
+          expect(client).to receive(:get_thing).with(req, return_op: true, metadata: metadata, deadline: deadline).and_return(op)
+          expect(subject).to be_truthy
+        end
+      end
     end
 
     context 'if a GRPC::BadStatus is raised' do