zookeeper 0.9.4 → 1.0.0.beta.1

data/java/{zookeeper_base.rb → java_base.rb}

@@ -8,16 +8,19 @@ gem 'slyphon-zookeeper_jar', '= 3.3.5'
 require 'log4j'
 require 'zookeeper_jar'
 
+
+# XXX: reindent this WHOLE FILE later
+module Zookeeper
+
 # The low-level wrapper-specific methods for the Java lib,
 # subclassed by the top-level Zookeeper class
-class ZookeeperBase
+class JavaBase
   include Java
-  include ZookeeperCommon
-  include ZookeeperConstants
-  include ZookeeperCallbacks
-  include ZookeeperExceptions
-  include ZookeeperACLs
-  include ZookeeperStat
+  include Zookeeper::Common
+  include Zookeeper::Constants
+  include Zookeeper::Callbacks
+  include Zookeeper::Exceptions
+  include Zookeeper::ACLs
 
   JZK   = org.apache.zookeeper
   JZKD  = org.apache.zookeeper.data
@@ -26,8 +29,6 @@ class ZookeeperBase
   ANY_VERSION = -1
   DEFAULT_SESSION_TIMEOUT = 10_000
 
-  ZKRB_GLOBAL_CB_REQ = -1 unless defined?(ZKRB_GLOBAL_CB_REQ)
-
   JZKD::Stat.class_eval do
     MEMBERS = [:version, :czxid, :mzxid, :ctime, :mtime, :cversion, :aversion, :ephemeralOwner, :dataLength, :numChildren, :pzxid]
     def to_hash
@@ -43,7 +44,7 @@ class ZookeeperBase
 
   JZKD::ACL.class_eval do
     def self.from_ruby_acl(acl)
-      raise TypeError, "acl must be a ZookeeperACLs::ACL not #{acl.inspect}" unless acl.kind_of?(ZookeeperACLs::ACL)
+      raise TypeError, "acl must be a Zookeeper::ACLs::ACL not #{acl.inspect}" unless acl.kind_of?(Zookeeper::ACLs::ACL)
       id = org.apache.zookeeper.data.Id.new(acl.id.scheme.to_s, acl.id.id.to_s)
       new(acl.perms.to_i, id)
     end
@@ -158,7 +159,7 @@ class ZookeeperBase
 
       def initialize(event_queue)
         @event_queue = event_queue
-        super(ZookeeperBase::ZKRB_GLOBAL_CB_REQ)
+        super(Zookeeper::Constants::ZKRB_GLOBAL_CB_REQ)
       end
 
       def process(event)
@@ -473,5 +474,5 @@ class ZookeeperBase
       orig_jzk.close if orig_jzk
     end
 end
-
+end
 

data/lib/zookeeper.rb

@@ -5,23 +5,27 @@ require 'monitor'
 require 'forwardable'
 require 'logger'
 
-require 'zookeeper/common'
-require 'zookeeper/constants'
-require 'zookeeper/callbacks'
-require 'zookeeper/exceptions'
-require 'zookeeper/stat'
-require 'zookeeper/acls'
+require 'backports'
 
-
-if defined?(::JRUBY_VERSION)
-  $LOAD_PATH.unshift(File.expand_path('../java', File.dirname(__FILE__))).uniq!
-else
-  $LOAD_PATH.unshift(File.expand_path('../ext', File.dirname(__FILE__))).uniq!
+module Zookeeper
+  # establishes the namespace
 end
 
-require 'zookeeper_base'
+require_relative 'zookeeper/acls'
+require_relative 'zookeeper/constants'
+require_relative 'zookeeper/exceptions'
+require_relative 'zookeeper/common'
+require_relative 'zookeeper/callbacks'
+require_relative 'zookeeper/stat'
+require_relative 'zookeeper/client_methods'
+
+# ok, now we construct the client
+
+require_relative 'zookeeper/client'
+
+module Zookeeper
+  include Constants
 
-class Zookeeper < ZookeeperBase
   unless defined?(@@logger)
     @@logger = Logger.new($stderr).tap { |l| l.level = Logger::ERROR } 
   end
@@ -34,167 +38,20 @@ class Zookeeper < ZookeeperBase
     @@logger = logger
   end
 
-  def reopen(timeout=10, watcher=nil)
-    warn "WARN: ZookeeperBase#reopen watcher argument is now ignored" if watcher
-    super
-  end
-
-  def initialize(host, timeout=10, watcher=nil)
-    super
-  end
-
-  def get(options = {})
-    assert_open
-    assert_supported_keys(options, [:path, :watcher, :watcher_context, :callback, :callback_context])
-    assert_required_keys(options, [:path])
-
-    req_id = setup_call(:get, options)
-    rc, value, stat = super(req_id, options[:path], options[:callback], options[:watcher])
-
-    rv = { :req_id => req_id, :rc => rc }
-    options[:callback] ? rv : rv.merge(:data => value, :stat => Stat.new(stat))
-  end
-
-  def set(options = {})
-    assert_open
-    assert_supported_keys(options, [:path, :data, :version, :callback, :callback_context])
-    assert_required_keys(options, [:path])
-    assert_valid_data_size!(options[:data])
-    options[:version] ||= -1
-
-    req_id = setup_call(:set, options)
-    rc, stat = super(req_id, options[:path], options[:data], options[:callback], options[:version])
-
-    rv = { :req_id => req_id, :rc => rc }
-    options[:callback] ? rv : rv.merge(:stat => Stat.new(stat))
-  end
-
-  def get_children(options = {})
-    assert_open
-    assert_supported_keys(options, [:path, :callback, :callback_context, :watcher, :watcher_context])
-    assert_required_keys(options, [:path])
-
-    req_id = setup_call(:get_children, options)
-    rc, children, stat = super(req_id, options[:path], options[:callback], options[:watcher])
-
-    rv = { :req_id => req_id, :rc => rc }
-    options[:callback] ? rv : rv.merge(:children => children, :stat => Stat.new(stat))
-  end
-
-  def stat(options = {})
-    assert_open
-    assert_supported_keys(options, [:path, :callback, :callback_context, :watcher, :watcher_context])
-    assert_required_keys(options, [:path])
-
-    req_id = setup_call(:stat, options)
-    rc, stat = exists(req_id, options[:path], options[:callback], options[:watcher])
-
-    rv = { :req_id => req_id, :rc => rc }
-    options[:callback] ? rv : rv.merge(:stat => Stat.new(stat))
-  end
-
-  def create(options = {})
-    assert_open
-    assert_supported_keys(options, [:path, :data, :acl, :ephemeral, :sequence, :callback, :callback_context])
-    assert_required_keys(options, [:path])
-    assert_valid_data_size!(options[:data])
-
-    flags = 0
-    flags |= ZOO_EPHEMERAL if options[:ephemeral]
-    flags |= ZOO_SEQUENCE if options[:sequence]
-
-    options[:acl] ||= ZOO_OPEN_ACL_UNSAFE
-
-    req_id = setup_call(:create, options)
-    rc, newpath = super(req_id, options[:path], options[:data], options[:callback], options[:acl], flags)
-
-    rv = { :req_id => req_id, :rc => rc }
-    options[:callback] ? rv : rv.merge(:path => newpath)
-  end
-
-  def delete(options = {})
-    assert_open
-    assert_supported_keys(options, [:path, :version, :callback, :callback_context])
-    assert_required_keys(options, [:path])
-    options[:version] ||= -1
-
-    req_id = setup_call(:delete, options)
-    rc = super(req_id, options[:path], options[:version], options[:callback])
-
-    { :req_id => req_id, :rc => rc }
-  end
-
-  # this method is *only* asynchronous
-  #
-  # @note There is a discrepancy between the zkc and java versions. zkc takes
-  #   a string_callback_t, java takes a VoidCallback. You should most likely use
-  #   the ZookeeperCallbacks::VoidCallback and not rely on the string value.
-  #
-  def sync(options = {})
-    assert_open
-    assert_supported_keys(options, [:path, :callback, :callback_context])
-    assert_required_keys(options, [:path, :callback])
-
-    req_id = setup_call(:sync, options)
-
-    rc = super(req_id, options[:path]) # we don't pass options[:callback] here as this method is *always* async
-
-    { :req_id => req_id, :rc => rc }
-  end
-
-  def set_acl(options = {})
-    assert_open
-    assert_supported_keys(options, [:path, :acl, :version, :callback, :callback_context])
-    assert_required_keys(options, [:path, :acl])
-    options[:version] ||= -1
-
-    req_id = setup_call(:set_acl, options)
-    rc = super(req_id, options[:path], options[:acl], options[:callback], options[:version])
-
-    { :req_id => req_id, :rc => rc }
-  end
-
-  def get_acl(options = {})
-    assert_open
-    assert_supported_keys(options, [:path, :callback, :callback_context])
-    assert_required_keys(options, [:path])
-
-    req_id = setup_call(:get_acl, options)
-    rc, acls, stat = super(req_id, options[:path], options[:callback])
-
-    rv = { :req_id => req_id, :rc => rc }
-    options[:callback] ? rv : rv.merge(:acl => acls, :stat => Stat.new(stat))
-  end
-
-  # close this client and any underyling connections
-  def close
-    super
-  end
-
-  def state
-    super
-  end
-
-  def connected?
-    super
+  # @private
+  def self.deprecation_warnings?
+    @deprecation_warnings = true if @deprecation_warnings.nil?
   end
 
-  def connecting?
-    super
+  # set this to false to mute Zookeeper related deprecation warnings...
+  # __AT YOUR PERIL__
+  def self.deprecation_warnings=(v)
+    @deprecation_warnings = v
   end
 
-  def associating?
-    super
-  end
-  
-  # There are some operations that are dangerous in the context of the event
-  # dispatch thread (because they would block further event delivery). This
-  # method allows clients to know if they're currently executing in the context of an
-  # event.
-  #
-  # @returns [true,false] true if the current thread is the event dispatch thread
-  def event_dispatch_thread?
-    super
+  # @private
+  def self.deprecation_warning(warning)
+    Kernel.warn(warning) if deprecation_warnings?
   end
 
   # for expert use only. set the underlying debug level for the C layer, has no
@@ -202,14 +59,14 @@ class Zookeeper < ZookeeperBase
   #
   # @private
   def self.set_debug_level(val)
-    if defined?(::CZookeeper)
+    if defined?(CZookeeper)
       CZookeeper.set_debug_level(val.to_i)
     end
   end
 
   # @private
   def self.get_debug_level
-    if defined?(::CZookeeper)
+    if defined?(CZookeeper)
       CZookeeper.get_debug_level
     end
   end
@@ -221,77 +78,8 @@ class Zookeeper < ZookeeperBase
     # @private
     alias :debug_level :get_debug_level
   end
-
-  # DEPRECATED: use the class-level method instead
-  def set_debug_level(val)
-    super
-  end
-
-  # has the underlying connection been closed?
-  def closed?
-    super
-  end
-
-  # is the event delivery system running?
-  def running?
-    super
-  end
-
-  # return the session id of the current connection as an Fixnum
-  def session_id
-    super
-  end
-
-  # Return the passwd portion of this connection's credentials as a String
-  def session_passwd
-    super
-  end
-
-protected
-  # used during shutdown, awaken the event delivery thread if it's blocked
-  # waiting for the next event
-  def wake_event_loop!
-    super
-  end
-  
-  # starts the event delivery subsystem going. after calling this method, running? will be true
-  def setup_dispatch_thread!
-    super
-  end
-
-  # TODO: describe what this does
-  def get_default_global_watcher
-    super
-  end
-
-  def logger
-    Zookeeper.logger
-  end
-
-  def assert_valid_data_size!(data)
-    return if data.nil?
-
-    data = data.to_s
-    if data.length >= 1048576 # one megabyte 
-      raise ZookeeperException::DataTooLargeException, "data must be smaller than 1 MiB, your data starts with: #{data[0..32].inspect}"
-    end
-    nil
-  end
-
-private
-  # TODO: Sanitize user mistakes by unregistering watchers from ops that
-  # don't return ZOK (except wexists)?  Make users clean up after themselves for now.
-  #
-  # XXX: is this dead code?
-  def unregister_watcher(req_id)
-    @mutex.synchronize {
-      @watcher_reqs.delete(req_id)
-    }
-  end
-  
-  # must be supplied by parent class impl.
-  def assert_open
-    super
-  end
 end
 
+# just for first test, get rid of this soon
+require_relative 'zookeeper/compatibility'
+

data/lib/zookeeper/acls.rb

@@ -1,4 +1,5 @@
-module ZookeeperACLs
+module Zookeeper
+module ACLs
   class Id
     attr_reader :scheme, :id
     def initialize(hash)
@@ -24,17 +25,20 @@ module ZookeeperACLs
     end
   end
   
-  ZOO_PERM_READ   = 0
-  ZOO_PERM_WRITE  = 1
-  ZOO_PERM_CREATE = 2
-  ZOO_PERM_DELETE = 4
-  ZOO_PERM_ADMIN  = 8
-  ZOO_PERM_ALL    = ZOO_PERM_READ | ZOO_PERM_WRITE | ZOO_PERM_CREATE | ZOO_PERM_DELETE | ZOO_PERM_ADMIN
-  
-  ZOO_ANYONE_ID_UNSAFE = Id.new(:scheme => "world", :id => "anyone")
-  ZOO_AUTH_IDS         = Id.new(:scheme => "auth", :id => "")
+  module Constants
+    ZOO_PERM_READ   = 0
+    ZOO_PERM_WRITE  = 1
+    ZOO_PERM_CREATE = 2
+    ZOO_PERM_DELETE = 4
+    ZOO_PERM_ADMIN  = 8
+    ZOO_PERM_ALL    = ZOO_PERM_READ | ZOO_PERM_WRITE | ZOO_PERM_CREATE | ZOO_PERM_DELETE | ZOO_PERM_ADMIN
+    
+    ZOO_ANYONE_ID_UNSAFE = Id.new(:scheme => "world", :id => "anyone")
+    ZOO_AUTH_IDS         = Id.new(:scheme => "auth", :id => "")
 
-  ZOO_OPEN_ACL_UNSAFE  = [ACL.new(:perms => ZOO_PERM_ALL,  :id => ZOO_ANYONE_ID_UNSAFE)]
-  ZOO_READ_ACL_UNSAFE  = [ACL.new(:perms => ZOO_PERM_READ, :id => ZOO_ANYONE_ID_UNSAFE)]
-  ZOO_CREATOR_ALL_ACL  = [ACL.new(:perms => ZOO_PERM_ALL,  :id => ZOO_AUTH_IDS)]
+    ZOO_OPEN_ACL_UNSAFE  = [ACL.new(:perms => ZOO_PERM_ALL,  :id => ZOO_ANYONE_ID_UNSAFE)]
+    ZOO_READ_ACL_UNSAFE  = [ACL.new(:perms => ZOO_PERM_READ, :id => ZOO_ANYONE_ID_UNSAFE)]
+    ZOO_CREATOR_ALL_ACL  = [ACL.new(:perms => ZOO_PERM_ALL,  :id => ZOO_AUTH_IDS)]
+  end
+end
 end

data/lib/zookeeper/callbacks.rb

@@ -1,7 +1,24 @@
-module ZookeeperCallbacks
-  class Callback
+module Zookeeper
+module Callbacks
+  class Base
     attr_reader :proc, :completed, :context
 
+    # allows for easier construction of a user callback block that will be
+    # called with the callback object itself as an argument. 
+    #
+    # @example
+    #   
+    #   Base.create do |cb|
+    #     puts "watcher callback called with argument: #{cb.inspect}"
+    #   end
+    #
+    #   "watcher callback called with argument: #<Zookeeper::Callbacks::Base:0x1018a3958 @state=3, @type=1, ...>"
+    #
+    #
+    def self.create
+      cb_inst = new { yield cb_inst }
+    end
+
     def initialize
       @completed = false
       @proc = Proc.new do |hash|
@@ -12,7 +29,6 @@ module ZookeeperCallbacks
     end
     
     def call(*args)
-      # puts "call passed #{args.inspect}"
       @proc.call(*args)
     end
     
@@ -24,8 +40,8 @@ module ZookeeperCallbacks
       @context = nil
     end
   end
-  
-  class WatcherCallback < Callback
+
+  class WatcherCallback < Base
     ## wexists, awexists, wget, awget, wget_children, awget_children
     attr_reader :type, :state, :path
     
@@ -34,7 +50,7 @@ module ZookeeperCallbacks
     end
   end
 
-  class DataCallback < Callback
+  class DataCallback < Base
     ## aget, awget
     attr_reader :return_code, :data, :stat
 
@@ -43,7 +59,7 @@ module ZookeeperCallbacks
     end
   end
 
-  class StringCallback < Callback
+  class StringCallback < Base
     ## acreate, async
     attr_reader :return_code, :string, :context
 
@@ -54,7 +70,7 @@ module ZookeeperCallbacks
     end
   end
 
-  class StringsCallback < Callback
+  class StringsCallback < Base
     ## aget_children, awget_children
     attr_reader :return_code, :children, :stat
 
@@ -63,7 +79,7 @@ module ZookeeperCallbacks
     end
   end
 
-  class StatCallback < Callback
+  class StatCallback < Base
     ## aset, aexists, awexists
     attr_reader :return_code, :stat
 
@@ -72,7 +88,7 @@ module ZookeeperCallbacks
     end
   end
 
-  class VoidCallback < Callback
+  class VoidCallback < Base
     ## adelete, aset_acl, add_auth
     attr_reader :return_code
     
@@ -81,7 +97,7 @@ module ZookeeperCallbacks
     end
   end
 
-  class ACLCallback < Callback
+  class ACLCallback < Base
     ## aget_acl
     attr_reader :return_code, :acl, :stat
     def initialize_context(hash)
@@ -89,3 +105,4 @@ module ZookeeperCallbacks
     end
   end
 end
+end