dry-credentials 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8940c71155c930786c83a30a5513a6e8312eaa10c161caa8a6a6b69f700626f9
-  data.tar.gz: b44e8fbb54d2bd7dd11d0d43cbe5c4f84f4e0f4b1ef94b5766359b0e7276ddfb
+  metadata.gz: 75fffe7657df51c4024515b19bc9844f19ab914885e9fa7bfc88eecd777a6562
+  data.tar.gz: 99d82a79fa22559765e2ec7673038a153771739fe95fe564dded76f689c4ae36
 SHA512:
-  metadata.gz: 02f67b851a1e06dbd9973a4e809881d989e88399bb8498ec46f28dad9862fc1f87973fe17988ce2955a248bcd2620e2acbcadc4a4d12316cb0167e8ec07292d4
-  data.tar.gz: 7de2214a5ea6da20fbf749d901111ca503aac98f5a287743e1761d0adeab3d794d0694bb4ad70810a4d2b6dabde9ba8e5b3345f7272ea3063c803ab56db312a5
+  metadata.gz: 95cf92beaa0f57b58c537ca34f50996d0a13fdbc263b4ce242e1bbdf125d80eb0e6c6458f02769bd2cebea4f53fcdbe0ca0c50d0fff000cece2c5921509b5c12
+  data.tar.gz: 5ab85de6a1c56572e9c228c29201387e78890948af7ab8c312726659e6687c32315df2b010677e84c0b23b1f4b289be0e00f495eac99cbeb0cfe5a6c0e7a944b

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 Nothing so far
 
+## 0.6.0
+
+### Additions
+* Allow keys to be read from file e.g. `CREDENTIALS_KEY_FILE`
+
 ## 0.5.1
 
 ### Changes

data/README.md

@@ -94,6 +94,13 @@ Alternatively, you can omit the first part of the variable name. Such a key will
 export CREDENTIALS_KEY=68656973716a4e706e336733377245732b6e77584c6c772b5432446532456f674767664271374a623876383d
 ```
 
+You can also read keys from files which is the recommended way when using [secrets in Docker Compose](https://docs.docker.com/compose/how-tos/use-secrets/). Just append `_FILE` to the corresponding environment variable name and set it to the path from which the secret can be read, for example:
+
+```db
+export SANDBOX_CREDENTIALS_KEY_FILE=/run/secrets/sandbox_credentials_key
+export CREDENTIALS_KEY_FILE=/run/secrets/credentials_key
+```
+
 With this in place, you can use the decrypted credentials anywhere in your app:
 
 ```ruby

data/lib/dry/credentials/helpers.rb

@@ -72,10 +72,15 @@ module Dry
       private
 
       def key
-        if create?
+        case
+        when create?
           ENV[key_ev] = encryptor.generate_key
+        when key = ENV[key_ev] || ENV['CREDENTIALS_KEY']
+          key
+        when file = ENV["#{key_ev}_FILE"] || ENV['CREDENTIALS_KEY_FILE']
+          File.read(file)
         else
-          (ENV[key_ev] || ENV['CREDENTIALS_KEY']) or fail Dry::Credentials::KeyNotSetError
+          fail Dry::Credentials::KeyNotSetError
         end
       end
 

data/lib/dry/credentials/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module Credentials
-    VERSION = "0.5.1"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-credentials
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Sven Schwyn
@@ -93,20 +93,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest-focus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement