zoo-service-discovery 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmFlYTU1NDM4ODZkZThmMzllMWQxODVmM2I4ZmQ2YjEzYjc2NzEzYQ==
+  data.tar.gz: !binary |-
+    MDNlNGVhYmZhOGMxZjk4NWZmNmVlNzIxMWMyODcwN2JmZTZjNDUwMg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Y2RjZTg3ZWNkMDBmYjc4M2Q4YjRiZTg0NzkzNGM1OGMxN2Y0OTY2ODViNDc3
+    ODUyYjI2YTViMDMwYzcyMTA0MzdhN2VlZDFlMmE0OTMxNGNmNTgyMmQxZDcw
+    ZWE4ZTgxYmJiNmMzOGEzN2Q3YWJjYWNjNzdiNjU0YzQxNzkwMDU=
+  data.tar.gz: !binary |-
+    ZmI4Nzc3MzBmNzdiZjg5OThkYTdhMjIwMjk3YmU2OTA3ZTlhNzczZDgzNDcy
+    MWZkYmVjMDNmMGU0YjE1NmY4YTRhNDE3YzAwZTZkMWJmNDlhN2NhNDliZGU5
+    ZWMwOGU0NzgxMTNkNjg2OWIyYTM1MzAwYzA0OTkzN2M3MjQzNmQ=

data/README.md

@@ -0,0 +1,30 @@
+# ZooKeeper Service Discovery
+
+ZooKeeper service discovery gem.
+
+You can use it to publish and discover well-known service URL's within your
+application infrastructure.
+
+## Service Publication by a Service Provider
+
+```ruby
+require 'zoo-service-discovery'
+
+ZooService::Publication.register_service('service_name', 'http://api.service.com/')
+```
+
+## Service Lookup by a Service Consumer
+
+```ruby
+require 'zoo-service-discovery'
+
+base_service_url = ZooService::Discovery.get_service_url('service_name')
+```
+
+## Specs
+
+RSpecs were developed and ran on a Mac OS X machine. They require ZooKeeper to
+be installed locally (e.g. via Brew) and be available in the path.
+
+More details on how the Zookeeper instances are started and torn down are in
+the ```zookeeper_runner.rb``` RSpec support file.

data/lib/zoo-service-discovery.rb

@@ -0,0 +1,2 @@
+require_relative 'zoo_service/discovery'
+require_relative 'zoo_service/publication'

data/lib/zoo_service/discovery.rb

@@ -0,0 +1,45 @@
+require 'zk'
+
+# Service discovery facilities namespace.
+module ZooService
+
+  # Performs service discovery for a HTTP service consumer.
+  class Discovery
+    class << self
+      # :call-seq:
+      #   get_service_url(name) => String
+      #
+      # Gets service URL by _name_.
+      #
+      # Returns service URL, if everything went OK, +nil+ otherwise.
+      def get_service_url(name)
+        get_published_urls(name).first
+      end
+
+    protected
+
+      # Gets published URLs of _service_name_.
+      def get_published_urls(service_name)
+        service_path = "/services/#{service_name}"
+        publications = zk.children(service_path, ignore: :no_node) || [ ]
+
+        unless publications.empty?
+          zk.get("#{service_path}/#{publications.last}", ignore: :no_node)
+        else
+          [ ]
+        end
+      end
+
+      # Returns a working instance of a ZooKeeper client.
+      def zk
+        if Thread.current[:service_discovery_zk_client]
+          return Thread.current[:service_discovery_zk_client]
+        end
+
+        Thread.current[:service_discovery_zk_client] ||= ZK.new(ENV['SERVICE_DISCOVERY_WELLKNOWN_ADDRESS'] || 'localhost:2181')
+      end
+
+    end
+  end
+
+end

data/lib/zoo_service/publication.rb

@@ -0,0 +1,59 @@
+require 'zk'
+
+# Service discovery facilities namespace.
+module ZooService
+
+  # Performs service publication for a HTTP service provider.
+  class Publication
+    class << self
+      # :call-seq:
+      #   register_service(name, url) => Boolean
+      #
+      # Registers a well-known service with _name_ at _url_.
+      #
+      # Returns +true+, if everything went OK, +false+ otherwise.
+      def register_service(name, url)
+        registration_block = create_registration_block(name, url)
+        service_registration_blocks << registration_block
+        registration_block.(zk)
+      end
+
+    protected
+
+      # Creates a lambda that once called registeres the service on the URL.
+      def create_registration_block(name, url)
+        -> zk {
+          service_path = "/services/#{name}"
+          zk.mkdir_p(service_path) unless zk.exists?(service_path)
+          zk.create("#{service_path}/node-", url, mode: :ephemeral_sequential)
+        }
+      end
+
+      # Stores the registration blocks that are rerun after reconnection to
+      # the ZooKeeper.
+      def service_registration_blocks
+        @service_registration_blocks ||= [ ]
+      end
+
+      # Returns a working instance of a ZooKeeper client.
+      def zk
+        if Thread.current[:service_publication_zk_client]
+          return Thread.current[:service_publication_zk_client]
+        end
+
+        zk_client = ZK.new(ENV['SERVICE_DISCOVERY_WELLKNOWN_ADDRESS'] || 'localhost:2181') do |zk|
+          zk.on_connected do
+            # Rerun all the registrations upon reconnection
+            service_registration_blocks.each do |registration_block|
+              registration_block.(zk)
+            end
+          end
+        end
+
+        Thread.current[:service_publication_zk_client] = zk_client
+      end
+
+    end
+  end
+
+end

data/spec/features/complex_discovery_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe "Discovered service URL (registered in a separate process)" do
+
+  def kill_server_process
+    begin
+      Process.kill("HUP", server_process)
+      Process.wait(server_process)
+    rescue Errno::ESRCH
+      # ignore
+    end
+  end
+
+  before {
+    if Thread.current[:service_discovery_zk_client]
+      Thread.current[:service_discovery_zk_client].close
+      Thread.current[:service_discovery_zk_client] = nil
+    end
+
+    if Thread.current[:service_publication_zk_client]
+      Thread.current[:service_publication_zk_client].close
+      Thread.current[:service_publication_zk_client] = nil
+    end
+  }
+
+  subject {
+    ZooService::Discovery.get_service_url(service)
+  }
+
+  let(:real_service_url) {
+    "http://sample.dev/"
+  }
+
+  let(:service) {
+    "service"
+  }
+
+  let!(:server_process) {
+    pid = fork do |variable|
+      ZooService::Publication.register_service(service, real_service_url)
+      sleep 1 while true
+    end
+    sleep 0.5
+    return pid
+  }
+
+  after do
+    kill_server_process
+  end
+
+  it { should == real_service_url }
+
+  it "should be nil after service owner termination" do
+    kill_server_process
+    sleep 30
+    should == nil
+  end
+
+  it "retains value when ZooKeeper fails and restarts with an empty DB" do
+    should == real_service_url
+
+    ZookeeperRunner.clean
+    ZookeeperRunner.stop
+    ZookeeperRunner.start
+
+    should == real_service_url
+  end
+
+end

data/spec/features/discovery_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe "Discovered service URL" do
+
+  subject {
+    ZooService::Discovery.get_service_url(service)
+  }
+
+  let(:real_service_url) {
+    "http://sample.dev/"
+  }
+
+  context "when service is registered" do
+
+    let!(:service) {
+      ZooService::Publication.register_service("service", real_service_url)
+      "service"
+    }
+
+    it { should == real_service_url }
+
+    it "should be nil if ZooKeeper gets cleaned somehow" do
+      # eh, eh, negative case ;) just to be sure
+      ZookeeperRunner.clean  # clean the ZooKeeper
+      should == nil          # check that it cannot be discovered
+    end
+
+  end
+
+  context "when service is not registered" do
+
+    let(:service) {
+      "service"
+    }
+
+    it { should == nil }
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'bundler'
+Bundler.require(:test)
+
+require_relative "../lib/zoo_service/discovery"
+require_relative "../lib/zoo_service/publication"
+
+Dir[File.expand_path("../../spec/support/**/*.rb", __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.before(:all) do
+    ZookeeperRunner.stop # ensure it's stopped
+    ZookeeperRunner.start
+    ZookeeperRunner.clean
+  end
+
+  config.after(:all) do
+    ZookeeperRunner.clean
+    ZookeeperRunner.stop
+  end
+
+  config.before do
+    ZookeeperRunner.clean
+  end
+end

data/spec/support/zookeeper_runner.rb

@@ -0,0 +1,36 @@
+class ZookeeperRunner
+  class << self
+
+    def start
+      system "zkServer start > /dev/null 2>&1"
+      wait_zookeeper_start
+    end
+
+    def stop
+      system "zkServer stop > /dev/null 2>&1"
+      wait_zookeeper_stop
+    end
+
+    def clean
+      ZK.open('localhost:2181') do |zk|
+        zk.rm_rf('/services')
+      end
+    end
+
+    protected
+
+    def wait_zookeeper_start
+      sleep 1 while zookeeper_pid == 0
+    end
+
+    def wait_zookeeper_stop
+      sleep 0.125 while zookeeper_pid > 0
+    end
+
+    def zookeeper_pid
+      `ps aux | grep zookeeper | grep java | grep -v grep | awk '{ print $2; }'`.to_i
+    end
+
+
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: zoo-service-discovery
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrew Druzhinin <andrey.druginin@gmail.com>
+- Ivan Kasatenko <sky@uniqsystems.ru>
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-23 00:00:00.000000000 Z
+dependencies: []
+description: ZooKeeper service discovery gem for your SOA environment.
+email: support@uniqsystems.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/zoo-service-discovery.rb
+- lib/zoo_service/discovery.rb
+- lib/zoo_service/publication.rb
+- spec/features/complex_discovery_spec.rb
+- spec/features/discovery_spec.rb
+- spec/spec_helper.rb
+- spec/support/zookeeper_runner.rb
+- README.md
+homepage: http://uniqsystems.ru/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: ZooKeeper service discovery gem
+test_files: []
+has_rdoc: