feat: getAWS creds

README.md

@@ -195,6 +195,27 @@ Why would one use `env.getUrl()` if one just wishes to grab the url string value
 
 As of now, `http`, `redis` and `postgresql` are the only supported protocols. Other protocols will return `null`. I'm not against adding new protocol support, but these are the ones that seemed most obvious to me. If you want other protocols supported, I'd recommend making a PR. You may create an issue, but I can't guarantee when I'll get around to implementation.
 
+Fetch AWS Credentials
+
+```javascript
+const {
+  awsKeyId,
+  awsSecretAccessKey,
+  awsDefaultRegion,
+} = env.getAWS();
+
+// Use defaults
+const {
+  awsKeyId,
+  awsSecretAccessKey,
+  awsDefaultRegion,
+} = env.getAWS({
+  keyId: 'keyId',
+  accessKey: 'accessKey',
+  region: 'region',
+});
+```
+
 ## Shortcut Methods
 
 ```javascript

package.json

@@ -1,6 +1,6 @@
 {
   "name": "good-env",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "description": "Better environment variable handling for Twelve-Factor node apps",
   "main": "src/index.js",
   "scripts": {

src/index.d.ts

@@ -1,4 +1,5 @@
 declare module "good-env" {
+  export const getAWS: (defaults?: object) => object;
   /**
    * @description Finds the URL string in the environment associated with the given key. If
    * it's found, the function tries to construct a URL object. If the URL is invalid, return null.

src/index.js

@@ -16,6 +16,21 @@ const validType = item => ['number', 'boolean', 'string'].includes(item);
 
 module.exports = Object
   .create({
+    getAWS ({
+      keyId,
+      accessKey,
+      region
+    } = {}) {
+      const awsKeyId = this.get('AWS_ACCESS_KEY_ID', keyId);
+      const awsSecretAccessKey = this.get('AWS_SECRET_ACCESS_KEY', accessKey);
+      const awsDefaultRegion = this.get('AWS_DEFAULT_REGION', region);
+
+      return {
+        awsKeyId,
+        awsSecretAccessKey,
+        awsDefaultRegion
+      };
+    },
     /**
      * @description Finds the URL string in the environment associated with the given key. If
      * it's found, the function tries to construct a URL object. If the URL is invalid, return null.

test/test.env

@@ -13,3 +13,6 @@ ENDPOINT=https://foo.com
 REDIS_URL=redis://user:password@ipaddress:6379/0
 POSTGRES_URL=postgresql://user:password@localhost/otherdb?connect_timeout=10&application_name=myapp
 UNSUPPORTED_URL=beep://baz.bop
+AWS_ACCESS_KEY_ID=exampleaccesskeyid
+AWS_SECRET_ACCESS_KEY=examplesecretaccesskey
+AWS_DEFAULT_REGION=us-east-1

test/test.js

@@ -5,6 +5,20 @@ require('dotenv').config({ path: 'test/test.env' });
 const test = require('tape');
 const env = require('../src/index');
 
+test('it gets AWS creds', (t) => {
+  const {
+    awsKeyId,
+    awsSecretAccessKey,
+    awsDefaultRegion
+  } = env.getAWS();
+
+  t.equals(awsKeyId, 'exampleaccesskeyid');
+  t.equals(awsSecretAccessKey, 'examplesecretaccesskey');
+  t.equals(awsDefaultRegion, 'us-east-1');
+
+  t.end();
+});
+
 test('it parses a valid url', (t) => {
   const { httpOk, href } = env.getUrl('ENDPOINT');
   t.equals(href, 'https://foo.com/');