etcdv3 0.11.4 → 0.11.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18d76403d57c3e56b75e603931345900a4583b2e94d773b33ca04aa1547e304d
-  data.tar.gz: f1d1f9336f62f18b32fb9d3f055e0043bddb6076022b922b097c0104a7467c8b
+  metadata.gz: f63c528f864012711cf608ca262674d7efd89caa6ac67674bb23e007df2920ab
+  data.tar.gz: 7a6c37da695eb6759a206ca5bfbd953ac647b17c7c19918596e7a6db86d065bf
 SHA512:
-  metadata.gz: 9633a47e982b7777ccda7e5472a663a661e4cf6368689cfbbd8d06a6ca862be47e7c3a75d075919b645611879513d4c88c7f59686b2a0eac15cc160e3ea7520f
-  data.tar.gz: 5a330de810e02ebdec73c279e33b7c2ece0c2aa7c4c877da89a2b285976ce68578ca20b3c51206d9a14c9fccbf18ef6310254010053eaefa59b06b898e1c195a
+  metadata.gz: 9b6b51ca358da66d57cd16358146f54f9c220a925f43fea326aa764887c647de76c40b860a05005d48f7bd9528fe239e985be39ceb0c886052147459bdc6e98f
+  data.tar.gz: fcf41864b7e54c74d8788a2d94688255880f193a6ad3527262f3a0b0512301693fb5cb90b72db9a52f0abcb9fad1541427dfda1970a9348225ec9579d651345d

data/lib/etcdv3/auth.rb

@@ -10,7 +10,7 @@ class Etcdv3
     }
 
     def initialize(hostname, credentials, timeout, metadata = {})
-      @stub = Etcdserverpb::Auth::Stub.new(hostname, credentials)
+      @stub = Etcdserverpb::Auth::Stub.new(hostname, credentials, **metadata.delete(:client_options) || {})
       @timeout = timeout
       @metadata = metadata
     end

data/lib/etcdv3/kv.rb

@@ -5,7 +5,7 @@ class Etcdv3
     include GRPC::Core::TimeConsts
 
     def initialize(hostname, credentials, timeout, metadata={})
-      @stub = Etcdserverpb::KV::Stub.new(hostname, credentials)
+      @stub = Etcdserverpb::KV::Stub.new(hostname, credentials, **metadata.delete(:client_options) || {})
       @timeout = timeout
       @metadata = metadata
     end

data/lib/etcdv3/lease.rb

@@ -3,7 +3,7 @@ class Etcdv3
     include GRPC::Core::TimeConsts
 
     def initialize(hostname, credentials, timeout, metadata={})
-      @stub = Etcdserverpb::Lease::Stub.new(hostname, credentials)
+      @stub = Etcdserverpb::Lease::Stub.new(hostname, credentials, **metadata.delete(:client_options) || {})
       @timeout = timeout
       @metadata = metadata
     end

data/lib/etcdv3/lock.rb

@@ -3,19 +3,19 @@ class Etcdv3
     include GRPC::Core::TimeConsts
 
     def initialize(hostname, credentials, timeout, metadata = {})
-      @stub = V3lockpb::Lock::Stub.new(hostname, credentials)
+      @stub = V3lockpb::Lock::Stub.new(hostname, credentials, **metadata.delete(:client_options) || {})
       @timeout = timeout
       @metadata = metadata
     end
 
     def lock(name, lease_id, timeout: nil)
       request = V3lockpb::LockRequest.new(name: name, lease: lease_id)
-      @stub.lock(request, deadline: deadline(timeout))
+      @stub.lock(request, metadata: @metadata, deadline: deadline(timeout))
     end
 
     def unlock(key, timeout: nil)
       request = V3lockpb::UnlockRequest.new(key: key)
-      @stub.unlock(request, deadline: deadline(timeout))
+      @stub.unlock(request, metadata: @metadata, deadline: deadline(timeout))
     end
 
     private

data/lib/etcdv3/maintenance.rb

@@ -13,7 +13,7 @@ class Etcdv3
     }
 
     def initialize(hostname, credentials, _timeout, metadata = {})
-      @stub = Etcdserverpb::Maintenance::Stub.new(hostname, credentials)
+      @stub = Etcdserverpb::Maintenance::Stub.new(hostname, credentials, **metadata.delete(:client_options) || {})
       @metadata = metadata
     end
 

data/lib/etcdv3/namespace/kv.rb

@@ -5,7 +5,7 @@ class Etcdv3::Namespace
     include GRPC::Core::TimeConsts
   
     def initialize(hostname, credentials, timeout, namespace, metadata={})
-      @stub = Etcdserverpb::KV::Stub.new(hostname, credentials)
+      @stub = Etcdserverpb::KV::Stub.new(hostname, credentials, **metadata.delete(:client_options) || {})
       @timeout = timeout
       @namespace = namespace
       @metadata = metadata

data/lib/etcdv3/namespace/lock.rb

@@ -4,7 +4,7 @@ class Etcdv3::Namespace
     include Etcdv3::Namespace::Utilities
 
     def initialize(hostname, credentials, timeout, namespace, metadata = {})
-      @stub = V3lockpb::Lock::Stub.new(hostname, credentials)
+      @stub = V3lockpb::Lock::Stub.new(hostname, credentials, **metadata.delete(:client_options) || {})
       @timeout = timeout
       @namespace = namespace
       @metadata = metadata
@@ -13,14 +13,14 @@ class Etcdv3::Namespace
     def lock(name, lease_id, timeout: nil)
       name = prepend_prefix(@namespace, name)
       request = V3lockpb::LockRequest.new(name: name, lease: lease_id)
-      resp = @stub.lock(request, deadline: deadline(timeout))
+      resp = @stub.lock(request, metadata: @metadata, deadline: deadline(timeout))
       strip_prefix_from_lock(@namespace, resp)
     end
 
     def unlock(key, timeout: nil)
       key = prepend_prefix(@namespace, key)
       request = V3lockpb::UnlockRequest.new(key: key)
-      @stub.unlock(request, deadline: deadline(timeout))
+      @stub.unlock(request, metadata: @metadata, deadline: deadline(timeout))
     end
 
     private

data/lib/etcdv3/namespace/watch.rb

@@ -4,7 +4,7 @@ class Etcdv3::Namespace
     include Etcdv3::Namespace::Utilities
 
     def initialize(hostname, credentials, timeout, namespace, metadata = {})
-      @stub = Etcdserverpb::Watch::Stub.new(hostname, credentials)
+      @stub = Etcdserverpb::Watch::Stub.new(hostname, credentials, **metadata.delete(:client_options) || {})
       @timeout = timeout
       @namespace = namespace
       @metadata = metadata

data/lib/etcdv3/version.rb

@@ -1,3 +1,3 @@
 class Etcdv3
-  VERSION = '0.11.4'.freeze
+  VERSION = '0.11.6'.freeze
 end

data/lib/etcdv3/watch.rb

@@ -3,7 +3,7 @@ class Etcdv3
     include GRPC::Core::TimeConsts
 
     def initialize(hostname, credentials, timeout, metadata = {})
-      @stub = Etcdserverpb::Watch::Stub.new(hostname, credentials)
+      @stub = Etcdserverpb::Watch::Stub.new(hostname, credentials, **metadata.delete(:client_options) || {})
       @timeout = timeout
       @metadata = metadata
     end

data/spec/etcdv3/lock_spec.rb

@@ -10,14 +10,28 @@ unless $instance.version < Gem::Version.new("3.2.0")
     #it_should_behave_like "a method with a GRPC timeout", described_class, :lock, :lock, 'foo'
 
     describe '#lock' do
-      let(:lease_id) { lease_stub.lease_grant(10)['ID'] }
-      subject { stub.lock('foo', lease_id) }
-      it { is_expected.to be_an_instance_of(V3lockpb::LockResponse) }
+      it 'returns a response' do
+        lease_id = lease_stub.lease_grant(10)['ID']
+
+        expect(stub.lock('example1', lease_id)).to be_an_instance_of(V3lockpb::LockResponse)
+      end
+
+      it 'passes metadata correctly' do
+        lease_id = lease_stub.lease_grant(10)['ID']
+        stub = expect_metadata_passthrough(described_class, :lock, :lock)
+        stub.lock('example2', lease_id)
+      end
     end
 
     describe '#unlock' do
-      subject { stub.unlock('foo') }
-      it { is_expected.to be_an_instance_of(V3lockpb::UnlockResponse) }
+      it 'returns a response' do
+        expect(stub.unlock('example3')).to be_an_instance_of(V3lockpb::UnlockResponse)
+      end
+
+      it 'passes metadata correctly' do
+        stub = expect_metadata_passthrough(described_class, :unlock, :unlock)
+        stub.unlock('example4')
+      end
     end
   end
 end

data/spec/etcdv3/namespace/lock_spec.rb

@@ -2,22 +2,41 @@ require 'spec_helper'
 
 # Locking is not implemented in etcd v3.1.X
 unless $instance.version < Gem::Version.new("3.2.0")
-  describe Etcdv3::Lock do
+  describe Etcdv3::Namespace::Lock do
     let(:stub) { local_namespace_stub(Etcdv3::Namespace::Lock, 1, '/namespace/') }
     let(:lease_stub) { local_stub(Etcdv3::Lease, 1) }
 
-    it_should_behave_like "a method with a GRPC timeout", described_class, :unlock, :unlock, 'foo'
+    # NOTE: this was running duplicate tests against Etcdv3::Lock before, but it
+    # doesn't work with Etcdv3::Namespace::Lock
+    #
+    # it_should_behave_like "a method with a GRPC timeout", described_class, :unlock, :unlock, 'foo'
+
     # it_should_behave_like "a method with a GRPC timeout", described_class, :lock, :lock, 'foo'
 
     describe '#lock' do
-      let(:lease_id) { lease_stub.lease_grant(10)['ID'] }
-      subject { stub.lock('foo', lease_id) }
-      it { is_expected.to be_an_instance_of(V3lockpb::LockResponse) }
+      it 'returns a response' do
+        lease_id = lease_stub.lease_grant(10)['ID']
+        expect(stub.lock('example1', lease_id)).to(
+          be_an_instance_of(V3lockpb::LockResponse)
+        )
+      end
+
+      it 'passes metadata correctly' do
+        lease_id = lease_stub.lease_grant(10)['ID']
+        stub = expect_metadata_passthrough_namespace(described_class, :lock, :lock, '/namespace/')
+        stub.lock('example2', lease_id)
+      end
     end
 
     describe '#unlock' do
-      subject { stub.unlock('foo') }
-      it { is_expected.to be_an_instance_of(V3lockpb::UnlockResponse) }
+      it 'returns a response' do
+        expect(stub.unlock('example3')).to be_an_instance_of(V3lockpb::UnlockResponse)
+      end
+
+      it 'passes metadata correctly' do
+        stub = expect_metadata_passthrough_namespace(described_class, :unlock, :unlock, '/namespace/')
+        stub.unlock('example4')
+      end
     end
   end
 end

data/spec/helpers/connections.rb

@@ -21,10 +21,18 @@ module Helpers
       interface.new(local_url, :this_channel_is_insecure, timeout, {})
     end
 
+    def local_stub_with_metadata(interface, timeout: nil, metadata: {})
+      interface.new(local_url, :this_channel_is_insecure, timeout, metadata)
+    end
+
     def local_namespace_stub(interface, timeout=nil, namespace)
       interface.new(local_url, :this_channel_is_insecure, timeout, namespace, {})
     end
 
+    def local_namespace_stub_with_metadata(interface, timeout: nil, namespace:, metadata: {})
+      interface.new(local_url, :this_channel_is_insecure, timeout, namespace, metadata)
+    end
+
     def local_url
       "127.0.0.1:#{port}"
     end

data/spec/helpers/metadata_passthrough.rb

@@ -0,0 +1,21 @@
+module Helpers
+  module MetadataPassthrough
+    include Connections
+
+    def expect_metadata_passthrough(stub_class, method_name, expectation_target)
+      metadata = { user: "foo", password: "bar" }
+      handler = local_stub_with_metadata(stub_class, metadata: metadata, timeout: 1)
+      inner_stub = handler.instance_variable_get("@stub")
+      expect(inner_stub).to receive(expectation_target).with(anything, hash_including(metadata: metadata)).and_call_original
+      return handler
+    end
+
+    def expect_metadata_passthrough_namespace(stub_class, method_name, expectation_target, namespace)
+      metadata = { user: "foo", password: "bar" }
+      handler = local_namespace_stub_with_metadata(stub_class, metadata: metadata, timeout: 1, namespace: namespace)
+      inner_stub = handler.instance_variable_get("@stub")
+      expect(inner_stub).to receive(expectation_target).with(anything, hash_including(metadata: metadata)).and_call_original
+      return handler
+    end
+  end
+end

data/spec/helpers/test_instance.rb

@@ -3,10 +3,12 @@ require 'tmpdir'
 require 'socket'
 require 'timeout'
 require 'helpers/connections'
+require 'helpers/metadata_passthrough'
 
 module Helpers
   class TestInstance
     include Helpers::Connections
+    include Helpers::MetadataPassthrough
 
     class InvalidVersionException < StandardError; end
     class PortInUseException < StandardError; end

data/spec/spec_helper.rb

@@ -3,20 +3,22 @@ $LOAD_PATH.unshift File.expand_path('./helpers', __FILE__)
 $LOAD_PATH.unshift File.expand_path('./namespace', __FILE__)
 
 
-# require 'simplecov'
-# require 'codecov'
-# SimpleCov.start
-# SimpleCov.formatter = SimpleCov::Formatter::Codecov
+require 'simplecov'
+require 'codecov'
+SimpleCov.start
+SimpleCov.formatter = SimpleCov::Formatter::Codecov
 
 require 'etcdv3'
 require 'helpers/test_instance'
 require 'helpers/connections'
+require 'helpers/metadata_passthrough'
 require 'helpers/shared_examples_for_timeout'
 
 $instance = Helpers::TestInstance.new
 
 RSpec.configure do |config|
   config.include(Helpers::Connections)
+  config.include(Helpers::MetadataPassthrough)
 
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etcdv3
 version: !ruby/object:Gem::Version
-  version: 0.11.4
+  version: 0.11.6
 platform: ruby
 authors:
 - Shaun Davis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2023-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -126,6 +126,7 @@ files:
 - spec/etcdv3/watch_spec.rb
 - spec/etcdv3_spec.rb
 - spec/helpers/connections.rb
+- spec/helpers/metadata_passthrough.rb
 - spec/helpers/shared_examples_for_timeout.rb
 - spec/helpers/test_instance.rb
 - spec/spec_helper.rb
@@ -133,7 +134,7 @@ homepage: https://github.com/davissp14/etcdv3-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,8 +149,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A Etcd client library for Version 3
 test_files:
@@ -166,6 +167,7 @@ test_files:
 - spec/etcdv3/watch_spec.rb
 - spec/etcdv3_spec.rb
 - spec/helpers/connections.rb
+- spec/helpers/metadata_passthrough.rb
 - spec/helpers/shared_examples_for_timeout.rb
 - spec/helpers/test_instance.rb
 - spec/spec_helper.rb