protobuf-rspec 0.0.4 → 0.1.0.rc1

data/lib/protobuf/rspec/helpers.rb

@@ -12,86 +12,63 @@ module Protobuf
   module RSpec
     module Helpers
 
-      ClientMock = Struct.new("ClientMock", :request, :response, :error)
-
       # 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.
-      # 
+      #
       # @example Test a local service method
       #     # Implementation
       #     module Proto
       #       class UserService < Protobuf::Rpc::Service
       #         def create
       #           user = User.create_from_proto(request)
-      #           self.response = ProtoRepresenter.new(user).to_proto
+      #           if request.name
+      #             respond_with(ProtoRepresenter.new(user))
+      #           else
+      #             rpc_failed 'Error: name required'
+      #           end
       #         end
       #       end
       #     end
-      # 
+      #
       #     # Spec
       #     describe Proto::UserService do
       #       describe '#create' do
       #         it 'creates a new user' do
       #           create_request = Proto::UserCreate.new(...)
-      #           client = call_local_service(Proto::UserService, :create, create_request)
-      #           client.response.should eq(some_response_object)
+      #           service = call_local_service(Proto::UserService, :create, create_request)
+      #           service.response.should eq(some_response_object)
+      #         end
+      #
+      #         it 'fails when name is not given' do
+      #           bad_req = { :name => nil }
+      #           service = call_local_service(Proto::UserService, :create, :create_request) do |service|
+      #             # Block is yielded before the method is invoked.
+      #             service.should_receive(:rpc_failed).with('Error: name required')
+      #           end
       #         end
       #       end
       #     end
       #
-      # @param [Class] klass the service class constant
-      # @param [Symbol, String] method a symbol or string denoting the method to call
-      # @param [Protobuf::Message] request the request message of the expected type for the given method
-      # @param [Fixnum] timeout force timeout on service call
-      # @return [ClientMock] an object which contains the request and potential response or error objects
-      def call_local_service(klass, method, request, timeout=5)
-        service = klass.new
-        response = service.rpcs[method].response_type.new
-        service.stub(:request).and_return(request)
-        service.stub(:response).and_return(response)
-        def service.response= res
-          @response = res
-          self.stub(:response).and_return(@response)
-        end
-        def service.rpc_failed message
-          @custom_error = message
-          send_response
-        end
-        def service.send_response
-          @send_response_called = true
-        end
-
-        client_mock = ClientMock.new
-        client_mock.request = request
-
-        begin
-          yield(service) if block_given?
-          service.__send__("rpc_#{method}")
-        rescue
-          client_mock.error = $!
-        else
-          client_mock.error = service.instance_variable_get(:@custom_error)
-        ensure
-          if client_mock.error.nil?
-            if service.instance_variable_get(:@async_responder)
-              Timeout.timeout(timeout) do
-                sleep 0.5 until service.instance_variable_get(:@send_response_called)
-              end
-            end
-            client_mock.response = service.instance_variable_get(:@response) || response
-          end
-        end
-
-        client_mock
+      # @param [Class] klass the service class constant.
+      # @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.
+      # @param [block] optionally provide a block which will be yielded the service instance just prior to invoking the rpc method.
+      # @return [Protobuf::Service] the service instance post-calling the rpc method.
+      def call_local_service(klass, method_name, request)
+        request = service.rpcs[method_name].request_type.new(request) if request.is_a?(Hash)
+        service = klass.new(method_name, request.serialize_to_string)
+        yield(service) if block_given?
+        service.method(method_name).call
+        service
       end
-      alias :call_service :call_local_service
+      alias_method :call_service, :call_local_service
 
       # 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. 
-      # 
+      # 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. 
+      # 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,
@@ -109,7 +86,7 @@ module Protobuf
       #       status
       #     end
       #     ...
-      #     
+      #
       #     # spec
       #     it 'verifies the on_success method behaves correctly' do
       #       mock_remote_service(Proto::UserService, :client, response: mock('response_mock', status: 'success'))
@@ -129,7 +106,7 @@ module Protobuf
       #       status
       #     end
       #     ...
-      #     
+      #
       #     # spec
       #     it 'verifies the on_success method behaves correctly' do
       #       mock_remote_service(Proto::UserService, :client, error: mock('error_mock', message: 'this is an error message'))
@@ -146,14 +123,14 @@ module Protobuf
       #       end
       #     end
       #     ...
-      #     
+      #
       #     # spec
       #     it 'verifies the request is built correctly' do
       #       expected_request = ... # some expectation
       #       mock_remote_service(Proto::UserService, :client, request: expected_request)
       #       create_user(request)
       #     end
-      #     
+      #
       # @example Testing the given client request object (explicit assert)
       #     # Method under test
       #     def create_user
@@ -163,7 +140,7 @@ module Protobuf
       #       end
       #     end
       #     ...
-      #     
+      #
       #     # spec
       #     it 'verifies the request is built correctly' do
       #       mock_remote_service(Proto::UserService, :client) do |given_request|
@@ -172,7 +149,7 @@ module Protobuf
       #       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)
@@ -202,25 +179,10 @@ module Protobuf
         else
           client.stub(:on_failure)
         end
-        
-        client
-      end
-      alias :mock_service :mock_remote_service
 
-      # Stubs out a protobuf message object internals so that we can just test the needed fields.
-      # It's debatable if this is actually helpful since the protobuf message is so lean in the first place.
-      # 
-      # @param [Class, String] klass the message class constant or the message name
-      # @param [Hash] stubs the stubbed fields and values
-      # @return [OpenStruct] the mocked message
-      def mock_proto(klass, stubs={})
-        proto_instance = OpenStruct.new({:mock_name => klass}.merge(stubs))
-        proto_instance.stub!(:has_field? => true)
-        proto = mock(klass)
-        proto.stub!(:tap).and_yield(proto_instance)
-        klass.stub!(:new).and_return(proto)
-        proto_instance
+        client
       end
+      alias_method :mock_service, :mock_remote_service
 
     end
   end

data/lib/protobuf/rspec/version.rb

@@ -1,5 +1,5 @@
 module Protobuf
   module RSpec
-    VERSION = "0.0.4"
+    VERSION = "0.1.0.rc1"
   end
 end

data/protobuf-rspec.gemspec

@@ -18,9 +18,10 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
   s.add_runtime_dependency "protobuf", ">= 1.1"
   s.add_runtime_dependency "rspec", "~> 2.8"
+
+  s.add_development_dependency "rake"
   s.add_development_dependency "yard", "~> 0.7"
   s.add_development_dependency "redcarpet", "~> 2.1"
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: protobuf-rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.1.0.rc1
+  prerelease: 6
 platform: ruby
 authors:
 - BJ Neilsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-01 00:00:00.000000000Z
+date: 2012-10-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protobuf
-  requirement: &2162490940 !ruby/object:Gem::Requirement
+  requirement: &2161458660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2162490940
+  version_requirements: *2161458660
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2162490320 !ruby/object:Gem::Requirement
+  requirement: &2161457900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,21 @@ dependencies:
         version: '2.8'
   type: :runtime
   prerelease: false
-  version_requirements: *2162490320
+  version_requirements: *2161457900
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2161457260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2161457260
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2162489740 !ruby/object:Gem::Requirement
+  requirement: &2161456720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +54,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *2162489740
+  version_requirements: *2161456720
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &2162489160 !ruby/object:Gem::Requirement
+  requirement: &2161456140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +65,7 @@ dependencies:
         version: '2.1'
   type: :development
   prerelease: false
-  version_requirements: *2162489160
+  version_requirements: *2161456140
 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.
@@ -84,12 +95,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1776446749920294311
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: protobuf-rspec
 rubygems_version: 1.8.15