Bump js-yaml from 3.14.0 to 4.0.0 (#186)

* Bump js-yaml from 3.14.0 to 4.0.0

Bumps [js-yaml](https://github.com/nodeca/js-yaml) from 3.14.0 to 4.0.0.
- [Release notes](https://github.com/nodeca/js-yaml/releases)
- [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md)
- [Commits](https://github.com/nodeca/js-yaml/compare/3.14.0...4.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* Updating js-yaml to 4.0

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
Co-authored-by: David Diaz <seich@martianwabbit.com>

.gitattributes

@@ -1 +1,2 @@
 * text=auto
+*.js text eol=lf

.github/workflows/main.yml

@@ -0,0 +1,37 @@
+name: Tests
+on:
+    push:
+        branches: [master]
+
+    pull_request:
+        branches: [master]
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-node@v2-beta
+            - name: Install dependencies
+              run: |
+                  npm install
+                  wget https://codeclimate.com/downloads/test-reporter/test-reporter-0.6.3-linux-amd64 -O cc-test-reporter
+                  chmod +x ./cc-test-reporter
+
+            - name: Validate Schema
+              run: |
+                npx ajv-cli compile -s schema.json
+                npx ajv-cli validate -s schema.json -d examples/beau.yml
+            - name: Run CLI Tests
+              run: npm test -- ./bin
+            - name: Run Lib Tests
+              run: npm run test:coverage
+            - name: Report Results
+              if: success()
+              run: |
+                  ./cc-test-reporter format-coverage
+                  ./cc-test-reporter upload-coverage
+              env:
+                GIT_COMMIT_SHA: ${{ github.event.pull_request.head.sha }}
+                GIT_BRANCH: ${{ github.head_ref }}
+                CC_TEST_REPORTER_ID: ${{ secrets.CODECLIMATE_REPO_TOKEN }}

.gitignore

@@ -1 +1,3 @@
 node_modules/
+coverage/
+*.swp

.prettierrc

@@ -0,0 +1,10 @@
+printWidth: 80
+tabWidth: 4
+singleQuote: true
+useTabs: false
+trailingComma: none
+bracketSpacing: true
+jsxBracketSameLine: true
+semi: false
+requirePragma: false
+proseWrap: always

LICENSE

@@ -1,7 +1,41 @@
-Copyright 2017 David Sergio Díaz
+“Commons Clause” License Condition v1.0
 
-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 Software is provided to you by the Licensor under the License, as defined
+below, subject to the following condition.
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+Without limiting other conditions in the License, the grant of rights under the
+License will not include, and the License does not grant to you, the right to
+Sell 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.
+For purposes of the foregoing, “Sell” means practicing any or all of the rights
+granted to you under the License to provide to third parties, for a fee or other
+consideration (including without limitation fees for hosting or consulting/
+support services related to the Software), a product or service whose value
+derives, entirely or substantially, from the functionality of the Software. Any
+license notice or attribution required by the License must also include this
+Commons Clause License Condition notice.
+
+Software: Beau
+License: MIT
+Licensor: David Díaz
+
+---
+
+Copyright 2020 David Díaz
+
+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.

README.md

@@ -1,64 +1,87 @@
 <div align="center">
-	<img src="http://files.martianwabbit.com/beau.png?1" height="144"/>
+    <img src="media/beau.png" height="144" alt="Beau's Logo is a Seahorse" />
 </div>
 
 <h1 align="center">Beau</h1>
 <p align="center">Testing JSON APIs made easy.</p>
+<p align="center">
+    <a href="https://codeclimate.com/github/Seich/Beau/maintainability"><img src="https://api.codeclimate.com/v1/badges/bc2de4d71893d6a2d18b/maintainability" /></a>
+    <a href="https://codeclimate.com/github/Seich/Beau/test_coverage"><img src="https://api.codeclimate.com/v1/badges/bc2de4d71893d6a2d18b/test_coverage" /></a>
+    <img src="https://github.com/Seich/Beau/workflows/Tests/badge.svg"/>
+</p>
 
 ## What is Beau?
-Beau, is a CLI that executes HTTP requests based on a YAML configuration file. This makes testing easy, it allows you to share test requests with others as part of your repo.
 
-![A Gif showing how beau works](http://files.martianwabbit.com/beau.gif)
+Beau is a modern http client. It uses a YAML file as configuration allowing you
+to test APIs without having to write lengthy commands.
+
+<div align="center">
+    <img src="media/usage.gif" alt="A gif showing how beau works." />
+</div>
 
 ## Installation
-	npm install -g beau
+
+    npm install -g beau
 
 ## Usage
-	 beau [options] -r <Request Alias>
 
-  Options:
+    $ beau [COMMAND]
 
-    -h, --help               output usage information
-    -V, --version            output the version number
-    -r, --request [request]  The alias for the request you'd like to trigger.
-    -v, --verbose            Show all the information related to the current request and it's response.
-    -c, --config [file]      Specify your request config file. Defaults to beau.yml in the current directory.
-    -l, --list               List all requests in the config file.
-    -t, --truncate [length]  Truncate the content to the given length
+    COMMANDS
+      help      display help for beau
+      list      Lists all available requests in the config file.
+      request   Executes a request by name.
+      validate  Validates the given configuration file against Beau's configuration schema.
 
 ## Example Configuration File
 
-	version: 1
-	host: https://example.com/api/
+```yaml
+endpoint: https://httpbin.org/
 
-	POST /session:
-		ALIAS: session
-		PAYLOAD:
-			username: seich
-			password: hello01
+POST /anything:
+    alias: anything
+    payload:
+        hello: world
+```
 
-	GET /profile
-		ALIAS: profile
-		HEADERS:
-			authorization: Bearer $session.response.body.token
+```
+$ beau request anything
 
-	GET /user/$profile.response.body.id/posts
-		ALIAS: friends
-		HEADERS:
-			authorization: Bearer $session.response.body.token
-		PARAMS:
-			archived: true
+Status              Endpoint
+200                 https://httpbin.org/anything
 
-## Example Usage
-	beau -r profile
+{
+...
+  json: {
+    hello: "world"
+  },
+  method: "POST",
+  url: "https://httpbin.org/anything"
+  ...
+}
+```
 
-That would execute the profile request along with it´s dependencies. In this case, the session request would be made as well since we are using it´s response value as part of our current request.
+## Documentation
+
+Visit https://beaujs.com/docs/ for the complete docs.
 
 ## License
-Copyright 2017 David Sergio Díaz
 
-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:
+Copyright 2018 David Sergio Díaz
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+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 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.
+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.

__tests__/beau.spec.js

@@ -1,24 +0,0 @@
-const fs = require('fs');
-const Beau = require('../beau');
-const yaml = require('js-yaml');
-
-describe(`Beau's config Loader.`, () => {
-	it ('Should only load valid configuration keys', () => {
-		let host = 'http://martianwabbit.com';
-		let version = 1;
-		let cache = false;
-		let shouldntBeAdded = true;
-
-		let beau = new Beau({
-			version,
-			host,
-			cache,
-			shouldntBeAdded
-		});
-
-		expect(beau.config.HOST).toBe(host);
-		expect(beau.config.CACHE).toBe(cache);
-		expect(beau.config.VERSION).toBe(version);
-		expect(beau.config.shouldntBeAdded).toBeUndefined();
-	});
-});

__tests__/request.spec.js

@@ -1,47 +0,0 @@
-const Request = require('../request');
-const RequestCache = require('../requestCache');
-const RequestList = require('../requestList');
-
-describe('Request', () => {
-	let req;
-	let cache;
-	let request;
-
-	beforeEach(() => {
-		req = {
-			request: 'POST /user',
-			host: 'http://martianwabbit.com',
-			alias: 'profile',
-			params: {
-				userId: '$profile.UserId'
-			},
-			headers: {
-				authentication: 'BEARER $session.token'
-			},
-			payload: {
-				username: 'seich'
-			}
-		};
-
-		cache = new RequestCache();
-		cache.add('$session', { token: 'abc123' });
-		cache.add('$profile', { UserId: 14 });
-
-		request = new Request(req);
-
-	});
-
-	test('It should load up the given request', () => {
-		expect(request.VERB).toBe('POST');
-		expect(request.ENDPOINT).toBe(req.host + '/user');
-		expect(request.HEADERS).toBeDefined();
-		expect(request.PAYLOAD).toBeDefined();
-		expect(request.PARAMS).toBeDefined();
-	});
-
-	test('It should list all of its dependencies', () => {
-		expect(request.DEPENDENCIES.size).toBe(2);
-		expect(request.DEPENDENCIES).toContain('session');
-		expect(request.DEPENDENCIES).toContain('profile');
-	});
-});

__tests__/requestCache.spec.js

@@ -1,68 +0,0 @@
-const RequestCache = require('../requestCache');
-
-describe('Request Cache', () => {
-	let cache;
-
-	beforeEach(() => {
-		cache = new RequestCache();
-
-		cache.add('$session', {
-			hello: 'World'
-		});
-
-		cache.add('$array', [{
-			id: 1,
-			name: 'Sergio'
-		}, {
-			id: 2,
-			name: 'Angela'
-		}]);
-	});
-
-	it('should add keys to the cache', () => {
-		expect(cache.$cache.$session.hello).toBe('World');
-	});
-
-	describe('get', () => {
-		it('should be able to find key values with a given path', () => {
-			expect(cache.get('$session.hello')).toBe('World');
-		});
-
-		it('should throw when given an invalid path', () => {
-			expect(cache.get('$session.hello')).toThrow();
-		});
-	});
-
-	describe('parse', () => {
-		it('should transform variables in strings using it\'s cache', () => {
-			expect(cache.parse('Hello $session.hello')).toBe('Hello World');
-		});
-
-		it('should go transform variables in all values when given an object', () => {
-			let parsed = cache.parse({ hello: 'hello $session.hello', earth: '$session.hello' });
-			expect(parsed.hello).toBe('hello World');
-			expect(parsed.earth).toBe('World');
-		});
-
-		it('should return every non-string value as-is', () => {
-			let parsed = cache.parse({ number: 1, nulled: null, truthy: false, hello: '$session.hello' });
-			expect(parsed.number).toBe(1);
-			expect(parsed.nulled).toBeNull();
-			expect(parsed.truthy).toBe(false);
-			expect(parsed.hello).toBe('World');
-		});
-
-		it('should parse arrays as well', () => {
-			let parsed = cache.parse({ hello: '$array.0.name' })
-			expect(parsed.hello).toBe('Sergio');
-		});
-
-		it('should return an object when given an undefined value', () => {
-			expect(Object.keys(cache.parse(undefined)).length).toBe(0)
-		});
-
-		it('should parse any value other than undefined', () => {
-			expect(cache.parse('Hello $session.hello')).toBe('Hello World');
-		});
-	});
-});

__tests__/requestList.spec.js

@@ -1,27 +0,0 @@
-const RequestList = require('../requestList');
-
-describe('RequestList', () => {
-	let host = 'http://martianwabbit.com';
-	let doc = {
-		'POST /session': null,
-		'Not a Request': null,
-		'GET /post': 'get-posts',
-		'POST /user': {
-			alias: 'user',
-			payload: {
-				name: 'Sergio',
-				lastname: 'Diaz'
-			}
-		}
-	};
-
-
-	it('should load valid requests', () => {
-		let requests = new RequestList(doc, { HOST: host });
-		let request = requests.list[0];
-
-		expect(requests.list.length).toBe(3);
-		expect(request.VERB).toBe('POST');
-		expect(request.ENDPOINT).toBe(host + '/session');
-	});
-});

beau.js

@@ -1,30 +0,0 @@
-const RequestList = require('./requestList');
-
-class Beau {
-	constructor(doc) {
-		this.defaults = {
-			VERSION: 1,
-			CACHE: false,
-			HOST: '',
-			PLUGINS: []
-		};
-
-
-		this.configKeys = Object.keys(this.defaults);
-		this.config = this.loadConfig(doc, this.defaults);
-		this.requests = new RequestList(doc, this.config);
-	}
-
-	loadConfig(doc, defaults = {}) {
-		var result = defaults;
-
-		Object.keys(doc)
-			.filter(k => this.configKeys.indexOf(k.toUpperCase()) > -1)
-			.forEach(k => result[k.toUpperCase()] = doc[k]);
-
-		return result;
-	}
-}
-
-
-module.exports = Beau;

bin/beau

@@ -1,156 +1,5 @@
 #!/usr/bin/env node
-const program = require('commander');
-const process = require('process');
-const Beau = require('../beau');
-const yaml = require('js-yaml');
-const fs = require('fs');
-const { Line, Spinner } = require('clui');
-const clc = require('cli-color');
-const jsome = require('jsome');
 
-const package = require('../package.json');
-
-program
-	.version(package.version)
-	.usage(`[options] -r <Request Alias>`)
-	.option(
-		'-r, --request [request]',
-		`The alias for the request you'd like to trigger.`
-	)
-	.option(
-		'-R, --clean-request [request]',
-		`The alias for the request you'd like to trigger. This one doesn't format the output.`
-	)
-	.option(
-		'-v, --verbose',
-		`Show all the information related to the current request and it's response.`
-	)
-	.option(
-		'-c, --config [file]',
-		'Specify your request config file. Defaults to beau.yml in the current directory.',
-		'beau.yml'
-	)
-	.option('-l, --list', `List all requests in the config file.`)
-	.option('-L, --clean-list', `List all requests with no formatting.`)
-	.option(
-		'-t, --truncate [length]',
-		`Truncate the content to the given length`
-	)
-	.parse(process.argv);
-
-if (!fs.existsSync(program.config)) {
-	console.error(`The config file, ${program.config} was not found.`);
-	process.exit(1);
-}
-
-const config = yaml.safeLoad(fs.readFileSync(program.config, 'utf-8'));
-const beau = new Beau(config);
-
-if (
-	typeof program.list === 'undefined' &&
-	typeof program.request === 'undefined' &&
-	typeof program.cleanList === 'undefined' &&
-	typeof program.cleanRequest === 'undefined'
-) {
-	program.help();
-}
-
-if (program.cleanList) {
-	beau.requests.list.forEach(({ VERB, ALIAS, ENDPOINT, DOCUMENTATION }) => {
-		if (typeof DOCUMENTATION !== 'undefined') {
-			let { title, description } = DOCUMENTATION;
-			console.log(
-				`${VERB}\t${ALIAS}\t${ENDPOINT}\t${title}\t${description}`
-			);
-		} else {
-			console.log(`${VERB}\t${ALIAS}\t${ENDPOINT}`);
-		}
-	});
-}
-
-if (program.list) {
-	new Line()
-		.padding(2)
-		.column('HTTP Verb', 20, [clc.cyan])
-		.column('Alias', 30, [clc.cyan])
-		.column('Endpoint', 20, [clc.cyan])
-		.output();
-
-	beau.requests.list.forEach(({ VERB, ALIAS, ENDPOINT }) =>
-		new Line()
-			.padding(2)
-			.column(VERB, 20, [clc.yellow])
-			.column(ALIAS, 30, [clc.yellow])
-			.column(ENDPOINT)
-			.output()
-	);
-
-	new Line().output();
-}
-
-if (program.cleanRequest) {
-	beau.requests
-		.execByAlias(program.cleanRequest)
-		.then(res => {
-			let { status, headers, body } = res.response;
-			let { endpoint } = res.request;
-
-			console.log(status);
-			console.log(endpoint);
-			console.log(JSON.stringify(headers));
-			console.log(JSON.stringify(body));
-		})
-		.catch(err => {
-			new Line().output();
-			console.error(err);
-			process.exit(1);
-		});
-}
-
-if (program.request) {
-	const spinner = new Spinner(clc.yellow(`Requesting: ${program.request}`));
-
-	spinner.start();
-
-	beau.requests
-		.execByAlias(program.request)
-		.then(res => {
-			spinner.stop();
-
-			let { status, body } = res.response;
-			let { endpoint } = res.request;
-
-			status = status.toString().startsWith(2)
-				? clc.green(status)
-				: clc.red(status);
-
-			new Line()
-				.padding(2)
-				.column('Status', 20, [clc.cyan])
-				.column('Endpoint', 20, [clc.cyan])
-				.output();
-
-			new Line()
-				.padding(2)
-				.column(status, 20)
-				.column(endpoint)
-				.output();
-
-			new Line().output();
-
-			let maxLength = +(program.truncate || res.length);
-
-			if (program.verbose) {
-				jsome(res);
-			} else {
-				jsome(body);
-			}
-
-			process.exit(0);
-		})
-		.catch(err => {
-			new Line().output();
-			console.error(err);
-			process.exit(1);
-		});
-}
+require('@oclif/command')
+    .run()
+    .catch(require('@oclif/errors/handle'));

bin/cli/__mocks__/base.js

@@ -0,0 +1,30 @@
+const Beau = require('../../../src/beau')
+
+const original = jest.requireActual('../base')
+
+const config = {
+    environment: {
+        params: {
+            name: 'David'
+        }
+    },
+    endpoint: 'https://example.org',
+    version: 1,
+    'GET /anything': {
+        alias: 'alias',
+        payload: {
+            name: '$env.params.name'
+        }
+    },
+    'GET /status/418': {
+        alias: 'teapot'
+    }
+}
+
+class Base extends original {
+    loadConfig(configFile, params = []) {
+        return new Beau(config, {})
+    }
+}
+
+module.exports = Base

bin/cli/__mocks__/fs.js

@@ -0,0 +1,14 @@
+const fs = jest.genMockFromModule('fs')
+
+fs.existsSync = (filename) => filename === 'beau.yml'
+fs.readFileSync = () => `
+version: 1
+endpoint: https://example.org/
+
+GET /anything:
+  alias: anything
+  payload:
+    name: $env.params.name
+`
+
+module.exports = fs

bin/cli/__tests__/__snapshots__/list.spec.js.snap

@@ -0,0 +1,23 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`List Command with flags: 1`] = `
+Array [
+  "  HTTP Verb           Alias                         Endpoint            
+",
+  "  GET                 alias                         https://example.org/anything
+",
+  "  GET                 teapot                        https://example.org/status/418
+",
+  "
+",
+]
+`;
+
+exports[`List Command with flags: 2`] = `
+Array [
+  "GET	alias	https://example.org/anything
+",
+  "GET	teapot	https://example.org/status/418
+",
+]
+`;

bin/cli/__tests__/__snapshots__/request.spec.js.snap

@@ -0,0 +1,71 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Request Command with flags: alias %s %s 1`] = `
+Array [
+  "",
+  "  Status              Endpoint            
+",
+  "  200                 https://example.org/anything
+",
+  "
+",
+  "{\\"hello\\": \\"world\\"}
+",
+]
+`;
+
+exports[`Request Command with flags: alias --as-json %s 1`] = `
+Array [
+  "{\\"status\\":200,\\"headers\\":[],\\"body\\":\\"{\\\\\\"hello\\\\\\": \\\\\\"world\\\\\\"}\\"}
+",
+]
+`;
+
+exports[`Request Command with flags: alias --as-json --verbose 1`] = `
+Array [
+  "{\\"request\\":{\\"body\\":{\\"name\\":\\"David\\"},\\"endpoint\\":\\"https://example.org/anything\\"},\\"response\\":{\\"status\\":200,\\"headers\\":[],\\"body\\":\\"{\\\\\\"hello\\\\\\": \\\\\\"world\\\\\\"}\\"},\\"body\\":\\"{\\\\\\"hello\\\\\\": \\\\\\"world\\\\\\"}\\"}
+",
+]
+`;
+
+exports[`Request Command with flags: alias --no-format %s 1`] = `
+Array [
+  "200
+",
+  "https://example.org/anything
+",
+  "[]
+",
+  "\\"{\\\\\\"hello\\\\\\": \\\\\\"world\\\\\\"}\\"
+",
+]
+`;
+
+exports[`Request Command with flags: alias --quiet %s 1`] = `Array []`;
+
+exports[`Request Command with flags: alias --verbose %s 1`] = `
+Array [
+  "",
+  "  Status              Endpoint            
+",
+  "  200                 https://example.org/anything
+",
+  "
+",
+  "{
+  \\"request\\": {
+    \\"body\\": {
+      \\"name\\": \\"David\\"
+    },
+    \\"endpoint\\": \\"https://example.org/anything\\"
+  },
+  \\"response\\": {
+    \\"status\\": 200,
+    \\"headers\\": [],
+    \\"body\\": \\"{\\\\\\"hello\\\\\\": \\\\\\"world\\\\\\"}\\"
+  },
+  \\"body\\": \\"{\\\\\\"hello\\\\\\": \\\\\\"world\\\\\\"}\\"
+}
+",
+]
+`;

bin/cli/__tests__/list.spec.js

@@ -0,0 +1,23 @@
+const ListCommand = require('../commands/list')
+
+jest.mock('../../../src/shared')
+
+jest.mock('../base')
+
+describe('List Command', () => {
+    let result
+
+    beforeEach(() => {
+        result = []
+        jest.spyOn(process.stdout, 'write').mockImplementation((val) =>
+            result.push(require('strip-ansi')(val.toString('utf8')))
+        )
+    })
+
+    afterEach(() => jest.restoreAllMocks())
+
+    test.each([[], ['--no-format']])('with flags:', async (...args) => {
+        await ListCommand.run(args)
+        expect(result).toMatchSnapshot()
+    })
+})

bin/cli/__tests__/request.spec.js

@@ -0,0 +1,37 @@
+const RequestCommand = require('../commands/request')
+const requestPromiseNativeMock = require('request-promise-native')
+
+jest.mock('../../../src/shared')
+
+jest.mock('../base')
+
+describe('Request Command', () => {
+    let result
+
+    beforeEach(() => {
+        requestPromiseNativeMock.fail = false
+        result = []
+        jest.spyOn(process.stdout, 'write').mockImplementation((val) =>
+            result.push(require('strip-ansi')(val.toString('utf8')))
+        )
+    })
+
+    afterEach(() => jest.restoreAllMocks())
+
+    test.each([
+        ['alias'],
+        ['alias', '--verbose'],
+        ['alias', '--as-json'],
+        ['alias', '--as-json', '--verbose'],
+        ['alias', '--no-format'],
+        ['alias', '--quiet']
+    ])('with flags: %s %s %s', async (...args) => {
+        await RequestCommand.run(args)
+        expect(result).toMatchSnapshot()
+    })
+
+    it('should throw an error when the request fails', async () => {
+        requestPromiseNativeMock.fail = true
+        await expect(RequestCommand.run(['anything'])).rejects.toThrow(Error)
+    })
+})

bin/cli/base.js

@@ -0,0 +1,77 @@
+const { Command, flags } = require('@oclif/command')
+const yaml = require('js-yaml')
+const fs = require('fs')
+const path = require('path')
+const dotenv = require('dotenv')
+const Beau = require('../../src/beau')
+const Ajv = require('ajv').default
+const betterAjvErrors = require('better-ajv-errors')
+
+const schema = require('../../schema.json')
+const ajv = new Ajv()
+const validate = ajv.compile(schema)
+
+class Base extends Command {
+    openConfigFile(configFile) {
+        if (!fs.existsSync(configFile)) {
+            throw new Error(`The config file, ${configFile} was not found.`)
+        }
+
+        let config
+        yaml.loadAll(fs.readFileSync(configFile, 'utf-8'), (doc) => {
+            const valid = validate(doc)
+
+            if (!valid) {
+                this.log(`The configuration file is not valid.`)
+                this.error(
+                    betterAjvErrors(schema, doc, validate.errors, { indent: 2 })
+                )
+            }
+
+            if (typeof config === 'undefined') {
+                config = doc
+            } else {
+                if (typeof config.hosts === 'undefined') {
+                    config.hosts = []
+                }
+
+                config.hosts.push(doc)
+            }
+        })
+
+        return config
+    }
+
+    loadConfig(configFile, params = []) {
+        const config = this.openConfigFile(configFile)
+        const env = dotenv.config().parsed || {}
+        params = dotenv.parse(params.join('\n'))
+
+        const envParams = { _: Object.assign(env, params) }
+
+        const configFileDir = path.dirname(
+            path.resolve(process.cwd(), configFile)
+        )
+
+        process.chdir(configFileDir)
+
+        return new Beau(config, envParams)
+    }
+}
+
+Base.flags = {
+    config: flags.string({
+        char: 'c',
+        description: 'The configuration file to be used.',
+        default: 'beau.yml'
+    }),
+    verbose: flags.boolean({
+        char: 'V',
+        description: `Show all additional information available for a command.`
+    }),
+    'no-format': flags.boolean({
+        description: `Disables color formatting for usage on external tools.`
+    })
+}
+
+module.exports = Base

bin/cli/commands/list.js

@@ -0,0 +1,46 @@
+const clc = require('cli-color')
+const { Line } = require('clui')
+const { expandPath } = require('../../../src/shared')
+const Base = require('../base')
+
+class ListCommand extends Base {
+    async run() {
+        const { flags } = this.parse(ListCommand)
+        const Beau = this.loadConfig(flags.config)
+
+        if (flags['no-format']) {
+            return Beau.requests.list.forEach(
+                ({ VERB, ALIAS, ENDPOINT, PATH }) =>
+                    this.log(
+                        `${VERB}\t${ALIAS}\t${ENDPOINT.replace(
+                            /\/$/,
+                            ''
+                        )}/${PATH.replace(/^\//, '')}`
+                    )
+            )
+        }
+
+        new Line()
+            .padding(2)
+            .column('HTTP Verb', 20, [clc.cyan])
+            .column('Alias', 30, [clc.cyan])
+            .column('Endpoint', 20, [clc.cyan])
+            .output()
+
+        Beau.requests.list.forEach(({ VERB, ALIAS, ENDPOINT, PATH }) =>
+            new Line()
+                .padding(2)
+                .column(VERB, 20, [clc.yellow])
+                .column(ALIAS, 30, [clc.yellow])
+                .column(expandPath(ENDPOINT, PATH))
+                .output()
+        )
+
+        new Line().output()
+    }
+}
+
+ListCommand.description = `Lists all available requests in the config file.`
+ListCommand.flags = { ...Base.flags }
+
+module.exports = ListCommand

bin/cli/commands/request.js

@@ -0,0 +1,158 @@
+const Base = require('../base')
+const cj = require('color-json')
+const clc = require('cli-color')
+const prompts = require('prompts')
+const { Line, Spinner } = require('clui')
+const { flags } = require('@oclif/command')
+const { expandPath } = require('../../../src/shared')
+
+class RequestCommand extends Base {
+    prettyOutput(res, verbose = false) {
+        let { status, body } = res.response
+
+        this.spinner.stop()
+
+        status = status.toString().startsWith(2)
+            ? clc.green(status)
+            : clc.red(status)
+
+        new Line()
+            .padding(2)
+            .column('Status', 20, [clc.cyan])
+            .column('Endpoint', 20, [clc.cyan])
+            .output()
+
+        new Line()
+            .padding(2)
+            .column(status, 20)
+            .column(res.request.endpoint)
+            .output()
+
+        new Line().output()
+
+        const result = (verbose ? res : body) || null
+        if (typeof result === 'object') {
+            this.log(cj(result))
+        } else if (typeof result === 'string') {
+            this.log(result)
+        }
+    }
+
+    async run() {
+        const {
+            flags: {
+                param: params,
+                config,
+                'no-format': noFormat = false,
+                verbose = false,
+                'as-json': asJson = false,
+                quiet = false,
+                interactive = false
+            },
+            args
+        } = this.parse(RequestCommand)
+
+        const Beau = this.loadConfig(config, params)
+
+        const spinnerSprite = ['⣾', '⣽', '⣻', '⢿', '⡿', '⣟', '⣯', '⣷']
+        this.spinner = new Spinner('', spinnerSprite)
+
+        let spinnerEnabled = !noFormat && !asJson && !quiet
+
+        if (typeof args.alias == 'undefined' && !interactive) {
+            this.error(
+                'Missing 1 required argument: The alias of the request to execute.'
+            )
+        }
+
+        if (interactive) {
+            const requests = Beau.requests.list.map(
+                ({ VERB, ALIAS, ENDPOINT, PATH }) => ({
+                    title: `${VERB} ${PATH} - ${ALIAS}`,
+                    value: ALIAS,
+                    description: expandPath(ENDPOINT, PATH)
+                })
+            )
+
+            const { name } = await prompts({
+                name: 'name',
+                message: 'Pick a Request to execute',
+                type: 'select',
+                choices: requests
+            })
+
+            args.alias = name
+        }
+
+        if (spinnerEnabled) {
+            this.spinner.start()
+        }
+
+        let res
+        try {
+            res = await Beau.requests.execByAlias(args.alias)
+        } catch (err) {
+            this.spinner.stop()
+
+            if (!quiet) {
+                this.error(err.message)
+            }
+
+            this.exit(1)
+        }
+
+        if (quiet) {
+            return
+        }
+
+        if (asJson) {
+            return this.log(JSON.stringify(verbose ? res : res.response))
+        }
+
+        if (noFormat) {
+            this.log(res.response.status)
+            this.log(res.request.endpoint)
+            this.log(JSON.stringify(res.response.headers))
+            this.log(JSON.stringify(res.response.body))
+            return
+        }
+
+        this.prettyOutput(res, verbose)
+    }
+}
+
+RequestCommand.description = `Executes a request by name.`
+RequestCommand.flags = {
+    ...Base.flags,
+    param: flags.string({
+        char: 'P',
+        multiple: true,
+        default: [],
+        description: `Allows you to inject values into the request's environment.`
+    }),
+
+    quiet: flags.boolean({
+        description: `Skips the output.`
+    }),
+
+    'as-json': flags.boolean({
+        char: 'j',
+        description: `Outputs the response as json.`
+    }),
+
+    interactive: flags.boolean({
+        char: 'i',
+        description: 'Choose request interactively.',
+        default: false
+    })
+}
+
+RequestCommand.args = [
+    {
+        name: 'alias',
+        required: false,
+        description: `The alias of the request to execute.`
+    }
+]
+
+module.exports = RequestCommand

examples/beau.yml

@@ -0,0 +1,37 @@
+endpoint: https://pokeapi.co/api/v2/
+
+# Try replacing this pokemon using params:
+# beau request get-pokemon -P "pokemon=dragapult"
+environment:
+    _:
+        pokemon: ditto
+
+cookiejar: true
+
+GET /pokemon/$env._.pokemon: get-pokemon
+GET $get-pokemon.body.location_area_encounters: get-encounters
+
+POST https://httpbin.org/anything:
+    - alias: post-first-area
+      payload:
+          area: $get-encounters.body.0.location_area.name
+
+    - alias: post-pokemon-type
+      payload:
+          type: $get-pokemon.body.types.0.type.name
+
+    - alias: form-submission
+      form:
+          name: Dragapult
+
+    - alias: file-upload
+      formdata:
+          name: Beau
+          logo: $[createReadStream('../media/beau.png')]
+
+GET https://httpbin.org/status/418: teapot
+
+GET https://httpbin.org/cookies/set:
+    alias: set-cookies
+    params:
+        hello: World

examples/github.yml

@@ -1,15 +0,0 @@
-VERSION: 1
-HOST: https://api.github.com
-
-auth: &auth
-  HEADERS:
-    Authorization: token asfdasf123423sd1fgnh7d83n478
-    User-Agent: Beau
-
-GET /user:
-  ALIAS: $user
-  <<: *auth
-
-GET /user/repos:
-  ALIAS: $repos
-  <<: *auth

examples/jsonplaceholder.yml

@@ -1,22 +0,0 @@
-version: 1
-host: 'http://jsonplaceholder.typicode.com'
-
-GET /posts/1: get-post
-
-GET /posts/:
-  alias: posts
-  documentation:
-    title: Fetch Posts
-    description: Fetches all posts available.
-
-POST /posts/:
-  alias: new-post
-  documentation:
-    title: New Post
-
-GET /users/$posts.body.0.userId:
-  alias: post-user
-  documentation:
-    description: Fetches the user for a give post.
-  params:
-    hello: 'world'

examples/plugins.yml

@@ -1,11 +0,0 @@
-host: http://localhost:10080
-
-plugins:
-  - beau-jwt:
-      data:
-        userId: 12
-        name: Sergio
-      secret: 'asdfasdf+asdfasdf/asdfasdfasdfasdf=='
-
-GET /test:
-  alias: test

examples/slack.yml

@@ -1,37 +0,0 @@
-VERSION: '1'
-HOST: https://slack.com/api
-
-auth: &auth
-    token: xoxp-139455775026-139455775090-147751461120-f224ed6ffee029869a0f138d0859e7d6
-
-GET /users.getPresence:
-  ALIAS: presence
-  PARAMS:
-    <<: *auth
-
-GET /channels.list:
-  ALIAS: channel-list
-  PARAMS:
-    <<: *auth
-    exclude_archived: true
-
-GET /channels.info:
-  ALIAS: channel-info
-  PARAMS:
-    <<: *auth
-    channel: $channel-list.response.body.channels.0.id
-
-POST /chat.postMessage:
-  ALIAS: new-message
-  PARAMS:
-    <<: *auth
-    channel: $channel-info.response.body.channel.id
-    text: 'Hey Seich!'
-    parse: full
-    link_names: true
-    username: Beau
-
-GET /users.list:
-  ALIAS: user-list
-  PARAMS:
-    <<: *auth

package.json

@@ -1,33 +1,67 @@
 {
-  "name": "beau",
-  "version": "0.4.0",
-  "description": "A tool for testing JSON APIs",
-  "main": "beau.js",
-  "author": "Sergio Diaz <seich@martianwabbit.com>",
-  "license": "MIT",
-  "scripts": {
-    "test": "jest",
-    "watch": "jest --watch"
-  },
-  "dependencies": {
-    "cli-color": "^1.1.0",
-    "clui": "^0.3.1",
-    "commander": "^2.9.0",
-    "js-yaml": "^3.7.0",
-    "jsome": "^2.3.26",
-    "request": "^2.83.0",
-    "request-promise-native": "^1.0.5",
-    "requireg": "^0.1.6"
-  },
-  "repository": "git@github.com:Seich/Beau.git",
-  "devDependencies": {
-    "jest": "^17.0.3"
-  },
-  "jest": {
-    "testEnvironment": "node",
-    "notify": true
-  },
-  "bin": {
-    "beau": "./bin/beau"
-  }
+    "name": "beau",
+    "version": "0.11.3",
+    "description": "Testing APIs made easy.",
+    "main": "./src/beau.js",
+    "author": "David Díaz <seich@martianwabbit.com>",
+    "license": "MIT + Commons Clause",
+    "scripts": {
+        "test": "jest -i",
+        "test:coverage": "jest --coverage ./src",
+        "release": "np"
+    },
+    "files": [
+        "/src",
+        "/bin"
+    ],
+    "dependencies": {
+        "@oclif/command": "1.8.0",
+        "@oclif/config": "1.17.0",
+        "@oclif/plugin-help": "3.2.1",
+        "@oclif/plugin-warn-if-update-available": "1.7.0",
+        "ajv": "7.0.3",
+        "beau-std": "0.9.4",
+        "better-ajv-errors": "0.7.0",
+        "cli-color": "2.0.0",
+        "clui": "0.3.6",
+        "color-json": "2.0.1",
+        "deepmerge": "4.2.2",
+        "dotenv": "8.2.0",
+        "globby": "11.0.2",
+        "is-plain-object": "5.0.0",
+        "js-yaml": "4.0.0",
+        "prompts": "2.4.0",
+        "request": "2.88.2",
+        "request-promise-native": "1.0.9",
+        "requireg": "0.2.2"
+    },
+    "repository": "git@github.com:Seich/Beau.git",
+    "devDependencies": {
+        "jest": "26.6.3",
+        "jest-watch-typeahead": "0.6.1",
+        "strip-ansi": "6.0.0",
+        "np": "7.2.0"
+    },
+    "oclif": {
+        "commands": "./bin/cli/commands",
+        "bin": "beau",
+        "plugins": [
+            "@oclif/plugin-help",
+            "@oclif/plugin-warn-if-update-available"
+        ]
+    },
+    "jest": {
+        "testEnvironment": "node",
+        "notify": true,
+        "watchPlugins": [
+            "jest-watch-typeahead/filename",
+            "jest-watch-typeahead/testname"
+        ]
+    },
+    "bin": {
+        "beau": "./bin/beau"
+    },
+    "engines": {
+        "node": ">=8.10.0"
+    }
 }

request.js

@@ -1,114 +0,0 @@
-const request = require('request-promise-native');
-const {httpVerbs, requestRegex, replacementRegex} = require('./shared');
-const RequestList = require('./requestList');
-const RequestCache = require('./requestCache');
-
-class Request {
-	constructor(req) {
-		let config = {};
-		this.originalRequest = req;
-
-		Object.keys(req).forEach(k => config[k.toUpperCase()] = req[k]);
-
-		let { REQUEST, ALIAS, PAYLOAD, HOST, PARAMS, HEADERS, DOCUMENTATION } = config;
-		let { verb, endpoint } = this.parseRequest(REQUEST);
-
-		this.VERB = verb;
-		this.ENDPOINT = HOST + endpoint;
-
-		this.HEADERS = HEADERS;
-		this.PAYLOAD = PAYLOAD;
-		this.PARAMS = PARAMS;
-
-		this.ALIAS = ALIAS;
-		this.DOCUMENTATION = DOCUMENTATION;
-
-		if (typeof this.ALIAS === 'undefined') {
-			console.info(`${REQUEST} is missing an alias.`);
-		}
-
-		this.DEPENDENCIES = this.findDependencies(req);
-	}
-
-	parseRequest(request) {
-		let parts = request.match(requestRegex);
-
-		return {
-			verb: parts[1],
-			endpoint: parts[2]
-		};
-	}
-
-	findDependencies(request, set = new Set()) {
-		if (typeof request === 'object') {
-			let keys = Object.keys(request).filter(key => key !== 'ALIAS');
-
-			keys.forEach(key => {
-				set = this.findDependencies(request[key], set);
-			});
-		} else if (typeof request === 'string') {
-			let matches = request.match(replacementRegex) || [];
-			let deps = matches.map(m => m.split('.')[0].substring(1));
-
-			return new Set([...set, ...deps]);
-		}
-
-		return set;
-	}
-
-	async exec(modifiers = [], requestList) {
-		let dependencies = Array.from(this.DEPENDENCIES);
-
-		let cache = await requestList.fetchDependencies(dependencies);
-
-		let settings = {
-			endpoint: cache.parse(this.ENDPOINT),
-			method: this.VERB,
-			headers: cache.parse(this.HEADERS),
-			query: cache.parse(this.PARAMS),
-			payload: cache.parse(this.PAYLOAD)
-		};
-
-		modifiers.forEach(mod => {
-			if (typeof mod.preRequest !== 'undefined') {
-				mod.preRequest(settings, this.originalRequest);
-			}
-		});
-
-		try {
-			let response = await request({
-				url: settings.endpoint,
-				method: settings.method,
-				headers: settings.headers,
-				qs: settings.query,
-				body: settings.payload,
-
-				json: true,
-				simple: false,
-				resolveWithFullResponse: true
-			});
-
-			let results = {
-				request: {
-					headers: response.request.headers,
-					body: response.request.body,
-					endpoint: response.request.uri.href
-				},
-				response: {
-					status: response.statusCode,
-					headers: response.headers,
-					body: response.body
-				},
-				body: response.body
-			};
-
-			cache.add(`$${this.ALIAS}`, results);
-
-			return results;
-		} catch({ error }) {
-			throw new Error(error);
-		}
-	}
-}
-
-module.exports = Request;

requestCache.js

@@ -1,51 +0,0 @@
-const { replacementRegex } = require('./shared');
-
-class RequestCache {
-	constructor() {
-		this.$cache = {};
-	}
-
-	add(key, value) {
-		this.$cache[key] = value;
-	}
-
-	get(path) {
-		let result = this.$cache;
-
-		path.split('.').forEach(part => {
-			if (result === undefined) return;
-			result = result[part];
-		});
-
-		if (typeof result === 'undefined') {
-			throw new Error(`${path} not found in cache: `, path);
-		}
-
-		return result;
-	}
-
-	parse(item) {
-		let type = typeof item;
-
-		if (type === 'undefined') {
-			return {};
-		}
-
-		if (item === null) {
-			return null;
-		}
-
-		if (type === 'string') {
-			return item.replace(replacementRegex, key => this.get(key));
-		}
-
-		if (type === 'object') {
-			Object.keys(item).forEach(k => item[k] = this.parse(item[k]));
-			return item;
-		}
-
-		return item;
-	}
-}
-
-module.exports = RequestCache;

requestList.js

@@ -1,89 +0,0 @@
-const Request = require('./request');
-const RequestCache = require('./requestCache');
-const httpVerbs = require('./shared').httpVerbs;
-const requireg = require('requireg');
-
-class RequestList {
-	constructor(doc = {}, config = {}) {
-		this.config = config;
-
-		this.modifiers = this.loadPlugins();
-		this.list = this.loadRequests(doc);
-		this.cache = new RequestCache();
-	}
-
-	async execByAlias(alias) {
-		let request = this.list.find(r => r.ALIAS === alias);
-
-		if (typeof request === 'undefined') {
-			return Promise.reject(`${alias} not found among the requests.`);
-		}
-
-		try {
-			let response = await request.exec(this.modifiers, this);
-
-			this.modifiers.forEach(mod => {
-				if (typeof mod.postResponse !== 'undefined') {
-					mod.postResponse(response);
-				}
-			});
-
-			return response;
-		} catch (reason) {
-			throw new Error(
-				`Request: ${request.VERB} ${request.ENDPOINT} FAILED. \n${reason}`
-			);
-		}
-	}
-
-	async fetchDependencies(dependencies) {
-		dependencies = dependencies.map(d => this.execByAlias(d));
-		await Promise.all(dependencies);
-
-		return this.cache;
-	}
-
-	loadRequests(doc) {
-		let requests = Object.keys(doc).filter(key => {
-			let verb = key.split(' ')[0].toUpperCase();
-			return httpVerbs.indexOf(verb) > -1;
-		});
-
-		return requests.map(request => {
-			let type = typeof doc[request];
-
-			if (type === 'string') {
-				doc[request] = {
-					ALIAS: doc[request]
-				};
-			}
-
-			doc[request] = doc[request] || {};
-
-			doc[request].HOST = this.config.HOST;
-			doc[request].request = request;
-
-			return new Request(doc[request]);
-		});
-	}
-
-	loadPlugins() {
-		if (typeof this.config.PLUGINS === 'undefined') {
-			return;
-		}
-
-		return this.config.PLUGINS.map(plugin => {
-			let name = plugin;
-			let settings = null;
-
-			if (typeof plugin === 'object') {
-				name = Object.keys(plugin)[0];
-				settings = plugin[name];
-			}
-
-			return new (requireg(name))(settings);
-		});
-	}
-}
-
-module.exports = RequestList;

schema.json

@@ -0,0 +1,122 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "$id": "https://beaujs.com/schema.json",
+    "title": "Beaujs Requests Schema",
+    "type": "object",
+    "definitions": {
+        "request": {
+            "oneOf": [
+                { "type": "string" },
+                {
+                    "type": "object",
+                    "$ref": "#/definitions/requestObject",
+                    "required": ["alias"]
+                }
+            ]
+        },
+        "requestObject": {
+            "type": "object",
+            "properties": {
+                "alias": {
+                    "type": "string",
+                    "description": "The name of this request."
+                },
+                "headers": {
+                    "type": "object",
+                    "additionalProperties": true,
+                    "description": "Headers that are part of this request."
+                },
+                "params": {
+                    "type": "object",
+                    "additionalProperties": true,
+                    "description": "Query String parameters to add to this request."
+                },
+                "payload": {
+                    "description": "This request's body. It is converted to json automatically if given an object. It's sent as a string otherwise.",
+                    "oneOf": [
+                        { "type": "string" },
+                        {
+                            "type": "object",
+                            "additionalProperties": true
+                        }
+                    ]
+                },
+                "form": {
+                    "type": "object",
+                    "additionalProperties": true,
+                    "description": "This request's body. Sets the content-type to application/x-www-form-urlencoded."
+                },
+                "formdata": {
+                    "type": "object",
+                    "additionalProperties": true,
+                    "description": "This request's body. Sets the content-type to multipart/form-data."
+                }
+            },
+            "allOf": [
+                { "not": { "required": ["payload", "form"] } },
+                { "not": { "required": ["payload", "formdata"] } },
+                { "not": { "required": ["formdata", "form"] } }
+            ]
+        }
+    },
+    "properties": {
+        "version": {
+            "type": "number",
+            "description": "The beau version this document was created for.",
+            "enum": [1]
+        },
+        "endpoint": {
+            "type": "string",
+            "description": "The root endpoint for this host."
+        },
+        "cookiejar": {
+            "type": "boolean",
+            "description": "Enable cookie support for requests?"
+        },
+        "host": {
+            "type": "string",
+            "description": "The name of the current host. It allows referencing requests between different hosts."
+        },
+        "defaults": {
+            "description": "Default values to be added to all requests.",
+            "$ref": "#/definitions/requestObject"
+        },
+        "plugins": {
+            "description": "Plugins to be enabled for this document.",
+            "type": "array",
+            "items": {
+                "anyOf": [
+                    { "type": "string" },
+                    { "type": "object", "additionalProperties": true }
+                ]
+            }
+        },
+        "environment": {
+            "type": "object",
+            "description": "Global document variables for easy access.",
+            "additionalProperties": true,
+            "properties": {
+                "_": {
+                    "type": "object",
+                    "description": "Environment variables brought in by cli params or dotenv.",
+                    "additionalProperties": true
+                }
+            }
+        }
+    },
+    "patternProperties": {
+        "(GET|HEAD|POST|PUT|DELETE|CONNECT|OPTIONS|TRACE|PATCH)\\s.*": {
+            "oneOf": [
+                {
+                    "$ref": "#/definitions/request"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/request"
+                    }
+                }
+            ]
+        }
+    }
+}

shared.js

@@ -1,20 +0,0 @@
-const httpVerbs = [
-	'GET',
-	'HEAD',
-	'POST',
-	'PUT',
-	'DELETE',
-	'CONNECT',
-	'OPTIONS',
-	'TRACE',
-	'PATCH'
-];
-
-const requestRegex = new RegExp(`(${httpVerbs.join('|')})\\s(.*)`, 'i');
-const replacementRegex = /\$([a-zA-Z\.\d\-\_]*)/g;
-
-module.exports = {
-	httpVerbs,
-	requestRegex,
-	replacementRegex
-};

src/__mocks__/beau-dynamic-values.js

@@ -0,0 +1,11 @@
+class DynamicValues {
+    constructor(registry, settings = {}) {
+        registry.defineDynamicValue('add', this.add)
+    }
+
+    add(x, y) {
+        return x + y
+    }
+}
+
+module.exports = DynamicValues

src/__mocks__/beau-modifiers.js

@@ -0,0 +1,20 @@
+class Modifiers {
+    constructor(registry, settings = {}) {
+        registry.addPreRequestModifier(this.preRequest)
+        registry.addPostRequestModifier(this.postRequest)
+    }
+
+    preRequest(request, orig) {
+        request.headers = request.headers || {}
+        request.headers.preRequestModifier = true
+        return request
+    }
+
+    postRequest(response, orig) {
+        response.body = 'Hello World'
+        response.response.body = 'Hello World'
+        return response
+    }
+}
+
+module.exports = Modifiers

src/__mocks__/beau-std.js

@@ -0,0 +1,7 @@
+class BeauStd {
+    constructor(registry, settings) {
+        registry.defineDynamicValue('createReadStream', () => {})
+    }
+}
+
+module.exports = BeauStd

src/__mocks__/request-promise-native.js

@@ -0,0 +1,22 @@
+function Request(request) {
+    if (Request.fail) {
+        throw new Error()
+    }
+
+    return {
+        request: {
+            headers: request.headers,
+            body: request.body,
+            uri: {
+                href: `${request.baseUrl}${request.uri}`
+            }
+        },
+        statusCode: 200,
+        headers: [],
+        body: '{"hello": "world"}'
+    }
+}
+
+Request.fail = false
+
+module.exports = Request

src/__mocks__/requireg.js

@@ -0,0 +1,15 @@
+function requireg(name) {
+    return require(name)
+}
+
+requireg.resolving = true
+
+requireg.resolve = function (name) {
+    if (requireg.resolving) {
+        return ''
+    } else {
+        return undefined
+    }
+}
+
+module.exports = requireg

src/__mocks__/shared.js

@@ -0,0 +1,4 @@
+module.exports = {
+    ...jest.requireActual('../shared'),
+    moduleVersion: jest.fn().mockReturnValue(1)
+}

src/__tests__/__snapshots__/beau.spec.js.snap

@@ -0,0 +1,117 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Beau's config Loader. should load the config 1`] = `
+Beau {
+  "config": Config {
+    "COOKIEJAR": false,
+    "DEFAULTS": Object {
+      "headers": Object {
+        "authentication": "hello",
+      },
+    },
+    "ENDPOINT": "http://example.com",
+    "ENVIRONMENT": Object {},
+    "HOSTS": Array [],
+    "PLUGINS": Plugins {
+      "autoload": Array [
+        "std",
+      ],
+      "context": Object {},
+      "registry": Object {
+        "dynamicValues": Array [],
+        "postRequestModifiers": Array [],
+        "preRequestModifiers": Array [],
+      },
+    },
+    "REQUESTS": Array [],
+    "VERSION": 1,
+    "configKeys": Array [
+      "VERSION",
+      "ENDPOINT",
+      "PLUGINS",
+      "DEFAULTS",
+      "ENVIRONMENT",
+      "HOSTS",
+      "COOKIEJAR",
+    ],
+  },
+  "requests": RequestList {
+    "cache": RequestCache {
+      "$cache": Object {
+        "env": Object {},
+      },
+    },
+    "list": Array [],
+  },
+}
+`;
+
+exports[`Beau's config Loader. should load the request list using the configuration 1`] = `
+RequestList {
+  "cache": RequestCache {
+    "$cache": Object {
+      "env": Object {},
+    },
+  },
+  "list": Array [
+    Request {
+      "ALIAS": "get-post",
+      "COOKIEJAR": false,
+      "DEPENDENCIES": Set {},
+      "ENDPOINT": "http://example.com",
+      "PATH": "/posts/1",
+      "REQUEST": "GET /posts/1",
+      "VERB": "GET",
+      "originalRequest": Object {
+        "ALIAS": "get-post",
+        "COOKIEJAR": false,
+        "ENDPOINT": "http://example.com",
+        "REQUEST": "GET /posts/1",
+      },
+      "plugins": Plugins {
+        "autoload": Array [
+          "std",
+        ],
+        "context": Object {},
+        "registry": Object {
+          "dynamicValues": Array [],
+          "postRequestModifiers": Array [],
+          "preRequestModifiers": Array [],
+        },
+      },
+    },
+    Request {
+      "ALIAS": "user",
+      "COOKIEJAR": false,
+      "DEPENDENCIES": Set {},
+      "ENDPOINT": "http://example.com",
+      "HEADERS": Object {
+        "hello": "world",
+      },
+      "PATH": "/user",
+      "REQUEST": "GET /user",
+      "VERB": "GET",
+      "originalRequest": Object {
+        "ALIAS": "user",
+        "COOKIEJAR": false,
+        "ENDPOINT": "http://example.com",
+        "HEADERS": Object {
+          "hello": "world",
+        },
+        "REQUEST": "GET /user",
+      },
+      "plugins": Plugins {
+        "autoload": Array [
+          "std",
+        ],
+        "context": Object {},
+        "registry": Object {
+          "dynamicValues": Array [],
+          "postRequestModifiers": Array [],
+          "preRequestModifiers": Array [],
+        },
+      },
+    },
+  ],
+}
+`;

src/__tests__/__snapshots__/config.spec.js.snap

@@ -0,0 +1,182 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Config should load multiple hosts 1`] = `
+Config {
+  "COOKIEJAR": false,
+  "DEFAULTS": Object {
+    "HEADERS": Object {
+      "hello": "mars",
+    },
+  },
+  "ENDPOINT": "http://example.org",
+  "ENVIRONMENT": Object {},
+  "HOSTS": Array [
+    Object {
+      "GET /e2": "e2",
+      "GET /posts": "posts",
+      "defaults": Object {
+        "HEADERS": Object {
+          "hello": "world",
+          "world": "hello",
+        },
+      },
+      "endpoint": "http://example.com",
+      "host": "com",
+    },
+    Object {
+      "GET /e3": "e3",
+      "GET /posts": "posts",
+      "defaults": Object {
+        "HEADERS": Object {
+          "hello": "world",
+          "world": "bye",
+        },
+      },
+      "endpoint": "http://example.net",
+      "host": "net",
+    },
+    Object {
+      "GET /posts": "posts",
+      "endpoint": "http://example.info",
+      "host": "info",
+    },
+  ],
+  "PLUGINS": Plugins {
+    "autoload": Array [
+      "std",
+    ],
+    "context": Object {},
+    "registry": Object {
+      "dynamicValues": Array [],
+      "postRequestModifiers": Array [],
+      "preRequestModifiers": Array [],
+    },
+  },
+  "REQUESTS": Array [
+    Object {
+      "ALIAS": "e1",
+      "COOKIEJAR": false,
+      "ENDPOINT": "http://example.org",
+      "HEADERS": Object {
+        "hello": "mars",
+      },
+      "REQUEST": "GET /e1",
+    },
+    Object {
+      "ALIAS": "com:e2",
+      "COOKIEJAR": false,
+      "ENDPOINT": "http://example.com",
+      "HEADERS": Object {
+        "hello": "world",
+        "world": "hello",
+      },
+      "REQUEST": "GET /e2",
+    },
+    Object {
+      "ALIAS": "com:posts",
+      "COOKIEJAR": false,
+      "ENDPOINT": "http://example.com",
+      "HEADERS": Object {
+        "hello": "world",
+        "world": "hello",
+      },
+      "REQUEST": "GET /posts",
+    },
+    Object {
+      "ALIAS": "net:e3",
+      "COOKIEJAR": false,
+      "ENDPOINT": "http://example.net",
+      "HEADERS": Object {
+        "hello": "world",
+        "world": "bye",
+      },
+      "REQUEST": "GET /e3",
+    },
+    Object {
+      "ALIAS": "net:posts",
+      "COOKIEJAR": false,
+      "ENDPOINT": "http://example.net",
+      "HEADERS": Object {
+        "hello": "world",
+        "world": "bye",
+      },
+      "REQUEST": "GET /posts",
+    },
+    Object {
+      "ALIAS": "info:posts",
+      "COOKIEJAR": false,
+      "ENDPOINT": "http://example.info",
+      "HEADERS": Object {
+        "hello": "mars",
+      },
+      "REQUEST": "GET /posts",
+    },
+  ],
+  "VERSION": 1,
+  "configKeys": Array [
+    "VERSION",
+    "ENDPOINT",
+    "PLUGINS",
+    "DEFAULTS",
+    "ENVIRONMENT",
+    "HOSTS",
+    "COOKIEJAR",
+  ],
+}
+`;
+
+exports[`Config should set up defaults for all requests 1`] = `
+Config {
+  "COOKIEJAR": false,
+  "DEFAULTS": Object {
+    "HEADERS": Object {
+      "authentication": "hello",
+    },
+  },
+  "ENDPOINT": "http://example.com",
+  "ENVIRONMENT": Object {},
+  "HOSTS": Array [],
+  "PLUGINS": Plugins {
+    "autoload": Array [
+      "std",
+    ],
+    "context": Object {},
+    "registry": Object {
+      "dynamicValues": Array [],
+      "postRequestModifiers": Array [],
+      "preRequestModifiers": Array [],
+    },
+  },
+  "REQUESTS": Array [
+    Object {
+      "ALIAS": "get-post",
+      "COOKIEJAR": false,
+      "ENDPOINT": "http://example.com",
+      "HEADERS": Object {
+        "authentication": "hello",
+      },
+      "REQUEST": "GET /posts/1",
+    },
+    Object {
+      "ALIAS": "user",
+      "COOKIEJAR": false,
+      "ENDPOINT": "http://example.com",
+      "HEADERS": Object {
+        "authentication": "hello",
+        "hello": "world",
+      },
+      "REQUEST": "GET /user",
+    },
+  ],
+  "VERSION": 1,
+  "configKeys": Array [
+    "VERSION",
+    "ENDPOINT",
+    "PLUGINS",
+    "DEFAULTS",
+    "ENVIRONMENT",
+    "HOSTS",
+    "COOKIEJAR",
+  ],
+}
+`;

src/__tests__/__snapshots__/plugins.spec.js.snap

@@ -0,0 +1,31 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Beau's plugin system Request Modifiers should modify the request and response using modifiers. 1`] = `
+Object {
+  "body": "Hello World",
+  "request": Object {
+    "body": undefined,
+    "endpoint": "http://example.com/user",
+    "headers": Object {
+      "preRequestModifier": true,
+    },
+  },
+  "response": Object {
+    "body": "Hello World",
+    "headers": Array [],
+    "status": 200,
+  },
+}
+`;
+
+exports[`Beau's plugin system shouldn't do anything when given an empty array. 1`] = `
+Plugins {
+  "autoload": Array [],
+  "context": Object {},
+  "registry": Object {
+    "dynamicValues": Array [],
+    "postRequestModifiers": Array [],
+    "preRequestModifiers": Array [],
+  },
+}
+`;

src/__tests__/__snapshots__/request.spec.js.snap

@@ -0,0 +1,37 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Request should execute a request 1`] = `
+Object {
+  "body": "{\\"hello\\": \\"world\\"}",
+  "request": Object {
+    "body": Object {
+      "username": "seich",
+    },
+    "endpoint": "http://example.com/user",
+    "headers": Object {
+      "authentication": "BEARER abc123",
+    },
+  },
+  "response": Object {
+    "body": "{\\"hello\\": \\"world\\"}",
+    "headers": Array [],
+    "status": 200,
+  },
+}
+`;
+
+exports[`Request should execute a request 2`] = `
+Object {
+  "body": "{\\"hello\\": \\"world\\"}",
+  "request": Object {
+    "body": undefined,
+    "endpoint": "http://example.com/user",
+    "headers": undefined,
+  },
+  "response": Object {
+    "body": "{\\"hello\\": \\"world\\"}",
+    "headers": Array [],
+    "status": 200,
+  },
+}
+`;

src/__tests__/__snapshots__/requestList.spec.js.snap

@@ -0,0 +1,43 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`RequestList should execute requests by alias. 1`] = `
+Object {
+  "body": "{\\"hello\\": \\"world\\"}",
+  "request": Object {
+    "body": Object {
+      "lastname": "Diaz",
+      "name": "Sergio",
+    },
+    "endpoint": "http://martianwabbit.com/user",
+    "headers": undefined,
+  },
+  "response": Object {
+    "body": "{\\"hello\\": \\"world\\"}",
+    "headers": Array [],
+    "status": 200,
+  },
+}
+`;
+
+exports[`RequestList should fetch dependencies 1`] = `
+RequestCache {
+  "$cache": Object {
+    "env": Object {
+      "environmental": true,
+    },
+    "get-posts": Object {
+      "body": "{\\"hello\\": \\"world\\"}",
+      "request": Object {
+        "body": undefined,
+        "endpoint": "http://martianwabbit.com/post",
+        "headers": undefined,
+      },
+      "response": Object {
+        "body": "{\\"hello\\": \\"world\\"}",
+        "headers": Array [],
+        "status": 200,
+      },
+    },
+  },
+}
+`;

src/__tests__/beau.spec.js

@@ -0,0 +1,59 @@
+const yaml = require('js-yaml')
+const Beau = require('../beau')
+const { moduleVersion } = require('../shared')
+
+jest.mock('../shared')
+
+const requireg = require('requireg')
+requireg.resolving = false
+
+describe(`Beau's config Loader.`, () => {
+    it('should load the config', () => {
+        moduleVersion.mockReturnValue(1)
+
+        const doc = yaml.load(`
+            version: 1
+            endpoint: 'http://example.com'
+
+            defaults:
+                headers:
+                    authentication: hello
+        `)
+
+        const beau = new Beau(doc)
+        expect(beau).toMatchSnapshot()
+    })
+
+    it(`should load the request list using the configuration`, () => {
+        moduleVersion.mockReturnValue(1)
+
+        const doc = yaml.load(`
+            version: 1
+            endpoint: 'http://example.com'
+
+            GET /posts/1: get-post
+            GET /user:
+                alias: user
+                headers:
+                    hello: world
+        `)
+
+        const beau = new Beau(doc)
+        expect(beau.requests).toMatchSnapshot()
+    })
+
+    it('should display a warning if the module version and the beau file version are different', () => {
+        let stdout
+        let spy = jest
+            .spyOn(console, 'warn')
+            .mockImplementation((val) => (stdout = val))
+
+        moduleVersion.mockReturnValue(2)
+
+        const beau = new Beau({ version: 1 })
+        expect(stdout).toEqual('This Beau file expects v1. You are using v2.')
+
+        spy.mockReset()
+        spy.mockRestore()
+    })
+})

src/__tests__/config.spec.js

@@ -0,0 +1,176 @@
+const yaml = require('js-yaml')
+const Config = require('../config')
+
+const requireg = require('requireg')
+requireg.resolving = false
+
+describe('Config', () => {
+    it('should load valid config keys', () => {
+        const doc = yaml.load(`
+            version: 1
+            endpoint: http://martianwabbit.com
+            shouldntBeAdded: true
+        `)
+
+        const config = new Config(doc)
+        expect(config.ENDPOINT).toBe(doc.endpoint)
+        expect(config.VERSION).toBe(doc.version)
+        expect(config.shouldntBeAdded).toBeUndefined()
+    })
+
+    it('should load requests', () => {
+        const doc = yaml.load(`
+            endpoint: http://example.com
+
+            GET /profile: get-profile
+            GET /posts: get-posts
+            GET /posts/1: get-post
+            GET /user:
+                alias: user
+                headers:
+                    hello: world
+        `)
+
+        const config = new Config(doc)
+        expect(Object.keys(config.REQUESTS).length).toBe(4)
+    })
+
+    it('should set up defaults for all requests', () => {
+        const doc = yaml.load(`
+            version: 1
+            endpoint: 'http://example.com'
+
+            defaults:
+                HEADERS:
+                    authentication: hello
+
+            GET /posts/1: get-post
+            GET /user:
+                alias: user
+                headers:
+                    hello: world
+        `)
+
+        const config = new Config(doc)
+
+        expect(config).toMatchSnapshot()
+        Object.values(config.REQUESTS).forEach((r) => {
+            expect(r.HEADERS.authentication).toMatch('hello')
+        })
+    })
+
+    it('should load multiple hosts', () => {
+        const doc = yaml.load(`
+          version: 1
+          endpoint: http://example.org
+
+          defaults:
+            HEADERS:
+              hello: mars
+
+          GET /e1: e1
+
+          hosts:
+            - host: com
+              endpoint: http://example.com
+
+              defaults:
+                HEADERS:
+                  hello: world
+                  world: hello
+
+              GET /e2: e2
+              GET /posts: posts
+
+            - host: net
+              endpoint: http://example.net
+
+              defaults:
+                HEADERS:
+                  hello: world
+                  world: bye
+
+              GET /e3: e3
+              GET /posts: posts
+
+            - host: info
+              endpoint: http://example.info
+
+              GET /posts: posts
+        `)
+
+        let config = new Config(doc)
+
+        expect(config).toMatchSnapshot()
+    })
+
+    it('should namespace all aliases within an host', () => {
+        const doc = yaml.load(`
+            hosts:
+              - host: test1
+                endpoint: http://example.com
+                GET /posts: posts
+              - host: test2
+                endpoint: http://example.net
+                GET /posts: posts
+        `)
+
+        let config = new Config(doc)
+
+        expect(config.REQUESTS[0].ALIAS).toBe('test1:posts')
+        expect(config.REQUESTS[1].ALIAS).toBe('test2:posts')
+    })
+
+    it(`should throw if host doesn't have a host key`, () => {
+        const doc = yaml.load(`
+            hosts:
+              - endpoint: http://example.com
+                GET /posts: posts
+
+              - host: test2
+                endpoint: http://example.net
+                GET /posts: posts
+        `)
+
+        expect(() => new Config(doc)).toThrow()
+    })
+
+    it(`should merge host settings with global settings`, () => {
+        const doc = yaml.load(`
+            defaults:
+              headers:
+                hello: 1
+
+            hosts:
+              - host: test
+                endpoint: http://example.net
+                GET /posts: posts
+
+              - host: test2
+                endpoint: http://example.org
+                defaults:
+                  headers: false
+
+                GET /posts: posts
+        `)
+
+        let config = new Config(doc)
+        expect(config.REQUESTS[0].HEADERS.hello).toBe(1)
+    })
+
+    it(`should allow different settings for the same request`, () => {
+        const doc = yaml.load(`
+      host: https://example.com
+      GET /1:
+        - alias: req1
+          headers:
+            request: 1
+        - alias: req2
+          headers:
+            request: 2
+    `)
+
+        let config = new Config(doc)
+        expect(config.REQUESTS.length).toBe(2)
+    })
+})

src/__tests__/plugins.spec.js

@@ -0,0 +1,101 @@
+const Plugins = require('../plugins')
+const Request = require('../request')
+const RequestCache = require('../requestCache')
+const requireg = require('requireg')
+
+describe(`Beau's plugin system`, () => {
+    let request
+    let plugins
+
+    beforeEach(() => {
+        plugins = new Plugins([{ Modifiers: [Object] }, 'DynamicValues'], [])
+    })
+
+    it('should load all plugins', () => {
+        expect(plugins.registry.preRequestModifiers.length).toBe(1)
+        expect(plugins.registry.postRequestModifiers.length).toBe(1)
+        expect(plugins.registry.dynamicValues.length).toBe(1)
+    })
+
+    it(`should throw if given an invalid configuration`, () => {
+        expect(() => new Plugins([{ test1: true, test2: true }])).toThrow()
+    })
+
+    it(`shouldn't do anything when given an empty array.`, () => {
+        expect(new Plugins([], [])).toMatchSnapshot()
+    })
+
+    it(`should warn if the plugin is not available.`, () => {
+        const spy = jest.spyOn(console, 'warn').mockImplementation(() => {})
+        requireg.resolving = false
+
+        new Plugins(['not-a-Package'])
+        expect(spy).toHaveBeenCalled()
+
+        requireg.resolving = true
+        spy.mockReset()
+        spy.mockRestore()
+    })
+
+    describe(`Request Modifiers`, () => {
+        beforeEach(() => {
+            request = new Request(
+                {
+                    request: 'POST /user',
+                    endpoint: 'http://example.com',
+                    alias: 'update'
+                },
+                plugins
+            )
+        })
+
+        it(`should modify the request and response using modifiers.`, async () => {
+            await expect(request.exec()).resolves.toMatchSnapshot()
+        })
+    })
+
+    describe(`Dynamic Values`, () => {
+        beforeEach(() => {
+            request = new Request(
+                {
+                    request: 'PATCH /hello/$[add(1, 2)]',
+                    endpoint: 'http://example.com',
+                    alias: 'say-hello',
+                    headers: {
+                        count: '$[add(1, $value2)]',
+                        empty: ''
+                    },
+                    payload: 'counted $[add(1, $value2)] so far.'
+                },
+                plugins
+            )
+        })
+
+        let cache = new RequestCache()
+        cache.add('value2', '2')
+
+        it(`should look for dynamic values executing and replacing them`, async () => {
+            let req = await request.exec(cache)
+            expect(req).toHaveProperty('request.body', 'counted 3 so far.')
+        })
+
+        it(`should change the internal datatype if the only thing in the value is the dynamic value`, async () => {
+            let req = await request.exec(cache)
+            expect(req).toHaveProperty('request.headers.count', 3)
+        })
+
+        it(`should return empty values as empty`, async () => {
+            let req = await request.exec(cache)
+            expect(req).toHaveProperty('request.headers.empty', '')
+        })
+
+        it(`should throw when calling an undefined dynamic value`, async () => {
+            request = new Request({
+                request: 'POST /hello/$[notAvailable(1, 2)]',
+                alias: 'say-hello'
+            })
+
+            await expect(request.exec()).rejects.toThrow()
+        })
+    })
+})

src/__tests__/request.spec.js

@@ -0,0 +1,100 @@
+const Request = require('../request')
+const RequestCache = require('../requestCache')
+const requestPromiseNativeMock = require('request-promise-native')
+
+describe('Request', () => {
+    let cache
+    let validRequestConfig
+    let invalidRequestConfig
+    let request
+    let requestWithoutDependencies
+
+    beforeEach(() => {
+        validRequestConfig = {
+            request: 'POST /user',
+            endpoint: 'http://example.com',
+            alias: 'update',
+            params: {
+                userId: '$profile.UserId'
+            },
+            headers: {
+                authentication: 'BEARER $session.token'
+            },
+            payload: {
+                username: 'seich'
+            }
+        }
+
+        invalidRequestConfig = {
+            request: `POST /session`,
+            endpoint: 'http://example.com'
+        }
+
+        cache = new RequestCache()
+        cache.add('session', { token: 'abc123' })
+        cache.add('profile', { UserId: 14 })
+
+        request = new Request(validRequestConfig)
+        requestWithoutDependencies = new Request({
+            endpoint: 'http://example.com',
+            request: 'GET /user',
+            alias: 'show'
+        })
+
+        requestPromiseNativeMock.fail = false
+    })
+
+    it('should load up the given request', () => {
+        expect(request.VERB).toBe('POST')
+        expect(request.ENDPOINT).toBe(validRequestConfig.endpoint)
+        expect(request.HEADERS).toBeDefined()
+        expect(request.PAYLOAD).toBeDefined()
+        expect(request.PARAMS).toBeDefined()
+    })
+
+    it('should throw if a given request is invalid', () => {
+        expect(() => new Request(invalidRequestConfig)).toThrow()
+    })
+
+    it('should list all of its dependencies', () => {
+        expect(request.DEPENDENCIES.size).toBe(2)
+        expect(request.DEPENDENCIES).toContain('session')
+        expect(request.DEPENDENCIES).toContain('profile')
+    })
+
+    it('should execute a request', async () => {
+        await expect(request.exec(cache)).resolves.toMatchSnapshot()
+        await expect(
+            requestWithoutDependencies.exec()
+        ).resolves.toMatchSnapshot()
+    })
+
+    it('should throw if the request fails', async () => {
+        requestPromiseNativeMock.fail = true
+        await expect(requestWithoutDependencies.exec()).rejects.toThrow(Error)
+    })
+
+    it(`should use the full url if given one as part of the path instead of the global endpoint`, async () => {
+        const requestWithPath = new Request({
+            endpoint: 'http://example.com',
+            request: 'GET http://martianwabbit.com/user',
+            alias: 'get-user'
+        })
+
+        const requestWithoutPath = new Request({
+            endpoint: 'http://example.com',
+            request: 'GET /user',
+            alias: 'get-user'
+        })
+
+        await expect(requestWithPath.exec()).resolves.toHaveProperty(
+            'request.endpoint',
+            'http://martianwabbit.com/user'
+        )
+
+        await expect(requestWithoutPath.exec()).resolves.toHaveProperty(
+            'request.endpoint',
+            'http://example.com/user'
+        )
+    })
+})

src/__tests__/requestCache.spec.js

@@ -0,0 +1,89 @@
+const RequestCache = require('../requestCache')
+
+describe('Request Cache', () => {
+    let cache
+
+    beforeEach(() => {
+        cache = new RequestCache()
+
+        cache.add('session', {
+            hello: 'World'
+        })
+
+        cache.add('array', [
+            {
+                id: 1,
+                name: 'Sergio'
+            },
+            {
+                id: 2,
+                name: 'Angela'
+            }
+        ])
+    })
+
+    it('should add keys to the cache', () => {
+        expect(cache.$cache.session.hello).toBe('World')
+    })
+
+    describe('get', () => {
+        it('should be able to find key values with a given path', () => {
+            expect(cache.get('session.hello')).toBe('World')
+        })
+
+        it('should throw when given an invalid path', () => {
+            expect(() => cache.get('$session.world')).toThrow()
+        })
+    })
+
+    describe('parse', () => {
+        it("should transform variables in strings using it's cache", () => {
+            expect(cache.parse('Hello $session.hello')).toBe('Hello World')
+        })
+
+        it('should go transform variables in all values when given an object', () => {
+            let parsed = cache.parse({
+                hello: 'hello $session.hello',
+                earth: '$session.hello'
+            })
+            expect(parsed.hello).toBe('hello World')
+            expect(parsed.earth).toBe('World')
+        })
+
+        it('should return every non-string value as-is', () => {
+            let parsed = cache.parse({
+                number: 1,
+                nulled: null,
+                truthy: false,
+                hello: '$session.hello'
+            })
+            expect(parsed.number).toBe(1)
+            expect(parsed.nulled).toBeNull()
+            expect(parsed.truthy).toBe(false)
+            expect(parsed.hello).toBe('World')
+        })
+
+        it('should parse arrays as well', () => {
+            let parsed = cache.parse({ hello: '$array.0.name' })
+            expect(parsed.hello).toBe('Sergio')
+        })
+
+        it('should return an object when given an undefined value', () => {
+            expect(cache.parse(undefined)).toEqual({})
+        })
+
+        it('should parse any value other than undefined', () => {
+            expect(cache.parse('Hello $session.hello')).toBe('Hello World')
+        })
+
+        it('should return null when passed null', () => {
+            expect(cache.parse(null)).toBe(null)
+        })
+
+        it(`shouldn't replace escaped variables`, () => {
+            expect(cache.parse(`\\$session.hello is $session.hello`)).toBe(
+                `$session.hello is World`
+            )
+        })
+    })
+})

src/__tests__/requestList.spec.js

@@ -0,0 +1,78 @@
+const Config = require('../config')
+const RequestList = require('../requestList')
+const requestPromiseNativeMock = require('request-promise-native')
+
+describe('RequestList', () => {
+    const endpoint = 'http://martianwabbit.com'
+
+    let env = {
+        environmental: true
+    }
+
+    const doc = {
+        ENDPOINT: endpoint,
+        ENVIRONMENT: env,
+        'GET /post': { alias: 'get-posts' },
+        'POST /user': {
+            alias: 'user',
+            payload: {
+                name: 'Sergio',
+                lastname: 'Diaz'
+            }
+        }
+    }
+
+    let requests
+    beforeEach(() => {
+        requestPromiseNativeMock.fail = false
+
+        let config = new Config(doc)
+        requests = new RequestList(config)
+    })
+
+    it('should allow an empty request list', () => {
+        requests = new RequestList()
+        expect(requests.list.length).toBe(0)
+    })
+
+    it('should load valid requests', () => {
+        expect(requests.list.length).toBe(2)
+    })
+
+    it('should fetch dependencies', async () => {
+        await expect(
+            requests.fetchDependencies(['get-posts'])
+        ).resolves.toMatchSnapshot()
+    })
+
+    it('should execute requests by alias.', async () => {
+        await expect(requests.execByAlias('user')).resolves.toMatchSnapshot()
+    })
+
+    it('should fail if the request fails', async () => {
+        requestPromiseNativeMock.fail = true
+        await expect(requests.execByAlias('user')).rejects.toThrow()
+    })
+
+    it('should return a cached result if available', async () => {
+        const obj = { test: true }
+        requests.cache.add('test', obj)
+        await expect(requests.execByAlias('test')).resolves.toBe(obj)
+    })
+
+    it('should fail if the alias is not found', async () => {
+        await expect(requests.execByAlias('notAnAlias')).rejects.toThrow()
+    })
+
+    it(`should fail if a given request doesn't have an alias`, () => {
+        let config = new Config({
+            'GET /hello': {
+                headers: {
+                    hello: 1
+                }
+            }
+        })
+
+        expect(() => new RequestList(config, config)).toThrow()
+    })
+})

src/__tests__/shared.spec.js

@@ -0,0 +1,98 @@
+const {
+    requestRegex,
+    replacementRegex,
+    dynamicValueRegex,
+    UpperCaseKeys,
+    removeOptionalKeys,
+    toKebabCase,
+    replaceInObject,
+    expandPath
+} = require('../shared')
+
+describe('Shared Utilities', () => {
+    describe('requestRegex', () => {
+        test.each([
+            ['GET /hello', true],
+            ['HEAD /hello', true],
+            ['POST /hello', true],
+            ['PUT /hello', true],
+            ['DELETE /hello', true],
+            ['CONNECT /hello', true],
+            ['OPTIONS /hello', true],
+            ['TRACE /hello', true],
+            ['PATCH /hello', true]
+        ])('should match: %s', (example, expected) => {
+            expect(requestRegex.test(example)).toBe(expected)
+        })
+    })
+
+    describe('replacementRegex', () => {
+        test.each([
+            ['$a.b', ['$a.b']],
+            ['GET /hello/$a.name', ['$a.name']],
+            ['PUT /hi/$a.a/$a.b', ['$a.a', '$a.b']],
+            [`\\$value`, ['\\$value']]
+        ])('should match: %s', (example, expected) => {
+            expect(example.match(replacementRegex)).toEqual(expected)
+        })
+    })
+
+    describe('dynamicValueRegex', () => {
+        test.each([
+            ['$[test()]', ['$[test()]']],
+            ['$[test(1, 2, 3)]', ['$[test(1, 2, 3)]']],
+            [`$[test({ \n id: 1 \n })]`, ['$[test({ \n id: 1 \n })]']]
+        ])('should match: %s', (example, expected) => {
+            expect(example.match(dynamicValueRegex)).toEqual(expected)
+        })
+    })
+
+    describe('UpperCaseKeys', () => {
+        it('should uppercase all first-level keys in an object', () => {
+            let a = { test: 1, Test2: 2 }
+            expect(UpperCaseKeys(a)).toEqual({ TEST: 1, TEST2: 2 })
+        })
+    })
+
+    describe('removeOptionalKeys', () => {
+        it('should remove empty objects from an object', () => {
+            let a = { b: {}, c: 2, d: {} }
+            expect(removeOptionalKeys(a, ['b', 'd'])).toEqual({ c: 2 })
+        })
+    })
+
+    describe('toKebabCase', () => {
+        it('should convert camel case to kebab case', () => {
+            expect(toKebabCase('helloWorld')).toBe('hello-world')
+        })
+    })
+
+    describe('replaceInObject', () => {
+        it('should replace every value in an object with the output of a function', () => {
+            let a = { b: 'b', c: 'c' }
+            expect(replaceInObject(a, (obj) => 'a')).toEqual({ b: 'a', c: 'a' })
+        })
+    })
+
+    describe('expandPath', () => {
+        test.each([
+            ['https://alchem.ee', 'api/v1/hello'],
+            ['https://alchem.ee/', '/api/v1/hello'],
+            ['https://alchem.ee', '/api/v1/hello'],
+            ['https://alchem.ee/', 'api/v1/hello']
+        ])(
+            'should add a base url to the path is the path is not a url: %s, %s',
+            (url, path) => {
+                expect(expandPath(url, path)).toEqual(
+                    'https://alchem.ee/api/v1/hello'
+                )
+            }
+        )
+
+        it('should return the path if its a fully fledged url on its own', () => {
+            expect(
+                expandPath('https://alchem.ee', 'https://martianwabbit.com')
+            ).toEqual('https://martianwabbit.com')
+        })
+    })
+})

src/beau.js

@@ -0,0 +1,20 @@
+const RequestList = require('./requestList')
+const Config = require('./config')
+const { moduleVersion } = require('./shared')
+
+class Beau {
+    constructor(doc, env = {}) {
+        this.config = new Config(doc, env)
+        this.requests = new RequestList(this.config)
+
+        if (this.config.VERSION !== moduleVersion()) {
+            console.warn(
+                `This Beau file expects v${
+                    this.config.VERSION
+                }. You are using v${moduleVersion()}.`
+            )
+        }
+    }
+}
+
+module.exports = Beau

src/config.js

@@ -0,0 +1,100 @@
+const deepMerge = require('deepmerge')
+const { requestRegex, UpperCaseKeys, moduleVersion } = require('./shared')
+const Plugins = require('./plugins')
+
+class Config {
+    constructor(doc, env = {}) {
+        const defaultConfigValues = {
+            VERSION: moduleVersion(),
+            ENDPOINT: '',
+            PLUGINS: [],
+            DEFAULTS: {},
+            ENVIRONMENT: {},
+            HOSTS: [],
+            COOKIEJAR: false
+        }
+
+        this.configKeys = Object.keys(defaultConfigValues)
+
+        let config = this.loadConfig(doc)
+        Object.assign(this, defaultConfigValues, config)
+
+        this.ENVIRONMENT = deepMerge(this.ENVIRONMENT, env)
+
+        this.REQUESTS = []
+
+        this.loadRequests(doc, {
+            DEFAULTS: this.DEFAULTS,
+            ENDPOINT: this.ENDPOINT
+        })
+
+        this.loadHosts(this.HOSTS, config, defaultConfigValues)
+
+        this.PLUGINS = new Plugins(this.PLUGINS)
+    }
+
+    loadHosts(hosts, rootConfig, defaultConfigValues) {
+        hosts.forEach((host) => {
+            if (typeof host.host === 'undefined') {
+                throw new Error(`Host doesn't indicate it's host name.`)
+            }
+
+            let config = deepMerge(defaultConfigValues, this.loadConfig(host))
+
+            config.DEFAULTS = deepMerge(rootConfig.DEFAULTS, config.DEFAULTS)
+
+            this.loadRequests(host, {
+                DEFAULTS: config.DEFAULTS,
+                ENDPOINT: config.ENDPOINT,
+                NAMESPACE: host.host
+            })
+        })
+    }
+
+    loadRequests(host, settings) {
+        Object.entries(host)
+            .filter(([key]) => requestRegex.test(key))
+            .forEach(([key, rDefinition]) => {
+                if (Array.isArray(rDefinition)) {
+                    rDefinition.forEach((req) =>
+                        this.addRequest(key, req, settings)
+                    )
+                } else {
+                    this.addRequest(key, rDefinition, settings)
+                }
+            })
+    }
+
+    addRequest(key, rDefinition, settings) {
+        let requestDefinitionIsString = typeof rDefinition === 'string'
+        let originalRequest = requestDefinitionIsString
+            ? { ALIAS: rDefinition }
+            : rDefinition
+
+        let request = UpperCaseKeys(originalRequest)
+
+        if (settings.NAMESPACE) {
+            request.ALIAS = `${settings.NAMESPACE}:${request.ALIAS}`
+        }
+
+        request.REQUEST = key
+        request.COOKIEJAR = this.COOKIEJAR
+        request.ENDPOINT = settings.ENDPOINT
+
+        let defaults = UpperCaseKeys(settings.DEFAULTS)
+
+        this.REQUESTS.push(deepMerge(defaults, request))
+    }
+
+    loadConfig(host) {
+        let config = {}
+
+        Object.entries(host)
+            .filter(([key]) => this.configKeys.includes(key.toUpperCase()))
+            .forEach(([key, value]) => (config[key.toUpperCase()] = value))
+
+        return config
+    }
+}
+
+module.exports = Config

src/plugins.js

@@ -0,0 +1,119 @@
+const vm = require('vm')
+const requireg = require('requireg')
+const deepmerge = require('deepmerge')
+const { toKebabCase, dynamicValueRegex, replaceInObject } = require('./shared')
+const { isPlainObject } = require('is-plain-object')
+
+class Plugins {
+    constructor(plugins = [], autoload = ['std']) {
+        this.registry = {
+            preRequestModifiers: [],
+            postRequestModifiers: [],
+            dynamicValues: []
+        }
+
+        this.context = {}
+
+        this.autoload = autoload
+
+        this.loadPlugins(plugins.concat(this.autoload))
+    }
+
+    normalizePlugins(plugins) {
+        let results = {}
+
+        plugins.forEach((plugin) => {
+            let name = plugin
+            let settings = undefined
+
+            if (typeof plugin === 'object') {
+                let keys = Object.keys(plugin)
+
+                if (keys.length !== 1) {
+                    throw new Error(`Plugin items should contain only one key.`)
+                }
+
+                name = keys[0]
+                settings = plugin[name]
+            }
+
+            results[name] = settings
+        })
+
+        return results
+    }
+
+    loadPlugins(plugins) {
+        plugins = this.normalizePlugins(plugins)
+        Object.keys(plugins).forEach((name) => {
+            const module = `beau-${toKebabCase(name)}`
+
+            if (typeof requireg.resolve(module) !== 'undefined') {
+                const plugin = requireg(module)
+                new plugin(this, plugins[name])
+            } else {
+                if (this.autoload.includes(name)) return
+
+                console.warn(
+                    `Plugin ${name} couldn't be found. It is available globally?`
+                )
+            }
+        })
+    }
+
+    executeModifier(modifier, obj, orig) {
+        let result = deepmerge({}, obj, { isMergeableObject: isPlainObject })
+
+        this.registry[modifier].forEach(
+            (modifier) => (result = modifier(result, orig))
+        )
+
+        return result
+    }
+
+    replaceDynamicValues(obj) {
+        vm.createContext(this.context)
+        return replaceInObject(obj, (val) => {
+            let valIsEmpty = val.trim().length === 0
+
+            if (valIsEmpty) {
+                return val
+            }
+
+            try {
+                let onlyHasDynamic =
+                    val.replace(dynamicValueRegex, '').trim() === ''
+
+                if (onlyHasDynamic) {
+                    let call
+                    val.replace(dynamicValueRegex, (match, c) => {
+                        call = c
+                    })
+
+                    return vm.runInContext(call, this.context)
+                }
+
+                return val.replace(dynamicValueRegex, (match, call) => {
+                    return vm.runInContext(call, this.context)
+                })
+            } catch (e) {
+                throw new Error(`DynamicValue: ` + e)
+            }
+        })
+    }
+
+    addPreRequestModifier(modifier) {
+        this.registry.preRequestModifiers.push(modifier)
+    }
+
+    addPostRequestModifier(modifier) {
+        this.registry.postRequestModifiers.push(modifier)
+    }
+
+    defineDynamicValue(name, fn) {
+        this.registry.dynamicValues.push({ name, fn })
+        this.context[name] = fn
+    }
+}
+
+module.exports = Plugins

src/request.js

@@ -0,0 +1,131 @@
+const request = require('request-promise-native')
+const RequestCache = require('./requestCache')
+const Plugins = require('./plugins')
+
+const {
+    requestRegex,
+    replacementRegex,
+    UpperCaseKeys,
+    removeOptionalKeys,
+    isUrl
+} = require('./shared')
+
+class Request {
+    constructor(req, plugins = new Plugins()) {
+        this.originalRequest = req
+        this.plugins = plugins
+
+        req = UpperCaseKeys(req)
+        Object.assign(this, req)
+
+        if (!this.ALIAS) {
+            throw new Error(`${this.REQUEST} is missing an alias.`)
+        }
+
+        const { VERB, PATH } = this.parseRequest(this.REQUEST)
+
+        this.VERB = VERB
+        this.PATH = PATH
+
+        this.DEPENDENCIES = this.findDependencies(req)
+    }
+
+    parseRequest(request) {
+        const parts = request.match(requestRegex)
+
+        return {
+            VERB: parts[1],
+            PATH: parts[2]
+        }
+    }
+
+    findDependencies(request, set = new Set()) {
+        let type = typeof request
+
+        if (type === 'object' && request !== null) {
+            Object.entries(request)
+                .filter(([key]) => key !== 'ALIAS')
+                .forEach(([key, value]) => {
+                    set = this.findDependencies(value, set)
+                })
+        } else if (type === 'string') {
+            const matches = []
+            request.replace(
+                replacementRegex,
+                (match, g1) => !match.startsWith('\\') && matches.push(g1)
+            )
+
+            const deps = matches.map((m) => m.split('.')[0])
+
+            return new Set([...set, ...deps])
+        }
+
+        return set
+    }
+
+    async exec(cache = new RequestCache()) {
+        let settings = cache.parse({
+            baseUrl: '',
+            uri: this.PATH,
+            method: this.VERB,
+            jar: this.COOKIEJAR,
+
+            headers: this.HEADERS,
+            qs: this.PARAMS,
+            body: this.PAYLOAD,
+            form: this.FORM,
+            formData: this.FORMDATA,
+
+            json: true,
+            simple: false,
+            resolveWithFullResponse: true
+        })
+
+        const isPathFullUrl = isUrl(settings.uri)
+        settings.baseUrl = isPathFullUrl ? '' : this.ENDPOINT
+
+        settings = removeOptionalKeys(settings, [
+            'headers',
+            'qs',
+            'body',
+            'form',
+            'formData'
+        ])
+
+        settings = this.plugins.replaceDynamicValues(settings)
+
+        settings = this.plugins.executeModifier(
+            'preRequestModifiers',
+            settings,
+            this.originalRequest
+        )
+
+        const response = await request(settings)
+
+        let results = {
+            request: {
+                headers: response.request.headers,
+                body: response.request.body,
+                endpoint: response.request.uri.href
+            },
+            response: {
+                status: response.statusCode,
+                headers: response.headers,
+                body: response.body
+            },
+            body: response.body
+        }
+
+        results = this.plugins.executeModifier(
+            'postRequestModifiers',
+            results,
+            this.originalRequest
+        )
+
+        cache.add(this.ALIAS, results)
+
+        return results
+    }
+}
+
+module.exports = Request

src/requestCache.js

@@ -0,0 +1,46 @@
+const { replacementRegex, replaceInObject } = require('./shared')
+
+class RequestCache {
+    constructor() {
+        this.$cache = {}
+    }
+
+    exists(key) {
+        return typeof this.$cache[key] !== 'undefined'
+    }
+
+    add(key, value) {
+        this.$cache[key] = value
+    }
+
+    get(path) {
+        let result = this.$cache
+        path.split('.').forEach((part) => {
+            if (result[part] === undefined) {
+                throw new Error(`${path} not found in cache.`)
+            }
+
+            result = result[part]
+        })
+
+        return result
+    }
+
+    parse(item) {
+        if (item === null) {
+            return null
+        }
+
+        return replaceInObject(item, (item) =>
+            item.replace(replacementRegex, (match, key) => {
+                if (match.startsWith('\\')) {
+                    return match.replace('\\$', '$')
+                }
+
+                return this.get(key)
+            })
+        )
+    }
+}
+
+module.exports = RequestCache

src/requestList.js

@@ -0,0 +1,54 @@
+const Request = require('./request')
+const RequestCache = require('./requestCache')
+
+class RequestList {
+    constructor(config = { REQUESTS: [] }) {
+        this.list = this.loadRequests(config.REQUESTS, config.PLUGINS)
+        this.cache = new RequestCache()
+
+        this.cache.add(`env`, config.ENVIRONMENT)
+    }
+
+    async execByAlias(alias) {
+        if (this.cache.exists(alias)) {
+            return this.cache.get(alias)
+        }
+
+        const request = this.list.find((r) => r.ALIAS === alias)
+
+        if (typeof request === 'undefined') {
+            throw new Error(`${alias} not found among the requests.`)
+        }
+
+        try {
+            await this.fetchDependencies(Array.from(request.DEPENDENCIES))
+            return await request.exec(this.cache)
+        } catch (reason) {
+            throw new Error(
+                `Request ${request.VERB} ${request.ENDPOINT} FAILED. \n${reason}`
+            )
+        }
+    }
+
+    async fetchDependencies(dependencies) {
+        dependencies = dependencies.map((d) => this.execByAlias(d))
+        await Promise.all(dependencies)
+
+        return this.cache
+    }
+
+    loadRequests(REQUESTS, PLUGINS) {
+        let requests = []
+        REQUESTS.forEach((request) => {
+            try {
+                requests.push(new Request(request, PLUGINS))
+            } catch (e) {
+                throw new Error(`${request.request} was ignored: ${e}`)
+            }
+        })
+
+        return requests
+    }
+}
+
+module.exports = RequestList

src/shared.js

@@ -0,0 +1,99 @@
+const { URL } = require('url')
+
+const httpVerbs = [
+    'GET',
+    'HEAD',
+    'POST',
+    'PUT',
+    'DELETE',
+    'CONNECT',
+    'OPTIONS',
+    'TRACE',
+    'PATCH'
+]
+
+const requestRegex = new RegExp(`(${httpVerbs.join('|')})\\s(.*)`, 'i')
+const replacementRegex = /(?:\\?)\$([a-zA-Z\.\d\-\_\:]+)/g
+const dynamicValueRegex = /\$\[(\w+\((?:.|[\n\r])*?\))\]/g
+
+const UpperCaseKeys = function (obj) {
+    let result = {}
+    Object.entries(obj).forEach(([k, v]) => (result[k.toUpperCase()] = v))
+    return result
+}
+
+const isEmptyObject = (obj) =>
+    Object.keys(obj).length === 0 && obj.constructor === Object
+
+const removeOptionalKeys = function (obj, optionalValues) {
+    let result = {}
+
+    Object.entries(obj).forEach(([key, value]) => {
+        if (optionalValues.includes(key) && isEmptyObject(value)) {
+            return
+        }
+
+        result[key] = value
+    })
+
+    return result
+}
+
+const toKebabCase = function (str) {
+    return str
+        .trim()
+        .replace(/([a-z])([A-Z])/g, '$1-$2')
+        .toLowerCase()
+}
+
+const replaceInObject = function (obj, fn) {
+    if (obj === null) {
+        return null
+    }
+
+    switch (typeof obj) {
+        case 'undefined':
+            return {}
+        case 'string':
+            return fn(obj)
+        case 'object':
+            obj = Object.assign({}, obj)
+            Object.entries(obj).forEach(
+                ([key, value]) => (obj[key] = replaceInObject(value, fn))
+            )
+        default:
+            return obj
+    }
+}
+
+const moduleVersion = () => parseInt(require('../package.json').version, 10)
+
+const isUrl = function (str) {
+    try {
+        new URL(str)
+        return true
+    } catch (e) {
+        return false
+    }
+}
+
+const expandPath = (url, path) => {
+    if (isUrl(path)) {
+        return path
+    }
+
+    return url.replace(/\/+$/, '') + '/' + path.replace(/^\/+/, '')
+}
+
+module.exports = {
+    requestRegex,
+    replacementRegex,
+    dynamicValueRegex,
+    UpperCaseKeys,
+    removeOptionalKeys,
+    toKebabCase,
+    replaceInObject,
+    moduleVersion,
+    isUrl,
+    expandPath
+}