ruby_skynet 1.2.7 → 1.3.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d66558afbf4e84bec8db1eb77f09b6e2f2157cfd
-  data.tar.gz: 7d99411322f3550d9cbc4bfca9305470d622b6dc
+  metadata.gz: c969a82d83df34cb54f6417180b098db0a83ccaa
+  data.tar.gz: de2482f4598ad614af99ae74122d91fbbc578233
 SHA512:
-  metadata.gz: 473f10c3632f770220484db927cc9ca3052c6e5b963e90ffae00eaa8358697a5a262f8189db88fe42127f549325ce0031009c68c98fd6b431145d568a323dab6
-  data.tar.gz: 4e76abe1ce6771be9f397918dfe8b61e2c325364cae0067ee6cf8d1ab985a31e017636cfaa19dd54eb806455d021928ceaede6fa9f2ac9f8600a107a4fa88912
+  metadata.gz: 9777072ab66461a26c5f32befd5e9d65cdcca68d34d0f0a71b66b91f2ac66d958adb2aceb06acba828d86436d65ad5aa64ff971a52eb474c736e895f8854e544
+  data.tar.gz: ced033f9f4c2987abbc6ae7c18f2044b8d01d9d5bac73f877feef12604936b96f6778ff3ab0fe1e20a9af4af40290388f2401f8b71034e07b36292d75bfb6f24

data/Gemfile

@@ -8,15 +8,13 @@ gem "rake"
 gem "semantic_logger", ">= 2.1"
 gem "resilient_socket"
 # Doozer Client
-gem "ruby_doozer"
+#gem "ruby_doozer"
 # Zookeeper Client
 gem "zookeeper"
 # Thread Safe Hash and Array
 gem "thread_safe"
-# Connection pool
-gem "gene_pool"
 # For looking up Service entries in Service Registry
 gem "multi_json"
 # Wire format when communicating with services
-gem "bson"
+gem "bson", '1.5.2'
 gem "bson_ext", :platform => :ruby

data/Gemfile.lock

@@ -1,57 +1,46 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.0.0)
+    activesupport (4.0.2)
       i18n (~> 0.6, >= 0.6.4)
       minitest (~> 4.2)
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
     atomic (1.1.14)
-    bson (1.9.2)
-    bson_ext (1.9.2)
-      bson (~> 1.9.2)
-    gene_pool (1.3.0)
-    i18n (0.6.5)
+    bson (1.5.2)
+    bson_ext (1.5.2)
+      bson (= 1.5.2)
+    i18n (0.6.9)
     minitest (4.7.5)
-    multi_json (1.8.0)
+    multi_json (1.8.2)
     rake (10.1.0)
     resilient_socket (0.5.0)
       semantic_logger (>= 2.1)
-    ruby_doozer (0.8.1)
-      gene_pool (>= 1.3.0)
-      multi_json (>= 1.6.1)
-      resilient_socket (>= 0.5.0)
-      ruby_protobuf (>= 0.4.11)
-      semantic_logger (>= 2.1)
-      sync_attr (>= 1.0.0)
-    ruby_protobuf (0.4.11)
-    semantic_logger (2.2.0)
+    semantic_logger (2.6.1)
       sync_attr (>= 1.0)
       thread_safe (>= 0.1.0)
     shoulda (3.5.0)
       shoulda-context (~> 1.0, >= 1.0.1)
       shoulda-matchers (>= 1.4.1, < 3.0)
-    shoulda-context (1.1.5)
-    shoulda-matchers (2.3.0)
+    shoulda-context (1.1.6)
+    shoulda-matchers (2.4.0)
       activesupport (>= 3.0.0)
     sync_attr (1.0.0)
     thread_safe (0.1.3)
       atomic
-    tzinfo (0.3.37)
-    zookeeper (1.4.6)
+    tzinfo (0.3.38)
+    zookeeper (1.4.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bson
+  bson (= 1.5.2)
   bson_ext
-  gene_pool
   multi_json
   rake
   resilient_socket
-  ruby_doozer
   semantic_logger (>= 2.1)
   shoulda
   thread_safe

data/lib/ruby_skynet.rb

@@ -11,8 +11,39 @@ module RubySkynet
   autoload :Client,          'ruby_skynet/client'
   autoload :Service,         'ruby_skynet/service'
   autoload :Server,          'ruby_skynet/server'
-  autoload :Registry,        'ruby_skynet/registry'
-  autoload :ServiceRegistry, 'ruby_skynet/service_registry'
+  autoload :Zookeeper,       'ruby_skynet/zookeeper'
+end
+
+# Autodetect if Zookeeper gem is loaded, otherwise look for Doozer
+module RubySkynet
+  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)
+
+    # Shortcuts to loaded Registry classes
+    ServiceRegistry = RubySkynet::Zookeeper::ServiceRegistry
+    CachedRegistry  = RubySkynet::Zookeeper::CachedRegistry
+    Registry        = RubySkynet::Zookeeper::Registry
+  rescue LoadError
+    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
+      require 'ruby_skynet/static_service_registry'
+
+      # Use Static Service Registry
+      ServiceRegistry = RubySkynet::StaticServiceRegistry
+    end
+
+  end
 end
 
 if defined?(Rails)

data/lib/ruby_skynet/client.rb

@@ -83,20 +83,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/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(services = {})
+      @services = 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 = "1.2.7"
+  VERSION = "1.3.0.alpha1"
 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

data/ruby_skynet.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'date'
+require 'ruby_skynet/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'ruby_skynet'
+  spec.version     = RubySkynet::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ['Reid Morrison']
+  spec.email       = ['reidmo@gmail.com']
+  spec.homepage    = 'https://github.com/ClarityServices/ruby_skynet'
+  spec.date        = Date.today.to_s
+  spec.summary     = "Skynet Ruby Client"
+  spec.description = "Ruby Client for invoking Skynet services"
+  spec.files       = Dir.glob("lib/**/*") + Dir.glob("examples/**/*.rb") +  %w(LICENSE.txt README.md)
+  spec.license     = "Apache License V2.0"
+  spec.has_rdoc    = true
+  spec.add_dependency 'semantic_logger', '>= 2.6.1'
+  spec.add_dependency 'resilient_socket', '>= 0.5.0'
+  spec.add_dependency 'sync_attr', '>= 1.0.0'
+  spec.add_dependency 'bson', '>= 1.5.2'
+  spec.add_dependency 'thread_safe'
+end

data/test/client_test.rb

@@ -50,7 +50,7 @@ class ClientTest < Test::Unit::TestCase
           client = RubySkynet::Client.new('SomeService','*','ClientTest')
           client.call(:test, :hello => 'there')
         end
-        assert_match /No servers available for service: SomeService with version: \* in region: ClientTest/, exception.message
+        assert_match /No servers available for service: SomeService with version: -1 in region: ClientTest/, exception.message
       end
 
     end

data/test/service_registry_test.rb

@@ -42,7 +42,7 @@ class ServiceRegistryTest < Test::Unit::TestCase
         # Allow time for registry callback that service was deregistered
         sleep 0.1
         # No servers should be in the local registry
-#        assert_equal nil, RubySkynet.service_registry.servers_for(@service_name, @version, @region)
+        #        assert_equal nil, RubySkynet.service_registry.servers_for(@service_name, @version, @region)
       end
 
       should "find server using exact match" do
@@ -83,15 +83,21 @@ class ServiceRegistryTest < Test::Unit::TestCase
       end
 
       should "return nil when service not found" do
-        assert_equal nil, RubySkynet.service_registry.servers_for('MissingService', @version, @region)
+        assert_raise RubySkynet::ServiceUnavailable do
+          RubySkynet.service_registry.servers_for('MissingService', @version, @region)
+        end
       end
 
       should "return nil when version not found" do
-        assert_equal nil, RubySkynet.service_registry.servers_for(@service_name, @version+1, @region)
+        assert_raise RubySkynet::ServiceUnavailable do
+          RubySkynet.service_registry.servers_for(@service_name, @version+1, @region)
+        end
       end
 
       should "return nil when region not found" do
-        assert_equal nil, RubySkynet.service_registry.servers_for(@service_name, @version, 'OtherRegion')
+        assert_raise RubySkynet::ServiceUnavailable do
+          RubySkynet.service_registry.servers_for(@service_name, @version, 'OtherRegion')
+        end
       end
     end
 

data/test/zookeeper_registry_test.rb

@@ -153,7 +153,7 @@ class ZookeeperRegistryTest < Test::Unit::TestCase
             sleep 0.1
             # Allow Zookeeper to send back the change
             @registry.delete('bar')
-            sleep 0.3
+            sleep 2
             assert_equal 'bar', deleted_path
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_skynet
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.3.0.alpha1
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-19 00:00:00.000000000 Z
+date: 2013-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semantic_logger
@@ -122,7 +122,7 @@ files:
 - lib/ruby_skynet/ruby_skynet.rb
 - lib/ruby_skynet/server.rb
 - lib/ruby_skynet/service.rb
-- lib/ruby_skynet/service_registry.rb
+- lib/ruby_skynet/static_service_registry.rb
 - lib/ruby_skynet/version.rb
 - lib/ruby_skynet/zookeeper.rb
 - lib/ruby_skynet/zookeeper/cached_registry.rb
@@ -131,6 +131,7 @@ files:
 - lib/ruby_skynet/zookeeper/json/serializer.rb
 - lib/ruby_skynet/zookeeper/registry.rb
 - lib/ruby_skynet/zookeeper/service_registry.rb
+- ruby_skynet.gemspec
 - test/client_test.rb
 - test/service_registry_test.rb
 - test/service_test.rb
@@ -150,12 +151,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Skynet Ruby Client

data/lib/ruby_skynet/service_registry.rb

@@ -1,23 +0,0 @@
-# Define RubySkynet::ServiceRegistry based on whether the ZooKeeper or Doozer gem is present
-module RubySkynet
-  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