cmdb 2.6.2 → 3.0.0rc1

data/lib/cmdb/source/network.rb

@@ -0,0 +1,104 @@
+module CMDB
+  class Source::Network < Source
+    # @param [URI] uri
+    # @param [String] dot-notation prefix of all keys
+    def initialize(uri, prefix)
+      @uri = uri
+      @prefix = prefix
+    end
+
+    private
+
+    # Perform a GET. On 2xx, return the response body as a String.
+    # On 3xx, 4xx, 5xx, return an Integer status code.
+    #
+    # @param [String] path
+    # @return [Integer,String]
+    def http_get(path, query:nil)
+      @http ||= Net::HTTP.start(@uri.host, @uri.port)
+      uri = @uri.dup
+      uri.path = path
+      uri.query = query unless query.nil? || query.empty?
+
+      request = Net::HTTP::Get.new uri
+      response = @http.request request
+
+      case response.code.to_i
+      when 200..299
+        response.body
+      else
+        return response.code.to_i
+      end
+    end
+
+    # Perform a PUT. JSON-encode request entity unless it is already a String.
+    # Return status code from HTTP response.
+    #
+    # @return [Integer] HTTP status code
+    # @param [String] path
+    # @param [String,Hash,Array,Numeric,Boolean] entity
+    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
+
+      request = Net::HTTP::Put.new uri
+      request.body = entity
+      response = @http.request request
+
+      response.code.to_i
+    end
+
+    # Perform a DELETE.
+    # Return status code from HTTP response.
+    #
+    # @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
+
+      request = Net::HTTP::Delete.new uri
+      response = @http.request request
+
+      response.code.to_i
+    end
+
+    # Attempt to parse str as a JSON document or fragment. Fragments include
+    # "bare" numbers, strings, `null`, `true`, `false` that occur outside of
+    # a dictionary or array context, but exclude anything that is syntactically
+    # invalid JSON (e.g. an unquoted string).
+    #
+    # @return [Object] JSON-parsed object, or the original string if parse fails
+    # @param [String] str
+    def json_parse(str)
+      JSON.load(str)
+    rescue JSON::ParserError
+      str
+    end
+
+    # Convert dotted notation to slash-separated notation without an initial
+    # slash. Remove prefix if appropriate; raise an error if the key name
+    # does not begin with this source's prefix.
+    def dot_to_slash(key)
+      unless prefixed?(key)
+        raise CMDB::BadKey.new(key, "Keys of this source must begin with #{prefix}.")
+      end
+      pieces = key.split(CMDB::SEPARATOR)
+      pieces.shift
+      pieces.join('/')
+    end
+
+    # Convert a slash-separated URI path or subpath to dotted notation. If there is an initial
+    # slash, discard it. Prepend source's prefix to key name if not already present.
+    def slash_to_dot(path)
+      pieces = path.split('/')
+      pieces.shift if pieces[0].empty?
+      pieces.unshift(prefix) unless prefix.nil? || pieces[0] == prefix
+      pieces.join(CMDB::SEPARATOR)
+    end
+  end
+end

data/lib/cmdb/source.rb

@@ -0,0 +1,94 @@
+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.
+    #
+    # Some sources have no common prefix, in which case this reader returns nil.
+    #
+    # @return [nil,String] common and unique dot-notation prefix of 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.
+    #
+    # @param [String,URI] location of source
+    #
+    # @raise ArgumentError if URL scheme is unrecognized
+    #
+    # @example environment source
+    #   CMDB::Source.create('env')
+    #
+    # @example JSON source
+    #   CMDB::Source.create('file://awesome.json')
+    #
+    # @example YAML source
+    #   CMDB::Source.create('file://awesome.yml')
+    #
+    # @example consul source at the root of the k/v tree with prefix "otherhost" (probably not desirable!)
+    #   CMDB::Source.create('consul://otherhost.example.com')
+    #
+    # @example consul source at the root of the k/v tree with prefix "myapp"
+    #   CMDB::Source.create('consul://otherhost.example.com#myapp')
+    #
+    # @example consul source whose keys are drawn from a subtree of the k/v with prefix "interesting."
+    #   CMDB::Source.create('consul://localhost/interesting')
+    #
+    # @example consul source with nonstandard location and port and prefix "my-kv"
+    #   CMDB::Source.create('consul://my-kv:18500')
+    def self.create(uri)
+      uri = URI.parse(uri) if uri.is_a?(String)
+
+      if !uri.path.nil? && !uri.path.empty?
+        prefix = ::File.basename(uri.path, '.*')
+      else
+        prefix = nil
+      end
+
+      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)
+      when 'file'
+        Source::File.new(uri.path, prefix)
+      else
+        raise ArgumentError, "Unrecognized URL scheme '#{uri.scheme}'"
+      end
+    end
+
+    # Test for the presence of some default sources and return any that exist.
+    #
+    # @return [Array] a set of initialized CMDB sources
+    def self.detect
+      sources = []
+
+      consul = create('consul://localhost')
+      sources << consul if consul.ping
+
+      sources
+    end
+
+    private
+
+    # Check whether a key's prefix is suitable for this source.
+    def prefixed?(key)
+      prefix.nil? || (key.index(prefix) == 0 && key[prefix.size] == '.')
+    end
+  end
+end
+
+require 'cmdb/source/memory'
+require 'cmdb/source/file'
+require 'cmdb/source/network'
+require 'cmdb/source/consul'

data/lib/cmdb/version.rb

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

data/lib/cmdb.rb

@@ -1,16 +1,17 @@
 # encoding: utf-8
+require 'logger'
 require 'set'
 require 'singleton'
 
 module CMDB
-  # Values of RACK_ENV/RAILS_ENV that are considered to be "development," which relaxes
-  # certain runtime sanity checks.
-  DEVELOPMENT_ENVIRONMENTS = [nil, 'development', 'test'].freeze
+  # Character that separates keys from subkeys in the standard notation for
+  # CMDB keys.
+  SEPARATOR = '.'.freeze
 
   # Regexp that matches valid key names. Key names consist of one or more dot-separated words;
   # each word must begin with a lowercase alpha character and may contain alphanumerics or
   # underscores.
-  VALID_KEY = /^[a-z][a-z0-9_]*(?:\.[a-z][a-z0-9_]*)*$/
+  VALID_KEY = /^[a-z][a-z0-9_]*(?:\.[a-z][a-z0-9_]*)*$/i.freeze
 
   class Error < StandardError; end
 
@@ -26,15 +27,15 @@ module CMDB
     end
   end
 
-  # Client asked for an invalid or malformed key name.
+  # Client used a malformed key name.
   class BadKey < Error
     # @return [String] the name of the offending key
     attr_reader :key
 
     # @param [String] name
-    def initialize(key)
+    def initialize(key, message="Malformed key '#{key}'")
+      super(message)
       @key = key
-      super("Malformed key '#{key}'")
     end
   end
 
@@ -69,6 +70,16 @@ module CMDB
     end
   end
 
+  # Client asked to do something that does not make sense.
+  class BadCommand < Error
+    attr_reader :command
+
+    def initialize(command, message='Unrecognized command')
+      super(message)
+      @command = command
+    end
+  end
+
   # Two or more sources contain keys for the same namespace; this is only allowed in development
   # environments.
   class ValueConflict < Error
@@ -83,8 +94,8 @@ module CMDB
   # Deprecated name for ValueConflict
   Conflict = ValueConflict
 
-  # Two or more keys in different namespaces have an identical name. This isn't an error
-  # when CMDB is used to refer to keys by their full, qualified name, but it can become
+  # Two or more keys in different sources have an identical name. This isn't an error
+  # when CMDB is used to refer to keys by their full, prefixed name, but it can become
   # an issue when loading keys into the environment for 12-factor apps to process.
   class NameConflict < Error
     attr_reader :env
@@ -117,6 +128,11 @@ module CMDB
   def log
     unless @log
       @log = Logger.new(STDOUT)
+
+      @log.formatter = Proc.new do |severity, datetime, progname, msg|
+        "#{severity}: #{msg}\n"
+      end
+
       @log.level = Logger::WARN
     end
 
@@ -126,16 +142,9 @@ module CMDB
   def log=(log)
     @log = log
   end
-
-  # Determine whether CMDB is running in a development environment.
-  # @return [Boolean]
-  def development?
-    DEVELOPMENT_ENVIRONMENTS.include?(ENV['RACK_ENV'] || ENV['RAILS_ENV'])
-  end
 end
 
-require 'cmdb/consul_source'
-require 'cmdb/file_source'
+require 'cmdb/source'
 require 'cmdb/interface'
 require 'cmdb/rewriter'
 require 'cmdb/commands'

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cmdb
 version: !ruby/object:Gem::Version
-  version: 2.6.2
+  version: 3.0.0rc1
 platform: ruby
 authors:
 - RightScale
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-15 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: listen
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: diplomat
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +46,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -81,12 +54,13 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
-- TODO.md
 - bin/console
 - bin/setup
 - cmdb.gemspec
+- docker-compose.yml
 - exe/cmdb
 - fixtures/Gemfile
 - fixtures/Gemfile.lock
@@ -95,11 +69,19 @@ files:
 - lib/cmdb.rb
 - lib/cmdb/commands.rb
 - lib/cmdb/commands/help.rb
+- lib/cmdb/commands/shell.rb
 - lib/cmdb/commands/shim.rb
-- lib/cmdb/consul_source.rb
-- lib/cmdb/file_source.rb
 - lib/cmdb/interface.rb
 - lib/cmdb/rewriter.rb
+- lib/cmdb/shell.rb
+- lib/cmdb/shell/dsl.rb
+- lib/cmdb/shell/printer.rb
+- lib/cmdb/shell/text.rb
+- lib/cmdb/source.rb
+- lib/cmdb/source/consul.rb
+- lib/cmdb/source/file.rb
+- lib/cmdb/source/memory.rb
+- lib/cmdb/source/network.rb
 - lib/cmdb/version.rb
 homepage: https://github.com/rightscale/cmdb
 licenses:
@@ -113,12 +95,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.1

data/TODO.md

@@ -1,3 +0,0 @@
-Actually respect --quiet
-
-Remove reset/late_initialize garbage.

data/lib/cmdb/consul_source.rb

@@ -1,83 +0,0 @@
-# encoding: utf-8
-require 'diplomat'
-
-module CMDB
-  class ConsulSource
-    # Regular expression to match array values
-    ARRAY_VALUE = /^\[(.*)\]$/
-
-    ### Class variables
-
-    class << self
-      attr_writer :url
-    end
-
-    class << self
-      attr_reader :url
-    end
-
-    class << self
-      attr_writer :prefixes
-    end
-
-    class << self
-      attr_reader :prefixes
-    end
-
-    ### Instance variables
-
-    # The url to communicate with consul
-    @url = nil
-
-    # Initialize the configuration for consul source
-    def initialize(prefix)
-      Diplomat.configure do |config|
-        config.url = self.class.url
-      end
-      @prefix = prefix
-    end
-
-    # Get a single key from consul
-    def get(key)
-      value = Diplomat::Kv.get(dot_to_slash(key))
-      process_value(value)
-    rescue TypeError
-      puts 'hi'
-    rescue Diplomat::KeyNotFound
-      nil
-    end
-
-    # Not implemented for consul source
-    def each_pair(&_block)
-      prefix = @prefix || ''
-      all = Diplomat::Kv.get(prefix, recurse: true)
-      all.each do |item|
-        dotted_prefix = prefix.split('/').join('.')
-        dotted_key = item[:key].split('/').join('.')
-        key = dotted_prefix == '' ? dotted_key : dotted_key.split("#{dotted_prefix}.").last
-        value = process_value(item[:value])
-        yield(key, value)
-      end
-    rescue Diplomat::KeyNotFound => exc
-      CMDB.log.warn exc.message
-    end
-
-    private
-
-    # Lazily parse a value, which may be valid JSON or may be a bare string.
-    # TODO: concat a regexp to match JSONable things
-    def process_value(val)
-      JSON.load(val)
-    rescue JSON::ParserError
-      val
-    end
-
-    # Converts the dotted notation to a slashed notation. If a @prefix is set, it applies the prefix.
-    # @example
-    #   "common.proxy.endpoints" => common/proxy/endpoints (or) shard403/common/proxy/endpoints
-    def dot_to_slash(key)
-      key = "#{@prefix}.#{key}" unless @prefix.nil?
-      key.split('.').join('/')
-    end
-  end
-end