RingyDingy 1.4 → 1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1054fdc0bd640813aee2cea5b6b2509e37dba286
-  data.tar.gz: 213d83aeee80b18b00cf43da678d87af8fb86872
+  metadata.gz: 49a70aaeac4ce0f4d9e3bddb018da38372ca5d0d
+  data.tar.gz: 373f70d3c2e3bb548fdf5cfd81e32f77e40aeb32
 SHA512:
-  metadata.gz: 0ac41a4cbcf2c46ad0ff168e3edb6329bb58bf02a16c3ec35a8e4df21d51ee9939485b46d39aaeb17d195119a68a208c48a64ec07f8cc7bcb1a4ea22ea864d9f
-  data.tar.gz: 646b70ea57a8976574b2972d88f83e6c18d1497bc0efb75109257f35d86f00b6157bf087f86e0e7b2cee9abab5da1494aca21392e38fd0adc31b3c0ca88f7b29
+  metadata.gz: 50ce6ae837b4dcde616b9c9d8dcf5376c01527a2a6300c9e6a7b2fa6b58e5787b4bbdf1aaa492fa5eec92d4f8562804b3af098dc7c8ff42d1470df7f323571a8
+  data.tar.gz: eaec7dfff951f1b88bcfa18445a5427394d130a3e7a12e314004426cf1c28090602a74016c73fc7473c65ee8ac3d10ce831a0c2ccb19533abfc95660e0aafeb0

data/History.rdoc

@@ -1,3 +1,8 @@
+=== 1.5 / 2013-05-03
+
+* Added RingyDingy::Lookup to handle lookup of services.
+  * Added RingyDingy::Lookup#wait_for to wait on a recently registered service
+
 === 1.4 / 2013-03-15
 
 * Work around [ruby-talk:395364] by adding a timeout.

data/Manifest.txt

@@ -5,6 +5,10 @@ README.rdoc
 Rakefile
 bin/ring_server
 lib/ringy_dingy.rb
+lib/ringy_dingy/cancelable_renewer.rb
+lib/ringy_dingy/lookup.rb
 lib/ringy_dingy/ring_server.rb
 test/test_ring_server.rb
 test/test_ringy_dingy.rb
+test/test_ringy_dingy_cancelable_renewer.rb
+test/test_ringy_dingy_lookup.rb

data/Rakefile

@@ -2,6 +2,7 @@ require 'hoe'
 
 Hoe.plugin :git
 Hoe.plugin :minitest
+Hoe.plugin :travis
 
 Hoe.spec 'RingyDingy' do |p|
   p.developer 'Eric Hodel', 'drbrain@segment7.net'

data/lib/ringy_dingy.rb

@@ -2,8 +2,6 @@ require 'English'
 require 'drb'
 require 'rinda/ring'
 
-$TESTING = false unless defined? $TESTING
-
 ##
 # RingyDingy registers a DRb service with a Rinda::RingServer and re-registers
 # the service if communication with the Rinda::RingServer is ever lost.
@@ -24,7 +22,7 @@ class RingyDingy
   ##
   # The version of RingyDingy you are using
 
-  VERSION = '1.4'
+  VERSION = '1.5'
 
   ##
   # Interval to check the RingServer for our registration information.
@@ -47,10 +45,8 @@ class RingyDingy
 
   attr_reader :thread
 
-  if $TESTING then
-    attr_accessor :ring_finger, :renewer # :nodoc:
-    attr_writer :ring_server, :thread # :nodoc:
-  end
+  attr_accessor :ring_finger, :renewer # :nodoc:
+  attr_writer :ring_server, :thread # :nodoc:
 
   ##
   # Lists of hosts to search for ring servers.  By default includes the subnet
@@ -63,32 +59,7 @@ class RingyDingy
   # Ring servers are discovered via the +broadcast_list+.
 
   def self.find service_name, broadcast_list = BROADCAST_LIST
-    DRb.start_service unless DRb.primary_server
-    rf = Rinda::RingFinger.new broadcast_list
-
-    services = {}
-
-    rf.lookup_ring do |ts|
-      services[ts.__drburi] = ts.read_all [:name, nil, DRbObject, nil]
-    end
-
-    services.each do |_, tuples|
-      tuples.each do |_, found_service_name, service|
-        begin
-          next unless found_service_name == service_name
-
-          service.method_missing :object_id # ping service for liveness
-
-          return service
-        rescue DRb::DRbConnError
-          next
-        rescue NoMethodError
-          next
-        end
-      end
-    end
-
-    raise "unable to find service #{service_name.inspect}"
+    RingyDingy::Lookup.new(broadcast_list).find service_name
   end
 
   ##
@@ -116,9 +87,13 @@ class RingyDingy
   # Registers this service with the primary Rinda::RingServer.
 
   def register
-    ring_server.write [:name, @service, DRbObject.new(@object), @identifier],
-                      @renewer
-    return nil
+    reference = DRb::DRbObject.new(@object)
+
+    tuple = [:name, @service, reference, @identifier]
+
+    ring_server.write tuple, @renewer
+
+    nil
   end
 
   ##
@@ -202,3 +177,5 @@ class RingyDingy
 
 end
 
+require 'ringy_dingy/cancelable_renewer'
+require 'ringy_dingy/lookup'

data/lib/ringy_dingy/cancelable_renewer.rb

@@ -0,0 +1,28 @@
+##
+# This renewer can be canceled to shut down a TupleSpace operation.
+
+class RingyDingy::CancelableRenewer
+  include DRbUndumped
+
+  ##
+  # Creates a new renewer that will be checked every +sec+ for cancellation by
+  # the TupleSpace
+
+  def initialize seconds = 1
+    @renew   = true
+    @seconds = seconds
+  end
+
+  ##
+  # Cancels the renewer
+
+  def cancel
+    @renew = false
+  end
+
+  def renew # :nodoc:
+    @renew ? @seconds : true
+  end
+
+end
+

data/lib/ringy_dingy/lookup.rb

@@ -0,0 +1,128 @@
+require 'rinda/tuplespace'
+
+class RingyDingy::Lookup
+
+  ##
+  # The list of addresses where ring servers will be searched-for
+
+  attr_reader :broadcast_list
+
+  ##
+  # The Rinda::RingFinger used to search for ring servers
+
+  attr_reader :ring_finger
+
+  ##
+  # Lists of hosts to search for ring servers.  By default includes the subnet
+  # broadcast address and localhost.
+
+  def initialize broadcast_list = RingyDingy::BROADCAST_LIST
+    DRb.start_service unless DRb.primary_server
+
+    @broadcast_list = broadcast_list
+
+    @ring_finger    = Rinda::RingFinger.new @broadcast_list
+  end
+
+  ##
+  # Yields each tuple space found in the broadcast list
+
+  def each_tuple_space
+    return enum_for __method__ unless block_given?
+
+    @ring_finger.lookup_ring do |tuple_space|
+      yield tuple_space
+    end
+  end
+
+  ##
+  # Continually checks for tuple spaces and yields found tuple spaces.
+  #
+  # Returns a Thread that must be killed to shut down lookup:
+  #
+  #   def my_method
+  #     thread = enumerate_tuple_spaces do |tuple_space|
+  #       # ...
+  #     end
+  #   ensure
+  #     thread.kill
+  #   end
+
+  def enumerate_tuple_spaces
+    Thread.start do
+      spaces = {}
+
+      loop do
+        @ring_finger.lookup_ring do |tuple_space|
+          yield tuple_space
+        end
+      end
+    end
+  end
+
+  ##
+  # Finds the first live service matching +service_name+ on any ring server.
+  # Ring servers are discovered via the +broadcast_list+.
+
+  def find service_name
+    found = nil
+
+    each_tuple_space.any? do |ts|
+      tuples = ts.read_all [:name, nil, DRbObject, nil]
+
+      found = tuples.find do |_, found_service_name, service, _|
+        begin
+          next unless found_service_name == service_name
+
+          if DRbObject === service then
+            service.method_missing :object_id # ping service for liveness
+          else
+            service
+          end
+        rescue DRb::DRbConnError
+          next
+        rescue NoMethodError
+          next
+        end
+      end
+    end
+
+    raise "unable to find service #{service_name.inspect}" unless found
+
+    found[2]
+  end
+
+  ##
+  # Waits until +service_name+ appears on any ring server.  Returns the first
+  # service found with that name.
+  #
+  # If you launch a service via another process use this to wait until the
+  # service comes up.
+
+  def wait_for service_name
+    queue   = Queue.new
+    renewer = nil
+
+    thread = enumerate_tuple_spaces do |tuple_space|
+      renewer.cancel if renewer
+      renewer = RingyDingy::CancelableRenewer.new
+
+      Thread.new do
+        template = [:name, service_name, DRbObject, nil]
+        begin
+          tuple = tuple_space.read template, renewer
+
+          queue.push tuple[2]
+        rescue DRb::DRbConnError => e
+        end
+      end
+    end
+
+    queue.pop
+  ensure
+    renewer.cancel
+    thread.kill if thread
+  end
+
+end
+

data/lib/ringy_dingy/ring_server.rb

@@ -93,11 +93,13 @@ class RingyDingy::RingServer
     list_services.each do |ring_server, services|
       out << "Services on #{ring_server}"
 
-      values = services.sort_by { |s| [s[2].__drburi, -s[2].__drbref] }
+      values = services.sort_by do |_, name, service,|
+        [name.to_s, service.__drburi, -service.__drbref]
+      end
 
-      values.each do |s|
-        out << "\t%p, %p\n\t\tURI: %s ref: %d" %
-               [s[1], s[3], s[2].__drburi, s[2].__drbref]
+      values.each do |_, name, service, description|
+        out << "  %p, %p\n    URI: %s ref: %d" %
+               [name, description, service.__drburi, service.__drbref]
         out << nil
       end
     end

data/test/test_ring_server.rb

@@ -103,15 +103,15 @@ class TestRingServer < MiniTest::Unit::TestCase
 
     expected = <<-EOF
 Services on druby://localhost:10000
-\t:RingyDingy, "localhost_9607_obj0"
-\t\tURI: druby://localhost:10001 ref: #{OBJ0.object_id}
+  :RingyDingy, "localhost_9607_obj0"
+    URI: druby://localhost:10001 ref: #{OBJ0.object_id}
 
-\t:RingyDingy, "localhost_9607_obj1"
-\t\tURI: druby://localhost:10001 ref: #{OBJ1.object_id}
+  :RingyDingy, "localhost_9607_obj1"
+    URI: druby://localhost:10001 ref: #{OBJ1.object_id}
 
 Services on druby://localhost:10002
-\t:RingyDingy, "localhost_9607_obj2"
-\t\tURI: druby://localhost:10003 ref: #{OBJ2.object_id}
+  :RingyDingy, "localhost_9607_obj2"
+    URI: druby://localhost:10003 ref: #{OBJ2.object_id}
     EOF
 
     assert_equal expected, out

data/test/test_ringy_dingy.rb

@@ -1,7 +1,5 @@
 require 'test/unit'
 
-$TESTING = true
-
 require 'ringy_dingy'
 
 class StubRingFinger

data/test/test_ringy_dingy_cancelable_renewer.rb

@@ -0,0 +1,38 @@
+require 'minitest/autorun'
+
+class TestRingyDingyCancelableRenewer < MiniTest::Unit::TestCase
+
+  def setup
+    super
+
+    @renewer = RingyDingy::CancelableRenewer.new
+  end
+
+  def test_cancel
+    @renewer.cancel
+
+    assert_equal true, @renewer.renew
+  end
+
+  def test_marshal_dump
+    assert_raises TypeError do
+      Marshal.dump @renewer
+    end
+  end
+
+  def test_renew
+    assert_equal 1, @renewer.renew
+
+    @renewer.cancel
+
+    assert_equal true, @renewer.renew
+  end
+
+  def test_renew_seconds
+    @renewer = RingyDingy::CancelableRenewer.new 2
+
+    assert_equal 2, @renewer.renew
+  end
+
+end
+

data/test/test_ringy_dingy_lookup.rb

@@ -0,0 +1,57 @@
+require 'minitest/autorun'
+require 'ringy_dingy'
+
+class TestRingyDingyLookup < MiniTest::Unit::TestCase
+
+  def setup
+    super
+
+    @lookup = RingyDingy::Lookup.new []
+  end
+
+  def test_enumerate_tuple_spaces
+    stub_ring_finger
+
+    items = []
+
+    thread = @lookup.enumerate_tuple_spaces do |ts|
+      items << ts
+    end
+
+    Thread.pass while items.empty?
+
+    refute_empty items
+  ensure
+    thread.kill if thread
+  end
+
+  def test_find
+    stub_ring_finger
+
+    found = @lookup.find 'service'
+
+    assert_kind_of Object, found
+  end
+
+  def test_wait_for
+    stub_ring_finger
+
+    found = @lookup.wait_for 'service'
+
+    assert_kind_of Object, found
+  end
+
+  def stub_ring_finger
+    def (@lookup.ring_finger).lookup_ring
+      ts = Rinda::TupleSpace.new
+      yield DRb::DRbObject.new ts
+
+      ro = DRbObject.new Object.new
+      ts = Rinda::TupleSpace.new
+      ts.write [:name, 'service', ro, 'the service']
+      yield DRb::DRbObject.new ts
+    end
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: RingyDingy
 version: !ruby/object:Gem::Version
-  version: '1.4'
+  version: '1.5'
 platform: ruby
 authors:
 - Eric Hodel
@@ -30,7 +30,7 @@ cert_chain:
   KDyY1VIazVgoC8XvR4h/95/iScPiuglzA+DBG1hip1xScAtw05BrXyUNrc9CEMYU
   wgF94UVoHRp6ywo8I7NP3HcwFQDFNEZPNGXsng==
   -----END CERTIFICATE-----
-date: 2013-03-16 00:00:00.000000000 Z
+date: 2013-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -38,14 +38,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.6'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -119,9 +119,13 @@ files:
 - Rakefile
 - bin/ring_server
 - lib/ringy_dingy.rb
+- lib/ringy_dingy/cancelable_renewer.rb
+- lib/ringy_dingy/lookup.rb
 - lib/ringy_dingy/ring_server.rb
 - test/test_ring_server.rb
 - test/test_ringy_dingy.rb
+- test/test_ringy_dingy_cancelable_renewer.rb
+- test/test_ringy_dingy_lookup.rb
 - .gemtest
 homepage: https://github.com/drbrain/RingyDingy
 licenses:
@@ -145,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ringydingy
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: RingyDingy is a little boat that keeps your DRb service afloat! RingyDingy
@@ -153,3 +157,5 @@ summary: RingyDingy is a little boat that keeps your DRb service afloat! RingyDi
 test_files:
 - test/test_ring_server.rb
 - test/test_ringy_dingy.rb
+- test/test_ringy_dingy_cancelable_renewer.rb
+- test/test_ringy_dingy_lookup.rb