consul-templaterb 1.13.0 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba3e953ddc4da2445e08a84bbd39c1a309855bac
-  data.tar.gz: '08c115b11cf6006014940030fea37f68c7ece703'
+  metadata.gz: 81fe8ace61e417a86ebcc40579f9d7601c624e1f
+  data.tar.gz: 743e935937d5b0a23a7e1f2586e89d98142311a9
 SHA512:
-  metadata.gz: f778131a4db7c8ddf4464911a8969e8dfb841ad8cbdecca5e49a3d0d15887634915c4c5b68d80b59878e1fbd47c41fa99b8dfd75234bcc2808f47392b9a4ed42
-  data.tar.gz: 9d63155dad550910c3b6b7aec5f2ab677f62cfcf0996f16daf91c060d9528df40bdbe81fee86a8a62205d136219d99e6a83004146655eeecba776b543e13382e
+  metadata.gz: 7de540a1a265c175d71d9509425ccf1c4bc70f07d63dda83e31fe7046542d6ffbb877e674426d257754d95b00902697c91f4a77e72bb9cfdfdcdbd6762111bcd
+  data.tar.gz: 54a1adec053fd1da90a3de4f7bbdbc5654f7bc1f641c47d91a469e26d3bad6b749be661a3061516f734c9c30ccf2334a12589fdb3f4c94081eb446bac225df21

data/.gitignore

@@ -7,21 +7,17 @@
 /pkg/
 /spec/reports/
 /tmp/
+/samples/**/*.json
+/samples/**/*.xml
+/samples/**/*.html
+/samples/**/*.txt
+/samples/**/*.cfg
 /samples/ready
-/samples/*.json
-/samples/*.xml
-/samples/*.html
-/samples/*.txt
-/samples/*.cfg
-samples/consul-ui/*.html
-samples/consul-ui/*.json
-samples/consul-ui/common/*.html
-/samples/criteo/haproxy.cfg
+/samples/render_template_from_kv
 /samples/consul_template
 /samples/metrics
 /samples/service_checks_metrics
 /samples/find_blocked_choregraphies
-/samples/tools/*.txt
 /spec/consul/async/resources/templates/*.txt
 /spec/consul/async/resources/templates/*.result
 /out.txt

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## (UNRELEASED)
 
+## 1.13.1 (April 12, 2019)
+
+IMPROVEMENTS:
+
+ * Added support for loading KV with YAML using `get_value_yaml()`
+
 ## 1.13.0 (April 10, 2019)
 
 IMPROVEMENTS:

data/TemplateAPI.md

@@ -225,6 +225,7 @@ and the call is retrieving several keys, it allows to select a specific one.The
   if will not throw an error during rendering of template and return nil. Otherwise
   an Error will be thrown and have to be catch if you are unsure if the value is valid
   JSON
+* `get_value_yaml( [path], [catch_errors: true] )` : same as above, but for yml
 
 #### Get the result of a single value
 
@@ -234,6 +235,8 @@ The easiest, use the helpers to retrieve the values in the following formats:
 * `kv('/my/path/to/value').get_decoded` : get the decoded value of a single key in KV
 * `kv('/my/path/to/value').get_value_json` : get the base64 decoded value and try decoding it as JSON
 
+* `kv('/my/path/to/value').get_value_yaml` : get the base64 decoded value and try decoding it as YAML
+
 #### Iterate over values
 
 If you want to iterate amongst all values, you might to it that way:

data/lib/consul/async/consul_template.rb

@@ -471,6 +471,18 @@ module Consul
           raise StandardError.new(e), "get_value_json() cannot deserialize kv(#{name}) as JSON: #{e.message}", e.backtrace
         end
       end
+
+      # Helper to get the value decoded as YAML
+      def get_value_yaml(name = root, catch_errors: true)
+        x = get_value_decoded(name)
+        return nil unless x
+        begin
+          YAML.safe_load(x)
+        rescue YAML::ParserError => e
+          return nil if catch_errors
+          raise StandardError.new(e), "get_value_yaml() cannot deserialize kv(#{name}) as YAML: #{e.message}", e.backtrace
+        end
+      end
     end
 
     class ConsulTemplateVaultSecret < ConsulTemplateAbstractMap

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.13.0'.freeze
+    VERSION = '1.13.1'.freeze
   end
 end

data/samples/kv_yaml_to_json.json.erb

@@ -0,0 +1,14 @@
+<%
+  # This template read a YAML KV value and render it as JSON
+  kv_path = param('kv_path', ENV['KV_YAML_PATH'])
+  if kv_path
+    obj = kv(kv_path).get_value_yaml()
+    if obj
+%><%= JSON.pretty_generate(obj)%><%
+    else
+%><%= kv_path %> is not a valid YAML<%
+    end
+  else
+%>Please specify environment variable KV_YAML_PATH<%
+  end
+%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.13.1
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-10 00:00:00.000000000 Z
+date: 2019-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -209,6 +209,7 @@ files:
 - samples/debug/compare_connect_services.txt.erb
 - samples/ha_proxy.cfg.erb
 - samples/keys.html.erb
+- samples/kv_yaml_to_json.json.erb
 - samples/metrics.erb
 - samples/nodes.html.erb
 - samples/render_template_from_kv.erb