cmdb 3.0.0rc4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c88c245ee9bc31f0fe4f261b3d688402b0f06be1
-  data.tar.gz: 0e6b981474487959202b1bc16a85e5411754c818
+  metadata.gz: 1f4287917beeab0bb0a6ac9d486f2f6c2c5cf81d
+  data.tar.gz: 488206107b1515b2ecb4933690a718d8541ff4ae
 SHA512:
-  metadata.gz: a613be0d9de98744ba0b86d799d6f3685e46632a8d8373cb6ba1b1b473b326a26ce6b95912be9b60f31f5090ca2a883784fdf89d0e3362a9a5acbc6d15953887
-  data.tar.gz: 337b285e2ed120e8b543fe4cc0e1c9e0e1af759589aee4072c022bc76a793272b934185c12db54b2bd9860fe2a325c5c879423f4b38b45423f08ebde01d29b16
+  metadata.gz: ead52e74f5ee6565fbbd78cce0db6397fd3b9ae55fa74583d283b911a7f98508b1eb31072bee6ebc8d4167375f2dc2fe1ebc716af9c8b2bf6f1b206c98275688
+  data.tar.gz: 41f23de1b60dbb5606b9262b304d37f08d93f1b979032681cb1ba23dd50e515dc8423535544754ed48fe9b4e89bbc36394c56c0eddc9e22d6e2bad77182c90f8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cmdb (3.0.0rc4)
+    cmdb (3.0.0)
       trollop (~> 2.0)
 
 GEM

data/README.md

@@ -17,39 +17,46 @@ Maintained by
 
 ## Why should I use this gem?
 
-CMDB supports two primary use cases:
+With CMDB, you can:
 
   1. Decouple your modern (12-factor) application from the CM mechanism that is used to deploy it,
      transforming CMDB keys and values into the enviroment variables that your app expects.
   2. Deploy legacy applications that expect their configuration to be
      written to disk files by rewriting files at app-load time, substituting
      CMDB variables into the files as required.
+  3. Explore your CMDB contents from the command line using a beautiful shell.
 
 CMDB has three primary interfaces:
 
   1. The `cmdb shim` command populates the environment with values and/or rewrites hardcoded
      config files, then spawns your application.
-  2. The `CMDB::Interface` object provides a programmatic API for querying CMDBs. Its `#to_env`
+  2. The `cmdb shell` command navigates your k/v store using filesystem-like
+     metaphors (`ls`, `cd`, and so forth) with color output and tab completion
+  3. The `CMDB::Interface` object provides a programmatic API for querying CMDBs. Its `#to_env`
      method transforms the whole configuration into an environment-friendly hash if you prefer to seed the
      environment yourself, without using the shim.
-  3. The `cmdb shell` command navigates your k/v store using filesystem-like
-  metaphors (`ls`, `cd`, and so forth)   
 
 # Data Model
 
-CMDB models all data sources as hierarchical trees whose nodes are named, and
-whose leaf nodes can contain a piece of data: strings, numbers, booleans, or
-lists are all supported data types. Maps are disallowed on order to prevent
-ambiguity; a map always represents a subtree of the k/v store, never a value.
+CMDB models all data sources as trees whose nodes are named, and whose leaf
+nodes can contain a piece of data: strings, numbers, booleans, or arrays.
 
-This model is a "least common denominator" simplification of the data models of
-YML, JSON, ZooKeeper and etcd; by disallowing maps as the values of keys, it
-avoids ambiguity over whether a map should be treated as a subtree or as a
-distinct value.
+Maps are disallowed on order to prevent ambiguity; a map always represents a
+subtree of the k/v store, never a value. Mixed-type arrays are disallowed
+because they can cause problems with strongly-typed languages. Nil is
+disallowed as a value because writing nil means "delete the key."
+
+Paths within a tree -- and therefore CMDB keys -- are identified using a dot
+notation similar to Java properties; for instance, `production.http.listen_port`
+might be an Integer-valued key that tells your microservice which HTTP port
+to listen on in the production environment; `production.database.host` might be
+the database host, and so forth. The names of keys are determined by the tree
+structure of your k/v store, and when you set a key through CMDB, its position
+in the tree is derived from its key name.
 
 ## Source Prefixes
 
-Some CMDB sources have a `prefix`, indicating that _all_ keys contained in
+CMDB sources have a `prefix`, meaning that _all_ keys contained in
 that source begin with the same prefix. No two sources may share a prefix,
 ensuring that sources don't "hide" each others' data. The prefix of a source is
 usually automatically determined by the final component of its URL, e.g. the
@@ -63,7 +70,7 @@ disjoint; there is no such thing as "inheritance" in the CMDB data model.
 
 When keys are exported to the environment, the prefix is stripped from the
 key name; however, CMDB _still_ prevents overlap in this case.
- 
+
 Inheritance may be supported in future as an optional behavior, but is omitted
 for the time being because in practice, it causes more problems than it solves.
 
@@ -135,13 +142,13 @@ Examples:
     use this source with the `myapp` source in the example above!)
 
 If no sources are specified on the command line, CMDB will run an auto-detect
-algorithm to check for network agents listening at localhost. 
+algorithm to check for network agents listening at localhost.
 
 To learn more about sources and prefixes, see "Data model," below.
 
 ## Invoke the CMDB Shell
 
-To enter an interactive sh-like shell, just type `cmdb shell`. 
+To enter an interactive sh-like shell, just type `cmdb shell`.
 
 ## Invoke the CMDB Shim
 
@@ -181,7 +188,7 @@ found, it substitutes the corresponding CMDB key's value.
 
 Replacement tokens look like this: `<<name.of.my.key>>` and can appear anywhere in a file as a YAML
 or JSON _value_ (but never a key). Unlike environment variables, replacement tokens always use
-the fully-qualified key name, including prefix. 
+the fully-qualified key name, including prefix.
 
 Replacement tokens should appear inside string literals in your configuration files so they don't
 invalidate syntax or render the files unparsable by other tools.

data/TODO.md

@@ -1,10 +1,2 @@
-1) Move array validation stuff (same type, etc) out of File source so Consul
-   can use it. Or decide to ditch this constraint ... hmm ...
-   
-2) Create a Shell.new helper to enable embedding of shells into other apps
-
-3) Extract padding/truncation/excerpting code into Text module; deal with
+1) Extract padding/truncation/excerpting code into Text module; deal with
    corner cases better.
-
-4) Move CMDB separator logic (join/split) into toplevel methods of CMDB;
-   DRY out Shell#expand_path

data/lib/cmdb.rb

@@ -127,17 +127,17 @@ module CMDB
 
   module_function
 
-  # Split a dotted-notation CMDB key into its constituent parts and return an
+  # Split a dot-notation CMDB key into its constituent parts and return an
   # Array. Optionally limit the amount of splitting done by passing parts > 0.
   #
   # @return [Array]
-  # @param [String] key dotted-notation key
+  # @param [String] key dot-notation key
   # @param [Integer] parts number of total parts to return
   def split(key, parts=0)
     key.split(SEPARATOR, parts)
   end
 
-  # Transform a list of key components into a dotted-notation key.
+  # Transform a list of key components into a dot-notation key.
   #
   # @return [String]
   def join(*pieces)

data/lib/cmdb/source.rb

@@ -95,6 +95,33 @@ module CMDB
     def prefixed?(key)
       prefix.nil? || (key.index(prefix) == 0 && key[prefix.size] == '.')
     end
+
+    # Check whether a CMDB value conforms to the extra-strict constraints
+    # that we place on certain object types.
+    #
+    # @return [Object] always returns value (unless it raises)
+    # @param [String] dot-notation key, used to describe errors
+    # @param [Object] value
+    # @raise [BadValue] if the value is bad
+    def validate!(key, value)
+      case value
+      when Array
+        if value.any? { |e| e.is_a?(Hash) }
+          raise BadValue.new(uri, key, value, 'hashes not allowed inside arrays')
+        elsif value.all? { |e| e.is_a?(String) } ||
+          value.all? { |e| e.is_a?(Numeric) } ||
+          value.all? { |e| e == true } ||
+          value.all? { |e| e == false }
+          value
+        else
+          raise BadValue.new(uri, key, value, 'mismatched or disallowed element types')
+        end
+      when String, Numeric, TrueClass, FalseClass, NilClass
+          value
+      else
+        raise BadValue.new(uri, key, value)
+      end
+    end
   end
 end
 

data/lib/cmdb/source/consul.rb

@@ -27,7 +27,8 @@ module CMDB
       when String
         response = json_parse(response)
         item = response.first
-        item['Value'] && json_parse(Base64.decode64(item['Value']))
+        item['Value'] && value = json_parse(Base64.decode64(item['Value']))
+        validate!(key, value)
       when 404
         nil
       else
@@ -49,6 +50,7 @@ module CMDB
       if value.nil?
         status = http_delete path_to(key)
       else
+        validate!(key, value)
         status = http_put path_to(key), value
       end
 
@@ -80,6 +82,7 @@ module CMDB
         key.sub(@useless,'')
         next unless item['Value']
         value = json_parse(Base64.decode64(item['Value']))
+        validate!(key, value)
         yield(key, value)
       end
 

data/lib/cmdb/source/file.rb

@@ -38,13 +38,18 @@ module CMDB
 
       @data = {}
       flatten(raw_data, @prefix, @data)
+
+      # File sources are static; we can check them for data errors at load
+      # time. Do this by each'ing, which validates values as a side effect.
+      each_pair { |_,_| }
     end
 
     # Get the value of key.
     #
     # @return [Object] the key's value, or nil if not found
     def get(key)
-      @data[key]
+      value = @data[key]
+      validate!(key, value)
     end
 
     # Enumerate the keys and values in this source.
@@ -53,7 +58,10 @@ module CMDB
     # @yieldparam [String] key
     # @yieldparam [Object] value
     def each_pair(&_block)
-      @data.each_pair { |k, v| yield(k, v) }
+      @data.each_pair do |key, value|
+        validate!(key, value)
+        yield(key, value)
+      end
     end
 
     private
@@ -64,24 +72,8 @@ module CMDB
         case value
         when Hash
           flatten(value, key, output)
-        when Array
-          if value.any? { |e| e.is_a?(Hash) }
-            # mismatched arrays: not allowed
-            raise BadValue.new(uri, key, value, 'hashes not allowed inside arrays')
-          elsif value.all? { |e| e.is_a?(String) } ||
-             value.all? { |e| e.is_a?(Numeric) } ||
-             value.all? { |e| e == true } ||
-             value.all? { |e| e == false }
-            output[key] = value
-          else
-            # mismatched arrays: not allowed
-            raise BadValue.new(uri, key, value, 'mismatched/unsupported element types')
-          end
-        when String, Numeric, TrueClass, FalseClass
-          output[key] = value
         else
-          # nil and anything else: not allowed
-          raise BadValue.new(uri, key, value)
+          output[key] = value
         end
       end
     end

data/lib/cmdb/source/network.rb

@@ -99,7 +99,7 @@ module CMDB
     end
 
     # Convert dotted notation to slash-separated notation without an initial
-    # slash. Remove prefix if it is present in the dotted-notation key.
+    # slash. Remove prefix if it is present in the dot-notation key.
     def dot_to_slash(key)
       pieces = CMDB.split(key)
       pieces.shift if pieces[0] == @prefix

data/lib/cmdb/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module CMDB
-  VERSION = '3.0.0rc4'.freeze
+  VERSION = '3.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmdb
 version: !ruby/object:Gem::Version
-  version: 3.0.0rc4
+  version: 3.0.0
 platform: ruby
 authors:
 - RightScale
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-25 00:00:00.000000000 Z
+date: 2016-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -102,9 +102,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.1