etcdv3 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e2fce5dfb236ef001c050f60f6fec8162914121
-  data.tar.gz: 0ae18b137efb5cbd7c328a6690615f2f6c68c65b
+  metadata.gz: 6054abb122d9d779e4fc044e0e18cb6f06b03e26
+  data.tar.gz: 93fb0231d2ebb440f38e2e23fbd8e5c78ab45b6b
 SHA512:
-  metadata.gz: b06266232676bd25db0521874cd846069b473091f34cf1dc7d0a5dc2b06575d141323aa917411854ba186d8134d5f1ef09c22e5ff919167c6ecae164a65dce4b
-  data.tar.gz: 305a579ce7e7c0c202c8643ba1ea3cbb265abf3dded50a748b6ad839ef78acb22f1ce72e3d62ad0edefa6ef288f65b52e0828482d7658f3fbb5192b4a1017ec0
+  metadata.gz: eca14e0abaad2095e87ad37a6236f304e53319a58f93adfaee300f6d068b5be039f161a066259e1941a45288ea1e41137d0746ec71d36a4c0f884bec91421512
+  data.tar.gz: 3a636b3b397101ed7dd479e0ecbe16ae30ffad4d3c23fa804dab9bb196d41ce0d94ee0a09bf562d36bb5e94ef55c6ead6594822af84365a72f2a6c37e9141dab

data/Gemfile

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

data/README.md

@@ -1,4 +1,5 @@
-# etcdv3-ruby  [![Gem Version](https://badge.fury.io/rb/etcdv3.svg)](https://badge.fury.io/rb/etcdv3) [![Build Status](https://travis-ci.org/davissp14/etcdv3-ruby.svg?branch=master)](https://travis-ci.org/davissp14/etcdv3-ruby)
+# etcdv3-ruby  [![Gem Version](https://badge.fury.io/rb/etcdv3.svg)](https://badge.fury.io/rb/etcdv3) [![Build Status](https://travis-ci.org/davissp14/etcdv3-ruby.svg?branch=master)](https://travis-ci.org/davissp14/etcdv3-ruby) [![codecov](https://codecov.io/gh/davissp14/etcdv3-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/davissp14/etcdv3-ruby)
+
 
 Ruby client for Etcd V3
 
@@ -40,7 +41,7 @@ conn = Etcd.new(url: 'https://hostname:port', user: "gary", password: "secret")
  conn.get("my")
 
  # Get Key Range
- conn.get('my', 'myyyy')
+ conn.get('my', range_end: 'myyyy')
 
  # Delete Key
  conn.del('my')

data/lib/etcdv3/kv.rb

@@ -1,6 +1,21 @@
 
 class Etcd
   class KV
+
+    SORT_TARGET = {
+      key: 0,
+      version: 1,
+      create: 2,
+      mod: 3,
+      value: 4
+    }
+
+    SORT_ORDER = {
+      none: 0,
+      ascend: 1,
+      descend: 2
+    }
+
     def initialize(hostname, credentials, metadata={})
       @stub = Etcdserverpb::KV::Stub.new(hostname, credentials)
       @metadata = metadata
@@ -12,8 +27,13 @@ class Etcd
       @stub.put(kv, metadata: @metadata)
     end
 
-    def get(key, range_end="")
-      kv = Etcdserverpb::RangeRequest.new(key: key, range_end: range_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)
     end
 

data/lib/etcdv3/version.rb

@@ -1,3 +1,3 @@
 class Etcd
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/etcdv3.rb

@@ -80,9 +80,21 @@ class Etcd
     request.handle(:kv, 'put', [key, value, lease_id])
   end
 
-  # Fetches key(s).
-  def get(key, range_end='')
-    request.handle(:kv, 'get', [key, range_end])
+  # key                           - string
+  # optional :range_end           - string
+  # optional :limit               - integer
+  # optional :revision            - integer
+  # optional :sort_order          - symbol - [:none, :ascend, :descend]
+  # optional :sort_target         - symbol - [:key, :version, :create, :mode, :value]
+  # optional :serializable        - boolean
+  # optional :keys_only           - boolean
+  # optional :count_only          - boolean
+  # optional :min_mod_revision    - integer
+  # optional :max_mod_revision    - integer
+  # optional :min_create_revision - integer
+  # optional :max_create_revision - integer
+  def get(key, opts={})
+    request.handle(:kv, 'get', [key, opts])
   end
 
   # Grant a lease with a speified TTL

data/spec/etcdv3_spec.rb

@@ -41,8 +41,35 @@ describe Etcd do
     end
 
     describe '#get' do
-      subject { conn.get('test') }
-      it { is_expected.to_not be_nil }
+      before do
+        conn.put('apple', 'test')
+        conn.put('applee', 'test')
+        conn.put('appleee', 'test')
+      end
+      context 'no filters' do
+        subject { conn.get('apple') }
+        it { is_expected.to_not be_nil }
+      end
+      context 'sorts desc' do
+        subject do
+          conn.get('apple', range_end: 'appleeee', sort_order: :descend) \
+            .kvs.first.key
+        end
+        it { is_expected.to eq('appleee') }
+      end
+      context 'sorts asc' do
+        subject do
+          conn.get('apple', range_end: 'appleeee', sort_order: :ascend) \
+            .kvs.first.key
+        end
+        it { is_expected.to eq('apple') }
+      end
+      context 'count only' do
+        subject do
+          conn.get('apple', range_end: 'appleeee', count_only: true).kvs
+        end
+        it { is_expected.to be_empty }
+      end
     end
 
     describe '#put' do

data/spec/spec_helper.rb

@@ -2,12 +2,17 @@ $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift File.expand_path('./helpers', __FILE__)
 
 require 'etcdv3'
+require 'simplecov'
+require 'codecov'
 require 'helpers/test_instance'
 require 'helpers/connections'
 
+SimpleCov.start
+SimpleCov.formatter = SimpleCov::Formatter::Codecov
+
 RSpec.configure do |config|
   config.include(Helpers::Connections)
-  
+
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etcdv3
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Shaun Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-09 00:00:00.000000000 Z
+date: 2017-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -68,7 +68,6 @@ files:
 - lib/etcdv3/protos/rpc.proto
 - lib/etcdv3/request.rb
 - lib/etcdv3/version.rb
-- spec/etcd_spec.rb
 - spec/etcdv3/auth_spec.rb
 - spec/etcdv3/kv_spec.rb
 - spec/etcdv3/lease_spec.rb
@@ -102,7 +101,6 @@ signing_key:
 specification_version: 4
 summary: A Etcd client library for Version 3
 test_files:
-- spec/etcd_spec.rb
 - spec/etcdv3/auth_spec.rb
 - spec/etcdv3/kv_spec.rb
 - spec/etcdv3/lease_spec.rb

data/spec/etcd_spec.rb

@@ -1,112 +0,0 @@
-require 'spec_helper'
-
-describe Etcd do
-  context 'Insecure connection without Auth' do
-
-    let(:conn) { local_connection }
-
-    describe '#initialize' do
-      subject { conn }
-      it { is_expected.to have_attributes(scheme: 'http') }
-      it { is_expected.to have_attributes(hostname: '127.0.0.1') }
-      it { is_expected.to have_attributes(credentials: :this_channel_is_insecure) }
-      it { is_expected.to have_attributes(token: nil) }
-      it { is_expected.to have_attributes(user: nil) }
-      it { is_expected.to have_attributes(password: nil) }
-    end
-
-    describe '#version' do
-      subject { conn.version }
-      it { is_expected.to be_an_instance_of(String) }
-    end
-
-    describe '#db_size' do
-      subject { conn.db_size }
-      it { is_expected.to_not be_nil }
-    end
-
-    describe '#leader_id' do
-      subject { conn.leader_id.class }
-      it { is_expected.to_not be_nil }
-    end
-
-    describe '#disable_auth' do
-      before do
-        conn.add_user('root', 'test')
-        conn.grant_role_to_user('root', 'root')
-        conn.enable_auth
-        conn.authenticate('root', 'test')
-      end
-      after { conn.delete_user('root') }
-      subject { conn.disable_auth }
-      it { is_expected.to be_an_instance_of(Etcdserverpb::AuthDisableResponse) }
-    end
-
-    describe '#enable_auth' do
-      before do
-        conn.add_user('root', 'test')
-        conn.grant_role_to_user('root', 'root')
-      end
-      after do
-        conn.authenticate('root', 'test')
-        conn.disable_auth
-        conn.delete_user('root')
-      end
-      subject { conn.enable_auth }
-      it { is_expected.to be_an_instance_of(Etcdserverpb::AuthEnableResponse) }
-    end
-
-    describe "#authenticate" do
-      context "auth enabled" do
-        before do
-          conn.add_user('root', 'test')
-          conn.grant_role_to_user('root', 'root')
-          conn.enable_auth
-          conn.authenticate('root', 'test')
-        end
-        after do
-          conn.disable_auth
-          conn.delete_user('root')
-        end
-        it 'properly reconfigures auth and token' do
-          expect(conn.token).to_not be_nil
-          expect(conn.user).to eq('root')
-          expect(conn.password).to eq('test')
-        end
-      end
-
-      context 'auth disabled' do
-        it 'raises error' do
-          expect { conn.authenticate('root', 'root') }.to raise_error(GRPC::InvalidArgument)
-        end
-      end
-    end
-
-    describe '#metacache' do
-      context 'uses cached request object' do
-        let!(:object_id) { conn.send(:request).object_id }
-        before { conn.add_user('root', 'test') }
-        after { conn.delete_user('root') }
-        subject { conn.send(:request).object_id }
-        it { is_expected.to eq(object_id) }
-      end
-      context 'resets cache on auth' do
-        let!(:object_id) { conn.send(:request).object_id }
-        before do
-          conn.add_user('root', 'test')
-          conn.grant_role_to_user('root', 'root')
-          conn.enable_auth
-          conn.authenticate('root', 'test')
-          conn.add_user('boom', 'password')
-        end
-        after do
-          conn.disable_auth
-          conn.delete_user('root')
-          conn.delete_user('boom')
-        end
-        subject { conn.send(:request).object_id }
-        it { is_expected.to_not eq(object_id) }
-      end
-    end
-  end
-end