ruby_skynet 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71af05d7950d049061c39abe50a23dd1fe02a51d
-  data.tar.gz: b312ef155c2aacea545f434d4d9e38348bc94ac5
+  metadata.gz: 088702cd6c216e6b48ec0124fb0ea95438be5a17
+  data.tar.gz: 6500952161438b2dcd00f2862164260ddc1788ca
 SHA512:
-  metadata.gz: 240897f81ded9f668da49ed7280b378bbe92d17e819e9c795a47affd7e6996a972d61168f4b9c104b8a21b4a01937523d5104661590ab82005de8fa1f39e6c38
-  data.tar.gz: 423409dbf2038a5723438004d451a28b4493edd85eadbf6cd239a0190c11b508ac56eb36be29872be28c2c6b057c31f7e2ba099912153b5cebd0384daf46a517
+  metadata.gz: 44c050a725b5fdf2ebda68a12be4a08117bb067f9df0bd19d4a28223e3f62bbdce5d5fe0dc715088a6857f462682dee61afc7b1e9c8843d52f3a8ee336f4165c
+  data.tar.gz: 8cf35886b4c988835b705d39777ac3d74e87ae26fe55b9038d713f6d9f87a06c143a6d5a05ccbfa46b8da0e5c0972148c92c4328406eaf60092b17262dc1353e

data/Gemfile.lock

@@ -7,8 +7,12 @@ GEM
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
+    atomic (1.1.10)
     atomic (1.1.10-java)
+    bson (1.9.0)
     bson (1.9.0-java)
+    bson_ext (1.9.0)
+      bson (~> 1.9.0)
     gene_pool (1.3.0)
     i18n (0.6.4)
     minitest (4.7.5)
@@ -39,12 +43,14 @@ GEM
     thread_safe (0.1.0)
       atomic
     tzinfo (0.3.37)
+    zookeeper (1.4.4)
     zookeeper (1.4.4-java)
       slyphon-log4j (= 1.2.15)
       slyphon-zookeeper_jar (= 3.3.5)
 
 PLATFORMS
   java
+  ruby
 
 DEPENDENCIES
   bson

data/lib/ruby_skynet/doozer/service_registry.rb

@@ -0,0 +1,240 @@
+require 'semantic_logger'
+require 'thread_safe'
+require 'gene_pool'
+require 'resolv'
+
+#
+# RubySkynet Sevices Registry
+#
+# Based on the Skynet Services Registry, obtains and keeps up to date a list of
+# all services and which servers they are available on.
+#
+module RubySkynet
+  module Doozer
+    class ServiceRegistry
+      include SemanticLogger::Loggable
+
+      # Create a service registry
+      # See: RubyDoozer::Registry for the parameters
+      def initialize
+        # Registry has the following format
+        #  Key: [String] 'name/version/region'
+        #  Value: [Array<String>] 'host:port', 'host:port'
+        @cache = ThreadSafe::Hash.new
+
+        # Supply block to load the current keys from the Registry
+        @registry = Doozer::Registry.new(:root => '/services') do |key, value|
+          service_info_changed(key, value)
+        end
+        # Register Callbacks
+        @registry.on_update {|path, value| service_info_changed(path, value) }
+        @registry.on_delete {|path|        service_info_changed(path) }
+
+        # Zookeeper Registry also supports on_create
+        @registry.on_create {|path, value| service_info_changed(path, value) } if @registry.respond_to?(:on_create)
+      end
+
+      # Returns the Service Registry as a Hash
+      def to_h
+        @cache.dup
+      end
+
+      # Register the supplied service at this Skynet Server host and Port
+      def register_service(name, version, region, hostname, port)
+        @registry["#{name}/#{version}/#{region}/#{hostname}/#{port}"] = {
+          "Config" => {
+            "UUID"    => "#{hostname}:#{port}-#{$$}-#{name}-#{version}",
+            "Name"    => name,
+            "Version" => version.to_s,
+            "Region"  => region,
+            "ServiceAddr" => {
+              "IPAddress" => hostname,
+              "Port"      => port,
+              "MaxPort"   => port + 999
+            },
+          },
+          "Registered" => true
+        }
+      end
+
+      # Deregister the supplied service from the Registry
+      def deregister_service(name, version, region, hostname, port)
+        @registry.delete("#{name}/#{version}/#{region}/#{hostname}/#{port}")
+      end
+
+      # Return a server that implements the specified service
+      def server_for(name, version='*', region=RubySkynet.region)
+        if servers = servers_for(name, version, region)
+          # Randomly select one of the servers offering the service
+          servers[rand(servers.size)]
+        else
+          msg = "No servers available for service: #{name} with version: #{version} in region: #{region}"
+          logger.warn msg
+          raise ServiceUnavailable.new(msg)
+        end
+      end
+
+      # Returns [Array<String>] a list of servers implementing the requested service
+      def servers_for(name, version='*', region=RubySkynet.region)
+        if version == '*'
+          # Find the highest version for the named service in this region
+          version = -1
+          @cache.keys.each do |key|
+            if match = key.match(/#{name}\/(\d+)\/#{region}/)
+              ver = match[1].to_i
+              version = ver if ver > version
+            end
+          end
+        end
+        if server_infos = @cache["#{name}/#{version}/#{region}"]
+          server_infos.first.servers
+        end
+      end
+
+      # Invokes registered callbacks when a specific server is shutdown or terminates
+      # Not when a server de-registers itself
+      # The callback will only be called once and will need to be re-registered
+      # after being called if future callbacks are required for that server
+      def on_server_removed(server, &block)
+        ((@on_server_removed_callbacks ||= ThreadSafe::Hash.new)[server] ||= ThreadSafe::Array.new) << block
+      end
+
+      ############################
+      protected
+
+      # Service information changed in doozer, so update internal registry
+      def service_info_changed(path, value=nil)
+        logger.info("service_info_changed: #{path}", value)
+        # path: "TutorialService/1/Development/127.0.0.1/9000"
+        e = path.split('/')
+
+        # Key: [String] 'name/version/region'
+        key = "#{e[0]}/#{e[1]}/#{e[2]}"
+        hostname, port = e[3], e[4]
+
+        if value
+          if value['Registered']
+            add_server(key, hostname, port)
+          else
+            # Service just de-registered
+            remove_server(key, hostname, port, false)
+          end
+        else
+          # Service has stopped and needs to be removed
+          remove_server(key, hostname, port, true)
+        end
+      end
+
+      # :score:   [Integer] Score
+      # :servers: [Array<String>] 'host:port', 'host:port'
+      ServerInfo = Struct.new(:score, :servers )
+
+      # Format of the internal services registry
+      #   key: [String] "<name>/<version>/<region>"
+      #   value: [ServiceInfo, ServiceInfo]
+      #          Sorted by highest score first
+
+      # Add the host to the registry based on it's score
+      def add_server(key, hostname, port)
+        server  = "#{hostname}:#{port}"
+
+        server_infos = (@cache[key] ||= ThreadSafe::Array.new)
+
+        # If already present, then nothing to do
+        server_info = server_infos.find{|si| si.servers.include?(server)}
+        return server_info if server_info
+
+        # Look for the same score with a different server
+        score = self.class.score_for_server(hostname, RubySkynet.local_ip_address)
+        logger.info "Service: #{key} now running at #{server} with score #{score}"
+        if server_info = server_infos.find{|si| si.score == score}
+          server_info.servers << server
+          return server_info
+        end
+
+        # New score
+        servers = ThreadSafe::Array.new
+        servers << server
+        server_info = ServerInfo.new(score, servers)
+
+        # Insert into Array in order of score
+        if index = server_infos.find_index {|si| si.score <= score}
+          server_infos.insert(index, server_info)
+        else
+          server_infos << server_info
+        end
+        server_info
+      end
+
+      # Remove the host from the registry based
+      # Returns the server instance if it was removed
+      def remove_server(key, hostname, port, notify)
+        server = "#{hostname}:#{port}"
+        logger.info "Service: #{key} stopped running at #{server}"
+        server_info = nil
+        if server_infos = @cache[key]
+          server_infos.each do |si|
+            if si.servers.delete(server)
+              server_info = si
+              break
+            end
+          end
+
+          # Found server
+          if server_info
+            # Cleanup if no more servers in server list
+            server_infos.delete(server_info) if server_info.servers.size == 0
+
+            # Cleanup if no more server infos
+            @cache.delete(key) if server_infos.size == 0
+
+            server_removed(server) if notify
+          end
+        end
+        server_info
+      end
+
+      # Invoke any registered callbacks for the specific server
+      def server_removed(server)
+        if @on_server_removed_callbacks && (callbacks = @on_server_removed_callbacks.delete(server))
+          callbacks.each do |block|
+            begin
+              logger.debug "Calling callback for server: #{server}"
+              block.call(server)
+            rescue Exception => exc
+              logger.error("Exception during a callback for server: #{server}", exc)
+            end
+          end
+        end
+      end
+
+      IPV4_REG_EXP = /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/
+
+      # Returns [Integer] the score for the supplied ip_address
+      # Score currently ranges from 0 to 4 with 4 being the best score
+      # If the IP address does not match an IP v4 address a DNS lookup will
+      # be performed
+      def self.score_for_server(ip_address, local_ip_address)
+        ip_address = '127.0.0.1' if ip_address == 'localhost'
+        score = 0
+        # Each matching element adds 1 to the score
+        # 192.168.  0.  0
+        #               1
+        #           1
+        #       1
+        #   1
+        server_match = IPV4_REG_EXP.match(ip_address) || IPV4_REG_EXP.match(Resolv::DNS.new.getaddress(ip_address).to_s)
+        if server_match
+          local_match = IPV4_REG_EXP.match(local_ip_address)
+          score = 0
+          (1..4).each do |i|
+            break if local_match[i].to_i != server_match[i].to_i
+            score += 1
+          end
+        end
+        score
+      end
+
+    end
+  end
+end

data/lib/ruby_skynet/ruby_skynet.rb

@@ -51,7 +51,15 @@ module RubySkynet
   # By default it connects to a local ZooKeeper instance
   # Use .configure! to supply a configuration file with any other settings
   sync_cattr_reader :service_registry do
-    ServiceRegistry.new(:root => '/services')
+    ServiceRegistry.new
+  end
+
+  # Returns the current Registry Config information
+  #
+  # By default it connects to a local ZooKeeper instance
+  # Use .configure! to supply a configuration file with any other settings
+  def self.registry_config
+    @@config.dup if @@config && defined?(@@config)
   end
 
   # Set the services registry
@@ -89,27 +97,14 @@ module RubySkynet
     RubySkynet.local_ip_address = config.delete(:local_ip_address) || Common::local_ip_address
 
     # Extract just the zookeeper or doozer configuration element
-    key = config[:zookeeper] ? :zookeeper : :doozer
     RubySkynet.service_registry = ServiceRegistry.new(
-      :root => '/services',
-      key   => config.delete(key)
+      :registry => config[:registry]
     )
 
     config.each_pair {|k,v| RubySkynet::Server.logger.warn "Ignoring unknown RubySkynet config option #{k} => #{v}"}
   end
 
-  # Returns an instance of RubySkynet::Zookeeper::CachedRegistry or RubyDoozer::CachedRegistry
-  # based on which was loaded in RubySkynet.configure!
-  def self.new_cache_registry(root)
-    # Load config
-    service_registry
-
-    if zookeeper = @@config[:zookeeper]
-      RubySkynet::Zookeeper::CachedRegistry.new(:root => root, :zookeeper => zookeeper)
-    else
-      raise "How did we get here", @@config
-      Doozer::CachedRegistry.new(:root => root, :doozer => @@config[:doozer])
-    end
-  end
+  # Initialize internal class variable
+  @@config = nil
 
 end

data/lib/ruby_skynet/service_registry.rb

@@ -1,238 +1,23 @@
-require 'semantic_logger'
-require 'thread_safe'
-require 'gene_pool'
-require 'resolv'
-
-#
-# RubySkynet Sevices Registry
-#
-# Based on the Skynet Services Registry, obtains and keeps up to date a list of
-# all services and which servers they are available on.
-#
+# Define RubySkynet::ServiceRegistry based on whether the ZooKeeper or Doozer gem is present
 module RubySkynet
-  class ServiceRegistry
-    include SemanticLogger::Loggable
-
-    # Create a service registry
-    # See: RubyDoozer::Registry for the parameters
-    def initialize(params)
-      # Registry has the following format
-      #  Key: [String] 'name/version/region'
-      #  Value: [Array<String>] 'host:port', 'host:port'
-      @cache = ThreadSafe::Hash.new
-
-      # Supply block to load the current keys from the Registry
-      @registry = Registry.new(params) do |key, value|
-        service_info_changed(key, value)
-      end
-      # Register Callbacks
-      @registry.on_update {|path, value| service_info_changed(path, value) }
-      @registry.on_delete {|path|        service_info_changed(path) }
-
-      # Zookeeper Registry also supports on_create
-      @registry.on_create {|path, value| service_info_changed(path, value) } if @registry.respond_to?(:on_create)
-    end
-
-    # Returns the Service Registry as a Hash
-    def to_h
-      @cache.dup
-    end
-
-    # Register the supplied service at this Skynet Server host and Port
-    def register_service(name, version, region, hostname, port)
-      @registry["#{name}/#{version}/#{region}/#{hostname}/#{port}"] = {
-        "Config" => {
-          "UUID"    => "#{hostname}:#{port}-#{$$}-#{name}-#{version}",
-          "Name"    => name,
-          "Version" => version.to_s,
-          "Region"  => region,
-          "ServiceAddr" => {
-            "IPAddress" => hostname,
-            "Port"      => port,
-            "MaxPort"   => port + 999
-          },
-        },
-        "Registered" => true
-      }
-    end
-
-    # Deregister the supplied service from the Registry
-    def deregister_service(name, version, region, hostname, port)
-      @registry.delete("#{name}/#{version}/#{region}/#{hostname}/#{port}")
-    end
-
-    # Return a server that implements the specified service
-    def server_for(name, version='*', region=RubySkynet.region)
-      if servers = servers_for(name, version, region)
-        # Randomly select one of the servers offering the service
-        servers[rand(servers.size)]
-      else
-        msg = "No servers available for service: #{name} with version: #{version} in region: #{region}"
-        logger.warn msg
-        raise ServiceUnavailable.new(msg)
-      end
-    end
-
-    # Returns [Array<String>] a list of servers implementing the requested service
-    def servers_for(name, version='*', region=RubySkynet.region)
-      if version == '*'
-        # Find the highest version for the named service in this region
-        version = -1
-        @cache.keys.each do |key|
-          if match = key.match(/#{name}\/(\d+)\/#{region}/)
-            ver = match[1].to_i
-            version = ver if ver > version
-          end
-        end
-      end
-      if server_infos = @cache["#{name}/#{version}/#{region}"]
-        server_infos.first.servers
-      end
-    end
-
-    # Invokes registered callbacks when a specific server is shutdown or terminates
-    # Not when a server de-registers itself
-    # The callback will only be called once and will need to be re-registered
-    # after being called if future callbacks are required for that server
-    def on_server_removed(server, &block)
-      ((@on_server_removed_callbacks ||= ThreadSafe::Hash.new)[server] ||= ThreadSafe::Array.new) << block
-    end
-
-    ############################
-    protected
-
-    # Service information changed in doozer, so update internal registry
-    def service_info_changed(path, value=nil)
-      logger.info("service_info_changed: #{path}", value)
-      # path: "TutorialService/1/Development/127.0.0.1/9000"
-      e = path.split('/')
-
-      # Key: [String] 'name/version/region'
-      key = "#{e[0]}/#{e[1]}/#{e[2]}"
-      hostname, port = e[3], e[4]
-
-      if value
-        if value['Registered']
-          add_server(key, hostname, port)
-        else
-          # Service just de-registered
-          remove_server(key, hostname, port, false)
-        end
-      else
-        # Service has stopped and needs to be removed
-        remove_server(key, hostname, port, true)
-      end
-    end
-
-    # :score:   [Integer] Score
-    # :servers: [Array<String>] 'host:port', 'host:port'
-    ServerInfo = Struct.new(:score, :servers )
-
-    # Format of the internal services registry
-    #   key: [String] "<name>/<version>/<region>"
-    #   value: [ServiceInfo, ServiceInfo]
-    #          Sorted by highest score first
-
-    # Add the host to the registry based on it's score
-    def add_server(key, hostname, port)
-      server  = "#{hostname}:#{port}"
-
-      server_infos = (@cache[key] ||= ThreadSafe::Array.new)
-
-      # If already present, then nothing to do
-      server_info = server_infos.find{|si| si.servers.include?(server)}
-      return server_info if server_info
-
-      # Look for the same score with a different server
-      score = self.class.score_for_server(hostname, RubySkynet.local_ip_address)
-      logger.info "Service: #{key} now running at #{server} with score #{score}"
-      if server_info = server_infos.find{|si| si.score == score}
-        server_info.servers << server
-        return server_info
-      end
-
-      # New score
-      servers = ThreadSafe::Array.new
-      servers << server
-      server_info = ServerInfo.new(score, servers)
-
-      # Insert into Array in order of score
-      if index = server_infos.find_index {|si| si.score <= score}
-        server_infos.insert(index, server_info)
-      else
-        server_infos << server_info
-      end
-      server_info
-    end
-
-    # Remove the host from the registry based
-    # Returns the server instance if it was removed
-    def remove_server(key, hostname, port, notify)
-      server = "#{hostname}:#{port}"
-      logger.info "Service: #{key} stopped running at #{server}"
-      server_info = nil
-      if server_infos = @cache[key]
-        server_infos.each do |si|
-          if si.servers.delete(server)
-            server_info = si
-            break
-          end
-        end
-
-        # Found server
-        if server_info
-          # Cleanup if no more servers in server list
-          server_infos.delete(server_info) if server_info.servers.size == 0
-
-          # Cleanup if no more server infos
-          @cache.delete(key) if server_infos.size == 0
-
-          server_removed(server) if notify
-        end
-      end
-      server_info
-    end
-
-    # Invoke any registered callbacks for the specific server
-    def server_removed(server)
-      if @on_server_removed_callbacks && (callbacks = @on_server_removed_callbacks.delete(server))
-        callbacks.each do |block|
-          begin
-            logger.debug "Calling callback for server: #{server}"
-            block.call(server)
-          rescue Exception => exc
-            logger.error("Exception during a callback for server: #{server}", exc)
-          end
-        end
-      end
-    end
-
-    IPV4_REG_EXP = /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/
-
-    # Returns [Integer] the score for the supplied ip_address
-    # Score currently ranges from 0 to 4 with 4 being the best score
-    # If the IP address does not match an IP v4 address a DNS lookup will
-    # be performed
-    def self.score_for_server(ip_address, local_ip_address)
-      ip_address = '127.0.0.1' if ip_address == 'localhost'
-      score = 0
-      # Each matching element adds 1 to the score
-      # 192.168.  0.  0
-      #               1
-      #           1
-      #       1
-      #   1
-      server_match = IPV4_REG_EXP.match(ip_address) || IPV4_REG_EXP.match(Resolv::DNS.new.getaddress(ip_address).to_s)
-      if server_match
-        local_match = IPV4_REG_EXP.match(local_ip_address)
-        score = 0
-        (1..4).each do |i|
-          break if local_match[i].to_i != server_match[i].to_i
-          score += 1
-        end
-      end
-      score
-    end
-
+  begin
+    require 'zookeeper'
+    require 'zookeeper/client'
+    require 'ruby_skynet/zookeeper/service_registry'
+    # Monkey-patch so that the Zookeeper JRuby code can handle nil values in Zookeeper
+    require 'ruby_skynet/zookeeper/extensions/java_base' if defined?(::JRUBY_VERSION)
+    ServiceRegistry = RubySkynet::Zookeeper::ServiceRegistry
+    CachedRegistry  = RubySkynet::Zookeeper::CachedRegistry
+    Registry        = RubySkynet::Zookeeper::Registry
+  rescue LoadError
+    begin
+      require 'ruby_doozer'
+      require 'ruby_skynet/doozer/service_registry'
+    rescue LoadError
+      raise LoadError, "Must gem install either 'zookeeper' or 'ruby_doozer'. 'zookeeper' is recommended"
+    end
+    ServiceRegistry = RubySkynet::Doozer::ServiceRegistry
+    CachedRegistry  = Doozer::CachedRegistry
+    Registry        = Doozer::Registry
   end
-end
+end

data/lib/ruby_skynet/version.rb

@@ -1,3 +1,3 @@
 module RubySkynet #:nodoc
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/ruby_skynet/zookeeper/json/serializer.rb

@@ -3,7 +3,7 @@ module RubySkynet
   module Zookeeper
     module Json
 
-      # Serialize to JSON for storing in Doozer
+      # Serialize to JSON for storing in Registry
       module Serializer
         def self.serialize(value)
           if value.is_a?(Hash) || value.is_a?(Array)

data/lib/ruby_skynet/zookeeper/registry.rb

@@ -34,7 +34,10 @@ module RubySkynet
       #   significant traffic since it will also monitor ZooKeeper Admin changes
       #   Mandatory
       #
-      # :zookeeper [Hash|ZooKeeper]
+      # :ephemeral [Boolean]
+      #   All set operations of non-nil values will result in ephemeral nodes.
+      #
+      # :registry [Hash|ZooKeeper]
       #   ZooKeeper configuration information, or an existing
       #   ZooKeeper ( ZooKeeper client) instance
       #
@@ -87,6 +90,9 @@ module RubySkynet
         @serializer   = params.delete(:serializer)   || RubySkynet::Zookeeper::Json::Serializer
         @deserializer = params.delete(:deserializer) || RubySkynet::Zookeeper::Json::Deserializer
 
+        @ephemeral = params.delete(:ephemeral)
+        @ephemeral = false if @ephemeral.nil?
+
         # Generate warning log entries for any unknown configuration options
         params.each_pair {|k,v| logger.warn "Ignoring unknown configuration option: #{k}"}
 
@@ -206,7 +212,7 @@ module RubySkynet
       #      Default: '*'
       #
       #    value
-      #      New value from doozer
+      #      New value from the registry
       #
       #    version
       #      The version number of this node
@@ -230,12 +236,12 @@ module RubySkynet
       #
       #  Parameters passed to the block:
       #    key
-      #      The key that was updated in doozer
+      #      The key that was updated in the registry
       #      Supplying a key of '*' means all paths
       #      Default: '*'
       #
       #    value
-      #      New value from doozer
+      #      New value from the registry
       #
       #    version
       #      The version number of this node
@@ -259,7 +265,7 @@ module RubySkynet
       #
       #  Parameters passed to the block:
       #    key
-      #      The key that was deleted from doozer
+      #      The key that was deleted from the registry
       #      Supplying a key of '*' means all paths
       #      Default: '*'
       #
@@ -314,7 +320,7 @@ module RubySkynet
           @zookeeper.create(:path => path)
         end
         if value
-          @zookeeper.create(:path => full_path, :data => value)
+          @zookeeper.create(:path => full_path, :data => value, :ephemeral => @ephemeral)
         else
           @zookeeper.create(:path => full_path)
         end

data/lib/ruby_skynet/zookeeper/service_registry.rb

@@ -0,0 +1,271 @@
+require 'semantic_logger'
+require 'thread_safe'
+require 'gene_pool'
+require 'resolv'
+
+#
+# RubySkynet Sevices Registry
+#
+# Based on the Skynet Services Registry, obtains and keeps up to date a list of
+# all services and which servers they are available on.
+#
+module RubySkynet
+  module Zookeeper
+    class ServiceRegistry
+      include SemanticLogger::Loggable
+
+      # Create a service registry
+      # See: RubyDoozer::Registry for the parameters
+      def initialize(params = {})
+        # Registry has the following format
+        #  Key: [String] 'name/version/region'
+        #  Value: [Array<String>] 'host:port', 'host:port'
+        @cache = ThreadSafe::Hash.new
+        @notifications_cache = ThreadSafe::Hash.new
+
+        # Supply block to load the current keys from the Registry
+        params[:root] = '/instances'
+        params[:ephemeral] = true
+        @registry = Zookeeper::Registry.new(params) do |key, value|
+          service_info_created(key, value)
+        end
+        # Register Callbacks
+        @registry.on_create {|path, value| service_info_created(path, value) }
+        @registry.on_update {|path, value| service_info_updated(path, value) }
+        @registry.on_delete {|path|        service_info_deleted(path) }
+      end
+
+      # Returns the Service Registry as a Hash
+      def to_h
+        @cache.dup
+      end
+
+      # Register the supplied service at this Skynet Server host and Port
+      # Returns the UUID for the service that was created
+      def register_service(name, version, region, hostname, port)
+        uuid = "#{hostname}:#{port}-#{$$}-#{name}-#{version}"
+        # TODO Make sets ephemeral
+        @registry[File.join(uuid,'addr')]       = "#{hostname}:#{port}"
+        @registry[File.join(uuid,'name')]       = name
+        @registry[File.join(uuid,'version')]    = version
+        @registry[File.join(uuid,'region')]     = region
+        @registry[File.join(uuid,'registered')] = true
+	      uuid
+      end
+
+      # Deregister the supplied service from the Registry
+      def deregister_service(name, version, region, hostname, port)
+        uuid = "#{hostname}:#{port}-#{$$}-#{name}-#{version}"
+        @registry.delete(File.join(uuid,'addr'), false)
+        @registry.delete(File.join(uuid,'name'), false)
+        @registry.delete(File.join(uuid,'version'), false)
+        @registry.delete(File.join(uuid,'region'), false)
+        @registry.delete(File.join(uuid,'registered'), false)
+        @registry.delete(uuid, false)
+      end
+
+      # Return a server that implements the specified service
+      def server_for(name, version='*', region=RubySkynet.region)
+        if servers = servers_for(name, version, region)
+          # Randomly select one of the servers offering the service
+          servers[rand(servers.size)]
+        else
+          msg = "No servers available for service: #{name} with version: #{version} in region: #{region}"
+          logger.warn msg
+          raise ServiceUnavailable.new(msg)
+        end
+      end
+
+      # Returns [Array<String>] a list of servers implementing the requested service
+      def servers_for(name, version='*', region=RubySkynet.region)
+        if version == '*'
+          # Find the highest version for the named service in this region
+          version = -1
+          @cache.keys.each do |key|
+            if match = key.match(/#{name}\/(\d+)\/#{region}/)
+              ver = match[1].to_i
+              version = ver if ver > version
+            end
+          end
+        end
+        if server_infos = @cache["#{name}/#{version}/#{region}"]
+          server_infos.first.servers
+        end
+      end
+
+      # Invokes registered callbacks when a specific server is shutdown or terminates
+      # Not when a server de-registers itself
+      # The callback will only be called once and will need to be re-registered
+      # after being called if future callbacks are required for that server
+      def on_server_removed(server, &block)
+        ((@on_server_removed_callbacks ||= ThreadSafe::Hash.new)[server] ||= ThreadSafe::Array.new) << block
+      end
+
+      ############################
+      protected
+
+      def service_info_deleted(path)
+        logger.info("service_info_deleted: #{path}")
+        # path: "uuid/key"
+        uuid, key = path.split('/')
+        if (key == 'registered')
+          if server = @notifications_cache.delete(uuid)
+            hostname, port = server['addr'].split(':')
+            # Service has stopped and needs to be removed
+            remove_server(File.join(server['name'], server['version'].to_s, server['region']), hostname, port, true)
+          end
+        end
+      end
+
+      # Service information changed, so update internal registry
+      def service_info_created(path, value=nil)
+        logger.info("service_info_created: #{path}", value)
+        # path: "uuid/key"
+        uuid, key = path.split('/')
+
+        # Big Assumption: 'registered' event will be received last as true
+        if (key == 'registered') && (value == true)
+          server = @notifications_cache[uuid]
+          if server && server['addr'] && server['name'] && server['version'] && server['region']
+            hostname, port = server['addr'].split(':')
+            add_server(File.join(server['name'], server['version'].to_s, server['region']), hostname, port)
+          else
+            logger.warn "Registered notification received for #{uuid} but is missing critical information. Received:", server
+          end
+        else
+          (@notifications_cache[uuid] ||= ThreadSafe::Hash.new)[key] = value
+        end
+      end
+
+      def service_info_updated(path, value=nil)
+        logger.info("service_info_updated: #{path}", value)
+        # path: "uuid/key"
+        uuid, key = path.split('/')
+
+        # Big Assumption: 'registered' event will be received last as true
+        if (key == 'registered') && (value == true)
+          server = @notifications_cache[uuid]
+          if server && server['addr'] && server['name'] && server['version'] && server['region']
+            hostname, port = server['addr'].split(':')
+            add_server(File.join(server['name'], server['version'].to_s, server['region']), hostname, port)
+          else
+            logger.warn "Registered notification received for #{uuid} but is missing critical information. Received:", server
+          end
+        else
+          (@notifications_cache[uuid] ||= ThreadSafe::Hash.new)[key] = value
+        end
+      end
+
+      # :score:   [Integer] Score
+      # :servers: [Array<String>] 'host:port', 'host:port'
+      ServerInfo = Struct.new(:score, :servers )
+
+      # Format of the internal services registry
+      #   key: [String] "<name>/<version>/<region>"
+      #   value: [ServiceInfo, ServiceInfo]
+      #          Sorted by highest score first
+
+      # Add the host to the registry based on it's score
+      def add_server(key, hostname, port)
+        server  = "#{hostname}:#{port}"
+
+        server_infos = (@cache[key] ||= ThreadSafe::Array.new)
+
+        # If already present, then nothing to do
+        server_info = server_infos.find{|si| si.servers.include?(server)}
+        return server_info if server_info
+
+        # Look for the same score with a different server
+        score = self.class.score_for_server(hostname, RubySkynet.local_ip_address)
+        logger.info "Service: #{key} now running at #{server} with score #{score}"
+        if server_info = server_infos.find{|si| si.score == score}
+          server_info.servers << server
+          return server_info
+        end
+
+        # New score
+        servers = ThreadSafe::Array.new
+        servers << server
+        server_info = ServerInfo.new(score, servers)
+
+        # Insert into Array in order of score
+        if index = server_infos.find_index {|si| si.score <= score}
+          server_infos.insert(index, server_info)
+        else
+          server_infos << server_info
+        end
+        server_info
+      end
+
+      # Remove the host from the registry based
+      # Returns the server instance if it was removed
+      def remove_server(key, hostname, port, notify)
+        server = "#{hostname}:#{port}"
+        logger.info "Service: #{key} stopped running at #{server}"
+        server_info = nil
+        if server_infos = @cache[key]
+          server_infos.each do |si|
+            if si.servers.delete(server)
+              server_info = si
+              break
+            end
+          end
+
+          # Found server
+          if server_info
+            # Cleanup if no more servers in server list
+            server_infos.delete(server_info) if server_info.servers.size == 0
+
+            # Cleanup if no more server infos
+            @cache.delete(key) if server_infos.size == 0
+
+            server_removed(server) if notify
+          end
+        end
+        server_info
+      end
+
+      # Invoke any registered callbacks for the specific server
+      def server_removed(server)
+        if @on_server_removed_callbacks && (callbacks = @on_server_removed_callbacks.delete(server))
+          callbacks.each do |block|
+            begin
+              logger.debug "Calling callback for server: #{server}"
+              block.call(server)
+            rescue Exception => exc
+              logger.error("Exception during a callback for server: #{server}", exc)
+            end
+          end
+        end
+      end
+
+      IPV4_REG_EXP = /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/
+
+      # Returns [Integer] the score for the supplied ip_address
+      # Score currently ranges from 0 to 4 with 4 being the best score
+      # If the IP address does not match an IP v4 address a DNS lookup will
+      # be performed
+      def self.score_for_server(ip_address, local_ip_address)
+        ip_address = '127.0.0.1' if ip_address == 'localhost'
+        score = 0
+        # Each matching element adds 1 to the score
+        # 192.168.  0.  0
+        #               1
+        #           1
+        #       1
+        #   1
+        server_match = IPV4_REG_EXP.match(ip_address) || IPV4_REG_EXP.match(Resolv::DNS.new.getaddress(ip_address).to_s)
+        if server_match
+          local_match = IPV4_REG_EXP.match(local_ip_address)
+          score = 0
+          (1..4).each do |i|
+            break if local_match[i].to_i != server_match[i].to_i
+            score += 1
+          end
+        end
+        score
+      end
+
+    end
+  end
+end

data/lib/ruby_skynet/zookeeper.rb

@@ -2,6 +2,7 @@ require 'semantic_logger'
 module RubySkynet
   module Zookeeper
     autoload :Registry,        'ruby_skynet/zookeeper/registry'
+    autoload :ServiceRegistry, 'ruby_skynet/zookeeper/service_registry'
     autoload :CachedRegistry,  'ruby_skynet/zookeeper/cached_registry'
     module Json
       autoload :Deserializer,  'ruby_skynet/zookeeper/json/deserializer'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_skynet
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-27 00:00:00.000000000 Z
+date: 2013-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semantic_logger
@@ -115,10 +115,10 @@ files:
 - lib/ruby_skynet/client.rb
 - lib/ruby_skynet/common.rb
 - lib/ruby_skynet/connection.rb
+- lib/ruby_skynet/doozer/service_registry.rb
 - lib/ruby_skynet/exceptions.rb
 - lib/ruby_skynet/railtie.rb
 - lib/ruby_skynet/railties/ruby_skynet.rake
-- lib/ruby_skynet/registry.rb
 - lib/ruby_skynet/ruby_skynet.rb
 - lib/ruby_skynet/server.rb
 - lib/ruby_skynet/service.rb
@@ -130,6 +130,7 @@ files:
 - lib/ruby_skynet/zookeeper/json/deserializer.rb
 - lib/ruby_skynet/zookeeper/json/serializer.rb
 - lib/ruby_skynet/zookeeper/registry.rb
+- lib/ruby_skynet/zookeeper/service_registry.rb
 - test/client_test.rb
 - test/service_registry_test.rb
 - test/service_test.rb

data/lib/ruby_skynet/registry.rb

@@ -1,17 +0,0 @@
-# Define RubySkynet::Registry based on whether the ZooKeeper or Doozer gem is present
-module RubySkynet
-  begin
-    require 'zookeeper'
-    require 'zookeeper/client'
-    # Monkey-patch so that the Zookeeper JRuby code can handle nil values in Zookeeper
-    require 'ruby_skynet/zookeeper/extensions/java_base' if defined?(::JRUBY_VERSION)
-    Registry = RubySkynet::Zookeeper::Registry
-  rescue LoadError
-    begin
-      require 'ruby_doozer'
-    rescue LoadError
-      raise LoadError, "Must gem install either 'zookeeper' or 'ruby_doozer'. 'zookeeper' is recommended"
-    end
-    Registry = Doozer::Registry
-  end
-end