gruf 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2452f173e2987612fde71b5e170874f52718e5a7f820658378c7a98e54f5b1f
-  data.tar.gz: bcbb20ab199f78fadd1926d1314fe881fccda9413f149ebb8ad1e4daeba259f8
+  metadata.gz: 65e740037fb8efc21bd1560364abb3c9de7ae69d8e443363b8965ab617344e99
+  data.tar.gz: 2acbd3d7618774210218dac40e033c8d279152793aa9336f7025eb9a2a6c7e30
 SHA512:
-  metadata.gz: d9ae08c458006784a089c1390000870febe48a01e8e6be85673e343639ec8283410c76fa6110981916f1333bc3e49c499d845cb03551cf1ea42cab8b5455c2c1
-  data.tar.gz: 26833397af9630db7a6c3d0429ddcaaf63d84e076e8d6691719b2210b8f7523b3a89169e2826ad2f66d67dd64e313a31f87da423d5f4580c4b7ac6fc26fc54d7
+  metadata.gz: 1b7130c6564fa22da55c76c28f602f1f56f90033a1df736539bc3c930e9edc3cb2ea5100644fa9ee2d918d6120cc7d6a683f0a81709431a06b7fc870f98eadd6
+  data.tar.gz: 8247fba2ac2be6f566d9c95bb76c321cc6920e289f082fb0f513c5a3bcfe033b7c5a01c762f1472f20b2c8c401d48187382b89f4cb4faf104c4a8dcf2cedd27d

data/CHANGELOG.md

@@ -2,6 +2,11 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### Pending release
 
+### 2.5.1
+
+- Ensure `timeout` is an int when passed as a client option to a gRPC client
+- Add `bound_service` reader to `Gruf::Controllers::Base` for finding the service bound to the given controller
+
 ### 2.5.0
 
 - Client exceptions raised now contain mapped subclasses, such as `Gruf::Client::Errors::InvalidArgument`

data/CODE_OF_CONDUCT.md

@@ -1,49 +1,46 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at splittingred@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at engineering@bigcommerce.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -450,7 +450,8 @@ very large values (such as binary or json data).
 ### Controllers
 
 In order to test your controller, you first need to mock a GRPC ActiveCall. You can create the following file under `/spec/support/` path of your project:
-```
+
+```ruby
 require 'grpc'
 
 module Rpc
@@ -471,25 +472,21 @@ end
 ```
 
 Imagine you have the following controller to test:
-```
+
+```ruby
 class ThingController < ::Gruf::Controllers::Base
   bind ::Rpc::ThingService::Service
 
   def get_thing
-    thing = Rpc::Thing.new(id: message_id, name: 'Foo')
+    thing = Rpc::Thing.new(id: request.message.id, name: 'Foo')
     Rpc::GetThingResponse.new(thing: thing)
   end
-
-  private
-
-  def message_id
-    request.message.id
-  end
 end
 ```
 
 You can stub it in the specs this way:
-```
+
+```ruby
 describe ThingController do
   let(:rpc_service) { ::Rpc::ThingService::Service }
   let(:rpc_desc) { Rpc::ThingService::Service.rpc_descs.values.first }
@@ -510,6 +507,7 @@ describe ThingController do
 
       it 'returns an instance of Rpc::GetThingResponse' do
         expect(result).to be_instance_of(Rpc::GetThingResponse)
+        expect(result.id).to eq request.id
       end
     end
   end
@@ -521,16 +519,17 @@ end
 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
 * [gruf-lightstep](https://github.com/bigcommerce/gruf-lightstep) - Provides a seamless
 [LightStep](https://lightstep.com) 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-zipkin](https://github.com/bigcommerce/gruf-zipkin) - Provides a [Zipkin](https://zipkin.io)
+integration
+* [gruf-newrelic](https://github.com/bigcommerce/gruf-newrelic) - Easy [New Relic](https://newrelic.com/) integration
 * [gruf-commander](https://github.com/bigcommerce/gruf-commander) - Request/command-style validation and
 execution patterns for services
+* [gruf-profiler](https://github.com/bigcommerce/gruf-profiler) - Profiles and provides memory usage
+reports for clients and services
+* [gruf-circuit-breaker](https://github.com/bigcommerce/gruf-circuit-breaker) - Circuit breaker
+support for services
 
 ## Demo Rails App
 

data/lib/gruf/client.rb

@@ -59,6 +59,7 @@ module Gruf
       @opts[:password] = options.fetch(:password, '').to_s
       @opts[:hostname] = options.fetch(:hostname, Gruf.default_client_host)
       @error_factory = Gruf::Client::ErrorFactory.new
+      client_options[:timeout] = client_options[:timeout].to_i if client_options.key?(:timeout)
       client = "#{service}::Stub".constantize.new(@opts[:hostname], build_ssl_credentials, client_options)
       super(client)
     end

data/lib/gruf/controllers/base.rb

@@ -29,6 +29,11 @@ module Gruf
       # @var [Gruf::Error] error
       attr_reader :error
 
+      class << self
+        # @var [GRPC::GenericService] bound_service
+        attr_reader :bound_service
+      end
+
       ##
       # Initialize the controller within the given request context
       #
@@ -56,8 +61,10 @@ module Gruf
       # @param [GRPC::GenericService] service The name of the service to bind this controller to
       #
       def self.bind(service)
-        Gruf.services << service.name.constantize
-        ServiceBinder.new(service).bind!(self)
+        service_class = service.name.constantize
+        Gruf.services << service_class
+        @bound_service = service_class
+        ServiceBinder.new(service_class).bind!(self)
       end
 
       ##

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.5.0'.freeze
+  VERSION = '2.5.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-14 00:00:00.000000000 Z
+date: 2018-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler