cmdb 3.0.0rc2 → 3.0.0rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a5fa442a4ff4b6f1d7955c804b79bce26e232a5
-  data.tar.gz: 60a350561cc2612639f53f41b1427b6d0ace23b0
+  metadata.gz: 4c44ac22f3267a7961d7034b5a0b56fc34a7bd7a
+  data.tar.gz: dfd4eaded71592fe0f8be7aa5b2a552610972811
 SHA512:
-  metadata.gz: 949bf77549aefdbdb499e4d9ab818d826f5359d026dd8bd4bf6f0046a809e69e54369cb975962c3ef0c367a8ab5e3106731050dacf71eec5149fc109fec4a6a7
-  data.tar.gz: f5e1c629aa3135b333c89cffa7e2f1d1a4a05266c4be9fea75e3ba0cc5751c1f89c4f70d4859b464b205bb570ff67b0fb26cb898b925fa7896ccf3e96da99a53
+  metadata.gz: 7910184801caaa46c493b1eca7094bf9d5107741cb20c67f1fdaaa537b99652634c528b7d9864865ddd0cdb8e902cb0373fd829ca70fb595ff39c075f1fa3541
+  data.tar.gz: 5779dece8e9682d685a148a6c5315a10aae3b6be19d2505e02ed0beb923895a3b8c931068e97322874f9fbd63f8379bbc704c9a503de39fedb03003961692dae

data/Gemfile.lock

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

data/Rakefile

@@ -23,8 +23,8 @@ task :sandbox do
   compose = Docker::Compose::Session.new
   compose.up 'consul', detached:true
   mapper = Docker::Compose::Mapper.new(compose)
-  url = mapper.map('consul://consul:8500/sandbox')
+  uri = mapper.map('consul://consul:8500/sandbox')
 
   lib = File.expand_path('../lib', __FILE__)
-  exec "bin/shell --source=#{url}"
+  exec "bin/shell --source=#{uri}"
 end

data/exe/cmdb

@@ -90,15 +90,15 @@ rescue CMDB::BadKey => e
   CMDB.log.fatal "CMDB: Bad Key: malformed CMDB key '#{e.key}'"
   exit 1
 rescue CMDB::BadValue => e
-  CMDB.log.fatal "CMDB: Bad Value: illegal value for CMDB key '#{e.key}' in source #{e.url}"
+  CMDB.log.fatal "CMDB: Bad Value: illegal value for CMDB key '#{e.key}' in source #{e.uri}"
   exit 2
 rescue CMDB::BadData => e
-  CMDB.log.fatal "CMDB: Bad Data: malformed CMDB data in source #{e.url}"
+  CMDB.log.fatal "CMDB: Bad Data: malformed CMDB data in source #{e.uri}"
   exit 3
 rescue CMDB::ValueConflict => e
   CMDB.log.fatal "CMDB: Value Conflict: #{e.message}"
   e.sources.each do |s|
-    CMDB.log.fatal " - #{s.url}"
+    CMDB.log.fatal " - #{s.uri}"
   end
   exit 4
 rescue CMDB::NameConflict => e

data/lib/cmdb.rb

@@ -41,17 +41,17 @@ module CMDB
 
   # A value of an unsupported type was encountered in the CMDB or filesystem.
   class BadValue < Error
-    # @return [URI] filesystem or network location of the bad value
-    attr_reader :url
+    # @return [URI] source that contains the bad data
+    attr_reader :uri
 
     # @return [String] the name of the key that contained the bad value
     attr_reader :key
 
-    # @param [URI] url filesystem or network location of the bad value
+    # @param [URI] source that contains the bad value
     # @param [String] key CMDB key name under which the bad value was found
     # @param [Object] value the bad value itself
-    def initialize(url, key, value, desc=nil)
-      @url = url
+    def initialize(uri, key, value, desc=nil)
+      @uri = uri
       @key = key
       msg = "Unsupported #{value.class.name} value"
       msg << ": #{desc}" if desc
@@ -61,13 +61,13 @@ module CMDB
 
   # Malformed data was encountered in the CMDB or filesystem.
   class BadData < Error
-    # @return [URI] filesystem or network location of the bad data
-    attr_reader :url
+    # @return [URI] source that contains the bad data
+    attr_reader :uri
 
-    # @param [URI] url filesystem or network location of the bad value
+    # @param [URI] source that contains the bad value
     # @param [String] context brief description of where data was found e.g. 'CMDB data file' or 'input config file'
-    def initialize(url, context = nil)
-      @url = url
+    def initialize(uri, context = nil)
+      @uri = uri
       super("Malformed data encountered #{(' in ' + context) if context}")
     end
   end

data/lib/cmdb/source.rb

@@ -1,24 +1,25 @@
 module CMDB
   class Source
-    # Determine the prefix of all keys provided by this source. No two sources can share
-    # a prefix (other than nil) and no source's prefix can be a prefix of any other
-    # source's prefix.
+    # @return [URI] logical description of this source
+    attr_reader :uri
+
+    # The dot-notation prefix of all keys provided by this source. No two
+    # sources can share a prefix (other than nil) and no source's prefix can
+    # be a prefix of any other source's prefix.
     #
-    # Some sources have no common prefix, in which case this reader returns nil.
+    # Some sources have no prefix, in which case this reader returns nil.
     #
-    # @return [nil,String] common and unique dot-notation prefix of this source's keys, if any
+    # @return [nil,String] unique dot-notation prefix of all this source's keys, if any
     attr_reader :prefix
 
-    # @return [URI] a URL describing where this source's data comes from
-    attr_reader :url
-
     # Construct a source given a URI that identifies both the type of
     # source (consul, file or environment) and its location if applicable.
     # Choose a suitable prefix for the source based on the URI contents.
     #
-    # If you pass a fragment as part of the URI, then the fragment becomes the
-    # prefix. Otherwise, the final path component becomes the prefix, unless
-    # it is empty in which case the first hostname component becomes the prefix.
+    # This method accepts a special URI notation that is specific to the cmdb
+    # gem; in this notation, the scheme of the URI specifies the type of source
+    # (consul, file, etc) and the other components describe how to locate the
+    # source.
     #
     # @param [String,URI] location of source
     #
@@ -55,15 +56,11 @@ module CMDB
 
       case uri.scheme
       when 'consul'
-        curi = uri.dup
-        curi.scheme = 'http'
-        curi.port ||= 8500
-        curi.path = ''
-        Source::Consul.new(URI.parse(curi.to_s), prefix)
+        Source::Consul.new(uri, prefix)
       when 'file'
-        Source::File.new(uri.path, prefix)
+        Source::File.new(uri, prefix)
       when 'memory'
-        Source::Memory.new({},nil)
+        Source::Memory.new({},prefix)
       else
         raise ArgumentError, "Unrecognized URL scheme '#{uri.scheme}'"
       end
@@ -81,6 +78,17 @@ module CMDB
       sources
     end
 
+    # Construct a new Source.
+    #
+    # @param [String,URI] uri logical description of this source
+    # @param [String] prefix unique dot-notation prefix of all this source's keys, if any
+    # @raise [URI::InvalidURIError] if an invalid string is passed
+    def initialize(uri, prefix)
+      uri = URI.parse(uri) if uri.is_a?(String)
+      @uri = uri
+      @prefix = prefix
+    end
+
     private
 
     # Check whether a key's prefix is suitable for this source.

data/lib/cmdb/source/consul.rb

@@ -8,6 +8,10 @@ module CMDB
     # Regular expression to match array values
     ARRAY_VALUE = /^\[(.*)\]$/
 
+    def initialize(uri, prefix)
+      super(uri, 8500, prefix)
+    end
+
     # Get a single key from consul. If the key is not found, return nil.
     #
     # @param [String] key dot-notation key
@@ -77,15 +81,13 @@ module CMDB
       false
     end
 
-    private
-
     # Given a key's relative path, return its absolute REST path in the consul
-    # kv, including prefix if appropriate.
-    def path_to(subkey)
-      p = '/v1/kv/'
-      p << prefix << '/' if prefix
-      p << subkey unless (subkey == '/' && p[-1] == '/')
-      p
+    # kv, including the `/v1/kv/` prefix and any subkey path specified at
+    # initialize time.
+    #
+    # @param [String] subpath key path relative to base
+    def path_to(subpath)
+      ::File.join('/v1/kv/', @uri.path, subpath)
     end
   end
 end

data/lib/cmdb/source/file.rb

@@ -10,32 +10,33 @@ module CMDB
   #    source = Source::File.new('/tmp/my.yml') # contains a top-level stanza named "database"
   #    source['my']['database']['host'] # => 'db1-1.example.com'
   class Source::File < Source
-    # Construct a new Source::File from an input file.
-    # @param [String,Pathname] filename path to a file
-    # @param [String] prefix optional prefix of
+    # Read a data file whose location is specified by a file:// URI.
+    #
+    # @param [URI] uri logical description of this source
+    # @param [String] prefix unique dot-notation prefix of all this source's keys, if any
     # @raise [BadData] if the file's content is malformed
-    def initialize(filename, prefix)
-      @data = {}
-      @prefix = prefix
-      filename = ::File.expand_path(filename)
-      @url = URI.parse("file://#{filename}")
-      @extension = ::File.extname(filename)
-      raw_bytes = ::File.read(filename)
+    def initialize(uri, prefix)
+      super(uri, prefix)
+      path = @uri.path
+      filename  = ::File.basename(path)
+      extension = ::File.extname(filename)
+      raw_bytes = ::File.read(path)
       raw_data  = nil
 
       begin
-        case @extension
+        case extension
         when /jso?n?$/i
           raw_data = JSON.load(raw_bytes)
         when /ya?ml$/i
           raw_data = YAML.load(raw_bytes)
         else
-          raise BadData.new(url, 'file with unknown extension; expected js(on) or y(a)ml')
+          raise BadData.new(@uri, 'file with unknown extension; expected js(on) or y(a)ml')
         end
       rescue StandardError
-        raise BadData.new(url, 'CMDB data file')
+        raise BadData.new(@uri, 'CMDB data file')
       end
 
+      @data = {}
       flatten(raw_data, @prefix, @data)
     end
 
@@ -66,7 +67,7 @@ module CMDB
         when Array
           if value.any? { |e| e.is_a?(Hash) }
             # mismatched arrays: not allowed
-            raise BadValue.new(url, key, value, 'hashes not allowed inside arrays')
+            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 } ||
@@ -74,13 +75,13 @@ module CMDB
             output[key] = value
           else
             # mismatched arrays: not allowed
-            raise BadValue.new(url, key, value, 'mismatched/unsupported element types')
+            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(url, key, value)
+          raise BadValue.new(uri, key, value)
         end
       end
     end

data/lib/cmdb/source/memory.rb

@@ -10,8 +10,9 @@ module CMDB
 
     # Construct a new Source::Memory.
     def initialize(hash, prefix)
+      uri = URI.parse("memory:#{hash.object_id}")
+      super(uri, prefix)
       @hash = hash
-      @prefix = prefix
     end
 
     # Get the value of key.

data/lib/cmdb/source/network.rb

@@ -1,10 +1,21 @@
 module CMDB
+  # Abstract base class for sources that are backed by an HTTP k/v store.
+  # Contains reusable HTTP request logic.
   class Source::Network < Source
-    # @param [URI] uri
+    # @return [URI] HTTP base location of this source (minus path)
+    attr_reader :http_url
+
+    # Construct a new HTTP source. The logical URI is transformed into an
+    # HTTP base URL by preserving the hostname, overriding the port (unless
+    # the URI already has a specific port), replacing the scheme with http
+    # and eliminating the path.
+    #
+    # @param [String,URI] uri logical description of this source
+    # @param [Integer] port default HTTP port if not specified in URI
     # @param [String] dot-notation prefix of all keys
-    def initialize(uri, prefix)
-      @uri = uri
-      @prefix = prefix
+    def initialize(uri, port, prefix)
+      super(uri, prefix)
+      @http_url = URI.parse("http://%s:%s" % [@uri.host, @uri.port || port])
     end
 
     private
@@ -16,12 +27,12 @@ module CMDB
     # @param [String] path
     # @return [Integer,String]
     def http_get(path, query:nil, retries:3)
-      @http ||= Net::HTTP.start(@uri.host, @uri.port)
-      uri = @uri.dup
-      uri.path = path
-      uri.query = query unless query.nil? || query.empty?
+      @http ||= Net::HTTP.start(@http_url.host, @http_url.port)
+      url = @http_url.dup
+      url.path = path
+      url.query = query unless query.nil? || query.empty?
 
-      request = Net::HTTP::Get.new uri
+      request = Net::HTTP::Get.new url
       response = @http.request request
 
       case response.code.to_i
@@ -47,11 +58,11 @@ module CMDB
     def http_put(path, entity)
       entity = JSON.dump(entity) unless entity.is_a?(String)
 
-      @http ||= Net::HTTP.start(@uri.host, @uri.port)
-      uri = @uri.dup
-      uri.path = path
+      @http ||= Net::HTTP.start(@http_url.host, @http_url.port)
+      url = @http_url.dup
+      url.path = path
 
-      request = Net::HTTP::Put.new uri
+      request = Net::HTTP::Put.new url
       request.body = entity
       response = @http.request request
 
@@ -64,11 +75,11 @@ module CMDB
     # @return [Integer] HTTP status code
     # @param [String] path
     def http_delete(path)
-      @http ||= Net::HTTP.start(@uri.host, @uri.port)
-      uri = @uri.dup
-      uri.path = path
+      @http ||= Net::HTTP.start(@http_url.host, @http_url.port)
+      url = @http_url.dup
+      url.path = path
 
-      request = Net::HTTP::Delete.new uri
+      request = Net::HTTP::Delete.new url
       response = @http.request request
 
       response.code.to_i

data/lib/cmdb/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cmdb
 version: !ruby/object:Gem::Version
-  version: 3.0.0rc2
+  version: 3.0.0rc3
 platform: ruby
 authors:
 - RightScale