Skip to content

Commit f00d54e

Browse files
shreys7shreys7
committed
Added support for adding headers and body modes
1 parent 221d529 commit f00d54e

File tree

6 files changed

+274
-16
lines changed

6 files changed

+274
-16
lines changed

‎codegens/php-httprequest/.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,5 @@ typings/
3939
.env
4040

4141
out/
42+
43+
codesnippet.php

‎codegens/php-httprequest/lib/index.js

+121-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,124 @@
1-
module.exports = {
2-
convert: function (request, options) {
3-
// Use request object and options object to generate code snippet.
4-
// return (String) snippet
5-
},
1+
var _ = require('./lodash'),
2+
parseBody = require('./util/parseBody'),
3+
sanitize = require('./util/sanitize').sanitize,
4+
sanitizeOptions = require('./util/sanitize').sanitizeOptions,
5+
self;
6+
7+
/**
8+
* Used to get the headers and put them in the desired form of the language
9+
*
10+
* @param {Object} request - postman SDK-request object
11+
* @param {String} indentation - used for indenting snippet's structure
12+
* @returns {String} - request headers in the desired format
13+
*/
14+
function getHeaders (request, indentation) {
15+
var headerArray = request.toJSON().header,
16+
headerMap;
17+
18+
if (!_.isEmpty(headerArray)) {
19+
headerArray = _.reject(headerArray, 'disabled');
20+
headerMap = _.map(headerArray, function (header) {
21+
return `${indentation}'${sanitize(header.key, true)}' => ` +
22+
`'${sanitize(header.value)}'`;
23+
});
24+
return `$request->setHeaders(array(\n${headerMap.join(',\n')}\n));\n`;
25+
}
26+
return '';
27+
}
28+
self = module.exports = {
29+
/**
30+
* @returns {Array} plugin specific options
31+
*/
632
getOptions: function () {
7-
// Return an array of options supported by this codegen.
33+
return [
34+
{
35+
name: 'Set indentation count',
36+
id: 'indentCount',
37+
type: 'positiveInteger',
38+
default: 2,
39+
description: 'Set the number of indentation characters to add per code level'
40+
},
41+
{
42+
name: 'Set indentation type',
43+
id: 'indentType',
44+
type: 'enum',
45+
default: 'Space',
46+
availableOptions: ['Tab', 'Space'],
47+
description: 'Select the character used to indent lines of code'
48+
},
49+
{
50+
name: 'Set request timeout',
51+
id: 'requestTimeout',
52+
type: 'positiveInteger',
53+
default: 0,
54+
description: 'Set number of milliseconds the request should wait for a response' +
55+
' before timing out (use 0 for infinity)'
56+
},
57+
{
58+
name: 'Trim request body fields',
59+
id: 'trimRequestBody',
60+
type: 'boolean',
61+
default: false,
62+
description: 'Remove white space and additional lines that may affect the server\'s response'
63+
},
64+
{
65+
name: 'Follow redirects',
66+
id: 'followRedirect',
67+
type: 'boolean',
68+
default: true,
69+
description: 'Automatically follow HTTP redirects'
70+
}
71+
];
72+
},
73+
convert: function (request, options, callback) {
74+
if (_.isFunction(options)) {
75+
callback = options;
76+
options = {};
77+
}
78+
if (!_.isFunction(callback)) {
79+
throw new Error('PHP-HttpRequest-Converter: callback is not valid function');
80+
}
81+
options = sanitizeOptions(options, self.getOptions());
82+
83+
var snippet, indentString;
84+
indentString = options.indentType === 'Tab' ? '\t' : ' ';
85+
indentString = indentString.repeat(options.indentCount);
86+
87+
snippet = '<?php\n';
88+
snippet += '$request = new HttpRequest();\n';
89+
snippet += `$request->setUrl('${request.url.toString()}');\n`;
90+
snippet += `$request->setMethod(HTTP_METH_${request.method});\n`;
91+
if (options.requestTimeout !== 0 || !options.followRedirect) {
92+
snippet += '$request->setOptions(array(';
93+
snippet += options.requestTimeout === 0 ? '' : `'timeout' => ${options.requestTimeout}`;
94+
snippet += options.followRedirect ? '' : ', \'redirect\' => false';
95+
snippet += '));\n';
96+
}
97+
if (request.body && !request.headers.has('Content-Type')) {
98+
if (request.body.mode === 'file') {
99+
request.addHeader({
100+
key: 'Content-Type',
101+
value: 'text/plain'
102+
});
103+
}
104+
else if (request.body.mode === 'graphql') {
105+
request.addHeader({
106+
key: 'Content-Type',
107+
value: 'application/json'
108+
});
109+
}
110+
}
111+
// add the headers to snippet
112+
snippet += getHeaders(request, indentString);
113+
114+
// add the body to snippet
115+
if (!_.isEmpty(request.body)) {
116+
snippet += `${parseBody(request.toJSON(), indentString, options.trimRequestBody)}`;
117+
}
118+
snippet += 'try {\n';
119+
snippet += `${indentString}echo $request->send()->getBody();\n`;
120+
snippet += '} catch(HttpException $ex) {\n';
121+
snippet += `${indentString}echo $ex;\n}`;
122+
return callback(null, snippet);
8123
}
9124
};

‎codegens/php-httprequest/lib/util/parseBody.js

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
var _ = require('../lodash'),
2+
sanitize = require('./sanitize').sanitize;
3+
4+
module.exports = function (request, indentString, trim) {
5+
var bodySnippet = '',
6+
bodyFileMap = [],
7+
bodyDataMap = [],
8+
enabledBodyList;
9+
10+
switch (request.body.mode) {
11+
case 'raw':
12+
bodySnippet += `$request->setBody(${sanitize(request.body[request.body.mode], trim)});\n`;
13+
break;
14+
// eslint-disable-next-line no-case-declarations
15+
case 'graphql':
16+
let query = request.body[request.body.mode].query,
17+
graphqlVariables;
18+
try {
19+
graphqlVariables = JSON.parse(request.body[request.body.mode].variables);
20+
}
21+
catch (e) {
22+
graphqlVariables = {};
23+
}
24+
bodySnippet += `$request->setBody(${sanitize(JSON.stringify({
25+
query: query,
26+
variables: graphqlVariables
27+
}), trim)});\n`;
28+
break;
29+
case 'urlencoded':
30+
enabledBodyList = _.reject(request.body[request.body.mode], 'disabled');
31+
if (!_.isEmpty(enabledBodyList)) {
32+
bodyDataMap = _.map(enabledBodyList, (data) => {
33+
return `${indentString}'${sanitize(data.key, trim)}' => '${sanitize(data.value, trim)}'`;
34+
});
35+
bodySnippet += `$request->setPostFields(array(\n${bodyDataMap.join(',\n')}));\n`;
36+
}
37+
break;
38+
case 'formdata':
39+
enabledBodyList = _.reject(request.body[request.body.mode], 'disabled');
40+
if (!_.isEmpty(enabledBodyList)) {
41+
bodyDataMap = _.map(_.filter(enabledBodyList, {'type': 'text'}), function (data) {
42+
return `${indentString}'${sanitize(data.key, trim)}' => '${sanitize(data.value, trim)}'`;
43+
});
44+
bodyFileMap = _.map(_.filter(enabledBodyList, {'type': 'file'}), function (data) {
45+
return `${indentString}'${sanitize(data.key, trim)}', '${data.src}', <Content-Type Header>`;
46+
});
47+
if (bodyDataMap.length) {
48+
bodySnippet += `$request->setPostFields(array(\n${bodyDataMap.join(',\n')}));\n`;
49+
}
50+
if (bodyFileMap.length) {
51+
bodySnippet += `$request->setPostFiles(array(\n${bodyDataMap.join(',\n')}));\n`;
52+
}
53+
}
54+
break;
55+
case 'file':
56+
bodySnippet += '$request->setBody(\'<file contents here>\');\n';
57+
break;
58+
default:
59+
break;
60+
}
61+
return bodySnippet;
62+
};

‎codegens/php-httprequest/lib/util/sanitize.js

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
module.exports = {
2+
/**
3+
* used to sanitize eg: trim, handle escape characters
4+
* @param {String} inputString - input
5+
* @param {Boolean} [inputTrim] - whether to trim the input
6+
* @returns {String}
7+
*/
8+
9+
sanitize: function (inputString, inputTrim) {
10+
if (typeof inputString !== 'string') {
11+
return '';
12+
}
13+
14+
inputString = inputTrim && typeof inputTrim === 'boolean' ? inputString.trim() : inputString;
15+
return inputString.replace(/\\/g, '\\\\').replace(/'/g, '\\\'');
16+
},
17+
18+
/**
19+
* sanitizes input options
20+
*
21+
* @param {Object} options - Options provided by the user
22+
* @param {Array} optionsArray - options array received from getOptions function
23+
*
24+
* @returns {Object} - Sanitized options object
25+
*/
26+
sanitizeOptions: function (options, optionsArray) {
27+
var result = {},
28+
defaultOptions = {},
29+
id;
30+
optionsArray.forEach((option) => {
31+
defaultOptions[option.id] = {
32+
default: option.default,
33+
type: option.type
34+
};
35+
if (option.type === 'enum') {
36+
defaultOptions[option.id].availableOptions = option.availableOptions;
37+
}
38+
});
39+
40+
for (id in options) {
41+
if (options.hasOwnProperty(id)) {
42+
if (defaultOptions[id] === undefined) {
43+
continue;
44+
}
45+
switch (defaultOptions[id].type) {
46+
case 'boolean':
47+
if (typeof options[id] !== 'boolean') {
48+
result[id] = defaultOptions[id].default;
49+
}
50+
else {
51+
result[id] = options[id];
52+
}
53+
break;
54+
case 'positiveInteger':
55+
if (typeof options[id] !== 'number' || options[id] < 0) {
56+
result[id] = defaultOptions[id].default;
57+
}
58+
else {
59+
result[id] = options[id];
60+
}
61+
break;
62+
case 'enum':
63+
if (!defaultOptions[id].availableOptions.includes(options[id])) {
64+
result[id] = defaultOptions[id].default;
65+
}
66+
else {
67+
result[id] = options[id];
68+
}
69+
break;
70+
default:
71+
result[id] = options[id];
72+
}
73+
}
74+
}
75+
76+
for (id in defaultOptions) {
77+
if (defaultOptions.hasOwnProperty(id)) {
78+
if (result[id] === undefined) {
79+
result[id] = defaultOptions[id].default;
80+
}
81+
}
82+
}
83+
return result;
84+
}
85+
};

‎codegens/php-httprequest/npm-shrinkwrap.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎codegens/php-httprequest/test/newman/newman.test.js

+3-9
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,15 @@ var runNewmanTest = require('../../../../test/codegen/newman/newmanTestUtil').ru
22
convert = require('../../index').convert;
33

44

5-
describe('<<CODEGEN_NAME>> Converter', function () {
5+
describe('PHP HttpRequest Converter', function () {
66
describe('convert for different request types', function () {
77
var options = {
88
indentType: 'Space',
99
indentCount: 4
1010
},
1111
testConfig = {
12-
// filename along with the appropriate version of the file. This file will be used to run the snippet.
13-
fileName: '',
14-
// Run script required to run the generated code snippet
15-
runScript: '',
16-
// Compile script required to compile the code snippet
17-
compileScript: '',
18-
// Array of name of collections for which newman tests has to be skipped.
19-
skipCollections: []
12+
runScript: 'php codesnippet.php',
13+
fileName: 'codesnippet.php'
2014
};
2115
runNewmanTest(convert, options, testConfig);
2216
});

0 commit comments

Comments
 (0)