protobuf 1.0.0 → 1.0.1

data/spec/helper/tolerance_matcher.rb

@@ -0,0 +1,40 @@
+#
+# courtesy of sander 6
+# - http://github.com/sander6/custom_matchers/blob/master/lib/matchers/tolerance_matchers.rb
+#
+module Sander6
+  module CustomMatchers
+
+    class ToleranceMatcher
+      def initialize(tolerance)
+        @tolerance = tolerance
+        @target = 0
+      end
+
+      def of(target)
+        @target = target
+        self
+      end
+
+      def matches?(value)
+        @value = value
+        ((@target - @tolerance)..(@target + @tolerance)).include?(@value)
+      end
+
+      def failure_message
+        "Expected #{@value.inspect} to be within #{@tolerance.inspect} of #{@target.inspect}, but it wasn't.\n" +
+          "Difference: #{@value - @target}"
+          end
+
+      def negative_failure_message
+        "Expected #{@value.inspect} not to be within #{@tolerance.inspect} of #{@target.inspect}, but it was.\n" +
+          "Difference: #{@value - @target}"
+          end
+    end
+
+    def be_within(value)
+      Sander6::CustomMatchers::ToleranceMatcher.new(value)
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -13,11 +13,9 @@ require 'protobuf'
 require 'protobuf/rpc/client'
 class ::Protobuf::Rpc::Client
   def == other
-   options == other.options && \
-   error == other.error && \
-   do_block == other.do_block && \
-   @success_callback == other.instance_variable_get(:@success_callback) && \
-   @failure_callback == other.instance_variable_get(:@failure_callback)
+   connector.options == other.options && \
+   success_cb == other.success_cb && \
+   failure_cb == other.failure_cb
   end
 end
 

data/spec/unit/rpc/client_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+require 'spec/proto/test_service_impl'
+require 'spec/helper/all'
+
+describe Protobuf::Rpc::Client do
+
+  context "when using fiber based calls" do
+    it "waits for response when running synchronously" do
+      EventMachine.fiber_run do
+        delay = 3
+        server = StubServer.new(delay)
+        stop_servers = lambda { server.stop; EventMachine.stop }
+        client = Spec::Proto::TestService.client(:async => false)
+
+        start = now
+        
+        client.find(:name => "Test Name", :active => true) do |c|
+          c.on_success do |succ|
+            succ.name.should eq("Test Name")
+            succ.status.should eq(Spec::Proto::StatusType::ENABLED) 
+          end
+
+          c.on_failure do |err|
+            raise err.inspect
+          end
+        end
+
+        (now - start).should be_within(delay * 0.10).of(delay)
+        stop_servers.call
+      end
+    end
+
+    it "doesn't wait for response when running async call inside fiber" do
+      EventMachine.fiber_run do
+        delay = 3
+        server = StubServer.new(delay)
+        stop_servers = lambda { server.stop; EventMachine.stop }
+        client = Spec::Proto::TestService.client(:async => true)
+
+        start = now
+        
+        client.find(:name => "Test Name", :active => true)
+
+        (now - start).should_not be_within(delay * 0.10).of(delay)
+        stop_servers.call
+      end
+    end
+
+    it "throws and error when synchronous code is attempted without 'EventMachine.fiber_run'" do
+      subject = Proc.new do
+        EventMachine.run do
+          delay = 1
+          server = StubServer.new(delay)
+          stop_servers = lambda { server.stop; EventMachine.stop }
+          client = Spec::Proto::TestService.client(:async => false)
+
+          client.find(:name => "Test Name", :active => true)
+          stop_servers.call
+        end
+      end
+
+      subject.should raise_error(RuntimeError, /EM.fiber_run/)
+    end
+
+    it "throws a timeout when client timeout is exceeded" do
+      subject = Proc.new do
+        EventMachine.fiber_run do
+          delay = 3
+          server = StubServer.new(delay)
+          stop_servers = lambda { server.stop; EventMachine.stop }
+          client = Spec::Proto::TestService.client(:async => false, :timeout => 1)
+
+          client.find(:name => "Test Name", :active => true)
+          stop_servers.call
+        end
+      end
+
+      subject.should raise_error(RuntimeError, /timeout/i)
+    end
+
+  end
+  
+  context 'when creating a client from a service' do
+    
+    it 'should be able to get a client through the Service#client helper method' do
+      Spec::Proto::TestService.client(:port => 9191).should eq(Protobuf::Rpc::Client.new(:service => Spec::Proto::TestService, :port => 9191))
+    end
+    
+    it "should be able to override a service location's host and port" do
+      Spec::Proto::TestService.located_at 'somewheregreat.com:12345'
+      clean_client = Spec::Proto::TestService.client
+      clean_client.options[:host].should eq('somewheregreat.com')
+      clean_client.options[:port].should eq(12345)
+      
+      updated_client = Spec::Proto::TestService.client(:host => 'amazing.com', :port => 54321)
+      updated_client.options[:host].should eq('amazing.com')
+      updated_client.options[:port].should eq(54321)
+    end
+    
+    it 'should be able to define the syncronicity of the client request' do
+      client = Spec::Proto::TestService.client(:async => false)
+      client.options[:async].should be_false
+      client.async?.should be_false
+      
+      client = Spec::Proto::TestService.client(:async => true)
+      client.options[:async].should be_true
+      client.async?.should be_true
+    end
+    
+    it 'should be able to define which service to create itself for' do
+      client = Protobuf::Rpc::Client.new :service => Spec::Proto::TestService
+      client.options[:service].should eq(Spec::Proto::TestService)
+    end
+    
+    it 'should have a hard default for host and port on a service that has not been configured' do
+      reset_service_location Spec::Proto::TestService
+      client = Spec::Proto::TestService.client
+      client.options[:host].should eq(Protobuf::Rpc::Service::DEFAULT_LOCATION[:host])
+      client.options[:port].should eq(Protobuf::Rpc::Service::DEFAULT_LOCATION[:port])
+    end
+
+  end
+  
+  context 'when calling methods on a service client' do
+    
+    # NOTE: we are assuming the service methods are accurately 
+    # defined inside spec/proto/test_service.rb,
+    # namely the :find method
+    
+    it 'should respond to defined service methods' do
+      client = Spec::Proto::TestService.client
+      client.should_receive(:send_request).and_return(nil)
+      expect { client.find(nil) }.should_not raise_error
+    end
+    
+    it 'raises a NameError when accessing a var that does not exist' do
+      pending
+    end
+    
+    it 'should be able to set and get local variables within client response blocks' do
+      outer_value = 'OUTER'
+      inner_value = 'INNER'
+      client = Spec::Proto::TestService.client(:async => true)
+      
+      EM.should_receive(:reactor_running?).and_return(true)
+      EM.stub!(:schedule) do
+        client.success_cb.call(inner_value)
+      end
+      
+      client.find(nil) do |c|
+        c.on_success do |response|
+          outer_value.should eq('OUTER')
+          outer_value = response
+        end
+      end
+      outer_value.should eq(inner_value)
+    end
+    
+  end
+  
+  context 'when receiving request objects' do
+    
+    it 'should be able to create the correct request object if passed a hash' do
+      client = Spec::Proto::TestService.client
+      client.should_receive(:send_request)
+      client.find({:name => 'Test Name', :active => false})
+      client.options[:request].should be_a Spec::Proto::ResourceFindRequest
+      client.options[:request].name.should eq('Test Name')
+      client.options[:request].active.should eq(false)
+    end
+    
+  end
+ 
+end

data/spec/unit/rpc/connector_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Protobuf::Rpc::Connector do
+  
+  describe '.connector_for_platform' do
+    
+    context 'when platform is java' do
+      let(:platform) { 'jruby' }
+      it 'returns a socket connector class reference' do
+        Protobuf::Rpc::Connector.connector_for_platform(platform).should eq Protobuf::Rpc::Connectors::Socket
+      end
+    end
+  
+    context 'when platform is mri' do
+      let(:platform) { 'mri' }
+      it 'returns an eventmachine connector class reference' do
+        Protobuf::Rpc::Connector.connector_for_platform(platform).should eq Protobuf::Rpc::Connectors::EventMachine
+      end
+    end
+  
+    context 'when platform is unknown' do
+      let(:platform) { 'some_bogus_engine' }
+      it 'returns an eventmachine connector class reference' do
+        Protobuf::Rpc::Connector.connector_for_platform(platform).should eq Protobuf::Rpc::Connectors::EventMachine
+      end
+    end
+  
+    context 'when platform is not given' do
+      it 'returns an eventmachine connector class reference' do
+        Protobuf::Rpc::Connector.connector_for_platform.should eq Protobuf::Rpc::Connectors::EventMachine
+      end
+    end
+  
+  end
+  
+end

data/spec/unit/rpc/connectors/base_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Protobuf::Rpc::Connectors::Base do
+  
+  let(:opts) do
+    { async: false, timeout: 60 }
+  end
+  
+  subject { Protobuf::Rpc::Connectors::Base.new(opts) }
+  
+  describe '.new' do
+    it 'assigns passed options and initializes success/failure callbacks' do
+      subject.options.should eq opts
+      subject.success_cb.should be_nil
+      subject.failure_cb.should be_nil
+    end
+  end
+  
+  describe '#success_cb' do
+    it 'allows setting the success callback and calling it' do
+      subject.success_cb.should be_nil
+      cb = proc {|res| raise res }
+      subject.success_cb = cb
+      subject.success_cb.should eq cb
+      expect { subject.success_cb.call('an error from cb') }.to raise_error 'an error from cb'
+    end
+  end
+  
+  describe '#failure_cb' do
+    it 'allows setting the failure callback and calling it' do
+      subject.failure_cb.should be_nil
+      cb = proc {|res| raise res }
+      subject.failure_cb = cb
+      subject.failure_cb.should eq cb
+      expect { subject.failure_cb.call('an error from cb') }.to raise_error 'an error from cb'
+    end
+  end
+  
+  describe '#async?' do
+    context 'when provided options[:async] is false' do
+      let(:opts) do
+        { async: false, timeout: 60 }
+      end
+  
+      subject { Protobuf::Rpc::Connectors::Base.new(opts) }
+    
+      it 'returns false' do
+        subject.async?.should be_false
+      end
+    end
+    
+    context 'when provided options[:async] is true' do
+      let(:opts) do
+        { async: true, timeout: 60 }
+      end
+  
+      subject { Protobuf::Rpc::Connectors::Base.new(opts) }
+    
+      it 'returns true' do
+        subject.async?.should be_true
+      end
+    end
+    
+    context 'when options doesn\'t denote async' do
+      let(:opts) do
+        { timeout: 60 }
+      end
+  
+      subject { Protobuf::Rpc::Connectors::Base.new(opts) }
+    
+      it 'returns false' do
+        subject.async?.should be_false
+      end
+    end
+  end
+  
+end

metadata

@@ -1,65 +1,68 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: protobuf
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.0.1
   prerelease: 
-  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - BJ Neilsen
+- Brandon Dewitt
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-06 00:00:00 -06:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: eventmachine
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2156121020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.12.10
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2156121020
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2156088060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2156088060
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156085040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.7.0
   type: :development
-  version_requirements: *id003
-description: |-
-  Ruby implementation for Protocol Buffers. Works with other protobuf rpc implementations (e.g. Java, Python, C++).
-  
-  This gem has diverged from https://github.com/macks/ruby-protobuf. All credit for serialization and rprotoc work most certainly goes to the original authors. All RPC implementation code (client/server/service) was written and is maintained by this author. Attempts to reconcile the original codebase with the current RPC implementation went unsuccessful.
-email: 
+  prerelease: false
+  version_requirements: *2156085040
+description: ! 'Ruby implementation for Protocol Buffers. Works with other protobuf
+  rpc implementations (e.g. Java, Python, C++).
+
+
+  This gem has diverged from https://github.com/macks/ruby-protobuf. All credit for
+  serialization and rprotoc work most certainly goes to the original authors. All
+  RPC implementation code (client/server/service) was written and is maintained by
+  this author. Attempts to reconcile the original codebase with the current RPC implementation
+  went unsuccessful.'
+email:
 - bj.neilsen@gmail.com
-executables: 
+- brandonsdewitt@gmail.com
+executables:
 - rpc_server
 - rprotoc
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
@@ -81,9 +84,6 @@ files:
 - lib/protobuf/compiler/proto.y
 - lib/protobuf/compiler/proto2.ebnf
 - lib/protobuf/compiler/proto_parser.rb
-- lib/protobuf/compiler/template/rpc_bin.erb
-- lib/protobuf/compiler/template/rpc_client.erb
-- lib/protobuf/compiler/template/rpc_service.erb
 - lib/protobuf/compiler/template/rpc_service_implementation.erb
 - lib/protobuf/compiler/visitors.rb
 - lib/protobuf/descriptor/descriptor.proto
@@ -93,6 +93,7 @@ files:
 - lib/protobuf/descriptor/enum_descriptor.rb
 - lib/protobuf/descriptor/field_descriptor.rb
 - lib/protobuf/descriptor/file_descriptor.rb
+- lib/protobuf/ext/eventmachine.rb
 - lib/protobuf/message/decoder.rb
 - lib/protobuf/message/encoder.rb
 - lib/protobuf/message/enum.rb
@@ -102,7 +103,11 @@ files:
 - lib/protobuf/message/protoable.rb
 - lib/protobuf/rpc/buffer.rb
 - lib/protobuf/rpc/client.rb
-- lib/protobuf/rpc/client_connection.rb
+- lib/protobuf/rpc/connector.rb
+- lib/protobuf/rpc/connectors/base.rb
+- lib/protobuf/rpc/connectors/em_client.rb
+- lib/protobuf/rpc/connectors/eventmachine.rb
+- lib/protobuf/rpc/connectors/socket.rb
 - lib/protobuf/rpc/error.rb
 - lib/protobuf/rpc/error/client_error.rb
 - lib/protobuf/rpc/error/server_error.rb
@@ -115,17 +120,24 @@ files:
 - protobuf.gemspec
 - script/mk_parser
 - spec/functional/embedded_service_spec.rb
+- spec/helper/all.rb
+- spec/helper/server.rb
+- spec/helper/tolerance_matcher.rb
 - spec/proto/test.pb.rb
 - spec/proto/test.proto
 - spec/proto/test_service.rb
 - spec/proto/test_service_impl.rb
 - spec/spec_helper.rb
-- spec/unit/client_spec.rb
 - spec/unit/common/logger_spec.rb
 - spec/unit/enum_spec.rb
 - spec/unit/message_spec.rb
-- spec/unit/server_spec.rb
-- spec/unit/service_spec.rb
+- spec/unit/rpc/client_spec.rb
+- spec/unit/rpc/connector_spec.rb
+- spec/unit/rpc/connectors/base_spec.rb
+- spec/unit/rpc/connectors/eventmachine/client_spec.rb
+- spec/unit/rpc/connectors/eventmachine_spec.rb
+- spec/unit/rpc/server_spec.rb
+- spec/unit/rpc/service_spec.rb
 - test/check_unbuild.rb
 - test/data/data.bin
 - test/data/data_source.py
@@ -172,47 +184,51 @@ files:
 - test/test_serialize.rb
 - test/test_standard_message.rb
 - test/test_types.rb
-has_rdoc: true
 homepage: https://github.com/localshred/protobuf
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Ruby implementation for Protocol Buffers. Works with other protobuf rpc implementations (e.g. Java, Python, C++).
-test_files: 
+summary: Ruby implementation for Protocol Buffers. Works with other protobuf rpc implementations
+  (e.g. Java, Python, C++).
+test_files:
 - spec/functional/embedded_service_spec.rb
+- spec/helper/all.rb
+- spec/helper/server.rb
+- spec/helper/tolerance_matcher.rb
 - spec/proto/test.pb.rb
 - spec/proto/test.proto
 - spec/proto/test_service.rb
 - spec/proto/test_service_impl.rb
 - spec/spec_helper.rb
-- spec/unit/client_spec.rb
 - spec/unit/common/logger_spec.rb
 - spec/unit/enum_spec.rb
 - spec/unit/message_spec.rb
-- spec/unit/server_spec.rb
-- spec/unit/service_spec.rb
+- spec/unit/rpc/client_spec.rb
+- spec/unit/rpc/connector_spec.rb
+- spec/unit/rpc/connectors/base_spec.rb
+- spec/unit/rpc/connectors/eventmachine/client_spec.rb
+- spec/unit/rpc/connectors/eventmachine_spec.rb
+- spec/unit/rpc/server_spec.rb
+- spec/unit/rpc/service_spec.rb
 - test/check_unbuild.rb
 - test/data/data.bin
 - test/data/data_source.py