etcdv3 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b631270b8fb44fc9f63bf971305a3a5336bc9064
-  data.tar.gz: 799324974b4957ace06c52553281a37ac178a1af
+  metadata.gz: e3da4471fa89eef12de54927ad29a3dfe9ad78d1
+  data.tar.gz: d2c7b8a7df8d7a464881a6fa226c20cc24142347
 SHA512:
-  metadata.gz: fbe1eb6655e78bd7ba390bb84b5d11d8b2843f8ebab0ee12838d02a0da46508409847f993081307a2eb56192ea8bd0ec98156095964b11034e3872b413940195
-  data.tar.gz: 7124c6966834392ee9f11b44770160ee8e0ee2cdd3fa892901f58d1f87ce46b1f6c78257a0ce86df6bfc97887acba9bf525797da57f4c8302458538f25770278
+  metadata.gz: 5870f96529e1084efe1c18fdc8f3295371ec6a6008f744b3db3f48198bf05564c438a2191c5a29f33d7b5a0602f4c23b86f96ee020642fe546cd7b0d3e8aacee
+  data.tar.gz: 4bf35190f37e5453368c9a50349dcb7151f966278b88d6ef3429bdf86716670db0912fdfe9ef82b116a097b45211ff00a5858d58c1909e5d609f7b7ffa83769b

data/README.md

@@ -6,6 +6,8 @@ Ruby client for Etcd V3
 
 ## Getting Started
 
+[RubyDocs](http://www.rubydoc.info/gems/etcdv3/0.1.1/Etcd)
+
 To install etcdv3, run the following command:
 ```
 gem install etcdv3
@@ -87,3 +89,12 @@ Disabling auth will clear the auth token and all previously attached user inform
 ```
 conn.disable_auth
 ```
+
+**Alarms**
+```
+# List all active Alarms
+conn.alarm_list
+
+# Deactivate ALL active Alarms
+conn.deactivate_alarms
+```

data/lib/etcdv3.rb

@@ -5,6 +5,7 @@ require 'uri'
 require 'etcdv3/etcdrpc/rpc_services_pb'
 require 'etcdv3/auth'
 require 'etcdv3/kv'
+require 'etcdv3/maintenance'
 
 class Etcd
 
@@ -45,6 +46,21 @@ class Etcd
     @metadata[:token] = auth.generate_token(user, password) unless user.nil?
   end
 
+  # Version of Etcd running on member
+  def version
+    maintenance.member_status.version
+  end
+
+  # Store size in bytes.
+  def db_size
+    maintenance.member_status.dbSize
+  end
+
+  # Cluster leader id
+  def leader_id
+    maintenance.member_status.leader
+  end
+
   # Inserts a new key.
   def put(key, value)
     kv.put(key, value)
@@ -84,15 +100,12 @@ class Etcd
   # On successful authentication, an auth token will be assigned to the instance.
   def authenticate(user, password)
     token = auth.generate_token(user, password)
-    if token
-      @metadata[:token] = token
-      @options[:user] = user
-      @options[:password] = password
-      return true
-    end
-    return false
-  rescue GRPC::InvalidArgument => exception
-    return false
+    return false unless token
+    @metadata[:token] = token
+    @options[:user] = user
+    @options[:password] = password
+
+    true
   end
 
   # List all roles.
@@ -151,6 +164,16 @@ class Etcd
     response
   end
 
+  # List active alarms
+  def alarm_list
+    maintenance.alarms(:get, leader_id)
+  end
+
+  # Disarm alarms on a specified member.
+  def deactivate_alarms
+    maintenance.alarms(:deactivate, leader_id)
+  end
+
   private
 
   def auth
@@ -161,6 +184,10 @@ class Etcd
     Etcd::KV.new(hostname, port, @credentials, @metadata)
   end
 
+  def maintenance
+    Etcd::Maintenance.new(hostname, port, @credentials, @metadata)
+  end
+
   def resolve_credentials
     case scheme
     when 'http'

data/lib/etcdv3/auth.rb

@@ -18,8 +18,7 @@ class Etcd
         Authpb::User.new(name: user, password: password)
       )
       response.token
-    rescue GRPC::FailedPrecondition => exception
-      puts exception.message
+    rescue GRPC::FailedPrecondition, GRPC::InvalidArgument => exception
       false
     end
 

data/lib/etcdv3/kv.rb

@@ -9,17 +9,11 @@ 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/maintenance.rb

@@ -0,0 +1,36 @@
+require 'ostruct'
+
+class Etcd
+  class Maintenance
+    # Sadly these are the only alarm types supported by the api right now.
+    ALARM_TYPES = {
+      NONE: 0,
+      NOSPACE: 1
+    }
+
+    ALARM_ACTIONS = {
+      get: 0,
+      activate: 1, # Should only be used in testing. Not a stable feature...
+      deactivate: 2
+    }
+
+    def initialize(hostname, port, credentials, metadata = {})
+      @stub = Etcdserverpb::Maintenance::Stub.new("#{hostname}:#{port}", credentials)
+      @metadata = metadata
+    end
+
+    def member_status
+      @stub.status(Etcdserverpb::StatusRequest.new, metadata: @metadata)
+    end
+
+    def alarms(action, member_id, alarm=:NONE)
+      alarm = ALARM_TYPES[alarm]
+      request = Etcdserverpb::AlarmRequest.new(
+        action: ALARM_ACTIONS[action],
+        memberID: member_id,
+        alarm: action == :deactivate ? ALARM_TYPES[:NOSPACE] : alarm
+      )
+      @stub.alarm(request)
+    end
+  end
+end

data/lib/etcdv3/version.rb

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

data/spec/etcdv3/maintenance_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Etcd::Maintenance do
+
+  let(:conn) do
+    Etcd.new(url: 'http://127.0.0.1:2379')
+  end
+
+  describe '#version' do
+    subject { conn.version }
+    it { is_expected.to_not be_nil }
+  end
+
+  describe '#leader_id' do
+    subject { conn.leader_id }
+    it { is_expected.to_not be_nil }
+  end
+
+  describe '#db_size' do
+    subject { conn.db_size }
+    it { is_expected.to_not be_nil }
+  end
+
+  describe '#alarm_list' do
+    before { conn.send(:maintenance).alarms(:activate, conn.leader_id, :NOSPACE) }
+    after { conn.deactivate_alarms }
+    subject { conn.alarm_list }
+    it 'returns an alarm' do
+        expect(subject).to be_an_instance_of(Etcdserverpb::AlarmResponse)
+        expect(subject.alarms.size).to eq(1)
+    end
+  end
+
+  describe '#deactivate_alarms' do
+    before { conn.send(:maintenance).alarms(:activate, conn.leader_id, :NOSPACE) }
+    subject { conn.deactivate_alarms }
+    it 'deactivates alarms' do
+      expect(subject).to be_an_instance_of(Etcdserverpb::AlarmResponse)
+      expect(conn.alarm_list.alarms.size).to eq(0)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etcdv3
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Shaun Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-01 00:00:00.000000000 Z
+date: 2017-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -57,6 +57,7 @@ files:
 - lib/etcdv3/etcdrpc/rpc_pb.rb
 - lib/etcdv3/etcdrpc/rpc_services_pb.rb
 - lib/etcdv3/kv.rb
+- lib/etcdv3/maintenance.rb
 - lib/etcdv3/protos/annotations.proto
 - lib/etcdv3/protos/auth.proto
 - lib/etcdv3/protos/descriptor.proto
@@ -68,6 +69,7 @@ files:
 - spec/etcd_spec.rb
 - spec/etcdv3/auth_spec.rb
 - spec/etcdv3/kv_spec.rb
+- spec/etcdv3/maintenance_spec.rb
 - spec/helpers/test_instance.rb
 - spec/spec_helper.rb
 homepage: https://github.com/davissp14/etcdv3-ruby
@@ -90,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A Etcd client library for Version 3
@@ -98,5 +100,6 @@ test_files:
 - spec/etcd_spec.rb
 - spec/etcdv3/auth_spec.rb
 - spec/etcdv3/kv_spec.rb
+- spec/etcdv3/maintenance_spec.rb
 - spec/helpers/test_instance.rb
 - spec/spec_helper.rb