Compare commits

..

No commits in common. "master" and "v0.6.0" have entirely different histories.

53 changed files with 9300 additions and 12248 deletions

1
.gitattributes vendored
View File

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

View File

@ -1,37 +0,0 @@
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 }}

1
.gitignore vendored
View File

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

View File

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

42
LICENSE
View File

@ -1,41 +1,7 @@
“Commons Clause” License Condition v1.0 Copyright 2017 David Sergio Díaz
The Software is provided to you by the Licensor under the License, as defined 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:
below, subject to the following condition.
Without limiting other conditions in the License, the grant of rights under the The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
License will not include, and the License does not grant to you, the right to
Sell the Software.
For purposes of the foregoing, “Sell” means practicing any or all of the rights 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.
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.

View File

@ -1,5 +1,5 @@
<div align="center"> <div align="center">
<img src="media/beau.png" height="144" alt="Beau's Logo is a Seahorse" /> <img src="http://files.martianwabbit.com/beau.png?1" height="144"/>
</div> </div>
<h1 align="center">Beau</h1> <h1 align="center">Beau</h1>
@ -7,81 +7,68 @@
<p align="center"> <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/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> <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"/> <a href="https://circleci.com/gh/Seich/Beau/tree/master"><img src="https://circleci.com/gh/Seich/Beau/tree/master.svg?style=svg" alt="CircleCI"></a>
</p> </p>
## What is Beau? ## What is Beau?
Beau is a modern http client. It uses a YAML file as configuration allowing you 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.
to test APIs without having to write lengthy commands.
<div align="center"> ![A Gif showing how beau works](http://files.martianwabbit.com/beau2.gif)
<img src="media/usage.gif" alt="A gif showing how beau works." />
</div>
## Installation ## Installation
npm install -g beau npm install -g beau
## Usage ## Usage
⚡ beau --help
$ beau [COMMAND] Usage: beau [options] [command]
COMMANDS
help display help for beau Options:
list Lists all available requests in the config file.
request Executes a request by name. -V, --version output the version number
validate Validates the given configuration file against Beau's configuration schema. -h, --help output usage information
Commands:
request [options] <alias>
list [options]
## Example Configuration File ## Example Configuration File
```yaml version: 1
endpoint: https://httpbin.org/ endpoint: https://example.com/api/
POST /anything: POST /session:
alias: anything ALIAS: session
payload: PAYLOAD:
hello: world username: seich
``` password: hello01
``` GET /profile
$ beau request anything ALIAS: profile
HEADERS:
authorization: Bearer $session.response.body.token
Status Endpoint GET /user/$profile.response.body.id/posts
200 https://httpbin.org/anything ALIAS: friends
HEADERS:
authorization: Bearer $session.response.body.token
PARAMS:
archived: true
{ ## Example Usage
... beau request profile
json: {
hello: "world"
},
method: "POST",
url: "https://httpbin.org/anything"
...
}
```
## Documentation 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.
Visit https://beaujs.com/docs/ for the complete docs.
## License ## License
Copyright 2017 David Sergio Díaz
Copyright 2018 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:
Permission is hereby granted, free of charge, to any person obtaining a copy of The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
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 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.
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.

177
bin/beau
View File

@ -1,5 +1,176 @@
#!/usr/bin/env node #!/usr/bin/env node
const program = require('commander');
const process = require('process');
const Beau = require('../src/beau');
const yaml = require('js-yaml');
const fs = require('fs');
const { Line, Spinner } = require('clui');
const clc = require('cli-color');
const jsome = require('jsome');
require('@oclif/command') const package = require('../package.json');
.run()
.catch(require('@oclif/errors/handle')); program.version(package.version);
program
.command('request <alias>')
.option(
'-c --config <config>',
'Specify your request config file. Defaults to beau.yml in the current directory.',
'beau.yml'
)
.option(
'-v --verbose',
'Show all the information available on the current request.',
false
)
.option('--no-format', 'Return the text without any special formatting.')
.action(async (alias, { config, format, verbose }) => {
const beau = loadConfig(config);
let spinner;
if (format) {
spinner = new Spinner(clc.yellow(`Requesting: ${alias}`));
spinner.start();
}
try {
let res = await beau.requests.execByAlias(alias);
let { status, headers, body } = res.response;
let { endpoint } = res.request;
if (format) {
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(endpoint)
.output();
new Line().output();
if (verbose) {
jsome(res);
} else {
jsome(body);
}
} else {
console.log(status);
console.log(endpoint);
console.log(JSON.stringify(headers));
console.log(JSON.stringify(body));
}
process.exit(0);
} catch (err) {
new Line().output();
console.error(err.message);
process.exit(1);
}
});
program
.command('list')
.option(
'-c --config <config>',
'Specify your request config file. Defaults to beau.yml in the current directory.',
'beau.yml'
)
.option('--no-format', 'Return the text without any special formatting.')
.action(({ config, format }) => {
const beau = loadConfig(config);
if (format) {
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();
} else {
beau.requests.list.forEach(({ VERB, ALIAS, ENDPOINT }) => {
console.log(`${VERB}\t${ALIAS}\t${ENDPOINT}`);
});
}
});
program
.command('init')
.option(
'-e --endpoint <endpoint>',
'Allows you to set the default endpoint',
null
)
.action(({ endpoint }) => {
const newFile = `# Beau.yml
version: 1${endpoint === null ? `
# endpoint: http://example.com
` : `
endpoint: ${endpoint}
`}
# defaults:
# params:
# userId: 25
# GET /profile: profile
# GET /posts:
# alias: posts
# params:
# order: ASC
# POST /profile:
# alias: save-profile
# headers:
# authentication: Bearer token
# payload:
# name: David
# lastname: Diaz
`;
if (!fs.existsSync('beau.yml')) {
fs.writeFileSync('beau.yml', newFile);
console.info('beau.yml created!');
} else {
console.error('beau.yml already exists.');
}
});
program.parse(process.argv);
if (!program.args.length) program.help();
function loadConfig(configFile) {
if (!fs.existsSync(configFile)) {
console.error(`The config file, ${configFile} was not found.`);
process.exit(1);
}
const config = yaml.safeLoad(fs.readFileSync(configFile, 'utf-8'));
return new Beau(config);
}

View File

@ -1,30 +0,0 @@
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

View File

@ -1,14 +0,0 @@
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

View File

@ -1,23 +0,0 @@
// 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
",
]
`;

View File

@ -1,71 +0,0 @@
// 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\\\\\\"}\\"
}
",
]
`;

View File

@ -1,23 +0,0 @@
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()
})
})

View File

@ -1,37 +0,0 @@
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)
})
})

View File

@ -1,77 +0,0 @@
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

View File

@ -1,46 +0,0 @@
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

View File

@ -1,158 +0,0 @@
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

12
circle.yml Normal file
View File

@ -0,0 +1,12 @@
machine:
node:
version: 8.9.3
dependencies:
post:
- npm install -g codeclimate-test-reporter
test:
pre:
- npm run test:coverage
- codeclimate-test-reporter < ./coverage/lcov.info

View File

@ -1,37 +0,0 @@
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

15
examples/github.yml Normal file
View File

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

View File

@ -0,0 +1,29 @@
version: 1
endpoint: 'http://jsonplaceholder.typicode.com'
environment:
the:
post: 1
defaults:
headers:
hello: $posts.body.0.userId
GET /posts/$env.the.post: get-post
GET /posts/:
alias: posts
headers:
hello: false
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'

11
examples/plugins.yml Normal file
View File

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

37
examples/slack.yml Normal file
View File

@ -0,0 +1,37 @@
VERSION: '1'
ENDPOINT: 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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 616 KiB

12782
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,67 +1,38 @@
{ {
"name": "beau", "name": "beau",
"version": "0.11.3", "version": "0.6.0",
"description": "Testing APIs made easy.", "description": "A tool for testing JSON APIs",
"main": "./src/beau.js", "main": "beau.js",
"author": "David Díaz <seich@martianwabbit.com>", "author": "Sergio Diaz <seich@martianwabbit.com>",
"license": "MIT + Commons Clause", "license": "MIT",
"scripts": { "scripts": {
"test": "jest -i", "test": "jest",
"test:coverage": "jest --coverage ./src", "watch": "jest --watch",
"release": "np" "test:coverage": "jest --coverage"
}, },
"files": [
"/src",
"/bin"
],
"dependencies": { "dependencies": {
"@oclif/command": "1.8.0", "cli-color": "^1.1.0",
"@oclif/config": "1.17.0", "clui": "^0.3.1",
"@oclif/plugin-help": "3.2.1", "commander": "^2.12.2",
"@oclif/plugin-warn-if-update-available": "1.7.0", "deepmerge": "^2.0.1",
"ajv": "7.0.3", "js-yaml": "^3.7.0",
"beau-std": "0.9.4", "jsome": "^2.3.26",
"better-ajv-errors": "0.7.0", "request": "^2.83.0",
"cli-color": "2.0.0", "request-promise-native": "^1.0.5",
"clui": "0.3.6", "requireg": "^0.1.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", "repository": "git@github.com:Seich/Beau.git",
"devDependencies": { "devDependencies": {
"jest": "26.6.3", "jest": "22.0.4"
"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": { "jest": {
"testEnvironment": "node", "testEnvironment": "node",
"notify": true, "notify": true
"watchPlugins": [
"jest-watch-typeahead/filename",
"jest-watch-typeahead/testname"
]
}, },
"bin": { "bin": {
"beau": "./bin/beau" "beau": "./bin/beau"
}, },
"engines": { "engines": {
"node": ">=8.10.0" "node": ">=8.9.3"
} }
} }

View File

@ -1,122 +0,0 @@
{
"$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"
}
}
]
}
}
}

View File

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

View File

@ -1,20 +0,0 @@
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

View File

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

View File

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

View File

@ -1,15 +1,19 @@
function requireg(name) { module.exports = function(name) {
return require(name) return function(settings) {
} let response = {
name: `${name}`,
preRequest(request) {
request.wasModified = true;
requireg.resolving = true return request;
},
requireg.resolve = function (name) { postResponse(response) {
if (requireg.resolving) { response.changed = true;
return '' return response;
} else {
return undefined
}
} }
};
module.exports = requireg return response;
};
};

View File

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

View File

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

View File

@ -1,182 +0,0 @@
// 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",
],
}
`;

View File

@ -1,31 +0,0 @@
// 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 [],
},
}
`;

View File

@ -1,13 +1,13 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`Request should execute a request 1`] = ` exports[`Request It should execute a request 1`] = `
Object { Object {
"body": "{\\"hello\\": \\"world\\"}", "body": "{\\"hello\\": \\"world\\"}",
"request": Object { "request": Object {
"body": Object { "body": Object {
"username": "seich", "username": "seich",
}, },
"endpoint": "http://example.com/user", "endpoint": "http://martianwabbit.com/user",
"headers": Object { "headers": Object {
"authentication": "BEARER abc123", "authentication": "BEARER abc123",
}, },
@ -20,13 +20,13 @@ Object {
} }
`; `;
exports[`Request should execute a request 2`] = ` exports[`Request It should execute a request 2`] = `
Object { Object {
"body": "{\\"hello\\": \\"world\\"}", "body": "{\\"hello\\": \\"world\\"}",
"request": Object { "request": Object {
"body": undefined, "body": Object {},
"endpoint": "http://example.com/user", "endpoint": "http://martianwabbit.com/user",
"headers": undefined, "headers": Object {},
}, },
"response": Object { "response": Object {
"body": "{\\"hello\\": \\"world\\"}", "body": "{\\"hello\\": \\"world\\"}",
@ -35,3 +35,22 @@ Object {
}, },
} }
`; `;
exports[`Request It should use modifiers 1`] = `
Array [
Array [
Object {
"endpoint": "http://martianwabbit.com/user",
"headers": Object {},
"method": "GET",
"payload": Object {},
"query": Object {},
},
Object {
"alias": "show",
"endpoint": "http://martianwabbit.com",
"request": "GET /user",
},
],
]
`;

View File

@ -3,13 +3,14 @@
exports[`RequestList should execute requests by alias. 1`] = ` exports[`RequestList should execute requests by alias. 1`] = `
Object { Object {
"body": "{\\"hello\\": \\"world\\"}", "body": "{\\"hello\\": \\"world\\"}",
"changed": true,
"request": Object { "request": Object {
"body": Object { "body": Object {
"lastname": "Diaz", "lastname": "Diaz",
"name": "Sergio", "name": "Sergio",
}, },
"endpoint": "http://martianwabbit.com/user", "endpoint": "http://martianwabbit.com/user",
"headers": undefined, "headers": Object {},
}, },
"response": Object { "response": Object {
"body": "{\\"hello\\": \\"world\\"}", "body": "{\\"hello\\": \\"world\\"}",
@ -18,26 +19,3 @@ Object {
}, },
} }
`; `;
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,
},
},
},
}
`;

View File

@ -1,59 +1,44 @@
const yaml = require('js-yaml') const yaml = require('js-yaml');
const Beau = require('../beau') const Beau = require('../beau');
const { moduleVersion } = require('../shared')
jest.mock('../shared')
const requireg = require('requireg')
requireg.resolving = false
describe(`Beau's config Loader.`, () => { describe(`Beau's config Loader.`, () => {
it('should load the config', () => { it('Should only load valid configuration keys', () => {
moduleVersion.mockReturnValue(1) const doc = yaml.safeLoad(`
const doc = yaml.load(`
version: 1 version: 1
endpoint: 'http://example.com' endpoint: http://martianwabbit.com
cache: false
shouldntBeAdded: true
`);
const beau = new Beau(doc);
expect(beau.config.ENDPOINT).toBe(doc.endpoint);
expect(beau.config.CACHE).toBe(doc.cache);
expect(beau.config.VERSION).toBe(doc.version);
expect(beau.config.shouldntBeAdded).toBeUndefined();
});
it('should set up defaults for all requests', () => {
const doc = yaml.safeLoad(`
version: 1
endpoint: 'http://jsonplaceholder.typicode.com'
defaults: defaults:
headers: headers:
authentication: hello 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 /posts/1: get-post
GET /user: GET /user:
alias: user alias: user
headers: headers:
hello: world hello: world
`) `);
const beau = new Beau(doc) 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', () => { expect(beau).toMatchSnapshot();
let stdout beau.requests.list.forEach(r => {
let spy = jest expect(r.HEADERS.authentication).toMatch('hello');
.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()
})
})

View File

@ -1,176 +0,0 @@
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)
})
})

View File

@ -1,101 +0,0 @@
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()
})
})
})

View File

@ -1,18 +1,18 @@
const Request = require('../request') const Request = require('../request');
const RequestCache = require('../requestCache') const RequestCache = require('../requestCache');
const requestPromiseNativeMock = require('request-promise-native') const RequestList = require('../requestList');
const requestPromiseNativeMock = require('request-promise-native');
describe('Request', () => { describe('Request', () => {
let cache let req;
let validRequestConfig let cache;
let invalidRequestConfig let request;
let request let requestWithoutDependencies;
let requestWithoutDependencies
beforeEach(() => { beforeEach(() => {
validRequestConfig = { req = {
request: 'POST /user', request: 'POST /user',
endpoint: 'http://example.com', endpoint: 'http://martianwabbit.com',
alias: 'update', alias: 'update',
params: { params: {
userId: '$profile.UserId' userId: '$profile.UserId'
@ -23,78 +23,62 @@ describe('Request', () => {
payload: { payload: {
username: 'seich' username: 'seich'
} }
} };
invalidRequestConfig = { cache = new RequestCache();
request: `POST /session`, cache.add('$session', { token: 'abc123' });
endpoint: 'http://example.com' cache.add('$profile', { UserId: 14 });
}
cache = new RequestCache() request = new Request(req);
cache.add('session', { token: 'abc123' })
cache.add('profile', { UserId: 14 })
request = new Request(validRequestConfig)
requestWithoutDependencies = new Request({ requestWithoutDependencies = new Request({
endpoint: 'http://example.com', endpoint: 'http://martianwabbit.com',
request: 'GET /user', request: 'GET /user',
alias: 'show' alias: 'show'
}) });
requestPromiseNativeMock.fail = false requestPromiseNativeMock.fail = false;
}) });
it('should load up the given request', () => { test('It should load up the given request', () => {
expect(request.VERB).toBe('POST') expect(request.VERB).toBe('POST');
expect(request.ENDPOINT).toBe(validRequestConfig.endpoint) expect(request.ENDPOINT).toBe(req.endpoint + '/user');
expect(request.HEADERS).toBeDefined() expect(request.HEADERS).toBeDefined();
expect(request.PAYLOAD).toBeDefined() expect(request.PAYLOAD).toBeDefined();
expect(request.PARAMS).toBeDefined() expect(request.PARAMS).toBeDefined();
}) });
it('should throw if a given request is invalid', () => { test('It should list all of its dependencies', () => {
expect(() => new Request(invalidRequestConfig)).toThrow() expect(request.DEPENDENCIES.size).toBe(2);
}) expect(request.DEPENDENCIES).toContain('session');
expect(request.DEPENDENCIES).toContain('profile');
});
it('should list all of its dependencies', () => { test('It should execute a request', async () => {
expect(request.DEPENDENCIES.size).toBe(2) await expect(request.exec([], cache)).resolves.toMatchSnapshot();
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( await expect(
requestWithoutDependencies.exec() requestWithoutDependencies.exec()
).resolves.toMatchSnapshot() ).resolves.toMatchSnapshot();
}) });
it('should throw if the request fails', async () => { test('It should throw if the request fails', async () => {
requestPromiseNativeMock.fail = true requestPromiseNativeMock.fail = true;
await expect(requestWithoutDependencies.exec()).rejects.toThrow(Error) 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 () => { test('It should use modifiers', async () => {
const requestWithPath = new Request({ const preRequest = jest.fn();
endpoint: 'http://example.com', const withPreRequest = [{ preRequest }];
request: 'GET http://martianwabbit.com/user',
alias: 'get-user'
})
const requestWithoutPath = new Request({ const notCalled = jest.fn();
endpoint: 'http://example.com', const nonModifiers = [{ notCalled }];
request: 'GET /user',
alias: 'get-user'
})
await expect(requestWithPath.exec()).resolves.toHaveProperty( await requestWithoutDependencies.exec(withPreRequest);
'request.endpoint',
'http://martianwabbit.com/user'
)
await expect(requestWithoutPath.exec()).resolves.toHaveProperty( expect(preRequest).toHaveBeenCalled();
'request.endpoint', expect(preRequest.mock.calls).toMatchSnapshot();
'http://example.com/user'
) await requestWithoutDependencies.exec(nonModifiers);
})
}) expect(notCalled).not.toHaveBeenCalled();
});
});

View File

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

View File

@ -1,17 +1,15 @@
const Config = require('../config') const RequestList = require('../requestList');
const RequestList = require('../requestList') const requestPromiseNativeMock = require('request-promise-native');
const requestPromiseNativeMock = require('request-promise-native')
describe('RequestList', () => { describe('RequestList', () => {
const endpoint = 'http://martianwabbit.com' const endpoint = 'http://martianwabbit.com';
let env = { let env = {
environmental: true environmental: true
} };
const doc = { const doc = {
ENDPOINT: endpoint, 'POST /session': null,
ENVIRONMENT: env, 'Not a Request': null,
'GET /post': { alias: 'get-posts' }, 'GET /post': { alias: 'get-posts' },
'POST /user': { 'POST /user': {
alias: 'user', alias: 'user',
@ -20,59 +18,62 @@ describe('RequestList', () => {
lastname: 'Diaz' lastname: 'Diaz'
} }
} }
} };
let requests let requests;
beforeEach(() => { beforeEach(() => {
requestPromiseNativeMock.fail = false requestPromiseNativeMock.fail = false;
requests = new RequestList(doc, {
let config = new Config(doc) ENDPOINT: endpoint,
requests = new RequestList(config) ENVIRONMENT: env,
}) PLUGINS: [
{
it('should allow an empty request list', () => { 'beau-jwt': {
requests = new RequestList() data: {
expect(requests.list.length).toBe(0) secret: 'shhh.',
}) userId: 412
}
}
},
'beau-document'
]
});
});
it('should load valid requests', () => { it('should load valid requests', () => {
expect(requests.list.length).toBe(2) const request = requests.list[0];
})
it('should fetch dependencies', async () => { expect(requests.list.length).toBe(3);
await expect( expect(request.VERB).toBe('POST');
requests.fetchDependencies(['get-posts']) expect(request.ENDPOINT).toBe(endpoint + '/session');
).resolves.toMatchSnapshot() });
})
it('should fetch dependencies', () => {
requests.fetchDependencies(['get-posts']);
});
it('should load plugins', () => {
const pluginLessList = new RequestList();
expect(requests.modifiers.length).toBe(2);
expect(pluginLessList.modifiers.length).toBe(0);
});
it('should execute requests by alias.', async () => { it('should execute requests by alias.', async () => {
await expect(requests.execByAlias('user')).resolves.toMatchSnapshot() await expect(requests.execByAlias('user')).resolves.toMatchSnapshot();
}) });
it('should fail if the request fails', async () => { it('should fail if the request fails', async () => {
requestPromiseNativeMock.fail = true requestPromiseNativeMock.fail = true;
await expect(requests.execByAlias('user')).rejects.toThrow() await expect(requests.execByAlias('user')).rejects.toThrow(Error);
}) });
it('should return a cached result if available', async () => { it('should return a cached result if available', async () => {
const obj = { test: true } const obj = { test: true };
requests.cache.add('test', obj) requests.cache.add('$test', obj);
await expect(requests.execByAlias('test')).resolves.toBe(obj) await expect(requests.execByAlias('test')).resolves.toBe(obj);
}) });
it('should fail if the alias is not found', async () => { it('should fail if the alias is not found', async () => {
await expect(requests.execByAlias('notAnAlias')).rejects.toThrow() await expect(requests.execByAlias('notAnAlias')).rejects.toThrow(Error);
}) });
});
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()
})
})

View File

@ -1,98 +0,0 @@
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')
})
})
})

View File

@ -1,20 +1,55 @@
const RequestList = require('./requestList') const deepMerge = require('deepmerge');
const Config = require('./config')
const { moduleVersion } = require('./shared') const RequestList = require('./requestList');
const requestRegex = require('./shared').requestRegex;
class Beau { class Beau {
constructor(doc, env = {}) { constructor(doc) {
this.config = new Config(doc, env) this.defaults = {
this.requests = new RequestList(this.config) VERSION: 1,
CACHE: false,
ENDPOINT: '',
PLUGINS: [],
DEFAULTS: [],
ENVIRONMENT: {}
};
if (this.config.VERSION !== moduleVersion()) { this.configKeys = Object.keys(this.defaults);
console.warn( this.config = this.loadConfig(doc);
`This Beau file expects v${ this.requests = this.getRequests(doc);
this.config.VERSION this.requests = new RequestList(this.requests, this.config);
}. You are using v${moduleVersion()}.`
)
} }
getRequests(doc) {
let requests = Object.keys(doc).filter(key => {
return requestRegex.test(key);
});
let results = {};
requests.forEach(r => {
if (typeof doc[r] === 'string') {
results[r] = {
ALIAS: doc[r]
};
} else {
results[r] = doc[r];
}
results[r] = deepMerge(this.config.DEFAULTS, results[r]);
});
return results;
}
loadConfig(doc) {
let result = this.defaults;
Object.keys(doc)
.filter(k => this.configKeys.indexOf(k.toUpperCase()) > -1)
.forEach(k => (result[k.toUpperCase()] = doc[k]));
return result;
} }
} }
module.exports = Beau module.exports = Beau;

View File

@ -1,100 +0,0 @@
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

View File

@ -1,119 +0,0 @@
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

View File

@ -1,108 +1,98 @@
const request = require('request-promise-native') const request = require('request-promise-native');
const RequestCache = require('./requestCache') const { httpVerbs, requestRegex, replacementRegex } = require('./shared');
const Plugins = require('./plugins') const RequestList = require('./requestList');
const RequestCache = require('./requestCache');
const {
requestRegex,
replacementRegex,
UpperCaseKeys,
removeOptionalKeys,
isUrl
} = require('./shared')
class Request { class Request {
constructor(req, plugins = new Plugins()) { constructor(req) {
this.originalRequest = req let config = {};
this.plugins = plugins this.originalRequest = req;
req = UpperCaseKeys(req) Object.keys(req).forEach(k => (config[k.toUpperCase()] = req[k]));
Object.assign(this, req)
if (!this.ALIAS) { const {
throw new Error(`${this.REQUEST} is missing an alias.`) REQUEST,
ALIAS,
PAYLOAD,
ENDPOINT,
PARAMS,
HEADERS,
DOCUMENTATION
} = config;
const { verb, path } = this.parseRequest(REQUEST);
this.VERB = verb;
this.ENDPOINT = ENDPOINT + path;
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.`);
} }
const { VERB, PATH } = this.parseRequest(this.REQUEST) this.DEPENDENCIES = this.findDependencies(req);
this.VERB = VERB
this.PATH = PATH
this.DEPENDENCIES = this.findDependencies(req)
} }
parseRequest(request) { parseRequest(request) {
const parts = request.match(requestRegex) const parts = request.match(requestRegex);
return { return {
VERB: parts[1], verb: parts[1],
PATH: parts[2] path: parts[2]
} };
} }
findDependencies(request, set = new Set()) { findDependencies(request, set = new Set()) {
let type = typeof request if (typeof request === 'object') {
const keys = Object.keys(request).filter(key => key !== 'ALIAS');
if (type === 'object' && request !== null) { keys.forEach(key => {
Object.entries(request) set = this.findDependencies(request[key], set);
.filter(([key]) => key !== 'ALIAS') });
.forEach(([key, value]) => { } else if (typeof request === 'string') {
set = this.findDependencies(value, set) const matches = request.match(replacementRegex) || [];
}) const deps = matches.map(m => m.split('.')[0].substring(1));
} 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 new Set([...set, ...deps])
} }
return set return set;
} }
async exec(cache = new RequestCache()) { async exec(modifiers = [], cache = new RequestCache()) {
let settings = cache.parse({ const settings = {
baseUrl: '', endpoint: cache.parse(this.ENDPOINT),
uri: this.PATH,
method: this.VERB, method: this.VERB,
jar: this.COOKIEJAR, headers: cache.parse(this.HEADERS),
query: cache.parse(this.PARAMS),
payload: cache.parse(this.PAYLOAD)
};
headers: this.HEADERS, modifiers.forEach(mod => {
qs: this.PARAMS, if (typeof mod.preRequest !== 'undefined') {
body: this.PAYLOAD, mod.preRequest(settings, this.originalRequest);
form: this.FORM, }
formData: this.FORMDATA, });
try {
const response = await request({
url: settings.endpoint,
method: settings.method,
headers: settings.headers,
qs: settings.query,
body: settings.payload,
json: true, json: true,
simple: false, simple: false,
resolveWithFullResponse: true resolveWithFullResponse: true
}) });
const isPathFullUrl = isUrl(settings.uri) const results = {
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: { request: {
headers: response.request.headers, headers: response.request.headers,
body: response.request.body, body: response.request.body,
@ -114,18 +104,15 @@ class Request {
body: response.body body: response.body
}, },
body: response.body body: response.body
};
cache.add(`$${this.ALIAS}`, results);
return results;
} catch ({ error }) {
throw new Error(error);
} }
results = this.plugins.executeModifier(
'postRequestModifiers',
results,
this.originalRequest
)
cache.add(this.ALIAS, results)
return results
} }
} }
module.exports = Request module.exports = Request;

View File

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

View File

@ -1,54 +1,91 @@
const Request = require('./request') const Request = require('./request');
const RequestCache = require('./requestCache') const RequestCache = require('./requestCache');
const httpVerbs = require('./shared').httpVerbs;
const requireg = require('requireg');
class RequestList { class RequestList {
constructor(config = { REQUESTS: [] }) { constructor(doc = {}, config = {}) {
this.list = this.loadRequests(config.REQUESTS, config.PLUGINS) this.config = config;
this.cache = new RequestCache()
this.cache.add(`env`, config.ENVIRONMENT) this.modifiers = this.loadPlugins();
this.list = this.loadRequests(doc);
this.cache = new RequestCache();
this.cache.add(`$env`, this.config.ENVIRONMENT);
} }
async execByAlias(alias) { async execByAlias(alias) {
if (this.cache.exists(alias)) { if (this.cache.exists(`$${alias}`)) {
return this.cache.get(alias) return this.applyPostResponseModifiers(this.cache.get(`$${alias}`));
} }
const request = this.list.find((r) => r.ALIAS === alias) const request = this.list.find(r => r.ALIAS === alias);
if (typeof request === 'undefined') { if (typeof request === 'undefined') {
throw new Error(`${alias} not found among the requests.`) throw new Error(`${alias} not found among the requests.`);
} }
try { try {
await this.fetchDependencies(Array.from(request.DEPENDENCIES)) await this.fetchDependencies(Array.from(request.DEPENDENCIES));
return await request.exec(this.cache) const response = await request.exec(this.modifiers, this.cache);
return this.applyPostResponseModifiers(response);
} catch (reason) { } catch (reason) {
throw new Error( throw new Error(
`Request ${request.VERB} ${request.ENDPOINT} FAILED. \n${reason}` `Request: ${request.VERB} ${request.ENDPOINT} FAILED. \n${reason}`
) );
} }
} }
async fetchDependencies(dependencies) { async fetchDependencies(dependencies) {
dependencies = dependencies.map((d) => this.execByAlias(d)) dependencies = dependencies.map(d => this.execByAlias(d));
await Promise.all(dependencies) await Promise.all(dependencies);
return this.cache return this.cache;
} }
loadRequests(REQUESTS, PLUGINS) { loadRequests(doc) {
let requests = [] const requests = Object.keys(doc).filter(key => {
REQUESTS.forEach((request) => { const verb = key.split(' ')[0].toUpperCase();
try { return httpVerbs.indexOf(verb) > -1;
requests.push(new Request(request, PLUGINS)) });
} catch (e) {
throw new Error(`${request.request} was ignored: ${e}`)
}
})
return requests return requests.map(request => {
doc[request] = doc[request] || {};
doc[request].ENDPOINT = this.config.ENDPOINT;
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);
});
}
applyPostResponseModifiers(response) {
this.modifiers.forEach(mod => {
if (typeof mod.postResponse !== 'undefined') {
mod.postResponse(response);
}
});
return response;
} }
} }
module.exports = RequestList module.exports = RequestList;

View File

@ -1,5 +1,3 @@
const { URL } = require('url')
const httpVerbs = [ const httpVerbs = [
'GET', 'GET',
'HEAD', 'HEAD',
@ -10,90 +8,13 @@ const httpVerbs = [
'OPTIONS', 'OPTIONS',
'TRACE', 'TRACE',
'PATCH' 'PATCH'
] ];
const requestRegex = new RegExp(`(${httpVerbs.join('|')})\\s(.*)`, 'i') const requestRegex = new RegExp(`(${httpVerbs.join('|')})\\s(.*)`, 'i');
const replacementRegex = /(?:\\?)\$([a-zA-Z\.\d\-\_\:]+)/g 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 = { module.exports = {
httpVerbs,
requestRegex, requestRegex,
replacementRegex, replacementRegex
dynamicValueRegex, };
UpperCaseKeys,
removeOptionalKeys,
toKebabCase,
replaceInObject,
moduleVersion,
isUrl,
expandPath
}

2942
yarn.lock Normal file

File diff suppressed because it is too large Load Diff