Compare commits

..

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

53 changed files with 7322 additions and 9691 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 }}

View File

@ -5,6 +5,7 @@ useTabs: false
trailingComma: none trailingComma: none
bracketSpacing: true bracketSpacing: true
jsxBracketSameLine: true jsxBracketSameLine: true
semi: false parser: babylon
semi: true
requirePragma: false requirePragma: false
proseWrap: always proseWrap: always

42
LICENSE
View File

@ -1,41 +1,7 @@
“Commons Clause” License Condition v1.0 Copyright 2018 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,17 +7,16 @@
<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.
to test APIs without having to write lengthy commands. This makes testing easy, it allows you to share test requests with others as
part of your repo.
<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
@ -25,45 +24,52 @@ to test APIs without having to write lengthy commands.
## Usage ## Usage
$ beau [COMMAND] ⚡ beau --help
COMMANDS Usage: beau [options] [command]
help display help for beau
list Lists all available requests in the config file.
request Executes a request by name. Options:
validate Validates the given configuration file against Beau's configuration schema.
-V, --version output the version number
-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
...
json: {
hello: "world"
},
method: "POST",
url: "https://httpbin.org/anything"
...
}
```
## Documentation beau request profile
Visit https://beaujs.com/docs/ for the complete docs. 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.
## License ## License

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,61 +1,35 @@
const { Command, flags } = require('@oclif/command') const yaml = require('js-yaml');
const yaml = require('js-yaml') const fs = require('fs');
const fs = require('fs') const path = require('path');
const path = require('path') const dotenv = require('dotenv');
const dotenv = require('dotenv') const { Command, flags } = require('@oclif/command');
const Beau = require('../../src/beau')
const Ajv = require('ajv').default
const betterAjvErrors = require('better-ajv-errors')
const schema = require('../../schema.json') const Beau = require('../../src/beau');
const ajv = new Ajv()
const validate = ajv.compile(schema)
class Base extends Command { class Base extends Command {
openConfigFile(configFile) { openConfigFile(configFile) {
if (!fs.existsSync(configFile)) { if (!fs.existsSync(configFile)) {
throw new Error(`The config file, ${configFile} was not found.`) this.error(`The config file, ${configFile} was not found.`);
this.exit(1);
} }
let config return yaml.safeLoad(fs.readFileSync(configFile, 'utf-8'));
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 = []) { loadConfig(configFile, params = []) {
const config = this.openConfigFile(configFile) const config = this.openConfigFile(configFile);
const env = dotenv.config().parsed || {} const env = dotenv.config().parsed || {};
params = dotenv.parse(params.join('\n')) params = dotenv.parse(params.reduce((a, p) => a + '\n' + p, ''));
const envParams = { _: Object.assign(env, params) } const envParams = { _: Object.assign(env, params) };
const configFileDir = path.dirname( const configFileDir = path.dirname(
path.resolve(process.cwd(), configFile) path.resolve(process.cwd(), configFile)
) );
process.chdir(configFileDir) process.chdir(configFileDir);
return new Beau(config, envParams) return new Beau(config, envParams);
} }
} }
@ -67,11 +41,11 @@ Base.flags = {
}), }),
verbose: flags.boolean({ verbose: flags.boolean({
char: 'V', char: 'V',
description: `Show all additional information available for a command.` description: 'Show all additional information available for a command.'
}), }),
'no-format': flags.boolean({ 'no-format': flags.boolean({
description: `Disables color formatting for usage on external tools.` description: `Disables color formatting for usage on external tools.`
}) })
} };
module.exports = Base module.exports = Base;

View File

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

View File

@ -1,41 +1,35 @@
const Base = require('../base') const clc = require('cli-color');
const cj = require('color-json') const jsome = require('jsome');
const clc = require('cli-color') const { Line, Spinner } = require('clui');
const prompts = require('prompts') const { flags } = require('@oclif/command');
const { Line, Spinner } = require('clui')
const { flags } = require('@oclif/command') const Base = require('../base');
const { expandPath } = require('../../../src/shared')
class RequestCommand extends Base { class RequestCommand extends Base {
prettyOutput(res, verbose = false) { prettyOutput(res, verbose = false) {
let { status, body } = res.response let { status, body } = res.response;
this.spinner.stop() this.spinner.stop();
status = status.toString().startsWith(2) status = status.toString().startsWith(2)
? clc.green(status) ? clc.green(status)
: clc.red(status) : clc.red(status);
new Line() new Line()
.padding(2) .padding(2)
.column('Status', 20, [clc.cyan]) .column('Status', 20, [clc.cyan])
.column('Endpoint', 20, [clc.cyan]) .column('Endpoint', 20, [clc.cyan])
.output() .output();
new Line() new Line()
.padding(2) .padding(2)
.column(status, 20) .column(status, 20)
.column(res.request.endpoint) .column(res.request.endpoint)
.output() .output();
new Line().output() new Line().output();
const result = (verbose ? res : body) || null jsome((verbose ? res : body) || null);
if (typeof result === 'object') {
this.log(cj(result))
} else if (typeof result === 'string') {
this.log(result)
}
} }
async run() { async run() {
@ -44,84 +38,43 @@ class RequestCommand extends Base {
param: params, param: params,
config, config,
'no-format': noFormat = false, 'no-format': noFormat = false,
verbose = false, verbose = false
'as-json': asJson = false,
quiet = false,
interactive = false
}, },
args args
} = this.parse(RequestCommand) } = this.parse(RequestCommand);
const Beau = this.loadConfig(config, params) const Beau = this.loadConfig(config, params);
const spinnerSprite = ['⣾', '⣽', '⣻', '⢿', '⡿', '⣟', '⣯', '⣷'] const spinnerSprite = ['⣾', '⣽', '⣻', '⢿', '⡿', '⣟', '⣯', '⣷'];
this.spinner = new Spinner('', spinnerSprite) this.spinner = new Spinner(
clc.yellow(`Requesting: ${args.alias}`),
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 { try {
res = await Beau.requests.execByAlias(args.alias) if (!noFormat) {
} catch (err) { this.spinner.start();
this.spinner.stop()
if (!quiet) {
this.error(err.message)
} }
this.exit(1) let res = await Beau.requests.execByAlias(args.alias);
}
if (quiet) {
return
}
if (asJson) {
return this.log(JSON.stringify(verbose ? res : res.response))
}
if (noFormat) { if (noFormat) {
this.log(res.response.status) this.log(res.response.status);
this.log(res.request.endpoint) this.log(res.request.endpoint);
this.log(JSON.stringify(res.response.headers)) this.log(JSON.stringify(res.response.headers));
this.log(JSON.stringify(res.response.body)) this.log(JSON.stringify(res.response.body));
return } else {
this.prettyOutput(res, verbose);
}
} catch (err) {
new Line().output();
this.spinner.stop();
this.error(err.message);
} }
this.prettyOutput(res, verbose)
} }
} }
RequestCommand.description = `Executes a request by name.` RequestCommand.description = `Executes a request by name.`;
RequestCommand.flags = { RequestCommand.flags = {
...Base.flags, ...Base.flags,
param: flags.string({ param: flags.string({
@ -129,30 +82,15 @@ RequestCommand.flags = {
multiple: true, multiple: true,
default: [], default: [],
description: `Allows you to inject values into the request's environment.` 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 = [ RequestCommand.args = [
{ {
name: 'alias', name: 'alias',
required: false, required: true,
description: `The alias of the request to execute.` description: `The alias of the request to execute.`
} }
] ];
module.exports = RequestCommand module.exports = RequestCommand;

View File

@ -0,0 +1,34 @@
const clc = require('cli-color');
const fs = require('fs');
const yaml = require('js-yaml');
const { flags } = require('@oclif/command');
const Base = require('../base');
const { validate } = require('../../../src/schema.js');
class ValidateCommand extends Base {
async run() {
const { flags, args } = this.parse(ValidateCommand);
const configFile = args.alias || flags.config;
const config = this.openConfigFile(configFile);
let result = await validate(config);
if (result.valid) {
this.log(`${configFile} is valid.`);
} else {
this.error(result.message);
}
}
}
ValidateCommand.description = `Validates the given configuration file against Beau's configuration schema.`;
ValidateCommand.flags = { ...Base.flags };
ValidateCommand.args = [
{
name: 'alias',
required: false,
description: `The configuration file to validate.`
}
];
module.exports = ValidateCommand;

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

32
examples/hosts.yml Normal file
View File

@ -0,0 +1,32 @@
version: 1
environment:
the:
post: 2
defaults:
headers:
hello: 'Hello2'
GET http://jsonplaceholder.typicode.com/posts/1:
alias: a-post
headers:
hello: $jpa2:get-post.body.id
hosts:
- host: jpa
endpoint: http://jsonplaceholder.typicode.com
GET /posts/$env.the.post: get-post
GET /users/$jpa:get-post.body.userId: hello
- host: jpa2
endpoint: http://jsonplaceholder.typicode.com
defaults:
headers: false
GET /posts/$jpa:get-post.body.id:
alias: get-post

27
examples/httpbin.yml Normal file
View File

@ -0,0 +1,27 @@
version: 1
endpoint: https://httpbin.org/
cookiejar: true
environment:
params:
name: David
GET /anything:
alias: anything
payload:
name: $env.params.name
GET /cookies/set:
alias: set-cookies
params:
hello: World
GET /status/418:
alias: teapot
POST /post:
alias: post
formdata:
file: $[createReadStream('./github.yml')]

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:
- 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

14534
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,46 +1,35 @@
{ {
"name": "beau", "name": "beau",
"version": "0.11.3", "version": "0.9.2",
"description": "Testing APIs made easy.", "description": "Testing APIs made easy.",
"main": "./src/beau.js", "main": "./src/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", "test:coverage": "jest --coverage"
"release": "np"
}, },
"files": [
"/src",
"/bin"
],
"dependencies": { "dependencies": {
"@oclif/command": "1.8.0", "@oclif/command": "^1.4.16",
"@oclif/config": "1.17.0", "@oclif/config": "^1.6.13",
"@oclif/plugin-help": "3.2.1", "@oclif/plugin-help": "^1.2.5",
"@oclif/plugin-warn-if-update-available": "1.7.0", "@oclif/plugin-warn-if-update-available": "^1.3.6",
"ajv": "7.0.3", "cli-color": "^1.1.0",
"beau-std": "0.9.4", "clui": "^0.3.1",
"better-ajv-errors": "0.7.0", "deepmerge": "^2.1.0",
"cli-color": "2.0.0", "dotenv": "^5.0.1",
"clui": "0.3.6", "joi": "^13.2.0",
"color-json": "2.0.1", "globby": "^8.0.1",
"deepmerge": "4.2.2", "is-plain-object": "^2.0.4",
"dotenv": "8.2.0", "js-yaml": "^3.11.0",
"globby": "11.0.2", "jsome": "^2.5.0",
"is-plain-object": "5.0.0", "request": "^2.85.0",
"js-yaml": "4.0.0", "request-promise-native": "^1.0.5",
"prompts": "2.4.0", "requireg": "^0.1.6"
"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.4.0"
"jest-watch-typeahead": "0.6.1",
"strip-ansi": "6.0.0",
"np": "7.2.0"
}, },
"oclif": { "oclif": {
"commands": "./bin/cli/commands", "commands": "./bin/cli/commands",
@ -52,16 +41,12 @@
}, },
"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 +1,11 @@
class DynamicValues { class DynamicValues {
constructor(registry, settings = {}) { constructor(registry, settings = {}) {
registry.defineDynamicValue('add', this.add) registry.defineDynamicValue('add', this.add);
} }
add(x, y) { add(x, y) {
return x + y return x + y;
} }
} }
module.exports = DynamicValues module.exports = DynamicValues;

View File

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

View File

@ -1,7 +1,7 @@
class BeauStd { class BeauStd {
constructor(registry, settings) { constructor(registry, settings) {
registry.defineDynamicValue('createReadStream', () => {}) registry.defineDynamicValue('createReadStream', () => {});
} }
} }
module.exports = BeauStd 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 {
@ -14,9 +14,9 @@ function Request(request) {
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,15 @@
function requireg(name) { function requireg(name) {
return require(name) return require(name);
} }
requireg.resolving = true requireg.resolving = true;
requireg.resolve = function (name) { requireg.resolve = function(name) {
if (requireg.resolving) { if (requireg.resolving) {
return '' return '';
} else { } else {
return undefined return undefined;
} }
} };
module.exports = requireg module.exports = requireg;

View File

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

View File

@ -1,6 +1,6 @@
// 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 create a request list 1`] = `
Beau { Beau {
"config": Config { "config": Config {
"COOKIEJAR": false, "COOKIEJAR": false,
@ -9,13 +9,10 @@ Beau {
"authentication": "hello", "authentication": "hello",
}, },
}, },
"ENDPOINT": "http://example.com", "ENDPOINT": "http://jsonplaceholder.typicode.com",
"ENVIRONMENT": Object {}, "ENVIRONMENT": Object {},
"HOSTS": Array [], "HOSTS": Array [],
"PLUGINS": Plugins { "PLUGINS": Plugins {
"autoload": Array [
"std",
],
"context": Object {}, "context": Object {},
"registry": Object { "registry": Object {
"dynamicValues": Array [], "dynamicValues": Array [],
@ -23,7 +20,27 @@ Beau {
"preRequestModifiers": Array [], "preRequestModifiers": Array [],
}, },
}, },
"REQUESTS": Array [], "REQUESTS": Array [
Object {
"ALIAS": "get-post",
"COOKIEJAR": false,
"ENDPOINT": "http://jsonplaceholder.typicode.com",
"HEADERS": Object {
"authentication": "hello",
},
"REQUEST": "GET /posts/1",
},
Object {
"ALIAS": "user",
"COOKIEJAR": false,
"ENDPOINT": "http://jsonplaceholder.typicode.com",
"HEADERS": Object {
"authentication": "hello",
"hello": "world",
},
"REQUEST": "GET /user",
},
],
"VERSION": 1, "VERSION": 1,
"configKeys": Array [ "configKeys": Array [
"VERSION", "VERSION",
@ -34,23 +51,132 @@ Beau {
"HOSTS", "HOSTS",
"COOKIEJAR", "COOKIEJAR",
], ],
"defaultConfigValues": Object {
"COOKIEJAR": false,
"DEFAULTS": Object {},
"ENDPOINT": "",
"ENVIRONMENT": Object {},
"HOSTS": Array [],
"PLUGINS": Array [],
"VERSION": 1,
},
"doc": Object {
"GET /posts/1": "get-post",
"GET /user": Object {
"alias": "user",
"headers": Object {
"hello": "world",
},
},
"defaults": Object {
"headers": Object {
"authentication": "hello",
},
},
"endpoint": "http://jsonplaceholder.typicode.com",
"version": 1,
},
}, },
"requests": RequestList { "requests": RequestList {
"REQUESTS": Array [
Object {
"ALIAS": "get-post",
"COOKIEJAR": false,
"ENDPOINT": "http://jsonplaceholder.typicode.com",
"HEADERS": Object {
"authentication": "hello",
},
"REQUEST": "GET /posts/1",
},
Object {
"ALIAS": "user",
"COOKIEJAR": false,
"ENDPOINT": "http://jsonplaceholder.typicode.com",
"HEADERS": Object {
"authentication": "hello",
"hello": "world",
},
"REQUEST": "GET /user",
},
],
"cache": RequestCache { "cache": RequestCache {
"$cache": Object { "$cache": Object {
"env": Object {}, "env": Object {},
}, },
}, },
"list": Array [], "config": Config {
"COOKIEJAR": false,
"DEFAULTS": Object {
"headers": Object {
"authentication": "hello",
}, },
} },
`; "ENDPOINT": "http://jsonplaceholder.typicode.com",
"ENVIRONMENT": Object {},
exports[`Beau's config Loader. should load the request list using the configuration 1`] = ` "HOSTS": Array [],
RequestList { "PLUGINS": Plugins {
"cache": RequestCache { "context": Object {},
"$cache": Object { "registry": Object {
"env": Object {}, "dynamicValues": Array [],
"postRequestModifiers": Array [],
"preRequestModifiers": Array [],
},
},
"REQUESTS": Array [
Object {
"ALIAS": "get-post",
"COOKIEJAR": false,
"ENDPOINT": "http://jsonplaceholder.typicode.com",
"HEADERS": Object {
"authentication": "hello",
},
"REQUEST": "GET /posts/1",
},
Object {
"ALIAS": "user",
"COOKIEJAR": false,
"ENDPOINT": "http://jsonplaceholder.typicode.com",
"HEADERS": Object {
"authentication": "hello",
"hello": "world",
},
"REQUEST": "GET /user",
},
],
"VERSION": 1,
"configKeys": Array [
"VERSION",
"ENDPOINT",
"PLUGINS",
"DEFAULTS",
"ENVIRONMENT",
"HOSTS",
"COOKIEJAR",
],
"defaultConfigValues": Object {
"COOKIEJAR": false,
"DEFAULTS": Object {},
"ENDPOINT": "",
"ENVIRONMENT": Object {},
"HOSTS": Array [],
"PLUGINS": Array [],
"VERSION": 1,
},
"doc": Object {
"GET /posts/1": "get-post",
"GET /user": Object {
"alias": "user",
"headers": Object {
"hello": "world",
},
},
"defaults": Object {
"headers": Object {
"authentication": "hello",
},
},
"endpoint": "http://jsonplaceholder.typicode.com",
"version": 1,
}, },
}, },
"list": Array [ "list": Array [
@ -58,20 +184,27 @@ RequestList {
"ALIAS": "get-post", "ALIAS": "get-post",
"COOKIEJAR": false, "COOKIEJAR": false,
"DEPENDENCIES": Set {}, "DEPENDENCIES": Set {},
"ENDPOINT": "http://example.com", "ENDPOINT": "http://jsonplaceholder.typicode.com",
"FORM": undefined,
"FORMDATA": undefined,
"HEADERS": Object {
"authentication": "hello",
},
"PARAMS": undefined,
"PATH": "/posts/1", "PATH": "/posts/1",
"PAYLOAD": undefined,
"REQUEST": "GET /posts/1", "REQUEST": "GET /posts/1",
"VERB": "GET", "VERB": "GET",
"originalRequest": Object { "originalRequest": Object {
"ALIAS": "get-post", "ALIAS": "get-post",
"COOKIEJAR": false, "COOKIEJAR": false,
"ENDPOINT": "http://example.com", "ENDPOINT": "http://jsonplaceholder.typicode.com",
"HEADERS": Object {
"authentication": "hello",
},
"REQUEST": "GET /posts/1", "REQUEST": "GET /posts/1",
}, },
"plugins": Plugins { "plugins": Plugins {
"autoload": Array [
"std",
],
"context": Object {}, "context": Object {},
"registry": Object { "registry": Object {
"dynamicValues": Array [], "dynamicValues": Array [],
@ -84,26 +217,29 @@ RequestList {
"ALIAS": "user", "ALIAS": "user",
"COOKIEJAR": false, "COOKIEJAR": false,
"DEPENDENCIES": Set {}, "DEPENDENCIES": Set {},
"ENDPOINT": "http://example.com", "ENDPOINT": "http://jsonplaceholder.typicode.com",
"FORM": undefined,
"FORMDATA": undefined,
"HEADERS": Object { "HEADERS": Object {
"authentication": "hello",
"hello": "world", "hello": "world",
}, },
"PARAMS": undefined,
"PATH": "/user", "PATH": "/user",
"PAYLOAD": undefined,
"REQUEST": "GET /user", "REQUEST": "GET /user",
"VERB": "GET", "VERB": "GET",
"originalRequest": Object { "originalRequest": Object {
"ALIAS": "user", "ALIAS": "user",
"COOKIEJAR": false, "COOKIEJAR": false,
"ENDPOINT": "http://example.com", "ENDPOINT": "http://jsonplaceholder.typicode.com",
"HEADERS": Object { "HEADERS": Object {
"authentication": "hello",
"hello": "world", "hello": "world",
}, },
"REQUEST": "GET /user", "REQUEST": "GET /user",
}, },
"plugins": Plugins { "plugins": Plugins {
"autoload": Array [
"std",
],
"context": Object {}, "context": Object {},
"registry": Object { "registry": Object {
"dynamicValues": Array [], "dynamicValues": Array [],
@ -113,5 +249,6 @@ RequestList {
}, },
}, },
], ],
},
} }
`; `;

View File

@ -42,9 +42,6 @@ Config {
}, },
], ],
"PLUGINS": Plugins { "PLUGINS": Plugins {
"autoload": Array [
"std",
],
"context": Object {}, "context": Object {},
"registry": Object { "registry": Object {
"dynamicValues": Array [], "dynamicValues": Array [],
@ -122,6 +119,55 @@ Config {
"HOSTS", "HOSTS",
"COOKIEJAR", "COOKIEJAR",
], ],
"defaultConfigValues": Object {
"COOKIEJAR": false,
"DEFAULTS": Object {},
"ENDPOINT": "",
"ENVIRONMENT": Object {},
"HOSTS": Array [],
"PLUGINS": Array [],
"VERSION": 1,
},
"doc": Object {
"GET /e1": "e1",
"defaults": Object {
"HEADERS": Object {
"hello": "mars",
},
},
"endpoint": "http://example.org",
"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",
},
],
},
} }
`; `;
@ -133,13 +179,10 @@ Config {
"authentication": "hello", "authentication": "hello",
}, },
}, },
"ENDPOINT": "http://example.com", "ENDPOINT": "http://jsonplaceholder.typicode.com",
"ENVIRONMENT": Object {}, "ENVIRONMENT": Object {},
"HOSTS": Array [], "HOSTS": Array [],
"PLUGINS": Plugins { "PLUGINS": Plugins {
"autoload": Array [
"std",
],
"context": Object {}, "context": Object {},
"registry": Object { "registry": Object {
"dynamicValues": Array [], "dynamicValues": Array [],
@ -151,7 +194,7 @@ Config {
Object { Object {
"ALIAS": "get-post", "ALIAS": "get-post",
"COOKIEJAR": false, "COOKIEJAR": false,
"ENDPOINT": "http://example.com", "ENDPOINT": "http://jsonplaceholder.typicode.com",
"HEADERS": Object { "HEADERS": Object {
"authentication": "hello", "authentication": "hello",
}, },
@ -160,7 +203,7 @@ Config {
Object { Object {
"ALIAS": "user", "ALIAS": "user",
"COOKIEJAR": false, "COOKIEJAR": false,
"ENDPOINT": "http://example.com", "ENDPOINT": "http://jsonplaceholder.typicode.com",
"HEADERS": Object { "HEADERS": Object {
"authentication": "hello", "authentication": "hello",
"hello": "world", "hello": "world",
@ -178,5 +221,30 @@ Config {
"HOSTS", "HOSTS",
"COOKIEJAR", "COOKIEJAR",
], ],
"defaultConfigValues": Object {
"COOKIEJAR": false,
"DEFAULTS": Object {},
"ENDPOINT": "",
"ENVIRONMENT": Object {},
"HOSTS": Array [],
"PLUGINS": Array [],
"VERSION": 1,
},
"doc": Object {
"GET /posts/1": "get-post",
"GET /user": Object {
"alias": "user",
"headers": Object {
"hello": "world",
},
},
"defaults": Object {
"HEADERS": Object {
"authentication": "hello",
},
},
"endpoint": "http://jsonplaceholder.typicode.com",
"version": 1,
},
} }
`; `;

View File

@ -20,7 +20,6 @@ Object {
exports[`Beau's plugin system shouldn't do anything when given an empty array. 1`] = ` exports[`Beau's plugin system shouldn't do anything when given an empty array. 1`] = `
Plugins { Plugins {
"autoload": Array [],
"context": Object {}, "context": Object {},
"registry": Object { "registry": Object {
"dynamicValues": Array [], "dynamicValues": Array [],

View File

@ -7,7 +7,7 @@ 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",
}, },
@ -25,7 +25,7 @@ Object {
"body": "{\\"hello\\": \\"world\\"}", "body": "{\\"hello\\": \\"world\\"}",
"request": Object { "request": Object {
"body": undefined, "body": undefined,
"endpoint": "http://example.com/user", "endpoint": "http://martianwabbit.com/user",
"headers": undefined, "headers": undefined,
}, },
"response": Object { "response": Object {

View File

@ -1,59 +1,29 @@
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;
const requireg = require('requireg')
requireg.resolving = false
describe(`Beau's config Loader.`, () => { describe(`Beau's config Loader.`, () => {
it('should load the config', () => { it('should create a request list', () => {
moduleVersion.mockReturnValue(1) const doc = yaml.safeLoad(`
const doc = yaml.load(`
version: 1 version: 1
endpoint: 'http://example.com' 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.requests).toBeDefined();
let stdout expect(beau).toMatchSnapshot();
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()
})
})

View File

@ -1,25 +1,25 @@
const yaml = require('js-yaml') const yaml = require('js-yaml');
const Config = require('../config') const Config = require('../config');
const requireg = require('requireg') const requireg = require('requireg');
requireg.resolving = false requireg.resolving = false;
describe('Config', () => { describe('Config', () => {
it('should load valid config keys', () => { it('should load valid config keys', () => {
const doc = yaml.load(` const doc = yaml.safeLoad(`
version: 1 version: 1
endpoint: http://martianwabbit.com endpoint: http://martianwabbit.com
shouldntBeAdded: true shouldntBeAdded: true
`) `);
const config = new Config(doc) const config = new Config(doc);
expect(config.ENDPOINT).toBe(doc.endpoint) expect(config.ENDPOINT).toBe(doc.endpoint);
expect(config.VERSION).toBe(doc.version) expect(config.VERSION).toBe(doc.version);
expect(config.shouldntBeAdded).toBeUndefined() expect(config.shouldntBeAdded).toBeUndefined();
}) });
it('should load requests', () => { it('should load requests', () => {
const doc = yaml.load(` const doc = yaml.safeLoad(`
endpoint: http://example.com endpoint: http://example.com
GET /profile: get-profile GET /profile: get-profile
@ -29,16 +29,16 @@ describe('Config', () => {
alias: user alias: user
headers: headers:
hello: world hello: world
`) `);
const config = new Config(doc) const config = new Config(doc);
expect(Object.keys(config.REQUESTS).length).toBe(4) expect(Object.keys(config.REQUESTS).length).toBe(4);
}) });
it('should set up defaults for all requests', () => { it('should set up defaults for all requests', () => {
const doc = yaml.load(` const doc = yaml.safeLoad(`
version: 1 version: 1
endpoint: 'http://example.com' endpoint: 'http://jsonplaceholder.typicode.com'
defaults: defaults:
HEADERS: HEADERS:
@ -49,19 +49,18 @@ describe('Config', () => {
alias: user alias: user
headers: headers:
hello: world hello: world
`) `);
const config = new Config(doc) const config = new Config(doc);
expect(config).toMatchSnapshot() expect(config).toMatchSnapshot();
Object.values(config.REQUESTS).forEach((r) => { Object.values(config.REQUESTS).forEach(r => {
expect(r.HEADERS.authentication).toMatch('hello') expect(r.HEADERS.authentication).toMatch('hello');
}) });
}) });
it('should load multiple hosts', () => { it('should load multiple hosts', () => {
const doc = yaml.load(` const doc = yaml.safeLoad(`
version: 1
endpoint: http://example.org endpoint: http://example.org
defaults: defaults:
@ -97,15 +96,15 @@ describe('Config', () => {
endpoint: http://example.info endpoint: http://example.info
GET /posts: posts GET /posts: posts
`) `);
let config = new Config(doc) let config = new Config(doc);
expect(config).toMatchSnapshot() expect(config).toMatchSnapshot();
}) });
it('should namespace all aliases within an host', () => { it('should namespace all aliases within an host', () => {
const doc = yaml.load(` const doc = yaml.safeLoad(`
hosts: hosts:
- host: test1 - host: test1
endpoint: http://example.com endpoint: http://example.com
@ -113,16 +112,16 @@ describe('Config', () => {
- host: test2 - host: test2
endpoint: http://example.net endpoint: http://example.net
GET /posts: posts GET /posts: posts
`) `);
let config = new Config(doc) let config = new Config(doc);
expect(config.REQUESTS[0].ALIAS).toBe('test1:posts') expect(config.REQUESTS[0].ALIAS).toBe('test1:posts');
expect(config.REQUESTS[1].ALIAS).toBe('test2:posts') expect(config.REQUESTS[1].ALIAS).toBe('test2:posts');
}) });
it(`should throw if host doesn't have a host key`, () => { it(`should throw if host doesn't have a host key`, () => {
const doc = yaml.load(` const doc = yaml.safeLoad(`
hosts: hosts:
- endpoint: http://example.com - endpoint: http://example.com
GET /posts: posts GET /posts: posts
@ -130,13 +129,13 @@ describe('Config', () => {
- host: test2 - host: test2
endpoint: http://example.net endpoint: http://example.net
GET /posts: posts GET /posts: posts
`) `);
expect(() => new Config(doc)).toThrow() expect(() => new Config(doc)).toThrow();
}) });
it(`should merge host settings with global settings`, () => { it(`should merge host settings with global settings`, () => {
const doc = yaml.load(` const doc = yaml.safeLoad(`
defaults: defaults:
headers: headers:
hello: 1 hello: 1
@ -152,25 +151,9 @@ describe('Config', () => {
headers: false headers: false
GET /posts: posts GET /posts: posts
`) `);
let config = new Config(doc) let config = new Config(doc);
expect(config.REQUESTS[0].HEADERS.hello).toBe(1) 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,41 +1,42 @@
const Plugins = require('../plugins') const yaml = require('js-yaml');
const Request = require('../request') const Plugins = require('../plugins');
const RequestCache = require('../requestCache') const Request = require('../request');
const requireg = require('requireg') const RequestCache = require('../requestCache');
const requireg = require('requireg');
describe(`Beau's plugin system`, () => { describe(`Beau's plugin system`, () => {
let request let request;
let plugins let plugins;
beforeEach(() => { beforeEach(() => {
plugins = new Plugins([{ Modifiers: [Object] }, 'DynamicValues'], []) plugins = new Plugins([{ Modifiers: [Object] }, 'DynamicValues'], []);
}) });
it('should load all plugins', () => { it('should load all plugins', () => {
expect(plugins.registry.preRequestModifiers.length).toBe(1) expect(plugins.registry.preRequestModifiers.length).toBe(1);
expect(plugins.registry.postRequestModifiers.length).toBe(1) expect(plugins.registry.postRequestModifiers.length).toBe(1);
expect(plugins.registry.dynamicValues.length).toBe(1) expect(plugins.registry.dynamicValues.length).toBe(1);
}) });
it(`should throw if given an invalid configuration`, () => { it(`should throw if given an invalid configuration`, () => {
expect(() => new Plugins([{ test1: true, test2: true }])).toThrow() expect(() => new Plugins([{ test1: true, test2: true }])).toThrow();
}) });
it(`shouldn't do anything when given an empty array.`, () => { it(`shouldn't do anything when given an empty array.`, () => {
expect(new Plugins([], [])).toMatchSnapshot() expect(new Plugins([], [])).toMatchSnapshot();
}) });
it(`should warn if the plugin is not available.`, () => { it(`should warn if the plugin is not available.`, () => {
const spy = jest.spyOn(console, 'warn').mockImplementation(() => {}) const spy = jest.spyOn(console, 'warn').mockImplementation(() => {});
requireg.resolving = false requireg.resolving = false;
new Plugins(['not-a-Package']) new Plugins(['not-a-Package']);
expect(spy).toHaveBeenCalled() expect(spy).toHaveBeenCalled();
requireg.resolving = true requireg.resolving = true;
spy.mockReset() spy.mockReset();
spy.mockRestore() spy.mockRestore();
}) });
describe(`Request Modifiers`, () => { describe(`Request Modifiers`, () => {
beforeEach(() => { beforeEach(() => {
@ -46,13 +47,13 @@ describe(`Beau's plugin system`, () => {
alias: 'update' alias: 'update'
}, },
plugins plugins
) );
}) });
it(`should modify the request and response using modifiers.`, async () => { it(`should modify the request and response using modifiers.`, async () => {
await expect(request.exec()).resolves.toMatchSnapshot() await expect(request.exec()).resolves.toMatchSnapshot();
}) });
}) });
describe(`Dynamic Values`, () => { describe(`Dynamic Values`, () => {
beforeEach(() => { beforeEach(() => {
@ -68,34 +69,34 @@ describe(`Beau's plugin system`, () => {
payload: 'counted $[add(1, $value2)] so far.' payload: 'counted $[add(1, $value2)] so far.'
}, },
plugins plugins
) );
}) });
let cache = new RequestCache() let cache = new RequestCache();
cache.add('value2', '2') cache.add('value2', '2');
it(`should look for dynamic values executing and replacing them`, async () => { it(`should look for dynamic values executing and replacing them`, async () => {
let req = await request.exec(cache) let req = await request.exec(cache);
expect(req).toHaveProperty('request.body', 'counted 3 so far.') 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 () => { it(`should change the internal datatype if the only thing in the value is the dynamic value`, async () => {
let req = await request.exec(cache) let req = await request.exec(cache);
expect(req).toHaveProperty('request.headers.count', 3) expect(req).toHaveProperty('request.headers.count', 3);
}) });
it(`should return empty values as empty`, async () => { it(`should return empty values as empty`, async () => {
let req = await request.exec(cache) let req = await request.exec(cache);
expect(req).toHaveProperty('request.headers.empty', '') expect(req).toHaveProperty('request.headers.empty', '');
}) });
it(`should throw when calling an undefined dynamic value`, async () => { it(`should throw when calling an undefined dynamic value`, async () => {
request = new Request({ request = new Request({
request: 'POST /hello/$[notAvailable(1, 2)]', request: 'POST /hello/$[notAvailable(1, 2)]',
alias: 'say-hello' alias: 'say-hello'
}) });
await expect(request.exec()).rejects.toThrow() await expect(request.exec()).rejects.toThrow();
}) });
}) });
}) });

View File

@ -1,18 +1,19 @@
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 cache;
let validRequestConfig let validRequestConfig;
let invalidRequestConfig let invalidRequestConfig;
let request let request;
let requestWithoutDependencies let requestWithoutDependencies;
beforeEach(() => { beforeEach(() => {
validRequestConfig = { validRequestConfig = {
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 +24,54 @@ describe('Request', () => {
payload: { payload: {
username: 'seich' username: 'seich'
} }
} };
invalidRequestConfig = { invalidRequestConfig = {
request: `POST /session`, request: `POST /session`,
endpoint: 'http://example.com' endpoint: 'http://martianwabbit.com'
} };
cache = new RequestCache() cache = new RequestCache();
cache.add('session', { token: 'abc123' }) cache.add('session', { token: 'abc123' });
cache.add('profile', { UserId: 14 }) cache.add('profile', { UserId: 14 });
request = new Request(validRequestConfig) 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', () => { 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(validRequestConfig.endpoint);
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', () => { it('should throw if a given request is invalid', () => {
expect(() => new Request(invalidRequestConfig)).toThrow() expect(() => new Request(invalidRequestConfig)).toThrow();
}) });
it('should list all of its dependencies', () => { it('should list all of its dependencies', () => {
expect(request.DEPENDENCIES.size).toBe(2) expect(request.DEPENDENCIES.size).toBe(2);
expect(request.DEPENDENCIES).toContain('session') expect(request.DEPENDENCIES).toContain('session');
expect(request.DEPENDENCIES).toContain('profile') expect(request.DEPENDENCIES).toContain('profile');
}) });
it('should execute a request', async () => { it('should execute a request', async () => {
await expect(request.exec(cache)).resolves.toMatchSnapshot() 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 () => { 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 () => {
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'
)
})
})

View File

@ -1,14 +1,14 @@
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', [
{ {
@ -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,34 @@ 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`, () => { it(`shouldn't replace escaped variables`, () => {
expect(cache.parse(`\\$session.hello is $session.hello`)).toBe( expect(cache.parse(`\\$session.hello is $session.hello`)).toBe(
`$session.hello is World` `$session.hello is World`
) );
}) });
}) });
}) });

View File

@ -1,13 +1,13 @@
const Config = require('../config') 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, ENDPOINT: endpoint,
@ -20,49 +20,49 @@ describe('RequestList', () => {
lastname: 'Diaz' lastname: 'Diaz'
} }
} }
} };
let requests let requests;
beforeEach(() => { beforeEach(() => {
requestPromiseNativeMock.fail = false requestPromiseNativeMock.fail = false;
let config = new Config(doc) let config = new Config(doc);
requests = new RequestList(config) requests = new RequestList(config);
}) });
it('should allow an empty request list', () => { it('should allow an empty request list', () => {
requests = new RequestList() requests = new RequestList();
expect(requests.list.length).toBe(0) expect(requests.list.length).toBe(0);
}) });
it('should load valid requests', () => { it('should load valid requests', () => {
expect(requests.list.length).toBe(2) expect(requests.list.length).toBe(2);
}) });
it('should fetch dependencies', async () => { it('should fetch dependencies', async () => {
await expect( await expect(
requests.fetchDependencies(['get-posts']) requests.fetchDependencies(['get-posts'])
).resolves.toMatchSnapshot() ).resolves.toMatchSnapshot();
}) });
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();
}) });
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();
}) });
it(`should fail if a given request doesn't have an alias`, () => { it(`should fail if a given request doesn't have an alias`, () => {
let config = new Config({ let config = new Config({
@ -71,8 +71,8 @@ describe('RequestList', () => {
hello: 1 hello: 1
} }
} }
}) });
expect(() => new RequestList(config, config)).toThrow() 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,11 @@
const RequestList = require('./requestList') const RequestList = require('./requestList');
const Config = require('./config') const Config = require('./config');
const { moduleVersion } = require('./shared')
class Beau { class Beau {
constructor(doc, env = {}) { constructor(doc, env = {}) {
this.config = new Config(doc, env) this.config = new Config(doc, env);
this.requests = new RequestList(this.config) 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 module.exports = Beau;

View File

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

View File

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

View File

@ -1,71 +1,89 @@
const request = require('request-promise-native') const request = require('request-promise-native');
const RequestCache = require('./requestCache') const RequestCache = require('./requestCache');
const Plugins = require('./plugins') const Plugins = require('./plugins');
const { const {
requestRegex, requestRegex,
replacementRegex, replacementRegex,
UpperCaseKeys, UpperCaseKeys,
removeOptionalKeys, removeOptionalKeys
isUrl } = require('./shared');
} = require('./shared')
class Request { class Request {
constructor(req, plugins = new Plugins()) { constructor(req, plugins = new Plugins()) {
this.originalRequest = req this.originalRequest = req;
this.plugins = plugins this.plugins = plugins;
req = UpperCaseKeys(req) this.loadCofiguration(
Object.assign(this, req) [
'REQUEST',
'ENDPOINT',
'HEADERS',
'PAYLOAD',
'PARAMS',
'FORM',
'ALIAS',
'COOKIEJAR',
'FORMDATA'
],
req
);
if (!this.ALIAS) { if (!this.ALIAS) {
throw new Error(`${this.REQUEST} is missing an alias.`) throw new Error(`${this.REQUEST} is missing an alias.`);
} }
const { VERB, PATH } = this.parseRequest(this.REQUEST) const { VERB, PATH } = this.parseRequest(this.REQUEST);
this.VERB = VERB this.VERB = VERB;
this.PATH = PATH this.PATH = PATH;
this.DEPENDENCIES = this.findDependencies(req) this.DEPENDENCIES = this.findDependencies(req);
}
loadCofiguration(keys, obj) {
obj = UpperCaseKeys(obj);
keys.forEach(k => {
this[k] = obj[k];
});
} }
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 let type = typeof request;
if (type === 'object' && request !== null) { if (type === 'object') {
Object.entries(request) Object.keys(request)
.filter(([key]) => key !== 'ALIAS') .filter(key => key !== 'ALIAS')
.forEach(([key, value]) => { .forEach(key => {
set = this.findDependencies(value, set) set = this.findDependencies(request[key], set);
}) });
} else if (type === 'string') { } else if (type === 'string') {
const matches = [] const matches = [];
request.replace( request.replace(
replacementRegex, replacementRegex,
(match, g1) => !match.startsWith('\\') && matches.push(g1) (match, g1) => !match.startsWith('\\') && matches.push(g1)
) );
const deps = matches.map((m) => m.split('.')[0]) 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(cache = new RequestCache()) {
let settings = cache.parse({ let settings = cache.parse({
baseUrl: '', baseUrl: this.ENDPOINT,
uri: this.PATH, uri: this.PATH,
method: this.VERB, method: this.VERB,
jar: this.COOKIEJAR, jar: this.COOKIEJAR,
@ -79,10 +97,7 @@ class Request {
json: true, json: true,
simple: false, simple: false,
resolveWithFullResponse: true resolveWithFullResponse: true
}) });
const isPathFullUrl = isUrl(settings.uri)
settings.baseUrl = isPathFullUrl ? '' : this.ENDPOINT
settings = removeOptionalKeys(settings, [ settings = removeOptionalKeys(settings, [
'headers', 'headers',
@ -90,17 +105,18 @@ class Request {
'body', 'body',
'form', 'form',
'formData' 'formData'
]) ]);
settings = this.plugins.replaceDynamicValues(settings) settings = this.plugins.replaceDynamicValues(settings);
settings = this.plugins.executeModifier( settings = this.plugins.executeModifier(
'preRequestModifiers', 'preRequestModifiers',
settings, settings,
this.originalRequest this.originalRequest
) );
const response = await request(settings) try {
const response = await request(settings);
let results = { let results = {
request: { request: {
@ -114,18 +130,21 @@ class Request {
body: response.body body: response.body
}, },
body: response.body body: response.body
} };
results = this.plugins.executeModifier( results = this.plugins.executeModifier(
'postRequestModifiers', 'postRequestModifiers',
results, results,
this.originalRequest this.originalRequest
) );
cache.add(this.ALIAS, results) cache.add(this.ALIAS, results);
return results return results;
} catch ({ error }) {
throw new Error(`Request Error: ` + error);
}
} }
} }
module.exports = Request module.exports = Request;

View File

@ -1,46 +1,46 @@
const { replacementRegex, replaceInObject } = require('./shared') const { replacementRegex, replaceInObject } = 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) { if (result[part] === undefined) {
throw new Error(`${path} not found in cache.`) throw new Error(`${path} not found in cache.`);
} }
result = result[part] result = result[part];
}) });
return result return result;
} }
parse(item) { parse(item) {
if (item === null) { if (item === null) {
return null return null;
} }
return replaceInObject(item, (item) => return replaceInObject(item, item => {
item.replace(replacementRegex, (match, key) => { return item.replace(replacementRegex, (match, key) => {
if (match.startsWith('\\')) { if (match.startsWith('\\')) {
return match.replace('\\$', '$') return match.replace('\\$', '$');
} }
return this.get(key) return this.get(key);
}) });
) });
} }
} }
module.exports = RequestCache module.exports = RequestCache;

View File

@ -1,54 +1,59 @@
const Request = require('./request') const Request = require('./request');
const RequestCache = require('./requestCache') const RequestCache = require('./requestCache');
class RequestList { class RequestList {
constructor(config = { REQUESTS: [] }) { constructor(config = { REQUESTS: [] }) {
this.list = this.loadRequests(config.REQUESTS, config.PLUGINS) this.config = config;
this.cache = new RequestCache() this.REQUESTS = config.REQUESTS;
this.cache.add(`env`, config.ENVIRONMENT) this.list = this.loadRequests();
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.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) return await request.exec(this.cache);
} 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() {
let requests = [] let requests = [];
REQUESTS.forEach((request) => { this.REQUESTS.forEach(request => {
try { try {
requests.push(new Request(request, PLUGINS)) requests.push(new Request(request, this.config.PLUGINS));
} catch (e) { } catch (e) {
throw new Error(`${request.request} was ignored: ${e}`) throw new Error(`${request.request} was ignored: ${e}`);
} }
}) });
return requests return requests;
} }
} }
module.exports = RequestList module.exports = RequestList;

79
src/schema.js Normal file
View File

@ -0,0 +1,79 @@
const Joi = require('joi');
const { requestRegex } = require('./shared.js');
const pluginSchema = [
Joi.string(),
Joi.object()
.keys(null)
.max(1)
];
const requestSchema = [
Joi.object()
.keys({
HEADERS: Joi.object().keys(null),
PAYLOAD: [Joi.object().keys(null), Joi.string()],
PARAMS: Joi.object().keys(null),
FORM: Joi.object().keys(null),
ALIAS: Joi.string().required(),
FORMDATA: Joi.object().keys(null)
})
.without('FORM', ['PAYLOAD', 'FORMDATA'])
.without('PAYLOAD', ['FORM', 'FORMDATA'])
.without('FORMDATA', ['FORM', 'PAYLOAD'])
.rename(/headers/i, 'HEADERS', { override: true })
.rename(/payload/i, 'PAYLOAD', { override: true })
.rename(/params/i, 'PARAMS', { override: true })
.rename(/form/i, 'FORM', { override: true })
.rename(/alias/i, 'ALIAS', { override: true }),
Joi.string()
];
const hostSchema = Joi.object()
.keys({
HOST: Joi.string().required(),
ENDPOINT: Joi.string(),
DEFAULTS: Joi.object().keys(null)
})
.pattern(requestRegex, requestSchema)
.rename(/host/i, 'HOST', { override: true })
.rename(/defaults/i, 'DEFAULTS', { override: true })
.rename(/endpoint/i, 'ENDPOINT', { override: true });
const schema = Joi.object()
.keys({
VERSION: Joi.number().integer(),
ENDPOINT: Joi.string().uri(),
PLUGINS: Joi.array().items(pluginSchema),
DEFAULTS: Joi.object(),
ENVIRONMENT: Joi.object(),
HOSTS: Joi.array().items(hostSchema),
COOKIEJAR: Joi.boolean()
})
.pattern(requestRegex, requestSchema)
.rename(/version/i, 'VERSION', { override: true })
.rename(/endpoint/i, 'ENDPOINT', { override: true })
.rename(/hosts/i, 'HOSTS', { override: true })
.rename(/plugins/i, 'PLUGINS', { override: true })
.rename(/defaults/i, 'DEFAULTS', { override: true })
.rename(/environment/i, 'ENVIRONMENT', { override: true })
.rename(/cookiejar/i, 'COOKIEJAR', { override: true });
const validate = async function(config) {
try {
let results = await Joi.validate(config, schema, {
allowUnknown: true
});
return { valid: true };
} catch ({ name, details }) {
return {
valid: false,
message: `${name}: \n ${details
.map(d => d.message + ' @ ' + d.path)
.join(' \n ')}`
};
}
};
module.exports = { schema, validate };

View File

@ -1,5 +1,3 @@
const { URL } = require('url')
const httpVerbs = [ const httpVerbs = [
'GET', 'GET',
'HEAD', 'HEAD',
@ -10,80 +8,65 @@ 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 dynamicValueRegex = /\$\[(\w+\((?:.|[\n\r])*?\))\]/g;
const UpperCaseKeys = function (obj) { const UpperCaseKeys = function(obj) {
let result = {} let result = {};
Object.entries(obj).forEach(([k, v]) => (result[k.toUpperCase()] = v)) Object.keys(obj).forEach(k => (result[k.toUpperCase()] = obj[k]));
return result return result;
} };
const isEmptyObject = (obj) => const removeOptionalKeys = function(obj, optionalValues) {
Object.keys(obj).length === 0 && obj.constructor === Object let result = {};
const removeOptionalKeys = function (obj, optionalValues) { Object.keys(obj).forEach(key => {
let result = {} if (
optionalValues.includes(key) &&
Object.entries(obj).forEach(([key, value]) => { (Object.keys(obj[key]).length === 0 &&
if (optionalValues.includes(key) && isEmptyObject(value)) { obj[key].constructor === Object)
return ) {
return;
} }
result[key] = value result[key] = obj[key];
}) });
return result return result;
} };
const toKebabCase = function (str) { const toKebabCase = function(str) {
return str return str
.trim() .trim()
.replace(/([a-z])([A-Z])/g, '$1-$2') .replace(/([a-z])([A-Z])/g, '$1-$2')
.toLowerCase() .replace(/\s+/g, '-')
} .toLowerCase();
};
const replaceInObject = function (obj, fn) { const replaceInObject = function(obj, fn) {
if (obj === null) { if (obj === null) {
return null return null;
} }
switch (typeof obj) { let type = 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) if (type === 'undefined') {
return {};
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(/^\/+/, '') if (type === 'string') {
} return fn(obj);
}
if (type === 'object') {
Object.keys(obj).forEach(k => (obj[k] = replaceInObject(obj[k], fn)));
}
return obj;
};
module.exports = { module.exports = {
requestRegex, requestRegex,
@ -92,8 +75,5 @@ module.exports = {
UpperCaseKeys, UpperCaseKeys,
removeOptionalKeys, removeOptionalKeys,
toKebabCase, toKebabCase,
replaceInObject, replaceInObject
moduleVersion, };
isUrl,
expandPath
}