etcdv3 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 688201ef38aa54b086f120a6b5eaaaef142167de
-  data.tar.gz: ed7714479e957b95959e26610db9aaab66fdef89
+  metadata.gz: bfb94e2d833d0412e229748f89be3697776aa677
+  data.tar.gz: a4878727100089890d69309ea3e063d767a8f5ec
 SHA512:
-  metadata.gz: 56fe98b7cde847d737d30767894f1e964fbda6935e6775259c94f25cb1bb04af49a9644b2f62a02d05edf58571bf4d379e28f30fc64dc5f6226229ce5a39ab51
-  data.tar.gz: f00d91763751a2872e09c71790043c639dadc0ffa5e8ce05df6dd9bd6a3f0cf16f646bc84f525be44df801b820d98e05262625c55d46565c807053de7cb8711d
+  metadata.gz: 5fbac1f489e35934579e6ed3e92158b23a5ad6aaf39c8c381b1a304b4a9f969cb954c79113c4b207d976a73c2c9638b30fa96ecc8393e77c08ccd77d581e86e1
+  data.tar.gz: 2a22159afd0bb01446764763e79dc5fffa47fe8d51edbd063f59f7afa801d40a8532213ca32f9be556482027124172ac169cb0fb11d104ebbe29f5771e113bf7

data/README.md

@@ -26,7 +26,7 @@ conn = Etcdv3.new(url: 'http://127.0.0.1:2379')
 conn = Etcdv3.new(url: 'https://hostname:port')
 
 # Secure connection with Auth
-conn = Etcdv3.new(url: 'https://hostname:port', user: "gary", password: "secret")
+conn = Etcdv3.new(url: 'https://hostname:port', user: 'root', password: 'mysecretpassword')
 
 # Secure connection specifying own certificates
 # Coming soon...
@@ -35,19 +35,19 @@ conn = Etcdv3.new(url: 'https://hostname:port', user: "gary", password: "secret"
 ## Adding, Fetching and Deleting Keys
 ```ruby
  # Put
- conn.put("my", "value")
+ conn.put('foo', 'bar')
 
  # Get
- conn.get("my")
+ conn.get('my')
 
  # Get Key Range
- conn.get('my', range_end: 'myyyy')
+ conn.get('foo', range_end: 'foo80')
 
  # Delete Key
- conn.del('my')
+ conn.del('foo')
 
  # Delete Key Range
- conn.del('my', range_end: 'myyy')
+ conn.del('foo', range_end: 'foo80')
  ```
 
 ## User Management
@@ -58,20 +58,23 @@ conn.user_add('admin', 'secret')
 # Delete User
 conn.user_delete('admin')
 
-# List users
+# Get User
+conn.user_get('admin')
+
+# List Users
 conn.user_list
 ```
 
 ## Role Management
 ```ruby
 # Add Role
-conn.role_add('rolename')
+conn.role_add('admin')
 
 # Grant Permission to Role
-conn.role_grant_permission('rolename', :readwrite, 'a', 'z')
+conn.role_grant_permission('admin', :readwrite, 'foo', 'foo99')
 
 # Delete Role
-conn.role_delete('rolename')
+conn.role_delete('admin')
 
 # List Roles
 conn.role_list
@@ -82,7 +85,7 @@ conn.role_list
 # Configure a root user
 conn.user_add('root', 'mysecretpassword')
 
-# Grant root user the root role
+# Grant root role to root user
 conn.user_grant_role('root', 'root')
 
 # Enable Authentication
@@ -104,7 +107,7 @@ conn.auth_disable
 conn.lease_grant(100)
 
 # Attach key to lease
-conn.put("testkey", "testvalue", lease_id: 1234566789)
+conn.put('foo', 'bar', lease_id: 1234566789)
 
 # Get information about lease and its attached keys
 conn.lease_ttl(1234566789)
@@ -116,10 +119,10 @@ conn.lease_revoke(1234566789)
 ## Watch
 ```ruby
 # Watch for changes on a specified key and return
-events = conn.watch('names')
+events = conn.watch('foo')
 
 # Watch for changes on a specified key range and return
-events = conn.watch('boom', range_end: 'booooooom')
+events = conn.watch('foo', range_end: 'fop')
 
 # Watches for changes continuously until killed.
 event_count = 0

data/lib/etcdv3/request.rb

@@ -1,35 +1,53 @@
+require 'base64'
 class Etcdv3
   class Request
 
-    attr_reader :metacache
+    HANDLERS = {
+      auth: Etcdv3::Auth,
+      kv: Etcdv3::KV,
+      maintenance: Etcdv3::Maintenance,
+      lease: Etcdv3::Lease,
+      watch: Etcdv3::Watch
+    }
 
-    def initialize(hostname, credentials, metadata, metacache='')
-      @handlers ||= handler_map(hostname, credentials, metadata)
-      @metacache = metacache
+    attr_reader :user, :password, :token
+
+    def initialize(hostname, credentials)
+      @user, @password, @token = nil, nil, nil
+      @hostname = hostname
+      @credentials = credentials
+      @handlers = handler_map
     end
 
-    def handle(stub, method, method_args=[])
+    def handle(stub, method, method_args=[], retries: 1)
       @handlers.fetch(stub).send(method, *method_args)
+    rescue GRPC::Unauthenticated => exception
+      # Regenerate token in the event it expires.
+      if exception.details == 'etcdserver: invalid auth token'
+        if retries > 0
+          authenticate(@user, @password)
+          return handle(stub, method, method_args, retries: retries - 1)
+        end
+      end
+      raise exception
+    end
+
+    def authenticate(user, password)
+      # Attempt to generate token using user and password.
+      @token = handle(:auth, 'generate_token', [user, password])
+      @user = user
+      @password = password
+      @handlers = handler_map(token: @token)
     end
 
     private
 
-    def handler_map(hostname, credentials, metadata)
+    def handler_map(metadata={})
       Hash[
-        handler_constants.map do |key, klass|
-          [key, klass.new(hostname, credentials, metadata)]
+        HANDLERS.map do |key, klass|
+          [key, klass.new(@hostname, @credentials, metadata)]
         end
       ]
     end
-
-    def handler_constants
-      {
-        auth: Etcdv3::Auth,
-        kv: Etcdv3::KV,
-        maintenance: Etcdv3::Maintenance,
-        lease: Etcdv3::Lease,
-        watch: Etcdv3::Watch
-      }
-    end
   end
 end

data/lib/etcdv3/version.rb

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

data/lib/etcdv3.rb

@@ -1,16 +1,16 @@
 
 require 'grpc'
 require 'uri'
-require 'base64'
 
 require 'etcdv3/etcdrpc/rpc_services_pb'
 require 'etcdv3/auth'
 require 'etcdv3/kv'
 require 'etcdv3/maintenance'
 require 'etcdv3/lease'
-require 'etcdv3/request'
 require 'etcdv3/watch'
 
+require 'etcdv3/request'
+
 class Etcdv3
 
   attr_reader :credentials, :options
@@ -31,24 +31,22 @@ class Etcdv3
     uri.hostname
   end
 
-  def token
-    @metadata[:token]
-  end
-
   def user
-    @options[:user]
+    request.user
   end
 
   def password
-    @options[:password]
+    request.password
+  end
+
+  def token
+    request.token
   end
 
   def initialize(options = {})
     @options = options
     @credentials = resolve_credentials
-    @metadata = {}
-    @metadata[:token] = generate_token(user, password) unless user.nil?
-    @metacache = set_metacache
+    authenticate(options[:user], options[:password]) unless options[:user].nil?
   end
 
   # Version of Etcd running on member
@@ -77,33 +75,23 @@ class Etcdv3
   end
 
   # Authenticate using specified user and password.
-  # On successful authentication, an auth token will be assigned to the instance.
+  # On successful authentication, an auth token will be assigned to the request instance.
   def authenticate(user, password)
-    token = generate_token(user, password)
-    return false unless token
-    @metadata[:token] = token
-    @options[:user] = user
-    @options[:password] = password
-    @metacache = set_metacache
-    true
+    request.authenticate(user, password)
   end
 
   # Enables authentication.
   def auth_enable
     request.handle(:auth, 'auth_enable')
+    true
   end
 
   # Disables authentication.
   # This will clear any active auth / token data.
   def auth_disable
-    response = request.handle(:auth, 'auth_disable')
-    if response
-      @metadata.delete(:token)
-      @options[:user] = nil
-      @options[:password] = nil
-      @metacache = set_metacache
-    end
-    response
+    request.handle(:auth, 'auth_disable')
+    request(reset: true)
+    true
   end
 
   # key                           - string
@@ -219,19 +207,9 @@ class Etcdv3
 
   private
 
-  def request
-    # Only re-initialize when metadata changes.
-    return @request if @request && @request.metacache == @metacache
-    @request = Request.new("#{hostname}:#{port}", @credentials, @metadata, @metacache)
-  end
-
-  # Generates a new hash using a base64 of the metadata.
-  def set_metacache
-    Base64.strict_encode64(@metadata.to_s)
-  end
-
-  def generate_token(user, password)
-    request.handle(:auth, 'generate_token', [user, password])
+  def request(reset: false)
+    return @request if @request && !reset
+    @request = Request.new("#{hostname}:#{port}", @credentials)
   end
 
   def resolve_credentials

data/spec/etcdv3_spec.rb

@@ -201,7 +201,7 @@ describe Etcdv3 do
       end
       after { conn.user_delete('root') }
       subject { conn.auth_disable }
-      it { is_expected.to be_an_instance_of(Etcdserverpb::AuthDisableResponse) }
+      it { is_expected.to eq(true) }
     end
 
     describe '#auth_enable' do
@@ -215,7 +215,7 @@ describe Etcdv3 do
         conn.user_delete('root')
       end
       subject { conn.auth_enable }
-      it { is_expected.to be_an_instance_of(Etcdserverpb::AuthEnableResponse) }
+      it { is_expected.to eq(true) }
     end
 
     describe "#authenticate" do
@@ -243,32 +243,5 @@ describe Etcdv3 do
         end
       end
     end
-
-    describe '#metacache' do
-      context 'uses cached request object' do
-        let!(:object_id) { conn.send(:request).object_id }
-        before { conn.user_add('root', 'test') }
-        after { conn.user_delete('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.user_add('root', 'test')
-          conn.user_grant_role('root', 'root')
-          conn.auth_enable
-          conn.authenticate('root', 'test')
-          conn.user_add('boom', 'password')
-        end
-        after do
-          conn.auth_disable
-          conn.user_delete('root')
-          conn.user_delete('boom')
-        end
-        subject { conn.send(:request).object_id }
-        it { is_expected.to_not eq(object_id) }
-      end
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etcdv3
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Shaun Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-17 00:00:00.000000000 Z
+date: 2017-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc