etcd 0.2.0.alpha → 0.2.0.beta.1

data/lib/etcd/node.rb

@@ -1,15 +1,16 @@
 # Encoding: utf-8
 
 module Etcd
+  # This class represents an etcd node
   class Node
-
     include Comparable
 
     attr_reader :created_index, :modified_index, :expiration, :ttl, :key, :value
-    alias :createdIndex :created_index
-    alias :modifiedIndex :modified_index
+    alias_method :createdIndex, :created_index
+    alias_method :modifiedIndex, :modified_index
 
-    def initialize(opts={})
+    # rubocop:disable MethodLength
+    def initialize(opts = {})
       @created_index = opts['createdIndex']
       @modified_index = opts['modifiedIndex']
       @ttl = opts['ttl']
@@ -18,7 +19,7 @@ module Etcd
       @expiration = opts['expiration']
       @dir = opts['dir']
 
-      if opts['dir'] and (!!opts['nodes'])
+      if opts['dir'] && (!!opts['nodes'])
         opts['nodes'].each do |data|
           children << Node.new(data)
         end
@@ -33,7 +34,7 @@ module Etcd
       if directory?
         @children ||= []
       else
-        raise "This is not a directory, cant have children"
+        fail 'This is not a directory, cant have children'
       end
     end
 

data/lib/etcd/response.rb

@@ -2,18 +2,18 @@
 
 require 'etcd/node'
 require 'json'
+require 'forwardable'
 
 module Etcd
-
+  # manage http responses
   class Response
-
     extend Forwardable
 
     attr_reader :action, :node, :etcd_index, :raft_index, :raft_term
 
     def_delegators :@node, :key, :value, :directory?, :children
 
-    def initialize(opts, headers={})
+    def initialize(opts, headers = {})
       @action = opts['action']
       @node = Node.new(opts['node'])
       @etcd_index = headers[:etcd_index]
@@ -23,11 +23,11 @@ module Etcd
 
     def self.from_http_response(response)
       data = JSON.parse(response.body)
-      headers = Hash.new
+      headers = {}
       headers[:etcd_index] = response['X-Etcd-Index'].to_i
       headers[:raft_index] = response['X-Raft-Index'].to_i
       headers[:raft_term] = response['X-Raft-Term'].to_i
-      response = Response.new(data, headers)
+      Response.new(data, headers)
     end
   end
 end

data/lib/etcd/stats.rb

@@ -3,8 +3,8 @@
 require 'json'
 
 module Etcd
+  # Support stats
   module Stats
-
     def stats_endpoint
       version_prefix + '/stats'
     end
@@ -12,13 +12,13 @@ module Etcd
     def stats(type)
       case type
       when :leader
-        JSON.parse(api_execute(stats_endpoint+'/leader', :get).body)
+        JSON.parse(api_execute(stats_endpoint + '/leader', :get).body)
       when :store
-        JSON.parse(api_execute(stats_endpoint+'/store', :get).body)
+        JSON.parse(api_execute(stats_endpoint + '/store', :get).body)
       when :self
-        JSON.parse(api_execute(stats_endpoint+'/self', :get).body)
+        JSON.parse(api_execute(stats_endpoint + '/self', :get).body)
       else
-        raise ArgumentError, "Invalid stats type '#{type}'"
+        fail ArgumentError, "Invalid stats type '#{type}'"
       end
     end
   end

data/lib/etcd/version.rb

@@ -1,5 +1,5 @@
 # Encoding: utf-8
-
+# Version const
 module Etcd
-  VERSION = "0.2.0.alpha"
+  VERSION = '0.2.0.beta.1'
 end

data/spec/etcd/basic_auth_client_spec.rb

@@ -0,0 +1,27 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+
+describe 'Etcd basic auth client' do
+
+  let(:client) do
+    Etcd.client(user_name: 'test', password: 'pwd')
+  end
+
+  it '#user_name' do
+    expect(client.user_name).to eq('test')
+  end
+
+  it '#password' do
+    expect(client.password).to eq('pwd')
+  end
+
+  it 'should set basic auth' do
+    Net::HTTPRequest.any_instance.should_receive(:basic_auth).with('test', 'pwd')
+    key = random_key
+    value = uuid.generate
+    client.set(key, value: value)
+    sleep 1
+    expect(read_only_client.get(key).value).to eq(value)
+  end
+end

data/spec/etcd/client_spec.rb

@@ -15,7 +15,7 @@ describe Etcd::Client do
   end
 
   it '#version' do
-    expect(client.version).to match(/^etcd v0\.2\./)
+    expect(client.version).to match(/^etcd v?0\.\d+\.\d+(\+git)?/)
   end
 
   it '#version_prefix' do
@@ -29,14 +29,22 @@ describe Etcd::Client do
       end.to raise_error
     end
 
-    it 'should redirect api request when allo_redirect is set'
+    it 'should redirect api request when allow_redirect is set' do
+      key = random_key
+      value = uuid.generate
+      rd_client = Etcd.client host: 'localhost', port: 4003
+      resp = rd_client.set(key, value: value)
+      resp.node.key.should eql key
+      resp.node.value.should eql value
+      client.get(key).value.should eql resp.value
+    end
   end
 
   context '#http header based metadata' do
     before(:all) do
       key = random_key
       value = uuid.generate
-      @response = Etcd.client.set(key,value)
+      @response = Etcd.client.set(key, value: value)
     end
 
     it '#etcd_index' do

data/spec/etcd/keys_spec.rb

@@ -9,18 +9,60 @@ describe Etcd::Keys do
   it '#set/#get' do
     key = random_key
     value = uuid.generate
-    client.set(key, value)
+    client.set(key, value: value)
     expect(client.get(key).value).to eq(value)
   end
 
   context '#exists?' do
     it 'should be true for existing keys' do
       key = random_key
-      client.create(key, 10)
+      client.create(key, value: 10)
       expect(client.exists?(key)).to be_true
     end
     it 'should be true for existing keys' do
       expect(client.exists?(random_key)).to be_false
     end
   end
+
+  context 'directory' do
+    it 'should be able to create a directory' do
+      d = random_key
+      client.create(d, dir: true)
+      expect(client.get(d)).to be_true
+    end
+    context 'empty' do
+      it 'should be able to delete with dir flag' do
+        d = random_key
+        client.create(d, dir: true)
+        expect(client.delete(d, dir: true)).to be_true
+      end
+
+      it 'should not be able to delete without dir flag' do
+        d = random_key
+        client.create(d, dir: true)
+        client.create("#{d}/foobar", value: 10)
+        expect do
+          client.delete(d)
+        end.to raise_error(Etcd::NotFile)
+      end
+    end
+    context 'not empty' do
+      it 'should be able to delete with recursive flag' do
+        d = random_key
+        client.create(d, dir: true)
+        client.create("#{d}/foobar")
+        expect do
+          client.delete(d, dir: true, recursive: true)
+        end.to_not raise_error
+      end
+      it 'should be not able to delete without recursive flag' do
+        d = random_key
+        client.create(d, dir: true)
+        client.create("#{d}/foobar")
+        expect do
+          client.delete(d, dir: true)
+        end.to raise_error(Etcd::DirNotEmpty)
+      end
+    end
+  end
 end

data/spec/etcd/lock_spec.rb

@@ -10,7 +10,7 @@ describe 'lock' do
 
   it 'should be able to acquire a lock' do
     expect do
-      client.acquire_lock('/my_lock',10)
+      client.acquire_lock('/my_lock', 10)
     end.to_not raise_error
   end
 
@@ -23,7 +23,7 @@ describe 'lock' do
 
   it 'should be able to renew a lock based on index' do
     client.acquire_lock('/my_lock2', 10)
-    index = client.get_lock('/my_lock2', field:'index')
+    index = client.get_lock('/my_lock2', field: 'index')
     expect do
       client.renew_lock('/my_lock2', 10, index: index)
     end.to_not raise_error
@@ -38,7 +38,7 @@ describe 'lock' do
 
   it 'should be able to delete a lock based on index' do
     client.acquire_lock('/my_lock4', 10)
-    index = client.get_lock('/my_lock4', field:'index')
+    index = client.get_lock('/my_lock4', field: 'index')
     expect do
       client.delete_lock('/my_lock4', index: index)
     end.to_not raise_error

data/spec/etcd/node_spec.rb

@@ -6,19 +6,19 @@ describe Etcd::Node do
     Etcd.client
   end
 
-  it "should create a directory with parent key when nested keys are set" do
+  it 'should create a directory with parent key when nested keys are set' do
     parent = random_key
     child = random_key
     value = uuid.generate
-    client.set(parent+child, value)
-    expect(client.get(parent+child)).to_not be_directory
+    client.set(parent + child, value: value)
+    expect(client.get(parent + child)).to_not be_directory
     expect(client.get(parent)).to be_directory
   end
 
   context '#children' do
     it 'should raise exception when invoked against a leaf node' do
       parent = random_key
-      client.create(random_key, 10)
+      client.create(random_key, value: 10)
       expect do
         client.get(random_key).children
       end.to raise_error

data/spec/etcd/read_only_client_spec.rb

@@ -2,32 +2,31 @@
 
 require 'spec_helper'
 
-describe "Etcd read only client" do
+describe 'Etcd read only client' do
 
   let(:client) do
     Etcd.client
   end
 
-  it "should not allow write" do
-    key= random_key
-    expect{
-      read_only_client.set(key, uuid.generate)
-    }.to raise_error(Net::HTTPRetriableError)
+  it 'should not allow write' do
+    key = random_key
+    expect do
+      read_only_client.set(key, value: uuid.generate)
+    end.to raise_error(Net::HTTPRetriableError)
   end
 
-  it "should allow reads" do
+  it 'should allow reads' do
     key = random_key
     value = uuid.generate
-    client.set(key, value)
+    client.set(key, value: value)
     sleep 1
     expect(read_only_client.get(key).value).to eq(value)
   end
 
-  it "should allow watch" do
+  it 'should allow watch' do
     key = random_key
     value = uuid.generate
-    index = client.set(key, value).node.modified_index
+    index = client.set(key, value: value).node.modified_index
     expect(read_only_client.watch(key, index: index).value).to eq(value)
   end
 end
-

data/spec/etcd/readme_spec.rb

@@ -53,10 +53,9 @@ describe 'Etcd specs for the main etcd README examples' do
   end
 
   context 'set a key named "/message"' do
-    
 
     before(:all) do
-     @response = Etcd.client.set('/message', 'PinkFloyd')
+     @response = Etcd.client.set('/message', value: 'PinkFloyd')
     end
 
     it_should_behave_like 'response with valid http headers'
@@ -70,7 +69,7 @@ describe 'Etcd specs for the main etcd README examples' do
   context 'get a key named "/message"' do
 
     before(:all) do
-      Etcd.client.set('/message', 'PinkFloyd')
+      Etcd.client.set('/message', value: 'PinkFloyd')
       @response = Etcd.client.get('/message')
     end
 
@@ -85,8 +84,8 @@ describe 'Etcd specs for the main etcd README examples' do
   context 'change the value of a key named "/message"' do
 
     before(:all) do
-      Etcd.client.set('/message', 'World')
-      @response = Etcd.client.set('/message','PinkFloyd')
+      Etcd.client.set('/message', value: 'World')
+      @response = Etcd.client.set('/message', value: 'PinkFloyd')
     end
 
     it_should_behave_like 'response with valid http headers'
@@ -100,8 +99,8 @@ describe 'Etcd specs for the main etcd README examples' do
   context 'delete a key named "/message"' do
 
     before(:all) do
-      Etcd.client.set('/message', 'World')
-      Etcd.client.set('/message','PinkFloyd')
+      Etcd.client.set('/message', value: 'World')
+      Etcd.client.set('/message', value: 'PinkFloyd')
       @response = Etcd.client.delete('/message')
     end
 
@@ -116,9 +115,9 @@ describe 'Etcd specs for the main etcd README examples' do
   context 'using ttl a key named "/message"' do
 
     before(:all) do
-      Etcd.client.set('/message', 'World')
+      Etcd.client.set('/message', value: 'World')
       @set_time = Time.now
-      @response = Etcd.client.set('/message','PinkFloyd', 5)
+      @response = Etcd.client.set('/message', value: 'PinkFloyd', ttl: 5)
     end
 
     it_should_behave_like 'response with valid http headers'
@@ -148,11 +147,11 @@ describe 'Etcd specs for the main etcd README examples' do
   context 'waiting for a change against a key named "/message"' do
 
     before(:all) do
-      Etcd.client.set('/message', 'foo')
+      Etcd.client.set('/message', value: 'foo')
       thr = Thread.new do
         @response = Etcd.client.watch('/message')
       end
-      Etcd.client.set('/message', 'PinkFloyd')
+      Etcd.client.set('/message', value: 'PinkFloyd')
       thr.join
     end
 
@@ -164,7 +163,7 @@ describe 'Etcd specs for the main etcd README examples' do
     end
 
     it 'should get the exact value by specifying a waitIndex' do
-      client.set('/message', 'someshit')
+      client.set('/message', value: 'someshit')
       w_response = client.watch('/message', index: @response.node.modified_index)
       expect(w_response.node.value).to eq('PinkFloyd')
     end
@@ -173,7 +172,7 @@ describe 'Etcd specs for the main etcd README examples' do
   context 'atomic in-order keys' do
 
     before(:all) do
-      @response = Etcd.client.create_in_order('/queue', 'PinkFloyd')
+      @response = Etcd.client.create_in_order('/queue', value: 'PinkFloyd')
     end
 
     it_should_behave_like 'response with valid http headers'
@@ -188,8 +187,8 @@ describe 'Etcd specs for the main etcd README examples' do
     end
 
     it 'should have the child keys as monotonically increasing' do
-      first_response = client.create_in_order('/queue', 'The Jimi Hendrix Experience')
-      second_response = client.create_in_order('/queue', 'The Doors')
+      first_response = client.create_in_order('/queue', value: 'The Jimi Hendrix Experience')
+      second_response = client.create_in_order('/queue', value: 'The Doors')
       first_key = first_response.key.split('/').last.to_i
       second_key = second_response.key.split('/').last.to_i
       expect(first_key).to be < second_key
@@ -198,12 +197,12 @@ describe 'Etcd specs for the main etcd README examples' do
     it 'should enlist all children in sorted manner' do
       responses = []
       10.times do |n|
-        responses << client.create_in_order('/queue', 'Deep Purple - Track #{n}')
+        responses << client.create_in_order('/queue', value: 'Deep Purple - Track #{n}')
       end
       directory = client.get('/queue', sorted: true)
       past_index = directory.children.index(responses.first.node)
       9.times do |n|
-        current_index = directory.children.index(responses[n+1].node)
+        current_index = directory.children.index(responses[n + 1].node)
         expect(current_index).to be > past_index
         past_index = current_index
       end
@@ -230,18 +229,18 @@ describe 'Etcd specs for the main etcd README examples' do
 
     it 'will throw error if updated without setting prevExist' do
       expect do
-        client.set('/directory', dir:true, ttl:5)
+        client.set('/directory', dir: true, ttl: 5)
       end.to raise_error
     end
 
     it 'can be updated by setting  prevExist to true' do
-      client.set('/directory', prevExist: true, dir:true, ttl:5)
+      client.set('/directory', prevExist: true, dir: true, ttl: 5)
       expect(client.get('/directory').node.ttl).to eq(5)
     end
 
     it 'watchers should get expriy notification' do
-      client.set('/directory/a', 'Test')
-      client.set('/directory', prevExist: true, dir:true, ttl:2)
+      client.set('/directory/a', value: 'Test')
+      client.set('/directory', prevExist: true, dir: true, ttl: 2)
       response = client.watch('/directory/a', consistent: true, timeout: 3)
       expect(response.action).to eq('expire')
     end
@@ -256,37 +255,37 @@ describe 'Etcd specs for the main etcd README examples' do
   context 'atomic compare and swap' do
 
     it 'should  raise error if prevExist is passed a false' do
-      client.set('/foo', 'one')
+      client.set('/foo', value: 'one')
       expect do
-        client.set('/foo','three', prevExist: false)
+        client.set('/foo', value: 'three',  prevExist: false)
       end.to raise_error
     end
 
     it 'should raise error is prevValue is wrong' do
-      client.set('/foo', 'one')
+      client.set('/foo', value: 'one')
       expect do
-        client.set('/foo','three', prevValue: 'two')
+        client.set('/foo', value: 'three', prevValue: 'two')
       end.to raise_error
     end
 
     it 'should allow setting the value when prevValue is right' do
-      client.set('/foo', 'one')
-      expect(client.set('/foo','three', prevValue: 'one').value).to eq('three')
+      client.set('/foo', value: 'one')
+      expect(client.set('/foo', value: 'three', prevValue: 'one').value).to eq('three')
     end
   end
   context 'directory manipulation' do
     it 'should allow creating directory' do
-      expect(client.set('/dir',dir:true)).to be_directory
+      expect(client.set('/dir', dir: true)).to be_directory
     end
 
     it 'should allow listing directory' do
-      client.set('/foo_dir/foo','bar')
+      client.set('/foo_dir/foo', value: 'bar')
       expect(client.get('/').children.map(&:key)).to include('/foo_dir')
     end
 
     it 'should allow recursive directory listing' do
       response = client.get('/', recursive: true)
-      expect(response.children.find{|n|n.key=='/foo_dir'}.children).to_not be_empty
+      expect(response.children.find { |n|n.key == '/foo_dir' }.children).to_not be_empty
     end
 
     it 'should be able to delete empty directory without the recusrive flag' do
@@ -301,8 +300,8 @@ describe 'Etcd specs for the main etcd README examples' do
   context 'hidden nodes' do
 
     before(:all) do
-      Etcd.client.set('/_message', 'Hello Hidden World')
-      Etcd.client.set('/message', 'Hello World')
+      Etcd.client.set('/_message', value: 'Hello Hidden World')
+      Etcd.client.set('/message', value: 'Hello World')
     end
 
     it 'should not be visible in directory listing' do