proto_pharm 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 404f9289692becf1d216f4c8a3dbdb574394035f4fe80849565931b61ecba9ba
-  data.tar.gz: 6bb014799feda5517ed91d065a92c3feb5955c253779d5bf312fd6abc81f7882
+  metadata.gz: '085284c66deb0cdd0054f9b2663d9e1ef0c1a71384cc9af964f7ff02382d187d'
+  data.tar.gz: b86a47f713e24e281c28378f89a6efe06aa5b971787d3a1b842b32d7e2954cc7
 SHA512:
-  metadata.gz: 84fc28f8e009deb5dee062d15b8eff4091219bb3af1b9ad1d83dd90399c171e1c19b435eb271258fdfb449e60d7210ef4a57a6d61ab5a9d23c22282ef9df476e
-  data.tar.gz: ed36363f230916dfcab696c78f517b78256e7d3e954e02665485d7a0faf8aa0eb518be92daba1f30c58d4f85b92b5d1556cade1ac1e986e4441433f288d74cb0
+  metadata.gz: fbf7f332455eb884bfc2fe52c1bdf7488b7d64aff8f5f54b972aa09b21e340cc64e47a7e55fa27d7da37d94dfe3b6fcbea02f8c648f4ad02bd5a1f2d978c3253
+  data.tar.gz: 753a2290f4529efae044337f00431cce790f2b831256a323e92c157cd289a04d71f04a5d063d7b2f94fd0ae1883f93abca2899a61e799ec16456f1096d23c60c

data/.github/workflows/rspec.yml

@@ -27,7 +27,7 @@ jobs:
       env:
           BUNDLE_GEM__FURY__IO: ${{ secrets.GEMFURY_DEPLOY_TOKEN }}
       run: |
-        gem install bundler
+        gem install bundler -v "~> 2.1.0"
         bundle config path vendor/bundle
         bundle install --jobs 4 --retry 3
     - name: Run RSpec

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Changelog
 
-# 0.6.0
+## Upcoming
+
+## 0.7.0
+*Release Date: 2021-02-19*
+
+### Additions
+- Add configurable metadata serializer ([#6](https://github.com/Freshly/proto_pharm/pull/6))
+- Add metadata serializer for Gruf ([#7](https://github.com/Freshly/proto_pharm/pull/7))
+- Stub responses using a block ([#8](https://github.com/Freshly/proto_pharm/pull/8))
+- Net connect method cleanup ([#9](https://github.com/Freshly/proto_pharm/pull/9))
+
+## 0.6.0
 *Release Date: 2020-12-07*
 
 - Rename gem to `proto_pharm`

data/Gemfile

@@ -6,3 +6,5 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in proto_pharm.gemspec
 gemspec
+
+gem "grpc", platform: :ruby

data/Gemfile.lock

@@ -1,24 +1,32 @@
 PATH
   remote: .
   specs:
-    proto_pharm (0.6.0)
+    proto_pharm (0.7.0)
       activesupport (>= 5.2.0)
+      directive
       grpc (>= 1.12.0, < 2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
     activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
+    around_the_world (0.25.4)
+      activesupport (>= 5.2.1)
     ast (2.4.1)
     byebug (11.1.1)
     coderay (1.1.2)
     concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
+    directive (0.25.4)
+      activesupport (>= 5.2.1)
+      spicerack (= 0.25.4)
     faker (2.14.0)
       i18n (>= 1.6, < 2)
     google-protobuf (3.14.0)
@@ -28,6 +36,12 @@ GEM
       google-protobuf (~> 3.13)
       googleapis-common-protos-types (~> 1.0)
     grpc-tools (1.32.0)
+    gruf (2.8.1)
+      activesupport (> 4)
+      concurrent-ruby (> 1)
+      grpc (~> 1.10)
+      grpc-tools (~> 1.10)
+      slop (~> 4.6)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     method_source (0.9.2)
@@ -44,6 +58,11 @@ GEM
     rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
+    redis (4.2.5)
+    redis_hash (0.25.4)
+      activesupport (>= 5.2.1)
+      redis (>= 3.0)
+      tablesalt (= 0.25.4)
     regexp_parser (1.8.2)
     rexml (3.2.4)
     rspec (3.9.0)
@@ -83,11 +102,27 @@ GEM
     rubocop-rspec (1.43.2)
       rubocop (~> 0.87)
     ruby-progressbar (1.10.1)
+    short_circu_it (0.25.4)
+      activesupport (>= 5.2.1)
+      around_the_world (= 0.25.4)
+    slop (4.8.2)
+    spicerack (0.25.4)
+      around_the_world (= 0.25.4)
+      redis_hash (= 0.25.4)
+      short_circu_it (= 0.25.4)
+      tablesalt (= 0.25.4)
+      technologic (= 0.25.4)
     spicerack-styleguide (0.25.2)
       rubocop (~> 0.92.0)
       rubocop-performance (~> 1.8.0)
       rubocop-rails (~> 2.8.0)
       rubocop-rspec (~> 1.43.0)
+    tablesalt (0.25.4)
+      activemodel (>= 5.2.1)
+      activesupport (>= 5.2.1)
+    technologic (0.25.4)
+      activesupport (>= 5.2.1)
+      short_circu_it (= 0.25.4)
     thread_safe (0.3.6)
     tzinfo (1.2.8)
       thread_safe (~> 0.1)
@@ -100,7 +135,9 @@ PLATFORMS
 DEPENDENCIES
   bundler
   faker
+  grpc
   grpc-tools
+  gruf
   proto_pharm!
   pry-byebug
   rake (>= 12.3.3)

data/README.md

@@ -60,6 +60,16 @@ client.hello(Hello::HelloRequest.new(msg: 'Hello?')) # => Sent to network
 client.hello(Hello::HelloRequest.new(msg: 'Hola?')) # => <Hello::HelloResponse: msg: "Bienvenidos!">
 ```
 
+Or, stub the response with a block to perform some additional business logic:  
+_(Note - the `allow_grpc_service` syntax currently does not support block-stubbing)_
+```ruby
+stub_grpc_action(Hello::Hello::Service, :Hello).to_return do |request|
+  { msg: request.msg.reverse }
+end
+
+client.hello(Hello::HelloRequest.new(msg: 'Hello?')) # => <Hello::HelloResponse: msg: "?olleH">
+```
+
 Stub a failure response:
 ```ruby
 allow_grpc_service(Hello::Hello)
@@ -150,7 +160,16 @@ client.hello(Hello::HelloRequest.new(msg: 'hi'))    # => Hello::HelloResponse.ne
 
 ```
 
-### You can user either proto objects or hash for stubbing requests
+### Stubbing with a block
+```ruby
+ProtoPharm.stub_grpc_action(Hello::Hello::Service, :Hello).to_return do |request|
+  { msg: request.msg.reverse }
+end
+
+client.hello(Hello::HelloRequest.new(msg: 'Hello?')) # => <Hello::HelloResponse: msg: "?olleH">
+```
+
+### You can use either proto objects or hash for stubbing requests
 
 ```ruby
 ProtoPharm.stub_grpc_action(Hello::Hello::Service, :Hello).with(Hello::HelloRequest.new(msg: 'hi')).to_return(msg: 'test')

data/lib/proto_pharm.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require "active_support/core_ext/module"
+require "active_support/core_ext/object/blank"
+
+require "directive"
 require "grpc"
 
 require_relative "proto_pharm/version"
@@ -13,12 +16,20 @@ require_relative "proto_pharm/adapter"
 require_relative "proto_pharm/grpc_stub_adapter"
 require_relative "proto_pharm/grpc_stub_adapter/mock_stub"
 
+require_relative "proto_pharm/metadata_serializers/base"
+require_relative "proto_pharm/metadata_serializers/gruf"
+require_relative "proto_pharm/request_stub"
+require_relative "proto_pharm/action_stub"
+require_relative "proto_pharm/matchers/request_including_matcher"
 require_relative "proto_pharm/stub_registry"
 require_relative "proto_pharm/api"
 
 module ProtoPharm
   extend ProtoPharm::Api
 
+  include Directive::ConfigDelegation
+  delegates_to_configuration
+
   class << self
     delegate :enable!, :disable!, :enabled?, to: :adapter
 
@@ -33,10 +44,6 @@ module ProtoPharm
     def adapter
       @adapter ||= Adapter.new
     end
-
-    def config
-      @config ||= Configuration.new
-    end
   end
 
   # Hook into GRPC::ClientStub

data/lib/proto_pharm/action_stub.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/object/blank"
-
 module ProtoPharm
   class ActionStub < RequestStub
     include Introspection
@@ -26,7 +24,13 @@ module ProtoPharm
 
     # @param proto [Object] response proto object
     # @param request_kwargs [Hash] parameters to respond with
-    def to_return(proto = nil, **request_kwargs)
+    def to_return(proto = nil, **request_kwargs, &block)
+      if block_given?
+        raise ArgumentError, "Cannot stub with static response if stubbing with a block" if proto.present? || request_kwargs.present?
+
+        return super(&block)
+      end
+
       super(endpoint.normalize_response_proto(proto, **request_kwargs))
     end
 

data/lib/proto_pharm/api.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require "proto_pharm/request_stub"
-require "proto_pharm/action_stub"
-require "proto_pharm/matchers/request_including_matcher"
-
 module ProtoPharm
   module Api
     # @param path [String]
@@ -21,11 +17,15 @@ module ProtoPharm
     end
 
     def disable_net_connect!
-      ProtoPharm.config.allow_net_connect = false
+      GrpcStubAdapter::MockStub.disable_net_connect!
     end
 
     def allow_net_connect!
-      ProtoPharm.config.allow_net_connect = true
+      GrpcStubAdapter::MockStub.allow_net_connect!
+    end
+
+    def allow_net_connect?
+      GrpcStubAdapter::MockStub.allow_net_connect?
     end
   end
 end

data/lib/proto_pharm/configuration.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+require "directive"
+require_relative "metadata_serializers/base"
+require_relative "metadata_serializers/gruf"
+
 module ProtoPharm
-  class Configuration
-    attr_accessor :allow_net_connect
+  module Configuration
+    extend Directive
 
-    def initialize
-      @allow_net_connect = true
+    configuration_options do
+      option :metadata_serializer, default: MetadataSerializers::Base
     end
   end
 end

data/lib/proto_pharm/grpc_stub_adapter/mock_stub.rb

@@ -3,6 +3,20 @@
 module ProtoPharm
   class GrpcStubAdapter
     module MockStub
+      class << self
+        def disable_net_connect!
+          @allow_net_connect = false
+        end
+
+        def allow_net_connect!
+          @allow_net_connect = true
+        end
+
+        def allow_net_connect?
+          @allow_net_connect || false
+        end
+      end
+
       def request_response(method, request, *args, return_op: false, **opts)
         return super unless ProtoPharm.enabled?
 
@@ -11,11 +25,11 @@ module ProtoPharm
         if request_stub
           operation = OperationStub.new(metadata: opts[:metadata]) do
             request_stub.received!(request)
-            request_stub.response.evaluate
+            request_stub.response.evaluate(request)
           end
 
           return_op ? operation : operation.execute
-        elsif ProtoPharm.config.allow_net_connect
+        elsif _allow_net_connect?
           super
         else
           raise NetConnectNotAllowedError, method
@@ -32,7 +46,7 @@ module ProtoPharm
         if request_stub
           request_stub.received!(requests)
           request_stub.response.evaluate
-        elsif ProtoPharm.config.allow_net_connect
+        elsif _allow_net_connect?
           super
         else
           raise NetConnectNotAllowedError, method
@@ -47,7 +61,7 @@ module ProtoPharm
         if request_stub
           request_stub.received!(request)
           request_stub.response.evaluate
-        elsif ProtoPharm.config.allow_net_connect
+        elsif _allow_net_connect?
           super
         else
           raise NetConnectNotAllowedError, method
@@ -63,12 +77,18 @@ module ProtoPharm
         if request_stub
           request_stub.received!(requests)
           request_stub.response.evaluate
-        elsif ProtoPharm.config.allow_net_connect
+        elsif _allow_net_connect?
           super
         else
           raise NetConnectNotAllowedError, method
         end
       end
+
+      private
+
+      def _allow_net_connect?
+        MockStub.allow_net_connect?
+      end
     end
   end
 end

data/lib/proto_pharm/metadata_serializers/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ProtoPharm
+  module MetadataSerializers
+    module Base
+      class << self
+        def serialize(**metadata)
+          metadata.fetch(:metadata, {})
+        end
+      end
+    end
+  end
+end

data/lib/proto_pharm/metadata_serializers/freshly.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ProtoPharm
+  module MetadataSerializers
+    module Freshly
+      class << self
+        def serialize(code:, app_code: nil, **kwargs)
+          metadata = kwargs.fetch(:metadata, {})
+
+          {
+            metadata: metadata,
+          }.tap do |hash|
+            if ::Gruf.append_server_errors_to_trailing_metadata
+              enc_metadata = Labyrinth::GrufComponents::ErrorSerializer.encoded_metadata_hash(metadata)
+
+              e = ::Gruf::Error.new(code: code, app_code: app_code, metadata: enc_metadata)
+              hash[::Gruf.error_metadata_key.to_sym] = e.serialize
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/proto_pharm/metadata_serializers/gruf.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Serializes metadata for an application's Gruf configuration.
+#
+# Usage:
+#  Configuration.configure { |c| c.metadata_serializer = ProtoPharm::MetadataSerializers::Gruf }
+#
+#  allow_grpc_service(AService)
+#    .to receive_rpc(:your_endpoint)
+#    .and_fail_with(
+#      code: :invalid_argument,
+#      app_code: :cant_let_you_do_that_star_fox
+#      metadata: { some: :meta }
+#    )
+#
+# begin
+#   Service.your_endpoint
+# rescue Gruf::Client::Error::InvalidArgument => e
+#   e.error
+module ProtoPharm
+  module MetadataSerializers
+    module Gruf
+      class << self
+        def serialize(code:, app_code: nil, **metadata)
+          {
+            **metadata.fetch(:metadata, {}),
+          }.tap do |hash|
+            if ::Gruf.append_server_errors_to_trailing_metadata
+              e = ::Gruf::Error.new(code: code, app_code: app_code, **metadata)
+              hash[::Gruf.error_metadata_key.to_sym] = e.serialize
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/proto_pharm/request_stub.rb

@@ -23,9 +23,17 @@ module ProtoPharm
       self
     end
 
-    def to_return(*values)
-      responses = [*values].flatten.map { |v| Response::Value.new(v) }
+    def to_return(*values, &block)
+      if block_given?
+        raise ArgumentError, "Cannot stub with static response if stubbing with a block" if values.any?
+
+        responses = [ Response::Value.new(block) ]
+      else
+        responses = [*values].flatten.map { |v| Response::Value.new(v) }
+      end
+
       @response_sequence << ProtoPharm::ResponsesSequence.new(responses)
+
       self
     end
 

data/lib/proto_pharm/response.rb

@@ -18,18 +18,24 @@ module ProtoPharm
                      end
       end
 
-      def evaluate
+      def evaluate(_request = nil)
         raise @exception.dup
       end
     end
 
     class Value
+      attr_reader :value
+
       def initialize(value)
         @value = value
       end
 
-      def evaluate
-        @value.dup
+      def evaluate(request = nil)
+        if value.respond_to?(:call)
+          value.call(request)
+        else
+          value.dup
+        end
       end
     end
   end

data/lib/proto_pharm/stub_components/failure_response.rb

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/object/blank"
-
 module ProtoPharm
   module StubComponents
     module FailureResponse
       # @param code [String, Symbol] A gRPC failure code, such as not_found or invalid_argument. Default: :invalid_argument
       # @param message [String] A message to pass back with the exception
-      # @param metadata [Hash] A hash of metadata to be passed back with the exception
-      def to_fail_with(code = :invalid_argument, message = "unknown cause", metadata: {})
-        to_raise(exception_class(code).new(message, metadata))
+      # @param metadata [Hash] A hash of metadata to be passed back with the exception. See {ProtoPharm::MetadataSerializers::Base.serialize}.
+      def to_fail_with(code = :invalid_argument, message = "unknown cause", **metadata)
+        to_raise(exception_class(code).new(message, metadata_serializer.serialize(code: code, message: message, **metadata)))
       end
 
       def to_fail
@@ -18,6 +16,10 @@ module ProtoPharm
 
       private
 
+      def metadata_serializer
+        Configuration.config.metadata_serializer
+      end
+
       def exception_class(code)
         class_name = code.to_s.camelize
 

data/lib/proto_pharm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProtoPharm
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/proto_pharm.gemspec

@@ -24,10 +24,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", ">= 5.2.0"
+  spec.add_dependency "directive"
   spec.add_dependency "grpc", ">= 1.12.0", "< 2"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "faker"
+  spec.add_development_dependency "gruf"
   spec.add_development_dependency "grpc-tools"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", ">= 12.3.3"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: proto_pharm
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Yuta Iwama
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2021-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: directive
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: grpc
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +87,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gruf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: grpc-tools
   requirement: !ruby/object:Gem::Requirement
@@ -207,6 +235,9 @@ files:
 - lib/proto_pharm/introspection/service_resolver.rb
 - lib/proto_pharm/matchers/hash_argument_matcher.rb
 - lib/proto_pharm/matchers/request_including_matcher.rb
+- lib/proto_pharm/metadata_serializers/base.rb
+- lib/proto_pharm/metadata_serializers/freshly.rb
+- lib/proto_pharm/metadata_serializers/gruf.rb
 - lib/proto_pharm/operation_stub.rb
 - lib/proto_pharm/request_pattern.rb
 - lib/proto_pharm/request_stub.rb