protobuf-rspec 0.2.3 → 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75f4085dce2b39870d9c0e727802b1fa9b932092
+  data.tar.gz: c1e8fd5a05bbbb5247d1317c2d0c83cd18505ca2
+SHA512:
+  metadata.gz: 1ddfb37df0a592dd5d384abfea2b2e479233d8ba960d16ea30c01bd6ef4b1aebb8db0bd349fe43083747ee600353928355574b73628b0ee3325940f769d56929
+  data.tar.gz: 452459206a10534d3d048cadd194677e1933fac119a9beb397a740f48a2cd177a4354f8514e74644ecba64261ec0b57df35318ac8ddf0a03926d18814ea719c4

data/README.md

@@ -20,7 +20,7 @@ Unit-Testing Service Behavior
 
 ### `local_rpc`
 
-To unit test your service you should use the `local_rpc` helper method. `local_rpc` helps you call the service instance method of your choosing to ensure that the correct responses are generated with the given requests. This should be used to outside-in test a local RPC Service without testing the underlying socket implementation or needing actual client code to invoke the endpoint method under test.
+To unit test your service you should use the `local_rpc` helper method. `local_rpc` helps you call the service instance method of your choosing to ensure that the correct responses are generated with the given requests. This should be used to outside-in test a local RPC Service without testing the underlying socket implementation or needing actual client code to invoke the endpoint method under test. Any filters added to the service **will** be invoked.
 
 Given the service implementation below:
 
@@ -88,6 +88,34 @@ describe Services::UserService do
 end
 ```
 
+### `rpc`
+
+Make an RPC call (without testing the underlying socket implementation). Works the same as `local_rpc`, but invokes the entire RPC middleware stack (service filters are also run):
+
+```Ruby
+rpc(:create, user_request) # => UserService#create
+```
+
+### `rpc_env`
+
+Initialize a new RPC env object simulating what happens in the middleware stack.
+Useful for testing a service class directly without using `rpc` or `local_rpc`.
+
+```Ruby
+describe "#create" do
+  # Initialize request and response
+  # ...
+  let(:env) { rpc_env(:create, request) }
+
+  subject { described_class.new(env) }
+
+  it "creates a user" do
+    subject.create
+    subject.response.should eq response
+  end
+end
+```
+
 ### `subject_service`
 
 One thing to note is that `local_rpc` uses `described_class` as the class to invoke for the given method. If you need to instead test a different class than your `described_class`, simply pass a block to `subject_service` which returns the class you would like to use instead.

data/lib/protobuf/rspec/helpers.rb

@@ -1,4 +1,4 @@
-require 'protobuf/rpc/rpc.pb'
+require 'protobuf/rpc/server'
 
 # RSpec Helpers designed to give you mock abstraction of client or service layer.
 # Require as protobuf/rspec/helpers and include into your running RSpec configuration.
@@ -8,6 +8,7 @@ require 'protobuf/rpc/rpc.pb'
 #     RSpec.configure do |config|
 #       config.include Protobuf::Rspec::Helpers
 #     end
+#
 module Protobuf
   module RSpec
     module Helpers
@@ -34,7 +35,6 @@ module Protobuf
         #       its('response.records') { should have(3).items }
         #     end
         #
-        #
         def subject_service
           if block_given?
             @_subject_service = yield
@@ -51,8 +51,8 @@ module Protobuf
           self.class.subject_service
         end
 
-        # Call a local service to test responses and behavior based on the given request.
-        # Should use to outside-in test a local RPC Service without testing the underlying socket implementation.
+        # Call a local RPC service to test responses and behavior based on the
+        # given request (without testing the underlying socket implementation).
         #
         # @example Test a local service method
         #     # Implementation
@@ -118,22 +118,80 @@ module Protobuf
         # @param [Symbol, String] method a symbol or string denoting the method to call.
         # @param [Protobuf::Message or Hash] request the request message of the expected type for the given method.
         # @return [Protobuf::Message or String] the resulting protobuf message or error string
+        #
         def local_rpc(rpc_method, request)
-          request_klass = request_class(rpc_method)
-          request = request_klass.new(request) if request.is_a?(Hash)
+          env = rpc_env(rpc_method, request)
+          service = subject_service.new(env)
 
-          outer_request_params = { :service_name => subject_service.to_s,
-                                   :method_name => rpc_method.to_s,
-                                   :request_proto => request.serialize_to_string }
+          yield(service) if block_given?
 
-          outer_request = ::Protobuf::Socketrpc::Request.new(outer_request_params)
-          dispatcher = ::Protobuf::Rpc::ServiceDispatcher.new(outer_request)
+          # Dispatch the RPC method invoking all of the filters
+          service.callable_rpc_method(rpc_method).call
+          service.response
+        end
 
-          yield(dispatcher.service) if block_given?
+        # Make an RPC call invoking the entire middleware stack (without testing
+        # the underlying socket implementation). Works the same as `local_rpc`, but
+        # invokes the entire RPC middleware stack.
+        #
+        # @example Test an RPC method
+        #
+        #     it "returns a user" do
+        #       response = rpc(:find, request)
+        #       response.should eq user
+        #     end
+        #
+        # @param [Symbol, String] method a symbol or string denoting the method to call.
+        # @param [Protobuf::Message or Hash] request the request message of the expected type for the given method.
+        # @return [Protobuf::Message or Protobuf::Rpc::PbError] the resulting Protobuf message or RPC error.
+        #
+        def rpc(rpc_method, request)
+          request_wrapper = wrapped_request(rpc_method, request)
 
-          dispatcher.invoke!
+          env = ::Protobuf::Rpc::Env.new('encoded_request' => request_wrapper.encode)
+          env = ::Protobuf::Rpc.middleware.call(env)
+
+          env.response
         end
 
+        # Initialize a new RPC env object simulating what happens in the middleware stack.
+        # Useful for testing a service class directly without using `rpc` or `local_rpc`.
+        #
+        # @example Test an RPC method on the service directly
+        #
+        #     describe "#create" do
+        #       # Initialize request and response
+        #       # ...
+        #       let(:env) { rpc_env(:create, request) }
+        #
+        #       subject { described_class.new(env) }
+        #
+        #       it "creates a user" do
+        #         subject.create
+        #         subject.response.should eq response
+        #       end
+        #     end
+        #
+        # @param [Symbol, String] method a symbol or string denoting the method to call.
+        # @param [Protobuf::Message or Hash] request the request message of the expected type for the given method.
+        # @return [Protobuf::Rpc::Env] the environment derived from an RPC request.
+        #
+        def rpc_env(rpc_method, request)
+          request = request_class(rpc_method).new(request) if request.is_a?(Hash)
+
+          ::Protobuf::Rpc::Env.new(
+            'caller'          => 'protobuf-rspec',
+            'service_name'    => subject_service.to_s,
+            'method_name'     => rpc_method.to_s,
+            'request'         => request,
+            'request_type'    => request_class(rpc_method),
+            'response_type'   => response_class(rpc_method),
+            'rpc_method'      => subject_service.rpcs[rpc_method],
+            'rpc_service'     => subject_service
+          )
+        end
+        alias_method :env_for_request, :rpc_env
+
         # Create a mock service that responds in the way you are expecting to aid in testing client -> service calls.
         # In order to test your success callback you should provide a :response object. Similarly, to test your failure
         # callback you should provide an :error object.
@@ -228,6 +286,7 @@ module Protobuf
         # @param [Hash] callbacks provides expectation objects to invoke on_success (with :response), on_failure (with :error), and the request object (:request)
         # @param [Block] optional. When given, will be invoked with the request message sent to the client method
         # @return [Mock] the stubbed out client mock
+        #
         def mock_rpc(klass, method, callbacks = {})
           client = double('Client', :on_success => true, :on_failure => true)
           client.stub(method).and_yield(client)
@@ -275,6 +334,24 @@ module Protobuf
         def response_class(endpoint)
           subject_service.rpcs[endpoint].response_type
         end
+
+        # Returns the request wrapper that is encoded and sent over the wire when calling
+        # an RPC method with the given request
+        #
+        # @param [Symbol, String] method a symbol or string denoting the method to call.
+        # @param [Protobuf::Message or Hash] request the request message of the expected type for the given method.
+        # @return [Protobuf::Socketrpc::Request] the wrapper used to transmit RPC requests.
+        #
+        def wrapped_request(rpc_method, request)
+          request = request_class(rpc_method).new(request) if request.is_a?(Hash)
+
+          ::Protobuf::Socketrpc::Request.new(
+            :service_name => subject_service.to_s,
+            :method_name => rpc_method.to_s,
+            :request_proto => request.encode,
+            :caller => 'protobuf-rspec'
+          )
+        end
       end
     end
   end

data/lib/protobuf/rspec/version.rb

@@ -1,5 +1,5 @@
 module Protobuf
   module RSpec
-    VERSION = "0.2.3"
+    VERSION = "1.0.0.rc1"
   end
 end

data/protobuf-rspec.gemspec

@@ -5,8 +5,8 @@ require "protobuf/rspec/version"
 Gem::Specification.new do |s|
   s.name        = "protobuf-rspec"
   s.version     = Protobuf::RSpec::VERSION
-  s.authors     = ["BJ Neilsen"]
-  s.email       = ["bj.neilsen@gmail.com"]
+  s.authors     = ["BJ Neilsen", "Adam Hutchison"]
+  s.email       = ["bj.neilsen@gmail.com", "liveh2o@gmail.com"]
   s.homepage    = "http://github.com/localshred/protobuf-rspec"
   s.summary     = %q{Protobuf RSpec helpers for testing services and clients. Meant to be used with the protobuf gem. Decouple external services/clients from each other using the given helper methods.}
   s.description = s.summary
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "protobuf", ">= 2.0"
+  s.add_runtime_dependency "protobuf", ">= 3.0.0.rc1"
   s.add_runtime_dependency "rspec", "~> 2.8"
 
   s.add_development_dependency "rake"

metadata

@@ -1,76 +1,92 @@
 --- !ruby/object:Gem::Specification
 name: protobuf-rspec
 version: !ruby/object:Gem::Version
-  version: 0.2.3
-  prerelease: 
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - BJ Neilsen
+- Adam Hutchison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000Z
+date: 2014-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protobuf
-  requirement: &2152903460 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 3.0.0.rc1
   type: :runtime
   prerelease: false
-  version_requirements: *2152903460
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152902320 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.8'
   type: :runtime
   prerelease: false
-  version_requirements: *2152902320
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152900400 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152900400
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2152899620 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *2152899620
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &2152898740 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.1'
   type: :development
   prerelease: false
-  version_requirements: *2152898740
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: Protobuf RSpec helpers for testing services and clients. Meant to be
   used with the protobuf gem. Decouple external services/clients from each other using
   the given helper methods.
 email:
 - bj.neilsen@gmail.com
+- liveh2o@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -85,33 +101,26 @@ files:
 - protobuf-rspec.gemspec
 homepage: http://github.com/localshred/protobuf-rspec
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -623885674851921765
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -623885674851921765
+      version: 1.3.1
 requirements: []
 rubyforge_project: protobuf-rspec
-rubygems_version: 1.8.15
+rubygems_version: 2.1.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Protobuf RSpec helpers for testing services and clients. Meant to be used
   with the protobuf gem. Decouple external services/clients from each other using
   the given helper methods.