zookeeper 0.3.2 → 0.4.0

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.4.0. More attr-readers (StarvingMarvin) and 1.9 compatibility (tsuraan)
+
 v0.3.2. Handle close, closed connections and expired sessions a little more gracefully.
 
 v0.3.1. ACL bugfix.

data/Manifest

@@ -1,7 +1,9 @@
 CHANGELOG
 LICENSE
+Manifest
 README
 Rakefile
+examples/cloud_config.rb
 ext/extconf.rb
 ext/zkc-3.3.1.tar.gz
 ext/zookeeper_c.c
@@ -13,4 +15,9 @@ lib/zookeeper/callbacks.rb
 lib/zookeeper/constants.rb
 lib/zookeeper/exceptions.rb
 lib/zookeeper/stat.rb
-Manifest
+test/test_basic.rb
+test/test_callback1.rb
+test/test_close.rb
+test/test_esoteric.rb
+test/test_watcher1.rb
+test/test_watcher2.rb

data/examples/cloud_config.rb

@@ -0,0 +1,125 @@
+require "rubygems"
+require "zookeeper"
+
+# A basic cloud-based YAML config library.  Ruby Zookeeper client example.
+#
+# If you pass in a file as 'zk:/foo.yml/blah' it will go out to zookeeper. 
+# Otherwise the file is assumed to be local.  The yml file will get parsed
+# and cached locally, and keys after the .yml get interpreted as keys into
+# the YAML.
+#
+# e.g. get(zk:/config/service.yml/key1/key2/key3..) => 
+#   zk.get(:path => /config/service.yml)
+#   yaml <= YAML.parse(data)
+#   yaml[key1][key2][key3]...
+#
+# If keys are unspecified, it returns the parsed YAML as one big object
+#
+# TODO if staleness is set to 0, read in YAML immediately before next
+# get(...)
+
+class CloudConfig
+  class NodeNotFound < StandardError; end
+  class BadPathError < StandardError; end
+
+  DEFAULT_SERVERS = "localhost:2181"
+
+  def initialize(zkservers = DEFAULT_SERVERS, staleness = 15)  # maximum allowed staleness in seconds
+    @staleness = staleness
+    @lock      = Mutex.new
+    @zkservers = DEFAULT_SERVERS
+    
+    # cache
+    @data      = {}
+    @zkcb      = Zookeeper::WatcherCallback.new { dirty_callback(@zkcb.context) }
+    @zk        = nil
+  end
+
+  def get(node)
+    filename, keys = extract_filename(node)
+
+    # read(filename) is potentially a zk call, so do not hold the lock during the read
+    if @lock.synchronize { !@data.has_key?(filename) }
+      d = YAML.load(read(filename))
+      @lock.synchronize { @data[filename] = d }
+    end
+    
+    # synchronized b/c we potentially have a background thread updating data nodes from zk
+    # if keys is empty, return the whole file, otherwise roll up the keys
+    @lock.synchronize {
+      keys.empty? ? @data[filename] : keys.inject(@data[filename]) { |hash, key| hash[key] }
+    }
+  end
+
+  # todo:
+  #   factor get-and-watch into a different subsystem (so you can have
+  #   polling stat() ops on local filesystem.)
+  def read(yaml)
+    # read yaml file and register watcher.  if watcher fires, set up
+    # background thread to do read and update data.
+    if yaml.match(/^zk:/)
+      @zk ||= init_zk
+      yaml = yaml['zk:'.length..-1] # strip off zk: from zk:/config/path.yml
+      resp = get_and_register(yaml)
+
+      if resp[:rc] != Zookeeper::ZOK
+        @zk.unregister_watcher(resp[:req_id])
+        raise NodeNotFound
+      end
+      
+      resp[:data]
+    else
+      raise NodeNotFound unless File.exists?(yaml)
+      File.read(yaml)
+    end
+  end
+
+  def extract_filename(node)
+    path_elements = node.split("/")
+    
+    yamlindex = path_elements.map{ |x| x.match("\.yml$") != nil }.index(true)
+    raise BadPathError unless yamlindex
+    
+    yamlname = path_elements[0..yamlindex].join '/'
+    yamlkeys = path_elements[(yamlindex+1)..-1]
+    
+    return yamlname, yamlkeys
+  end
+    
+ private
+  def init_zk
+    Zookeeper.new(@zkservers)
+  end
+  
+  def get_and_register(znode)
+    @zk.get(:path => znode, :watcher => @zkcb,
+                   :watcher_context => { :path => znode,
+                                         :wait => rand(@staleness) })
+  end
+  
+  def dirty_callback(context)
+    path = context[:path]
+    wait = context[:wait]
+
+    # Fire off a background update that waits a randomized period of time up
+    # to @staleness seconds.
+    Thread.new do
+      sleep wait
+      background_update(path)
+    end
+  end
+
+  def background_update(zkpath)
+    # do a synchronous get/register a new watcher
+    resp = get_and_register(zkpath)
+    if resp[:rc] != Zookeeper::ZOK
+      # puts "Unable to read #{zkpath} from Zookeeper!"  @logger.error
+      zk.unregister_watcher(resp[:req_id])
+    else
+      # puts "Updating data."
+      d = YAML.load(resp[:data])
+      @lock.synchronize { @data["zk:#{zkpath}"] = d }
+    end
+  end
+end
+

data/ext/zookeeper_c.c

@@ -75,7 +75,7 @@ static VALUE method_init(VALUE self, VALUE hostPort) {
 
   zk_local_ctx->zh = 
       zookeeper_init(
-          RSTRING(hostPort)->ptr,
+          RSTRING_PTR(hostPort),
           zkrb_state_callback,
           10000,
           &zk_local_ctx->myid,
@@ -127,19 +127,19 @@ static VALUE method_get_children(VALUE self, VALUE reqid, VALUE path, VALUE asyn
   int rc;
   switch (call_type) {
     case SYNC:
-      rc = zoo_get_children2(zk->zh, RSTRING(path)->ptr, 0, &strings, &stat);
+      rc = zoo_get_children2(zk->zh, RSTRING_PTR(path), 0, &strings, &stat);
       break;
 
     case SYNC_WATCH:
-      rc = zoo_wget_children2(zk->zh, RSTRING(path)->ptr, zkrb_state_callback, watch_ctx, &strings, &stat);
+      rc = zoo_wget_children2(zk->zh, RSTRING_PTR(path), zkrb_state_callback, watch_ctx, &strings, &stat);
       break;
       
     case ASYNC:
-      rc = zoo_aget_children2(zk->zh, RSTRING(path)->ptr, 0, zkrb_strings_stat_callback, data_ctx);
+      rc = zoo_aget_children2(zk->zh, RSTRING_PTR(path), 0, zkrb_strings_stat_callback, data_ctx);
       break;
       
     case ASYNC_WATCH:
-      rc = zoo_awget_children2(zk->zh, RSTRING(path)->ptr, zkrb_state_callback, watch_ctx, zkrb_strings_stat_callback, data_ctx);
+      rc = zoo_awget_children2(zk->zh, RSTRING_PTR(path), zkrb_state_callback, watch_ctx, zkrb_strings_stat_callback, data_ctx);
       break;
   }
 
@@ -160,19 +160,19 @@ static VALUE method_exists(VALUE self, VALUE reqid, VALUE path, VALUE async, VAL
   int rc;
   switch (call_type) {
     case SYNC:
-      rc = zoo_exists(zk->zh, RSTRING(path)->ptr, 0, &stat);
+      rc = zoo_exists(zk->zh, RSTRING_PTR(path), 0, &stat);
       break;
 
     case SYNC_WATCH:
-      rc = zoo_wexists(zk->zh, RSTRING(path)->ptr, zkrb_state_callback, watch_ctx, &stat);
+      rc = zoo_wexists(zk->zh, RSTRING_PTR(path), zkrb_state_callback, watch_ctx, &stat);
       break;
       
     case ASYNC:
-      rc = zoo_aexists(zk->zh, RSTRING(path)->ptr, 0, zkrb_stat_callback, data_ctx);
+      rc = zoo_aexists(zk->zh, RSTRING_PTR(path), 0, zkrb_stat_callback, data_ctx);
       break;
       
     case ASYNC_WATCH:
-      rc = zoo_awexists(zk->zh, RSTRING(path)->ptr, zkrb_state_callback, watch_ctx, zkrb_stat_callback, data_ctx);
+      rc = zoo_awexists(zk->zh, RSTRING_PTR(path), zkrb_state_callback, watch_ctx, zkrb_stat_callback, data_ctx);
       break;
   }
 
@@ -191,8 +191,8 @@ static VALUE method_create(VALUE self, VALUE reqid, VALUE path, VALUE data, VALU
   struct Stat stat;
   if (data != Qnil) Check_Type(data, T_STRING);
   Check_Type(flags, T_FIXNUM);
-  const char *data_ptr = (data == Qnil) ? NULL : RSTRING(data)->ptr;
-  size_t      data_len = (data == Qnil) ? -1   : RSTRING(data)->len;
+  const char *data_ptr = (data == Qnil) ? NULL : RSTRING_PTR(data);
+  size_t      data_len = (data == Qnil) ? -1   : RSTRING_LEN(data);
   
   struct ACL_vector *aclptr = NULL;
   if (acls != Qnil) { aclptr = zkrb_ruby_to_aclvector(acls); }
@@ -201,11 +201,11 @@ static VALUE method_create(VALUE self, VALUE reqid, VALUE path, VALUE data, VALU
   int rc;
   switch (call_type) {
     case SYNC:
-      rc = zoo_create(zk->zh, RSTRING(path)->ptr, data_ptr, data_len, aclptr, FIX2INT(flags), realpath, sizeof(realpath));
+      rc = zoo_create(zk->zh, RSTRING_PTR(path), data_ptr, data_len, aclptr, FIX2INT(flags), realpath, sizeof(realpath));
       if (aclptr != NULL) deallocate_ACL_vector(aclptr);
       break;
     case ASYNC:
-      rc = zoo_acreate(zk->zh, RSTRING(path)->ptr, data_ptr, data_len, aclptr, FIX2INT(flags), zkrb_string_callback, data_ctx);
+      rc = zoo_acreate(zk->zh, RSTRING_PTR(path), data_ptr, data_len, aclptr, FIX2INT(flags), zkrb_string_callback, data_ctx);
       if (aclptr != NULL) deallocate_ACL_vector(aclptr);
       break;
     default:
@@ -230,10 +230,10 @@ static VALUE method_delete(VALUE self, VALUE reqid, VALUE path, VALUE version, V
   int rc = 0;
   switch (call_type) {
     case SYNC:
-      rc = zoo_delete(zk->zh, RSTRING(path)->ptr, FIX2INT(version));
+      rc = zoo_delete(zk->zh, RSTRING_PTR(path), FIX2INT(version));
       break;
     case ASYNC:
-      rc = zoo_adelete(zk->zh, RSTRING(path)->ptr, FIX2INT(version), zkrb_void_callback, data_ctx);
+      rc = zoo_adelete(zk->zh, RSTRING_PTR(path), FIX2INT(version), zkrb_void_callback, data_ctx);
       break;
     default:
       /* TODO(wickman) raise proper argument error */
@@ -258,19 +258,19 @@ static VALUE method_get(VALUE self, VALUE reqid, VALUE path, VALUE async, VALUE
   
   switch (call_type) {
     case SYNC:
-      rc = zoo_get(zk->zh, RSTRING(path)->ptr, 0, data, &data_len, &stat);
+      rc = zoo_get(zk->zh, RSTRING_PTR(path), 0, data, &data_len, &stat);
       break;
 
     case SYNC_WATCH:
-      rc = zoo_wget(zk->zh, RSTRING(path)->ptr, zkrb_state_callback, watch_ctx, data, &data_len, &stat);
+      rc = zoo_wget(zk->zh, RSTRING_PTR(path), zkrb_state_callback, watch_ctx, data, &data_len, &stat);
       break;
       
     case ASYNC:
-      rc = zoo_aget(zk->zh, RSTRING(path)->ptr, 0, zkrb_data_callback, data_ctx);
+      rc = zoo_aget(zk->zh, RSTRING_PTR(path), 0, zkrb_data_callback, data_ctx);
       break;
       
     case ASYNC_WATCH:
-      rc = zoo_awget(zk->zh, RSTRING(path)->ptr, zkrb_state_callback, watch_ctx, zkrb_data_callback, data_ctx);
+      rc = zoo_awget(zk->zh, RSTRING_PTR(path), zkrb_state_callback, watch_ctx, zkrb_data_callback, data_ctx);
       break;
   }
 
@@ -291,16 +291,16 @@ static VALUE method_set(VALUE self, VALUE reqid, VALUE path, VALUE data, VALUE a
   
   struct Stat stat;
   if (data != Qnil) Check_Type(data, T_STRING);
-  const char *data_ptr = (data == Qnil) ? NULL : RSTRING(data)->ptr;
-  size_t      data_len = (data == Qnil) ? -1   : RSTRING(data)->len;
+  const char *data_ptr = (data == Qnil) ? NULL : RSTRING_PTR(data);
+  size_t      data_len = (data == Qnil) ? -1   : RSTRING_LEN(data);
 
   int rc;
   switch (call_type) {
     case SYNC:
-      rc = zoo_set2(zk->zh, RSTRING(path)->ptr, data_ptr, data_len, FIX2INT(version), &stat);
+      rc = zoo_set2(zk->zh, RSTRING_PTR(path), data_ptr, data_len, FIX2INT(version), &stat);
       break;
     case ASYNC:
-      rc = zoo_aset(zk->zh, RSTRING(path)->ptr, data_ptr, data_len, FIX2INT(version),
+      rc = zoo_aset(zk->zh, RSTRING_PTR(path), data_ptr, data_len, FIX2INT(version),
                             zkrb_stat_callback, data_ctx);
       break;
     default:
@@ -325,11 +325,11 @@ static VALUE method_set_acl(VALUE self, VALUE reqid, VALUE path, VALUE acls, VAL
   int rc;
   switch (call_type) {
     case SYNC:
-      rc = zoo_set_acl(zk->zh, RSTRING(path)->ptr, FIX2INT(version), aclptr);
+      rc = zoo_set_acl(zk->zh, RSTRING_PTR(path), FIX2INT(version), aclptr);
       deallocate_ACL_vector(aclptr);
       break;
     case ASYNC:
-      rc = zoo_aset_acl(zk->zh, RSTRING(path)->ptr, FIX2INT(version), aclptr, zkrb_void_callback, data_ctx);
+      rc = zoo_aset_acl(zk->zh, RSTRING_PTR(path), FIX2INT(version), aclptr, zkrb_void_callback, data_ctx);
       deallocate_ACL_vector(aclptr);
       break;
     default:
@@ -351,10 +351,10 @@ static VALUE method_get_acl(VALUE self, VALUE reqid, VALUE path, VALUE async) {
   int rc;
   switch (call_type) {
     case SYNC:
-      rc = zoo_get_acl(zk->zh, RSTRING(path)->ptr, &acls, &stat);
+      rc = zoo_get_acl(zk->zh, RSTRING_PTR(path), &acls, &stat);
       break;
     case ASYNC:
-      rc = zoo_aget_acl(zk->zh, RSTRING(path)->ptr, zkrb_acl_callback, data_ctx);
+      rc = zoo_aget_acl(zk->zh, RSTRING_PTR(path), zkrb_acl_callback, data_ctx);
       break;
     default:
       /* TODO(wickman) raise proper argument error */

data/ext/zookeeper_lib.c

@@ -411,7 +411,7 @@ struct ACL_vector * zkrb_ruby_to_aclvector(VALUE acl_ary) {
   Check_Type(acl_ary, T_ARRAY);
 
   struct ACL_vector *v = malloc(sizeof(struct ACL_vector));
-  allocate_ACL_vector(v, RARRAY(acl_ary)->len);
+  allocate_ACL_vector(v, RARRAY_LEN(acl_ary));
 
   int k;
   for (k = 0; k < v->count; ++k) {
@@ -442,17 +442,17 @@ struct Id zkrb_ruby_to_id(VALUE rubyid) {
   VALUE ident  = rb_iv_get(rubyid, "@id");
   
   if (scheme != Qnil) {
-    id.scheme = malloc(RSTRING(scheme)->len + 1);
-    strncpy(id.scheme, RSTRING(scheme)->ptr, RSTRING(scheme)->len);
-    id.scheme[RSTRING(scheme)->len] = '\0';
+    id.scheme = malloc(RSTRING_LEN(scheme) + 1);
+    strncpy(id.scheme, RSTRING_PTR(scheme), RSTRING_LEN(scheme));
+    id.scheme[RSTRING_LEN(scheme)] = '\0';
   } else {
     id.scheme = NULL;
   }
 
   if (ident != Qnil) {
-    id.id     = malloc(RSTRING(ident)->len + 1);
-    strncpy(id.id, RSTRING(ident)->ptr, RSTRING(ident)->len);
-    id.id[RSTRING(ident)->len] = '\0';
+    id.id     = malloc(RSTRING_LEN(ident) + 1);
+    strncpy(id.id, RSTRING_PTR(ident), RSTRING_LEN(ident));
+    id.id[RSTRING_LEN(ident)] = '\0';
   } else {
     id.id = NULL;
   }

data/ext/zookeeper_lib.h

@@ -11,6 +11,16 @@
 #define ZK_FALSE 0
 #define ZKRB_GLOBAL_REQ -1
 
+#ifndef RSTRING_LEN
+# define RSTRING_LEN(x) RSTRING(x)->len
+#endif
+#ifndef RSTRING_PTR
+# define RSTRING_PTR(x) RSTRING(x)->ptr
+#endif
+#ifndef RARRAY_LEN
+# define RARRAY_LEN(x) RARRAY(x)->len
+#endif
+
 extern int ZKRBDebugging;
 
 struct zkrb_data_completion {

data/lib/zookeeper/stat.rb

@@ -1,6 +1,6 @@
 module ZookeeperStat
   class Stat
-    attr_reader :version, :exists
+    attr_reader :version, :exists, :czxid, :mzxid, :ctime, :mtime, :cverzion, :aversion, :ephemeralOwner, :dataLength, :numChildren, :pzxid
     def initialize(val)
       @exists = !!val
       @czxid, @mzxid, @ctime, @mtime, @version, @cversion, @aversion,

data/zookeeper.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{zookeeper}
-  s.version = "0.3.2"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Phillip Pearson, Eric Maland, Evan Weaver, Brian Wickman"]
-  s.date = %q{2010-08-17}
+  s.date = %q{2010-12-01}
   s.description = %q{An interface to the Zookeeper distributed configuration server.}
   s.email = %q{}
   s.extensions = ["ext/extconf.rb"]
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "ext/zookeeper_c.c", "lib/zookeeper.rb"]
-  s.files = ["CHANGELOG", "LICENSE", "README", "Rakefile", "ext/extconf.rb", "ext/zkc-3.3.1.tar.gz", "ext/zookeeper_c.c", "ext/zookeeper_lib.c", "ext/zookeeper_lib.h", "lib/zookeeper.rb", "lib/zookeeper/acls.rb", "lib/zookeeper/callbacks.rb", "lib/zookeeper/constants.rb", "lib/zookeeper/exceptions.rb", "lib/zookeeper/stat.rb", "Manifest", "zookeeper.gemspec", "test/test_basic.rb", "test/test_callback1.rb", "test/test_close.rb", "test/test_esoteric.rb", "test/test_watcher1.rb", "test/test_watcher2.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "README", "Rakefile", "examples/cloud_config.rb", "ext/extconf.rb", "ext/zkc-3.3.1.tar.gz", "ext/zookeeper_c.c", "ext/zookeeper_lib.c", "ext/zookeeper_lib.h", "lib/zookeeper.rb", "lib/zookeeper/acls.rb", "lib/zookeeper/callbacks.rb", "lib/zookeeper/constants.rb", "lib/zookeeper/exceptions.rb", "lib/zookeeper/stat.rb", "test/test_basic.rb", "test/test_callback1.rb", "test/test_close.rb", "test/test_esoteric.rb", "test/test_watcher1.rb", "test/test_watcher2.rb", "Manifest", "zookeeper.gemspec"]
   s.homepage = %q{http://blog.evanweaver.com/files/doc/fauna/zookeeper/}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Zookeeper", "--main", "README"]
   s.require_paths = ["lib", "ext"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zookeeper
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Phillip Pearson, Eric Maland, Evan Weaver, Brian Wickman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-17 00:00:00 -07:00
+date: 2010-12-01 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -36,6 +36,7 @@ files:
 - LICENSE
 - README
 - Rakefile
+- examples/cloud_config.rb
 - ext/extconf.rb
 - ext/zkc-3.3.1.tar.gz
 - ext/zookeeper_c.c
@@ -47,14 +48,14 @@ files:
 - lib/zookeeper/constants.rb
 - lib/zookeeper/exceptions.rb
 - lib/zookeeper/stat.rb
-- Manifest
-- zookeeper.gemspec
 - test/test_basic.rb
 - test/test_callback1.rb
 - test/test_close.rb
 - test/test_esoteric.rb
 - test/test_watcher1.rb
 - test/test_watcher2.rb
+- Manifest
+- zookeeper.gemspec
 has_rdoc: true
 homepage: http://blog.evanweaver.com/files/doc/fauna/zookeeper/
 licenses: []