etcdv3 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfb94e2d833d0412e229748f89be3697776aa677
-  data.tar.gz: a4878727100089890d69309ea3e063d767a8f5ec
+  metadata.gz: 30310caddc0edd306f6c292f980628a01e9555c6
+  data.tar.gz: 602d665808709503255bb941b604482ca5a0b91e
 SHA512:
-  metadata.gz: 5fbac1f489e35934579e6ed3e92158b23a5ad6aaf39c8c381b1a304b4a9f969cb954c79113c4b207d976a73c2c9638b30fa96ecc8393e77c08ccd77d581e86e1
-  data.tar.gz: 2a22159afd0bb01446764763e79dc5fffa47fe8d51edbd063f59f7afa801d40a8532213ca32f9be556482027124172ac169cb0fb11d104ebbe29f5771e113bf7
+  metadata.gz: 9d2dd95400f50f1a185593659d5651f9607b20fadd6f9bf712cb85e8a8832f735ef71a6b52dd7acaa76e46e43139a3ffa1031c8c5c34b10ef9dfd26e834eba7a
+  data.tar.gz: a26775aba02b2b2a7f3244544362cf33cfcdfd748196d3fedee1721357dbf2b2dd73e985db6dd7424ca4c11af48588ecd9a14c07a4a90266bafaebbbac5d8794

data/.travis.yml

@@ -6,7 +6,7 @@ rvm:
 
 env:
   global:
-    - ETCD_VERSION=v3.1.4
+    - ETCD_VERSION=v3.1.6
 
 install:
     - bundle install

data/Gemfile

@@ -1,7 +1,5 @@
 source 'https://rubygems.org'
 
-gem "grpc"
-gem 'faraday', '0.11.0'
+gemspec
 
-gem 'rspec', :group => :test
 gem 'codecov', :require => false, :group => :test

data/README.md

@@ -116,6 +116,31 @@ conn.lease_ttl(1234566789)
 conn.lease_revoke(1234566789)
 ```
 
+## Transaction
+Transactions provide an easy way to process multiple requests in a single transaction.
+
+_Note: You cannot modify the same key multiple times within a single transaction._
+
+```ruby
+# https://github.com/davissp14/etcdv3-ruby/blob/txns/lib/etcdv3/kv/transaction.rb
+conn.transaction do |txn|
+  txn.compare = [
+    # Is the value of 'target_key' equal to 'compare_value'
+    txn.value('target_key', :equal, 'compare_value'),
+    # Is the version of 'target_key' greater than 10
+    txn.version('target_key', :greater, 10)
+  ]
+  
+  txn.success = [
+    txn.put('txn1', 'success')
+  ]
+  
+  txn.failure = [
+    txn.put('txn1', 'failed')
+  ]
+end
+```
+
 ## Watch
 ```ruby
 # Watch for changes on a specified key and return

data/etcdv3.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
 
-  s.add_dependency("grpc", "1.2.0")
-  s.add_development_dependency("rspec", "3.5.4")
+  s.add_dependency("grpc", "1.2.5")
+  s.add_dependency("faraday", "0.11.0")
+  s.add_development_dependency("rspec")
 end

data/lib/etcdv3.rb

@@ -4,6 +4,8 @@ require 'uri'
 
 require 'etcdv3/etcdrpc/rpc_services_pb'
 require 'etcdv3/auth'
+require 'etcdv3/kv/requests'
+require 'etcdv3/kv/transaction'
 require 'etcdv3/kv'
 require 'etcdv3/maintenance'
 require 'etcdv3/lease'
@@ -205,6 +207,10 @@ class Etcdv3
     request.handle(:watch, 'watch', [key, range_end, block])
   end
 
+  def transaction(&block)
+    request.handle(:kv, 'transaction', [block])
+  end
+
   private
 
   def request(reset: false)

data/lib/etcdv3/kv.rb

@@ -1,6 +1,7 @@
 
 class Etcdv3
   class KV
+    include Etcdv3::KV::Requests
 
     SORT_TARGET = {
       key: 0,
@@ -22,27 +23,42 @@ class Etcdv3
     end
 
     def get(key, opts={})
-      opts[:sort_order] = SORT_ORDER[opts[:sort_order]] \
-        if opts[:sort_order]
-      opts[:sort_target] = SORT_TARGET[opts[:sort_target]] \
-        if opts[:sort_target]
-      opts[:key] = key
-      kv = Etcdserverpb::RangeRequest.new(opts)
-      @stub.range(kv, metadata: @metadata)
+      @stub.range(get_request(key, opts), metadata: @metadata)
     end
 
     def del(key, range_end="")
-      request = Etcdserverpb::DeleteRangeRequest.new(
-        key: key,
-        range_end: range_end
-      )
-      @stub.delete_range(request, metadata: @metadata)
+      @stub.delete_range(del_request(key, range_end), metadata: @metadata)
     end
 
     def put(key, value, lease=nil)
-      kv = Etcdserverpb::PutRequest.new(key: key, value: value)
-      kv.lease = lease if lease
-      @stub.put(kv, metadata: @metadata)
+      @stub.put(put_request(key, value, lease), metadata: @metadata)
+    end
+
+    def transaction(block)
+      txn = Etcdv3::KV::Transaction.new
+      block.call(txn)
+      request = Etcdserverpb::TxnRequest.new(
+        compare: txn.compare,
+        success: generate_request_ops(txn.success),
+        failure: generate_request_ops(txn.failure)
+      )
+      @stub.txn(request)
+    end
+
+    private
+
+    def generate_request_ops(requests)
+      requests.map do |request|
+        if request.is_a?(Etcdserverpb::RangeRequest)
+          Etcdserverpb::RequestOp.new(request_range: request)
+        elsif request.is_a?(Etcdserverpb::PutRequest)
+          Etcdserverpb::RequestOp.new(request_put: request)
+        elsif request.is_a?(Etcdserverpb::DeleteRangeRequest)
+          Etcdserverpb::RequestOp.new(request_delete_range: request)
+        else
+          raise "Invalid command. Not sure how you got here!"
+        end
+      end
     end
   end
 end

data/lib/etcdv3/kv/requests.rb

@@ -0,0 +1,23 @@
+class Etcdv3::KV
+  module Requests
+
+    def get_request(key, opts)
+      opts[:sort_order] = SORT_ORDER[opts[:sort_order]] \
+        if opts[:sort_order]
+      opts[:sort_target] = SORT_TARGET[opts[:sort_target]] \
+        if opts[:sort_target]
+      opts[:key] = key
+      Etcdserverpb::RangeRequest.new(opts)
+    end
+
+    def del_request(key, range_end="")
+      Etcdserverpb::DeleteRangeRequest.new(key: key, range_end: range_end)
+    end
+
+    def put_request(key, value, lease=nil)
+      kv = Etcdserverpb::PutRequest.new(key: key, value: value)
+      kv.lease = lease if lease
+      kv
+    end
+  end
+end

data/lib/etcdv3/kv/transaction.rb

@@ -0,0 +1,87 @@
+class Etcdv3::KV
+  class Transaction
+    include Etcdv3::KV::Requests
+
+    # Available comparison identifiers.
+    COMPARISON_IDENTIFIERS = {
+      equal: 0,
+      greater: 1,
+      less: 2,
+      not_equal: 3
+    }
+
+    # Available targets to compare with.
+    TARGETS = {
+      version: 0,
+      create_revision: 1,
+      mod_revision: 2,
+      value: 3
+    }
+
+    attr_writer :compare, :success, :failure
+
+    def initialize; end
+
+    def compare
+      @compare ||= []
+    end
+
+    def success
+      @success ||= []
+    end
+
+    def failure
+      @failure ||=[]
+    end
+
+    # Request Operations
+
+    # txn.put('my', 'key')
+    def put(key, value)
+      put_request(key, value)
+    end
+
+    # txn.get('key')
+    def get(key, opts={})
+      get_request(key, opts)
+    end
+
+    # txn.del('key')
+    def del(key, opts={})
+      del_request(key, opts)
+    end
+
+    ###  Compare Operations
+
+    # txn.version('names', :greater, 0 )
+    def version(key, compare_type, value)
+      generate_compare(:version, key, compare_type, value)
+    end
+
+    # txn.value('names', :equal, 'wowza' )
+    def value(key, compare_type, value)
+      generate_compare(:value, key, compare_type, value)
+    end
+
+    # txn.mod_revision('names', :not_equal, 0)
+    def mod_revision(key, compare_type, value)
+      generate_compare(:mod_revision, key, compare_type, value)
+    end
+
+    # txn.create_revision('names', :less, 10)
+    def create_revision(key, compare_type, value)
+      generate_compare(:create_revision, key, compare_type, value)
+    end
+
+    private
+
+    def generate_compare(target_union, key, compare_type, value)
+      Etcdserverpb::Compare.new(
+        key: key,
+        result: COMPARISON_IDENTIFIERS[compare_type],
+        target: TARGETS[target_union],
+        target_union => value
+      )
+    end
+  end
+end

data/lib/etcdv3/version.rb

@@ -1,3 +1,3 @@
 class Etcdv3
-  VERSION = '0.5.2'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/spec/etcdv3/kv_spec.rb

@@ -33,4 +33,15 @@ describe Etcdv3::KV do
     end
   end
 
+  describe '#transaction' do
+    let!(:block) do
+      Proc.new do |txn|
+        txn.compare = [ txn.value('txn', :equal, 'value') ]
+        txn.success = [ txn.put('txn-test', 'success') ]
+        txn.failure = [ txn.put('txn-test', 'failed') ]
+      end
+    end
+    subject { stub.transaction(block) }
+    it { is_expected.to be_an_instance_of(Etcdserverpb::TxnResponse) }
+  end
 end

data/spec/etcdv3_spec.rb

@@ -243,5 +243,48 @@ describe Etcdv3 do
         end
       end
     end
+
+    describe '#transaction' do
+      context 'success' do
+        before { conn.put('txn', 'value') }
+        after { conn.del('txn') }
+        subject do
+          conn.transaction do |txn|
+            txn.compare = [ txn.value('txn', :equal, 'value') ]
+            txn.success = [ txn.put('txn-test', 'success') ]
+            txn.failure = [ txn.put('txn-test', 'failed') ]
+          end
+        end
+        it { is_expected.to be_an_instance_of(Etcdserverpb::TxnResponse) }
+        it 'returns successful' do
+          expect(subject.succeeded).to eq(true)
+        end
+        it 'sets correct key' do
+          expect(conn.get('txn-test').kvs.first.value).to eq('success')
+        end
+      end
+
+      context 'failure' do
+        before { conn.put('txn', 'value') }
+        after { conn.del('txn') }
+        subject do
+          conn.transaction do |txn|
+            txn.compare = [
+              txn.create_revision('txn', :greater, 500),
+              txn.mod_revision('txn', :less, 1000)
+            ]
+            txn.success = [ txn.put('txn-test', 'success') ]
+            txn.failure = [ txn.put('txn-test', 'failed') ]
+          end
+        end
+        it 'returns successful' do
+          expect(subject.succeeded).to eq(false)
+        end
+        it 'sets correct key' do
+          expect(conn.get('txn-test').kvs.first.value).to eq('failed')
+        end
+      end
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etcdv3
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Shaun Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-19 00:00:00.000000000 Z
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.2.5
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.5.4
-  type: :development
+        version: 0.11.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.5.4
+        version: 0.11.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: Etcd v3 Ruby Client
 email: davissp14@gmail.com
 executables: []
@@ -58,6 +72,8 @@ files:
 - lib/etcdv3/etcdrpc/rpc_pb.rb
 - lib/etcdv3/etcdrpc/rpc_services_pb.rb
 - lib/etcdv3/kv.rb
+- lib/etcdv3/kv/requests.rb
+- lib/etcdv3/kv/transaction.rb
 - lib/etcdv3/lease.rb
 - lib/etcdv3/maintenance.rb
 - lib/etcdv3/protos/annotations.proto
@@ -98,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A Etcd client library for Version 3