envme 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2c1ec39ab7cdf49a40801b6428baa94be80eb4e4
-  data.tar.gz: 34881da0634db7a3cab73cdf661876225521c024
+SHA256:
+  metadata.gz: 5098e39b92393685c4daedd5b2ef8e86ff1183dc1be21147c3c8c98e82a395fc
+  data.tar.gz: cdc20d80247ea1f9f7f6ee0390f8bcc438facdcd516f0f399f3135b717a565fe
 SHA512:
-  metadata.gz: ea15ffbd4f8de393d064f3d467b404f5181e30d31f265d9b63ad2def51cc8d1315011987627e8771e076512ceb1daf0075ea716c88f2983f2ef0b9321a55d64f
-  data.tar.gz: e036e7f40af9e6ebc8f9fc8dbd7cc2ba171ae9d593865284e2dbfbb6c55056a9cad87cad3e027acae6d1e6ef6720ea9171237687581cc9e782e8e8b4b3a85ebe
+  metadata.gz: a4157b85087360e40ad79f71744d8b7123c5f66791f8e804b96aa97b0b15e1d75cc241f5ae2c91ca6e43efb5b6eda191459e01c5a0ce3d105afee2991b6b52e3
+  data.tar.gz: d86cacd96befe38118ee37e725bef9298566718ef5540c8136ffd275083c36aeb1e06969c8467fb9d9107626a1a189686df1cc464ce77a0127ed469f2808cc2e

data/README.md

@@ -1,6 +1,6 @@
 # Envme [![Gem Version](https://badge.fury.io/rb/envme.svg)](http://badge.fury.io/rb/envme) [![Circle CI](https://circleci.com/gh/reppard/envme.svg?style=svg)](https://circleci.com/gh/reppard/envme)
 
-Envme is a Ruby wrapper around hashicorp's [envconsul](https://github.com/hashicorp/envconsul).  It fetches k/v data from Consul using a user specified prefix which can then be used to configure your app with the returned enviroment variables.  It can be useful for building AWS user data or generating systemd service files.
+Envme is a Ruby wrapper around hashicorp's [envconsul](https://github.com/hashicorp/envconsul).  It fetches k/v data from Consul using a user specified prefix which can then be used to configure your app with the returned enviroment variables.  It can be useful for building AWS user data or generating systemd service files.  Currently works with envconsul v0.5.0.
 
 ## Installation
   
@@ -13,7 +13,7 @@ Or add to your Gemfile
 ```ruby
 source 'https://rubygems.org'
 
-gem 'envme',  '>=0.1.2'
+gem 'envme',  '>=0.2.0'
 ```
 
 ## Usage
@@ -32,56 +32,89 @@ Grab everything at specified prefix:
 
 ```ruby
 Envme::Vars.get('test/prefix')
-=> ["DB_ENDPOINT=db.endpoint.com", "DB_PASSWD=p@s$W0rd", "DB_USERNAME=dbuser", "REST_ENDPOINT=rest.endpoint.com"]
+# => ["DB_ENDPOINT=db.endpoint.com", "DB_PASSWD=p@s$W0rd", "DB_USERNAME=dbuser", "REST_ENDPOINT=rest.endpoint.com"]
 ```
 
 Limit return by passing in a search string:
 
 ```ruby
 Envme::Vars.get('test/prefix', 'rest')
-=> ["REST_ENDPOINT=rest.endpoint.com"]
+# => ["REST_ENDPOINT=rest.endpoint.com"]
 
 Envme::Vars.get('test/prefix', 'db')
-=> ["DB_ENDPOINT=db.endpoint.com", "DB_PASSWD=p@s$W0rd", "DB_USERNAME=dbuser"]
+# => ["DB_ENDPOINT=db.endpoint.com", "DB_PASSWD=p@s$W0rd", "DB_USERNAME=dbuser"]
 ```
 
 Using multiple search strings:
 
 ```ruby
 Envme::Vars.get('test/prefix', 'db', 'rest')
-=> ["DB_PASSWD=p@s$W0rd", "DB_USERNAME=dbuser", "REST_ENDPOINT=rest.endpoint.com", "DB_ENDPOINT=db.endpoint.com"]
+# => ["DB_PASSWD=p@s$W0rd", "DB_USERNAME=dbuser", "REST_ENDPOINT=rest.endpoint.com", "DB_ENDPOINT=db.endpoint.com"]
 ```
 
 ### Sanitizing return values
 
 ```ruby
 vars = Envme::Vars.get('test', 'db')
-=> ["PREFIX_DB_ENDPOINT=db.endpoint.com", "PREFIX_DB_PASSWD=p@s$W0rd", "PREFIX_DB_USERNAME=dbuser"]
+# => ["PREFIX_DB_ENDPOINT=db.endpoint.com", "PREFIX_DB_PASSWD=p@s$W0rd", "PREFIX_DB_USERNAME=dbuser"]
 
 Envme::Vars.sanitize(vars, 'prefix')
-=> ["DB_ENDPOINT=db.endpoint.com", "DB_PASSWD=p@s$W0rd", "DB_USERNAME=dbuser"]
+# => ["DB_ENDPOINT=db.endpoint.com", "DB_PASSWD=p@s$W0rd", "DB_USERNAME=dbuser"]
 ```
 
-### Building exports and File builder scripts
+### Building scripts
+
+Exports for script:
 
 ```ruby
 vars = Envme::Vars.get('test/prefix', 'db')
-=> ["DB_ENDPOINT=db.endpoint.com", "DB_PASSWD=p@s$W0rd", "DB_USERNAME=dbuser"]
+# => ["DB_ENDPOINT=db.endpoint.com", "DB_PASSWD=p@s$W0rd", "DB_USERNAME=dbuser"]
+
+exports = Envme.build_exports(vars)
+# => "export DB_ENDPOINT=db.endpoint.com\nexport DB_PASSWD=p@s$W0rd\nexport DB_USERNAME=dbuser"
 
-puts Envme.build_exports(vars)
+start_script = <<-eos
+#!/bin/bash
+#{exports}
+ruby app.rb
+eos
+# => "#!/bin/bash\nexport DB_ENDPOINT=db.endpoint.com\nexport DB_PASSWD=p@s$W0rd\nexport DB_USERNAME=dbuser\nruby app.rb\n"
 
+puts start_script
+
+#!/bin/bash
 export DB_ENDPOINT=db.endpoint.com
 export DB_PASSWD=p@s$W0rd
 export DB_USERNAME=dbuser
+ruby app.rb
+=> nil
+```
+
+Populate a systemd EnvironmentFile:
+
+```ruby
+vars = Envme::Vars.get('test/prefix', 'rest', 'db')
+# => ["DB_PASSWD=p@s$W0rd", "DB_USERNAME=dbuser", "REST_ENDPOINT=rest.endpoint.com", "DB_ENDPOINT=db.endpoint.com"]
 
+file_builder = Envme.file_builder(vars, '/etc/sysconfig/my_service.service')
+# => "echo DB_ENDPOINT=db.endpoint.com >> /etc/sysconfig/my_service.service\necho DB_PASSWD=p@s$W0rd >> /etc/sysconfig/my_service.service\necho DB_USERNAME=dbuser >> /etc/sysconfig/my_service.service\necho REST_ENDPOINT=rest.endpoint.com >> /etc/sysconfig/my_service.service"
 
-# Build a script to populate a systemd EnvironmentFile
+user_data = <<-eos
+#!/bin/bash
+#{file_builder}
+systemctl my_service start
+eos
+=> "#!/bin/bash\necho DB_ENDPOINT=db.endpoint.com >> /etc/sysconfig/my_service.service\necho DB_PASSWD=p@s$W0rd >> /etc/sysconfig/my_service.service\necho DB_USERNAME=dbuser >> /etc/sysconfig/my_service.service\necho REST_ENDPOINT=rest.endpoint.com >> /etc/sysconfig/my_service.service\nsystemctl my_service start\n"
 
-puts Envme.file_builder(vars, '/etc/sysconfig/my_service.service')
+puts user_data
 
+#!/bin/bash
 echo DB_ENDPOINT=db.endpoint.com >> /etc/sysconfig/my_service.service
 echo DB_PASSWD=p@s$W0rd >> /etc/sysconfig/my_service.service
 echo DB_USERNAME=dbuser >> /etc/sysconfig/my_service.service
+echo REST_ENDPOINT=rest.endpoint.com >> /etc/sysconfig/my_service.service
+systemctl my_service start
+=> nil
 ```
 
 Inspired by [Diplomat](https://github.com/WeAreFarmGeek/diplomat)

data/lib/envme.rb

@@ -29,7 +29,7 @@ module Envme
 
     def file_builder(var_collection, filename)
       var_collection.collect{ |var|
-        "echo #{var} >> #{filename}"
+        "echo '#{var}' >> #{filename}"
       }.sort.join("\n")
     end
   end

data/lib/envme/version.rb

@@ -1,3 +1,3 @@
 module Envme
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envme
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - 'Reppard Walker '
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-15 00:00:00.000000000 Z
+date: 2020-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,8 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Envme is a Ruby wrapper for envconsul with a few extras.