diplomat 0.8.4 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b30733457f28024a240e54b598c45a2ef02d258
-  data.tar.gz: 50e43ddee795ae3418d2b5e05e71f05e2f803a5e
+  metadata.gz: 88a912b85c1348113d9b8e5f941bb652295dbac8
+  data.tar.gz: 64c21697ea68210e172293afc90b0bc894a238cc
 SHA512:
-  metadata.gz: d4e10a411987256743fc86bf7c95e812ecc2b1f785469bb07f441488426505b0d4c125bbc615c991fd76c6bec916369bca7fa1a07b4c6a8446cff6bcf0054479
-  data.tar.gz: ad2d634dda086ab217f7c67165ac8cce6afc4928fd95765334b77f94fcf78facdbea3e7f1e0b6ce2d4c6be05a7a1dec277f673e1a2a09447c2a0185f40b0dea8
+  metadata.gz: e17459f8b810a4213ffa6a1e87aa4e4a91391f289c954526ed06a4601a754d9e3d230d5666bf9b5775f053627258a45dd163d1cb327f27424588e08c959d1b95
+  data.tar.gz: 0b0300f116e79dafb2fd26a2b123962e0ccecfabb7733dfacf034f9ee69b15c728f3da15a07a1974a17591fb0cc5237da60e8ffa176594310d3c252134c57945

data/lib/diplomat/event.rb

@@ -26,7 +26,7 @@ module Diplomat
     # Get the list of events matching name
     # @param name [String] the name of the event (regex)
     # @param not_found [Symbol] behaviour if there are no events matching name;
-    #   :reject with exception, or :wait for a non-empty list
+    #   :reject with exception, :return degenerate value, or :wait for a non-empty list
     # @param found [Symbol] behaviour if there are already events matching name;
     #   :reject with exception, :return its current value, or :wait for its next value
     # @return [Array[hash]] The list of { :name, :payload } hashes
@@ -46,6 +46,9 @@ module Diplomat
     #   - 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)
+    #   - R X - meaningless; never return a meaningful value
+    #   - R R - "safe" non-blocking, non-throwing get-or-default operation
+    #   - R W - get the next value or a default
     #   - 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
@@ -61,6 +64,8 @@ module Diplomat
         case not_found
           when :reject
             raise Diplomat::EventNotFound, name
+          when :return
+            return []
         end
       else
         case found
@@ -83,7 +88,7 @@ module Diplomat
     #   String are tokens returned by previous calls to this function
     #   Symbols are the special tokens :first, :last, and :next
     # @param not_found [Symbol] behaviour if there is no matching event;
-    #   :reject with exception, or :wait for event
+    #   :reject with exception, :return degenerate value, or :wait for event
     # @param found [Symbol] behaviour if there is a matching event;
     #   :reject with exception, or :return its current value
     # @return [hash] A hash with keys :value and :token;
@@ -114,12 +119,19 @@ module Diplomat
         case not_found
           when :reject
             raise Diplomat::EventNotFound, name
+          when :return
+            event_name = ""
+            event_payload = ""
+            event_token = :last
           when :wait
             @raw = wait_for_next_event(url)
             parse_body
             # If it's possible for two events to arrive at once,
             # this needs to #find again:
             event = @raw.last
+            event_name = event["Name"]
+            event_payload = Base64.decode64(event["Payload"])
+            event_token = event["ID"]
         end
       else
         case found
@@ -127,17 +139,16 @@ module Diplomat
             raise Diplomat::EventAlreadyExits, name
           when :return
             event = body[idx]
+            event_name = event["Name"]
+            event_payload = Base64.decode64(event["Payload"])
+            event_token = event["ID"]
         end
       end
 
       {
-        :value => {
-          :name => event["Name"],
-          :payload => Base64.decode64(event["Payload"])
-        },
-        :token => event["ID"]
+        :value => { :name => event_name, :payload => event_payload },
+        :token => event_token
       }
-
     end
 
 

data/lib/diplomat/kv.rb

@@ -11,7 +11,7 @@ module Diplomat
     # @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
+    #   :reject with exception, :return degenerate value, or :wait for it to appear
     # @param found [Symbol] behaviour if the key does exist;
     #   :reject with exception, :return its current value, or :wait for its next value
     # @return [String] The base64-decoded value associated with the key
@@ -24,6 +24,9 @@ module Diplomat
     #   - 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)
+    #   - R X - meaningless; never return a meaningful value
+    #   - R R - "safe" non-blocking, non-throwing get-or-default operation
+    #   - R W - get the next value or a default
     #   - 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
@@ -42,6 +45,8 @@ module Diplomat
         case not_found
           when :reject
             raise Diplomat::KeyNotFound, key
+          when :return
+            return @value = ""
           when :wait
             index = raw.headers["x-consul-index"]
         end

data/lib/diplomat/version.rb

@@ -1,3 +1,3 @@
 module Diplomat
-  VERSION = "0.8.4"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.9.0
 platform: ruby
 authors:
 - John Hamelink