etcdv3 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e8425d9e034d0a1bab9cc37a5250694854807e8
-  data.tar.gz: b49869fe7b0fa100faccc29dd9d06806753c6a5d
+  metadata.gz: 6a62664451e058e0837e78b5ea583944532f596e
+  data.tar.gz: df7954ad160f76a260d297a8c13357f50ef15474
 SHA512:
-  metadata.gz: '073189ecdbaa0c0719731731a4d2d05a0db0271855e7777f1c35d775d1196ea57554aa2cd8eaca7951e1a329dcf476d80f2024ee1aabe0ae540afe5ef024f5f7'
-  data.tar.gz: 0bdc23ddadaebb5827e3a241e5f7d7ec4a536d32196f1c1e64bbc3991433cd81fdbd05f664ea5cd1e776bede027b65da78754f1f1e8604a40295e63cdc83b920
+  metadata.gz: af31ea39606da03fed56cbfb723d1958feaec6507c1f13ee60dba9ab9c870bcdeaead2cec21ea79ea373a3eb9a4ece179684a3a9688ab86d659cfe9918b4fc8e
+  data.tar.gz: 1037364a45050545ab05b6dca88661fe9ecd6d6824a29ef9fcfe53abcd8a55044550f89a4e407708c558fbd57fe865735adc78349f57001238c1ae6527e185de

data/.travis.yml

@@ -1,5 +1,8 @@
 language: ruby
-python: 2.4
+rvm:
+  - 2.4.0
+  - 2.2
+  - 2.0
 
 env:
   global:

data/README.md

@@ -2,7 +2,7 @@
 
 Ruby client for Etcd V3
 
-**WARNING: This is very much a work in progress and should be considered unstable.**
+**Note: This is under active development and is not feature complete**
 
 ## Getting Started
 
@@ -11,7 +11,7 @@ To install etcdv3, run the following command:
 gem install etcdv3
 ```
 
-You can connect to Etcd by instantiating the Etcd class:
+**Establishing a connection**
 
 ```
 require 'etcdv3'
@@ -34,28 +34,53 @@ conn = Etcd.new(url: 'https://hostname:port', user: "gary", password: "secret")
      # Put
      conn.put("my", "value")
 
-     # Range
-     conn.range("my")
+     # Get
+     conn.get("my")
 
-**User Managment**
+     # Get Key Range
+     conn.get('my', 'myyyy')
 
-     # Add User
-     conn.add_user('admin', 'secret')
+**User Management**
+```
+ # Add User
+ conn.add_user('admin', 'secret')
+
+# Delete User
+conn.delete_user('admin')
 
-     # Delete User
-     conn.delete_user('admin')
+# List users
+conn.user_list
+```
 
-     # List users
-     conn.user_list
+**Role Management**
+```
+# Add Role
+conn.add_role('rolename', 'readwrite', 'a', 'Z')
 
-     # Add Role
-     conn.add_role('rolename', 'readwrite', 'a', 'Z')
+# Delete Role
+conn.delete_role('rolename')
 
-     # Enable Authentication
-     conn.add_user('root', "secret")
-     conn.grant_role_to_user('root', 'root')
-     conn.enable_auth
+# List Roles
+conn.role_list
+```
+
+**Authentication Management**
+```
+# Configure a root user
+conn.add_user('root', 'mysecretpassword')
 
-     # Disable Authentication
-     conn = Etcd.new(url: 'http://127.0.0.1:2379', user: 'root', password: 'secret')
-     conn.disable_auth
+# Grant root user the root role
+conn.grant_role_to_user('root', 'root')
+
+# Enable Authentication
+conn.enable_auth
+```
+After you enable authentication, you must authenticate.
+```
+# This will generate and assign an auth token that will be used in future requests.
+conn.authenticate('root', 'mysecretpassword')
+```
+Disabling auth will clear the auth token and all previously attached user information
+```
+conn.disable_auth
+```

data/lib/etcdv3/auth.rb

@@ -8,8 +8,9 @@ class Etcd
       'readwrite' => Authpb::Permission::Type::READWRITE
     }
 
-    def initialize(hostname, port, credentials)
+    def initialize(hostname, port, credentials, metadata = {})
       @stub = Etcdserverpb::Auth::Stub.new("#{hostname}:#{port}", credentials)
+      @metadata = metadata
     end
 
     def generate_token(user, password)
@@ -19,69 +20,57 @@ class Etcd
       response.token
     rescue GRPC::FailedPrecondition => exception
       puts exception.message
+      false
     end
 
-    def user_list(metadata = {})
-      @stub.user_list(Authpb::User.new, metadata: metadata).users
-    rescue GRPC::FailedPrecondition => exception
-      puts exception.message
+    def user_list
+      @stub.user_list(Authpb::User.new, metadata: @metadata).users
     end
 
-    def add_user(user, password, metadata = {})
+    def add_user(user, password)
       @stub.user_add(
-        Authpb::User.new(name: user, password: password), metadata: metadata
+        Authpb::User.new(name: user, password: password), metadata: @metadata
       )
-    rescue GRPC::FailedPrecondition => exception
-      puts exception.message
     end
 
-    def delete_user(user, metadata = {})
-      @stub.user_delete(Authpb::User.new(name: user), metadata: metadata)
-    rescue GRPC::FailedPrecondition => exception
-      puts exception.message
+    def delete_user(user)
+      @stub.user_delete(Authpb::User.new(name: user))
     end
 
-    def add_role(name, permission, key, range_end, metadata = {})
+    def add_role(name, permission, key, range_end)
       permission = Authpb::Permission.new(
         permType: Etcd::Auth::PERMISSIONS[permission], key: key, range_end: range_end
       )
       @stub.role_add(
         Authpb::Role.new(name: name, keyPermission: [permission]),
-        metadata: metadata
+        metadata: @metadata
       )
-    rescue GRPC::FailedPrecondition => exception
-      puts exception.message
     end
 
-    def delete_role(name, metadata = {})
-      @stub.role_delete(Authpb::Role.new(name: name), metadata: metadata)
-    rescue GRPC::FailedPrecondition => exception
-      puts exception.message
+    def delete_role(name)
+      @stub.role_delete(Authpb::Role.new(name: name), metadata: @metadata)
     end
 
-    def grant_role_to_user(user, role, metadata = {})
+    def grant_role_to_user(user, role)
       request = Etcdserverpb::AuthUserGrantRoleRequest.new(user: user, role: role)
-      @stub.user_grant_role(request)
-    rescue GRPC::FailedPrecondition => exception
-      puts exception.message
+      @stub.user_grant_role(request, metadata: @metadata)
     end
 
-    def role_list(metadata = {})
-      @stub.role_list(Authpb::Role.new, metadata: metadata)
-    rescue GRPC::FailedPrecondition => exception
-      puts exception.message
+    def revoke_role_from_user(user, role)
+      request = Etcdserverpb::AuthUserRevokeRoleRequest.new(name: user, role: role)
+      @stub.user_revoke_role(request, metadata: @metadata)
+    end
+
+    def role_list
+      @stub.role_list(Authpb::Role.new, metadata: @metadata)
     end
 
     def enable_auth
       @stub.auth_enable(Authpb::User.new)
-    rescue GRPC::FailedPrecondition => exception
-      puts exception.message
     end
 
-    def disable_auth(metadata = {})
-      @stub.auth_disable(Authpb::User.new, metadata: metadata)
-    rescue GRPC::FailedPrecondition => exception
-      puts exception.message
+    def disable_auth
+      @stub.auth_disable(Authpb::User.new, metadata: @metadata)
     end
 
   end

data/lib/etcdv3/kv.rb

@@ -1,19 +1,19 @@
 
 class Etcd
   class KV
-    def initialize(hostname, port, credentials)
+    def initialize(hostname, port, credentials, metadata={})
       @stub = Etcdserverpb::KV::Stub.new("#{hostname}:#{port}", credentials)
+      @metadata = metadata
     end
 
-    def put(key, value, metadata = {})
+    def put(key, value)
       kv = Etcdserverpb::PutRequest.new(key: key, value: value)
-      @stub.put(kv, metadata: metadata)
+      @stub.put(kv, metadata: @metadata)
     end
 
-    def range(key, range_end, metadata = {})
+    def get(key, range_end="")
       kv = Etcdserverpb::RangeRequest.new(key: key, range_end: range_end)
-      result = @stub.range(kv, metadata: metadata)
-      result.kvs
+      @stub.range(kv, metadata: @metadata).kvs
     end
   end
 end

data/lib/etcdv3/version.rb

@@ -1,3 +1,3 @@
 class Etcd
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

data/lib/etcdv3.rb

@@ -46,39 +46,56 @@ class Etcd
   end
 
   def put(key, value)
-    kv.put(key, value, @metadata)
+    kv.put(key, value)
   end
 
-  def range(key, range_end)
-    kv.range(key, range_end, @metadata)
+  def get(key, range_end='')
+    kv.get(key, range_end)
   end
 
   def add_user(user, password)
-    auth.add_user(user, password, @metadata)
+    auth.add_user(user, password)
   end
 
   def delete_user(user)
-    auth.delete_user(user, @metadata)
+    auth.delete_user(user)
   end
 
   def user_list
-    auth.user_list(@metadata)
+    auth.user_list
+  end
+
+  def authenticate(user, password)
+    token = auth.generate_token(user, password)
+    if token
+      @metadata[:token] = token
+      @options[:user] = user
+      @options[:password] = password
+      return true
+    end
+  rescue GRPC::InvalidArgument => exception
+    print exception.message
+    return false
   end
 
   def role_list
-    auth.role_list(@metadata)
+    auth.role_list
   end
 
   def add_role(name, permission, key, range_end='')
-    auth.add_role(name, permission, key, range_end, @metadata)
+    auth.add_role(name, permission, key, range_end)
   end
 
   def delete_role(name)
-    auth.delete_role(name, @metadata)
+    auth.delete_role(name)
   end
 
   def grant_role_to_user(user, role)
-    auth.grant_role_to_user(user, role, @metadata)
+    auth.grant_role_to_user(user, role)
+  end
+
+  def revoke_role_from_user(user, role)
+    auth.revoke_role_from_user(user, role)
   end
 
   def enable_auth
@@ -86,17 +103,23 @@ class Etcd
   end
 
   def disable_auth
-    auth.disable_auth(@metadata)
+    response = auth.disable_auth
+    if response
+      @metadata.delete(:token)
+      @options[:user] = nil
+      @options[:password] = nil
+    end
+    response
   end
 
   private
 
   def auth
-    Etcd::Auth.new(hostname, port, @credentials)
+    Etcd::Auth.new(hostname, port, @credentials, @metadata)
   end
 
   def kv
-    Etcd::KV.new(hostname, port, @credentials)
+    Etcd::KV.new(hostname, port, @credentials, @metadata)
   end
 
   def resolve_credentials

data/spec/etcdv3/auth_spec.rb

@@ -2,13 +2,13 @@ require 'spec_helper'
 
 describe Etcd::Auth do
 
-  let(:stub) do
-    Etcd::Auth.new('127.0.0.1', 2379, :this_channel_is_insecure)
+  let(:conn) do
+    Etcd.new(url: 'http://127.0.0.1:2379')
   end
 
   describe '#add_user' do
     it 'returns AuthUserAddResponse' do
-      expect(stub.add_user("boom", 'test')).to \
+      expect(conn.add_user("boom", 'test')).to \
         be_an_instance_of(Etcdserverpb::AuthUserAddResponse)
     end
   end
@@ -16,88 +16,128 @@ describe Etcd::Auth do
   describe '#user_list' do
 
     it 'returns Protobuf' do
-      expect(stub.user_list).to \
+      expect(conn.user_list).to \
         be_an_instance_of(Google::Protobuf::RepeatedField)
     end
 
     it 'returns listme user' do
-      stub.add_user('listme', 'test')
-      expect(stub.user_list).to include('listme')
+      conn.add_user('listme', 'test')
+      expect(conn.user_list).to include('listme')
     end
   end
 
   describe '#delete_user' do
     before do
-      stub.add_user('testuser', 'test')
+      conn.add_user('testuser', 'test')
     end
     it 'returns AuthUserDeleteResponse' do
-      expect(stub.delete_user('testuser')).to \
+      expect(conn.delete_user('testuser')).to \
         be_an_instance_of(Etcdserverpb::AuthUserDeleteResponse)
     end
   end
 
   describe '#grant_role_to_user' do
     before do
-      stub.add_user('root', 'password')
+      conn.add_user('root', 'password')
     end
     after do
-      stub.delete_user('root')
+      conn.delete_user('root')
     end
     it 'returns AuthUserGrantRoleResponse' do
-      expect(stub.grant_role_to_user("root", 'root')).to \
+      expect(conn.grant_role_to_user("root", 'root')).to \
         be_an_instance_of(Etcdserverpb::AuthUserGrantRoleResponse)
     end
   end
 
+  describe '#revoke_role_from_user' do
+    before do
+      conn.add_user('test_user', 'password')
+      conn.grant_role_to_user('test_user', 'root')
+    end
+    after do
+      conn.delete_user('test_user')
+    end
+    it 'returns AuthUserGrantRoleResponse' do
+      expect(conn.revoke_role_from_user("test_user", 'root')).to \
+        be_an_instance_of(Etcdserverpb::AuthUserRevokeRoleResponse)
+    end
+  end
+
   describe '#add_role' do
     it 'returns AuthRoleAddResponse' do
-      expect(stub.add_role('testRole', 'readwrite', 'a', 'Z')).to \
+      expect(conn.add_role('testRole', 'readwrite', 'a', 'Z')).to \
         be_an_instance_of(Etcdserverpb::AuthRoleAddResponse)
     end
   end
 
   describe '#add_delete' do
     it 'returns AuthRoleAddResponse' do
-      expect(stub.delete_role('testRole')).to \
+      expect(conn.delete_role('testRole')).to \
         be_an_instance_of(Etcdserverpb::AuthRoleDeleteResponse)
     end
   end
 
   describe '#role_list' do
     it 'returns AuthRoleListResponse' do
-      expect(stub.role_list).to \
+      expect(conn.role_list).to \
         be_an_instance_of(Etcdserverpb::AuthRoleListResponse)
     end
   end
 
   describe '#disable_auth' do
     before do
-      stub.add_user('root', 'test')
-      stub.grant_role_to_user('root', 'root')
-      stub.enable_auth
+      conn.add_user('root', 'test')
+      conn.grant_role_to_user('root', 'root')
+      conn.enable_auth
+      conn.authenticate('root', 'test')
     end
     after do
-      stub.delete_user('root')
+      conn.delete_user('root')
     end
     it 'returns AuthDisableResponse' do
-      token = stub.generate_token('root', 'test')
-      expect(stub.disable_auth(token: token)).to \
+      expect(conn.disable_auth).to \
         be_an_instance_of(Etcdserverpb::AuthDisableResponse)
     end
   end
 
   describe '#enable_auth' do
     before do
-      stub.add_user('root', 'test')
-      stub.grant_role_to_user('root', 'root')
+      conn.add_user('root', 'test')
+      conn.grant_role_to_user('root', 'root')
     end
     after do
-      token = stub.generate_token('root', 'test')
-      stub.disable_auth(token: token)
-      stub.delete_user('root')
+      conn.authenticate('root', 'test')
+      conn.disable_auth
+      conn.delete_user('root')
     end
     it 'returns AuthEnableResponse' do
-      expect(stub.enable_auth).to be_an_instance_of(Etcdserverpb::AuthEnableResponse)
+      expect(conn.enable_auth).to be_an_instance_of(Etcdserverpb::AuthEnableResponse)
+    end
+  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 token + user + password' 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 'returns false when authenticating with auth disabled' do
+        expect(conn.authenticate('root', 'root')).to eq(false)
+      end
     end
   end
 end

data/spec/etcdv3/kv_spec.rb

@@ -2,30 +2,28 @@ require 'spec_helper'
 
 describe Etcd::KV do
 
-  let(:stub) do
-    Etcd::KV.new('127.0.0.1', 2379, :this_channel_is_insecure)
+  let(:conn) do
+    Etcd.new(url: 'http://127.0.0.1:2379')
   end
 
   describe '#put' do
     it 'returns PutResponse' do
-      expect(stub.put('test', 'test')).to \
+      expect(conn.put('test', 'test')).to \
         be_an_instance_of(Etcdserverpb::PutResponse)
     end
   end
 
-  describe '#range' do
+  describe '#get' do
     before do
-      stub.put('test', "zoom")
+      conn.put('test', "zoom")
     end
     it 'returns protobuf' do
-      expect(stub.range('test', '')).to \
+      expect(conn.get('test')).to \
         be_an_instance_of(Google::Protobuf::RepeatedField)
     end
 
     it 'returns correct result' do
-      expect(stub.range('test', '').first.key).to eq('test')
+      expect(conn.get('test').first.key).to eq('test')
     end
   end
-
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: etcdv3
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Shaun Davis
@@ -44,10 +44,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -92,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A Etcd client library for Version 3

data/.codeclimate.yml

@@ -1,27 +0,0 @@
-engines:
-  duplication:
-    enabled: true
-    config:
-      languages:
-      - ruby
-  fixme:
-    enabled: true
-  rubocop:
-    enabled: true
-ratings:
-  paths:
-  - "**.rb"
-exclude_paths:
-- spec/
-engines:
-  rubocop:
-    enabled: true
-  duplication:
-    enabled: true
-ratings:
-  paths:
-  - lib/**
-  - "**.rb"
-exclude_paths:
-- "lib/etcdv3/protos/*"
-- "lib/etcdv3/etcdrpc/*"

data/.ruby-version

@@ -1 +0,0 @@
-2.4.1