etcd 0.0.4 → 0.0.5

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+html/

data/Rakefile

@@ -6,5 +6,5 @@ RSpec::Core::RakeTask.new("spec")
 
 RDoc::Task.new do |rdoc|
   rdoc.main = "README.rdoc"
-  rdoc.rdoc_files.include("README.rdoc", "lib   /*.rb")
+  rdoc.rdoc_files.include("lib   /*.rb")
 end

data/lib/etcd/client.rb

@@ -37,26 +37,38 @@ module Etcd
       end
     end
 
+    # Currently use 'v1' as version for etcd store
     def version_prefix
       '/v1'
     end
 
+    # Lists all machines in the cluster
     def machines
-      api_execute( version_prefix + '/machines', :get).split(",")
+      api_execute( version_prefix + '/machines', :get).split(",").map(&:strip)
     end
 
+    # Get the current leader in a cluster
     def leader
       api_execute( version_prefix + '/leader', :get)
     end
 
+    # Lists all the data (keys, dir etc) present in etcd store
     def key_endpoint
       version_prefix + '/keys'
     end
 
+    # Watches all keys and notifies if anyone changes
     def watch_endpoint
       version_prefix + '/watch'
     end
 
+    # Set a new value for key if previous value of key is matched
+    #
+    # This method takes following parameters as argument
+    # * key       - whose value is going to change if previous value is matched
+    # * value     - new value to be set for specified key
+    # * prevValue - value of a key to compare with existing value of key
+    # * ttl       - shelf life of a key (in secsonds) (optional)
     def test_and_set(key, value, prevValue, ttl = nil)
       path  = key_endpoint + key
       payload = {'value' => value, 'prevValue' => prevValue }
@@ -65,6 +77,12 @@ module Etcd
       json2obj(response)
     end
 
+    # Adds a new key with specified value and ttl, overwrites old values if exists
+    #
+    # This method has following parameters as argument
+    # * key   - whose value to be set
+    # * value - value to be set for specified key
+    # * ttl   - shelf life of a key (in secsonds) (optional)
     def set(key, value, ttl=nil)
       path  = key_endpoint + key
       payload = {'value' => value}
@@ -73,17 +91,29 @@ module Etcd
       json2obj(response)
     end
 
-
+    # Deletes a key along with all associated data
+    #
+    # This method has following parameters as argument
+    # * key - key to be deleted
     def delete(key)
       response = api_execute(key_endpoint + key, :delete)
       json2obj(response)
     end
 
+    # Retrives a key with its associated data, if key is not present it will return with message "Key Not Found"
+    #
+    # This method has following parameters as argument
+    # * key - whose data to be retrive
     def get(key)
       response = api_execute(key_endpoint + key, :get)
       json2obj(response)
     end
 
+    # Gives a notification when specified key changes
+    #
+    # This method has following parameters as argument
+    # * key   - key to be watched
+    # * index - etcd server index of specified key (optional)
     def watch(key, index=nil)
       response = if index.nil?
                     api_execute(watch_endpoint + key, :get)
@@ -93,6 +123,12 @@ module Etcd
       json2obj(response)
     end
 
+    # This method sends api request to etcd server.
+    #
+    # This method has following parameters as argument
+    # * path    - etcd server path (etcd server end point)
+    # * method  - the request method used
+    # * params  - any additional parameters used by request method (optional)
     def api_execute(path, method, params=nil)
 
       http = if path=~/^http/

data/lib/etcd/version.rb

@@ -1,3 +1,3 @@
 module Etcd
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: etcd
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
+  prerelease: 
 platform: ruby
 authors:
 - Ranjib Dey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-26 00:00:00.000000000 Z
+date: 2013-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-log
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -76,6 +86,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -83,6 +94,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -90,6 +102,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -97,6 +110,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -104,6 +118,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -144,26 +159,33 @@ files:
 homepage: https://github.com/ranjib/etcd-ruby
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -924240572325429270
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -924240572325429270
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Ruby client library for etcd
 test_files:
 - spec/functional/client_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MzNhZWZiNTA1ZjAzOTQ0ZjQ4YjUzOTIyZTZiNjEwZGVkZWJkYzllZg==
-  data.tar.gz: !binary |-
-    Y2ZlOTY4YTcxYTNkNzRhZGRhZDBlNzRlYWUyNjk2Y2VmMzBjYWFmYg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    YTU1YjdhMmVhNTM1ZWFlOTc3ZmQwN2ZlNDM2N2EyNTI0ZTVjN2FkNTljMzc2
-    ODZhYjdiNTU4YmE3NGE0NjdiY2M2MDhhM2VmNWEzZTQ0OTBmMjViYmI3MWVj
-    MTkxZjI1YWM4NTU5OWUzMmRiYmY5MzcyNzg0YzljN2Y2OWQ5Njg=
-  data.tar.gz: !binary |-
-    NjJlNWY1NjQyNmQ0YmU1Y2M1ZTkxYTY3NzRhOTc3Mjc0ODUxODYxOGE2NGY0
-    NDE3ZWFkZjMzMGFlNzZhYWIyZTRhMTE5NDUyMjZkNWE3Y2Y4MTI4NzQ4YmRh
-    ZGM0MGRlNDM5ZGQ4MzNkN2JhNmEzMTVhN2QzNWNhNjY1NjkyZWM=