etcdv3 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b63b789cf1ebf2e909c4818190278aed694886f5
-  data.tar.gz: d806b91ce19db3ee0c79d2c82e33648805f7de94
+  metadata.gz: 4e8425d9e034d0a1bab9cc37a5250694854807e8
+  data.tar.gz: b49869fe7b0fa100faccc29dd9d06806753c6a5d
 SHA512:
-  metadata.gz: 2538de053cd4757926e2f3dd542c0cbeaa8d8709917f56e534a708bd2f0928e534784940b61b42dfd0176e9ba0b3ff39534969799bcdfe7960669233fb3c8ea3
-  data.tar.gz: 325d9d8fa4692b1dfd57ae332ecb6e345519dc5ae400f57e4a502036c6f0a90903cdd2d60bd5ca597a36b8d0e1836f466fbf4f5551b73d78faf0c7c2561cb257
+  metadata.gz: '073189ecdbaa0c0719731731a4d2d05a0db0271855e7777f1c35d775d1196ea57554aa2cd8eaca7951e1a329dcf476d80f2024ee1aabe0ae540afe5ef024f5f7'
+  data.tar.gz: 0bdc23ddadaebb5827e3a241e5f7d7ec4a536d32196f1c1e64bbc3991433cd81fdbd05f664ea5cd1e776bede027b65da78754f1f1e8604a40295e63cdc83b920

data/.codeclimate.yml

@@ -0,0 +1,27 @@
+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/.gitignore

@@ -1,2 +1,8 @@
 Gemfile.lock
 *.sh
+*.gem
+/tmp/
+/.idea
+/coverage/*
+/doc/
+*.swp

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+python: 2.4
+
+env:
+  global:
+    - ETCD_VERSION=v3.1.4
+
+install:
+    - bundle install
+    - wget https://github.com/coreos/etcd/releases/download/$ETCD_VERSION/etcd-$ETCD_VERSION-linux-amd64.tar.gz -O etcd.tar.gz --no-check-certificate
+    - tar zxvf etcd.tar.gz
+    - export PATH=$PATH:etcd-$ETCD_VERSION-linux-amd64
+
+script: bundle exec rspec

data/README.md

@@ -1,36 +1,61 @@
-# etcdv3-ruby
+# etcdv3-ruby  [![Build Status](https://travis-ci.org/davissp14/etcdv3-ruby.svg?branch=master)](https://travis-ci.org/davissp14/etcdv3-ruby)
 
 Ruby client for Etcd V3
 
 **WARNING: This is very much a work in progress and should be considered unstable.**
 
-## Usage
+## Getting Started
 
-     # Initialize insecure Client
-     conn = Etcd.new(url: 'http://127.0.0.1:2379')
+To install etcdv3, run the following command:
+```
+gem install etcdv3
+```
 
-     # Initialize secure connection using default certificates
-     conn = Etcd.new(url: 'https://hostname:port')
+You can connect to Etcd by instantiating the Etcd class:
 
-     # Initialize secure connection with auth
-     conn = Etcd.new(url: 'https://hostname:port', user: "gary", password: "secret")
+```
+require 'etcdv3'
+
+# Insecure connection
+conn = Etcd.new(url: 'http://127.0.0.1:2379')
+
+# Secure connection using default certificates
+conn = Etcd.new(url: 'https://hostname:port')
+
+# Secure connection with Auth
+conn = Etcd.new(url: 'https://hostname:port', user: "gary", password: "secret")
+
+# Secure connection specifying own certificates
+# Coming soon...
+```
 
 **Adding and Fetching Keys**
-    
+
      # Put
      conn.put("my", "value")
 
      # Range
      conn.range("my")
-          
+
 **User Managment**
-   
+
      # Add User
      conn.add_user('admin', 'secret')
-     
+
      # Delete User
      conn.delete_user('admin')
-     
+
      # List users
      conn.user_list
-     
+
+     # Add Role
+     conn.add_role('rolename', 'readwrite', 'a', 'Z')
+
+     # Enable Authentication
+     conn.add_user('root', "secret")
+     conn.grant_role_to_user('root', 'root')
+     conn.enable_auth
+
+     # Disable Authentication
+     conn = Etcd.new(url: 'http://127.0.0.1:2379', user: 'root', password: 'secret')
+     conn.disable_auth

data/lib/etcdv3.rb

@@ -8,9 +8,7 @@ require 'etcdv3/kv'
 
 class Etcd
 
-  def options
-    Marshal.load(Martial.dump(@options))
-  end
+  attr_reader :credentials, :options
 
   def uri
     URI(@options[:url])
@@ -28,6 +26,10 @@ class Etcd
     uri.hostname
   end
 
+  def token
+    @metadata[:token]
+  end
+
   def user
     @options[:user]
   end
@@ -36,21 +38,11 @@ class Etcd
     @options[:password]
   end
 
-  def token
-    @metadata[:token]
-  end
-
-  def credentials
-    @credentials
-  end
-
-  def initialize(options={})
+  def initialize(options = {})
     @options = options
     @credentials = resolve_credentials
     @metadata = {}
-    unless user.nil?
-      @metadata[:token] = auth.generate_token(user, password)
-    end
+    @metadata[:token] = auth.generate_token(user, password) unless user.nil?
   end
 
   def put(key, value)
@@ -61,7 +53,6 @@ class Etcd
     kv.range(key, range_end, @metadata)
   end
 
-
   def add_user(user, password)
     auth.add_user(user, password, @metadata)
   end
@@ -74,6 +65,30 @@ class Etcd
     auth.user_list(@metadata)
   end
 
+  def role_list
+    auth.role_list(@metadata)
+  end
+
+  def add_role(name, permission, key, range_end='')
+    auth.add_role(name, permission, key, range_end, @metadata)
+  end
+
+  def delete_role(name)
+    auth.delete_role(name, @metadata)
+  end
+
+  def grant_role_to_user(user, role)
+    auth.grant_role_to_user(user, role, @metadata)
+  end
+
+  def enable_auth
+    auth.enable_auth
+  end
+
+  def disable_auth
+    auth.disable_auth(@metadata)
+  end
+
   private
 
   def auth
@@ -86,9 +101,9 @@ class Etcd
 
   def resolve_credentials
     case scheme
-    when "http"
+    when 'http'
       :this_channel_is_insecure
-    when "https"
+    when 'https'
       # Use default certs for now.
       GRPC::Core::ChannelCredentials.new
     else

data/lib/etcdv3/auth.rb

@@ -2,29 +2,84 @@
 class Etcd
   class Auth
 
+    PERMISSIONS = {
+      'read' => Authpb::Permission::Type::READ,
+      'write' => Authpb::Permission::Type::WRITE,
+      'readwrite' => Authpb::Permission::Type::READWRITE
+    }
+
     def initialize(hostname, port, credentials)
       @stub = Etcdserverpb::Auth::Stub.new("#{hostname}:#{port}", credentials)
     end
 
     def generate_token(user, password)
-      response = @stub.authenticate(Authpb::User.new(name: user, password: password))
+      response = @stub.authenticate(
+        Authpb::User.new(name: user, password: password)
+      )
       response.token
+    rescue GRPC::FailedPrecondition => exception
+      puts exception.message
     end
 
-    def user_list(metadata={})
+    def user_list(metadata = {})
       @stub.user_list(Authpb::User.new, metadata: metadata).users
+    rescue GRPC::FailedPrecondition => exception
+      puts exception.message
     end
 
-    def add_user(user, password, metadata={})
-      @stub.user_add(Authpb::User.new(name: user, password: password), metadata: metadata)
-
+    def add_user(user, password, metadata = {})
+      @stub.user_add(
+        Authpb::User.new(name: user, password: password), metadata: metadata
+      )
     rescue GRPC::FailedPrecondition => exception
       puts exception.message
     end
 
-    def delete_user(user, metadata={})
+    def delete_user(user, metadata = {})
       @stub.user_delete(Authpb::User.new(name: user), metadata: metadata)
+    rescue GRPC::FailedPrecondition => exception
+      puts exception.message
+    end
+
+    def add_role(name, permission, key, range_end, metadata = {})
+      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
+      )
+    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
+    end
+
+    def grant_role_to_user(user, role, metadata = {})
+      request = Etcdserverpb::AuthUserGrantRoleRequest.new(user: user, role: role)
+      @stub.user_grant_role(request)
+    rescue GRPC::FailedPrecondition => exception
+      puts exception.message
+    end
+
+    def role_list(metadata = {})
+      @stub.role_list(Authpb::Role.new, metadata: metadata)
+    rescue GRPC::FailedPrecondition => exception
+      puts exception.message
+    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
     end

data/lib/etcdv3/kv.rb

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

data/lib/etcdv3/version.rb

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

data/spec/etcd_spec.rb

@@ -1,15 +1,11 @@
 require 'spec_helper'
 
 describe Etcd do
-
   context 'Insecure connection without Auth' do
-
-    let(:conn){ Etcd.new(
-      url: 'http://127.0.0.1:2379'
-    )}
-
+    let(:conn) 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
@@ -30,23 +26,5 @@ describe Etcd do
         expect(conn.credentials).to eq(:this_channel_is_insecure)
       end
     end
-
-    describe "#put" do
-      it 'issues put request' do
-        expect(conn.put('test', 'test')).to be_an_instance_of(Etcdserverpb::PutResponse)
-      end
-    end
-
-    describe "#range" do
-      it 'returns protobuf' do
-        expect(conn.range('test', '')).to be_an_instance_of(Google::Protobuf::RepeatedField)
-      end
-
-      it 'returns correct result' do
-        expect(conn.range('test', '').first.key).to eq('test')
-      end
-    end
-
   end
-
 end

data/spec/etcdv3/auth_spec.rb

@@ -1,38 +1,103 @@
-# require 'spec_helper'
-# require 'securerandom'
-#
-# describe Etcd::Auth do
-#
-#   context "User managment without Auth" do
-#
-#     let(:stub){ Etcd::Auth.new("127.0.0.1", 2379, :this_channel_is_insecure)}
-#     let(:rando) { SecureRandom.hex(10) }
-#
-#     describe "#add_user" do
-#       it 'adds user' do
-#         expect(stub.add_user(rando, 'test')).to be_an_instance_of(Etcdserverpb::AuthUserAddResponse)
-#       end
-#     end
-#
-#     describe "#user_list" do
-#       it 'has correct data type' do
-#         expect(stub.user_list).to be_an_instance_of(Google::Protobuf::RepeatedField)
-#       end
-#
-#       it 'contains user testy' do
-#         puts stub.user_list
-#         expect(stub.user_list).to eq(rando)
-#       end
-#     end
-#
-#     describe "#delete_user" do
-#
-#       it 'deletes user' do
-#         expect(stub.delete_user(rando)).to be_an_instance_of(Etcdserverpb::AuthUserDeleteResponse)
-#       end
-#
-#     end
-#
-#   end
-#
-# end
+require 'spec_helper'
+
+describe Etcd::Auth do
+
+  let(:stub) do
+    Etcd::Auth.new('127.0.0.1', 2379, :this_channel_is_insecure)
+  end
+
+  describe '#add_user' do
+    it 'returns AuthUserAddResponse' do
+      expect(stub.add_user("boom", 'test')).to \
+        be_an_instance_of(Etcdserverpb::AuthUserAddResponse)
+    end
+  end
+
+  describe '#user_list' do
+
+    it 'returns Protobuf' do
+      expect(stub.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')
+    end
+  end
+
+  describe '#delete_user' do
+    before do
+      stub.add_user('testuser', 'test')
+    end
+    it 'returns AuthUserDeleteResponse' do
+      expect(stub.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')
+    end
+    after do
+      stub.delete_user('root')
+    end
+    it 'returns AuthUserGrantRoleResponse' do
+      expect(stub.grant_role_to_user("root", 'root')).to \
+        be_an_instance_of(Etcdserverpb::AuthUserGrantRoleResponse)
+    end
+  end
+
+  describe '#add_role' do
+    it 'returns AuthRoleAddResponse' do
+      expect(stub.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 \
+        be_an_instance_of(Etcdserverpb::AuthRoleDeleteResponse)
+    end
+  end
+
+  describe '#role_list' do
+    it 'returns AuthRoleListResponse' do
+      expect(stub.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
+    end
+    after do
+      stub.delete_user('root')
+    end
+    it 'returns AuthDisableResponse' do
+      token = stub.generate_token('root', 'test')
+      expect(stub.disable_auth(token: token)).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')
+    end
+    after do
+      token = stub.generate_token('root', 'test')
+      stub.disable_auth(token: token)
+      stub.delete_user('root')
+    end
+    it 'returns AuthEnableResponse' do
+      expect(stub.enable_auth).to be_an_instance_of(Etcdserverpb::AuthEnableResponse)
+    end
+  end
+end

data/spec/etcdv3/kv_spec.rb

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

data/spec/helpers/test_instance.rb

@@ -0,0 +1,59 @@
+require 'fileutils'
+require 'tmpdir'
+
+module Helpers
+  class TestInstance
+    MINIMUM_VERSION = Gem::Version.new('3.0.0')
+
+    def initialize
+      @pids = []
+      @tmpdir = Dir.mktmpdir
+      @bin = discover_binary_path
+      @version = discover_binary_version
+
+      raise "Invalid Etcd Version: #{@version}. Must be running 3.0+" \
+        if @version < MINIMUM_VERSION
+    end
+
+    def start
+      raise "Already running etcd servers(#{@pids.inspect})" unless @pids.empty?
+      puts 'Starting up testing environment...'
+      @pids << spawn_etcd_instance
+      sleep(5)
+    end
+
+    def spawn_etcd_instance
+      peer_url = 'http://127.0.0.1:2380'
+      client_url = 'http://127.0.0.1:2379'
+      cluster_url = 'node=http://127.0.0.1:2380'
+      flags =  ' --name=node'
+      flags << " --initial-advertise-peer-urls=#{peer_url}"
+      flags << " --listen-peer-urls=#{peer_url}"
+      flags << " --listen-client-urls=#{client_url}"
+      flags << " --advertise-client-urls=#{client_url}"
+      flags << " --initial-cluster=#{cluster_url}"
+      flags << " --data-dir=#{@tmpdir} "
+
+      # Assumes etcd is in PATH
+      command = "ETCDCTL_API=3 #{@bin} " + flags
+      pid = spawn(command, out: '/dev/null', err: '/dev/null')
+      Process.detach(pid)
+      pid
+    end
+
+    def stop
+      @pids.each { |pid| Process.kill('TERM', pid) }
+      FileUtils.remove_entry_secure(@tmpdir, true)
+      @pids.clear
+    end
+
+    def discover_binary_path
+      'etcd'
+    end
+
+    def discover_binary_version
+      result = `#{@bin} --version | grep "etcd Version"`
+      Gem::Version.new(result.split(':').last.strip)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,14 +1,22 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('./helpers', __FILE__)
 
 require 'etcdv3'
+require 'helpers/test_instance'
+
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
-
   config.mock_with :rspec do |mocks|
     mocks.verify_partial_doubles = true
   end
   config.shared_context_metadata_behavior = :apply_to_host_groups
+  instance = Helpers::TestInstance.new
+  config.before(:suite) do
+    instance.start
+  end
+  config.after(:suite) do
+    instance.stop
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etcdv3
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Shaun Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-30 00:00:00.000000000 Z
+date: 2017-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -44,9 +44,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - README.md
 - etcdv3.gemspec
@@ -67,6 +69,8 @@ files:
 - lib/etcdv3/version.rb
 - spec/etcd_spec.rb
 - spec/etcdv3/auth_spec.rb
+- spec/etcdv3/kv_spec.rb
+- spec/helpers/test_instance.rb
 - spec/spec_helper.rb
 homepage: https://github.com/davissp14/etcdv3-ruby
 licenses:
@@ -95,4 +99,6 @@ 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/helpers/test_instance.rb
 - spec/spec_helper.rb