diplomat 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f1c9c12e4e39b571bceb79ece16ea11b65e86a1
-  data.tar.gz: 20aab29fd76ec1ccca03f7051a2055d90e2e7c47
+  metadata.gz: 13812b43787dfad96eb90581712105f0c628d79b
+  data.tar.gz: 6a1243327e6ac77df41c96d9d00b6a6aaeb8e5c2
 SHA512:
-  metadata.gz: 90217e6d23c9fa287a1d53a0e6d9d4abb7e2700222f232b397e154004994880160a0ca97ae27019ba0811f2e054d190d61542a20292fa7c670ed9feeb847e7e8
-  data.tar.gz: 9666756e0d00d492342a4f5898885d459724c8fdbfe5fc36754abcab80fa11faa1a9d4819191183b96a94fff4ae3fa5630fc05708ff58dca12bb0eea31336280
+  metadata.gz: cbccfdcb4107ff7c5fe8a515207f93ab162c5f3a469e932ee1fbd71596302e2fdc0aa7a67b056139abba39029b781702f3c854a23a50e39fa70a53b7fee7442e
+  data.tar.gz: 50e25171fab1b59b069f180d4ca50ea5084795852bc0c4a4a18fe522e325da26c5922968508d7c69c92b8db9e4c753bdb3b757da7ea2da57e1b5aee714916c14

data/lib/diplomat.rb

@@ -20,7 +20,7 @@ module Diplomat
   self.root_path = File.expand_path "..", __FILE__
   self.lib_path = File.expand_path "../diplomat", __FILE__
 
-  require_libs "configuration", "rest_client", "kv", "service", "members", "check", "health", "session", "lock"
+  require_libs "configuration", "rest_client", "kv", "service", "members", "check", "health", "session", "lock", "error"
   self.configuration ||= Diplomat::Configuration.new
 
   class << self

data/lib/diplomat/error.rb

@@ -0,0 +1,5 @@
+module Diplomat
+  class KeyNotFound < StandardError; end
+  class KeyAlreadyExists < StandardError; end
+  class UnknownStatus < StandardError; end
+end

data/lib/diplomat/kv.rb

@@ -6,14 +6,69 @@ module Diplomat
 
     attr_reader :key, :value, :raw
 
-    # Get a value by its key
+    # Get a value by its key, potentially blocking for the first or next value
     # @param key [String] the key
+    # @param options [Hash] the query params
+    # @option options [String] :consistency The read consistency type
+    # @param not_found [Symbol] behaviour if the key doesn't exist;
+    #   :reject with exception, or :wait for it to appear
+    # @param found [Symbol] behaviour if the key does exist;
+    #   :reject with exception, :wait for its next value, or :return its current value
     # @return [String] The base64-decoded value associated with the key
-    def get key
+    # @note
+    #   When trying to access a key, there are two possibilites:
+    #   - The key doesn't (yet) exist
+    #   - The key exists. This may be its first value, there is no way to tell
+    #   The combination of not_found and found behaviour gives maximum possible
+    #   flexibility. For X: reject, R: return, W: wait
+    #   - X X - meaningless; never return a value
+    #   - X R - "normal" non-blocking get operation. Default
+    #   - X W - get the next value only (must have a current value)
+    #   - W X - get the first value only (must not have a current value)
+    #   - W R - get the first or current value; always return something, but
+    #           block only when necessary
+    #   - W W - get the first or next value; wait until there is an update
+    def get key, options=nil, not_found=:reject, found=:return
       @key = key
+      @options = options
+
       url = ["/v1/kv/#{@key}"]
       url += check_acl_token unless check_acl_token.nil?
-      @raw = @conn.get concat_url url
+      url += use_consistency(@options) unless use_consistency(@options).nil?
+
+      # 404s OK using this connection
+      raw = @conn_no_err.get concat_url url
+      if raw.status == 404
+        case not_found
+          when :reject
+            raise Diplomat::KeyNotFound, key
+          when :wait
+            index = raw.headers["x-consul-index"]
+        end
+      elsif raw.status == 200
+        case found
+          when :reject
+            raise Diplomat::KeyAlreadyExists, key
+          when :return
+            @raw = raw
+            parse_body
+            return return_value
+          when :wait
+            index = raw.headers["x-consul-index"]
+        end
+      else
+        raise Diplomat::UnknownStatus, "status #{raw.status}"
+      end
+
+      # Wait for first/next value
+      url = ["/v1/kv/#{@key}"]
+      url += check_acl_token unless check_acl_token.nil?
+      url += use_consistency(@options) unless use_consistency(@options).nil?
+      url += ["index=#{index}"]
+      @raw = @conn.get do |req|
+        req.url concat_url url
+        req.options.timeout = 86400
+      end
       parse_body
       return_value
     end
@@ -69,7 +124,7 @@ module Diplomat
 
     # Parse the body, apply it to the raw attribute
     def parse_body
-      @raw = JSON.parse(@raw.body).first
+      @raw = JSON.parse(@raw.body)
     end
 
     # Get the key from the raw output
@@ -79,8 +134,17 @@ module Diplomat
 
     # Get the value from the raw output
     def return_value
-      @value = @raw["Value"]
-      @value = Base64.decode64(@value) unless @value.nil?
+      if @raw.count == 1
+        @value = @raw.first["Value"]
+        @value = Base64.decode64(@value) unless @value.nil?
+      else
+        @value = @raw.map do |e|
+                   {
+                     key: e["Key"],
+                     value: e["Value"].nil? ? e["Value"] : Base64.decode64(e["Value"])
+                   }
+                 end
+      end
     end
 
     def check_acl_token
@@ -90,5 +154,9 @@ module Diplomat
     def use_cas(options)
       ["cas=#{options[:cas]}"] if options && options[:cas]
     end
+
+    def use_consistency(options)
+      ["#{options[:consistency]}"] if options && options[:consistency]
+    end
   end
 end

data/lib/diplomat/rest_client.rb

@@ -21,13 +21,23 @@ module Diplomat
     # Build the API Client
     # @param api_connection [Faraday::Connection,nil] supply mock API Connection
     def start_connection api_connection=nil
-      @conn = api_connection ||= Faraday.new(:url => Diplomat.configuration.url) do |faraday|
+      @conn = api_connection || Faraday.new(:url => Diplomat.configuration.url) do |faraday|
+        faraday.adapter  Faraday.default_adapter
         faraday.request  :url_encoded
+        faraday.response :raise_error
+
         Diplomat.configuration.middleware.each do |middleware|
           faraday.use middleware
         end
+      end
+
+      @conn_no_err = api_connection || Faraday.new(:url => Diplomat.configuration.url) do |faraday|
         faraday.adapter  Faraday.default_adapter
-        faraday.use      Faraday::Response::RaiseError
+        faraday.request  :url_encoded
+
+        Diplomat.configuration.middleware.each do |middleware|
+          faraday.use middleware
+        end
       end
     end
 

data/lib/diplomat/version.rb

@@ -1,3 +1,3 @@
 module Diplomat
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - John Hamelink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -179,6 +179,7 @@ files:
 - lib/diplomat.rb
 - lib/diplomat/check.rb
 - lib/diplomat/configuration.rb
+- lib/diplomat/error.rb
 - lib/diplomat/health.rb
 - lib/diplomat/kv.rb
 - lib/diplomat/lock.rb