ruby_skynet 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf65f91389e27d97e04be4be8a1ef49700bb245b
-  data.tar.gz: 6b26fea72828375f49fff798c931744951747698
+  metadata.gz: f4b7ec3477060f1215627b808ee1f2962a4ad4ae
+  data.tar.gz: 4cf98cc577399f3d0521a84f5207322e436b4f3e
 SHA512:
-  metadata.gz: 20a409544353b4634fde2fb83595e0998ef808383591ad08692bf5422d6bbf07995e1bf781b5a698ceeb7d1e1ec18d840eb8ef98b9f6939d27273a8c9324574c
-  data.tar.gz: 8b049acd60bc68157ee6c632d7f44273fa366199c6bacbd6a0ef703c02d56190f1a1cec7471957452c453d07fd99a426efdba7842e6ca51383dc2abcaff6150a
+  metadata.gz: f6bc41df87ffbfae9c881ed44ba4932d5b46e79674c41db3e154cf357675e22ececd338856c2e2e7ab0db83f05484b83f3f067db76c9ac58b5b26925bbb5c1b3
+  data.tar.gz: 4f0356b9dae935ec70cef7b6db4ee7c98203f317a4c057814c42fcbeb7cf36a100cbaf7ccff214b0d1a5658ac590271542092fe7f4a6dc6543b06ecd0ce8e1cf

data/README.md

@@ -37,7 +37,7 @@ class EchoService
 end
 
 # Start the server
-RubySkynet::Server.start
+server = RubySkynet::Server.new
 ```
 
 Client to call the above Service

data/lib/ruby_skynet.rb

@@ -29,14 +29,18 @@ module RubySkynet
     begin
       require 'ruby_doozer'
       require 'ruby_skynet/doozer/service_registry'
+
+      # Shortcuts to loaded Registry classes
+      ServiceRegistry = RubySkynet::Doozer::ServiceRegistry
+      CachedRegistry  = Doozer::CachedRegistry
+      Registry        = Doozer::Registry
     rescue LoadError
-      raise LoadError, "Load either the 'zookeeper' or 'ruby_doozer' gem prior to loading RubySkynet. 'zookeeper' is preferred"
+      require 'ruby_skynet/static_service_registry'
+
+      # Use Static Service Registry
+      ServiceRegistry = RubySkynet::StaticServiceRegistry
     end
 
-    # Shortcuts to loaded Registry classes
-    ServiceRegistry = RubySkynet::Doozer::ServiceRegistry
-    CachedRegistry  = Doozer::CachedRegistry
-    Registry        = Doozer::Registry
   end
 end
 

data/lib/ruby_skynet/client.rb

@@ -84,20 +84,14 @@ module RubySkynet
       # Skynet requires BSON RPC Calls to have the following format:
       # https://github.com/skynetservices/skynet/blob/master/protocol.md
       request_id = BSON::ObjectId.new.to_s
+
+      # Obtain list of servers implementing this service in order of priority
+      servers = ::RubySkynet.service_registry.servers_for(skynet_name, skynet_version, skynet_region)
+
       logger.tagged request_id do
         logger.benchmark_info "Called Skynet Service: #{skynet_name}.#{method_name}" do
-          retries = 0
-          # If it cannot connect to a server, try a different server
-          begin
-            Connection.with_connection(::RubySkynet.service_registry.server_for(skynet_name, skynet_version, skynet_region), connection_params) do |connection|
-              connection.rpc_call(request_id, skynet_name, method_name, parameters)
-            end
-          rescue ResilientSocket::ConnectionFailure => exc
-            if (retries < 3) && exc.cause.is_a?(Errno::ECONNREFUSED)
-              retries += 1
-              retry
-            end
-            # TODO rescue ServiceUnavailable retry x times until the service becomes available
+          Connection.with_connection(servers, connection_params) do |connection|
+            connection.rpc_call(request_id, skynet_name, method_name, parameters)
           end
         end
       end

data/lib/ruby_skynet/connection.rb

@@ -1,5 +1,4 @@
 require 'bson'
-require 'gene_pool'
 require 'thread_safe'
 require 'resilient_socket'
 require 'sync_attr'
@@ -17,20 +16,6 @@ module RubySkynet
     # Returns the underlying socket being used by a Connection instance
     attr_reader :socket
 
-    # Default Pool configuration
-    sync_cattr_accessor :pool_config do
-      {
-        :pool_size    => 30,   # Maximum number of connections to any one server
-        :warn_timeout => 2,    # Log a warning if no connections are available after the :warn_timeout seconds
-        :timeout      => 10,   # Raise a Timeout exception if no connections are available after the :timeout seconds
-        :idle_timeout => 600,  # Renew a connection if it has been idle for this period of time
-      }
-    end
-
-    # For each server there is a connection pool keyed on the
-    # server address: 'host:port'
-    @@connection_pools = ThreadSafe::Hash.new
-
     # Returns a new RubySkynet connection to the server
     #
     # Parameters:
@@ -50,8 +35,8 @@ module RubySkynet
     #   :connect_retry_interval [Float]
     #     Number of seconds between connection retry attempts after the first failed attempt
     #     Default: 0.5
-    def initialize(server, params = {})
-      self.logger = SemanticLogger["#{self.class.name} [#{server}]"]
+    def initialize(servers, params = {})
+      params = params.dup
 
       # User configurable options
       params[:read_timeout]           ||= 60
@@ -95,8 +80,8 @@ module RubySkynet
       end
 
       # To prevent strange issues if user incorrectly supplies server names
-      params.delete(:servers)
-      params[:server] = server
+      params.delete(:server)
+      params[:servers] = servers
 
       @socket = ResilientSocket::TCPClient.new(params)
     end
@@ -209,44 +194,19 @@ module RubySkynet
 
     # Execute the supplied block with a connection from the pool
     def self.with_connection(server, params={}, &block)
-      (@@connection_pools[server] ||= new_connection_pool(server, params)).with_connection(&block)
+      conn = nil
+      begin
+        conn = new(server, params)
+        block.call(conn)
+      ensure
+        conn.close if conn
+      end
     end
 
     def close
       @socket.close if @socket
     end
 
-    ########################
-    protected
-
-    # Returns a new connection pool for the specified server
-    def self.new_connection_pool(server, params={})
-      # Connection pool configuration options
-      config = pool_config.dup
-
-      logger = SemanticLogger::Logger.new("#{self.class.name} [#{server}]")
-
-      # Method to call to close idle connections
-      config[:close_proc] = :close
-      config[:logger]     = logger
-
-      pool = GenePool.new(pool_config) do
-        new(server, params)
-      end
-
-      # Cleanup corresponding connection pool when a server terminates
-      RubySkynet.service_registry.on_server_removed(server) do
-        pool = @@connection_pools.delete(server)
-        # Cannot close all the connections since they could still be in use
-        pool.remove_idle(0) if pool
-        #pool.close if pool
-        logger.debug "Connection pool released"
-      end
-
-      pool
-    end
-
   end
-
 end
 

data/lib/ruby_skynet/doozer/service_registry.rb

@@ -1,6 +1,5 @@
 require 'semantic_logger'
 require 'thread_safe'
-require 'gene_pool'
 require 'resolv'
 
 #
@@ -62,18 +61,6 @@ module RubySkynet
         @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 == '*'
@@ -86,9 +73,11 @@ module RubySkynet
             end
           end
         end
-        if server_infos = @cache["#{name}/#{version}/#{region}"]
+        servers = if server_infos = @cache["#{name}/#{version}/#{region}"]
           server_infos.first.servers
         end
+        raise ServiceUnavailable.new("No servers available for service: #{name} with version: #{version} in region: #{region}") unless servers
+        servers
       end
 
       # Invokes registered callbacks when a specific server is shutdown or terminates

data/lib/ruby_skynet/railtie.rb

@@ -17,12 +17,14 @@ module RubySkynet #:nodoc:
 
     # Load RubySkynet Configuration once rails has started
     initializer 'ruby_skynet.initialize' do
-      config_file = Rails.root.join("config", "ruby_skynet.yml")
-      if config_file.file?
-        ::RubySkynet.configure!(config_file, Rails.env)
-      else
-        puts "\nRuby Skynet config not found."
-        puts "To generate one for the first time: rails generate ruby_skynet:config\n\n"
+      unless ::RubySkynet.configured?
+        config_file = Rails.root.join("config", "ruby_skynet.yml")
+        if config_file.file?
+          ::RubySkynet.configure!(config_file, Rails.env)
+        else
+          puts "\nRuby Skynet config not found."
+          puts "To generate one for the first time: rails generate ruby_skynet:config\n\n"
+        end
       end
     end
 

data/lib/ruby_skynet/railties/ruby_skynet.rake

@@ -1,6 +1,6 @@
 namespace :ruby_skynet do
 
-  desc "Start the Ruby Skynet Server.\n Rails Example: rake ruby_skynet:server\n Without Rails: SKYNET_ENV=production SKYNET_CONFIG=config/ruby_skynet rake ruby_skynet:server"
+  desc "Start the Ruby Skynet Server.\n Rails Example: rake ruby_skynet:server\n Without Rails: SKYNET_ENV=production SKYNET_CONFIG=config/ruby_skynet.yml rake ruby_skynet:server"
   task :server => :environment do
     # Configuration is automatically loaded when running under Rails
     # so skip it here under Rails

data/lib/ruby_skynet/ruby_skynet.rb

@@ -52,7 +52,7 @@ 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
+    ServiceRegistry.new(registry: {})
   end
 
   # Returns the current Registry Config information
@@ -60,7 +60,7 @@ module RubySkynet
   # 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)
+    @@config.dup if @@config
   end
 
   # Set the services registry
@@ -92,7 +92,7 @@ module RubySkynet
     RubySkynet.server_port      = config.delete(:server_port)      || 2000
     RubySkynet.local_ip_address = config.delete(:local_ip_address) || Common::local_ip_address
 
-    # Extract just the zookeeper or doozer configuration element
+    # Extract the registry configuration element
     RubySkynet.service_registry = ServiceRegistry.new(
       :registry => config.delete(:registry)
     )
@@ -100,4 +100,8 @@ module RubySkynet
     config.each_pair {|k,v| warn "Ignoring unknown RubySkynet config option #{k} => #{v}"}
   end
 
+  # Returns [Boolean] whether the RubySkynet.configure! method has already been called
+  def self.configured?
+    !@@config.nil?
+  end
 end

data/lib/ruby_skynet/static_service_registry.rb

@@ -0,0 +1,75 @@
+require 'semantic_logger'
+require 'thread_safe'
+
+#
+# RubySkynet Sevices Registry
+#
+# Loads a list of all services and which servers they are available on from a
+# static YAML file
+#
+# Format of the YAML file
+#   key: [String] "<name>/<version>/<region>"
+#   value: [Array<String>] 'host:port', 'host:port'
+#
+module RubySkynet
+  class StaticServiceRegistry
+    include SemanticLogger::Loggable
+
+    # Create a service registry
+    def initialize(params = {})
+      @services = params[:registry]
+      raise "Missing :registry in config that must list the availables services" unless @services
+    end
+
+    # Returns the Service Registry as a Hash
+    def to_h
+      @services.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)
+      server = "#{hostname}:#{port}"
+      key = "#{name}/#{version}/#{region}"
+      (@services[key] ||= []) << server
+      key
+    end
+
+    # Deregister the supplied service from the Registry
+    def deregister_service(name, version, region, hostname, port)
+      server = "#{hostname}:#{port}"
+      key = "#{name}/#{version}/#{region}"
+      if servers = @services[key]
+        servers.delete_if {|s| s == server}
+        @services.delete(key) if servers.count == 0
+      end
+      key
+    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
+        @services.keys.each do |key|
+          if match = key.match(/#{name}\/(\d+)\/#{region}/)
+            ver = match[1].to_i
+            version = ver if ver > version
+          end
+        end
+      end
+      servers = @services["#{name}/#{version}/#{region}"]
+      raise ServiceUnavailable.new("No servers available for service: #{name} with version: #{version} in region: #{region}") unless servers
+      servers
+    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)
+      #nop
+    end
+
+  end
+end

data/lib/ruby_skynet/version.rb

@@ -1,3 +1,3 @@
 module RubySkynet #:nodoc
-  VERSION = "2.0.0.rc1"
+  VERSION = "2.0.0"
 end

data/lib/ruby_skynet/zookeeper/service_registry.rb

@@ -1,6 +1,5 @@
 require 'semantic_logger'
 require 'thread_safe'
-require 'gene_pool'
 require 'resolv'
 
 #
@@ -76,18 +75,6 @@ module RubySkynet
 	      uuid
       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 == '*'
@@ -100,9 +87,11 @@ module RubySkynet
             end
           end
         end
-        if server_infos = @cache["#{name}/#{version}/#{region}"]
+        servers = if server_infos = @cache["#{name}/#{version}/#{region}"]
           server_infos.first.servers
         end
+        raise ServiceUnavailable.new("No servers available for service: #{name} with version: #{version} in region: #{region}") unless servers
+        servers
       end
 
       # Invokes registered callbacks when a specific server is shutdown or terminates

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_skynet
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2014-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semantic_logger
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.6.1
 - !ruby/object:Gem::Dependency
   name: resilient_socket
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +38,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.5.0
-- !ruby/object:Gem::Dependency
-  name: gene_pool
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: sync_attr
   requirement: !ruby/object:Gem::Requirement
@@ -70,14 +56,14 @@ dependencies:
   name: bson
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.0.0.rc3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.0.0.rc3
 - !ruby/object:Gem::Dependency
@@ -113,6 +99,7 @@ files:
 - lib/ruby_skynet/ruby_skynet.rb
 - lib/ruby_skynet/server.rb
 - lib/ruby_skynet/service.rb
+- lib/ruby_skynet/static_service_registry.rb
 - lib/ruby_skynet/version.rb
 - lib/ruby_skynet/zookeeper/cached_registry.rb
 - lib/ruby_skynet/zookeeper/extensions/java_base.rb
@@ -141,12 +128,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Skynet Ruby Client