etcdv3 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 443472175a4cc4232c56f54afac01f0ca3bd1ae8
-  data.tar.gz: 3e5a3264ddb63003b330133e1e2ed0bc4b51716e
+  metadata.gz: 5f86e90b466cc1cf9999d8f9cbf08f5df1e2ac86
+  data.tar.gz: f8f237e1253a7218dfba6eae660e1553f54b07f6
 SHA512:
-  metadata.gz: 9d87445129496ab8919e580b652818a4f136f552e84215812a3a31348ae54f0eabe209bc09ce7a677fa9d8bb590e2c7657c324fb17158a1c84c950c55208bad2
-  data.tar.gz: bb48f8937f5edcaf62231a1ed46c17af1c1a1f5a95735b3db100660d3b93450850bebada9830ea75cc51ba5ca3e1c67220d5d3341ed4d6ce3cc1782d59ae5ea6
+  metadata.gz: 57d227117a3f8f82ae8d2a6691ed3468d7c8faf0a071d12182b2980c7784c456277315fb9945931ffa9c81882da7c748c188635d6dddf172ddbd9cc1aaf380e3
+  data.tar.gz: f53b3f71bb23e3961eaef3858f7cf22b69182835072fc1936146cd88b9d499cd6ed118538945a274e694e392f28ca57ae5bc1e29c73111a350a30afeaba9e59a

data/README.md

@@ -10,13 +10,13 @@ Ruby client for Etcd V3
 [RubyDocs](http://www.rubydoc.info/gems/etcdv3/0.1.1/Etcd)
 
 To install etcdv3, run the following command:
-```
+```ruby
 gem install etcdv3
 ```
 
-**Establishing a connection**
+## Establishing a connection
 
-```
+```ruby
 require 'etcdv3'
 
 # Insecure connection
@@ -32,8 +32,8 @@ conn = Etcdv3.new(url: 'https://hostname:port', user: "gary", password: "secret"
 # Coming soon...
 ```
 
-**Adding, Fetching and Deleting Keys**
-```
+## Adding, Fetching and Deleting Keys
+```ruby
  # Put
  conn.put("my", "value")
 
@@ -50,8 +50,8 @@ conn = Etcdv3.new(url: 'https://hostname:port', user: "gary", password: "secret"
  conn.del('my', range_end: 'myyy')
  ```
 
-**User Management**
-```
+## User Management
+```ruby
  # Add User
  conn.add_user('admin', 'secret')
 
@@ -62,8 +62,8 @@ conn.delete_user('admin')
 conn.user_list
 ```
 
-**Role Management**
-```
+## Role Management
+```ruby
 # Add Role
 conn.add_role('rolename')
 
@@ -77,8 +77,8 @@ conn.delete_role('rolename')
 conn.role_list
 ```
 
-**Authentication Management**
-```
+## Authentication Management
+```ruby
 # Configure a root user
 conn.add_user('root', 'mysecretpassword')
 
@@ -89,7 +89,7 @@ conn.grant_role_to_user('root', 'root')
 conn.enable_auth
 ```
 After you enable authentication, you must authenticate.
-```
+```ruby
 # This will generate and assign an auth token that will be used in future requests.
 conn.authenticate('root', 'mysecretpassword')
 ```
@@ -98,8 +98,8 @@ Disabling auth will clear the auth token and all previously attached user inform
 conn.disable_auth
 ```
 
-**Leases**
-```
+## Leases
+```ruby
 # Grant a lease with a 100 second TTL
 conn.grant_lease(100)
 
@@ -113,8 +113,25 @@ conn.lease_ttl(1234566789)
 conn.revoke_lease(1234566789)
 ```
 
-**Alarms**
+## Watch
+```ruby
+# Watch for changes on a specified key and return
+events = conn.watch('names')
+
+# Watch for changes on a specified key range and return
+events = conn.watch('boom', range_end: 'booooooom')
+
+# Watches for changes continuously until killed.
+event_count = 0
+conn.watch('boom') do |events|
+  puts events
+  event_count = event_count + 1
+  break if event_count >= 10
+end
 ```
+
+## Alarms
+```ruby
 # List all active Alarms
 conn.alarm_list
 

data/lib/etcdv3/maintenance.rb

@@ -1,5 +1,3 @@
-require 'ostruct'
-
 class Etcdv3
   class Maintenance
     # Sadly these are the only alarm types supported by the api right now.

data/lib/etcdv3/request.rb

@@ -37,5 +37,9 @@ class Etcdv3
       @lease ||= Etcdv3::Lease.new(@hostname, @credentials, @metadata)
     end
 
+    def watch
+      @watch ||= Etcdv3::Watch.new(@hostname, @credentials, @metadata)
+    end
+
   end
 end

data/lib/etcdv3/version.rb

@@ -1,3 +1,3 @@
 class Etcdv3
-  VERSION = '0.3.2'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/lib/etcdv3/watch.rb

@@ -0,0 +1,26 @@
+class Etcdv3
+  class Watch
+
+    def initialize(hostname, credentials, metadata = {})
+      @stub = Etcdserverpb::Watch::Stub.new(hostname, credentials)
+      @metadata = metadata
+    end
+
+    def watch(key, range_end, block)
+      create_req = Etcdserverpb::WatchCreateRequest.new(key: key, range_end: range_end)
+      watch_req = Etcdserverpb::WatchRequest.new(create_request: create_req)
+      events = nil
+      @stub.watch([watch_req]).each do |resp|
+        next if resp.events.empty?
+        if block
+          block.call(resp.events)
+        else
+          events = resp.events
+          break
+        end
+      end
+      events
+    end
+
+  end
+end

data/lib/etcdv3.rb

@@ -9,6 +9,7 @@ require 'etcdv3/kv'
 require 'etcdv3/maintenance'
 require 'etcdv3/lease'
 require 'etcdv3/request'
+require 'etcdv3/watch'
 
 class Etcdv3
 
@@ -65,6 +66,11 @@ class Etcdv3
     request.handle(:maintenance, 'member_status').leader
   end
 
+  # Watches for changes on a specified key range.
+  def watch(key, range_end: '', &block)
+    request.handle(:watch, 'watch', [key, range_end, block])
+  end
+
   # List active alarms
   def alarm_list
     request.handle(:maintenance, 'alarms', [:get, leader_id])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: etcdv3
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Shaun Davis
@@ -68,6 +68,7 @@ files:
 - lib/etcdv3/protos/rpc.proto
 - lib/etcdv3/request.rb
 - lib/etcdv3/version.rb
+- lib/etcdv3/watch.rb
 - spec/etcdv3/auth_spec.rb
 - spec/etcdv3/kv_spec.rb
 - spec/etcdv3/lease_spec.rb