securenv 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f98e4349739d04c45f76ef3065a0c1929910fe9e9b29332d0a1d384cd69a6a73
-  data.tar.gz: 23abb50be1835f36adea2c3a76d28aa7cda2997951d08bdfef49b4bbd1a1d969
+  metadata.gz: a81016414f2f135f892221107f59250bef0fa88c6266256842bc63750bcdd116
+  data.tar.gz: d19b97dc0e9bf70d1520798cbc78bd8b7897ae33d5692fe6bda638303a59d1c0
 SHA512:
-  metadata.gz: d0298049140580e3a89db7abf0a5dee76c14b5202e101a10fd41b2cd0946d9fdb835825397529fc30848e4b310f7e81d75eaa5a697a485ef6692de9b37d9a59c
-  data.tar.gz: 165c89584a73624004788ba1b11d4dbf9ca653ef60b1b3405b2417a3c614db5c5a6d94d9202138b45f75502c2da38d01351ad5d69daf083f54fb26151c992b13
+  metadata.gz: e6fababb6120228d63644966bb2ca448a9d629697d45a24f8bc2e71c2adafda386177c732cb462364b2216e0eb515c214ec74e58d2e28b3d23cbd33cea8af066
+  data.tar.gz: 1766c8d7a37b7cab046e3ded44671fb106dac333fb6049ae0a2000e08d13762ee2f9d4037da1f63ad71c5b9716aa032d2123896b217f5a0d803720a68d575efa

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    securenv (0.1.1)
+    securenv (1.0.0)
       aws-sdk-ssm
       thor
 

data/README.md

@@ -20,8 +20,9 @@ Or install it yourself as:
 
 ## Usage
 
-**NOTE : These docs are currently aspirational. This gem is very new and doesn't do _anything_ yet. The
-following is "documentation driven development".**
+There are two parts to using `securenv`:
+1.  Setting secure environment variables in SSM via the command line or programatically.
+2.  Populating a runtime ENV with values previously stored in SSM.
 
 ### Set a secure environment variable
 
@@ -37,6 +38,13 @@ Or you can use the short form:
 securenv set FOO=bar -a myapp -s production
 ```
 
+If you want to set them programtically you can do something like this:
+
+```ruby
+securenv = Securenv::Client.new(app: 'myapp', stage: 'dev')
+securenv.set(variable: 'FOO', value: 'bar')
+```
+
 ### Using secure environment variables in your app
 
 Before or during the boot stage of your app you can require `securenv` and give it a list of ENV variables
@@ -44,15 +52,16 @@ to populate.
 
 ```ruby
 require 'securenv'
-Securenv.app = 'myapp' # For rails you could use Rails.application.class.module_parent.name
-Securenv.app = ENV['STAGE'] # For rails you might use ENV['RAILS_ENV']
-Securenv.populate %w[
-  FOO
-  MY_SECRET_KEY
-]
+
+securenv = Securenv::Client.new(
+  app: 'myapp', # For rails you could use Rails.application.class.module_parent.name
+  stage: ENV['STAGE'] # For rails you might use ENV['RAILS_ENV']
+)
+
+securenv.populate_env
 ```
 
-Then you'll be able to use `ENV['FOO']` to access the value that you set previously.
+Then you'll be able to use `ENV['FOO']` (and others) to access the value that you set previously.
 
 ## Development
 

data/lib/securenv/version.rb

@@ -1,3 +1,3 @@
 module Securenv
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: securenv
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Jeremy Green