Salut 0.3.0 → 0.3.1

data/lib/Salut/Browser.rb

@@ -77,6 +77,7 @@ module Salut
 
     # @group Finding services
 
+    # @todo find a way to use default arguments
     # @param [String] service_name
     # @param [String] domain_name
     def find_services service_type, in_domain:domain_name

data/lib/Salut/Service.rb

@@ -99,7 +99,7 @@ module Salut
     # exiting will also cause the service to stop being published.
     def stop_advertising
       @service.stop
-      @service     = nil
+      @service = nil
     end
 
     # @endgroup
@@ -110,6 +110,7 @@ module Salut
     # A more Ruby-like #resolveWithTimeout by supporting a default argument
     # @param [Float] timeout number of seconds to wait before timing out
     def resolve timeout = 60.0
+      @service.delegate = self
       @service.resolveWithTimeout timeout
     end
 
@@ -178,7 +179,7 @@ module Salut
     def netServiceDidStop sender
       @advertising = false
       @delegates[__method__].call sender if @delegates[__method__]
-      Salut.log.info "Stopped advertising service (#{sender.description})"
+      Salut.log.info "Stopped advertising/resolving service (#{sender.description})"
     end
 
     # @endgroup

data/spec/Service_spec.rb

@@ -49,259 +49,374 @@ describe Salut::Service do
 
 
   describe '#service' do
-    it 'is an NSNetService instance' do
+    before do
+      @service = Salut::Service.new({
+        port:3000,
+        instance_name:'Test',
+        service_type:'_http._tcp.'
+      })
+    end
+
+    it 'is an NSNetService instance when not nil' do
+      @service.start_advertising
+      @service.service.class.should.be.equal NSNetService
     end
 
     it 'can be set at initialization' do
+      new_service = NSNetService.alloc.initWithDomain '',
+                                                 type:'_http._tcp.',
+                                                 name:'TEST',
+                                                 port:4000
+      @service = Salut::Service.new({ service:new_service })
+      @service.service.should.be.equal new_service
     end
 
     it 'will be created when advertising starts' do
+      @service.service.should.be.equal nil
+      @service.start_advertising
+      @service.service.should.not.be.equal nil
     end
 
     it 'will be set to nil when advertising stops' do
+      @service.service.should.be.equal nil
+      @service.start_advertising
+      NSRunLoop.currentRunLoop.runUntilDate (Time.now + 5)
+      @service.stop_advertising
+      @service.service.should.be.equal nil
     end
   end
 
 
   describe '#initialize' do
     it 'will let you initialize the port number' do
+      Salut::Service.new({ port:4000 }).port.should.be.equal 4000
     end
 
     it 'will let you initialize the instance name' do
+      Salut::Service.new({ instance_name:'TEST' }).instance_name.should.be.equal 'TEST'
     end
 
     it 'will let you initialize the service type' do
+      Salut::Service.new({ service_type:'_http._tcp.' }).service_type.should.be.equal '_http._tcp.'
     end
 
     it 'will let you initialize with a service' do
+      new_service = NSNetService.alloc.initWithDomain '',
+                                                 type:'_http._tcp.',
+                                                 name:'TEST',
+                                                 port:4000
+      @service = Salut::Service.new({ service:new_service })
+      @service.service.should.be.equal new_service
     end
 
     it 'will initialize delegates to an empty hash' do
+      Salut::Service.new.delegates.should.be.equal Hash.new
     end
 
     it 'will initialize @advertising to false' do
+      Salut::Service.new.advertising?.should.be.equal false
     end
 
     it 'will let you initialize with nothing being set' do
+      @service = Salut::Service.new
+      @service.should.not.be.equal nil
     end
   end
 
 
   describe '#delegates' do
     it 'should be initialized to an empty hash' do
+      Salut::Service.new.delegates.should.be.equal Hash.new
     end
 
     it 'should be writable' do
+      @service = Salut::Service.new
+      @service.delegates[:test] = Proc.new { true }
+      @service.delegates[:test].should.not.be.equal nil
     end
   end
 
 
   describe '#[]' do
-    it 'should be equivalent to #delegates' do
+    it 'should be equivalent to #delegates[]' do
+      @service = Salut::Service.new
+      @service.delegates[:test] = 'HEY'
+      @service[:test].should.be.equal 'HEY'
     end
   end
 
 
   describe '#[]=' do
-    it 'should be equivalent to #delegates=' do
+    it 'should be equivalent to #delegates[]=' do
+      @service = Salut::Service.new
+      @service[:test] = 'HEY'
+      @service.delegates[:test].should.be.equal 'HEY'
     end
   end
 
 
   describe '#start_advertising' do
+    before do
+      @service = Salut::Service.new({
+        instance_name:'TEST',
+        service_type:'_test._tcp.',
+        port:9001
+      })
+    end
+
     it 'should create a new @service object' do
+      @service.service.should.be.equal nil
+      @service.start_advertising
+      @service.service.should.not.be.equal nil
     end
 
     it 'should set the delegate for @service to self' do
+      @service.delegates[:'netServiceWillPublish:'] = Proc.new { |sender|
+        @service.service.should.be.equal sender
+      }
+      @service.start_advertising
     end
 
     # a fragile test since it depends on one of the callbacks
     # being called
     it 'should call #publish on @service' do
+      @service.delegates[:'netServiceWillPublish:'] = Proc.new { |sender|
+        @service.service.should.be.equal sender
+      }
+      @service.start_advertising
     end
 
     it 'should set domain to an empty string by default' do
+      @service.start_advertising
+      @service.service.domain.should.be.equal ''
     end
 
     it 'should allow me to specify a domain' do
+      @service.start_advertising 'local.'
+      @service.service.domain.should.be.equal 'local.'
+    end
+
+    it 'should fail if service type, instance name, or port are not set' do
+      @service.service_type = nil
+      should.raise(NoMethodError) { @service.start_advertising }
     end
   end
 
 
   describe '#stop_advertising' do
+    before do
+      @service = Salut::Service.new({
+        instance_name:'TEST',
+        service_type:'_test._tcp.',
+        port:9001
+      })
+      @service.start_advertising
+      NSRunLoop.currentRunLoop.runUntilDate Time.now + 3
+    end
+
     # a fragile test since it depends on one of the callbacks
     # being called
     it 'should call #stop on @service' do
+      @service.delegates[:'netServiceDidStop:'] = Proc.new { |sender|
+        true.should.be.equal true
+      }
+      @service.stop_advertising
+      NSRunLoop.currentRunLoop.runUntilDate Time.now + 3
     end
 
     it 'should set @service to nil' do
+      @service.service.should.not.be.equal nil
+      @service.stop_advertising
+      NSRunLoop.currentRunLoop.runUntilDate Time.now + 3
+      @service.service.should.be.equal nil
     end
   end
 
 
   describe '#resolve' do
     before do
-      # need a browser to find stuff to resolve
+      @service = Salut::Service.new({
+        instance_name:'TEST',
+        service_type:'_test._tcp.',
+        port:9001
+      })
+      @service.start_advertising
+      @browser = Salut::Browser.new
+      NSRunLoop.currentRunLoop.runUntilDate Time.now + 2
     end
 
-    # a fragile test since it depends on one of the callbacks
-    # being called
+    # a fragile test since it depends on callbacks of callbacks being called
     it 'should cause the resolve callback to be called' do
-    end
-
-    it 'should timeout after 60 seconds' do
+      @browser.delegates[:'netServiceBrowser:didFindService:moreComing:'] = Proc.new {
+        |sender, service, more|
+        service.delegates[:'netServiceWillResolve:'] = Proc.new { |sender|
+          true.should.be.equal true
+        }
+        service.resolve
+      }
+      @browser.find_services '_test._tcp.', in_domain:''
+      NSRunLoop.currentRunLoop.runUntilDate (Time.now + 5)
     end
 
     it 'should allow me to override the timeout' do
+      @browser.delegates[:'netServiceBrowser:didFindService:moreComing:'] = Proc.new {
+        |sender, service, more|
+        service.delegates[:'netServiceWillResolve:'] = Proc.new { |sender|
+          true.should.be.equal true
+        }
+        service.resolve 2.0
+      }
+      @browser.find_services '_test._tcp.', in_domain:''
+      NSRunLoop.currentRunLoop.runUntilDate (Time.now + 5)
     end
   end
 
 
-  describe 'callback skeletons' do
+  # describe 'callback skeletons' do
 
-    before do
-      # set the logger to log INFO and log to a stringIO object
-    end
+  #   before do
+  #     # set the logger to log INFO and log to a stringIO object
+  #   end
 
 
-    describe '#netServiceWillPublish' do
-      it 'should call its proc if exists' do
-      end
+  #   describe '#netServiceWillPublish' do
+  #     it 'should call its proc if exists' do
+  #     end
 
-      it 'should not explode if the proc does not exist' do
-      end
+  #     it 'should not explode if the proc does not exist' do
+  #     end
 
-      it 'should log a message at the INFO level' do
-      end
+  #     it 'should log a message at the INFO level' do
+  #     end
 
-      it 'should pass self to the proc' do
-      end
-    end
+  #     it 'should pass self to the proc' do
+  #     end
+  #   end
 
 
-    describe '#netService:didNotPublish:' do
-      it 'should call its proc if exists' do
-      end
+  #   describe '#netService:didNotPublish:' do
+  #     it 'should call its proc if exists' do
+  #     end
 
-      it 'should not explode if the proc does not exist' do
-      end
+  #     it 'should not explode if the proc does not exist' do
+  #     end
 
-      it 'should log a message at the INFO level' do
-      end
+  #     it 'should log a message at the INFO level' do
+  #     end
 
-      it 'should set @advertising to false' do
-      end
+  #     it 'should set @advertising to false' do
+  #     end
 
-      it 'should pass self to the proc' do
-      end
+  #     it 'should pass self to the proc' do
+  #     end
 
-      it 'should pass the error dict to the proc' do
-      end
-    end
+  #     it 'should pass the error dict to the proc' do
+  #     end
+  #   end
 
 
-    describe '#netServiceDidPublish' do
-      it 'should call its proc if exists' do
-      end
+  #   describe '#netServiceDidPublish' do
+  #     it 'should call its proc if exists' do
+  #     end
 
-      it 'should not explode if the proc does not exist' do
-      end
+  #     it 'should not explode if the proc does not exist' do
+  #     end
 
-      it 'should log a message at the INFO level' do
-      end
+  #     it 'should log a message at the INFO level' do
+  #     end
 
-      it 'should set @advertising to true' do
-      end
+  #     it 'should set @advertising to true' do
+  #     end
 
-      it 'should pass self to the proc' do
-      end
-    end
+  #     it 'should pass self to the proc' do
+  #     end
+  #   end
 
 
-    describe '#netServiceWillResolve' do
-      it 'should call its proc if exists' do
-      end
+  #   describe '#netServiceWillResolve' do
+  #     it 'should call its proc if exists' do
+  #     end
 
-      it 'should not explode if the proc does not exist' do
-      end
+  #     it 'should not explode if the proc does not exist' do
+  #     end
 
-      it 'should log a message at the INFO level' do
-      end
+  #     it 'should log a message at the INFO level' do
+  #     end
 
-      it 'should pass self to the proc' do
-      end
-    end
+  #     it 'should pass self to the proc' do
+  #     end
+  #   end
 
 
-    describe '#netService:didNotResolve:' do
-      it 'should call its proc if exists' do
-      end
+  #   describe '#netService:didNotResolve:' do
+  #     it 'should call its proc if exists' do
+  #     end
 
-      it 'should not explode if the proc does not exist' do
-      end
+  #     it 'should not explode if the proc does not exist' do
+  #     end
 
-      it 'should log a message at the INFO level' do
-      end
+  #     it 'should log a message at the INFO level' do
+  #     end
 
-      it 'should pass self to the proc' do
-      end
+  #     it 'should pass self to the proc' do
+  #     end
 
-      it 'should pass the error dict to the proc' do
-      end
-    end
+  #     it 'should pass the error dict to the proc' do
+  #     end
+  #   end
 
 
-    describe '#netServiceDidResolveAddress' do
-      it 'should call its proc if exists' do
-      end
+  #   describe '#netServiceDidResolveAddress' do
+  #     it 'should call its proc if exists' do
+  #     end
 
-      it 'should not explode if the proc does not exist' do
-      end
+  #     it 'should not explode if the proc does not exist' do
+  #     end
 
-      it 'should log a message at the INFO level' do
-      end
+  #     it 'should log a message at the INFO level' do
+  #     end
 
-      it 'should pass self to the proc' do
-      end
-    end
+  #     it 'should pass self to the proc' do
+  #     end
+  #   end
 
 
-    describe '#netService:didUpdateTXTRecordData:' do
-      it 'should call its proc if exists' do
-      end
+  #   describe '#netService:didUpdateTXTRecordData:' do
+  #     it 'should call its proc if exists' do
+  #     end
 
-      it 'should not explode if the proc does not exist' do
-      end
+  #     it 'should not explode if the proc does not exist' do
+  #     end
 
-      it 'should log a message at the INFO level' do
-      end
+  #     it 'should log a message at the INFO level' do
+  #     end
 
-      it 'should pass self to the proc' do
-      end
+  #     it 'should pass self to the proc' do
+  #     end
 
-      it 'should pass the TXT record data to the proc' do
-      end
-    end
+  #     it 'should pass the TXT record data to the proc' do
+  #     end
+  #   end
 
 
-    describe '#netServiceDidStop' do
-      it 'should call its proc if exists' do
-      end
+  #   describe '#netServiceDidStop' do
+  #     it 'should call its proc if exists' do
+  #     end
 
-      it 'should not explode if the proc does not exist' do
-      end
+  #     it 'should not explode if the proc does not exist' do
+  #     end
 
-      it 'should log a message at the INFO level' do
-      end
+  #     it 'should log a message at the INFO level' do
+  #     end
 
-      it 'should set @advertising to false' do
-      end
+  #     it 'should set @advertising to false' do
+  #     end
 
-      it 'should pass self to the proc' do
-      end
-    end
+  #     it 'should pass self to the proc' do
+  #     end
+  #   end
 
-  end
+  # end
 
 
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Mark Rada
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-17 00:00:00 -05:00
+date: 2011-01-21 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency