consult 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46ea3e316eba29453ae4fd2b33bf73e38112b21a14cc4f87c2ce906c0d139309
-  data.tar.gz: 96ba993d95a8ef6ab6f315856a943b11fada8eacb2bddf618fb372f15a08643a
+  metadata.gz: 36965e0fbed738e72487cda4371047459b67bcc980b2926fc74e604feadbc712
+  data.tar.gz: 6922f60403c25f25b944648319a3ad1dc3fb680c850688399559c34e0e0afaac
 SHA512:
-  metadata.gz: f47bc8fccf91f7efcd5ae3b9042e1c22d93a8c5a2f375a934ea5aaddae7eb0b8ecb7c63384367abf5428453f5bad98a2513b7b75ebf421ac15ba3a9c353ed05a
-  data.tar.gz: 8500c4dd097cfbc4c82cd3f9054c006214a4d51cf0ca0e79ae77655c2392581f341c031dfbdb66d1804d418148489411f164c46a7c58f0e055c2d70d18f22993
+  metadata.gz: f1690e8cd6ae71d813e26c77e71ae37916c1b6e15c142f2c4cc34975e18e38c5622f006d9d1c840e98b35476c4b9c6b503fd73f482f495cc962c215eda7a0247
+  data.tar.gz: e5013584ee2e288d2c75cb21ae746bb1409e598eeb2aba8499e58ea50d3a1c5db5ebb0b6389f94926df5e27ebab9fa9f0966e5c9073f331f2937717e8d8b063a

data/README.md

@@ -40,6 +40,16 @@ Pre-existing copies of files generated by Consult (such as `secrets.yml`, `datab
 
 If this gem is included in a Rails, the templates will render on Rails boot. Configuration or credential changes can be picked up by restarting your app.
 
+### CLI
+
+Render templates on demand with the CLI. By default, this will bypass template TTLs to force rendering and provide verbose output. See `consult --help` for options.
+
+```bash
+$ bundle exec consult
+Consult: Rendered my_config
+Consult: Rendered secrets
+```
+
 ### Configuration
 
 ```yaml

data/bin/consult

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/consult/cli'
+
+cli = Consult::CLI.instance
+cli.parse
+cli.render

data/consult.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['consult']
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '> 4', '< 6'
@@ -29,10 +29,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'vault', '>= 0.10.0', '< 1.0.0'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-rspec'
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov'

data/lib/consult.rb

@@ -18,8 +18,9 @@ module Consult
   CONSUL_DISK_TOKEN = Pathname.new("#{Dir.home}/.consul-token").freeze
 
   class << self
-    attr_reader :config, :templates
-    def load(config_dir: nil)
+    attr_reader :config, :templates, :force_render
+
+    def load(config_dir: nil, force_render: false, verbose: nil)
       root directory: config_dir
       yaml = root.join('config', 'consult.yml')
 
@@ -27,7 +28,9 @@ module Consult
       @all_config.deep_symbolize_keys!
 
       @config = @all_config[:shared].to_h.deep_merge @all_config[env&.to_sym].to_h
-      @templates = @config[:templates]&.map { |name, config| Template.new(name, config) } || []
+      @templates = @config[:templates]&.map { |name, config| Template.new(name, config.merge(verbose: verbose)) } || []
+
+      @force_render = force_render
 
       configure_consul
       configure_vault
@@ -71,7 +74,7 @@ module Consult
 
     # Return only the templates that are relevant for the current environment
     def active_templates
-      templates.select(&:should_render?)
+      force_render ? templates : templates.select(&:should_render?)
     end
 
     # Render templates.

data/lib/consult/cli.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+$stdout.sync = true
+
+require 'singleton'
+require 'optparse'
+
+require_relative '../consult'
+
+module Consult
+  class CLI
+    include Singleton
+
+    attr_reader :opts
+
+    def parse(args = ARGV)
+      @opts = parse_options(args)
+      Consult.load @opts
+    end
+
+    def render
+      Consult.render!
+    end
+
+    def parse_options(argv)
+      opts = {
+        config_dir: Dir.pwd,
+        force_render: true,
+        verbose: true
+      }
+
+      @parser = OptionParser.new do |o|
+        o.on '-d', '--directory=DIR', 'Path to directory containing the config directory' do |arg|
+          opts[:config_dir] = arg
+        end
+
+        o.on '-f', '--[no-]force', TrueClass, 'Ignore template TTLs and force rendering' do |arg|
+          opts[:force_render] = arg
+        end
+
+        o.on '-v', '--quiet', FalseClass, 'Silence output' do |arg|
+          opts[:verbose] = arg
+        end
+      end
+
+      @parser.on_tail "-h", "--help", "Show help" do
+        puts @parser
+        exit 1
+      end
+
+      @parser.parse! argv
+      opts
+    end
+  end
+end

data/lib/consult/template.rb

@@ -22,6 +22,7 @@ module Consult
       result = renderer.result(binding)
 
       File.open(dest, 'w') { |f| f << result } if save
+      puts "Consult: Rendered #{name}" if verbose?
       result
     rescue StandardError => e
       STDERR.puts "Error rendering template: #{name}"
@@ -55,6 +56,10 @@ module Consult
       dest.mtime < (Time.now - @config[:ttl].to_i)
     end
 
+    def verbose?
+      @config[:verbose]
+    end
+
     def ordered_locations
       @config.keys & LOCATIONS
     end

data/lib/consult/version.rb

@@ -1,3 +1,3 @@
 module Consult
-  VERSION = '0.8.2'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consult
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Jeff Fraser
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-10-24 00:00:00.000000000 Z
+date: 2019-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -78,20 +78,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -121,7 +107,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,7 +165,8 @@ dependencies:
 description: Manage consul/vault backed template files in Ruby.
 email:
 - jeff.fraser@veracross.com
-executables: []
+executables:
+- consult
 extensions: []
 extra_rdoc_files: []
 files:
@@ -195,10 +182,12 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/consult
 - bin/setup
 - consult.gemspec
 - docker-compose.yml
 - lib/consult.rb
+- lib/consult/cli.rb
 - lib/consult/rails/engine.rb
 - lib/consult/template.rb
 - lib/consult/template_functions.rb