ssm_env 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97104554b9b5e31d042dd09931660e71ee90e763
-  data.tar.gz: cbfe8f4766626b0111a42e2bf9b352bd70448ff1
+  metadata.gz: d96048267a0d225a6f5d2c350cd578eba8b7e939
+  data.tar.gz: 3bb63f00651a0944b939edc84f45dde6ad65d79c
 SHA512:
-  metadata.gz: ed83eadf1d87c037a364b742897283c1bec87950df566d2bedfad85bfc9041e1090ef2b52ae28720278d7dc29d9db9d0d7b3e872f2ebcdb0c193834b3ddfcf74
-  data.tar.gz: 3e8c10fae27d5e9f328c423201c283dde8a26315310a3b093929350e55b7bdc485f4c5caeb549538984a9f6a86ccc70348028c84749661f1e520521a66c9df91
+  metadata.gz: e38e6e4bdd1d9ad8081000872d4ee4fd99f9d8ac5037389d3195cca6c44b5561b9b0f3fd721afa017c2ba0cab32147d41927e2b091b1fe6f78a493f8735559e8
+  data.tar.gz: cb3e3cfdfb913f95c3fb6ca6b95d6971f9cb5930a5b78046167b73374a1c0597502cc6366a9d5f2ad759f95bfd4b009496a21dcbdd696fafe53b9fa1b97d0406

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ## Usage
 
-#### Use this from the command line like 
+#### Use this from the command line like
 
 **Output Values**
 ```
@@ -42,15 +42,56 @@ ssm_env save -p .env -i "BRANCH_KEY,VACUUM_RATE"
 ssm_env save -p .env -i ssm_param_names.yml
 ```
 
-#### Use this in ruby like 
+#### Use this in ruby like
 ```
 ssm_env = SsmEnv.new.run(params_list: [BRANCH_KEY, VACUUM_LIMIT])
 # Update the environment
-ssm_env.to_env 
+ssm_env.to_env
 # Store in a file
 ssm_env.to_file('/tmp/my_vars.env')
 ```
 
+#### Using this with Rails (Production)
+```
+# Fetch parameters from AWS SSM
+param_names = [
+    "STRIPE_API_KEY",
+    "OTHER_SECRET_KEY",
+]
+
+# NOTE: You don't need to provide AWS credentials. You only need to give your EC2 server an Instance Role that allows SSM read access.
+ssm_params = SsmEnv.fetch(params_list: param_names)
+
+# Make parameters ENV variables
+SsmEnv.to_env(ssm_params: ssm_params)
+
+# Use the parameters through ENV variables in your Rails app
+ENV['STRIPE_API_KEY']
+```
+
+#### Using this with Rails (Local Development)
+```
+# Fetch parameters from AWS SSM
+param_names = [
+    "STRIPE_API_KEY",
+    "OTHER_SECRET_KEY",
+]
+
+# NOTE: you can provide access_key_id and secret_access_key for local development (you can use a gem such as dotenv to have these credentials in a .env file that is not committed to source code)
+# You could also omit access_key_id and secret_access_key, but make sure they are exported in your ~/.profile as ENV variables
+ssm_params = SsmEnv.fetch(
+  params_list: param_names,
+  access_key_id: ENV['LOCAL_DEV_AWS_ACCESS_KEY_ID'],
+  secret_access_key: ENV['LOCAL_DEV_AWS_SECRET_ACCESS_KEY'])
+
+# Make parameters ENV variables
+SsmEnv.to_env(ssm_params: ssm_params)
+
+# Use the parameters through ENV variables in your Rails app
+ENV['STRIPE_API_KEY']
+
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -60,4 +101,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Everlance/ssm_env.
-

data/lib/ssm_env/version.rb

@@ -1,3 +1,3 @@
 module SsmEnv
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

data/lib/ssm_env.rb

@@ -5,8 +5,8 @@ require "ssm_env/fetcher"
 require "ssm_env/client"
 
 module SsmEnv
-  def self.fetch(params_list: )
-    @fetcher ||= SsmEnv::Fetcher.new(client: SsmEnv.client)
+  def self.fetch(params_list: , access_key_id: nil, secret_access_key: nil)
+    @fetcher ||= SsmEnv::Fetcher.new(client: SsmEnv.client(access_key_id, secret_access_key))
     @ssm_params = @fetcher.fetch(params: params_list)
   end
   def self.to_env(ssm_params: )
@@ -17,10 +17,10 @@ module SsmEnv
       ssm_params.each { |name, attribs| f << "#{name}=#{attribs[:value]}\n"}
     end
   end
-  def self.client
+  def self.client(access_key_id, secret_access_key)
     @client = Client.get_client(region:             SsmEnv.config.region,
-                                access_key_id:      SsmEnv.config.access_key_id,
-                                secret_access_key:  SsmEnv.config.secret_access_key)
+                                access_key_id:      access_key_id || SsmEnv.config.access_key_id,
+                                secret_access_key:  secret_access_key || SsmEnv.config.secret_access_key)
   end
   def self.config
     @config ||= OpenStruct.new(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssm_env
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Rob Lane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-01 00:00:00.000000000 Z
+date: 2017-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk