zk_service 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in zk_service.gemspec
+gemspec

data/README.md

@@ -0,0 +1,58 @@
+ZK Service
+=============
+
+zk_service is a small library which provides a service registry for Zookeeper.
+
+Servers
+--------------
+
+This library provides registration to zookeeper through a mixin.
+
+This connection can be set by calling,
+
+For example:
+
+    class SomeServer
+     include ZkService::Publisher
+    
+    def intialize
+      zk_service_Details( 'localhost', '2181', 'superservice' )
+      zk_publish("/some/service/path") #Creates an ephemeral node
+      #.....
+    end
+    
+    def close
+      #.....
+      zk_unpublish #explicitly removes the ephemeral node
+    end
+    
+Clients
+-----------
+
+Upon con requiring a connection to a specific service, a client will consult Zookeeper for the child znodes under '/envname/services/service_name'. These nodes will contain connection details.
+
+For example:
+
+    class SuperServiceVendor < ZkService::Vendor
+    
+      def initialize(host, port)
+        super(host, port)
+      end
+    
+    end
+
+Upon initialization, a child connection can be obtained by:
+
+    child_connection = SuperServiceVendorInstance.vend('superservice1')
+
+Connection details can be obtained by:
+
+    data = SuperServiceVendorInstance.get_data(child_connection)
+
+
+Issues
+------
+
+*Need to check for the existence of a Zookeeper ENV and grab the hostname and port number.
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/zk_service.rb

@@ -0,0 +1,131 @@
+require "zk_service/version"
+require 'zookeeper'
+require 'json'
+require 'yaml'
+
+module ZkService
+
+  def self.configure( h, p )
+    #config = YAML.env_config( "zookeeper" )
+    #hostkey  = config[:host] || "localhost"
+    #port = config[:port]     || "2181"
+    hostkey, port = h, p
+    zookeeper_server_addresses = []
+    zookeeper_server_addresses << "#{h}:#{p}"
+  end
+  
+  def self.check_namespaces(zookeeper_namespace)
+    zookeeper_namespace ||= "/"
+    if zookeeper_namespace && !zookeeper_namespace.start_with?("/")
+      raise InvalidZookeeperConfig.new("Zookeeper namespace should start with '/'")
+    end
+    zookeeper_namespace
+  end
+  
+  def self.create_connection(zookeeper_server_addresses)
+    begin
+      tryable = zookeeper_server_addresses.choice
+      Zookeeper.new( tryable )
+      # TODO: do not resque Exception or explain, why that is necessary
+      rescue Exception => e
+        zookeeper_server_addresses.shift
+        if zookeeper_server_addresses.empty?
+          raise NoAvailableZookeeper.new         # We're out of options.
+        else
+          create_connection(zookeeper_server_addresses) # We recurse to try again.
+        end
+    end
+  end
+
+  module Publisher
+    extend ZkService
+    
+    attr_reader :zk
+    attr_accessor :zookeeper_server_addresses,:zookeeper_namespace, :provider_path
+    
+    def zk_service_details(host, port, service_name)
+      @zookeeper_server_addresses ||= []
+      @provider_path ||= ""
+      @zookeeper_server_addresses = !@zookeeper_server_addresses.empty? || ZkService.configure( host, port )
+      @zk = ZkService.create_connection(@zookeeper_server_addresses)
+    
+      @zookeeper_namespace = ZkService.check_namespaces(@zookeeper_namespace)
+      @zookeeper_namespace += service_name
+    end
+        
+    def zk_path_exists(path)
+      path.nil?? false : @zk.stat(:path => path)[:stat].exists
+    end
+        
+    def zk_publish( data )
+      #register service if not already registered
+      if !zk_path_exists(@zookeeper_namespace)
+        response = @zk.create(:path => @zookeeper_namespace)
+        raise ZkServicePublisherError.new("ZK ERROR: Could not create #{service}'") if response[:rc] != Zookeeper::ZOK
+      end
+            
+      path = @zookeeper_namespace + '/provider-'
+      response = (!zk_path_exists(path)) ? @zk.create(:path => path, :data => data.to_json, :sequence => true, :ephemeral => true) : false
+      raise ZkServicePublisherError.new("ZK ERROR: Could not publish path '#{path}'") if response[:rc] != Zookeeper::ZOK
+
+      @provider_path = response[:path]
+      response
+    end
+
+    def zk_unpublish
+      @zk.delete(:path => @provider_path)
+      raise ZkServicePublisherError.new("ZK ERROR: Could not unpublish from path '#{@provider_path}'") if zk_path_exists(@provider_path)
+    end
+    
+    def zk_reset_host( host, port )
+      @zookeeper_server_addresses = []
+      @zookeeper_server_addresses << "#{host}:#{port}"
+    end
+  end
+  
+  class Vendor
+    include ZkService
+    
+    attr_reader :base_details, :zk
+    attr_accessor :zookeeper_server_addresses,:zookeeper_namespace
+    
+    def initialize( host , port )
+      @zookeeper_server_addresses ||= []
+      @zookeeper_namespace ||= "/"
+      @zookeeper_server_addresses << "#{host}:#{port}"
+    end
+    
+    def zk_path_exists(path)
+      path.nil?? false : @zk.stat(:path => path)[:stat].exists
+    end
+    
+    #return a child ephemeral node
+    def vend(service_name)
+      @zk = ZkService.create_connection(@zookeeper_server_addresses)      
+      @service_path = @zookeeper_namespace + service_name 
+
+      if zk_path_exists(@service_path)
+        response = @zk.get_children(:path => @service_path)
+        if !response[:children].nil?
+          response[:children].choice
+        else
+          raise ZkServiceVendorError.new("ZK ERROR: No nodes under #{@service_path}'") 
+        end 
+      else
+        raise ZkServiceVendorError.new("ZK ERROR: Could not find #{@service_path}'") 
+      end
+    end
+    
+    def get_data(child_path)
+      #need better error handling
+      return false if @service_path.empty?
+      path = @service_path + "/" + child_path
+      @zk.get(:path => path )[:data] 
+    end
+  end
+  
+  class NoAvailableZookeeper < StandardError ; end
+  class ZkServicePublisherError < StandardError ; end    
+  class ZkServiceVendorError < StandardError ; end    
+  class InvalidZookeeperConfig < StandardError ; end  
+end

data/lib/zk_service/version.rb

@@ -0,0 +1,3 @@
+module ZkService
+  VERSION = "0.0.1"
+end

data/test/test_zk_service.rb

@@ -0,0 +1,90 @@
+require 'rubygems'
+require 'rspec'
+
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(File.join(dir, '..', 'lib'))
+$LOAD_PATH.unshift(dir)
+require 'zk_service'
+
+describe "ZK Service Publisher" do
+  before :all do
+    class SomeServer
+      include ZkService::Publisher
+
+      def initialize
+        zk_service_details('localhost', '2181', 'superservice1')
+      end
+      
+      def publish(data)
+        zk_publish(data)
+      end
+      
+      def close; zk_unpublish; end
+      
+      def path_exists(path); zk_path_exists(path); end
+      
+      def get_zk; @zk; end
+      
+      def reset_host(host,port); zk_reset_host(host,port); end
+      
+      def connect_again
+        ZkService.create_connection(@zookeeper_server_addresses)
+      end
+    end
+    @zk_server = SomeServer.new
+  end
+  
+  it "updates zk service details" do
+    @zk_server.zookeeper_namespace.should == "/superservice1"
+    @zk_server.zookeeper_server_addresses.should == ["localhost:2181"]
+  end
+  
+  it "can publish its configs to zookeeper" do
+    @zk_server.publish({:hostname => 'awesome', :port => '99', :version => "3"})
+    children = @zk_server.get_zk.get_children(:path => '/superservice1')[:children]
+    children.any? { |w| w.include? 'provider-' }.should be true
+  end
+  
+  it "connects and registers the service directory" do
+    @zk_server.path_exists('/superservice1').should == true
+  end
+  
+  it "can remove its configs from zookeeper and reconnects" do
+    @zk_server.close
+    @zk_server.path_exists(@zk_server.provider_path).should == false  
+    @zk_server.publish({:hostname => 'awesome', :port => '99', :version => "3"})  
+  end
+  
+  it "with the incorrect host, error gracefully" do
+    @zk_server.reset_host("incorrect_hostname",'84886')
+    lambda { @zk_server.connect_again }.should raise_error(ZkService::NoAvailableZookeeper)
+  end
+end
+
+describe "ZK Service Vendor" do
+  before :all do    
+    class SuperServiceVendor < ZkService::Vendor
+      def initialize(host, port)
+        super(host, port)
+      end
+    end
+    @zk_client = SuperServiceVendor.new('localhost','2181')
+  end
+   
+  it "connects and retrieves connection details from a child" do
+    child_connection = @zk_client.vend('superservice1')
+    (child_connection.include? 'provider-').should be true
+  end
+  
+  it "connects and retrieves connection details from a child" do
+    child_connection = @zk_client.vend('superservice1')
+    data = @zk_client.get_data(child_connection)
+    config_details = JSON.parse(data)
+    config_details["port"].should == "99"
+    config_details["hostname"].should == "awesome"
+  end  
+  
+  it "cant find the service" do
+    lambda { @zk_client.vend('superservice2131231') }.should raise_error(ZkService::Vendor::ZkServiceVendorError)
+  end
+end

data/zk_service.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "zk_service/version"
+
+Gem::Specification.new do |s|
+  s.name        = "zk_service"
+  s.version     = "0.0.1"
+  s.authors     = ["Susheel Khamkar"]
+  s.email       = ["susheel@crowdflower.com"]
+  s.homepage    = ""
+  s.summary     = %q{ZK Service}
+  s.description = %q{This is a small library which provides a service registry for Zookeeper.}
+
+  s.rubyforge_project = "zk_service"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency "zookeeper"
+  s.add_dependency "json"
+  s.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: zk_service
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Susheel Khamkar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: zookeeper
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: This is a small library which provides a service registry for Zookeeper.
+email: 
+- susheel@crowdflower.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- README.md
+- Rakefile
+- lib/zk_service.rb
+- lib/zk_service/version.rb
+- test/test_zk_service.rb
+- zk_service.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: zk_service
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: ZK Service
+test_files: 
+- test/test_zk_service.rb