envme 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3605caf67c6c5d98f9e545266961dac5ab544d5c
-  data.tar.gz: 342bfaf9d404df61f4783726241d8e67148343ae
+  metadata.gz: 2c1ec39ab7cdf49a40801b6428baa94be80eb4e4
+  data.tar.gz: 34881da0634db7a3cab73cdf661876225521c024
 SHA512:
-  metadata.gz: 4362d77d0db0d311b75c9f242daffe6c3752fdfc4d52b8c9966d00c8a5ed0714629b1aadc713efec07229cac6391d24290d4434065735c0217a0fd71249640b8
-  data.tar.gz: c72570a32ae56d715e1de8777ca583b34f1954e5c1ecb6c22952f52a6f93ee32c4d63e2d612b1bbd47ecd59fcecf2fdaf344aea393a00964a1acb5c05b7fd898
+  metadata.gz: ea15ffbd4f8de393d064f3d467b404f5181e30d31f265d9b63ad2def51cc8d1315011987627e8771e076512ceb1daf0075ea716c88f2983f2ef0b9321a55d64f
+  data.tar.gz: e036e7f40af9e6ebc8f9fc8dbd7cc2ba171ae9d593865284e2dbfbb6c55056a9cad87cad3e027acae6d1e6ef6720ea9171237687581cc9e782e8e8b4b3a85ebe

data/README.md

@@ -4,7 +4,9 @@ Envme is a Ruby wrapper around hashicorp's [envconsul](https://github.com/hashic
 
 ## Installation
   
-  $ gem install envme
+```shell
+$ gem install envme
+```
 
 Or add to your Gemfile
 
@@ -24,32 +26,36 @@ gem 'envme',  '>=0.1.2'
   end
 ```
 
-### Get all at specified prefix
+### Get
+
+Grab everything at specified prefix:
 
 ```ruby
-Envme::Vars.get_all('test/prefix')
+Envme::Vars.get('test/prefix')
 => ["DB_ENDPOINT=db.endpoint.com", "DB_PASSWD=p@s$W0rd", "DB_USERNAME=dbuser", "REST_ENDPOINT=rest.endpoint.com"]
 ```
 
-### Get limited by using a search string
+Limit return by passing in a search string:
 
 ```ruby
-Envme::Vars.get_limited('test/prefix', 'rest')
+Envme::Vars.get('test/prefix', 'rest')
 => ["REST_ENDPOINT=rest.endpoint.com"]
 
-Envme::Vars.get_limited('test/prefix', 'db')
+Envme::Vars.get('test/prefix', 'db')
 => ["DB_ENDPOINT=db.endpoint.com", "DB_PASSWD=p@s$W0rd", "DB_USERNAME=dbuser"]
+```
 
-# Using multiple search strings
+Using multiple search strings:
 
-Envme::Vars.get_limited('test/prefix', 'db', 'rest')
+```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"]
 ```
 
 ### Sanitizing return values
 
 ```ruby
-vars = Envme::Vars.get_limited('test', 'db')
+vars = Envme::Vars.get('test', 'db')
 => ["PREFIX_DB_ENDPOINT=db.endpoint.com", "PREFIX_DB_PASSWD=p@s$W0rd", "PREFIX_DB_USERNAME=dbuser"]
 
 Envme::Vars.sanitize(vars, 'prefix')
@@ -59,7 +65,7 @@ Envme::Vars.sanitize(vars, 'prefix')
 ### Building exports and File builder scripts
 
 ```ruby
-vars = Envme::Vars.get_limited('test/prefix', 'db')
+vars = Envme::Vars.get('test/prefix', 'db')
 => ["DB_ENDPOINT=db.endpoint.com", "DB_PASSWD=p@s$W0rd", "DB_USERNAME=dbuser"]
 
 puts Envme.build_exports(vars)

data/lib/envme/vars.rb

@@ -1,17 +1,16 @@
 module Envme
   class Vars < Envme::CommandRunner
 
-    def self.get_all(prefix)
-      env = `env`.split("\n")
-      env_vars = run(prefix).split("\n") - env
+    def self.get(prefix, *search_strings)
+      env         = `env`.split("\n")
+      consul_vars = run(prefix).split("\n") - env
+      env_vars    = consul_vars.select{ |var| !var.split("=")[0].nil? }
 
-      env_vars.select{ |var| !var.split("=")[0].nil? }
-    end
-
-    def self.get_limited(prefix, *search_strings)
-      env_vars = get_all(prefix)
-
-      limit_to_search(env_vars, search_strings)
+      if search_strings.empty?
+        env_vars
+      else
+        limit_to_search(env_vars, search_strings)
+      end
     end
 
     def self.sanitize(vars, search)

data/lib/envme/version.rb

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

data/spec/vars_spec.rb

@@ -11,27 +11,38 @@ describe Envme::Vars do
     allow(Envme::CommandRunner).to receive(:run) { envconsul_data }
   end
 
-  context "#get_all" do
-    it "calls run and returns an array" do
+  context "#get" do
+    it "calls run"  do
       prefix = 'test/prefix'
       expect(Envme::CommandRunner).to receive(:run).with(prefix)
 
-      Envme::Vars.get_all(prefix)
+      Envme::Vars.get(prefix)
     end
 
     it "returns an Array" do
       prefix = 'test/prefix'
 
-      env_vars = Envme::Vars.get_all(prefix)
+      env_vars = Envme::Vars.get(prefix)
       expect(env_vars).to be_kind_of(Array)
     end
-  end
 
-  context "#get_limited" do
-    it "returns only the values matching search params" do
+    it "returns all if no search string is given" do
+      prefix = 'test/prefix'
+
+      expected = [
+        "COMPONENT_PARAM1=first_param",
+        "COMPONENT_PARAM2=second PaRam",
+        "ENVVAR_PARAM3=env var"
+      ]
+
+      env_vars = Envme::Vars.get(prefix)
+      expect(env_vars).to eq(expected)
+    end
+
+    it "returns only values matching search params" do
       prefix = 'test/prefix'
 
-      vars = Envme::Vars.get_limited(prefix, 'ENVVAR')
+      vars = Envme::Vars.get(prefix, 'ENVVAR')
       expect(vars.size).to eq(1)
       expect(vars[0]).to eq('ENVVAR_PARAM3=env var')
       expect(vars).not_to include("COMPONENT_PARAM2=second PaRam")
@@ -40,7 +51,7 @@ describe Envme::Vars do
     it "can accept multiple search strings" do
       prefix = 'test/prefix'
 
-      vars = Envme::Vars.get_limited(prefix, 'ENVVAR', 'COMPONENT')
+      vars = Envme::Vars.get(prefix, 'ENVVAR', 'COMPONENT')
       expect(vars.size).to eq(3)
       expect(vars[0]).to eq('COMPONENT_PARAM1=first_param')
     end
@@ -56,7 +67,7 @@ describe Envme::Vars do
       allow(Envme::CommandRunner).to receive(:run) { envconsul_data }
       prefix = 'test/prefix'
 
-      expect{Envme::Vars.get_limited(prefix, 'COMPONENT')}.to_not raise_error
+      expect{Envme::Vars.get(prefix, 'COMPONENT')}.to_not raise_error
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: envme
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - 'Reppard Walker '