aws-secrets-manager 1.0.9 → 1.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78068c78c3948f4cbfc3ceff0670c7ca3800a3bda56f5deb09994156778084b7
-  data.tar.gz: '09542c519acae56d1a307475a1d6cd490b171be0682986c2cca146bd2a15451b'
+  metadata.gz: 90a8352b08a303335d95acfd19dcb9c0af1928bdf09304b5eea2f86018a4cdfc
+  data.tar.gz: 19321b36156444b7fad96727cce32c502f52d79a6cc1ec23207d65d864ed0c18
 SHA512:
-  metadata.gz: 68cf52b8b3850b828cbcee77dceaa0e48b3186d2a48e611ea5addd968a6ff42d647636b4d1bad00babc68eba6f0f55899d615bebd8ed6d8b0dec47bc3f42cc01
-  data.tar.gz: 58d0434be54edee0335669208650f6e2500d86726f1f22b515a65d0399c2e4a58742c9c0f6fad4e6b372842718cfbfd81adf48080631d5b4cd7c69221d36f57f
+  metadata.gz: 02ac6598112f119d3971960cd46fceec0d539697074675be469480defb9888ca1c595022c5dbd3808025399edd5f835cf5d0e97afef42b015e9c3bf68319007e
+  data.tar.gz: cc2cc2da359f59f3903ed928d45e1e9b0c724371e737a840a5d136308e892586958ebba56b3bc1137fdf59313594f5302c10c08784aa48cbb1472c436d6cf27e

data/README.md

@@ -16,28 +16,117 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-If you using Ruby on Rails then rails g aws-secrets-manager:install
+If you using Ruby on Rails then
+
+```ruby
+rails g aws_secrets_manager:install
+```
 
 or manualy add in Rack app config file:
 
 ```ruby
+# frozen_string_literal: true
+
+require 'aws_secrets_manager'
+
+AwsSecretsManager.configure do |config|
+  config.aws_region = ENV.fetch('AWS_REGION', 'eu-west-1')
+end
+
+AwsSecretsManager.get_secret_value(
+  secrets: [
+    {
+      name: ENV.fetch('AWS_SECRETS_PLAINTEXT_1', 'aws-secrets-plaintext-1-development'),
+      type: AwsSecretsManager::Config::PLAINTEXT
+    },
+    {
+      name: ENV.fetch('AWS_SECRETS_PLAINTEXT_2', 'aws-secrets-plaintext-2-development'),
+      type: AwsSecretsManager::Config::PLAINTEXT
+    },
+    {
+      name: ENV.fetch('AWS_SECRETS_KEY_VALUE_1', 'aws-secrets-key-value-1-development'),
+      type: AwsSecretsManager::Config::KEY_VALUE
+    },
+    {
+      name: ENV.fetch('AWS_SECRETS_KEY_VALUE_2', 'aws-secrets-key-value-2-development'),
+      type: AwsSecretsManager::Config::KEY_VALUE
+    },
+  ]
+)
+```
+
+In complex environments where applications require the use of multiple secrets, this gem can be an interesting solution.
+
+In AWS Secrets Manager if you have secret with name example-1 and with Secret value type => Key/value:
+
+```ruby
+{
+  "ex_1":"1",
+  "ex_2":"2",
+  "ex_3":"3"
+}
+```
+in console when type ENV you will have 3 env variable like:
+
+```ruby
+{
+  "EX_1"=>"1",
+  "EX_1"=>"1",
+  "EX_1"=>"1"
+}
+```
+
+In AWS Secrets Manager if you have secret with name example-2 and with Secret value type => Plaintext with value: 123456789
+
+in console when type ENV you will have 1 env variable like:
+
+```ruby
+{
+  "EXAMPLE_2"=>"123456789"
+}
+```
+
+IMPORTANT!!! When type => Plaintext
+
+SECRET NAME IS ENV KEY AND Secret value IS ENV VALUE
+
+Full example:
+
+Config:
+
+```ruby
+# frozen_string_literal: true
+
 require 'aws_secrets_manager'
 
 AwsSecretsManager.configure do |config|
-  config.aws_region = "AWS_REGION"
+  config.aws_region = ENV.fetch('AWS_REGION', 'eu-west-1')
 end
 
-AwsSecretsManager.get_secret_value(secrets: [
-  {
-    name: "secret_name",
-    type: "plaintext"
-  },
-  {
-    name: "secret_name",
-    type: "key_value"
-  }]
+AwsSecretsManager.get_secret_value(
+  secrets: [
+    {
+      name: 'common-secrets',
+      type: AwsSecretsManager::Config::KEY_VALUE
+    },
+    {
+      name: 'fake-ssh-key',
+      type: AwsSecretsManager::Config::PLAINTEXT
+    },
+  ]
 )
 ```
+Console output:
+
+```ruby
+{
+  "DATABASE_DSN"=>"postgres://user:pass@server:5432/db",
+  "API_KEY"=>"5S6BX2c6vx879eZ",
+  "ORIGIN"=>"https://example.com"
+  "SMTP_HOST"=>"mailcluster.example.com",
+  "FAKE_SSH_KEY"=>"-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCxxx7OfuLEm3wm\njOVKL4+ibYBrrL3p8id2x4DZ3C+7C8ZkwsC6\n"
+}
+```
 
 ## Development
 

data/lib/aws_secrets_manager/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AwsSecretsManager
-  VERSION = "1.0.9"
+  VERSION = "1.1.9"
 end

data/lib/aws_secrets_manager.rb

@@ -13,6 +13,4 @@ module AwsSecretsManager
   include Config
   extend Client
   extend GetSecretValue
-
-  class Error < StandardError; end
 end

data/lib/generators/aws_secrets_manager/install_generator.rb

@@ -14,18 +14,28 @@ if Gem.loaded_specs.key?("rails")
 require 'aws_secrets_manager'
 
 AwsSecretsManager.configure do |config|
-  config.aws_region = "AWS_REGION"
+  config.aws_region = ENV.fetch("AWS_REGION", 'eu-west-1')
 end
 
-AwsSecretsManager.get_secret_value(secrets: [
-  {
-    name: "secret_name",
-    type: "plaintext"
-  },
-  {
-    name: "secret_name",
-    type: "key_value"
-  }]
+AwsSecretsManager.get_secret_value(
+  secrets: [
+    {
+      name: ENV.fetch('AWS_SECRETS_PLAINTEXT_1', 'aws-secrets-plaintext-1-development'),
+      type: AwsSecretsManager::Config::PLAINTEXT
+    },
+    {
+      name: ENV.fetch('AWS_SECRETS_PLAINTEXT_2', 'aws-secrets-plaintext-2-development'),
+      type: AwsSecretsManager::Config::PLAINTEXT
+    },
+    {
+      name: ENV.fetch('AWS_SECRETS_KEY_VALUE_1', 'aws-secrets-key-value-1-development'),
+      type: AwsSecretsManager::Config::KEY_VALUE
+    },
+    {
+      name: ENV.fetch('AWS_SECRETS_KEY_VALUE_2', 'aws-secrets-key-value-2-development'),
+      type: AwsSecretsManager::Config::KEY_VALUE
+    },
+  ]
 )
           FILE
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-secrets-manager
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.1.9
 platform: ruby
 authors:
 - Aleksandar Popovic