ssm_env 0.1.8 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 97104554b9b5e31d042dd09931660e71ee90e763
-  data.tar.gz: cbfe8f4766626b0111a42e2bf9b352bd70448ff1
+SHA256:
+  metadata.gz: b34d28c279bb7029318ab60da22e40d69486fbeda7243e3453f6d8be38b88f32
+  data.tar.gz: 1b801f4ba5451052f7023ec642846a359d3bf2803edd67410ec9f3a0e7c5b23d
 SHA512:
-  metadata.gz: ed83eadf1d87c037a364b742897283c1bec87950df566d2bedfad85bfc9041e1090ef2b52ae28720278d7dc29d9db9d0d7b3e872f2ebcdb0c193834b3ddfcf74
-  data.tar.gz: 3e8c10fae27d5e9f328c423201c283dde8a26315310a3b093929350e55b7bdc485f4c5caeb549538984a9f6a86ccc70348028c84749661f1e520521a66c9df91
+  metadata.gz: 28e1be859f9ad6491926c026bca12520e7b61e14b3ac07be4360ac9b1ce32d1a5794a8a9dfa8a7aa70e2c59be83e43e41df5f2b4681f6244ee69daef3980ccfe
+  data.tar.gz: 5416103bbe2e1fcc388fac3a685bfd9445992871400696860e09f2b3c5be4bf2ec30322c441da5c31fc05bda9d81ffa96ebe2506887d63b871be172be19527b5

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright 2018-2019 Everlance
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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.3"
 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(

data/ssm_env.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = SsmEnv::VERSION
   spec.authors       = ["Rob Lane"]
   spec.email         = ["rob@everlance.com"]
+  spec.license       = 'MIT'
 
   spec.summary       = "Synchronize your AWS SSM parameters to your environment"
 
@@ -16,8 +17,8 @@ Gem::Specification.new do |spec|
   spec.executables << 'ssm_env'
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "aws-sdk", "~> 2.0"
-  spec.add_runtime_dependency "thor", "0.19.1"
+  spec.add_runtime_dependency "aws-sdk", "~> 3.0"
+  spec.add_runtime_dependency "thor", "~> 1.1"
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssm_env
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: '0.3'
 platform: ruby
 authors:
 - Rob Lane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-12-01 00:00:00.000000000 Z
+date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - rob@everlance.com
 executables:
@@ -92,6 +92,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- MIT-LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -102,10 +103,11 @@ files:
 - lib/ssm_env/fetcher.rb
 - lib/ssm_env/version.rb
 - ssm_env.gemspec
-homepage: 
-licenses: []
+homepage:
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,9 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Synchronize your AWS SSM parameters to your environment
 test_files: []