etcd 0.0.5 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b268d252f6591fe8015fcf257369ec0502d62b2
+  data.tar.gz: 0b2567328a06ca5f6433948c7431ee7c4bb4a2d8
+SHA512:
+  metadata.gz: 9925238076f679e9983358c87f24d53e4f95726bfdea41f06aae831277f5126a99c956997848489c31ed0b228a8605a9f0b5c30fad323bbeca06e3564379f273
+  data.tar.gz: b65c505cbad680da0cf1967f750408986c69cf17c0d781b21a218a3706afaf069dd10b13b3c7a0d9bbf394cb3b163e5237d7a1c2b5424d549da809f17455586d

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 html/
+etcd

data/.travis.yml

@@ -1,4 +1,5 @@
 before_install: 
+  - sudo apt-get update -y
   - sudo add-apt-repository ppa:duh/golang -y
   - sudo apt-get update -y
   - sudo apt-get install golang -y

data/lib/etcd/client.rb

@@ -17,7 +17,7 @@ module Etcd
     include Etcd::Helpers
     include Etcd::Lockable
 
-    attr_reader :host, :port, :http, :allow_redirect
+    attr_reader :host, :port, :http, :allow_redirect, :use_ssl, :verify_mode
 
     ##
     # Creates a new instance of Etcd::Client. It accepts a hash +opts+ as argument
@@ -25,21 +25,20 @@ module Etcd
     # @param [Hash] opts The options for new Etcd::Client object
     # @opts [String] :host IP address of the etcd server (default is '127.0.0.1')
     # @opts [Fixnum] :port Port number of the etcd server (default is 4001)
+    # @opts [Fixnum] :read_timeout Set default HTTP read timeout for all api calls (default is 60)
 
     def initialize(opts={})
       @host = opts[:host] || '127.0.0.1'
       @port = opts[:port] || 4001
       @read_timeout = opts[:read_timeout] || 60
-      if opts.has_key?(:allow_redirect)
-        @allow_redirect = opts[:allow_redirect]
-      else
-        @allow_redirect = true
-      end
+      @allow_redirect = opts.has_key?(:allow_redirect) ? opts[:allow_redirect] : true
+      @use_ssl = opts[:use_ssl] || false
+      @verify_mode = opts[:verify_mode] || OpenSSL::SSL::VERIFY_PEER
     end
 
-    # Currently use 'v1' as version for etcd store
+    # Currently use 'v2' as version for etcd store
     def version_prefix
-      '/v1'
+      '/v2'
     end
 
     # Lists all machines in the cluster
@@ -73,7 +72,24 @@ module Etcd
       path  = key_endpoint + key
       payload = {'value' => value, 'prevValue' => prevValue }
       payload['ttl'] = ttl unless ttl.nil?
-      response = api_execute(path, :post, payload)
+      response = api_execute(path, :put, params: payload)
+      json2obj(response)
+    end
+
+
+    def create(key, value, ttl = nil)
+      path  = key_endpoint + key
+      payload = {value: value, prevExist: false }
+      payload['ttl'] = ttl unless ttl.nil?
+      response = api_execute(path, :put, params: payload)
+      json2obj(response)
+    end
+
+    def update(key, value, ttl = nil)
+      path  = key_endpoint + key
+      payload = {value: value, prevExist: true }
+      payload['ttl'] = ttl unless ttl.nil?
+      response = api_execute(path, :put, params: payload)
       json2obj(response)
     end
 
@@ -87,7 +103,7 @@ module Etcd
       path  = key_endpoint + key
       payload = {'value' => value}
       payload['ttl'] = ttl unless ttl.nil?
-      response = api_execute(path, :post, payload)
+      response = api_execute(path, :put, params: payload)
       json2obj(response)
     end
 
@@ -95,8 +111,8 @@ module Etcd
     #
     # This method has following parameters as argument
     # * key - key to be deleted
-    def delete(key)
-      response = api_execute(key_endpoint + key, :delete)
+    def delete(key,opts={})
+      response = api_execute(key_endpoint + key, :delete, params:opts)
       json2obj(response)
     end
 
@@ -104,21 +120,25 @@ module Etcd
     #
     # This method has following parameters as argument
     # * key - whose data to be retrive
-    def get(key)
-      response = api_execute(key_endpoint + key, :get)
+    def get(key, opts={})
+      response = api_execute(key_endpoint + key, :get, params:opts)
       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)
+    # @ key   - key to be watched
+    # @options [Hash] additional options for watching a key
+    # @options [Fixnum] :index watch the specified key from given index
+    # @options [Fixnum] :timeout specify http timeout (defaults to read_timeout value)
+    def watch(key, options={})
+      timeout = options[:timeout] || @read_timeout
+      index = options[:waitIndex] || options[:index]
       response = if index.nil?
-                    api_execute(watch_endpoint + key, :get)
+                    api_execute(key_endpoint + key, :get, timeout: timeout, params:{wait: true})
                   else
-                    api_execute(watch_endpoint + key, :post, {'index' => index})
+                    api_execute(key_endpoint + key, :get, timeout: timeout, params: {wait: true, waitIndex: index})
                   end
       json2obj(response)
     end
@@ -128,8 +148,11 @@ module Etcd
     # 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)
+    # * options  - any additional parameters used by request method (optional)
+    def api_execute(path, method, options={})
+
+      params = options[:params]
+      timeout = options[:timeout] || @read_timeout
 
       http = if path=~/^http/
                 uri = URI.parse(path)
@@ -138,7 +161,9 @@ module Etcd
               else
                 Net::HTTP.new(host, port)
               end
-      http.read_timeout = @read_timeout
+      http.read_timeout = timeout
+      http.use_ssl = use_ssl
+      http.verify_mode = verify_mode
 
       case  method
       when :get
@@ -152,12 +177,19 @@ module Etcd
         req = Net::HTTP::Post.new(path)
         req.body= encoded_params
         Log.debug("Setting body for post '#{encoded_params}'")
+      when :put
+        encoded_params = URI.encode_www_form(params)
+        req = Net::HTTP::Put.new(path)
+        req.body= encoded_params
+        Log.debug("Setting body for put '#{encoded_params}'")
       when :delete
         unless params.nil?
           encoded_params = URI.encode_www_form(params)
           path+= "?" + encoded_params
         end
         req = Net::HTTP::Delete.new(path)
+      else
+        raise "Unknown http action: #{method}"
       end
 
       Log.debug("Invoking: '#{req.class}' against '#{path}")
@@ -168,7 +200,7 @@ module Etcd
         res.body
       elsif redirect?(res.code.to_i) and allow_redirect
         Log.debug("Http redirect, following")
-        api_execute(res['location'], method, params)
+        api_execute(res['location'], method, params: params)
       else
         Log.debug("Http error")
         Log.debug(res.body)
@@ -183,11 +215,21 @@ module Etcd
 
     def json2obj(json)
       obj = JSON.parse(json)
-      if obj.is_a?(Array)
-        obj.map{|e| OpenStruct.new(e)}
+      if obj.has_key?('nodes')
+        obj.map do |e|
+          node2obj(e)
+        end
       else
-        OpenStruct.new(obj)
+        node2obj(obj)
       end
     end
+
+    def node2obj(hash)
+      h = hash.dup
+      h[:value] = h['node']['value'] if h.has_key?('node') and h['node'].has_key?('value')
+      o = OpenStruct.new(h)
+      o.node = OpenStruct.new(o.node) if h.has_key?('node')
+      o
+    end
   end
 end

data/lib/etcd/version.rb

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

data/spec/functional/client_spec.rb

@@ -19,6 +19,10 @@ describe "Functional Test Suite" do
     start_etcd_servers
   end
 
+  let(:etcd_servers) do
+    (1..5).map{|n| "http://127.0.0.1:700#{n}"}
+  end
+
   after(:all) do
     stop_etcd_servers
   end
@@ -46,7 +50,7 @@ describe "Functional Test Suite" do
 
 
   it "#leader" do
-    expect(client.leader).to eq('http://127.0.0.1:7001')
+    expect(etcd_servers).to include(client.leader)
   end
 
   it "#machines" do

data/spec/functional/read_only_client_spec.rb

@@ -18,7 +18,7 @@ shared_examples "read only client" do
     key = random_key
     value = uuid.generate
     index = client.set(key, value).index
-    expect(read_only_client.watch(key, index).value).to eq(value)
+    expect(read_only_client.watch(key, index: index).value).to eq(value)
   end
 end
 

data/spec/functional/test_and_set_spec.rb

@@ -14,5 +14,31 @@ shared_examples "test_and_set" do
     client.set(key, value)
     expect{ client.test_and_set(key, 10, 2)}.to raise_error(Net::HTTPServerException)
   end
+
+  it "#create should succeed when the key is absent and update should fail" do
+    key = random_key(2)
+    value = uuid.generate
+    expect {
+      client.update(key, value)
+    }.to raise_error
+    expect {
+      client.create(key, value)
+    }.to_not raise_error
+    expect(client.get(key).value).to eq(value)
+  end
+
+  it "#create should fail when the key is present and update should succeed" do
+    key = random_key(2)
+    value = uuid.generate
+    client.set(key, 1)
+
+    expect {
+      client.create(key, value)
+    }.to raise_error
+
+    expect {
+      client.update(key, value)
+    }.to_not raise_error
+  end
 end
 

data/spec/functional/watch_spec.rb

@@ -4,11 +4,11 @@ shared_examples "watch" do
     value1 = uuid.generate
     value2 = uuid.generate
 
-    index1 = client.set(key, value1).index
-    index2 = client.set(key, value2).index
+    index1 = client.create(key, value1).node.modifiedIndex
+    index2 = client.test_and_set(key, value2, value1).node.modifiedIndex
 
-    expect(client.watch(key, index1).value).to eq(value1)
-    expect(client.watch(key, index2).value).to eq(value2)
+    expect(client.watch(key, index: index1).value).to eq(value1)
+    expect(client.watch(key, index: index2).value).to eq(value2)
   end
 
   it "with index, waits and return when the key is updated" do

data/spec/functional_spec_helpers.rb

@@ -27,11 +27,11 @@ module Etcd
       end
 
       def spawn_etcd_server(dir, client_port=4001, server_port=7001, leader = nil)
-        args = " -c 127.0.0.1:#{client_port} -s 127.0.0.1:#{server_port} -d #{dir} -n node_#{client_port}"
+        args = " -addr 127.0.0.1:#{client_port} -peer-addr 127.0.0.1:#{server_port} -data-dir #{dir} -name node_#{client_port}"
         command = if leader.nil?
                     ETCD_BIN + args
                   else
-                    ETCD_BIN + args + " -C #{leader}"
+                    ETCD_BIN + args + " -peers #{leader}"
                   end
         puts command
         pid = spawn(command)

data/spec/unit/etcd/client_spec.rb

@@ -12,54 +12,62 @@ describe Etcd::Client do
     expect(client.port).to eq(4001)
   end
 
-  it "shlould follow redirection by default" do
+  it "should have SSL turned off by default" do
+    expect(client.use_ssl).to be_false
+  end
+
+  it "should have SSL verification turned on by default" do
+    expect(client.verify_mode).to eq(OpenSSL::SSL::VERIFY_PEER)
+  end
+
+  it "should follow redirection by default" do
     expect(client.allow_redirect).to be_true
   end
 
   it "#machines should make /machines GET http request" do
-    client.should_receive(:api_execute).with('/v1/machines', :get).and_return('foobar')
+    client.should_receive(:api_execute).with('/v2/machines', :get).and_return('foobar')
     expect(client.machines).to eq(['foobar'])
   end
 
   it "#leader should make /leader GET http request" do
-    client.should_receive(:api_execute).with('/v1/leader', :get).and_return('foobar')
+    client.should_receive(:api_execute).with('/v2/leader', :get).and_return('foobar')
     expect(client.leader).to eq('foobar')
   end
 
-  it "#get('/foo') should make /v1/keys/foo GET http request" do
-    client.should_receive(:api_execute).with('/v1/keys/foo', :get).and_return('{"value":1}')
+  it "#get('/foo') should make /v2/keys/foo GET http request" do
+    client.should_receive(:api_execute).with('/v2/keys/foo', :get, {:params=>{}}).and_return('{"value":1}')
     expect(client.get('/foo').value).to eq(1)
   end
 
   describe "#set" do
-    it "set('/foo', 1) should invoke /v1/keys/foo POST http request" do
-      client.should_receive(:api_execute).with('/v1/keys/foo', :post, {'value'=>1}).and_return('{"value":1}')
+    it "set('/foo', 1) should invoke /v2/keys/foo PUT http request" do
+      client.should_receive(:api_execute).with('/v2/keys/foo', :put, params: {'value'=>1}).and_return('{"value":1}')
       expect(client.set('/foo', 1).value).to eq(1)
     end
-    it "set('/foo', 1, 4) should invoke /v1/keys/foo POST http request and set the ttl to 4" do
-      client.should_receive(:api_execute).with('/v1/keys/foo', :post, {'value'=>1, 'ttl'=>4}).and_return('{"value":1}')
+    it "set('/foo', 1, 4) should invoke /v2/keys/foo PUT http request and set the ttl to 4" do
+      client.should_receive(:api_execute).with('/v2/keys/foo', :put, params: {'value'=>1, 'ttl'=>4}).and_return('{"value":1}')
       expect(client.set('/foo', 1, 4).value).to eq(1)
     end
   end
 
   describe "#test_and_set" do
-    it "test_and_set('/foo', 1, 4) should invoke /v1/keys/foo POST http request" do
-      client.should_receive(:api_execute).with('/v1/keys/foo', :post, {'value'=>1, 'prevValue'=>4}).and_return('{"value":1}')
+    it "test_and_set('/foo', 1, 4) should invoke /v2/keys/foo PUT http request" do
+      client.should_receive(:api_execute).with('/v2/keys/foo', :put, params: {'value'=>1, 'prevValue'=>4}).and_return('{"value":1}')
       expect(client.test_and_set('/foo', 1, 4).value).to eq(1)
     end
-    it "test_and_set('/foo', 1, 4, 10) should invoke /v1/keys/foo POST http request and set the ttl to 10" do
-      client.should_receive(:api_execute).with('/v1/keys/foo', :post, {'value'=>1, 'prevValue'=>4, 'ttl'=>10}).and_return('{"value":1}')
+    it "test_and_set('/foo', 1, 4, 10) should invoke /v2/keys/foo PUT http request and set the ttl to 10" do
+      client.should_receive(:api_execute).with('/v2/keys/foo', :put, params: {'value'=>1, 'prevValue'=>4, 'ttl'=>10}).and_return('{"value":1}')
       expect(client.test_and_set('/foo', 1, 4, 10).value).to eq(1)
     end
   end
 
-  it "#watch('/foo') should make /v1/watch/foo GET http request" do
-    client.should_receive(:api_execute).with('/v1/watch/foo', :get).and_return('{"value":1}')
+  it "#watch('/foo') should make /v2/watch/foo GET http request" do
+    client.should_receive(:api_execute).with('/v2/keys/foo', :get, {:timeout=>60, :params=>{:wait=>true}}).and_return('{"value":1}')
     expect(client.watch('/foo').value).to eq(1)
   end
 
-  it "#delete('/foo') should make /v1/keys/foo DELETE http request" do
-    client.should_receive(:api_execute).with('/v1/keys/foo', :delete).and_return('{"index":"1"}')
+  it "#delete('/foo') should make /v2/keys/foo DELETE http request" do
+    client.should_receive(:api_execute).with('/v2/keys/foo', :delete, {:params=>{}}).and_return('{"index":"1"}')
     client.delete('/foo')
   end
 

metadata

@@ -1,126 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: etcd
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 0.0.6
 platform: ruby
 authors:
 - Ranjib Dey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-10 00:00:00.000000000 Z
+date: 2013-12-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
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mixlib-log
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: uuid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby client library for etcd
@@ -159,33 +144,26 @@ 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: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby client library for etcd
 test_files:
 - spec/functional/client_spec.rb