obscure_yaml 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8cb65381c4bb6f6f29047bf4b7edf7080fb1cbb
-  data.tar.gz: f900378b076ebfcbf898bee3b7e1fb6aa7a7c3d7
+  metadata.gz: e586f3486eb9b5be77a5e103aafa209eed7c4e88
+  data.tar.gz: 82a944c7e62989133cb8b50d44cd93bf013daaf0
 SHA512:
-  metadata.gz: 48cda1819f12cd9776993a1cc376fe9d50e63c25e6613fa2e70ff20140e9657adc1a7ba3b85c731dd2338de2c2e7898287541675ffbb3d832f7e0b67d32a823d
-  data.tar.gz: 13036cb2318f7a05d122491bd37f93b0ef12bd51439c9d412a89e0f9495460f7bf2eccf7eb8edf298101ae8793beeec161a69d251e8509b78a17167c8e36a373
+  metadata.gz: f1e280e19a6758a0cc1ec1b812f95ed449f3d122fdd50132cdd3e2acbbb551b877f6d54d40911e8edc8c0430aae94add680c95b37c68e36688175624d7909e5d
+  data.tar.gz: cb7b03a2c017e20d960ef2a0bdfda64fbbc4ab936bed1282b23e3e12f58e2999aa9e8487f96aa1859aeb8af7cd7690b7d4cd400df49e2581aac894d6316b8208

data/README.md

@@ -1,4 +1,29 @@
-# obscure-yaml
+# obscure_yaml
 
 This gem contains helper classes for working with Base64 encoded
-Yaml files, in case the values you need to serialize are not valid YAML values without escaping etc, it will either read the value from a specified fle or use yaml value directly, and write the resulting data all to a single yaml file with 100% base64 encoded values for consistency.
+Yaml files, typically for kubernetes secrets.yml files, the values of which must be base64 encoded. It will either read the value from a specified fle or use yaml value directly, and write the resulting data all to a single yaml file with base64 encoded values under a specfied key ('data' by default) for consistency.  Decoding always results in a single file, with escaped values as necessary.
+
+Those long/unescaped values can be loaded from files referenced in the source yaml by wrapping in "magic" file/url delimiters, ('@' by default), e.g:
+```yaml
+apiVersion: v1
+kind: ConfigMap
+data:
+  long_crazy_indirect_value: '@local_unescaped_file.txt@'
+  regular_direct_value_domain: example.com
+```
+
+The delimiter can be changed with the env var `MAGIC_FILE` from default value of '@', and the data key can be changed from it's default value of 'data' with env var `DATA_KEY`.
+
+Gem install as usual in bundler or directly as `obscure_yaml`, though only CLI usage is intended at present.
+
+###Example usage
+```
+$ obscure encode connect.configmap.yml # outputs encoded yaml to stdout
+$ obscure decode connect.secrets.yml # outputs decode yaml to stdout
+$ obscure encode connect.configmap.yml tmp.out # writes encoded yaml to tmp.out file
+$ obscure decode connect.secrets.yml tmp2.out # writes encoded yaml to tmp2.out file
+$ cat file.yml | obscure decode # reads non-base64 input yaml from stdin, writes decoded yamlto stdout
+$ cat file.yml | obscure encode # reads base64 encoded input yaml from stdin, write encoded to stdout
+```
+
+A valid url may also be used in place of a file path for input or output.  There are no tests at present, because this was just an afternoon project, but pull requests are welcome if you find this useful!

data/lib/obscure_yaml.rb

@@ -5,48 +5,46 @@ require 'open-uri'
 module ObscureYaml
   DEFAULT_DATA_KEY = 'data'
   MAGIC_DELIMITER = '@'
-  module_function
+  class << self
 
-  def decode(output, input)
-    output << construct_yaml(input, :output)
-  end
+    def decode(output, input)
+      output << construct_yaml(input, :output)
+    end
 
-  def encode(output, input)
-    output << construct_yaml(input, :input)
-  end
+    def encode(output, input)
+      output << construct_yaml(input, :input)
+    end
 
-  private
+    private
 
-  module_function
+    def construct_yaml(yaml_source, direction)
+      YAML::load(yaml_source.read).tap { |hsh|
+        data = hsh[obscured_data_key]
+        hsh[obscured_data_key] = data.map { |key, value|
+            [key, handle_coding(direction, value)]
+          }.to_h
+      }.to_yaml
+    end
 
-  def construct_yaml(yaml_source, direction)
-    YAML::load(yaml_source.read).tap { |hsh|
-      data = hsh[obscured_data_key]
-      hsh[obscured_data_key] = data.map { |key, value|
-          [key, handle_coding(direction, value)]
-        }.to_h
-    }.to_yaml
-  end
+    def handle_coding(direction, value)
+      direction == :output ? Base64.decode64(value) : Base64.encode64(value_or_file_contents(value))
+    end
 
-  def handle_coding(direction, value)
-    direction == :output ? Base64.decode64(value) : Base64.encode64(value_or_file_contents(value))
-  end
+    def value_or_file_contents(value)
+      return value unless detect_file(value)
+      value_contents = open(value.gsub(magic_delimiter, '')) { |f| f.read }
+    end
 
-  def value_or_file_contents(value)
-    return value unless detect_file(value)
-    value_contents = open(value.gsub(magic_delimiter, '')) { |f| f.read }
-  end
+    def detect_file(value)
+      value.match /\A#{magic_delimiter}(.+)#{magic_delimiter}\z/
+    end
 
-  def detect_file(value)
-    value.match /\A#{magic_delimiter}(.+)#{magic_delimiter}\z/
-  end
-
-  def magic_delimiter
-    ENV['MAGIC_FILE'] || MAGIC_DELIMITER
-  end
+    def magic_delimiter
+      ENV['MAGIC_FILE'] || MAGIC_DELIMITER
+    end
 
-  def obscured_data_key
-    ENV['DATA_KEY'] || DEFAULT_DATA_KEY
+    def obscured_data_key
+      ENV['DATA_KEY'] || DEFAULT_DATA_KEY
+    end
   end
-
 end

data/lib/obscure_yaml/version.rb

@@ -1,3 +1,3 @@
 module ObscureYaml
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: obscure_yaml
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Brian Glusman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-22 00:00:00.000000000 Z
+date: 2016-09-23 00:00:00.000000000 Z
 dependencies: []
 description: "    There was no call for this really, except we needed it.\n"
 email: