zk_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 367305f9db2180c442ee459fb4e04f4fb3acaf55
+  data.tar.gz: 78cacce7e7d0e816f5d53a1b68e64dc31652f327
+SHA512:
+  metadata.gz: 6f19f3acc2afd60742807cdcf1e267bcc7801603949b4a7120cc0c9e4be60fd7c205277425d0bcef4c71b79df1863c360ef39e96658e030b633a694174990d27
+  data.tar.gz: 438a242921e985e15e0c95022b874b37d5c9537805be1e25a16f49a6b1aba7a2a042996188efb951c9b7bc30b0b0f9453788f618680743815d93a5f88bf641bf

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Autodesk, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,216 @@
+# ZkClient
+
+A simple Zookeeper client used in the Mojo framework. This gem allows quick and simple access to a Zookeeper server.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zk_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zk_client
+
+## Usage
+
+#### How to configure your Zookeeper client
+
+By default ZkClient uses 'localhost:2181' as the Zookeeper server, and '/' as the root_path. More on that later. But if you want to point to a different zk server, or change the root_path, then you will have to 'configure' the Zookeeper Client.
+
+There are a few ways to configure the Zookeeper client (ZkClient).
+
+##### Using the config block and allowing ZkClient to parse a uri
+
+```ruby
+require 'zk_client'
+
+ZkClient.config do |zk|
+  zk.uri = 'my-zk-server.com:8000/application/path'
+end
+
+ZkClient.host
+#=> "my-zk-server.com"
+ZkClient.port
+#=> 8000
+ZkClient.root_path
+#=> "/application/path"
+ZkClient.uri
+#=> "my-zk-server.com:8000"
+
+```
+
+##### Using the config block and directly setting zk variables
+
+```ruby
+require 'zk_client'
+
+ZkClient.config do |zk|
+  zk.host = 'test.myexample.com'
+  zk.port = 9999
+  zk.root_path = '/new/application/path'
+end
+
+ZkClient.host
+#=> "test.myexample.com"
+ZkClient.port
+#=> 9999
+ZkClient.root_path
+#=> "/new/application/path"
+ZkClient.uri
+#=> "test.myexample.com:9999"
+
+```
+
+##### Using the ZkClient directly and setting zk variables
+
+```ruby
+require 'zk_client'
+
+ZkClient.host = 'test.myexample.com'
+ZkClient.port = 9999
+ZkClient.root_path = '/new/application/path'
+
+ZkClient.host
+#=> "test.myexample.com"
+ZkClient.port
+#=> 9999
+ZkClient.root_path
+#=> "/new/application/path"
+ZkClient.uri
+#=> "test.myexample.com:9999"
+
+```
+
+
+#### Interacting with a Zookeeper Server
+
+##### Reading data from an existing node
+
+```ruby
+require 'zk_client'
+
+# Assuming you have a node at the path '/mynode' with the data value of 'my data!'
+ZkClient.read('/mynode')
+#=> "my data!"
+
+```
+
+##### Reading data from node that doesn't exist
+
+```ruby
+require 'zk_client'
+
+ZkClient.read('/doesntexist')
+#=> nil
+
+```
+
+##### Sometimes you want to return the whole node with stats too
+
+```ruby
+require 'zk_client'
+
+ZkClient.read_node('/mynode')
+#=> {:req_id=>3, :rc=>0, :data=>"my data!", :stat=>#<Zookeeper::Stat:0x000000028569f0 @exists=true, @czxid=2, @mzxid=10665, @ctime=1425596120895, @mtime=1441087085411, @version=2, @cversion=3, @aversion=0, @ephemeralOwner=0, @dataLength=0, @numChildren=3, @pzxid=9621>}
+
+```
+
+##### Writing data
+
+```ruby
+require 'zk_client'
+
+ZkClient.write('/mynode', "This is my data")
+#=> {:req_id=>5, :rc=>0, :path=>"/mynode"} 
+ZkClient.read('/mynode')
+#=> "This is my data"
+```
+
+##### Deleting a node
+
+```ruby
+require 'zk_client'
+
+ZkClient.delete('/mynode')
+#=> {:req_id=>7, :rc=>0} 
+ZkClient.read_node('/mynode')
+#=> {:req_id=>9, :rc=>-101, :data=>nil, :stat=>#<Zookeeper::Stat:0x00000002803f70 @exists=false>}
+```
+
+##### Close connection to ZK
+
+```ruby
+require 'zk_client'
+
+ZkClient.client.connected?
+#=> true 
+ZkClient.close
+#=> nil
+ZkClient.client.connected?
+#=> false 
+
+```
+
+##### Access the underlying Zookeeper.new instance
+```ruby
+require 'zk_client'
+
+# Sometimes you might want to interact with the Zookeeper::Client directly.
+# To do that just call .client:
+raw_client = ZkClient.client
+#=> #<Zookeeper::Client:0x0000000280da70 @host="localhost:2181", @chroot_path="", 0x0000000280c198 @level=0,
+# ...
+# ...
+raw_client.class
+#=> Zookeeper::Client 
+
+```
+
+#### How Root Path works
+Depending on your Zookeeper server you might have nested nodes that stores your application data. It can be quite annoying writing the leading path when that doesn't change. Lets say you share Zookeeper server accross your organization, and you need to specify your department and application name. When you acccess your data, it might look something like this:
+
+```ruby
+require 'zk_client'
+
+ZkClient.root_path
+#=> "/"
+
+ZkClient.read('/org/department/application/my_data')
+#=> "This is my data!"
+
+```
+
+That's annoying. Any you might accidentally mess with other people's data  if you fat finger the application name. ZkClient allows you to configure a root path and use relative paths to access data:
+
+```ruby
+require 'zk_client'
+
+ZkClient.root_path = '/org/department/application'
+ZkClient.root_path
+#=> "/org/department/application"
+
+ZkClient.read('/my_data')
+#=> "This is my data!"
+
+# It will also append a leading '/' if you forget....
+ZkClient.read('my_data')
+#=> "This is my data!"
+
+```
+
+
+
+## Contributing
+
+1. Fork it ( https://git.autodesk.com/EIS-EA-MOJO/zk_client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zk_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/zk_client/version.rb

@@ -0,0 +1,3 @@
+module ZkClient
+  VERSION = "0.1.0"
+end

data/lib/zk_client/zk_client.rb

@@ -0,0 +1,112 @@
+require 'zookeeper'
+require 'json'
+require 'uri'
+
+
+module ZkClient
+  ROOT = '/'
+
+  class << self
+
+    def client
+      @@client ||= create_client
+    end
+
+    def read(path)
+      read_node(path)[:data]
+    end
+
+    def read_node(path)
+      key = process_path(path)
+      client.get(path: key)
+    end
+
+    def write(path, data)
+      key = process_path(path)
+      response = client.set(path: key, data: data)
+      if !response[:stat].exists
+        create(key, data)
+      else
+        response
+      end
+    end
+
+    def create(path, data)
+      key = process_path(path)
+      resp = client.create(path: key, data: data)
+    end
+
+    def delete(path)
+      key = process_path(path)
+      client.delete(path: key)
+    end
+
+    def close
+      client.close
+    end
+
+    def config
+      if block_given?
+        yield(self)
+      end
+    end
+
+    def root_path
+      @@root_path ||= ROOT
+    end
+
+    def root_path=(root)
+      @@root_path = root
+    end
+
+    def host
+      @@host ||= "localhost"
+    end
+
+    def host=(host)
+      @@host = host
+    end
+
+    def port
+      @@port ||= 2181
+    end
+
+    def port=(port)
+      @@port = port.to_i
+    end
+
+    def uri
+      "#{host}:#{port}"
+    end
+
+    def uri=(uri)
+      parsed_uri = URI(uri)
+
+      @@host      = parsed_uri.host
+      @@port      = parsed_uri.port
+      @@root_path = parsed_uri.path
+    end
+
+    # Backward compatibility
+    def root
+      root_path
+    end
+
+    private
+
+    def create_client
+      if defined?(@@client) && @@client.respond_to?(close)
+        @@client.close
+      end
+      Zookeeper.new(uri)
+    end
+
+    def process_path(path)
+      path = "/#{path}"            unless path.start_with?('/')
+      path = "#{root_path}#{path}" unless path.start_with?(root_path)
+
+      path
+    end
+
+  end # End class methods
+end

data/lib/zk_client.rb

@@ -0,0 +1,5 @@
+require "zk_client/version"
+require "zk_client/zk_client"
+
+module ZkClient
+end

data/zk_client.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zk_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zk_client"
+  spec.version       = ZkClient::VERSION
+  spec.authors       = ["John Thomas"]
+  spec.email         = ["john.thomas@autodesk.com"]
+
+  spec.summary       = "A simple Zookeeper client used in the Mojo framework."
+  spec.description   = %q{ This gem allows quick and simple access to a Zookeeper
+server.
+  }
+  spec.homepage      = "https://git.autodesk.com/EIS-EA-MOJO/zk_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  #spec.platform      = 'java'
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "zookeeper"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+end
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: zk_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Thomas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zookeeper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " This gem allows quick and simple access to a Zookeeper\nserver.\n  "
+email:
+- john.thomas@autodesk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zk_client.rb
+- lib/zk_client/version.rb
+- lib/zk_client/zk_client.rb
+- zk_client.gemspec
+homepage: https://git.autodesk.com/EIS-EA-MOJO/zk_client
+licenses:
+- MIT
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A simple Zookeeper client used in the Mojo framework.
+test_files: []