gruf 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c2a05e3aed4e246d1e0de691d1b9ee25fe33efd
-  data.tar.gz: a829923c5dd79579525e2034e6b3dabc995f1b20
+  metadata.gz: 53a6a934e512aeba4261172db33d22e9994ede7f
+  data.tar.gz: 5fb09d8483bd0ff4d22f759ab9ae442b3f4e63cb
 SHA512:
-  metadata.gz: ada2953033d6ca5850c35f5f63a59e86489d1c55bd909e72c73d155c7348f32bffc3168531bcc00f548c06f3f75ea480616b5a20370fb3f3708c12d3f5cb5b9e
-  data.tar.gz: 317a912622dc017fc6568bb66aeace92a620175f2cb6e99047f320777b4b9b7f805ef1ce39039650d6b0074a105b0da460c354b5a22f33a6c9eb2cf97bb13e02
+  metadata.gz: 6f8ff602e9d5a53eface3706b55546dd83f964cae57a20d1dc41d74aa6770a6f06d67a3a1aa0c040f3091b03cc3a132bca6d83ed3eb5351ee0520b7c480d6c0f
+  data.tar.gz: a44dd99112b76fa2f5116a6418cc80a90c5c7ff8a1ad8a4c45e03bcd384172ced2221d60daf7614c2a022f107b2fdd19e0d786c84dfb4ea9c3a4b1f090f3fbc5

data/CHANGELOG.md

@@ -2,6 +2,10 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### Pending release
 
+### 2.1.1
+
+- Add ability to pass in client stub options into Gruf::Client 
+
 ### 2.1.0
 
 - Add ability to list, clear, insert before, insert after, and remove to a server's interceptor

data/README.md

@@ -8,17 +8,17 @@ provide a more streamlined integration into Ruby and Ruby on Rails applications.
 It provides an abstracted server and client for gRPC services, along with other tools to help get gRPC services in Ruby
 up fast and efficiently at scale. Some of its features include:
 
-* Abstracted controllers with request context support 
-* Full interceptors with timing and unified request context support 
+* Abstracted controllers with request context support
+* Full interceptors with timing and unified request context support
 * Robust client error handling and metadata transport abilities
 * Server authentication via interceptors, with basic auth with multiple key support built in
 * TLS support for client-server auth, though we recommend using [linkerd](https://linkerd.io/) instead
-* Error data serialization in output metadata to allow fine-grained error handling in the transport while 
+* Error data serialization in output metadata to allow fine-grained error handling in the transport while
   still preserving gRPC BadStatus codes
 * Server and client execution timings in responses
 
 gruf currently has active support for gRPC 1.4.x-1.8.x. gruf is compatible and tested with Ruby 2.2,
-2.3, and 2.4. gruf is also not [Rails](https://github.com/rails/rails)-specific, and can be used in any 
+2.3, and 2.4. gruf is also not [Rails](https://github.com/rails/rails)-specific, and can be used in any
 Ruby framework (such as [Grape](https://github.com/ruby-grape/grape), for instance).
 
 ## Installation
@@ -33,11 +33,27 @@ Then in an initializer or before use:
 require 'gruf'
 ```
 
-Make sure to review [UPGRADING.md](https://github.com/bigcommerce/gruf/blob/master/UPGRADING.md) 
+Make sure to review [UPGRADING.md](https://github.com/bigcommerce/gruf/blob/master/UPGRADING.md)
 if you are upgrading gruf between minor or major versions.
 
 ### Client
 
+Add an initializer:
+
+```ruby
+require 'gruf'
+
+Gruf.configure do |c|
+  c.default_client_host = 'grpc.service.com:9003'
+end
+```
+
+If you don't explicitly set `default_client_host`, you will need to pass it into the client options, like so:
+
+```ruby
+client = ::Gruf::Client.new(service: ::Demo::ThingService, options: {hostname: 'grpc.service.com:9003'})
+```
+
 From there, you can instantiate a client given a stub service (say on an SslCertificates proto with a GetSslCertificate call):
 
 ```ruby
@@ -68,10 +84,10 @@ Gruf.configure do |c|
 end
 ```
 
-Next, setup some handlers based on your proto configurations in `/app/rpc/`. For example, for the Thing service, with a 
+Next, setup some handlers based on your proto configurations in `/app/rpc/`. For example, for the Thing service, with a
 GetThingReq/GetThingResp call based on this proto:
 
-```
+```proto
 syntax = "proto3";
 
 package demo;
@@ -96,13 +112,13 @@ You'd have this handler in `/app/rpc/demo/job_controller.rb`
 module Demo
   class JobController < ::Gruf::Controllers::Base
     bind ::Demo::Jobs::Service
-  
+
     ##
     # @return [Demo::GetJobResp] The job response
     #
     def get_job
       thing = Job.find(request.message.id)
-      
+
       Demo::GetJobResp.new(id: thing.id)
     rescue
       fail!(:not_found, :job_not_found, "Failed to find Job with ID: #{request.message.id}")
@@ -113,23 +129,27 @@ end
 
 Finally, you can start the server by running:
 
-    bundle exec gruf
+```bash
+bundle exec gruf
+```
 
 ### Basic Authentication
 
-Gruf comes packaged in with a Basic Authentication interceptor. It takes in an array of supported 
+Gruf comes packaged in with a Basic Authentication interceptor. It takes in an array of supported
 username and password pairs (or password-only credentials).
 
+In Server:
+
 ```ruby
 Gruf.configure do |c|
   c.interceptors.use(
     Gruf::Interceptors::Authentication::Basic,
     credentials: [{
       username: 'my-username-here',
-      password: 'my-password-here',    
+      password: 'my-password-here',
     },{
       username: 'another-username',
-      password: 'another-password',    
+      password: 'another-password',
     },{
       password: 'a-password-only'
     }]
@@ -137,7 +157,28 @@ Gruf.configure do |c|
 end
 ```
 
-Supporting an array of credentials allow for unique credentials per service, or for easy credential 
+In Client:
+
+```ruby
+require 'gruf'
+
+id = args[:id].to_i.presence || 1
+
+options = {
+  username: ENV.fetch('DEMO_THING_SERVICE_USERNAME'),
+  password: ENV.fetch('DEMO_THING_SERVICE_PASSWORD')
+}
+
+begin
+  client = ::Gruf::Client.new(service: ::Demo::ThingService, options: options)
+  response = client.call(:GetMyThing, id: id)
+  puts response.message.inspect
+rescue Gruf::Client::Error => e
+  puts e.error.inspect
+end
+```
+
+Supporting an array of credentials allow for unique credentials per service, or for easy credential
 rotation with zero downtime.
 
 ### SSL Configuration
@@ -152,7 +193,7 @@ For the client, you'll need to point to the public certificate:
   service: Demo::ThingService,
   ssl_certificate: 'x509 public certificate here',
   # OR
-  ssl_certificate_file: '/path/to/my.crt' 
+  ssl_certificate_file: '/path/to/my.crt'
 )
 ```
 
@@ -169,10 +210,10 @@ end
 ## Server Interceptors
 
 gruf supports interceptors around the grpc server calls, allowing you to perform actions around your service
-method calls. This can be used to add tracing data, connection resets in the grpc thread pool, further 
+method calls. This can be used to add tracing data, connection resets in the grpc thread pool, further
 instrumentation, and other things.
 
-Adding a hook is as simple as creating a class that extends `Gruf::Interceptor::ServerInterceptor`, 
+Adding a hook is as simple as creating a class that extends `Gruf::Interceptor::ServerInterceptor`,
 and a `call` method that yields control to get the method result:
 
 ```ruby
@@ -197,7 +238,7 @@ class MyFailingInterceptor < ::Gruf::Interceptors::ServerInterceptor
     unless result.dont_hijack
       # we'll assume this "dont_hijack" attribute exists on the message for this example
       fail!(:internal, :hijacked, 'Hijack all the things!')
-    end 
+    end
     result
   end
 end
@@ -222,10 +263,10 @@ Gruf.configure do |c|
 end
 ```
 
-Interceptors each wrap the call and are run recursively within each other. This means that if you have 
-three interceptors - `Interceptor1`, `Interceptor2`, and `Interceptor3` - they will run in FIFO 
-(first in, first out) order. `Interceptor1` will run, yielding to `Interceptor2`, 
-which will then yield to `Interceptor3`, which will then yield to your service method call, 
+Interceptors each wrap the call and are run recursively within each other. This means that if you have
+three interceptors - `Interceptor1`, `Interceptor2`, and `Interceptor3` - they will run in FIFO
+(first in, first out) order. `Interceptor1` will run, yielding to `Interceptor2`,
+which will then yield to `Interceptor3`, which will then yield to your service method call,
 ending the chain.
 
 You can utilize the `insert_before` and `insert_after` methods to maintain order:
@@ -245,12 +286,12 @@ parameter.
 
 ## Instrumentation
 
-gruf comes out of the box with a couple of instrumentation interceptors packed in: 
-output metadata timings and StatsD support. 
+gruf comes out of the box with a couple of instrumentation interceptors packed in:
+output metadata timings and StatsD support.
 
 ### Output Metadata Timing
 
-Enabled by default, this will push timings for _successful responses_ through the response output 
+Enabled by default, this will push timings for _successful responses_ through the response output
 metadata back to the client.
 
 ### StatsD
@@ -271,7 +312,7 @@ This will measure counts and timings for each endpoint.
 
 ### Request Logging
 
-Gruf 1.2+ comes built with request logging out of the box; you'll get Rails-style logs with your 
+Gruf 1.2+ comes built with request logging out of the box; you'll get Rails-style logs with your
 gRPC calls:
 
 ```
@@ -282,7 +323,7 @@ I, [2017-07-14T09:51:03.299050 #70595]  INFO -- : {"message":"[GRPC::Ok] (thing_
  ```
 
 It supports formatters (including custom ones) that you can use to specify the formatting of the logging:
- 
+
 ```ruby
 Gruf.configure do |c|
   c.interceptors.use(
@@ -301,26 +342,28 @@ It comes with a few more options as well:
 | blacklist | An array of parameter key names to redact from logging, in path.to.key format | `[]` |
 | redacted_string | The string to use for redacted parameters. | `REDACTED` |
 
-It's important to maintain a safe blacklist should you decide to log parameters; gruf does no 
-parameter sanitization on its own. We also recommend blacklisting parameters that may contain 
+It's important to maintain a safe blacklist should you decide to log parameters; gruf does no
+parameter sanitization on its own. We also recommend blacklisting parameters that may contain
 very large values (such as binary or json data).
 
 ## Plugins
 
 You can build your own hooks and middleware for gruf; here's a list of known open source gems for
 gruf that you can use today:
- 
+
 * [gruf-zipkin](https://github.com/bigcommerce/gruf-zipkin) - Provides a [Zipkin](https://zipkin.io)
-integration for gruf
-* [gruf-circuit-breaker](https://github.com/bigcommerce/gruf-circuit-breaker) - Provides circuit breaker
-support for gruf services
-* [gruf-profiler](https://github.com/bigcommerce/gruf-profiler) - Profiles and provides memory usage 
-reports for gruf services
+integration
+* [gruf-circuit-breaker](https://github.com/bigcommerce/gruf-circuit-breaker) - Circuit breaker
+support for services
+* [gruf-profiler](https://github.com/bigcommerce/gruf-profiler) - Profiles and provides memory usage
+reports for clients and services
+* [gruf-commander](https://github.com/bigcommerce/gruf-commander) - Request/command-style validation and
+execution patterns for services
 
 ## Demo Rails App
 
-There is a [demonstration Rails application here](https://github.com/bigcommerce/gruf-demo) you can 
-view and clone that shows how to integrate Gruf into an existing Rails application. 
+There is a [demonstration Rails application here](https://github.com/bigcommerce/gruf-demo) you can
+view and clone that shows how to integrate Gruf into an existing Rails application.
 
 ## Roadmap
 
@@ -341,17 +384,17 @@ Using gruf and want to show your support? Let us know and we'll add your name he
 
 ## License
 
-Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved 
+Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
-documentation files (the "Software"), to deal in the Software without restriction, including without limitation the 
-rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit 
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
 persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the 
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE 
-WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/gruf/client.rb

@@ -66,14 +66,15 @@ module Gruf
     # @param [Hash] options A hash of options for the client
     # @option options [String] :password The password for basic authentication for the service.
     # @option options [String] :hostname The hostname of the service. Defaults to linkerd.
+    # @param [Hash] client_options A hash of options to pass to the gRPC client stub
     #
-    def initialize(service:, options: {})
+    def initialize(service:, options: {}, client_options: {})
       @base_klass = service
       @service_klass = "#{base_klass}::Service".constantize
       @opts = options || {}
       @opts[:password] = options.fetch(:password, '').to_s
       @opts[:hostname] = options.fetch(:hostname, Gruf.default_client_host)
-      client = "#{service}::Stub".constantize.new(@opts[:hostname], build_ssl_credentials)
+      client = "#{service}::Stub".constantize.new(@opts[:hostname], build_ssl_credentials, client_options)
       super(client)
     end
 
@@ -88,6 +89,7 @@ module Gruf
     # @return [Gruf::Response] The response from the server
     # @raise [Gruf::Client::Error|GRPC::BadStatus] If an error occurs, an exception will be raised according to the
     # error type that was returned
+    #
     def call(request_method, params = {}, metadata = {}, opts = {}, &block)
       request_method = request_method.to_sym
       req = streaming_request?(request_method) ? params : request_object(request_method, params)
@@ -108,6 +110,15 @@ module Gruf
       raise
     end
 
+    ##
+    # Returns the currently set timeout on the client stub
+    #
+    # @return [Integer|NilClass]
+    #
+    def timeout
+      __getobj__.instance_variable_get(:@timeout)
+    end
+
     private
 
     ##

data/lib/gruf/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: gRPC Ruby Framework