consult 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31a2190f1f1f38f5b2f674fa7d1ed91be5522d335e10c655f05493cbfdc056c3
-  data.tar.gz: 0c51acfbd537bb327f6360a4e6ef59fa8ec79b35c7326e421b14362f7a47d827
+  metadata.gz: aa590a02bf4aceb2c3b04e21c5737d1b7e86160db8cb1251c79dcf612eba6e9f
+  data.tar.gz: 29e80de8a03c8c52eb156dcabaed67b43bad22997e6c3532994d177afce5d4b0
 SHA512:
-  metadata.gz: b68efe09e942c634da159734f792da61e9fe16dc288e95b3cfafa1c0392457998f4149d0a6c5c1748238ff7ac3bf1165e63c80ed2d956914a372e591dbfc1545
-  data.tar.gz: 14b46ab1dccee0d9739ec820ee94c89af221aedf83e5ec46f072df6fbe9b78c353cc603cd6274d68c8f5eafecde2adb20653c0ef322881843971d17465b209ef
+  metadata.gz: 8d6aebe85871c232f97e9b760c811b18e98488149214fe9c7b3f618b601e69323ba6f2c30ff270afd6d68a5783492407cbc1446e455efccc1d031c0a880a3a44
+  data.tar.gz: 532d19aaf161adb255f1179958814d03f1d9ced811c4405dcd2f66244589aa58c08e83583b84720feb6a8d6187f3a991076d7d4524c81b27bcddaf38716354e3

data/.gitignore

@@ -5,8 +5,10 @@
 /doc/
 /pkg/
 /spec/reports/
-/spec/support/rendered/
+/spec/support/rendered/*.yml
 /tmp/
 
 # rspec failure tracking
 .rspec_status
+.ruby-version
+Gemfile.lock

data/.travis.yml

@@ -1,15 +1,15 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.5.0
-  - 2.4.1
+  - 2.5
+  - 2.4
+  - 2.3
 
 services:
   - docker
 
 before_install:
-  - gem install bundler -v 1.16.1
-  - docker pull consul
-  - docker pull vault
-  - docker run -d --name=dev-consul -p 8500:8500 consul
-  - docker run -d --name=dev-vault -p 8200:8200 --cap-add=IPC_LOCK -e 'VAULT_DEV_ROOT_TOKEN_ID=94e1a9ed-5d72-5677-27ab-ebc485cca368' vault
+  - gem install bundler -v 1.16.2
+  - docker-compose --version
+  - docker-compose up -d
+  - docker ps

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 0.6.0
+
+* Fixed tests to account for versioned key-value stores in Vault 0.10+
+
+# 0.5.0
+
+Initial release.

data/README.md

@@ -1,5 +1,9 @@
 # Consult
 
+[![Gem Version](https://badge.fury.io/rb/consult.svg)](https://badge.fury.io/rb/consult)
+[![Build Status](https://travis-ci.org/veracross/consult.svg?branch=master)](https://travis-ci.org/veracross/consult)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d7b048b7edd9f27c83b9/maintainability)](https://codeclimate.com/github/veracross/consult/maintainability)
+
 Render configuration and secrets from [Consul] and [Vault] with ERB templates.
 
 This gem is a spiritual sibling to [Consul Template], but specifically intended for use in Ruby or Rails environments. It does not have the same features as Consul Template; it is intended for simpler scenarios. Most importantly, leases and configuration changes are _not_ watched to automatically re-render. Consult is intended for more static or medium-to-long lived configuration.
@@ -55,24 +59,24 @@ vault:
 # Enumerate the templates.
 templates:
   database:
-    # Relative paths are assumed to be in #{Rails.root}/config.
+    # Relative paths are assumed to be in #{Rails.root}.
     # Path to the template
-    path: templates/database.yml.erb
+    path: config/templates/database.yml.erb
     # Destination for the rendered template
-    dest: rendered/database.yml
+    dest: config/database.yml
     # Which environments to render this template in
     environments: all
     # If the file is less than this old, do not re-render
     ttl: 3600 # seconds
 
   secrets:
-    path: templates/secrets.yml.erb
-    dest: rendered/secrets.yml
+    path: config/templates/secrets.yml.erb
+    dest: config/secrets.yml
     environments: test
 
   should_be_excluded:
-    path: templates/fake.yml.erb
-    dest: rendered/fake.yml
+    path: config/templates/fake.yml.erb
+    dest: config/fake.yml
     environments: production # won't be rendered because it doesn't match `env` at the top
 ```
 
@@ -135,6 +139,10 @@ returns
 
 **secret(path)** - Fetch a secret at the given path.
 
+    # Vault KV v2
+    username: <%= secret('secret/data/credentials').data.dig(:data, :username) %>
+
+    # Vault KV v1
     username: <%= secret('secret/credentials').data[:username] %>
 
 yields
@@ -269,10 +277,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Testing is easiest by running Consul and Vault in Docker. Just boot up their minimal containers:
 
-    $ docker pull consul
-    $ docker pull vault
-    $ docker run -d --name=dev-consul -p 8500:8500 consul
-    $ docker run -d --name=dev-vault -p 8200:8200 --cap-add=IPC_LOCK -e 'VAULT_DEV_ROOT_TOKEN_ID=94e1a9ed-5d72-5677-27ab-ebc485cca368' vault
+    $ docker-compose up
 
 Then run `bundle exec rspec`, or `bundle exec guard`.
 

data/consult.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '> 4', '< 6'
-  spec.add_dependency 'diplomat'
-  spec.add_dependency 'vault'
+  spec.add_dependency 'diplomat', '~> 2.0.2'
+  spec.add_dependency 'vault', '~> 0.10.1'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'byebug'

data/docker-compose.yml

@@ -0,0 +1,14 @@
+version: '3'
+services:
+  consul:
+    image: consul:1.2.0
+    ports:
+      - "8500:8500"
+  vault:
+    image: vault:0.10.3
+    environment:
+      - VAULT_DEV_ROOT_TOKEN_ID=94e1a9ed-5d72-5677-27ab-ebc485cca368
+    cap_add:
+      - IPC_LOCK
+    ports:
+      - "8200:8200"

data/lib/consult.rb

@@ -81,7 +81,7 @@ module Consult
       ENV['CONSUL_HTTP_TOKEN'] ||
         @config[:consul].delete(:token) ||
         @config[:consul][:acl_token] ||
-        CONSUL_DISK_TOKEN.read.chomp
+        (CONSUL_DISK_TOKEN.exist? ? CONSUL_DISK_TOKEN.read.chomp : nil)
     end
   end
 end

data/lib/consult/version.rb

@@ -1,3 +1,3 @@
 module Consult
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consult
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Jeff Fraser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-23 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -34,30 +34,30 @@ dependencies:
   name: diplomat
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: vault
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -181,8 +181,8 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - Procfile
@@ -191,6 +191,7 @@ files:
 - bin/console
 - bin/setup
 - consult.gemspec
+- docker-compose.yml
 - lib/consult.rb
 - lib/consult/rails/engine.rb
 - lib/consult/template.rb

data/Gemfile.lock

@@ -1,106 +0,0 @@
-PATH
-  remote: .
-  specs:
-    consult (0.5.0)
-      activesupport (> 4, < 6)
-      diplomat
-      vault
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.1.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    byebug (9.1.0)
-    coderay (1.1.2)
-    concurrent-ruby (1.0.5)
-    diff-lcs (1.3)
-    diplomat (2.0.2)
-      faraday (~> 0.9)
-      json
-    docile (1.1.5)
-    faraday (0.14.0)
-      multipart-post (>= 1.2, < 3)
-    ffi (1.9.18)
-    formatador (0.2.5)
-    guard (2.14.1)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (~> 1.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.7.3)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
-    i18n (0.9.5)
-      concurrent-ruby (~> 1.0)
-    json (2.1.0)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    lumberjack (1.0.12)
-    method_source (0.9.0)
-    minitest (5.11.3)
-    multipart-post (2.0.0)
-    nenv (0.3.0)
-    notiffany (0.1.1)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (10.5.0)
-    rb-fsevent (0.10.2)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.0)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
-    ruby_dep (1.5.0)
-    shellany (0.0.1)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    thor (0.20.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    vault (0.10.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  byebug
-  consult!
-  guard
-  guard-rspec
-  pry
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  simplecov
-
-BUNDLED WITH
-   1.16.1