protobuf-rspec 0.0.1 → 0.0.2

data/README.md

@@ -41,7 +41,9 @@ end
 Mocking Service Responses
 -------------------------
 
-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. If you would like to test the object that is given as a request you should provide a :request object.
+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. 
+
+Asserting the request object can be done one of two ways: direct or explicit. If you would like to directly test the object that is given as a request you should provide a `:request` object as part of the `cb_mocks` hash (third parameter). Alternatively you can do an explicit assertion by providing a block to `mock_remote_service`. The block will be yielded with the request object as its only parameter. This allows you to perform your own assertions on the request object (e.g. only check a few of the fields in the request). Also note that if a `:request` param is given in the third param, the block will be ignored.
 
 ### Testing the client on_success callback
 ```ruby
@@ -87,7 +89,7 @@ it 'verifies the on_success method behaves correctly' do
 end
 ```
 
-### Testing the given client request object
+### Testing the given client request object (direct assert)
 ```ruby
 # Method under test
 def create_user
@@ -106,7 +108,29 @@ it 'verifies the request is built correctly' do
 end
 ```
 
+### Testing the given client request object (explicit assert)
+```ruby
+# Method under test
+def create_user
+  request = ... # some operation to build a request on state
+  Proto::UserService.client.create(request) do |c|
+    ...
+  end
+end
+...
+
+# spec
+it 'verifies the request is built correctly' do
+  mock_remote_service(Proto::UserService, :client) do |given_request|
+    given_request.field1.should eq 'rainbows'
+    given_request.field2.should eq 'ponies'
+  end
+  create_user(request)
+end
+````
+
 Feedback
+--------
 
 Feedback and comments are welcome:
 

data/lib/protobuf/rspec/helpers.rb

@@ -88,8 +88,14 @@ module Protobuf
 
       # 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. If you would like to test the object that is given as a request
-      # you should provide a :request object.
+      # callback you should provide an :error object. 
+      # 
+      # Asserting the request object can be done one of two ways: direct or explicit. If you would like to directly test
+      # the object that is given as a request you should provide a :request object as part of the cb_mocks third parameter hash. 
+      # Alternatively you can do an explicit assertion by providing a block to mock_remote_service. The block will be yielded with
+      # the request object as its only parameter. This allows you to perform your own assertions on the request object
+      # (e.g. only check a few of the fields in the request). Also note that if a :request param is given in the third param,
+      # the block will be ignored.
       #
       # @example Testing the client on_success callback
       #     # Method under test
@@ -131,7 +137,7 @@ module Protobuf
       #       create_user(request).should eq('error')
       #     end
       #
-      # @example Testing the given client request object
+      # @example Testing the given client request object (direct assert)
       #     # Method under test
       #     def create_user
       #       request = ... # some operation to build a request on state
@@ -148,16 +154,40 @@ module Protobuf
       #       create_user(request)
       #     end
       #     
+      # @example Testing the given client request object (explicit assert)
+      #     # Method under test
+      #     def create_user
+      #       request = ... # some operation to build a request on state
+      #       Proto::UserService.client.create(request) do |c|
+      #         ...
+      #       end
+      #     end
+      #     ...
+      #     
+      #     # spec
+      #     it 'verifies the request is built correctly' do
+      #       mock_remote_service(Proto::UserService, :client) do |given_request|
+      #         given_request.field1.should eq 'rainbows'
+      #         given_request.field2.should eq 'ponies'
+      #       end
+      #       create_user(request)
+      #     end
+      #     
       # @param [Class] klass the service class constant
       # @param [Symbol, String] method a symbol or string denoting the method to call
       # @param [Hash] cb_mocks provides expectation objects to invoke on_success (with :response), on_failure (with :error), and the request object (:request)
+      # @param [Block] assert_block when given, will be invoked with the request message sent to the client method
       # @return [Mock] the stubbed out client mock
-      def mock_remote_service(klass, method, cb_mocks={})
+      def mock_remote_service(klass, method, cb_mocks={}, &assert_block)
         cb_mocks = {:error => mock('error', :message => nil, :code => nil)}.merge(cb_mocks)
         klass.stub(:client).and_return(client = mock('Client'))
         client.stub(method).and_yield(client)
         if cb_mocks[:request]
           client.should_receive(method).with(cb_mocks[:request])
+        elsif block_given?
+          client.should_receive(method) do |given_req|
+            assert_block.call(given_req)
+          end
         else
           client.should_receive(method)
         end
@@ -173,6 +203,7 @@ module Protobuf
         else
           client.stub(:on_failure)
         end
+        
         client
       end
       alias :mock_service :mock_remote_service

data/lib/protobuf/rspec/version.rb

@@ -1,5 +1,5 @@
 module Protobuf
   module RSpec
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protobuf-rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protobuf
-  requirement: &2160846800 !ruby/object:Gem::Requirement
+  requirement: &2152859620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2160846800
+  version_requirements: *2152859620
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160845600 !ruby/object:Gem::Requirement
+  requirement: &2152858520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.8'
   type: :runtime
   prerelease: false
-  version_requirements: *2160845600
+  version_requirements: *2152858520
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2160844920 !ruby/object:Gem::Requirement
+  requirement: &2152857540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *2160844920
+  version_requirements: *2152857540
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &2160843920 !ruby/object:Gem::Requirement
+  requirement: &2152856760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: '2.1'
   type: :development
   prerelease: false
-  version_requirements: *2160843920
+  version_requirements: *2152856760
 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.