protobuf 1.0.0

data/spec/unit/common/logger_spec.rb

@@ -0,0 +1,121 @@
+require 'protobuf/common/logger'
+require 'stringio'
+
+describe Protobuf::Logger do
+  
+  subject { Protobuf::Logger }
+  
+  before(:each) do
+    Protobuf::Logger.reset_device!
+    Protobuf::Logger.file = '/dev/null'
+    Protobuf::Logger.level = ::Logger::INFO
+  end
+  
+  describe '.instance' do
+    
+    it 'doesn\'t create a logger if the file was not set' do
+      subject.file = nil
+      subject.instance.should be_nil
+    end
+    
+    it 'doesn\'t create a logger if the level was not set' do
+      subject.level = nil
+      subject.instance.should be_nil
+    end
+    
+    it 'gets a new instance of the logger when file and level are set' do
+      subject.file.should_not be_nil
+      subject.level.should_not be_nil
+      subject.instance.should_not be_nil
+    end
+    
+    it 'keeps the same object from multiple calls to instance' do
+      subject.instance === subject.instance
+    end
+    
+  end
+  
+  describe '.configure' do
+    before(:each) { subject.reset_device! }
+    it 'sets the file and level in one call' do
+      subject.file.should_not be
+      subject.level.should_not be
+      subject.instance.should_not be
+      subject.configure :file => 'myfile.log', :level => ::Logger::WARN
+      subject.file.should == 'myfile.log'
+      subject.level.should == ::Logger::WARN
+      subject.instance.level.should == ::Logger::WARN
+    end
+    
+  end
+  
+  describe '.reset_device!' do
+    
+    it 'resets the logger instance, file, and level' do
+      subject.instance.should be
+      subject.file.should be
+      subject.level.should be
+      subject.reset_device!
+      subject.instance.should_not be
+      subject.file.should_not be
+      subject.level.should_not be
+    end
+    
+  end
+  
+  context 'when logging' do
+    
+    it 'doesn\'t raise errors when log instance is nil' do
+      subject.reset_device!
+      subject.instance.should be_nil
+      expect {
+        subject.debug 'No errors here'
+        subject.info 'No errors here'
+        subject.warn 'No errors here'
+        subject.error 'No errors here'
+        subject.fatal 'No errors here'
+        subject.add 'No errors here'
+        subject.log 'No errors here'
+      }.should_not raise_error
+    end
+    
+    it 'logs correctly when instance is valid' do
+      subject.instance.should_not be_nil
+      subject.instance.should_receive(:info).with('Should log great')
+      subject.info 'Should log great'
+    end
+    
+  end
+  
+  describe Protobuf::Logger::LogMethods do
+    
+    context 'when included in another class' do
+      
+      before(:all) do
+        class MyTestClass
+          include Protobuf::Logger::LogMethods
+        end
+      end
+      
+      subject { MyTestClass.new }
+      
+      it 'responds to all logger methods' do
+        subject.should respond_to :log_debug
+        subject.should respond_to :log_info
+        subject.should respond_to :log_warn
+        subject.should respond_to :log_error
+        subject.should respond_to :log_fatal
+        subject.should respond_to :log_add
+        subject.should respond_to :log_log
+      end
+      
+      it 'passes all embedded log calls to Logger instance' do
+        Protobuf::Logger.instance.should_receive(:debug).with('log this')
+        subject.log_debug('log this')
+      end
+      
+    end
+    
+  end
+  
+end

data/spec/unit/enum_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'spec/proto/test.pb'
+
+describe Protobuf::Enum do
+  context 'when coercing from enum' do
+    subject { Spec::Proto::StatusType::PENDING }
+    it { should == 0 }
+  end
+  context 'when coercing from integer' do
+    subject { 0 }
+    it { should == Spec::Proto::StatusType::PENDING }
+  end
+end

data/spec/unit/message_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'spec/proto/test.pb'
+
+describe Protobuf::Message do
+  
+  context 'when converting to json' do
+    
+    it "should be jsonable" do
+      msg = Spec::Proto::ResourceFindRequest.new
+      msg.should respond_to(:to_json)
+      msg.name = 'Jeff'
+      msg.active = false
+      msg.to_json.should == '{"name":"Jeff","active":false}'
+    end
+    
+    it 'should generate nested messages into nested json objects' do
+      date_created = Time.now.to_i
+      
+      nested = Spec::Proto::Nested.new
+      nested.name = 'NESTED'
+      nested.resource = Spec::Proto::Resource.new.tap do |r|
+        r.name = 'RESOURCE SINGLE'
+        r.date_created = date_created
+        r.status = Spec::Proto::StatusType::PENDING
+      end
+      2.times do |i|
+        nested.multiple_resources << Spec::Proto::Resource.new.tap do |r|
+          r.name = 'RESOURCE MULTIPLE %d' % i
+          r.date_created = date_created
+          r.status = Spec::Proto::StatusType::PENDING
+        end
+      end
+      nested.status = Spec::Proto::StatusType::ENABLED
+      
+      nested.to_json.should == %Q{{"name":"NESTED","resource":{"name":"RESOURCE SINGLE","date_created":#{date_created},"status":0,"repeated_enum":[]},"multiple_resources":[{"name":"RESOURCE MULTIPLE 0","date_created":#{date_created},"status":0,"repeated_enum":[]},{"name":"RESOURCE MULTIPLE 1","date_created":#{date_created},"status":0,"repeated_enum":[]}],"status":1}}
+    end
+    
+    
+  end
+  
+  context 'when converting to a hash' do
+    
+    context 'when message has repeated enum field' do
+      
+      it 'provides an array of integers' do
+        resource = Spec::Proto::Resource.new :repeated_enum => [
+          Spec::Proto::StatusType::PENDING,
+          Spec::Proto::StatusType::ENABLED,
+          Spec::Proto::StatusType::ENABLED,
+          Spec::Proto::StatusType::DISABLED,
+          Spec::Proto::StatusType::DELETED
+        ]
+        
+        resource.to_hash[:repeated_enum].should == [
+          Spec::Proto::StatusType::PENDING.value,
+          Spec::Proto::StatusType::ENABLED.value,
+          Spec::Proto::StatusType::ENABLED.value,
+          Spec::Proto::StatusType::DISABLED.value,
+          Spec::Proto::StatusType::DELETED.value
+        ]
+      end
+      
+    end
+    
+  end
+  
+end

data/spec/unit/server_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'protobuf/rpc/server'
+require 'spec/proto/test_service_impl'
+
+describe Protobuf::Rpc::Server do
+  context 'when sending response objects' do
+    it 'should be able to send a hash object as a response' do
+      server = Protobuf::Rpc::Server.new
+      
+      # Setup the right mocks
+      server.instance_variable_set(:@klass, Spec::Proto::TestService)
+      response_wrapper = mock('response')
+      response_wrapper.stub(:response_proto=)
+      server.instance_variable_set(:@response, response_wrapper)
+      Spec::Proto::TestService.stub_chain(:rpcs, :[], :[], :response_type).and_return(Spec::Proto::ResourceFindRequest)
+      
+      # Setup expectations
+      hash_response = {:name => 'Test Name', :active => false}
+      expected = Spec::Proto::ResourceFindRequest.new(hash_response)
+      Spec::Proto::ResourceFindRequest.should_receive(:new).with(hash_response).and_return(expected)
+      server.should_not_receive(:handle_error)
+      
+      # Call the method
+      server.send(:parse_response_from_service, hash_response)
+    end
+  end
+end

data/spec/unit/service_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'spec/proto/test_service_impl'
+
+describe Protobuf::Rpc::Service do
+  
+  context 'when configuring' do
+    before :each do
+      reset_service_location Spec::Proto::TestService
+    end
+  
+    it 'should have a default location configured' do
+      Spec::Proto::TestService.host.should == Protobuf::Rpc::Service::DEFAULT_LOCATION[:host]
+      Spec::Proto::TestService.port.should == Protobuf::Rpc::Service::DEFAULT_LOCATION[:port]
+    end
+  
+    it "should be able to pre-configure a service location for clients" do
+      Spec::Proto::TestService.located_at 'google.com:12345'
+      client = Spec::Proto::TestService.client
+      client.options[:host].should == 'google.com'
+      client.options[:port].should == 12345
+    end
+  
+    it 'should be able to configure and read the host' do
+      Spec::Proto::TestService.configure :host => 'somehost.com'
+      Spec::Proto::TestService.host.should == 'somehost.com'
+    end
+  
+    it 'should be able to configure and read the port' do
+      Spec::Proto::TestService.configure :port => 12345
+      Spec::Proto::TestService.port.should == 12345
+    end
+  
+    it 'should skip configuring location if the location passed does not match host:port syntax' do
+      invalid_locations = [nil, 'myhost:', ':9939', 'badhost123']
+      invalid_locations.each do |location|
+        Spec::Proto::TestService.located_at location
+        Spec::Proto::TestService.host.should == Protobuf::Rpc::Service::DEFAULT_LOCATION[:host]
+        Spec::Proto::TestService.port.should == Protobuf::Rpc::Service::DEFAULT_LOCATION[:port]
+      end
+    end
+  end
+  
+  context 'when server calls the service method' do
+    
+    before(:all) do
+      class ::NewTestService < Protobuf::Rpc::Service
+        rpc :bad_method, Spec::Proto::ResourceFindRequest, Spec::Proto::Resource
+        rpc :bad_var, Spec::Proto::ResourceFindRequest, Spec::Proto::Resource
+        def bad_method
+          hash = {}
+          hash[:one].explode
+        end
+        def bad_var
+          invalidvar
+        end
+      end
+    end
+    
+    it 'raises an undefined method name error when calling a method on a non-existant object' do
+      expect {
+        req = mock('RequestWrapper', :request_proto => Spec::Proto::ResourceFindRequest.new.to_s)
+        ::NewTestService.new.bad_method(req)
+      }.to raise_error(NoMethodError)
+    end
+    
+    it 'raises a name error when accessing a non-existant object' do
+      expect {
+        req = mock('RequestWrapper', :request_proto => Spec::Proto::ResourceFindRequest.new.to_s)
+        ::NewTestService.new.bad_var(req)
+      }.to raise_error(NameError)
+    end
+    
+  end
+  
+end

data/test/check_unbuild.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+$:.push "#{File.dirname(__FILE__)}/../lib"
+
+require 'test/unit'
+require 'protobuf/descriptor/descriptor_builder' 
+require 'protobuf/descriptor/descriptor_proto'
+
+class DescriptorTest < Test::Unit::TestCase
+  def test_unbuild
+    tutorial_proto = Google::Protobuf::FileDescriptorProto.new
+    tutorial_proto.parse_from_file 'person.bin'
+    Protobuf::Descriptor::DescriptorBuilder.build tutorial_proto
+
+    assert_nothing_raised {Tutorial::Person}
+    assert_nothing_raised {Tutorial::Person.new}
+    assert_equal(['age', 'email', 'id', 'name', 'phone'], 
+      Tutorial::Person.fields.map{|tag, field| field.name}.sort)
+
+    assert_nothing_raised {Tutorial::Person::PhoneNumber}
+    assert_nothing_raised {Tutorial::Person::PhoneNumber.new}
+    assert_equal(['number', 'type'], 
+      Tutorial::Person::PhoneNumber.fields.map{|tag, field| field.name}.sort)
+
+    assert_nothing_raised {Tutorial::Person::PhoneType}
+    assert_equal(0, Tutorial::Person::PhoneType::MOBILE)
+    assert_equal(1, Tutorial::Person::PhoneType::HOME)
+    assert_equal(2, Tutorial::Person::PhoneType::WORK)
+  end
+end

data/test/data/data.bin

@@ -0,0 +1,3 @@
+
+John Doe�	jdoe@example.com"
+555-4321

data/test/data/data_source.py

@@ -0,0 +1,14 @@
+import addressbook_pb2
+import sys
+
+person = addressbook_pb2.Person()
+person.id = 1234
+person.name = "John Doe"
+person.email = "jdoe@example.com"
+phone = person.phone.add()
+phone.number = "555-4321"
+phone.type = addressbook_pb2.Person.HOME
+
+f = open('data.bin', 'wb')
+f.write(person.SerializeToString())
+f.close()

data/test/data/types_source.py

@@ -0,0 +1,22 @@
+import types_pb2
+import sys
+
+types = types_pb2.TestTypes()
+types.type1 = 0.01
+types.type2 = 0.1
+types.type3 = 1
+types.type4 = 10
+types.type5 = 100
+types.type6 = 1000
+types.type7 = -1
+types.type8 = -10
+types.type9 = 10000
+types.type10 = 100000
+types.type11 = False
+types.type12 = 'hello all types'
+# TODO test type13
+#types.type13 = 
+
+f = open('types.bin', 'wb')
+f.write(types.SerializeToString())
+f.close()

data/test/proto/addressbook.pb.rb

@@ -0,0 +1,66 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: test/proto/addressbook.proto>
+# package tutorial;
+# 
+# message Person {
+#   required string name = 1;
+#   required int32 id = 2;
+#   optional string email = 3;
+# 
+#   enum PhoneType {
+#     MOBILE = 0;
+#     HOME = 1;
+#     WORK = 2;
+#   }
+# 
+#   message PhoneNumber {
+#     required string number = 1;
+#     optional PhoneType type = 2 [default = HOME];
+#   }
+# 
+#   repeated PhoneNumber phone = 4;
+#   optional uint32 age = 5 [default = 20];
+# 
+#   extensions 100 to 200;
+# }
+# 
+# /*
+# extend Person {
+#   optional int32 age = 100;
+# }
+# */
+# 
+# message AddressBook {
+#   repeated Person person = 1;
+# }
+
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/extend'
+
+module Tutorial
+  class Person < ::Protobuf::Message
+    defined_in __FILE__
+    required :string, :name, 1
+    required :int32, :id, 2
+    optional :string, :email, 3
+    class PhoneType < ::Protobuf::Enum
+      defined_in __FILE__
+      define :MOBILE, 0
+      define :HOME, 1
+      define :WORK, 2
+    end
+    class PhoneNumber < ::Protobuf::Message
+      defined_in __FILE__
+      required :string, :number, 1
+      optional :PhoneType, :type, 2, :default => :HOME
+    end
+    repeated :PhoneNumber, :phone, 4
+    optional :uint32, :age, 5, :default => 20
+    extensions 100..200
+  end
+  class AddressBook < ::Protobuf::Message
+    defined_in __FILE__
+    repeated :Person, :person, 1
+  end
+end