etcdv3 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a62664451e058e0837e78b5ea583944532f596e
-  data.tar.gz: df7954ad160f76a260d297a8c13357f50ef15474
+  metadata.gz: b631270b8fb44fc9f63bf971305a3a5336bc9064
+  data.tar.gz: 799324974b4957ace06c52553281a37ac178a1af
 SHA512:
-  metadata.gz: af31ea39606da03fed56cbfb723d1958feaec6507c1f13ee60dba9ab9c870bcdeaead2cec21ea79ea373a3eb9a4ece179684a3a9688ab86d659cfe9918b4fc8e
-  data.tar.gz: 1037364a45050545ab05b6dca88661fe9ecd6d6824a29ef9fcfe53abcd8a55044550f89a4e407708c558fbd57fe865735adc78349f57001238c1ae6527e185de
+  metadata.gz: fbe1eb6655e78bd7ba390bb84b5d11d8b2843f8ebab0ee12838d02a0da46508409847f993081307a2eb56192ea8bd0ec98156095964b11034e3872b413940195
+  data.tar.gz: 7124c6966834392ee9f11b44770160ee8e0ee2cdd3fa892901f58d1f87ce46b1f6c78257a0ce86df6bfc97887acba9bf525797da57f4c8302458538f25770278

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 gem "grpc"
 gem 'rspec'
+gem 'faraday', '0.11.0'
+
+

data/README.md

@@ -1,4 +1,4 @@
-# etcdv3-ruby  [![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)
 
 Ruby client for Etcd V3
 
@@ -55,7 +55,10 @@ conn.user_list
 **Role Management**
 ```
 # Add Role
-conn.add_role('rolename', 'readwrite', 'a', 'Z')
+conn.add_role('rolename')
+
+# Grant Permission to Role
+conn.grant_permission_to_role('rolename', 'readwrite', 'a', 'z')
 
 # Delete Role
 conn.delete_role('rolename')

data/lib/etcdv3/auth.rb

@@ -37,14 +37,25 @@ class Etcd
       @stub.user_delete(Authpb::User.new(name: user))
     end
 
-    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
+    def get_user(user)
+      @stub.user_get(Authpb::User.new(name: user))
+    end
+
+    def change_user_password(user, new_password)
+      request = Etcdserverpb::AuthUserChangePasswordRequest.new(
+        name: user,
+        password: new_password
       )
+      @stub.user_change_password(request, metadata: @metadata)
+    end
+
+    def add_role(name)
+      @stub.role_add(Authpb::Role.new(name: name), metadata: @metadata)
+    end
+
+    def get_role(name)
+      request = Etcdserverpb::AuthRoleGetRequest.new(role: name)
+      @stub.role_get(request, metadata: @metadata)
     end
 
     def delete_role(name)
@@ -61,6 +72,30 @@ class Etcd
       @stub.user_revoke_role(request, metadata: @metadata)
     end
 
+    def grant_permission_to_role(name, permission, key, range_end)
+      permission = Authpb::Permission.new(
+        permType: Etcd::Auth::PERMISSIONS[permission], key: key, range_end: range_end
+      )
+      @stub.role_grant_permission(
+        Etcdserverpb::AuthRoleGrantPermissionRequest.new(
+          name: name,
+          perm: permission
+        ),
+        metadata: @metadata
+      )
+    end
+
+    def revoke_permission_from_role(name, permission, key, range_end)
+      @stub.role_revoke_permission(
+        Etcdserverpb::AuthRoleRevokePermissionRequest.new(
+          role: name,
+          key: key,
+          range_end: range_end
+        ),
+        metadata: @metadata
+      )
+    end
+
     def role_list
       @stub.role_list(Authpb::Role.new, metadata: @metadata)
     end

data/lib/etcdv3/kv.rb

@@ -9,11 +9,17 @@ class Etcd
     def put(key, value)
       kv = Etcdserverpb::PutRequest.new(key: key, value: value)
       @stub.put(kv, metadata: @metadata)
+    rescue GRPC::PermissionDenied, GRPC::InvalidArgument => exception
+      puts exception.message
+      false
     end
 
     def get(key, range_end="")
       kv = Etcdserverpb::RangeRequest.new(key: key, range_end: range_end)
       @stub.range(kv, metadata: @metadata).kvs
+    rescue GRPC::PermissionDenied, GRPC::InvalidArgument => exception
+      puts exception.message
+      false
     end
   end
 end

data/lib/etcdv3/version.rb

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

data/lib/etcdv3.rb

@@ -45,26 +45,43 @@ class Etcd
     @metadata[:token] = auth.generate_token(user, password) unless user.nil?
   end
 
+  # Inserts a new key.
   def put(key, value)
     kv.put(key, value)
   end
 
+  # Fetches key(s).
   def get(key, range_end='')
     kv.get(key, range_end)
   end
 
+  # Creates new user.
   def add_user(user, password)
     auth.add_user(user, password)
   end
 
+  # Fetch specified user
+  def get_user(user)
+    auth.get_user(user)
+  end
+
+  # Delete specified user.
   def delete_user(user)
     auth.delete_user(user)
   end
 
+  # Changes the specified users password.
+  def change_user_password(user, new_password)
+    auth.change_user_password(user, new_password)
+  end
+
+  # List all users.
   def user_list
     auth.user_list
   end
 
+  # Authenticate using specified user and password.
+  # On successful authentication, an auth token will be assigned to the instance.
   def authenticate(user, password)
     token = auth.generate_token(user, password)
     if token
@@ -73,35 +90,57 @@ class Etcd
       @options[:password] = password
       return true
     end
+    return false
   rescue GRPC::InvalidArgument => exception
-    print exception.message
     return false
   end
 
+  # List all roles.
   def role_list
     auth.role_list
   end
 
-  def add_role(name, permission, key, range_end='')
-    auth.add_role(name, permission, key, range_end)
+  # Add role with specified name.
+  def add_role(name)
+    auth.add_role(name)
   end
 
+  # Fetches a specified role.
+  def get_role(name)
+    auth.get_role(name)
+  end
+
+  # Delete role.
   def delete_role(name)
     auth.delete_role(name)
   end
 
+  # Grants role to an existing user.
   def grant_role_to_user(user, role)
     auth.grant_role_to_user(user, role)
   end
 
+  # Revokes role from a specified user.
   def revoke_role_from_user(user, role)
     auth.revoke_role_from_user(user, role)
   end
 
+  # Grants a new permission to an existing role.
+  def grant_permission_to_role(name, permission, key, range_end='')
+    auth.grant_permission_to_role(name, permission, key, range_end)
+  end
+
+  def revoke_permission_from_role(name, permission, key, range_end='')
+    auth.revoke_permission_from_role(name, permission, key, range_end)
+  end
+
+  # Enables authentication.
   def enable_auth
     auth.enable_auth
   end
 
+  # Disables authentication.
+  # This will clear any active auth / token data.
   def disable_auth
     response = auth.disable_auth
     if response

data/spec/etcd_spec.rb

@@ -6,25 +6,14 @@ describe Etcd do
       Etcd.new(url: 'http://127.0.0.1:2379')
     end
     describe '#initialize' do
-      it 'assigns scheme' do
-        expect(conn.scheme).to eq('http')
-      end
-
-      it 'assigns host' do
-        expect(conn.hostname).to eq('127.0.0.1')
-      end
-
-      it 'assigns port' do
-        expect(conn.port).to eq(2379)
-      end
-
-      it 'returns nil token' do
-        expect(conn.token).to eq(nil)
-      end
-
-      it 'assigns proper credentials' do
-        expect(conn.credentials).to eq(:this_channel_is_insecure)
-      end
+      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(port: 2379) }
+      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
   end
 end

data/spec/etcdv3/auth_spec.rb

@@ -7,80 +7,100 @@ describe Etcd::Auth do
   end
 
   describe '#add_user' do
-    it 'returns AuthUserAddResponse' do
-      expect(conn.add_user("boom", 'test')).to \
-        be_an_instance_of(Etcdserverpb::AuthUserAddResponse)
-    end
+    after { conn.delete_user('boom') }
+    subject { conn.add_user('boom', 'test') }
+    it { is_expected.to be_an_instance_of(Etcdserverpb::AuthUserAddResponse) }
   end
 
-  describe '#user_list' do
-
-    it 'returns Protobuf' do
-      expect(conn.user_list).to \
-        be_an_instance_of(Google::Protobuf::RepeatedField)
-    end
+  describe '#get_user' do
+    before { conn.add_user('get_user', 'password') }
+    after { conn.delete_user('get_user') }
+    subject { conn.get_user('get_user') }
+    it { is_expected.to be_an_instance_of(Etcdserverpb::AuthUserGetResponse) }
+  end
 
-    it 'returns listme user' do
-      conn.add_user('listme', 'test')
-      expect(conn.user_list).to include('listme')
+  describe '#user_list' do
+    before { conn.add_user('list', 'test') }
+    after { conn.delete_user('list') }
+    subject { conn.user_list }
+    it 'returns correcty user information' do
+      expect(subject).to be_an_instance_of(Google::Protobuf::RepeatedField)
+      expect(subject).to include('list')
     end
   end
 
   describe '#delete_user' do
-    before do
-      conn.add_user('testuser', 'test')
-    end
-    it 'returns AuthUserDeleteResponse' do
-      expect(conn.delete_user('testuser')).to \
-        be_an_instance_of(Etcdserverpb::AuthUserDeleteResponse)
-    end
+    before { conn.add_user('delete_user', 'test') }
+    subject { conn.delete_user('delete_user') }
+    it { is_expected.to be_an_instance_of(Etcdserverpb::AuthUserDeleteResponse) }
   end
 
   describe '#grant_role_to_user' do
-    before do
-      conn.add_user('root', 'password')
-    end
-    after do
-      conn.delete_user('root')
-    end
-    it 'returns AuthUserGrantRoleResponse' do
-      expect(conn.grant_role_to_user("root", 'root')).to \
-        be_an_instance_of(Etcdserverpb::AuthUserGrantRoleResponse)
-    end
+    before { conn.add_user('grant_user', 'test') }
+    after { conn.delete_user('grant_user') }
+    subject { conn.grant_role_to_user('grant_user', 'root') }
+    it { is_expected.to be_an_instance_of(Etcdserverpb::AuthUserGrantRoleResponse) }
   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)
+      conn.add_user('revoke_user', 'password')
+      conn.grant_role_to_user('revoke_user', 'root')
     end
+    after { conn.delete_user('revoke_user') }
+    subject { conn.revoke_role_from_user('revoke_user', 'root') }
+    it { is_expected.to be_an_instance_of(Etcdserverpb::AuthUserRevokeRoleResponse) }
   end
 
   describe '#add_role' do
-    it 'returns AuthRoleAddResponse' do
-      expect(conn.add_role('testRole', 'readwrite', 'a', 'Z')).to \
-        be_an_instance_of(Etcdserverpb::AuthRoleAddResponse)
+    after { conn.delete_role('add_role') }
+    subject { conn.add_role('add_role') }
+    it 'adds a role' do
+      expect(subject).to be_an_instance_of(Etcdserverpb::AuthRoleAddResponse)
+      expect(conn.role_list.roles).to include('add_role')
     end
   end
 
-  describe '#add_delete' do
-    it 'returns AuthRoleAddResponse' do
-      expect(conn.delete_role('testRole')).to \
-        be_an_instance_of(Etcdserverpb::AuthRoleDeleteResponse)
+  describe '#get_role' do
+    before { conn.add_role('get_role') }
+    after { conn.delete_role('get_role') }
+    subject { conn.get_role('get_role') }
+    it { is_expected.to be_an_instance_of(Etcdserverpb::AuthRoleGetResponse) }
+  end
+
+  describe '#delete_role' do
+    before { conn.add_role('delete_role') }
+    subject { conn.delete_role('delete_role') }
+    it 'deletes role' do
+      expect(subject).to be_an_instance_of(Etcdserverpb::AuthRoleDeleteResponse)
+      expect(conn.role_list.roles).to_not include('delete_role')
     end
   end
 
   describe '#role_list' do
-    it 'returns AuthRoleListResponse' do
-      expect(conn.role_list).to \
-        be_an_instance_of(Etcdserverpb::AuthRoleListResponse)
+    subject { conn.role_list }
+    it { is_expected.to be_an_instance_of(Etcdserverpb::AuthRoleListResponse) }
+  end
+
+  describe '#grant_permission_to_role' do
+    before { conn.add_role('grant_perm') }
+    after { conn.delete_role('grant_perm') }
+    subject { conn.grant_permission_to_role('grant_perm', 'write', 'c', 'cc') }
+    it 'sets permission' do
+      expect(subject).to be_an_instance_of(Etcdserverpb::AuthRoleGrantPermissionResponse)
+    end
+  end
+
+  describe '#revoke_permission_from_role' do
+    before do
+      conn.add_role('myrole')
+      conn.grant_permission_to_role('myrole', 'write', 'c', 'cc')
+    end
+    after { conn.delete_role('myrole') }
+    subject { conn.revoke_permission_from_role('myrole', 'write', 'c', 'cc') }
+    it 'revokes permission' do
+      expect(subject).to be_an_instance_of(Etcdserverpb::AuthRoleRevokePermissionResponse)
+      expect(conn.get_role('myrole').perm.size).to eq(0)
     end
   end
 
@@ -91,13 +111,9 @@ describe Etcd::Auth do
       conn.enable_auth
       conn.authenticate('root', 'test')
     end
-    after do
-      conn.delete_user('root')
-    end
-    it 'returns AuthDisableResponse' do
-      expect(conn.disable_auth).to \
-        be_an_instance_of(Etcdserverpb::AuthDisableResponse)
-    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
@@ -110,9 +126,15 @@ describe Etcd::Auth do
       conn.disable_auth
       conn.delete_user('root')
     end
-    it 'returns AuthEnableResponse' do
-      expect(conn.enable_auth).to be_an_instance_of(Etcdserverpb::AuthEnableResponse)
-    end
+    subject { conn.enable_auth }
+    it { is_expected.to be_an_instance_of(Etcdserverpb::AuthEnableResponse) }
+  end
+
+  describe '#change_user_password' do
+    before { conn.add_user('myuser', 'test') }
+    after { conn.delete_user('myuser') }
+    subject { conn.change_user_password('myuser', 'boom') }
+    it { is_expected.to be_an_instance_of(Etcdserverpb::AuthUserChangePasswordResponse) }
   end
 
   describe "#authenticate" do
@@ -127,7 +149,7 @@ describe Etcd::Auth do
         conn.disable_auth
         conn.delete_user('root')
       end
-      it 'properly reconfigures token + user + password' do
+      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')
@@ -135,9 +157,8 @@ describe Etcd::Auth do
     end
 
     context 'auth disabled' do
-      it 'returns false when authenticating with auth disabled' do
-        expect(conn.authenticate('root', 'root')).to eq(false)
-      end
+      subject { conn.authenticate('root', 'root') }
+      it { is_expected.to eq(false) }
     end
   end
 end

data/spec/etcdv3/kv_spec.rb

@@ -7,23 +7,17 @@ describe Etcd::KV do
   end
 
   describe '#put' do
-    it 'returns PutResponse' do
-      expect(conn.put('test', 'test')).to \
-        be_an_instance_of(Etcdserverpb::PutResponse)
-    end
+    subject { conn.put('test', 'test') }
+    it { is_expected.to be_an_instance_of(Etcdserverpb::PutResponse) }
   end
 
   describe '#get' do
-    before do
-      conn.put('test', "zoom")
-    end
-    it 'returns protobuf' do
-      expect(conn.get('test')).to \
-        be_an_instance_of(Google::Protobuf::RepeatedField)
-    end
-
-    it 'returns correct result' do
-      expect(conn.get('test').first.key).to eq('test')
+    before { conn.put('test', "zoom") }
+    subject { conn.get('test') }
+    it 'returns correct response' do
+      expect(subject).to be_an_instance_of(Google::Protobuf::RepeatedField)
+      expect(subject.first.key).to eq('test')
+      expect(subject.size).to eq(1)
     end
   end
 end

data/spec/helpers/test_instance.rb

@@ -42,7 +42,7 @@ module Helpers
     end
 
     def stop
-      @pids.each { |pid| Process.kill('TERM', pid) }
+      @pids.each { |pid| Process.kill('TERM', pid) } rescue nil
       FileUtils.remove_entry_secure(@tmpdir, true)
       @pids.clear
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etcdv3
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Shaun Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-31 00:00:00.000000000 Z
+date: 2017-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A Etcd client library for Version 3