diplomat 2.2.5 → 2.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ee74cdd0ff09ba455fa1185856231070da1a7b5296bcec09db981a72cb0a235
-  data.tar.gz: 2fd779c20984bc5f394c9c5fb6aef1a30abfcc99bd74d1700044c6fe2cc1d4e4
+  metadata.gz: d4fc2a1fed34abcea03720130cdb3403c7f4e95183ba2685a7cb0e97a8b38021
+  data.tar.gz: e3d95df82fe5db865d2018f4cdc5bfc4795bf91e2d006b2ddc96141cea0e4184
 SHA512:
-  metadata.gz: 9d9a9c7e1d7a2fdfdabb7139013da70e5dee028c18dcd2fa820ed5d235a34a26ac3a1b5108d7fab2d76be1bad370ed85a47b791b190104088be2a63287d76d58
-  data.tar.gz: 9daf8932e9bd5e2e74ad19cb91b070552805f1f249d553c2975899edc2f1ee27146b6207fb07867cbbb563b0b60b8768d68fc3d276902de28ce0b0a65885d662
+  metadata.gz: 2f139bed5e80cd4f8f793a93d7171de48de69161a679336c5675847c26e3141d0c28b5bcea79dfc2447e7632750e12336d721ba9e48d11d60efd88062a799602
+  data.tar.gz: f6c7ad2ded6476794f53f03e70d663d06bbae0386a5246e8a84b3f5ec58cf18aa9f0c970f9b1e09f00da031ff14659e6564262f88b1c2abedf88b1754beafc5f

data/README.md

@@ -89,6 +89,26 @@ Diplomat::Kv.get('foo/', recurse: true)
 # => [{:key=>"foo/a", :value=>"lorem"}, {:key=>"foo/b", :value=>"ipsum"}, {:key=>"foo/c", :value=>"dolor"}]
 ```
 
+You can also use `get_all` to retrieve values recursively with a consistent return type:
+
+```ruby
+Diplomat::Kv.put('foo/a', 'lorem')
+Diplomat::Kv.put('foo/b', 'ipsum')
+Diplomat::Kv.put('foo/c', 'dolor')
+
+Diplomat::Kv.get('foo/', recurse: true)
+# => [{:key=>"foo/a", :value=>"lorem"}, {:key=>"foo/b", :value=>"ipsum"}, {:key=>"foo/c", :value=>"dolor"}]
+Diplomat::Kv.get_all('foo/')
+# => [{:key=>"foo/a", :value=>"lorem"}, {:key=>"foo/b", :value=>"ipsum"}, {:key=>"foo/c", :value=>"dolor"}]
+
+Diplomat::Kv.put('bar/a', 'lorem')
+
+Diplomat::Kv.get('bar/', recurse: true)
+# => "lorem"
+Diplomat::Kv.get_all('bar/')
+# => [{:key=>"bar/a", :value=>"lorem"}]
+```
+
 
 Or list all available keys:
 

data/lib/diplomat/kv.rb

@@ -1,7 +1,7 @@
 module Diplomat
   # Methods for interacting with the Consul KV API endpoint
   class Kv < Diplomat::RestClient
-    @access_methods = %i[get put delete txn]
+    @access_methods = %i[get get_all put delete txn]
     attr_reader :key, :value, :raw
 
     # Get a value by its key, potentially blocking for the first or next value
@@ -18,7 +18,7 @@ module Diplomat
     #   Only applies when combined with :keys option.
     # @option options [Boolean] :nil_values If to return keys/dirs with nil values
     # @option options [Boolean] :convert_to_hash Take the data returned from consul and build a hash
-    # @option options [Callable] :transformation funnction to invoke on keys values
+    # @option options [Callable] :transformation function to invoke on keys values
     # @param not_found [Symbol] behaviour if the key doesn't exist;
     #   :reject with exception, :return degenerate value, or :wait for it to appear
     # @param found [Symbol] behaviour if the key does exist;
@@ -42,20 +42,11 @@ module Diplomat
     #   - W W - get the first or next value; wait until there is an update
     # rubocop:disable PerceivedComplexity, MethodLength, LineLength, CyclomaticComplexity
     def get(key, options = {}, not_found = :reject, found = :return)
-      key = normalize_key_for_uri(key)
-      @key = key
       @options = options
-      custom_params = []
-      custom_params << recurse_get(@options)
-      custom_params << use_consistency(options)
-      custom_params << dc(@options)
-      custom_params << keys(@options)
-      custom_params << separator(@options)
-
       return_nil_values = @options && @options[:nil_values]
       transformation = @options && @options[:transformation] && @options[:transformation].methods.find_index(:call) ? @options[:transformation] : nil
+      raw = get_raw(key, options)
 
-      raw = send_get_request(@conn_no_err, ["/v1/kv/#{@key}"], options, custom_params)
       if raw.status == 404
         case not_found
         when :reject
@@ -86,18 +77,71 @@ module Diplomat
       end
 
       # Wait for first/next value
-      custom_params << use_named_parameter('index', index)
-      if options.nil?
-        options = { timeout: 86_400 }
-      else
-        options[:timeout] = 86_400
-      end
-      @raw = send_get_request(@conn, ["/v1/kv/#{@key}"], options, custom_params)
+      @raw = wait_for_value(index, options)
       @raw = parse_body
       return_value(return_nil_values, transformation)
     end
     # rubocop:enable PerceivedComplexity, LineLength, MethodLength, CyclomaticComplexity
 
+    # Get all keys recursively, 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
+    # @option options [String] :dc Target datacenter
+    # @option options [Boolean] :keys Only return key names.
+    # @option options [Boolean] :decode_values Return consul response with decoded values.
+    # @option options [String] :separator List only up to a given separator.
+    #   Only applies when combined with :keys option.
+    # @option options [Boolean] :nil_values If to return keys/dirs with nil values
+    # @option options [Boolean] :convert_to_hash Take the data returned from consul and build a hash
+    # @option options [Callable] :transformation function to invoke on keys values
+    # @param not_found [Symbol] behaviour if the key doesn't exist;
+    #   :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 [List] List of hashes, one hash for each key-value returned
+    # rubocop:disable PerceivedComplexity, MethodLength, LineLength, CyclomaticComplexity
+    def get_all(key, options = {}, not_found = :reject, found = :return)
+      @options = options
+      @options[:recurse] = true
+      return_nil_values = @options && @options[:nil_values]
+      transformation = @options && @options[:transformation] && @options[:transformation].methods.find_index(:call) ? @options[:transformation] : nil
+
+      raw = get_raw(key, options)
+      if raw.status == 404
+        case not_found
+        when :reject
+          raise Diplomat::KeyNotFound, key
+        when :return
+          return @value = []
+        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
+          @raw = parse_body
+          return decode_values if @options && @options[:decode_values]
+          return convert_to_hash(return_value(return_nil_values, transformation, true)) if @options && @options[:convert_to_hash]
+
+          return return_value(return_nil_values, transformation, true)
+        when :wait
+          index = raw.headers['x-consul-index']
+        end
+      else
+        raise Diplomat::UnknownStatus, "status #{raw.status}: #{raw.body}"
+      end
+
+      # Wait for first/next value
+      @raw = wait_for_value(index, options)
+      @raw = parse_body
+      return_value(return_nil_values, transformation, true)
+    end
+    # rubocop:enable PerceivedComplexity, MethodLength, LineLength, CyclomaticComplexity
+
     # Associate a value with a key
     # @param key [String] the key
     # @param value [String] the value
@@ -172,6 +216,30 @@ module Diplomat
 
     private
 
+    def get_raw(key, options = {}, custom_params = [])
+      key = normalize_key_for_uri(key)
+      @key = key
+      @options = options
+      custom_params << recurse_get(@options)
+      custom_params << use_consistency(@options)
+      custom_params << dc(@options)
+      custom_params << keys(@options)
+      custom_params << separator(@options)
+
+      send_get_request(@conn_no_err, ["/v1/kv/#{@key}"], options, custom_params)
+    end
+
+    def wait_for_value(index, options)
+      custom_params = []
+      custom_params << use_named_parameter('index', index)
+      if options.nil?
+        options = { timeout: 86_400 }
+      else
+        options[:timeout] = 86_400
+      end
+      get_raw(key, options, custom_params)
+    end
+
     def recurse_get(options)
       options[:recurse] ? ['recurse'] : []
     end

data/lib/diplomat/rest_client.rb

@@ -241,7 +241,7 @@ module Diplomat
           rest_options[:headers].map { |k, v| req.headers[k.to_sym] = v } unless rest_options[:headers].nil?
           req.options.timeout = options[:timeout] if options[:timeout]
         end
-      rescue Faraday::ClientError => e
+      rescue Faraday::ClientError, Faraday::ServerError => e
         resp = e.response
         if resp
           raise Diplomat::AclNotFound, e if resp[:status] == 403 && resp[:body] == 'ACL not found'

data/lib/diplomat/version.rb

@@ -1,3 +1,3 @@
 module Diplomat
-  VERSION = '2.2.5'.freeze
+  VERSION = '2.2.6'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 2.2.6
 platform: ruby
 authors:
 - John Hamelink
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-03 00:00:00.000000000 Z
+date: 2020-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -195,16 +195,22 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 description: Diplomat is a simple wrapper for Consul
 email:
 - john@johnhamelink.com
@@ -261,7 +267,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Diplomat is a simple wrapper for Consul